Skip to content

Commit 461d246

Browse files
tenbahttenbaht
committed
unified the naming scheme for the fuctions in Print
1 parent 224caae commit 461d246

4 files changed

Lines changed: 47 additions & 38 deletions

File tree

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*~
22
*.bak
33
.*.swp
4+
# ignore all kinds of binary files:
45
*.o
56
*.bin
67
*.ihx
@@ -20,3 +21,6 @@ tags
2021
*.map
2122
# ignore files generated by the Arduino make system:
2223
build-*
24+
# ignore files generated by patch:
25+
*.orig
26+
*.rej

‎sduino/hardware/sduino/stm8/cores/sduino/HardwareSerial.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,16 @@ void HardwareSerial_end(void);
8383

8484
// variants of the standard Serial.print() function: Separate implementations
8585
// for string, char, unsigned, signed int
86-
#define Serial_print_s(S) printStr(HardwareSerial_write,S)
86+
#define Serial_print_s(S) Print_print_s(HardwareSerial_write,S)
8787
#define Serial_print_c(C) HardwareSerial_write(C)
8888

8989
// print signed/unsigned integer values (char, short, int, long) as decimal values
9090
#define Serial_print_i(I) Print_print_i(HardwareSerial_write,I)
9191
#define Serial_print_u(U) Print_print_u(HardwareSerial_write,U)
9292

9393
// print signed/unsigned integer values (char, short, int, long) to base B
94-
#define Serial_print_ib(I,B) printInt(HardwareSerial_write,I,B)
95-
#define Serial_print_ub(U,B) printNumber(HardwareSerial_write,U,B)
94+
#define Serial_print_ib(I,B) Print_print_ib(HardwareSerial_write,I,B)
95+
#define Serial_print_ub(U,B) Print_print_ub(HardwareSerial_write,U,B)
9696

9797

9898
#define Serial_println() Print_println(HardwareSerial_write)
@@ -101,7 +101,7 @@ void HardwareSerial_end(void);
101101
#define Serial_println_i(I) Print_println_i(HardwareSerial_write,I)
102102

103103
// float (not implemented yet)
104-
#define Serial_print_f(F,D) Print_printFloat(HardwareSerial_write,F,D)
104+
#define Serial_print_f(F,D) Print_print_f(HardwareSerial_write,F,D)
105105

106106

107107
#endif

‎sduino/hardware/sduino/stm8/cores/sduino/Print.c‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ void printNL(void);
4444

4545
// Public Methods //////////////////////////////////////////////////////////////
4646

47-
size_t printBuf(writefunc_p writefunc, const uint8_t *buffer, size_t size)
47+
size_t Print_print_sn(writefunc_p writefunc, const uint8_t *buffer, size_t size)
4848
{
4949
size_t n = 0;
5050
while (size--) {
@@ -54,7 +54,7 @@ size_t printBuf(writefunc_p writefunc, const uint8_t *buffer, size_t size)
5454
return n;
5555
}
5656

57-
size_t printStr(writefunc_p writefunc, const char *str)
57+
size_t Print_print_s(writefunc_p writefunc, const char *str)
5858
{
5959
size_t n = 0;
6060
char c;
@@ -79,12 +79,12 @@ size_t Print_print_i(writefunc_p writefunc, long n)
7979
return printInt(writefunc, n,10);
8080
}
8181

82-
size_t Print_println_s(writefunc_p writefunc, char *str)
82+
size_t Print_println_s(writefunc_p writefunc, const char *str)
8383
{
8484
size_t r;
8585

86-
r = printStr(writefunc, str);
87-
return r + println(writefunc);
86+
r = Print_print_s(writefunc, str);
87+
return r + Print_println(writefunc);
8888
}
8989

9090

@@ -94,21 +94,21 @@ size_t Print_println_u(writefunc_p writefunc, unsigned long n)
9494
size_t r;
9595

9696
r = printNumber(writefunc, n,10);
97-
return r + println(writefunc);
97+
return r + Print_println(writefunc);
9898
}
9999

100100
size_t Print_println_i(writefunc_p writefunc, long n)
101101
{
102102
size_t r;
103103

104104
r = printInt(writefunc, n,10);
105-
return r + println(writefunc);
105+
return r + Print_println(writefunc);
106106
}
107107

108108

109109
// (not so) Private Methods /////////////////////////////////////////////////////////////
110110

111-
size_t println(writefunc_p writefunc)
111+
size_t Print_println(writefunc_p writefunc)
112112
{
113113
size_t n;
114114

@@ -118,7 +118,7 @@ size_t println(writefunc_p writefunc)
118118
}
119119

120120

