Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / Misc / TerminalCodes.h
index a5f397a..0576285 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief ANSI terminal special escape code macros.\r
- *\r
- *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing\r
- *  strings to modify their display on a compatible terminal application.\r
- */\r
\r
-/** \ingroup Group_MiscDrivers\r
- *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h\r
- *\r
- *  \section Sec_Dependencies Module Source Dependencies\r
- *  The following files must be built with any user project that uses this module:\r
- *    - None\r
- *\r
- *  \section Module Description\r
- *  Escape code macros for ANSI compliant text terminals.\r
- *\r
- *  \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC\r
- *        compiler via the -D switch to disable the terminal codes without modifying the source, for use with non\r
- *        compatible terminals (any terminal codes then equate to empty strings).\r
- *\r
- *  Example Usage:\r
- *  \code\r
- *      printf("Some String, " ESC_BOLD_ON " Some bold string");\r
- *  \endcode\r
- *\r
- *  @{\r
- */\r
\r
-#ifndef __TERMINALCODES_H__\r
-#define __TERMINALCODES_H__\r
-\r
-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       #if !defined(DISABLE_TERMINAL_CODES)\r
-                               /** Creates an ANSII escape sequence with the payload specified by "c". */\r
-                               #define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c\r
-                       #else\r
-                               #define ANSI_ESCAPE_SEQUENCE(c)\r
-                       #endif\r
-\r
-                       /** Resets any escape sequence modifiers back to their defaults. */\r
-                       #define ESC_RESET                ANSI_ESCAPE_SEQUENCE("0m")\r
-\r
-                       /** Turns on bold so that any following text is printed to the terminal in bold. */\r
-                       #define ESC_BOLD_ON              ANSI_ESCAPE_SEQUENCE("1m")\r
-\r
-                       /** Turns on italics so that any following text is printed to the terminal in italics. */\r
-                       #define ESC_ITALICS_ON           ANSI_ESCAPE_SEQUENCE("3m")\r
-\r
-                       /** Turns on underline so that any following text is printed to the terminal underlined. */\r
-                       #define ESC_UNDERLINE_ON         ANSI_ESCAPE_SEQUENCE("4m")\r
-\r
-                       /** Turns on inverse so that any following text is printed to the terminal in inverted colours. */\r
-                       #define ESC_INVERSE_ON           ANSI_ESCAPE_SEQUENCE("7m")\r
-\r
-                       /** Turns on strikethrough so that any following text is printed to the terminal with a line through the\r
-                        *  center.\r
-                        */\r
-                       #define ESC_STRIKETHROUGH_ON     ANSI_ESCAPE_SEQUENCE("9m")\r
-\r
-                       /** Turns off bold so that any following text is printed to the terminal in non bold. */\r
-                       #define ESC_BOLD_OFF             ANSI_ESCAPE_SEQUENCE("22m")\r
-\r
-                       /** Turns off italics so that any following text is printed to the terminal in non italics. */\r
-                       #define ESC_ITALICS_OFF          ANSI_ESCAPE_SEQUENCE("23m")\r
-                       \r
-                       /** Turns off underline so that any following text is printed to the terminal non underlined. */                        \r
-                       #define ESC_UNDERLINE_OFF        ANSI_ESCAPE_SEQUENCE("24m")\r
-\r
-                       /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */\r
-                       #define ESC_INVERSE_OFF          ANSI_ESCAPE_SEQUENCE("27m")\r
-\r
-                       /** Turns off strikethrough so that any following text is printed to the terminal without a line through\r
-                        *  the center.\r
-                        */\r
-                       #define ESC_STRIKETHROUGH_OFF    ANSI_ESCAPE_SEQUENCE("29m")\r
-\r
-                       /** Sets the foreground (text) colour to black. */\r
-                       #define ESC_FG_BLACK             ANSI_ESCAPE_SEQUENCE("30m")\r
-\r
-                       /** Sets the foreground (text) colour to red. */\r
-                       #define ESC_FG_RED               ANSI_ESCAPE_SEQUENCE("31m")\r
-\r
-                       /** Sets the foreground (text) colour to green. */\r
-                       #define ESC_FG_GREEN             ANSI_ESCAPE_SEQUENCE("32m")\r
-\r
-                       /** Sets the foreground (text) colour to yellow. */\r
-                       #define ESC_FG_YELLOW            ANSI_ESCAPE_SEQUENCE("33m")\r
-\r
-                       /** Sets the foreground (text) colour to blue. */\r
-                       #define ESC_FG_BLUE              ANSI_ESCAPE_SEQUENCE("34m")\r
-\r
-                       /** Sets the foreground (text) colour to magenta. */\r
-                       #define ESC_FG_MAGENTA           ANSI_ESCAPE_SEQUENCE("35m")\r
-\r
-                       /** Sets the foreground (text) colour to cyan. */\r
-                       #define ESC_FG_CYAN              ANSI_ESCAPE_SEQUENCE("36m")\r
-\r
-                       /** Sets the foreground (text) colour to white. */\r
-                       #define ESC_FG_WHITE             ANSI_ESCAPE_SEQUENCE("37m")\r
-\r
-                       /** Sets the foreground (text) colour to the terminal's default. */\r
-                       #define ESC_FG_DEFAULT           ANSI_ESCAPE_SEQUENCE("39m")\r
-\r
-                       /** Sets the text background colour to black. */\r
-                       #define ESC_BG_BLACK             ANSI_ESCAPE_SEQUENCE("40m")\r
-\r
-                       /** Sets the text background colour to red. */\r
-                       #define ESC_BG_RED               ANSI_ESCAPE_SEQUENCE("41m")\r
-\r
-                       /** Sets the text background colour to green. */\r
-                       #define ESC_BG_GREEN             ANSI_ESCAPE_SEQUENCE("42m")\r
-\r
-                       /** Sets the text background colour to yellow. */\r
-                       #define ESC_BG_YELLOW            ANSI_ESCAPE_SEQUENCE("43m")\r
-\r
-                       /** Sets the text background colour to blue. */\r
-                       #define ESC_BG_BLUE              ANSI_ESCAPE_SEQUENCE("44m")\r
-\r
-                       /** Sets the text background colour to magenta. */\r
-                       #define ESC_BG_MAGENTA           ANSI_ESCAPE_SEQUENCE("45m")\r
-\r
-                       /** Sets the text background colour to cyan. */\r
-                       #define ESC_BG_CYAN              ANSI_ESCAPE_SEQUENCE("46m")\r
-\r
-                       /** Sets the text background colour to white. */\r
-                       #define ESC_BG_WHITE             ANSI_ESCAPE_SEQUENCE("47m")\r
-\r
-                       /** Sets the text background colour to the terminal's default. */\r
-                       #define ESC_BG_DEFAULT           ANSI_ESCAPE_SEQUENCE("49m")\r
-                       \r
-                       /** Sets the cursor position to the given line and column. */\r
-                       #define ESC_CURSOR_POS(L, C)     ANSI_ESCAPE_SEQUENCE(#L ";" #C "H")\r
-\r
-                       /** Moves the cursor up the given number of lines. */\r
-                       #define ESC_CURSOR_UP(L)         ANSI_ESCAPE_SEQUENCE(#L "A")\r
-\r
-                       /** Moves the cursor down the given number of lines. */\r
-                       #define ESC_CURSOR_DOWN(L)       ANSI_ESCAPE_SEQUENCE(#L "B")\r
-\r
-                       /** Moves the cursor to the right the given number of columns. */\r
-                       #define ESC_CURSOR_FORWARD(C)    ANSI_ESCAPE_SEQUENCE(#C "C")\r
-\r
-                       /** Moves the cursor to the left the given number of columns. */\r
-                       #define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")\r
-\r
-                       /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */\r
-                       #define ESC_CURSOR_POS_SAVE      ANSI_ESCAPE_SEQUENCE("s")\r
-\r
-                       /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */\r
-                       #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")\r
-                       \r
-                       /** Erases the entire display, returning the cursor to the top left. */\r
-                       #define ESC_ERASE_DISPLAY        ANSI_ESCAPE_SEQUENCE("2J")\r
-\r
-                       /** Erases the current line, returning the cursor to the far left. */\r
-                       #define ESC_ERASE_LINE           ANSI_ESCAPE_SEQUENCE("K")\r
-\r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  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 
+  software without specific, written prior permission.
+
+  The author disclaim 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
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief ANSI terminal special escape code macros.
+ *
+ *  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
+ *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section Module Description
+ *  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
+ *        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:
+ *  \code
+ *      printf("Some String, " ESC_BOLD_ON " Some bold string");
+ *  \endcode
+ *
+ *  @{
+ */
+#ifndef __TERMINALCODES_H__
+#define __TERMINALCODES_H__
+
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       #if !defined(DISABLE_TERMINAL_CODES)
+                               /** Creates an ANSII escape sequence with the payload specified by "c". */
+                               #define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c
+                       #else
+                               #define ANSI_ESCAPE_SEQUENCE(c)
+                       #endif
+
+                       /** Resets any escape sequence modifiers back to their defaults. */
+                       #define ESC_RESET                ANSI_ESCAPE_SEQUENCE("0m")
+
+                       /** Turns on bold so that any following text is printed to the terminal in bold. */
+                       #define ESC_BOLD_ON              ANSI_ESCAPE_SEQUENCE("1m")
+
+                       /** Turns on italics so that any following text is printed to the terminal in italics. */
+                       #define ESC_ITALICS_ON           ANSI_ESCAPE_SEQUENCE("3m")
+
+                       /** Turns on underline so that any following text is printed to the terminal underlined. */
+                       #define ESC_UNDERLINE_ON         ANSI_ESCAPE_SEQUENCE("4m")
+
+                       /** Turns on inverse so that any following text is printed to the terminal in inverted colours. */
+                       #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
+                        *  center.
+                        */
+                       #define ESC_STRIKETHROUGH_ON     ANSI_ESCAPE_SEQUENCE("9m")
+
+                       /** Turns off bold so that any following text is printed to the terminal in non bold. */
+                       #define ESC_BOLD_OFF             ANSI_ESCAPE_SEQUENCE("22m")
+
+                       /** 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")
+
+                       /** 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")
+
+                       /** Turns off strikethrough so that any following text is printed to the terminal without a line through
+                        *  the center.
+                        */
+                       #define ESC_STRIKETHROUGH_OFF    ANSI_ESCAPE_SEQUENCE("29m")
+
+                       /** Sets the foreground (text) colour to black. */
+                       #define ESC_FG_BLACK             ANSI_ESCAPE_SEQUENCE("30m")
+
+                       /** Sets the foreground (text) colour to red. */
+                       #define ESC_FG_RED               ANSI_ESCAPE_SEQUENCE("31m")
+
+                       /** Sets the foreground (text) colour to green. */
+                       #define ESC_FG_GREEN             ANSI_ESCAPE_SEQUENCE("32m")
+
+                       /** Sets the foreground (text) colour to yellow. */
+                       #define ESC_FG_YELLOW            ANSI_ESCAPE_SEQUENCE("33m")
+
+                       /** Sets the foreground (text) colour to blue. */
+                       #define ESC_FG_BLUE              ANSI_ESCAPE_SEQUENCE("34m")
+
+                       /** Sets the foreground (text) colour to magenta. */
+                       #define ESC_FG_MAGENTA           ANSI_ESCAPE_SEQUENCE("35m")
+
+                       /** Sets the foreground (text) colour to cyan. */
+                       #define ESC_FG_CYAN              ANSI_ESCAPE_SEQUENCE("36m")
+
+                       /** Sets the foreground (text) colour to white. */
+                       #define ESC_FG_WHITE             ANSI_ESCAPE_SEQUENCE("37m")
+
+                       /** Sets the foreground (text) colour to the terminal's default. */
+                       #define ESC_FG_DEFAULT           ANSI_ESCAPE_SEQUENCE("39m")
+
+                       /** Sets the text background colour to black. */
+                       #define ESC_BG_BLACK             ANSI_ESCAPE_SEQUENCE("40m")
+
+                       /** Sets the text background colour to red. */
+                       #define ESC_BG_RED               ANSI_ESCAPE_SEQUENCE("41m")
+
+                       /** Sets the text background colour to green. */
+                       #define ESC_BG_GREEN             ANSI_ESCAPE_SEQUENCE("42m")
+
+                       /** Sets the text background colour to yellow. */
+                       #define ESC_BG_YELLOW            ANSI_ESCAPE_SEQUENCE("43m")
+
+                       /** Sets the text background colour to blue. */
+                       #define ESC_BG_BLUE              ANSI_ESCAPE_SEQUENCE("44m")
+
+                       /** Sets the text background colour to magenta. */
+                       #define ESC_BG_MAGENTA           ANSI_ESCAPE_SEQUENCE("45m")
+
+                       /** Sets the text background colour to cyan. */
+                       #define ESC_BG_CYAN              ANSI_ESCAPE_SEQUENCE("46m")
+
+                       /** Sets the text background colour to white. */
+                       #define ESC_BG_WHITE             ANSI_ESCAPE_SEQUENCE("47m")
+
+                       /** 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")
+
+                       /** Moves the cursor up the given number of lines. */
+                       #define ESC_CURSOR_UP(L)         ANSI_ESCAPE_SEQUENCE(#L "A")
+
+                       /** Moves the cursor down the given number of lines. */
+                       #define ESC_CURSOR_DOWN(L)       ANSI_ESCAPE_SEQUENCE(#L "B")
+
+                       /** Moves the cursor to the right the given number of columns. */
+                       #define ESC_CURSOR_FORWARD(C)    ANSI_ESCAPE_SEQUENCE(#C "C")
+
+                       /** Moves the cursor to the left the given number of columns. */
+                       #define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")
+
+                       /** 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")
+                       
+                       /** Erases the entire display, returning the cursor to the top left. */
+                       #define ESC_ERASE_DISPLAY        ANSI_ESCAPE_SEQUENCE("2J")
+
+                       /** Erases the current line, returning the cursor to the far left. */
+                       #define ESC_ERASE_LINE           ANSI_ESCAPE_SEQUENCE("K")
+
+#endif
+
+/** @} */