argos_colored_text.h

Go to the documentation of this file.

#ifndef ARGOS_COLORED_TEXT_H
#define ARGOS_COLORED_TEXT_H

#include <argos3/core/utility/datatypes/datatypes.h>

namespace argos {

   enum EARGoSLogAttributes {
      ARGOS_LOG_ATTRIBUTE_RESET      = 0,
      ARGOS_LOG_ATTRIBUTE_BRIGHT     = 1,
      ARGOS_LOG_ATTRIBUTE_DIM        = 2,
      ARGOS_LOG_ATTRIBUTE_UNDERSCORE = 3,
      ARGOS_LOG_ATTRIBUTE_BLINK      = 5,
      ARGOS_LOG_ATTRIBUTE_REVERSE    = 7,
      ARGOS_LOG_ATTRIBUTE_HIDDEN     = 8
   };

   enum EARGoSLogColors {
      ARGOS_LOG_COLOR_BLACK   = 0,
      ARGOS_LOG_COLOR_RED     = 1,
      ARGOS_LOG_COLOR_GREEN   = 2,
      ARGOS_LOG_COLOR_YELLOW  = 3,
      ARGOS_LOG_COLOR_BLUE    = 4,
      ARGOS_LOG_COLOR_MAGENTA = 5,
      ARGOS_LOG_COLOR_CYAN    = 6,
      ARGOS_LOG_COLOR_WHITE   = 7
   };

   struct SLogColor {
      UInt8 Attribute;
      UInt8 Foreground;

      SLogColor() :
         Attribute(ARGOS_LOG_ATTRIBUTE_RESET),
         Foreground(ARGOS_LOG_COLOR_WHITE) {}
      SLogColor(EARGoSLogAttributes e_attribute,
                EARGoSLogColors e_foreground_color) :
         Attribute(e_attribute),
         Foreground(e_foreground_color) {}
   };

   inline std::ostream& operator<<(std::ostream& c_os, const SLogColor& s_log_color)
   {
      c_os << "\033["
           << s_log_color.Attribute << ";"
           << (s_log_color.Foreground + 30) << "m";
      return c_os;
   }

#define DEFINE_ARGOS_STREAM_COLOR_HELPER(lc_color, uc_color)            \
   inline std::ostream& lc_color(std::ostream& c_os) {                  \
      c_os << SLogColor(ARGOS_LOG_ATTRIBUTE_BRIGHT, ARGOS_LOG_COLOR_ ## uc_color); \
      return c_os;                                                      \
   }

   DEFINE_ARGOS_STREAM_COLOR_HELPER(red, RED);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(green, GREEN);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(yellow, YELLOW);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(blue, BLUE);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(magenta, MAGENTA);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(cyan, CYAN);
   DEFINE_ARGOS_STREAM_COLOR_HELPER(white, WHITE);

   inline std::ostream& reset(std::ostream& c_os) {
      c_os << "\033["
           << ARGOS_LOG_ATTRIBUTE_RESET
           << "m";
      return c_os;
   }

}

#endif