/home/travis/build/lis-epfl/MAVRIC_Library/hal/common/console.hpp

/*******************************************************************************
 * Copyright (c) 2009-2016, MAV'RIC Development Team
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

/*******************************************************************************
 * \file    console.hpp
 *
 * \author  MAV'RIC Team
 *
 * \brief   Write to any write-able module in human-readable format
 * You can use '<<' to print various data types in cout style: console << " hello " << endl;
 * To define '<<' operator for your own class, implement the follwing function
 * in the header of your class, outside of your class definition:
 * template<typename Writeable>
 *  Console<Writeable>& operator<< (Console<Writeable>& console, YourClass& yourclass)
 *  {
 *      console.write(...);
 *      return console;
 *  }
 *
 ******************************************************************************/

#ifndef CONSOLE_HPP_
#define CONSOLE_HPP_

#include <cstdint>
#include "util/string_util.hpp"


template <typename Writeable>
class Console
{
protected:
    Writeable& stream_;

public:
    Console(Writeable& stream);


    bool write(const uint8_t* data, uint32_t size);

    bool write(const char* text);

    bool writeln(const char* text);


    bool write(bool value);


    template<typename T>
    bool write(T number);


    bool write(float number, uint8_t after_digits = 3);
    bool write(double number, uint8_t after_digits = 3);

    template <typename T>
    bool write_floating(T number, uint8_t after_digits = 3);


    void flush();

    void newline();


    /* definition of ConsoleManipulator function pointer (used for "console << endl") */
    typedef Console<Writeable>& (*ConsoleManipulator)(Console<Writeable>&);


    template<typename T>
    Console<Writeable>& operator<<(const T& data);

    Console<Writeable>& operator<<(ConsoleManipulator manip);

    Writeable* get_stream();
};

template<typename Writeable>
Console<Writeable>& endl(Console<Writeable>& console);

/* Template implementation file */
#include "console.hxx"

#endif /* CONSOLE_HPP_ */