projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Minor documentation improvements.
[pub/USBasp.git] / LUFA / Drivers / Misc / TerminalCodes.h
diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index ec35d12..696c17d 100644 (file)
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2013.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -34,162 +34,198 @@
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing
  *  strings to modify their display on a compatible terminal application.
  */
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing
  *  strings to modify their display on a compatible terminal application.
  */
- 
+
 /** \ingroup Group_MiscDrivers
 /** \ingroup Group_MiscDrivers
- *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
+ *  \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
+ *  \brief ANSI terminal special escape code macros.
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - None
  *
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - None
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Escape code macros for ANSI compliant text terminals.
  *
  *  Escape code macros for ANSI compliant text terminals.
  *
- *  \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC
+ *  \note If desired, the macro \c DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC
  *        compiler via the -D switch to disable the terminal codes without modifying the source, for use with non
  *        compatible terminals (any terminal codes then equate to empty strings).
  *
  *        compiler via the -D switch to disable the terminal codes without modifying the source, for use with non
  *        compatible terminals (any terminal codes then equate to empty strings).
  *
- *  Example Usage:
+ *  \section Sec_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
  *  \code
  *  \code
- *      printf("Some String, " ESC_BOLD_ON " Some bold string");
+ *      printf("Normal String, "
+ *             ESC_BOLD_ON "Bold String, "
+ *             ESC_UNDERLINE_ON "Bold and Underlined String"
+ *             ESC_RESET ESC_FG_BLUE ESC_BG_YELLOW "Normal Blue-on-Yellow String");
  *  \endcode
  *
  *  @{
  */
  *  \endcode
  *
  *  @{
  */
- 
+
 #ifndef __TERMINALCODES_H__
 #define __TERMINALCODES_H__
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        #if !defined(DISABLE_TERMINAL_CODES)
 #ifndef __TERMINALCODES_H__
 #define __TERMINALCODES_H__
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        #if !defined(DISABLE_TERMINAL_CODES)
-                               /** Creates an ANSI escape sequence with the payload specified by "c".
+                               /** Creates an ANSI escape sequence with the specified payload.
                                 *
                                 *
-                                *  \param[in] c  Payload to encode as an ANSI escape sequence, a ESC_* mask.
+                                *  \param[in] EscapeSeq  Payload to encode as an ANSI escape sequence, a \c ESC_* mask.
                                 */
                                 */
-                               #define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c
+                               #define ANSI_ESCAPE_SEQUENCE(EscapeSeq)  "\33[" EscapeSeq
                        #else
                        #else
-                               #define ANSI_ESCAPE_SEQUENCE(c)
+                               #define ANSI_ESCAPE_SEQUENCE(EscapeSeq)
                        #endif
 
                        #endif
 
-                       /** Resets any escape sequence modifiers back to their defaults. */
-                       #define ESC_RESET                ANSI_ESCAPE_SEQUENCE("0m")
-
+                       /** \name Text Display Modifier Control Sequences */
+                       //@{
                        /** Turns on bold so that any following text is printed to the terminal in bold. */
                        /** Turns on bold so that any following text is printed to the terminal in bold. */
-                       #define ESC_BOLD_ON              ANSI_ESCAPE_SEQUENCE("1m")
+                       #define ESC_BOLD_ON                     ANSI_ESCAPE_SEQUENCE("1m")
 
                        /** Turns on italics so that any following text is printed to the terminal in italics. */
 
                        /** Turns on italics so that any following text is printed to the terminal in italics. */
-                       #define ESC_ITALICS_ON           ANSI_ESCAPE_SEQUENCE("3m")
+                       #define ESC_ITALICS_ON                  ANSI_ESCAPE_SEQUENCE("3m")
 
                        /** Turns on underline so that any following text is printed to the terminal underlined. */
 
                        /** Turns on underline so that any following text is printed to the terminal underlined. */
-                       #define ESC_UNDERLINE_ON         ANSI_ESCAPE_SEQUENCE("4m")
+                       #define ESC_UNDERLINE_ON                ANSI_ESCAPE_SEQUENCE("4m")
 
                        /** Turns on inverse so that any following text is printed to the terminal in inverted colours. */
 
                        /** Turns on inverse so that any following text is printed to the terminal in inverted colours. */
-                       #define ESC_INVERSE_ON           ANSI_ESCAPE_SEQUENCE("7m")
+                       #define ESC_INVERSE_ON                  ANSI_ESCAPE_SEQUENCE("7m")
 
 
-                       /** Turns on strikethrough so that any following text is printed to the terminal with a line through the
+                       /** Turns on strike-through so that any following text is printed to the terminal with a line through the
                         *  center.
                         */
                         *  center.
                         */
-                       #define ESC_STRIKETHROUGH_ON     ANSI_ESCAPE_SEQUENCE("9m")
+                       #define ESC_STRIKETHROUGH_ON            ANSI_ESCAPE_SEQUENCE("9m")
 
                        /** Turns off bold so that any following text is printed to the terminal in non bold. */
 
                        /** Turns off bold so that any following text is printed to the terminal in non bold. */
-                       #define ESC_BOLD_OFF             ANSI_ESCAPE_SEQUENCE("22m")
+                       #define ESC_BOLD_OFF                    ANSI_ESCAPE_SEQUENCE("22m")
 
                        /** Turns off italics so that any following text is printed to the terminal in non italics. */
 
                        /** Turns off italics so that any following text is printed to the terminal in non italics. */
-                       #define ESC_ITALICS_OFF          ANSI_ESCAPE_SEQUENCE("23m")
-                       
-                       /** Turns off underline so that any following text is printed to the terminal non underlined. */                        
-                       #define ESC_UNDERLINE_OFF        ANSI_ESCAPE_SEQUENCE("24m")
+                       #define ESC_ITALICS_OFF                 ANSI_ESCAPE_SEQUENCE("23m")
+
+                       /** Turns off underline so that any following text is printed to the terminal non underlined. */
+                       #define ESC_UNDERLINE_OFF               ANSI_ESCAPE_SEQUENCE("24m")
 
                        /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */
 
                        /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */
-                       #define ESC_INVERSE_OFF          ANSI_ESCAPE_SEQUENCE("27m")
+                       #define ESC_INVERSE_OFF                 ANSI_ESCAPE_SEQUENCE("27m")
 
 
-                       /** Turns off strikethrough so that any following text is printed to the terminal without a line through
+                       /** Turns off strike-through so that any following text is printed to the terminal without a line through
                         *  the center.
                         */
                         *  the center.
                         */
-                       #define ESC_STRIKETHROUGH_OFF    ANSI_ESCAPE_SEQUENCE("29m")
+                       #define ESC_STRIKETHROUGH_OFF           ANSI_ESCAPE_SEQUENCE("29m")
+                       //@}
 
 
+                       /** \name Text Colour Control Sequences */
+                       //@{
                        /** Sets the foreground (text) colour to black. */
                        /** Sets the foreground (text) colour to black. */
-                       #define ESC_FG_BLACK             ANSI_ESCAPE_SEQUENCE("30m")
+                       #define ESC_FG_BLACK                    ANSI_ESCAPE_SEQUENCE("30m")
 
                        /** Sets the foreground (text) colour to red. */
 
                        /** Sets the foreground (text) colour to red. */
-                       #define ESC_FG_RED               ANSI_ESCAPE_SEQUENCE("31m")
+                       #define ESC_FG_RED                      ANSI_ESCAPE_SEQUENCE("31m")
 
                        /** Sets the foreground (text) colour to green. */
 
                        /** Sets the foreground (text) colour to green. */
-                       #define ESC_FG_GREEN             ANSI_ESCAPE_SEQUENCE("32m")
+                       #define ESC_FG_GREEN                    ANSI_ESCAPE_SEQUENCE("32m")
 
                        /** Sets the foreground (text) colour to yellow. */
 
                        /** Sets the foreground (text) colour to yellow. */
-                       #define ESC_FG_YELLOW            ANSI_ESCAPE_SEQUENCE("33m")
+                       #define ESC_FG_YELLOW                   ANSI_ESCAPE_SEQUENCE("33m")
 
                        /** Sets the foreground (text) colour to blue. */
 
                        /** Sets the foreground (text) colour to blue. */
-                       #define ESC_FG_BLUE              ANSI_ESCAPE_SEQUENCE("34m")
+                       #define ESC_FG_BLUE                     ANSI_ESCAPE_SEQUENCE("34m")
 
                        /** Sets the foreground (text) colour to magenta. */
 
                        /** Sets the foreground (text) colour to magenta. */
-                       #define ESC_FG_MAGENTA           ANSI_ESCAPE_SEQUENCE("35m")
+                       #define ESC_FG_MAGENTA                  ANSI_ESCAPE_SEQUENCE("35m")
 
                        /** Sets the foreground (text) colour to cyan. */
 
                        /** Sets the foreground (text) colour to cyan. */
-                       #define ESC_FG_CYAN              ANSI_ESCAPE_SEQUENCE("36m")
+                       #define ESC_FG_CYAN                     ANSI_ESCAPE_SEQUENCE("36m")
 
                        /** Sets the foreground (text) colour to white. */
 
                        /** Sets the foreground (text) colour to white. */
-                       #define ESC_FG_WHITE             ANSI_ESCAPE_SEQUENCE("37m")
+                       #define ESC_FG_WHITE                    ANSI_ESCAPE_SEQUENCE("37m")
 
                        /** Sets the foreground (text) colour to the terminal's default. */
 
                        /** Sets the foreground (text) colour to the terminal's default. */
-                       #define ESC_FG_DEFAULT           ANSI_ESCAPE_SEQUENCE("39m")
+                       #define ESC_FG_DEFAULT                  ANSI_ESCAPE_SEQUENCE("39m")
 
                        /** Sets the text background colour to black. */
 
                        /** Sets the text background colour to black. */
-                       #define ESC_BG_BLACK             ANSI_ESCAPE_SEQUENCE("40m")
+                       #define ESC_BG_BLACK                    ANSI_ESCAPE_SEQUENCE("40m")
 
                        /** Sets the text background colour to red. */
 
                        /** Sets the text background colour to red. */
-                       #define ESC_BG_RED               ANSI_ESCAPE_SEQUENCE("41m")
+                       #define ESC_BG_RED                      ANSI_ESCAPE_SEQUENCE("41m")
 
                        /** Sets the text background colour to green. */
 
                        /** Sets the text background colour to green. */
-                       #define ESC_BG_GREEN             ANSI_ESCAPE_SEQUENCE("42m")
+                       #define ESC_BG_GREEN                    ANSI_ESCAPE_SEQUENCE("42m")
 
                        /** Sets the text background colour to yellow. */
 
                        /** Sets the text background colour to yellow. */
-                       #define ESC_BG_YELLOW            ANSI_ESCAPE_SEQUENCE("43m")
+                       #define ESC_BG_YELLOW                   ANSI_ESCAPE_SEQUENCE("43m")
 
                        /** Sets the text background colour to blue. */
 
                        /** Sets the text background colour to blue. */
-                       #define ESC_BG_BLUE              ANSI_ESCAPE_SEQUENCE("44m")
+                       #define ESC_BG_BLUE                     ANSI_ESCAPE_SEQUENCE("44m")
 
                        /** Sets the text background colour to magenta. */
 
                        /** Sets the text background colour to magenta. */
-                       #define ESC_BG_MAGENTA           ANSI_ESCAPE_SEQUENCE("45m")
+                       #define ESC_BG_MAGENTA                  ANSI_ESCAPE_SEQUENCE("45m")
 
                        /** Sets the text background colour to cyan. */
 
                        /** Sets the text background colour to cyan. */
-                       #define ESC_BG_CYAN              ANSI_ESCAPE_SEQUENCE("46m")
+                       #define ESC_BG_CYAN                     ANSI_ESCAPE_SEQUENCE("46m")
 
                        /** Sets the text background colour to white. */
 
                        /** Sets the text background colour to white. */
-                       #define ESC_BG_WHITE             ANSI_ESCAPE_SEQUENCE("47m")
+                       #define ESC_BG_WHITE                    ANSI_ESCAPE_SEQUENCE("47m")
 
                        /** Sets the text background colour to the terminal's default. */
 
                        /** Sets the text background colour to the terminal's default. */
-                       #define ESC_BG_DEFAULT           ANSI_ESCAPE_SEQUENCE("49m")
-                       
-                       /** Sets the cursor position to the given line and column. */
-                       #define ESC_CURSOR_POS(L, C)     ANSI_ESCAPE_SEQUENCE(#L ";" #C "H")
+                       #define ESC_BG_DEFAULT                  ANSI_ESCAPE_SEQUENCE("49m")
+                       //@}
+
+                       /** \name Cursor Positioning Control Sequences */
+                       //@{
+                       /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */
+                       #define ESC_CURSOR_POS_SAVE             ANSI_ESCAPE_SEQUENCE("s")
+
+                       /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
+                       #define ESC_CURSOR_POS_RESTORE          ANSI_ESCAPE_SEQUENCE("u")
 
 
-                       /** Moves the cursor up the given number of lines. */
-                       #define ESC_CURSOR_UP(L)         ANSI_ESCAPE_SEQUENCE(#L "A")
+                       /** Sets the cursor position to the given line and column.
+                        *
+                        *  \param[in] Line    Line number to position the cursor at.
+                        *  \param[in] Column  Column number to position the cursor at.
+                        */
+                       #define ESC_CURSOR_POS(Line, Column)    ANSI_ESCAPE_SEQUENCE(#Line ";" #Column "H")
 
 
-                       /** Moves the cursor down the given number of lines. */
-                       #define ESC_CURSOR_DOWN(L)       ANSI_ESCAPE_SEQUENCE(#L "B")
+                       /** Moves the cursor up the given number of lines.
+                        *
+                        *  \param[in] Lines  Number of lines to move the cursor position
+                        */
+                       #define ESC_CURSOR_UP(Lines)            ANSI_ESCAPE_SEQUENCE(#Lines "A")
 
 
-                       /** Moves the cursor to the right the given number of columns. */
-                       #define ESC_CURSOR_FORWARD(C)    ANSI_ESCAPE_SEQUENCE(#C "C")
+                       /** Moves the cursor down the given number of lines.
+                        *
+                        *  \param[in] Lines  Number of lines to move the cursor position
+                        */
+                       #define ESC_CURSOR_DOWN(Lines)          ANSI_ESCAPE_SEQUENCE(#Lines "B")
 
 
-                       /** Moves the cursor to the left the given number of columns. */
-                       #define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")
+                       /** Moves the cursor to the right the given number of columns.
+                        *
+                        *  \param[in] Columns  Number of columns to move the cursor position
+                        */
+                       #define ESC_CURSOR_FORWARD(Columns)     ANSI_ESCAPE_SEQUENCE(#Columns "C")
 
 
-                       /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */
-                       #define ESC_CURSOR_POS_SAVE      ANSI_ESCAPE_SEQUENCE("s")
+                       /** Moves the cursor to the left the given number of columns.
+                        *
+                        *  \param[in] Columns  Number of columns to move the cursor position
+                        */
+                       #define ESC_CURSOR_BACKWARD(Columns)    ANSI_ESCAPE_SEQUENCE(#Columns "D")
+                       //@}
+
+                       /** \name Miscellaneous Control Sequences */
+                       //@{
+                       /** Resets any escape sequence modifiers back to their defaults. */
+                       #define ESC_RESET                       ANSI_ESCAPE_SEQUENCE("0m")
 
 
-                       /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
-                       #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")
-                       
                        /** Erases the entire display, returning the cursor to the top left. */
                        /** Erases the entire display, returning the cursor to the top left. */
-                       #define ESC_ERASE_DISPLAY        ANSI_ESCAPE_SEQUENCE("2J")
+                       #define ESC_ERASE_DISPLAY               ANSI_ESCAPE_SEQUENCE("2J")
 
                        /** Erases the current line, returning the cursor to the far left. */
 
                        /** Erases the current line, returning the cursor to the far left. */
-                       #define ESC_ERASE_LINE           ANSI_ESCAPE_SEQUENCE("K")
+                       #define ESC_ERASE_LINE                  ANSI_ESCAPE_SEQUENCE("K")
+                       //@}
 
 #endif
 
 /** @} */
 
 #endif
 
 /** @} */
+
USB isp AVR programmer