/home/travis/build/lis-epfl/MAVRIC_Library/hal/common/dbg.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    dbg.hpp
 *
 * \author  MAV'RIC Team
 *
 * \brief   Write debug messages
 *
 * Prints human-readable messages to a console.
 * The implementation of templated function is in dbg.hxx while the rest is in dbg.cpp
 * Before initialization, data is written to a dummy console.
 * dout() can be used for cout like syntax: 'dout() << "hello " << 123 << 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 DBG_HPP_
#define DBG_HPP_

#include "hal/dummy/serial_dummy.hpp"
#include "hal/common/console.hpp"
#include <cstdint>

namespace dbg
{

void init(Console<Serial>& console);

Console<Serial>& dout();

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

template<typename T>
static bool print(T data);

template<typename T>
bool println(T data);
};

// Template implementation file
#include "dbg.hxx"

//Dbg& dout = Dbg::getInstance();
#endif /* DBG_HPP_ */