Debug/print/print.h

   1 /* Copyright (C) 2011-2015 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 #pragma once
  23
  24 // ----- Includes -----
  25
  26 // Compiler Includes
  27 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
  28 #include <avr/pgmspace.h>
  29 #endif
  30
  31 // Project Includes
  32 #include <output_com.h>
  33
  34
  35
  36 // ----- Defines -----
  37 #define NL "\r\n"
  38
  39
  40
  41 // ----- Functions and Corresponding Function Aliases -----
  42
  43 /* XXX
  44  * Note that all the variadic functions below, take comma separated string lists, they are purposely not printf style (simplicity)
  45  */
  46
  47 // Function Aliases
  48 #define dPrint(c)         Output_putstr(c)
  49 #define dPrintStr(c)      Output_putstr(c)
  50 #define dPrintStrs(...)   printstrs(__VA_ARGS__, "\0\0\0")      // Convenience Variadic Macro
  51 #define dPrintStrNL(c)    dPrintStrs       (c, NL)              // Appends New Line Macro
  52 #define dPrintStrsNL(...) printstrs(__VA_ARGS__, NL, "\0\0\0")  // Appends New Line Macro
  53
  54 // Special Msg Constructs (Uses VT100 tags)
  55 #define dPrintMsg(colour_code_str,msg,...) \
  56                           printstrs("\033[", colour_code_str, "m", msg, "\033[0m - ", __VA_ARGS__, NL, "\0\0\0")
  57 #define printMsgNL(colour_code_str,msg,str) \
  58                           print("\033[" colour_code_str "m" msg "\033[0m - " str NL)
  59 #define printMsg(colour_code_str,msg,str) \
  60                           print("\033[" colour_code_str "m" msg "\033[0m - " str)
  61
  62 // Info Messages
  63 #define info_dPrint(...)  dPrintMsg        ("1;32",   "INFO",    __VA_ARGS__) // Info Msg
  64 #define info_print(str)   printMsgNL       ("1;32",   "INFO",    str)         // Info Msg
  65 #define info_msg(str)     printMsg         ("1;32",   "INFO",    str)         // Info Msg
  66
  67 // Warning Messages
  68 #define warn_dPrint(...)  dPrintMsg        ("1;33",   "WARNING", __VA_ARGS__) // Warning Msg
  69 #define warn_print(str)   printMsgNL       ("1;33",   "WARNING", str)         // Warning Msg
  70 #define warn_msg(str)     printMsg         ("1;33",   "WARNING", str)         // Warning Msg
  71
  72 // Error Messages
  73 #define erro_dPrint(...)  dPrintMsg        ("1;5;31", "ERROR",   __VA_ARGS__) // Error Msg
  74 #define erro_print(str)   printMsgNL       ("1;5;31", "ERROR",   str)         // Error Msg
  75 #define erro_msg(str)     printMsg         ("1;5;31", "ERROR",   str)         // Error Msg
  76
  77 // Debug Messages
  78 #define dbug_dPrint(...)  dPrintMsg        ("1;35",   "DEBUG",   __VA_ARGS__) // Debug Msg
  79 #define dbug_print(str)   printMsgNL       ("1;35",   "DEBUG",   str)         // Debug Msg
  80 #define dbug_msg(str)     printMsg         ("1;35",   "DEBUG",   str)         // Debug Msg
  81
  82
  83 // Static String Printing
  84 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
  85 #define print(s) _print(PSTR(s))
  86 #else
  87 #define print(s) _print(s)
  88 #endif
  89
  90 void _print( const char *s );
  91 void printstrs( char* first, ... );
  92
  93
  94 // Printing numbers
  95 #define printHex(hex)   printHex_op(hex, 1)
  96 #define printHex32(hex) printHex32_op(hex, 1)
  97
  98 void printInt8    ( uint8_t  in );
  99 void printInt16   ( uint16_t in );
 100 void printInt32   ( uint32_t in );
 101 void printHex_op  ( uint16_t in, uint8_t op );
 102 void printHex32_op( uint32_t in, uint8_t op );
 103
 104
 105 // String Functions
 106 #define hexToStr(hex, out) hexToStr_op(hex, out, 1)
 107
 108 void int8ToStr    ( uint8_t  in, char*  out );
 109 void int16ToStr   ( uint16_t in, char*  out );
 110 void int32ToStr   ( uint32_t in, char*  out );
 111 void hexToStr_op  ( uint16_t in, char*  out, uint8_t op );
 112 void hex32ToStr_op( uint32_t in, char*  out, uint8_t op );
 113 void revsStr      ( char*  in );
 114 uint16_t lenStr   ( char*  in );
 115 int16_t eqStr     ( char*  str1, char* str2 ); // Returns -1 if identical, last character of str1 comparison (0 if str1 is like str2)
 116 int numToInt      ( char* in ); // Returns the int representation of a string
 117