write(), print(), and println() now return number of bytes written.

The type is long, and negative values indicate errors.  Needs more testing.
http://code.google.com/p/arduino/issues/detail?id=551
This commit is contained in:
David A. Mellis 2011-08-23 19:12:03 -04:00
parent 72b95ca603
commit 9cb0caa376
5 changed files with 151 additions and 108 deletions

View File

@ -352,12 +352,13 @@ void HardwareSerial::flush()
; ;
} }
void HardwareSerial::write(uint8_t c) long HardwareSerial::write(uint8_t c)
{ {
int i = (_tx_buffer->head + 1) % SERIAL_BUFFER_SIZE; int i = (_tx_buffer->head + 1) % SERIAL_BUFFER_SIZE;
// If the output buffer is full, there's nothing for it other than to // If the output buffer is full, there's nothing for it other than to
// wait for the interrupt handler to empty it a bit // wait for the interrupt handler to empty it a bit
// ???: return 0 here instead?
while (i == _tx_buffer->tail) while (i == _tx_buffer->tail)
; ;
@ -365,6 +366,8 @@ void HardwareSerial::write(uint8_t c)
_tx_buffer->head = i; _tx_buffer->head = i;
sbi(*_ucsrb, _udrie); sbi(*_ucsrb, _udrie);
return 1;
} }
// Preinstantiate Objects ////////////////////////////////////////////////////// // Preinstantiate Objects //////////////////////////////////////////////////////

View File

@ -55,7 +55,7 @@ class HardwareSerial : public Stream
virtual int peek(void); virtual int peek(void);
virtual int read(void); virtual int read(void);
virtual void flush(void); virtual void flush(void);
virtual void write(uint8_t); virtual long write(uint8_t);
using Print::write; // pull in write(str) and write(buf, size) from Print using Print::write; // pull in write(str) and write(buf, size) from Print
}; };

View File

