terminal_tools: terminal_tools: print.h Source File

00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2010, Willow Garage, Inc.
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of Willow Garage, Inc. nor the names of its
00018  *     contributors may be used to endorse or promote products derived
00019  *     from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  *
00034  * $Id: print.h 30706 2010-07-09 18:20:31Z rusu $
00035  *
00036  */
00037 #ifndef TERMINAL_TOOLS_PRINT_H_
00038 #define TERMINAL_TOOLS_PRINT_H_
00039 
00040 #include <stdio.h>
00041 #include <stdarg.h>
00042 
00043 namespace terminal_tools
00044 {
00045   enum TT_ATTIBUTES
00046   {
00047     TT_RESET     = 0,
00048     TT_BRIGHT    = 1,
00049     TT_DIM       = 2,
00050     TT_UNDERLINE = 3,
00051     TT_BLINK     = 4,
00052     TT_REVERSE   = 7,
00053     TT_HIDDEN    = 8
00054   };
00055 
00056   enum TT_COLORS
00057   {
00058     TT_BLACK,
00059     TT_RED,
00060     TT_GREEN,
00061     TT_YELLOW,
00062     TT_BLUE,
00063     TT_MAGENTA,
00064     TT_CYAN,
00065     TT_WHITE
00066   };
00067 
00069 
00075   void change_text_color (FILE *stream, int attribute, int fg, int bg);
00076   
00078 
00083   void change_text_color (FILE *stream, int attribute, int fg);
00084 
00086 
00089   void reset_text_color (FILE *stream);
00090 
00092 
00098   void print_color (FILE *stream, int attr, int fg, const char *format, ...);
00099 
00101 
00104   void print_info  (const char *format, ...);
00106 
00110   void print_info  (FILE *stream, const char *format, ...);
00111 
00113 
00116   void print_highlight  (const char *format, ...);
00118 
00122   void print_highlight  (FILE *stream, const char *format, ...);
00123 
00125 
00128   void print_error (const char *format, ...);
00130 
00134   void print_error (FILE *stream, const char *format, ...);
00135 
00137 
00140   void print_warn (const char *format, ...);
00142 
00146   void print_warn (FILE *stream, const char *format, ...);
00147 
00149 
00152   void print_debug (const char *format, ...);
00154 
00158   void print_debug (FILE *stream, const char *format, ...);
00159 
00161 
00164   void print_value (const char *format, ...);
00166 
00170   void print_value (FILE *stream, const char *format, ...);
00171 } 
00172 
00173 #endif