Print.h

Go to the documentation of this file.

/* $Id: Print.h 1156 2011-06-07 04:01:16Z bhagman $
||
|| @author         Hernando Barragan <b@wiring.org.co>
|| @url            http://wiring.org.co/
|| @contribution   Nicholas Zambetti
|| @contribution   Brett Hagman <bhagman@wiring.org.co>
|| @contribution   Alexander Brevig <abrevig@wiring.org.co>
||
|| @description
|| | Print library.
|| |
|| | Wiring Common API
|| #
||
|| @license Please see cores/Common/License.txt.
||
*/

#pragma once

#ifdef __cplusplus

#include "Printable.h"
#include "WString.h"

#define INITIAL_PRINTF_BUFFSIZE 128

class Print
{
  public:
    Print() {}
    virtual ~Print() {}
  
    int getWriteError() { return write_error; }

    void clearWriteError() { setWriteError(0); }
  
    // pure virtual - must be implemented by derived class
    //virtual void write(uint8_t) = 0;

    // virtual - can be redefined (polymorphic class)
    //virtual void write(const char *str);
    //virtual void write(const uint8_t *buffer, size_t size);

    virtual size_t write(uint8_t) = 0;

    size_t write(const char *str) {
      if (str == NULL) return 0;
      return write((const uint8_t *)str, strlen(str));
    }

    virtual size_t write(const uint8_t *buffer, size_t size);

    size_t write(const char *buffer, size_t size) {
      return write((const uint8_t *)buffer, size);
    }
  
    size_t print(char c)
    {
      return write(c);
    }

    size_t print(const char str[])
    {
      return write(str);
    }

    size_t print(unsigned long num, int base = DEC)
    {
      if (base == 0) {
          return write(num);
      } else {
          return printNumber(num, base);
      }
    }

    size_t print(const unsigned long long& num, int base = DEC)
    {
        return printNumber(num, base);
    }

    size_t print(long, int base = DEC);

    size_t print(const long long&, int base = DEC);

    size_t print(unsigned int num, int base = DEC)
    {
      return print((unsigned long)num, base);
    }

    size_t print(unsigned char num, int base = DEC)
    {
      return print((unsigned long)num, base);
    }

    size_t print(int num, int base = DEC)
    {
      return print((long)num, base);
    }
    size_t print(double num, int digits = 2)
    {
      return printFloat(num, digits);
    }

    size_t print(const Printable &p)
    {
      return p.printTo(*this);
    }

    size_t print(const String &s)
    {
      return write(s.c_str(), s.length());
    }
  
    size_t println()
    {
      return print("\r\n");
    }

    size_t println(const char str[])
    {
      return print(str) + println();
    }

    size_t println(char c)
    {
      return print(c) + println();
    }

    size_t println(unsigned char num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(unsigned int num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(unsigned long num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(const unsigned long long& num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(int num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(long num, int base = DEC)
    {
      return print(num, base) + println();
    }

    size_t println(const long long& num, int base = DEC)
    {
      return print(num, base) + println();
    }
    size_t println(double num, int digits = 2)
    {
      return print(num, digits) + println();
    }

    size_t println(const Printable &p)
    {
      return print(p) + println();
    }

    size_t println(const String &s)
    {
      return print(s) + println();
    }

    size_t printf(const char *fmt, ...) __attribute__ ((format (printf, 2, 3)));

  private:
    int write_error = 0;
    size_t printNumber(unsigned long num, uint8_t base);
    size_t printNumber(const unsigned long long& num, uint8_t base);
    size_t printFloat(double num, uint8_t digits);
  protected:
    void setWriteError(int err = 1) { write_error = err; }
};

#endif  // __cplusplus