121-
size_t printNumber(writefunc_p writefunc, unsigned long n, uint8_t base)
121+
size_t Print_print_ub(writefunc_p writefunc, unsigned long n, uint8_t base)
122122
{
123123
char buf[8 * sizeof(long) + 1]; // Assumes 8-bit chars plus zero byte.
124124
char *str = &buf[sizeof(buf) - 1];
@@ -135,10 +135,10 @@ size_t printNumber(writefunc_p writefunc, unsigned long n, uint8_t base)
135135
*--str = c < 10 ? c + '0' : c + 'A' - 10;
136136
} while(n);
137137

138-
return printStr(writefunc, str);
138+
return Print_print_s(writefunc, str);
139139
}
140140

141-
size_t printInt(writefunc_p writefunc, long n, uint8_t base)
141+
size_t Print_print_ib(writefunc_p writefunc, long n, uint8_t base)
142142
{
143143
if (base == 0) {
144144
return writefunc((unsigned char) n);
@@ -155,7 +155,7 @@ size_t printInt(writefunc_p writefunc, long n, uint8_t base)
155155
}
156156

157157
/*
158-
size_t Print_printFloat(writefunc_p writefunc, double number, uint8_t digits)
158+
size_t Print_print_f(writefunc_p writefunc, double number, uint8_t digits)
159159
{
160160
size_t n = 0;
161161
uint8_t i;

‎sduino/hardware/sduino/stm8/cores/sduino/Print.h‎

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,36 +34,41 @@
3434

3535

3636
// for the function pointer to the actual write function
37-
typedef size_t (*writefunc_p)(char c);
37+
typedef size_t (*writefunc_p)(uint8_t c);
3838

39-
// the actual used functions, mostly for internal use
40-
size_t printBuf(writefunc_p writefunc, const uint8_t *buffer, size_t size);
41-
size_t printStr(writefunc_p writefunc, const char *str);
42-
size_t printNumber(writefunc_p writefunc, unsigned long n, uint8_t base);
43-
size_t printInt(writefunc_p writefunc, long n, uint8_t base);
44-
size_t println(writefunc_p writefunc);
39+
// abreviations of the actual function names, mostly for internal use
40+
#define printBuf Print_print_sn
41+
#define printStr Print_print_s
42+
#define printNumber Print_print_ub
43+
#define printInt Print_print_ib
44+
#define println Print_println
4545

46-
// the more sophisticated Arduino-Style functions:
4746

48-
//#define Print_write(B,N) printBuf(B,N)
47+
// the more sophisticated Arduino-Style functions. Variants of the standard
48+
// Serial.print() function: Separate impementations for different datatype
49+
// to mimic polymorphism.
4950

50-
// variants of the standard Serial.print() function: Separate impementations
51-
// for string, char, unsigned, signed int
52-
//#define Print_print_s(S) printStr(S)
53-
//#define Print_print_c(C) printChr(C)
54-
// print unsigned integer values (char, short, int, long) as decimal values
55-
size_t Print_print_u(writefunc_p writefunc, unsigned long n);
56-
// print signed integer values (char, short, int, long) as decimal value
51+
// print strings (C-Style or buffer contents)
52+
size_t Print_print_s(writefunc_p writefunc, const char *str);
53+
size_t Print_print_sn(writefunc_p writefunc, const uint8_t *buffer, size_t size);
54+
55+
// print signed/unsigned values (char, short, int, long) as decimal values
5756
size_t Print_print_i(writefunc_p writefunc, long n);
58-
// print unsigned integer values (char, short, int, long) to base B
59-
//#define Print_print_ub(U,B) printNumber(U,B)
60-
// print signed integer values (char, short, int, long) to base B
61-
//#define Print_print_ib(I,B) printInt(I,B)
57+
size_t Print_print_u(writefunc_p writefunc, unsigned long n);
58+
59+
// print signed/unsigned integer values (char, short, int, long) to base B
60+
size_t Print_print_ib(writefunc_p writefunc, long n, uint8_t base);
61+
size_t Print_print_ub(writefunc_p writefunc, unsigned long n, uint8_t base);
62+
63+
// print float values
64+
//size_t Print_print_f(writefunc_p writefunc, double number, uint8_t digits);
65+
6266

63-
size_t Print_println_s(writefunc_p writefunc, char *str);
67+
// Variants of the above with a newline added at the and:
68+
size_t Print_println(writefunc_p writefunc);
69+
size_t Print_println_s(writefunc_p writefunc, const char *str);
6470
size_t Print_println_u(writefunc_p writefunc, unsigned long n);
6571
size_t Print_println_i(writefunc_p writefunc, long n);
6672

67-
size_t Print_printFloat(writefunc_p writefunc, double number, uint8_t digits);
6873

6974
#endif

0 commit comments

Comments
 (0)