firm/bare_metal/common/ntshell/text_editor.h

   1 /**
   2  * @file text_editor.h
   3  * @author Shinichiro Nakamura
   4  * @brief NT-Shell用テキストエディタモジュールの定義。
   5  * @details
   6  * 文字列の編集を論理的に扱うためのモジュール。
   7  * このモジュールはビューに関して一切感知しない。
   8  */
   9
  10 /*
  11  * ===============================================================
  12  *  Natural Tiny Shell (NT-Shell)
  13  *  Version 0.0.8
  14  * ===============================================================
  15  * Copyright (c) 2010-2011 Shinichiro Nakamura
  16  *
  17  * Permission is hereby granted, free of charge, to any person
  18  * obtaining a copy of this software and associated documentation
  19  * files (the "Software"), to deal in the Software without
  20  * restriction, including without limitation the rights to use,
  21  * copy, modify, merge, publish, distribute, sublicense, and/or
  22  * sell copies of the Software, and to permit persons to whom the
  23  * Software is furnished to do so, subject to the following
  24  * conditions:
  25  *
  26  * The above copyright notice and this permission notice shall be
  27  * included in all copies or substantial portions of the Software.
  28  *
  29  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  31  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  33  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  34  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  35  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  36  * OTHER DEALINGS IN THE SOFTWARE.
  37  * ===============================================================
  38  */
  39
  40 #ifndef TEXT_EDITOR_H
  41 #define TEXT_EDITOR_H
  42
  43 #include "ntconf.h"
  44
  45 /**
  46  * @brief 編集可能な文字列最大長。
  47  */
  48 #define TEXTEDITOR_MAXLEN   (NTCONF_EDITOR_MAXLEN)
  49
  50 /**
  51  * @brief テキストエディタ構造体の実装。
  52  */
  53 typedef struct {
  54     char buffer[TEXTEDITOR_MAXLEN]; /**< バッファ。 */
  55     int pos;                        /**< カーソル位置。 */
  56     int len;                        /**< テキスト長さ。 */
  57 } text_editor_t;
  58
  59 void text_editor_init(text_editor_t *p);
  60 int text_editor_insert(text_editor_t *p, char c);
  61 int text_editor_backspace(text_editor_t *p);
  62 int text_editor_delete(text_editor_t *p);
  63 int text_editor_cursor_get_position(text_editor_t *p);
  64 int text_editor_cursor_head(text_editor_t *p);
  65 int text_editor_cursor_tail(text_editor_t *p);
  66 int text_editor_cursor_left(text_editor_t *p);
  67 int text_editor_cursor_right(text_editor_t *p);
  68 int text_editor_set_text(text_editor_t *p, char *buf);
  69 int text_editor_get_text(text_editor_t *p, char *buf, int siz);
  70 void text_editor_clear(text_editor_t *p);
  71
  72 #endif
  73