ntshell.readme_ja

   1 ===============================================================
   2  Natural Tiny Shell - A tiny shell for a small embedded system
   3  Copyright(C) 2011 Shinichiro Nakamura
   4 ===============================================================
   5
   6  Natural Tiny Shell (NT-Shell) は小規模組み込みシステム用の
   7  小さなシェルです。
   8
   9 1. 謝辞
  10
  11  Paul Williamsさん
  12  - 彼はDEC互換のステートマシンパーサの図を作りました。
  13
  14  Joshua Habermanさん
  15  - 彼はステートマシンパーサの実装をC言語で行ないました。
  16    それは素晴らしいインターフェースを持ち、シンプルで賢いです。
  17
  18 2. 背景
  19
  20  今日、沢山の優れたMPUが手に入ります。
  21  我々はそれらを使って小規模組み込みシステムを設計することができます。
  22  それは素晴らしいことで、20年前には考えられなかったことです。
  23
  24  システムを設計実装している時点で有効なデバッグ手段の１つにUARTを
  25  インターフェースとして端末のようなものを実現する手段があります。
  26  これは我々がUNIX端末上でシステムに対して要求を出すような形式で
  27  MPUを使ったシステムに対して要求を出すことができます。
  28
  29  対話形式でシステムの状態を観察したり、状態を変化させるためのパラメータを
  30  入力することができますので、スムーズに作業することができるのが特徴です。
  31
  32  しかしながら、世の中に存在する沢山の小規模組み込みシステムの端末の実装は
  33  あまり良いものがないのが現状でした。
  34  一部の制御コードのみに対応した結果、様々なキー入力によって表示や入力文字列
  35  が破綻してしまうものなどが大多数です。
  36
  37  今回はこれらの状況を打開すべくVT100をエミュレートした小さなシェルを
  38  実装してみました。
  39  このシェルを組み込み機器に搭載すれば、キー入力に慎重になる必要がなく、
  40  スムーズにデバッグを行うことができます。
  41
  42  このシェルには履歴機能もあります。
  43  過去に入力したコマンドを選択して編集した後で実行することもできます。
  44
  45 3. 基本コンセプト
  46
  47  * 小さい :)
  48  * シンプル :)
  49  * VT100互換 :)
  50  * Cランタイムライブラリが不要 :)
  51
  52 4. 機能
  53
  54  CTRL+A : Head
  55  CTRL+E : Tail
  56  CTRL+F : Cursor right
  57  CTRL+B : Cursor left
  58  CTRL+C : Cancel
  59  CTRL+P : History(Prev)
  60  CTRL+N : History(Next)
  61  TAB    : Suggestion
  62
  63 5. 構造
  64
  65  NT-Shellは５つの部品から構成されています。
  66
  67  * 最上位インターフェースモジュール
  68     ntshell.c
  69     ntshell.h
  70  * ユティリティ
  71     ntopt.c
  72     ntopt.h
  73  * VT100パーサ
  74     vtparse.c
  75     vtparse.h
  76     vtparse_table.c
  77     vtparse_table.h
  78  * テキストエディタ
  79     text_editor.c
  80     text_editor.h
  81  * テキストヒストリ
  82     text_history.c
  83     text_history.h
  84
  85 6. ポーティングガイド
  86
  87  NT-Shellのインターフェースは非常にシンプルです。
  88  UARTのための２つの入出力インターフェースとユーザ要求を取得するための
  89  １つのコールバックインターフェースを必要とします。
  90
  91  void ntshell(
  92         int (*func_read)(char *buf, int cnt),
  93         int (*func_write)(const char *buf, int cnt),
  94         int (*func_cb)(const char *text));
  95
  96  6-1. func_read
  97
  98   func_readはユーザキー入力を読むためのインターフェースです。
  99   キーを読み込むまでブロックするインターフェースとして実装されている
 100   必要があります。
 101
 102  6-2. func_write
 103
 104   func_writeはシェル出力を書くためのインターフェースです。
 105   書き込みが終了するまでブロックするインターフェースとして実装されている
 106   必要があります。
 107
 108  6-3. func_cb
 109
 110   func_cbはシステムに対するユーザ要求文字列を取得するための
 111   インターフェースです。
 112
 113 7. ライセンス
 114
 115  * vtparse and vtparse_tableはパブリックドメインとして提供されています。
 116  * ntshell, ntopt, ntlibc, text_editor, text_historyはMITライセンスです。
 117
 118  ===============================================================
 119  The MIT license for Natural Tiny Shell (NT-Shell)
 120  ===============================================================
 121  Copyright (c) 2010-2011 Shinichiro Nakamura
 122
 123  Permission is hereby granted, free of charge, to any person
 124  obtaining a copy of this software and associated documentation
 125  files (the "Software"), to deal in the Software without
 126  restriction, including without limitation the rights to use,
 127  copy, modify, merge, publish, distribute, sublicense, and/or
 128  sell copies of the Software, and to permit persons to whom the
 129  Software is furnished to do so, subject to the following
 130  conditions:
 131
 132  The above copyright notice and this permission notice shall be
 133  included in all copies or substantial portions of the Software.
 134
 135  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 136  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 137  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 138  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 139  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 140  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 141  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 142  OTHER DEALINGS IN THE SOFTWARE.
 143  ===============================================================
 144
 145  よってNatural Tiny Shell (NT-Shell)は非商用、商用を問わず製品に使用する
 146  ことができます。
 147  しかしながら、無保証です。
 148
 149  再配布する場合に、著作権文字列を取り除かないで下さい。
 150
 151 8. 参考文献
 152
 153  * A parser for DEC’s ANSI-compatible video terminal
 154    http://vt100.net/emu/dec_ansi_parser
 155
 156 9. バージョン
 157
 158  * 2011/03/01   Version 0.0.1    初版。
 159  * 2011/03/02   Version 0.0.2    ユティリティモジュールを追加。
 160  * 2011/03/04   Version 0.0.3    バグ修正。
 161  * 2011/04/30   Version 0.0.4    vtparseのテーブルがROMに配置されるようにした。
 162                                  ntoptの欠落を修正した。
 163                                  ntlibcを追加した。
 164  * 2011/05/16   Version 0.0.5    入力補完機能を追加した。
 165                                  ntshellのインターフェースを変更した。
 166  * 2011/05/22   Version 0.0.6    カーソルの先頭ジャンプ機能を追加した。
 167  * 2011/09/22   Version 0.0.7    ntoptインターフェースを更新した。