@ -30,167 +30,196 @@
// Public Methods ////////////////////////////////////////////////////////////// // Public Methods //////////////////////////////////////////////////////////////
/* default implementation: may be overridden */ /* default implementation: may be overridden */
void Print::write(const char *str) long Print::write(const char *str)
{ {
while (*str) long n = 0;
write(*str++); while (*str) {
if (write(*str++) <= 0) break;
n++;
}
return n;
} }
/* default implementation: may be overridden */ /* default implementation: may be overridden */
void Print::write(const uint8_t *buffer, size_t size) long Print::write(const uint8_t *buffer, size_t size)
{ {
while (size--) long n = 0;
write(*buffer++); while (size--) {
if (write(*buffer++) <= 0) break;
n++;
}
return n;
} }
void Print::print(const __FlashStringHelper *ifsh) long Print::print(const __FlashStringHelper *ifsh)
{ {
const prog_char *p = (const prog_char *)ifsh; const prog_char *p = (const prog_char *)ifsh;
long n = 0;
while (1) { while (1) {
unsigned char c = pgm_read_byte(p++); unsigned char c = pgm_read_byte(p++);
if (c == 0) return; if (c == 0) break;
write(c); if (write(c) <= 0) break;
n++;
} }
return n;
} }
void Print::print(const String &s) long Print::print(const String &s)
{ {
long n = 0;
for (int i = 0; i < s.length(); i++) { for (int i = 0; i < s.length(); i++) {
write(s[i]); if (write(s[i]) < 0) break;
n++;
} }
return n;
} }
void Print::print(const char str[]) long Print::print(const char str[])
{ {
write(str); return write(str);
} }
void Print::print(char c) long Print::print(char c)
{ {
write(c); return write(c);
} }
void Print::print(unsigned char b, int base) long Print::print(unsigned char b, int base)
{ {
print((unsigned long) b, base); return print((unsigned long) b, base);
} }
void Print::print(int n, int base) long Print::print(int n, int base)
{ {
print((long) n, base); return print((long) n, base);
} }
void Print::print(unsigned int n, int base) long Print::print(unsigned int n, int base)
{ {
print((unsigned long) n, base); return print((unsigned long) n, base);
} }
void Print::print(long n, int base) long Print::print(long n, int base)
{ {
if (base == 0) { if (base == 0) {
write(n); return write(n);
} else if (base == 10) { } else if (base == 10) {
if (n < 0) { if (n < 0) {
print('-'); long t = print('-');
if (t <= 0) return t;
n = -n; n = -n;
return printNumber(n, 10) + 1;
} }
printNumber(n, 10); return printNumber(n, 10);
} else { } else {
printNumber(n, base); return printNumber(n, base);
} }
} }
void Print::print(unsigned long n, int base) long Print::print(unsigned long n, int base)
{ {
if (base == 0) write(n); if (base == 0) return write(n);
else printNumber(n, base); else return printNumber(n, base);
} }
void Print::print(double n, int digits) long Print::print(double n, int digits)
{ {
printFloat(n, digits); return printFloat(n, digits);
} }
void Print::println(const __FlashStringHelper *ifsh) long Print::println(const __FlashStringHelper *ifsh)
{ {
print(ifsh); long n = print(ifsh);
println(); if (n >= 0) n += println();
return n;
} }
void Print::print(const Printable& x) long Print::print(const Printable& x)
{ {
x.printTo(*this); return x.printTo(*this);
} }
void Print::println(void) long Print::println(void)
{ {
print('\r'); long t = print('\r');
print('\n'); if (t <= 0) return t;
if (print('\n') <= 0) return 1;
return 2;
} }
void Print::println(const String &s) long Print::println(const String &s)
{ {
print(s); long n = print(s);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(const char c[]) long Print::println(const char c[])
{ {
print(c); long n = print(c);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(char c) long Print::println(char c)
{ {
print(c); long n = print(c);
println(); if (n > 0) n += println();
return n;
} }
void Print::println(unsigned char b, int base) long Print::println(unsigned char b, int base)
{ {
print(b, base); long n = print(b, base);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(int n, int base) long Print::println(int num, int base)
{ {
print(n, base); long n = print(num, base);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(unsigned int n, int base) long Print::println(unsigned int num, int base)
{ {
print(n, base); long n = print(num, base);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(long n, int base) long Print::println(long num, int base)
{ {
print(n, base); long n = print(num, base);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(unsigned long n, int base) long Print::println(unsigned long num, int base)
{ {
print(n, base); long n = print(num, base);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(double n, int digits) long Print::println(double num, int digits)
{ {
print(n, digits); long n = print(num, digits);
println(); if (n >= 0) n += println();
return n;
} }
void Print::println(const Printable& x) long Print::println(const Printable& x)
{ {
print(x); long n = print(x);
println(); if (n >= 0) n += println();
return n;
} }
// Private Methods ///////////////////////////////////////////////////////////// // Private Methods /////////////////////////////////////////////////////////////
void Print::printNumber(unsigned long n, uint8_t base) { long Print::printNumber(unsigned long n, uint8_t base) {
char buf[8 * sizeof(long) + 1]; // Assumes 8-bit chars plus zero byte. char buf[8 * sizeof(long) + 1]; // Assumes 8-bit chars plus zero byte.
char *str = &buf[sizeof(buf) - 1]; char *str = &buf[sizeof(buf) - 1];
@ -206,15 +235,17 @@ void Print::printNumber(unsigned long n, uint8_t base) {
*--str = c < 10 ? c + '0' : c + 'A' - 10; *--str = c < 10 ? c + '0' : c + 'A' - 10;
} while(n); } while(n);
write(str); return write(str);
} }
void Print::printFloat(double number, uint8_t digits) long Print::printFloat(double number, uint8_t digits)
{ {
long n = 0, t;
// Handle negative numbers // Handle negative numbers
if (number < 0.0) if (number < 0.0)
{ {
print('-'); if ((n = print('-')) <= 0) return n;
number = -number; number = -number;
} }
@ -228,18 +259,27 @@ void Print::printFloat(double number, uint8_t digits)
// Extract the integer part of the number and print it // Extract the integer part of the number and print it
unsigned long int_part = (unsigned long)number; unsigned long int_part = (unsigned long)number;
double remainder = number - (double)int_part; double remainder = number - (double)int_part;
print(int_part); if ((t = print(int_part)) < 0) return n;
n += t;
// Print the decimal point, but only if there are digits beyond // Print the decimal point, but only if there are digits beyond
if (digits > 0) if (digits > 0) {
print("."); t = print(".");
if (t <= 0) return n;
n += t;
}
// Extract digits from the remainder one at a time // Extract digits from the remainder one at a time
while (digits-- > 0) while (digits-- > 0)
{ {
remainder *= 10.0; remainder *= 10.0;
int toPrint = int(remainder); int toPrint = int(remainder);
print(toPrint); t = print(toPrint);
if (t <= 0) return n;
n += t;
remainder -= toPrint; remainder -= toPrint;
} }
return n;
} }

View File

@ -34,37 +34,37 @@
class Print class Print
{ {
private: private:
void printNumber(unsigned long, uint8_t); long printNumber(unsigned long, uint8_t);
void printFloat(double, uint8_t); long printFloat(double, uint8_t);
public: public:
virtual void write(uint8_t) = 0; virtual long write(uint8_t) = 0;
virtual void write(const char *str); virtual long write(const char *str);
virtual void write(const uint8_t *buffer, size_t size); virtual long write(const uint8_t *buffer, size_t size);
void print(const __FlashStringHelper *); long print(const __FlashStringHelper *);
void print(const String &); long print(const String &);
void print(const char[]); long print(const char[]);
void print(char); long print(char);
void print(unsigned char, int = DEC); long print(unsigned char, int = DEC);
void print(int, int = DEC); long print(int, int = DEC);
void print(unsigned int, int = DEC); long print(unsigned int, int = DEC);
void print(long, int = DEC); long print(long, int = DEC);
void print(unsigned long, int = DEC); long print(unsigned long, int = DEC);
void print(double, int = 2); long print(double, int = 2);
void print(const Printable&); long print(const Printable&);
void println(const __FlashStringHelper *); long println(const __FlashStringHelper *);
void println(const String &s); long println(const String &s);
void println(const char[]); long println(const char[]);
void println(char); long println(char);
void println(unsigned char, int = DEC); long println(unsigned char, int = DEC);
void println(int, int = DEC); long println(int, int = DEC);
void println(unsigned int, int = DEC); long println(unsigned int, int = DEC);
void println(long, int = DEC); long println(long, int = DEC);
void println(unsigned long, int = DEC); long println(unsigned long, int = DEC);
void println(double, int = 2); long println(double, int = 2);
void println(const Printable&); long println(const Printable&);
void println(void); long println(void);
}; };
#endif #endif

View File

@ -30,7 +30,7 @@ class Print;
class Printable class Printable
{ {
public: public:
virtual void printTo(Print& p) const = 0; virtual long printTo(Print& p) const = 0;
}; };
#endif #endif