Debug/print/print.h

   1 /* Copyright (C) 2011 by Jacob Alexander
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #ifndef print_h__
  23 #define print_h__
  24
  25 // ----- Includes -----
  26
  27 // AVR Includes
  28 #include <avr/pgmspace.h>
  29
  30 // Project Includes
  31 #include "usb_keyboard_debug.h"
  32
  33
  34
  35 // ----- Defines -----
  36 #define NL "\r\n"
  37
  38
  39
  40 // ----- Functions and Corresponding Function Aliases -----
  41
  42 /* XXX
  43  * Note that all the variadic functions below, take comma separated string lists, they are purposely not printf style (simplicity)
  44  */
  45
  46 // Function Aliases
  47 #define dPrint(c)         usb_debug_putchar(c)
  48 #define dPrintStr(c)      usb_debug_putstr (c)
  49 #define dPrintStrs(...)   usb_debug_putstrs(__VA_ARGS__, "\0\0\0")      // Convenience Variadic Macro
  50 #define dPrintStrNL(c)    dPrintStrs       (c, NL)                      // Appends New Line Macro
  51 #define dPrintStrsNL(...) usb_debug_putstrs(__VA_ARGS__, NL, "\0\0\0")  // Appends New Line Macro
  52
  53 // Special Msg Constructs (Uses VT100 tags)
  54 #define dPrintMsg(colour_code_str,msg,...) \
  55                           usb_debug_putstrs("\033[", colour_code_str, "m", msg, "\033[0m - ", __VA_ARGS__, NL, "\0\0\0")
  56 #define printMsg(colour_code_str,msg,str) \
  57                           print("\033[" colour_code_str "m" msg "\033[0m - " str NL)
  58
  59 // Info Messages
  60 #define info_dPrint(...)  dPrintMsg        ("1;32",   "INFO",    __VA_ARGS__) // Info Msg
  61 #define info_print(str)   printMsg         ("1;32",   "INFO",    str)         // Info Msg
  62
  63 // Warning Messages
  64 #define warn_dPrint(...)  dPrintMsg        ("1;33",   "WARNING", __VA_ARGS__) // Warning Msg
  65 #define warn_print(str)   printMsg         ("1;33",   "WARNING", str)         // Warning Msg
  66
  67 // Error Messages
  68 #define erro_dPrint(...)  dPrintMsg        ("1;5;31", "ERROR",   __VA_ARGS__) // Error Msg
  69 #define erro_print(str)   printMsg         ("1;5;31", "ERROR",   str)         // Error Msg
  70
  71 // Debug Messages
  72 #define dbug_dPrint(...)  dPrintMsg        ("1;35",   "DEBUG",   __VA_ARGS__) // Debug Msg
  73 #define dbug_print(str)   printMsg         ("1;35",   "DEBUG",   str)         // Debug Msg
  74
  75 // Static String Printing
  76 #define print(s) _print(PSTR(s))
  77
  78 void _print(const char *s);
  79 void usb_debug_putstr( char* s );
  80 void usb_debug_putstrs( char* first, ... );
  81
  82
  83
  84 // String Functions
  85 #define hexToStr(hex, out) hexToStr_op(hex, out, 1)
  86
  87 void int8ToStr  ( uint8_t  in,   char*  out );
  88 void int16ToStr ( uint16_t in,   char*  out );
  89 void hexToStr_op( uint16_t in,   char*  out, uint8_t op );
  90 void revsStr    ( char*  in );
  91 uint16_t lenStr ( char*  in );
  92
  93 #endif
  94