Shinichiro Nakamura / NaturalTinyShell

Natural Tiny Shell (NT-Shell) library is a tiny shell library for a small embedded system. The interface is really simple. You should only know ntshell_execute in ntshell.h. So you can port it to any embedded system easily. Please enjoy your small embedded system with it. :)

Dependents:   NaturalTinyShell_TestProgram

text_history.c@0:7147d6024de8, 2011-05-22 (annotated)

Committer:
shintamainjp
Date:
Sun May 22 02:51:35 2011 +0000
Revision:
0:7147d6024de8
Initial version.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
shintamainjp 0:7147d6024de8 1 /**
shintamainjp 0:7147d6024de8 2 * @file text_history.c
shintamainjp 0:7147d6024de8 3 * @author Shinichiro Nakamura
shintamainjp 0:7147d6024de8 4 * @brief NT-Shell用テキストヒストリモジュールの実装。
shintamainjp 0:7147d6024de8 5 * @details
shintamainjp 0:7147d6024de8 6 * 文字列の入力履歴を論理的に扱うためのモジュール。
shintamainjp 0:7147d6024de8 7 * このモジュールはビューに関して一切感知しない。
shintamainjp 0:7147d6024de8 8 */
shintamainjp 0:7147d6024de8 9
shintamainjp 0:7147d6024de8 10 /*
shintamainjp 0:7147d6024de8 11 * ===============================================================
shintamainjp 0:7147d6024de8 12 * Natural Tiny Shell (NT-Shell)
shintamainjp 0:7147d6024de8 13 * Version 0.0.6
shintamainjp 0:7147d6024de8 14 * ===============================================================
shintamainjp 0:7147d6024de8 15 * Copyright (c) 2010-2011 Shinichiro Nakamura
shintamainjp 0:7147d6024de8 16 *
shintamainjp 0:7147d6024de8 17 * Permission is hereby granted, free of charge, to any person
shintamainjp 0:7147d6024de8 18 * obtaining a copy of this software and associated documentation
shintamainjp 0:7147d6024de8 19 * files (the "Software"), to deal in the Software without
shintamainjp 0:7147d6024de8 20 * restriction, including without limitation the rights to use,
shintamainjp 0:7147d6024de8 21 * copy, modify, merge, publish, distribute, sublicense, and/or
shintamainjp 0:7147d6024de8 22 * sell copies of the Software, and to permit persons to whom the
shintamainjp 0:7147d6024de8 23 * Software is furnished to do so, subject to the following
shintamainjp 0:7147d6024de8 24 * conditions:
shintamainjp 0:7147d6024de8 25 *
shintamainjp 0:7147d6024de8 26 * The above copyright notice and this permission notice shall be
shintamainjp 0:7147d6024de8 27 * included in all copies or substantial portions of the Software.
shintamainjp 0:7147d6024de8 28 *
shintamainjp 0:7147d6024de8 29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
shintamainjp 0:7147d6024de8 30 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
shintamainjp 0:7147d6024de8 31 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
shintamainjp 0:7147d6024de8 32 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
shintamainjp 0:7147d6024de8 33 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
shintamainjp 0:7147d6024de8 34 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
shintamainjp 0:7147d6024de8 35 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
shintamainjp 0:7147d6024de8 36 * OTHER DEALINGS IN THE SOFTWARE.
shintamainjp 0:7147d6024de8 37 * ===============================================================
shintamainjp 0:7147d6024de8 38 */
shintamainjp 0:7147d6024de8 39
shintamainjp 0:7147d6024de8 40 #include "text_history.h"
shintamainjp 0:7147d6024de8 41 #include "ntlibc.h"
shintamainjp 0:7147d6024de8 42
shintamainjp 0:7147d6024de8 43 /**
shintamainjp 0:7147d6024de8 44 * @brief 初期化する。
shintamainjp 0:7147d6024de8 45 *
shintamainjp 0:7147d6024de8 46 * @param p テキストヒストリ構造体。
shintamainjp 0:7147d6024de8 47 */
shintamainjp 0:7147d6024de8 48 void text_history_init(text_history_t *p)
shintamainjp 0:7147d6024de8 49 {
shintamainjp 0:7147d6024de8 50 p->rp = 0;
shintamainjp 0:7147d6024de8 51 p->wp = 0;
shintamainjp 0:7147d6024de8 52 int i;
shintamainjp 0:7147d6024de8 53 for (i = 0; i < sizeof(p->history); i++) {
shintamainjp 0:7147d6024de8 54 p->history[i] = 0;
shintamainjp 0:7147d6024de8 55 }
shintamainjp 0:7147d6024de8 56 }
shintamainjp 0:7147d6024de8 57
shintamainjp 0:7147d6024de8 58 /**
shintamainjp 0:7147d6024de8 59 * @brief テキストヒストリに対して書き込みを実行する。
shintamainjp 0:7147d6024de8 60 *
shintamainjp 0:7147d6024de8 61 * @param p テキストヒストリ構造体。
shintamainjp 0:7147d6024de8 62 * @param buf バッファ。
shintamainjp 0:7147d6024de8 63 */
shintamainjp 0:7147d6024de8 64 int text_history_write(text_history_t *p, char *buf)
shintamainjp 0:7147d6024de8 65 {
shintamainjp 0:7147d6024de8 66 if (buf[0] == '\0') {
shintamainjp 0:7147d6024de8 67 return 0;
shintamainjp 0:7147d6024de8 68 }
shintamainjp 0:7147d6024de8 69 char *sp = p->history + (TEXTHISTORY_MAXLEN * p->wp);
shintamainjp 0:7147d6024de8 70 while (*buf) {
shintamainjp 0:7147d6024de8 71 *sp = *buf;
shintamainjp 0:7147d6024de8 72 sp++;
shintamainjp 0:7147d6024de8 73 buf++;
shintamainjp 0:7147d6024de8 74 }
shintamainjp 0:7147d6024de8 75 *sp = '\0';
shintamainjp 0:7147d6024de8 76 p->wp = (p->wp + 1) % TEXTHISTORY_DEPTH;
shintamainjp 0:7147d6024de8 77 p->rp = p->wp;
shintamainjp 0:7147d6024de8 78 return 1;
shintamainjp 0:7147d6024de8 79 }
shintamainjp 0:7147d6024de8 80
shintamainjp 0:7147d6024de8 81 /**
shintamainjp 0:7147d6024de8 82 * @brief テキストヒストリから読み出しを実行する。
shintamainjp 0:7147d6024de8 83 * @details
shintamainjp 0:7147d6024de8 84 * 得られる文字列が与えられたバッファサイズよりも大きい場合、
shintamainjp 0:7147d6024de8 85 * バッファに格納される文字列は途中で途切れるものとする。
shintamainjp 0:7147d6024de8 86 *
shintamainjp 0:7147d6024de8 87 * @param p テキストヒストリ構造体。
shintamainjp 0:7147d6024de8 88 * @param buf バッファ。
shintamainjp 0:7147d6024de8 89 * @param siz バッファサイズ。
shintamainjp 0:7147d6024de8 90 */
shintamainjp 0:7147d6024de8 91 int text_history_read(text_history_t *p, char *buf, const int siz)
shintamainjp 0:7147d6024de8 92 {
shintamainjp 0:7147d6024de8 93 char *sp = p->history + (TEXTHISTORY_MAXLEN * p->rp);
shintamainjp 0:7147d6024de8 94 int n = 0;
shintamainjp 0:7147d6024de8 95 while (*sp) {
shintamainjp 0:7147d6024de8 96 *buf = *sp;
shintamainjp 0:7147d6024de8 97 buf++;
shintamainjp 0:7147d6024de8 98 sp++;
shintamainjp 0:7147d6024de8 99 n++;
shintamainjp 0:7147d6024de8 100 if (siz - 1 <= n) {
shintamainjp 0:7147d6024de8 101 break;
shintamainjp 0:7147d6024de8 102 }
shintamainjp 0:7147d6024de8 103 }
shintamainjp 0:7147d6024de8 104 *buf = '\0';
shintamainjp 0:7147d6024de8 105 return n;
shintamainjp 0:7147d6024de8 106 }
shintamainjp 0:7147d6024de8 107
shintamainjp 0:7147d6024de8 108 /**
shintamainjp 0:7147d6024de8 109 * @brief 読み出しポインタを次に進める。
shintamainjp 0:7147d6024de8 110 *
shintamainjp 0:7147d6024de8 111 * @param p テキストヒストリ構造体。
shintamainjp 0:7147d6024de8 112 */
shintamainjp 0:7147d6024de8 113 int text_history_read_point_next(text_history_t *p)
shintamainjp 0:7147d6024de8 114 {
shintamainjp 0:7147d6024de8 115 int n = (p->rp + 1) % TEXTHISTORY_DEPTH;
shintamainjp 0:7147d6024de8 116 if (n != p->wp) {
shintamainjp 0:7147d6024de8 117 p->rp = n;
shintamainjp 0:7147d6024de8 118 return 1;
shintamainjp 0:7147d6024de8 119 }
shintamainjp 0:7147d6024de8 120 return 0;
shintamainjp 0:7147d6024de8 121 }
shintamainjp 0:7147d6024de8 122
shintamainjp 0:7147d6024de8 123 /**
shintamainjp 0:7147d6024de8 124 * @brief 読み出しポインタを前に戻す。
shintamainjp 0:7147d6024de8 125 *
shintamainjp 0:7147d6024de8 126 * @param p テキストヒストリ構造体。
shintamainjp 0:7147d6024de8 127 */
shintamainjp 0:7147d6024de8 128 int text_history_read_point_prev(text_history_t *p)
shintamainjp 0:7147d6024de8 129 {
shintamainjp 0:7147d6024de8 130 int n = (p->rp == 0) ? (TEXTHISTORY_DEPTH - 1) : (p->rp - 1);
shintamainjp 0:7147d6024de8 131 if (n != p->wp) {
shintamainjp 0:7147d6024de8 132 char *sp = p->history + (TEXTHISTORY_MAXLEN * n);
shintamainjp 0:7147d6024de8 133 if (*sp != '\0') {
shintamainjp 0:7147d6024de8 134 p->rp = n;
shintamainjp 0:7147d6024de8 135 return 1;
shintamainjp 0:7147d6024de8 136 }
shintamainjp 0:7147d6024de8 137 }
shintamainjp 0:7147d6024de8 138 return 0;
shintamainjp 0:7147d6024de8 139 }
shintamainjp 0:7147d6024de8 140
shintamainjp 0:7147d6024de8 141 /**
shintamainjp 0:7147d6024de8 142 * @brief 与えられたテキストで始まる文字列を探す。
shintamainjp 0:7147d6024de8 143 * @details このインターフェースはテキスト入力補完のために作られた。
shintamainjp 0:7147d6024de8 144 *
shintamainjp 0:7147d6024de8 145 * @param p テキストヒストリオブジェクト。
shintamainjp 0:7147d6024de8 146 * @param index ヒストリ中で見つかる文字列のindex個目。
shintamainjp 0:7147d6024de8 147 * @param text 検索する文字列。
shintamainjp 0:7147d6024de8 148 * @param buf 格納先バッファ。
shintamainjp 0:7147d6024de8 149 * @param siz 格納先バッファサイズ。
shintamainjp 0:7147d6024de8 150 *
shintamainjp 0:7147d6024de8 151 * @retval 0 成功。
shintamainjp 0:7147d6024de8 152 * @retval 0以外 失敗。
shintamainjp 0:7147d6024de8 153 */
shintamainjp 0:7147d6024de8 154 int text_history_find(text_history_t *p,
shintamainjp 0:7147d6024de8 155 const int index, const char *text,
shintamainjp 0:7147d6024de8 156 char *buf, const int siz)
shintamainjp 0:7147d6024de8 157 {
shintamainjp 0:7147d6024de8 158 const int text_len = ntlibc_strlen((const char *)text);
shintamainjp 0:7147d6024de8 159 int found = 0;
shintamainjp 0:7147d6024de8 160 int i;
shintamainjp 0:7147d6024de8 161 for (i = 0; i < TEXTHISTORY_DEPTH; i++) {
shintamainjp 0:7147d6024de8 162 int target = (p->rp + i) % TEXTHISTORY_DEPTH;
shintamainjp 0:7147d6024de8 163 char *txtp = p->history + (TEXTHISTORY_MAXLEN * target);
shintamainjp 0:7147d6024de8 164 const int target_len = ntlibc_strlen((const char *)txtp);
shintamainjp 0:7147d6024de8 165 int comp_len = (target_len < text_len) ? target_len : text_len;
shintamainjp 0:7147d6024de8 166 if ((ntlibc_strncmp(
shintamainjp 0:7147d6024de8 167 (const char *)txtp,
shintamainjp 0:7147d6024de8 168 (const char *)text, comp_len) == 0) && (comp_len > 0)) {
shintamainjp 0:7147d6024de8 169 if (found == index) {
shintamainjp 0:7147d6024de8 170 ntlibc_strcpy((char *)buf, (char *)txtp);
shintamainjp 0:7147d6024de8 171 return 0;
shintamainjp 0:7147d6024de8 172 }
shintamainjp 0:7147d6024de8 173 found++;
shintamainjp 0:7147d6024de8 174 }
shintamainjp 0:7147d6024de8 175 }
shintamainjp 0:7147d6024de8 176 return -1;
shintamainjp 0:7147d6024de8 177 }
shintamainjp 0:7147d6024de8 178