lib/cmd/include/ucg_cmd_vt100.h

   1 /*
   2  * Copyright (c) 2009-2015, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /*-
  29  * Copyright (c) <2010>, Intel Corporation
  30  * All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  *
  36  * - Redistributions of source code must retain the above copyright
  37  *   notice, this list of conditions and the following disclaimer.
  38  *
  39  * - Redistributions in binary form must reproduce the above copyright
  40  *   notice, this list of conditions and the following disclaimer in
  41  *   the documentation and/or other materials provided with the
  42  *   distribution.
  43  *
  44  * - Neither the name of Intel Corporation nor the names of its
  45  *   contributors may be used to endorse or promote products derived
  46  *   from this software without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  49  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  50  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  51  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  52  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  53  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  54  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  55  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  57  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  58  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  59  * OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #ifndef UCG_CMD_VT100_H_
  63 #define UCG_CMD_VT100_H_
  64
  65 #define ucg_vt100_bell         "\007"
  66 #define ucg_vt100_bs           "\010"
  67 #define ucg_vt100_bs_clear     "\010 \010"
  68 #define ucg_vt100_tab          "\011"
  69 #define ucg_vt100_crnl         "\012\015"
  70 #define ucg_vt100_clear_right  "\033[0K"
  71 #define ucg_vt100_clear_left   "\033[1K"
  72 #define ucg_vt100_clear_down   "\033[0J"
  73 #define ucg_vt100_clear_up     "\033[1J"
  74 #define ucg_vt100_clear_line   "\033[2K"
  75 #define ucg_vt100_clear_screen "\033[2J"
  76 #define ucg_vt100_up_arr       "\033\133\101"
  77 #define ucg_vt100_down_arr     "\033\133\102"
  78 #define ucg_vt100_right_arr    "\033\133\103"
  79 #define ucg_vt100_left_arr     "\033\133\104"
  80 #define ucg_vt100_multi_right  "\033\133%uC"
  81 #define ucg_vt100_multi_left   "\033\133%uD"
  82 #define ucg_vt100_suppr        "\033\133\063\176"
  83 #define ucg_vt100_home         "\033M\033E"
  84 #define ucg_vt100_word_left    "\033\142"
  85 #define ucg_vt100_word_right   "\033\146"
  86
  87 /* Result of parsing : it must be synchronized with
  88  * ucg_cmd_vt100_commands[] in vt100.c */
  89 #define UCG_CMD_KEY_UP_ARR 0
  90 #define UCG_CMD_KEY_DOWN_ARR 1
  91 #define UCG_CMD_KEY_RIGHT_ARR 2
  92 #define UCG_CMD_KEY_LEFT_ARR 3
  93 #define UCG_CMD_KEY_BKSPACE 4
  94 #define UCG_CMD_KEY_RETURN 5
  95 #define UCG_CMD_KEY_CTRL_A 6
  96 #define UCG_CMD_KEY_CTRL_E 7
  97 #define UCG_CMD_KEY_CTRL_K 8
  98 #define UCG_CMD_KEY_CTRL_Y 9
  99 #define UCG_CMD_KEY_CTRL_C 10
 100 #define UCG_CMD_KEY_CTRL_F 11
 101 #define UCG_CMD_KEY_CTRL_B 12
 102 #define UCG_CMD_KEY_SUPPR 13
 103 #define UCG_CMD_KEY_TAB 14
 104 #define UCG_CMD_KEY_CTRL_D 15
 105 #define UCG_CMD_KEY_CTRL_L 16
 106 #define UCG_CMD_KEY_RETURN2 17
 107 #define UCG_CMD_KEY_META_BKSPACE 18
 108 #define UCG_CMD_KEY_WLEFT 19
 109 #define UCG_CMD_KEY_WRIGHT 20
 110 #define UCG_CMD_KEY_HELP 21
 111 #define UCG_CMD_KEY_CTRL_W 22
 112 #define UCG_CMD_KEY_CTRL_P 23
 113 #define UCG_CMD_KEY_CTRL_N 24
 114 #define UCG_CMD_KEY_META_D 25
 115
 116 extern const char *ucg_cmd_vt100_commands[];
 117
 118 enum ucg_cmd_vt100_parser_state {
 119         UCG_CMD_VT100_INIT,
 120         UCG_CMD_VT100_ESCAPE,
 121         UCG_CMD_VT100_ESCAPE_CSI
 122 };
 123
 124 #define UCG_CMD_VT100_BUF_SIZE 8
 125 struct ucg_cmd_vt100 {
 126         uint8_t bufpos;
 127         char buf[UCG_CMD_VT100_BUF_SIZE];
 128         enum ucg_cmd_vt100_parser_state state;
 129 };
 130
 131 /**
 132  * Init
 133  */
 134 void ucg_vt100_init(struct ucg_cmd_vt100 *vt);
 135
 136 #define UCG_VT100_STD_CHAR     -1
 137 #define UCG_VT100_NOT_COMPLETE -2
 138 /**
 139  * Input a new character.
 140  * Return UCG_VT100_STD_CHAR if the character is not part of a control sequence
 141  * Return UCG_VT100_NOT_COMPLETE if c is not the last char of a control sequence
 142  * Else return the index in ucg_vt100_commands[]
 143  */
 144 int ucg_vt100_parser(struct ucg_cmd_vt100 *vt, char c);
 145
 146 #endif /* UCG_CMD_VT100_H_ */