Writer.h

Go to the documentation of this file.

/*
    Writer.h - a base class for writing data.
    For AVR ATMega328p (Arduino Uno) and ATMega2560 (Arduino Mega).
    This is part of the AVRTools library.
    Copyright (c) 2014 Igor Mikolic-Torreira.  All right reserved.
    Functions printNumber() and printFloat() adapted from Arduino code that
    is Copyright (c) 2008 David A. Mellis and licensed under LGPL.

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef Writer_h
#define Writer_h

#include <stdint.h>
#include <stddef.h>



#ifndef SERIAL_OUTPUT_EOL
#define SERIAL_OUTPUT_EOL    '\n'
#endif




class Writer
{
public:


    enum IntegerOutputBase
    {
        kBin    = 2,        
        kOct    = 8,        
        kDec    = 10,       
        kHex    = 16        
    };



    virtual size_t write( char c ) = 0;


    virtual size_t write( const char* str ) = 0;


    virtual size_t write( const char* buffer, size_t size ) = 0;


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


    virtual void flush() = 0;




    size_t print( const char* str, bool addLn = false );


    size_t print( const uint8_t* buf, size_t size, bool addLn = false );


    size_t print( char c, bool addLn = false );


    size_t print( int8_t n, int base = kDec, bool addLn = false );


    size_t print( uint8_t n, int base = kDec, bool addLn = false )
    { return print( static_cast<unsigned long>( n ), base, addLn ); }

    size_t print( int n, int base = kDec, bool addLn = false );


    size_t print( unsigned int n, int base = kDec, bool addLn = false )
    { return print( static_cast<unsigned long>( n ), base, addLn ); }


    size_t print( long n, int base = kDec, bool addLn = false );


    size_t print( unsigned long n, int base = kDec, bool addLn = false );


    size_t print( double d, int digits = 2, bool addLn = false );


    size_t println( const char* str )                       { return print( str, true ); }

    size_t println( const uint8_t* buf, size_t size )       { return print( buf, size, true ); }

    size_t println( char c )                                { return print( c, true ); }

    size_t println( int8_t n, int base = kDec )                { return print( n, base, true ); }

    size_t println( uint8_t n, int base = kDec )       { return print( n, base, true ); }

    size_t println( int n, int base = kDec )                { return print( n, base, true ); }

    size_t println( unsigned int n, int base = kDec )       { return print( n, base, true ); }

    size_t println( long n, int base = kDec )               { return print( n, base, true ); }

    size_t println( unsigned long n, int base = kDec )      { return print( n, base, true ); }

    size_t println( double d, int digits = 2 )              { return print( d, digits, true ); }

    size_t println();

private:

    size_t printNumber( unsigned long n, uint8_t base );
    size_t printFloat( double d, uint8_t digits );
};

#endif