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
Diff: ntshell.h
- Revision:
- 0:7147d6024de8
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ntshell.h Sun May 22 02:51:35 2011 +0000 @@ -0,0 +1,58 @@ +/** + * @file ntshell.h + * @author Shinichiro Nakamura + * @brief 小規模組み込みシステム向けのシェルシステムの定義。 + */ + +/* + * =============================================================== + * Natural Tiny Shell (NT-Shell) + * Version 0.0.6 + * =============================================================== + * Copyright (c) 2010-2011 Shinichiro Nakamura + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + * =============================================================== + */ + +#ifndef _NTSHELL_H_ +#define _NTSHELL_H_ + +#include "vtparse.h" +#include "text_editor.h" +#include "text_history.h" + +typedef struct { + vtparse_t parser; + text_editor_t editor; + text_history_t history; +} ntshell_t; + +void ntshell_version(int *major, int *minor, int *release); +void ntshell_execute( + ntshell_t *p, + int (*func_read)(char *buf, int cnt), + int (*func_write)(const char *buf, int cnt), + int (*func_cb)(const char *text)); + +#endif +