firm/bare_metal/common/ntshell/ntshell.h

   1 /**
   2  * @file ntshell.h
   3  * @author Shinichiro Nakamura
   4  * @brief 小規模組み込みシステム向けのシェルシステムの定義。
   5  */
   6
   7 /*
   8  * ===============================================================
   9  *  Natural Tiny Shell (NT-Shell)
  10  *  Version 0.0.8
  11  * ===============================================================
  12  * Copyright (c) 2010-2011 Shinichiro Nakamura
  13  *
  14  * Permission is hereby granted, free of charge, to any person
  15  * obtaining a copy of this software and associated documentation
  16  * files (the "Software"), to deal in the Software without
  17  * restriction, including without limitation the rights to use,
  18  * copy, modify, merge, publish, distribute, sublicense, and/or
  19  * sell copies of the Software, and to permit persons to whom the
  20  * Software is furnished to do so, subject to the following
  21  * conditions:
  22  *
  23  * The above copyright notice and this permission notice shall be
  24  * included in all copies or substantial portions of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  28  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  30  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  31  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  32  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  33  * OTHER DEALINGS IN THE SOFTWARE.
  34  * ===============================================================
  35  */
  36
  37 #ifndef NTSHELL_H
  38 #define NTSHELL_H
  39
  40 #include "vtrecv.h"
  41 #include "vtsend.h"
  42 #include "text_editor.h"
  43 #include "text_history.h"
  44
  45 /**
  46  * @brief NT-Shelハンドラの実装。
  47  * @details
  48  * 本来このハンドラは定義のみを公開し、実装の詳細を隠蔽すべきだが、
  49  * ヒープからメモリを確保するインターフェースのない環境も有り得る
  50  * 事を考慮して公開してある。
  51  * このため、スタックに置いた構造体を使って制御する事も可能である。
  52  */
  53 typedef struct {
  54     vtrecv_t vtrecv;        /**< vtrecvハンドラ。 */
  55     vtsend_t vtsend;        /**< vtsendハンドラ。 */
  56     text_editor_t editor;   /**< text_editorハンドラ。 */
  57     text_history_t history; /**< text_historyハンドラ。 */
  58 } ntshell_t;
  59
  60 void ntshell_version(int *major, int *minor, int *release);
  61 void ntshell_execute(
  62         ntshell_t *p,
  63         int (*func_read)(char *buf, int cnt),
  64         int (*func_write)(const char *buf, int cnt),
  65         int (*func_callback)(const char *text, void *extobj),
  66         void *func_callback_extobj);
  67
  68 #endif
  69