Serial.h

/********************************************************************
 *                   Open Source Cartridge Reader                   *
 ********************************************************************/
#pragma once
#if !defined(OSCR_HARDWARE_OUTPUTS_SERIAL_H_)
# define OSCR_HARDWARE_OUTPUTS_SERIAL_H_
 
# include "config.h"
 
# if defined(ENABLE_SERIAL_OUTPUT) || defined(ENABLE_UPDATER)
 
#   include "common/specializations.h"
 
namespace OSCR::Serial
{
  constexpr char const ending = '\n';
  constexpr char const ending2 = '\r';
  constexpr uint8_t const commandMax = 32;
  constexpr uint8_t const ansiEsc[2] = { 0x1B, 0x5B };
 
  extern uint32_t const baud;
 
  extern char command[commandMax];
  char const * getCommandPointer();
  uint8_t const * getCommandMaxPointer();
 
  extern void begin();
  extern void begin(uint32_t b);
  extern void end();
 
  extern void setup();
 
  extern int read();
 
  extern void printLine(void);
 
  extern void flush();
  extern void flushSync();
 
  extern bool echo(bool toggle);
  extern bool echo();
 
  extern bool getCommand();

 
  extern int available();
  extern int availableForWrite();
 
  extern size_t write(uint8_t const byte);
  extern size_t write(char const chr);
  extern size_t write(uint8_t const * buffer, size_t size);
  extern size_t write(char const * buffer, size_t size);
 
  extern void printLine(void);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable = true,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable = true>
  extern void print(T string);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable = true,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable = true>
  extern void printLine(T string);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable = true>
  extern void print(Tint number, int base = DEC);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable = true>
  extern void printLine(Tint number, int base = DEC);
 
  extern void printLineSync(void);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable = true,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable = true>
  extern void printSync(T string);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable = true,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable = true>
  extern void printLineSync(T string);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable = true>
  extern void printSync(Tint number, int base = DEC);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable = true>
  extern void printLineSync(Tint number, int base = DEC);
 
  template <bool prfx = true,
            typename T,
            OSCR::Util::if_is_any_unsigned_t<T> Enable = true>
  extern void printHex(T number);
 
  template <bool prfx = true,
            typename T,
            OSCR::Util::if_is_any_unsigned_t<T> Enable = true>
  extern void printHexLine(T number);
 
  extern void gotoLast();

 
#   if defined(ENABLE_SERIAL_OUTPUT)

 
  extern void printLine(void);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable>
  extern void print(T string);
 
  template <typename T,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_number<T>::value), bool> Enable,
            OSCR::Util::enable_if_t<!(OSCR::Util::is_printable<T>::value), bool> NonPrintable>
  extern void printLine(T string);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable>
  extern void print(Tint number, int base);
 
  template <typename Tint,
            OSCR::Util::enable_if_t<OSCR::Util::is_integer<Tint>::value, bool> Enable>
  extern void printLine(Tint number, int base);

 
#   endif /* ENABLE_SERIAL_OUTPUT */
 
} /* namespace OSCR::UI */
 
# endif /* ENABLE_SERIAL_OUTPUT || ENABLE_UPDATER */
 
#endif /* !OSCR_HARDWARE_OUTPUTS_SERIAL_H_ */