Print.h

/*
  Copyright (c) 2016 Arduino LLC.  All right reserved.

  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.

  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.

  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
*/

#pragma once

#include <inttypes.h>
#include <stdio.h> // for size_t

#include "String.h"
#include "Printable.h"

#define DEC 10
#define HEX 16
#define OCT 8
#define BIN 2

#define _always_inline __attribute__ ((__always_inline__)) // undefined at end

class Print
{
  private:
    int write_error;
    size_t printNumber(unsigned long, uint8_t);
    size_t printULLNumber(unsigned long long, uint8_t);
    size_t printFloat(double, uint8_t);
  protected:
    void setWriteError(int err = 1) { write_error = err; }
  public:
    Print() : write_error(0) {}

    int getWriteError() { return write_error; }
    void clearWriteError() { setWriteError(0); }

    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(const __FlashStringHelper *);
    size_t print(const String &);
    size_t print(  signed long, int = DEC);
    size_t print(unsigned long, int = DEC);
    size_t print(long long, int = DEC);
    size_t print(unsigned long long, int = DEC);
    size_t print(double, int = 2);

    _always_inline size_t print(const char str[])   { return write(str); }
    _always_inline size_t print(const char c)       { return write(c); }
    _always_inline size_t print(const Printable &x) { return x.printTo(*this); }

    _always_inline size_t print(  signed char  n, int f = DEC) { return print((  signed long) n, f); }
    _always_inline size_t print(  signed short n, int f = DEC) { return print((  signed long) n, f); }
    _always_inline size_t print(  signed int   n, int f = DEC) { return print((  signed long) n, f); }
    _always_inline size_t print(unsigned char  n, int f = DEC) { return print((unsigned long) n, f); }
    _always_inline size_t print(unsigned short n, int f = DEC) { return print((unsigned long) n, f); }
    _always_inline size_t print(unsigned int   n, int f = DEC) { return print((unsigned long) n, f); }
    _always_inline size_t print(    float      n, int f = 2  ) { return print((    double   ) n, f); }

    size_t println(void);

#if __cplusplus >= 201103L
    template<typename ...Ts> _always_inline size_t println(const Ts &...args) { size_t t = print(args...); return t + println(); }
#else
    template<typename T> _always_inline size_t println(const T &arg)      { size_t t = print(arg);  return t + println(); }
    template<typename T> _always_inline size_t println(const T &n, int f) { size_t t = print(n, f); return t + println(); }
#endif // __cplusplus >= 201103L
    

    /** Variadic methods **/
#if __cplusplus >= 201103L  // requires C++11
    // Ensure there are at least two parameters to avoid infinite recursion.
    // e.g. `StringSumHelper s; print(s)` may be treated as `print(s, ...)`
    // with `...` being the empty list, thus calling `print(s)` again.
    // (This is because print(StringSumHelper) isn't explicitly defined.)

    template<typename T, typename T2, typename ...Ts>
    _always_inline size_t print(const T &arg, const T2 &arg2, const Ts &...args) {
      size_t t = print(arg);
      return t + print(arg2, args...);
    }
    // Some methods take an extra int parameter.  If so, use these templates.
    // In a future, it would be nice to make the base/precision a special type.
    template<typename ...Ts> _always_inline size_t print(  signed char  n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(  signed short n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(  signed int   n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(  signed long  n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(unsigned char  n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(unsigned short n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(unsigned int   n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(unsigned long  n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(    float      n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(    double     n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(long long      n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
    template<typename ...Ts> _always_inline size_t print(unsigned long long n, int f, const Ts &...args) { size_t t = print(n, f); return t + print(args...); }
#endif // __cplusplus >= 201103L
};