From ea7003ce8390471ad127ae7d7f1276b8ecd1d6e4 Mon Sep 17 00:00:00 2001 From: "Collin J. Doering" Date: Fri, 9 Oct 2015 01:35:47 -0400 Subject: [PATCH] Simplify entry of ANSI escape sequences Use pre-processor macros to allow for simple entry of ANSI escape sequences. Many escape sequences don't require all characters in all cases. Example: Cursor movement (up down, forward and back) all take one parameter (natural number) that defaults to 1, and can be omitted in this case. Calling the associated macros with 1 will generate the correct escape but not the smallest one. Now for these single argument cases (there are others also) the macro of choice can be used with an empty argument which will generate the smallest ANSI escape sequence. Eg, the following are equivalent: CUD() === CUD(1) Another example is use of CUP (cursor position). It takes two arguments which both default to 1. Similarly to the CUD example above, CUP(1,1) generates a valid ANSI escape sequence, just not the smallest one. The smallest one can be achieved by omitting the arguments to CUP: CUP(,). For more information on ANSI escapes see wikipedia: https://en.wikipedia.org/wiki/ANSI_escape_code This is just an initial proof of concept and is not complete; namely: - Not all ANSI escapes are implemented - Macros don't error check for the user; that is, invalid escapes can be generated (Eg. the argument to ED is constrained to 0, 1, or 2 but this is not checked by the ED macro) - Macro's can generate invalid ANSI escapes when the argument that's given is not a natural number (specified as ASCII) Signed-off-by: Collin J. Doering --- ansi_escapes.h | 42 ++++++++++++++++++++++++++++++++++++++++++ lcdOutput.c | 7 ++++--- 2 files changed, 46 insertions(+), 3 deletions(-) create mode 100644 ansi_escapes.h diff --git a/ansi_escapes.h b/ansi_escapes.h new file mode 100644 index 0000000..ea86641 --- /dev/null +++ b/ansi_escapes.h @@ -0,0 +1,42 @@ +/** + * (C) Copyright Collin J. Doering 2015 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * File: ansi_escapes.h + * Author: Collin J. Doering + * Date: Oct 9, 2015 + */ + +#define CSI "\e[" + +#define CUU(n) CSI #n "A" // Cursor up +#define CUD(n) CSI #n "B" // Cursor down +#define CUF(n) CSI #n "C" // Cursor forward +#define CUB(n) CSI #n "D" // Cursor backward + +#define CNL(n) CSI #n "E" // Cursor next line +#define CPL(n) CSI #n "F" // Cursor previous line + +#define CHA(n) CSI #n "G" // Cursor horizontal absolute +#define CUP(n,m) CSI #n ";" #m "H" // Cursor position + +#define ED(n) CSI #n "J" // Erase display +#define EL(n) CSI #n "K" // Erase in line +#define SU(n) CSI #n "S" // Scroll up +#define SD(n) CSI #n "T" // Scroll down + +#define HVP(n,m) CSI #n ";" #m "f" // Horizontal and vertical position diff --git a/lcdOutput.c b/lcdOutput.c index 85e5f0f..53a6240 100644 --- a/lcdOutput.c +++ b/lcdOutput.c @@ -31,6 +31,7 @@ #include #include "lcdLib.h" +#include "ansi_escapes.h" #include "USART.h" int main(void) { @@ -50,17 +51,17 @@ int main(void) { switch (serialChar) { case '\r': writeStringToLCD("\r\n"); - transmitString("\n\e[1E\r"); + transmitString("\n" CNL(1) "\r"); break; ; case '\f': writeCharToLCD(serialChar); - transmitString("\e[2J\e[1;1H"); + transmitString(ED(2) CUP(1,1)); break; ; case 0x7f: // Backspace (sent as delete) writeStringToLCD("\b \b"); - transmitString("\e[1D \e[1D"); + transmitString(CUB(1) " " CUB(1)); break; ; default: