src/lib/cmdline_vt100.h

   1 /*-
   2  * Copyright (c) <2010>, Intel Corporation
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  17  * - Neither the name of Intel Corporation nor the names of its
  18  *   contributors may be used to endorse or promote products derived
  19  *   from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  32  * OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  37  * All rights reserved.
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in the
  45  *       documentation and/or other materials provided with the distribution.
  46  *     * Neither the name of the University of California, Berkeley nor the
  47  *       names of its contributors may be used to endorse or promote products
  48  *       derived from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  51  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  52  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  53  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  54  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  55  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  57  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #ifndef _CMDLINE_VT100_H_
  63 #define _CMDLINE_VT100_H_
  64
  65 #define vt100_bell         "\007"
  66 #define vt100_bs           "\010"
  67 #define vt100_bs_clear     "\010 \010"
  68 #define vt100_tab          "\011"
  69 #define vt100_crnl         "\012\015"
  70 #define vt100_clear_right  "\033[0K"
  71 #define vt100_clear_left   "\033[1K"
  72 #define vt100_clear_down   "\033[0J"
  73 #define vt100_clear_up     "\033[1J"
  74 #define vt100_clear_line   "\033[2K"
  75 #define vt100_clear_screen "\033[2J"
  76 #define vt100_up_arr       "\033\133\101"
  77 #define vt100_down_arr     "\033\133\102"
  78 #define vt100_right_arr    "\033\133\103"
  79 #define vt100_left_arr     "\033\133\104"
  80 #define vt100_multi_right  "\033\133%uC"
  81 #define vt100_multi_left   "\033\133%uD"
  82 #define vt100_suppr        "\033\133\063\176"
  83 #define vt100_home         "\033M\033E"
  84 #define vt100_word_left    "\033\142"
  85 #define vt100_word_right   "\033\146"
  86
  87
  88 /* Result of parsing : it must be synchronized with
  89  * cmdline_vt100_commands[] in vt100.c */
  90 #define CMDLINE_KEY_UP_ARR 0
  91 #define CMDLINE_KEY_DOWN_ARR 1
  92 #define CMDLINE_KEY_RIGHT_ARR 2
  93 #define CMDLINE_KEY_LEFT_ARR 3
  94 #define CMDLINE_KEY_BKSPACE 4
  95 #define CMDLINE_KEY_RETURN 5
  96 #define CMDLINE_KEY_CTRL_A 6
  97 #define CMDLINE_KEY_CTRL_E 7
  98 #define CMDLINE_KEY_CTRL_K 8
  99 #define CMDLINE_KEY_CTRL_Y 9
 100 #define CMDLINE_KEY_CTRL_C 10
 101 #define CMDLINE_KEY_CTRL_F 11
 102 #define CMDLINE_KEY_CTRL_B 12
 103 #define CMDLINE_KEY_SUPPR 13
 104 #define CMDLINE_KEY_TAB 14
 105 #define CMDLINE_KEY_CTRL_D 15
 106 #define CMDLINE_KEY_CTRL_L 16
 107 #define CMDLINE_KEY_RETURN2 17
 108 #define CMDLINE_KEY_META_BKSPACE 18
 109 #define CMDLINE_KEY_WLEFT 19
 110 #define CMDLINE_KEY_WRIGHT 20
 111 #define CMDLINE_KEY_HELP 21
 112
 113 extern const char *cmdline_vt100_commands[];
 114
 115 enum cmdline_vt100_parser_state {
 116         CMDLINE_VT100_INIT,
 117         CMDLINE_VT100_ESCAPE,
 118         CMDLINE_VT100_ESCAPE_CSI
 119 };
 120
 121 #define CMDLINE_VT100_BUF_SIZE 8
 122 struct cmdline_vt100 {
 123         uint8_t bufpos;
 124         char buf[CMDLINE_VT100_BUF_SIZE];
 125         enum cmdline_vt100_parser_state state;
 126 };
 127
 128 /**
 129  * Init
 130  */
 131 void vt100_init(struct cmdline_vt100 *vt);
 132
 133 /**
 134  * Input a new character.
 135  * Return -1 if the character is not part of a control sequence
 136  * Return -2 if c is not the last char of a control sequence
 137  * Else return the index in vt100_commands[]
 138  */
 139 int vt100_parser(struct cmdline_vt100 *vt, char c);
 140
 141 #endif