2011-04-12 07:07:59 +02:00
|
|
|
/*
|
|
|
|
* Print.cpp - Base class that provides print() and println()
|
|
|
|
* Copyright (c) 2008 David A. Mellis. All right reserved.
|
2012-06-01 00:55:44 +02:00
|
|
|
* Copyright (c) 2011 LeafLabs, LLC.
|
2010-09-27 03:47:55 +02:00
|
|
|
*
|
2011-04-12 07:07:59 +02:00
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2.1 of
|
|
|
|
* the License, or (at your option) any later version.
|
2010-09-27 03:47:55 +02:00
|
|
|
*
|
2011-04-12 07:07:59 +02:00
|
|
|
* This library is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
2010-09-27 03:47:55 +02:00
|
|
|
*
|
2011-04-12 07:07:59 +02:00
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
|
|
* 02110-1301 USA
|
2010-09-27 03:47:55 +02:00
|
|
|
*
|
2011-04-12 07:07:59 +02:00
|
|
|
* Modified 23 November 2006 by David A. Mellis
|
2011-04-12 07:13:52 +02:00
|
|
|
* Modified 12 April 2011 by Marti Bolivar <mbolivar@leaflabs.com>
|
2011-04-12 07:07:59 +02:00
|
|
|
*/
|
2009-12-17 03:37:07 +01:00
|
|
|
|
Move public headers to include directories; related cleanups.
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:
#include <libmaple/foo.h>
This is more polite in terms of the include namespace. It also allows
us to e.g. implement the Arduino SPI library at all (which has header
SPI.h; providing it was previously impossible on case-insensitive
filesystems due to libmaple's spi.h).
Similarly for Wirish.
The old include style (#include "header.h") is now deprecated.
libmaple/*.h:
- Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_.
- Add license headers where they're missing
- Add conditional extern "C" { ... } blocks where they're missing
(they aren't always necessary, but we might was well do it against
the future, while we're at it.).
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
- Move includes after extern "C".
- Remove extra trailing newlines
Note that this doesn't include the headers under libmaple/usb/ or
libmaple/usb/usb_lib. These will get fixed later.
libmaple/*.c:
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
Makefile:
- Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS. This allows
for users (including Wirish) to migrate their code, but should go
away ASAP, since it slows down compilation.
Wirish:
- Move wirish/**/*.h to (new) wirish/include/wirish/. This ignores
the USB headers, which, as usual, are getting handled after
everything else.
- Similarly generify wirish/boards/ structure. For each supported
board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to
wirish/boards/foo/include/board/board.h and
wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef
hacks around the .cpp files.
- wirish/rules.mk: put wirish/boards/foo/include in the include path
(and add wirish/boards/foo/board.cpp to the list of sources to be
compiled). This allows saying:
#include <board/board.h>
instead of the hack currently in place. We can allow the user to
override this setting later to make adding custom board definitions
easier.
- Disable -Werror in libmaple/rules.mk, as the current USB warnings
don't let the olimex_stm32_h103 board compile. We can re-enable
-Werror once we've moved the board-specific bits out of libmaple
proper.
libraries, examples:
- Update includes accordingly.
- Miscellaneous cosmetic fixups.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
2011-11-15 18:45:43 +01:00
|
|
|
#include <wirish/Print.h>
|
2011-04-26 00:02:10 +02:00
|
|
|
|
Move public headers to include directories; related cleanups.
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:
#include <libmaple/foo.h>
This is more polite in terms of the include namespace. It also allows
us to e.g. implement the Arduino SPI library at all (which has header
SPI.h; providing it was previously impossible on case-insensitive
filesystems due to libmaple's spi.h).
Similarly for Wirish.
The old include style (#include "header.h") is now deprecated.
libmaple/*.h:
- Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_.
- Add license headers where they're missing
- Add conditional extern "C" { ... } blocks where they're missing
(they aren't always necessary, but we might was well do it against
the future, while we're at it.).
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
- Move includes after extern "C".
- Remove extra trailing newlines
Note that this doesn't include the headers under libmaple/usb/ or
libmaple/usb/usb_lib. These will get fixed later.
libmaple/*.c:
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
Makefile:
- Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS. This allows
for users (including Wirish) to migrate their code, but should go
away ASAP, since it slows down compilation.
Wirish:
- Move wirish/**/*.h to (new) wirish/include/wirish/. This ignores
the USB headers, which, as usual, are getting handled after
everything else.
- Similarly generify wirish/boards/ structure. For each supported
board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to
wirish/boards/foo/include/board/board.h and
wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef
hacks around the .cpp files.
- wirish/rules.mk: put wirish/boards/foo/include in the include path
(and add wirish/boards/foo/board.cpp to the list of sources to be
compiled). This allows saying:
#include <board/board.h>
instead of the hack currently in place. We can allow the user to
override this setting later to make adding custom board definitions
easier.
- Disable -Werror in libmaple/rules.mk, as the current USB warnings
don't let the olimex_stm32_h103 board compile. We can re-enable
-Werror once we've moved the board-specific bits out of libmaple
proper.
libraries, examples:
- Update includes accordingly.
- Miscellaneous cosmetic fixups.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
2011-11-15 18:45:43 +01:00
|
|
|
#include <wirish/wirish_math.h>
|
2011-04-12 07:13:52 +02:00
|
|
|
#include <limits.h>
|
|
|
|
|
|
|
|
#ifndef LLONG_MAX
|
|
|
|
/*
|
|
|
|
* Note:
|
|
|
|
*
|
|
|
|
* At time of writing (12 April 2011), the limits.h that came with the
|
|
|
|
* newlib we distributed didn't include LLONG_MAX. Because we're
|
|
|
|
* staying away from using templates (see /notes/coding_standard.rst,
|
|
|
|
* "Language Features and Compiler Extensions"), this value was
|
|
|
|
* copy-pasted from a println() of the value
|
|
|
|
*
|
|
|
|
* std::numeric_limits<long long>::max().
|
|
|
|
*/
|
|
|
|
#define LLONG_MAX 9223372036854775807LL
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Public methods
|
|
|
|
*/
|
2009-12-17 03:37:07 +01:00
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::write(const char *str) {
|
2011-04-12 07:13:52 +02:00
|
|
|
while (*str) {
|
2011-04-12 07:07:59 +02:00
|
|
|
write(*str++);
|
2011-04-12 07:13:52 +02:00
|
|
|
}
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-05-04 19:15:33 +02:00
|
|
|
void Print::write(const void *buffer, uint32 size) {
|
2011-04-12 07:07:59 +02:00
|
|
|
uint8 *ch = (uint8*)buffer;
|
|
|
|
while (size--) {
|
|
|
|
write(*ch++);
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(uint8 b, int base) {
|
|
|
|
print((uint64)b, base);
|
2011-04-12 07:07:59 +02:00
|
|
|
}
|
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::print(char c) {
|
2011-06-08 22:39:04 +02:00
|
|
|
write(c);
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::print(const char str[]) {
|
|
|
|
write(str);
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(int n, int base) {
|
|
|
|
print((long long)n, base);
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(unsigned int n, int base) {
|
|
|
|
print((unsigned long long)n, base);
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(long n, int base) {
|
|
|
|
print((long long)n, base);
|
2011-04-12 07:13:52 +02:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(unsigned long n, int base) {
|
|
|
|
print((unsigned long long)n, base);
|
2011-04-12 07:13:52 +02:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(long long n, int base) {
|
|
|
|
if (base == BYTE) {
|
|
|
|
write((uint8)n);
|
|
|
|
return;
|
|
|
|
}
|
2011-04-12 07:07:59 +02:00
|
|
|
if (n < 0) {
|
|
|
|
print('-');
|
|
|
|
n = -n;
|
|
|
|
}
|
2011-06-08 22:39:04 +02:00
|
|
|
printNumber(n, base);
|
Rewrote Print class.
The old Print class couldn't print uint64 values, and featured
hand-hacked functionality better handled by snprintf(). Redid it
using snprintf(), using "[u]int[8,16,32,64]" types for more clarity,
and eliminated some private methods in favor of auxiliary functions in
Print.cpp.
Breaking compatibility with original implementation in three ways:
- Print::print(double) is now accurate to 6 digits, rather
than 2; this is consistent with the default behavior of the %f
format specifier, and if you're using floating point, it's slow
enough that you probably want the increased accuracy.
- The only bases you can print a number to are 2, 8, 10, and
16. 8, 10, and 16 already have format specifiers, and 2 is an
important special case; others complicate matters unnecessarily.
- Printing numbers in bases other than 10 treats them as
unsigned quantities (i.e., won't print '-' characters). This is
more consistent with C++'s behavior for hexadecimal and octal
literals (e.g., 0xFFFFFFFF has type uint32).
Updated HardwareSerial and USBSerial class documentation to reflect
the new behavior.
2011-02-24 20:42:30 +01:00
|
|
|
}
|
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
void Print::print(unsigned long long n, int base) {
|
2011-06-08 22:39:04 +02:00
|
|
|
if (base == BYTE) {
|
|
|
|
write((uint8)n);
|
2011-04-12 07:07:59 +02:00
|
|
|
} else {
|
|
|
|
printNumber(n, base);
|
|
|
|
}
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::print(double n, int digits) {
|
|
|
|
printFloat(n, digits);
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::println(void) {
|
2011-04-12 07:07:59 +02:00
|
|
|
print('\r');
|
|
|
|
print('\n');
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::println(char c) {
|
|
|
|
print(c);
|
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2010-09-27 03:47:55 +02:00
|
|
|
void Print::println(const char c[]) {
|
|
|
|
print(c);
|
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(uint8 b, int base) {
|
|
|
|
print(b, base);
|
2010-09-27 03:47:55 +02:00
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(int n, int base) {
|
|
|
|
print(n, base);
|
2010-09-27 03:47:55 +02:00
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(unsigned int n, int base) {
|
|
|
|
print(n, base);
|
2010-09-27 03:47:55 +02:00
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(long n, int base) {
|
|
|
|
print((long long)n, base);
|
2011-04-12 07:13:52 +02:00
|
|
|
println();
|
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(unsigned long n, int base) {
|
|
|
|
print((unsigned long long)n, base);
|
2010-09-27 03:47:55 +02:00
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(long long n, int base) {
|
|
|
|
print(n, base);
|
2011-04-12 07:13:52 +02:00
|
|
|
println();
|
|
|
|
}
|
|
|
|
|
|
|
|
void Print::println(unsigned long long n, int base) {
|
2010-09-27 03:47:55 +02:00
|
|
|
print(n, base);
|
|
|
|
println();
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|
|
|
|
|
2011-06-08 22:39:04 +02:00
|
|
|
void Print::println(double n, int digits) {
|
|
|
|
print(n, digits);
|
2010-09-27 03:47:55 +02:00
|
|
|
println();
|
|
|
|
}
|
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
/*
|
|
|
|
* Private methods
|
|
|
|
*/
|
2010-09-27 03:47:55 +02:00
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
void Print::printNumber(unsigned long long n, uint8 base) {
|
|
|
|
unsigned char buf[CHAR_BIT * sizeof(long long)];
|
2011-04-12 07:07:59 +02:00
|
|
|
unsigned long i = 0;
|
|
|
|
|
|
|
|
if (n == 0) {
|
|
|
|
print('0');
|
|
|
|
return;
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
2011-04-12 07:07:59 +02:00
|
|
|
|
|
|
|
while (n > 0) {
|
|
|
|
buf[i++] = n % base;
|
|
|
|
n /= base;
|
|
|
|
}
|
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
for (; i > 0; i--) {
|
|
|
|
print((char)(buf[i - 1] < 10 ?
|
|
|
|
'0' + buf[i - 1] :
|
|
|
|
'A' + buf[i - 1] - 10));
|
|
|
|
}
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
/* According to snprintf(),
|
|
|
|
*
|
|
|
|
* nextafter((double)numeric_limits<long long>::max(), 0.0) ~= 9.22337e+18
|
|
|
|
*
|
|
|
|
* This slightly smaller value was picked semi-arbitrarily. */
|
|
|
|
#define LARGE_DOUBLE_TRESHOLD (9.1e18)
|
|
|
|
|
|
|
|
/* THIS FUNCTION SHOULDN'T BE USED IF YOU NEED ACCURATE RESULTS.
|
|
|
|
*
|
|
|
|
* This implementation is meant to be simple and not occupy too much
|
|
|
|
* code size. However, printing floating point values accurately is a
|
|
|
|
* subtle task, best left to a well-tested library function.
|
|
|
|
*
|
|
|
|
* See Steele and White 2003 for more details:
|
|
|
|
*
|
|
|
|
* http://kurtstephens.com/files/p372-steele.pdf
|
|
|
|
*/
|
2011-04-12 07:07:59 +02:00
|
|
|
void Print::printFloat(double number, uint8 digits) {
|
2011-04-12 07:13:52 +02:00
|
|
|
// Hackish fail-fast behavior for large-magnitude doubles
|
|
|
|
if (abs(number) >= LARGE_DOUBLE_TRESHOLD) {
|
|
|
|
if (number < 0.0) {
|
|
|
|
print('-');
|
|
|
|
}
|
|
|
|
print("<large double>");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2011-04-12 07:07:59 +02:00
|
|
|
// Handle negative numbers
|
|
|
|
if (number < 0.0) {
|
|
|
|
print('-');
|
|
|
|
number = -number;
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
2011-04-12 07:07:59 +02:00
|
|
|
|
2011-04-12 07:13:52 +02:00
|
|
|
// Simplistic rounding strategy so that e.g. print(1.999, 2)
|
|
|
|
// prints as "2.00"
|
2011-04-12 07:07:59 +02:00
|
|
|
double rounding = 0.5;
|
2011-04-12 07:13:52 +02:00
|
|
|
for (uint8 i = 0; i < digits; i++) {
|
2011-04-12 07:07:59 +02:00
|
|
|
rounding /= 10.0;
|
|
|
|
}
|
|
|
|
number += rounding;
|
|
|
|
|
|
|
|
// Extract the integer part of the number and print it
|
2011-04-12 07:13:52 +02:00
|
|
|
long long int_part = (long long)number;
|
|
|
|
double remainder = number - int_part;
|
2011-04-12 07:07:59 +02:00
|
|
|
print(int_part);
|
|
|
|
|
|
|
|
// Print the decimal point, but only if there are digits beyond
|
|
|
|
if (digits > 0) {
|
|
|
|
print(".");
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
2011-04-12 07:07:59 +02:00
|
|
|
|
|
|
|
// Extract digits from the remainder one at a time
|
|
|
|
while (digits-- > 0) {
|
|
|
|
remainder *= 10.0;
|
2011-04-12 07:13:52 +02:00
|
|
|
int to_print = (int)remainder;
|
|
|
|
print(to_print);
|
|
|
|
remainder -= to_print;
|
2010-09-27 03:47:55 +02:00
|
|
|
}
|
2009-12-17 03:37:07 +01:00
|
|
|
}
|