RTduino Source Code Reference Manual
Print.h
1 /*
2  * Copyright (c) 2021-2022, RTduino Development Team
3  *
4  * SPDX-License-Identifier: LGPL-v2.1
5  *
6  * https://github.com/RTduino/RTduino
7  * https://gitee.com/rtduino/RTduino
8  *
9  * Change Logs:
10  * Date Author Notes
11  * 2021-12-10 Meco Man port to RTduino
12  */
13 /*
14  Print.h - Base class that provides print() and println()
15  Copyright (c) 2008 David A. Mellis. All right reserved.
16 
17  This library is free software; you can redistribute it and/or
18  modify it under the terms of the GNU Lesser General Public
19  License as published by the Free Software Foundation; either
20  version 2.1 of the License, or (at your option) any later version.
21 
22  This library is distributed in the hope that it will be useful,
23  but WITHOUT ANY WARRANTY; without even the implied warranty of
24  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25  Lesser General Public License for more details.
26 
27  You should have received a copy of the GNU Lesser General Public
28  License along with this library; if not, write to the Free Software
29  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
30 */
31 
32 #ifndef Print_h
33 #define Print_h
34 
35 #include <inttypes.h>
36 #include <stdio.h> // for size_t
37 
38 #include "WString.h"
39 #include "Printable.h"
40 
41 #define DEC 10
42 #define HEX 16
43 #define OCT 8
44 #define BIN 2
45 
46 class Print
47 {
48  private:
49  int write_error;
50  size_t printNumber(unsigned long, uint8_t);
51  size_t printFloat(double, uint8_t);
52  protected:
53  void setWriteError(int err = 1) { write_error = err; }
54  public:
55  Print() : write_error(0) {}
56 
57  int getWriteError() { return write_error; }
58  void clearWriteError() { setWriteError(0); }
59 
60  virtual size_t write(uint8_t c) = 0;
61  size_t write(const char *str) {
62  if (str == NULL) return 0;
63  return write((const uint8_t *)str, strlen(str));
64  }
65  virtual size_t write(const uint8_t *buffer, size_t size);
66  size_t write(const char *buffer, size_t size) {
67  return write((const uint8_t *)buffer, size);
68  }
69 
70  // default to zero, meaning "a single write may block"
71  // should be overridden by subclasses with buffering
72  virtual int availableForWrite() { return 0; }
73 
74  size_t print(const __FlashStringHelper *);
75  size_t print(const String &);
76  size_t print(const char[]);
77  size_t print(char);
78  size_t print(unsigned char, int = DEC);
79  size_t print(int, int = DEC);
80  size_t print(unsigned int, int = DEC);
81  size_t print(long, int = DEC);
82  size_t print(unsigned long, int = DEC);
83  size_t print(double, int = 2);
84  size_t print(const Printable&);
85 
86  size_t println(const __FlashStringHelper *);
87  size_t println(const String &s);
88  size_t println(const char[]);
89  size_t println(char);
90  size_t println(unsigned char, int = DEC);
91  size_t println(int, int = DEC);
92  size_t println(unsigned int, int = DEC);
93  size_t println(long, int = DEC);
94  size_t println(unsigned long, int = DEC);
95  size_t println(double, int = 2);
96  size_t println(const Printable&);
97  size_t println(void);
98 
99  virtual void flush() { /* Empty implementation for backward compatibility */ }
100 };
101 
102 #endif /* Print_h */
Definition: Print.h:47
Definition: Printable.h:46