PrintBasic.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. /**
  2. * Copyright (c) 2011-2020 Bill Greiman
  3. * This file is part of the SdFat library for SD memory cards.
  4. *
  5. * MIT License
  6. *
  7. * Permission is hereby granted, free of charge, to any person obtaining a
  8. * copy of this software and associated documentation files (the "Software"),
  9. * to deal in the Software without restriction, including without limitation
  10. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11. * and/or sell copies of the Software, and to permit persons to whom the
  12. * Software is furnished to do so, subject to the following conditions:
  13. *
  14. * The above copyright notice and this permission notice shall be included
  15. * in all copies or substantial portions of the Software.
  16. *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18. * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23. * DEALINGS IN THE SOFTWARE.
  24. */
  25. #ifndef PrintBasic_h
  26. #define PrintBasic_h
  27. /**
  28. * \file
  29. * \brief Stream/Print like replacement for non-Arduino systems.
  30. */
  31. #include <stdint.h>
  32. #include <stddef.h>
  33. #include <string.h>
  34. #include "../SdFatConfig.h"
  35. #ifndef F
  36. #if defined(__AVR__)
  37. #include <avr/pgmspace.h>
  38. class __FlashStringHelper;
  39. #define F(string_literal) (reinterpret_cast<const __FlashStringHelper *>(PSTR(string_literal)))
  40. #else // defined(__AVR__)
  41. #define F(str) (str)
  42. struct __FlashStringHelper {};
  43. #endif // defined(__AVR__)
  44. #endif // F
  45. #ifdef BIN
  46. #undef BIN
  47. #endif // BIN
  48. #define BIN 2
  49. #define OCT 8
  50. #define DEC 10
  51. #define HEX 16
  52. class PrintBasic {
  53. public:
  54. PrintBasic() : m_error(0) {}
  55. void clearWriteError() {
  56. setWriteError(0);
  57. }
  58. int getWriteError() {
  59. return m_error;
  60. }
  61. size_t print(char c) {
  62. return write(c);
  63. }
  64. size_t print(const char* str) {
  65. return write(str);
  66. }
  67. size_t print(const __FlashStringHelper *str) {
  68. #ifdef __AVR__
  69. PGM_P p = reinterpret_cast<PGM_P>(str);
  70. size_t n = 0;
  71. for (uint8_t c; (c = pgm_read_byte(p + n)) && write(c); n++) {}
  72. return n;
  73. #else // __AVR__
  74. return print(reinterpret_cast<const char *>(str));
  75. #endif // __AVR__
  76. }
  77. size_t println(const __FlashStringHelper *str) {
  78. #ifdef __AVR__
  79. return print(str) + println();
  80. #else // __AVR__
  81. return println(reinterpret_cast<const char *>(str));
  82. #endif // __AVR__
  83. }
  84. size_t print(double n, uint8_t prec = 2) {
  85. return printDouble(n, prec);
  86. }
  87. size_t print(signed char n, uint8_t base = 10) {
  88. return print((long)n, base);
  89. }
  90. size_t print(unsigned char n, uint8_t base = 10) {
  91. return print((unsigned long)n, base);
  92. }
  93. size_t print(int n, uint8_t base = 10) {
  94. return print((long)n, base);
  95. }
  96. size_t print(unsigned int n, uint8_t base = 10) {
  97. return print((unsigned long)n, base);
  98. }
  99. size_t print(long n, uint8_t base = 10);
  100. size_t print(unsigned long n, uint8_t base = 10) {
  101. return printNum(n, base);
  102. }
  103. size_t println() {
  104. return write("\r\n");
  105. }
  106. size_t println(char c) {
  107. return write(c) + println();
  108. }
  109. size_t println(const char* str) {
  110. return print(str) + println();
  111. }
  112. size_t println(double n, uint8_t prec = 2) {
  113. return print(n, prec) + println();
  114. }
  115. size_t println(signed char n, uint8_t base = 10) {
  116. return print(n, base) + println();
  117. }
  118. size_t println(unsigned char n, uint8_t base = 10) {
  119. return print(n, base) + println();
  120. }
  121. size_t println(int n, uint8_t base = 10) {
  122. return print(n, base) + println();
  123. }
  124. size_t println(unsigned int n, uint8_t base = 10) {
  125. return print(n, base) + println();
  126. }
  127. size_t println(long n, uint8_t base = 10) {
  128. return print(n, base) + println();
  129. }
  130. size_t println(unsigned long n, uint8_t base = 10) {
  131. return print(n, base) + println();
  132. }
  133. size_t write(const char *str) {
  134. return write(str, strlen(str));
  135. }
  136. virtual size_t write(uint8_t b) = 0;
  137. virtual size_t write(const uint8_t* buffer, size_t size) {
  138. size_t i;
  139. for (i = 0; i < size; i++) {
  140. if (!write(buffer[i])) break;
  141. }
  142. return i;
  143. }
  144. size_t write(const char *buffer, size_t size) {
  145. return write((const uint8_t*)buffer, size);
  146. }
  147. protected:
  148. void setWriteError(int err = 1) {
  149. m_error = err;
  150. }
  151. private:
  152. size_t printDouble(double n, uint8_t prec);
  153. size_t printNum(unsigned long n, uint8_t base);
  154. int m_error;
  155. };
  156. //------------------------------------------------------------------------------
  157. class StreamBasic : public PrintBasic {
  158. public:
  159. virtual int available() = 0;
  160. virtual int peek() = 0;
  161. virtual int read() = 0;
  162. };
  163. #endif // PrintBasic_h