lib/librte_cmdline/cmdline_vt100.h

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