2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: shell.h Source File< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "headertitle" >
< h1 > shell.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "shell_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < pre class = "fragment" > < a name = "l00001" > < / a > 00001 < span class = "comment" > /*< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00002" > < / a > 00002 < span class = "comment" > ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.< / span >
< a name = "l00003" > < / a > 00003 < span class = "comment" > < / span >
< a name = "l00004" > < / a > 00004 < span class = "comment" > This file is part of ChibiOS/RT.< / span >
< a name = "l00005" > < / a > 00005 < span class = "comment" > < / span >
< a name = "l00006" > < / a > 00006 < span class = "comment" > ChibiOS/RT is free software; you can redistribute it and/or modify< / span >
< a name = "l00007" > < / a > 00007 < span class = "comment" > it under the terms of the GNU General Public License as published by< / span >
< a name = "l00008" > < / a > 00008 < span class = "comment" > the Free Software Foundation; either version 3 of the License, or< / span >
< a name = "l00009" > < / a > 00009 < span class = "comment" > (at your option) any later version.< / span >
< a name = "l00010" > < / a > 00010 < span class = "comment" > < / span >
< a name = "l00011" > < / a > 00011 < span class = "comment" > ChibiOS/RT is distributed in the hope that it will be useful,< / span >
< a name = "l00012" > < / a > 00012 < span class = "comment" > but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< a name = "l00013" > < / a > 00013 < span class = "comment" > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< a name = "l00014" > < / a > 00014 < span class = "comment" > GNU General Public License for more details.< / span >
< a name = "l00015" > < / a > 00015 < span class = "comment" > < / span >
< a name = "l00016" > < / a > 00016 < span class = "comment" > You should have received a copy of the GNU General Public License< / span >
< a name = "l00017" > < / a > 00017 < span class = "comment" > along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< a name = "l00018" > < / a > 00018 < span class = "comment" > < / span >
< a name = "l00019" > < / a > 00019 < span class = "comment" > ---< / span >
< a name = "l00020" > < / a > 00020 < span class = "comment" > < / span >
< a name = "l00021" > < / a > 00021 < span class = "comment" > A special exception to the GPL can be applied should you wish to distribute< / span >
< a name = "l00022" > < / a > 00022 < span class = "comment" > a combined work that includes ChibiOS/RT, without being obliged to provide< / span >
< a name = "l00023" > < / a > 00023 < span class = "comment" > the source code for any proprietary components. See the file exception.txt< / span >
< a name = "l00024" > < / a > 00024 < span class = "comment" > for full details of how and when the exception can be applied.< / span >
< a name = "l00025" > < / a > 00025 < span class = "comment" > */< / span >
< a name = "l00026" > < / a > 00026 < span class = "comment" > < / span >
< a name = "l00027" > < / a > 00027 < span class = "comment" > /**< / span >
< a name = "l00028" > < / a > 00028 < span class = "comment" > * @file shell.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief Simple CLI shell header.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > * @addtogroup SHELL< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @{< / span >
< a name = "l00032" > < / a > 00032 < span class = "comment" > */< / span >
< a name = "l00033" > < / a > 00033
< a name = "l00034" > < / a > 00034 < span class = "preprocessor" > #ifndef _SHELL_H_< / span >
< a name = "l00035" > < / a > 00035 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _SHELL_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00037" > < / a > 00037 < span class = "comment" > /**< / span >
< a name = "l00038" > < / a > 00038 < span class = "comment" > * @brief Shell maximum input line length.< / span >
< a name = "l00039" > < / a > 00039 < span class = "comment" > */< / span >
< a name = "l00040" > < / a > 00040 < span class = "preprocessor" > #if !defined(SHELL_MAX_LINE_LENGTH) || defined(__DOXYGEN__)< / span >
< a name = "l00041" > < / a > < a class = "code" href = "group___s_h_e_l_l.html#ga0aee139645cf59df04bc31635f553024" > 00041< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define SHELL_MAX_LINE_LENGTH 64< / span >
< a name = "l00042" > < / a > 00042 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00043" > < / a > 00043 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00044" > < / a > 00044 < span class = "comment" > /**< / span >
< a name = "l00045" > < / a > 00045 < span class = "comment" > * @brief Shell maximum arguments per command.< / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > */< / span >
< a name = "l00047" > < / a > 00047 < span class = "preprocessor" > #if !defined(SHELL_MAX_ARGUMENTS) || defined(__DOXYGEN__)< / span >
< a name = "l00048" > < / a > < a class = "code" href = "group___s_h_e_l_l.html#ga730dd92884d4fce406efb6678aea8062" > 00048< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define SHELL_MAX_ARGUMENTS 4< / span >
< a name = "l00049" > < / a > 00049 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00050" > < / a > 00050 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00051" > < / a > 00051 < span class = "comment" > /**< / span >
< a name = "l00052" > < / a > 00052 < span class = "comment" > * @brief Enforces the use of iprintf() on newlib.< / span >
< a name = "l00053" > < / a > 00053 < span class = "comment" > */< / span >
< a name = "l00054" > < / a > 00054 < span class = "preprocessor" > #if !defined(SHELL_USE_IPRINTF) || defined(__DOXYGEN__)< / span >
< a name = "l00055" > < / a > < a class = "code" href = "group___s_h_e_l_l.html#ga73b5fc520b80ade7b64b2f22c835dbd7" > 00055< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define SHELL_USE_IPRINTF TRUE< / span >
< a name = "l00056" > < / a > 00056 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00057" > < / a > 00057 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > /**< / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > * @brief Command handler function type.< / span >
< a name = "l00060" > < / a > 00060 < span class = "comment" > */< / span >
< a name = "l00061" > < / a > < a class = "code" href = "group___s_h_e_l_l.html#gac6a0d1d8a290b0c82979a1739e804bc1" > 00061< / a > < span class = "keyword" > typedef< / span > void (*< a class = "code" href = "group___s_h_e_l_l.html#gac6a0d1d8a290b0c82979a1739e804bc1" title = "Command handler function type." > shellcmd_t< / a > )(< a class = "code" href = "struct_base_channel.html" title = "Base channel class." > BaseChannel< / a > *chp, < span class = "keywordtype" > int< / span > argc, < span class = "keywordtype" > char< / span > *argv[]);
< a name = "l00062" > < / a > 00062 < span class = "comment" > < / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > /**< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > * @brief Custom command entry type.< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > */< / span >
< a name = "l00066" > < / a > < a class = "code" href = "struct_shell_command.html" > 00066< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {
< a name = "l00067" > < / a > < a class = "code" href = "struct_shell_command.html#afb689607842aa2cf6844eebdb8b36236" > 00067< / a > < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *sc_name; < span class = "comment" > /**< @brief Command name. */< / span >
< a name = "l00068" > < / a > < a class = "code" href = "struct_shell_command.html#ad95f7461ff8fdf89ce55d90ce99c632d" > 00068< / a > < a class = "code" href = "group___s_h_e_l_l.html#gac6a0d1d8a290b0c82979a1739e804bc1" title = "Command handler function type." > shellcmd_t< / a > sc_function; < span class = "comment" > /**< @brief Command function. */< / span >
< a name = "l00069" > < / a > 00069 } < a class = "code" href = "struct_shell_command.html" title = "Custom command entry type." > ShellCommand< / a > ;
< a name = "l00070" > < / a > 00070 < span class = "comment" > < / span >
< a name = "l00071" > < / a > 00071 < span class = "comment" > /**< / span >
< a name = "l00072" > < / a > 00072 < span class = "comment" > * @brief Shell descriptor type.< / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > */< / span >
< a name = "l00074" > < / a > < a class = "code" href = "struct_shell_config.html" > 00074< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {
< a name = "l00075" > < / a > < a class = "code" href = "struct_shell_config.html#a7a31690e999696429b8c20732c1f2165" > 00075< / a > < a class = "code" href = "struct_base_channel.html" title = "Base channel class." > BaseChannel< / a > *sc_channel; < span class = "comment" > /**< @brief I/O channel associated< / span >
< a name = "l00076" > < / a > 00076 < span class = "comment" > to the shell. */< / span >
< a name = "l00077" > < / a > < a class = "code" href = "struct_shell_config.html#ab4a34e9003ce679f1e6366cce6f62035" > 00077< / a > < span class = "keyword" > const< / span > < a class = "code" href = "struct_shell_command.html" title = "Custom command entry type." > ShellCommand< / a > *sc_commands; < span class = "comment" > /**< @brief Shell extra commands< / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > table. */< / span >
< a name = "l00079" > < / a > 00079 } < a class = "code" href = "struct_shell_config.html" title = "Shell descriptor type." > ShellConfig< / a > ;
< a name = "l00080" > < / a > 00080
< a name = "l00081" > < / a > 00081 < span class = "keyword" > extern< / span > < a class = "code" href = "struct_event_source.html" title = "Event Source structure." > EventSource< / a > < a class = "code" href = "group___s_h_e_l_l.html#ga168440e44c637282589a4e28eb3a91b8" title = "Shell termination event source." > shell_terminated< / a > ;
< a name = "l00082" > < / a > 00082
< a name = "l00083" > < / a > 00083 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00084" > < / a > 00084 < span class = "preprocessor" > < / span > < span class = "keyword" > extern< / span > < span class = "stringliteral" > " C" < / span > {
< a name = "l00085" > < / a > 00085 < span class = "preprocessor" > #endif< / span >
< a name = "l00086" > < / a > 00086 < span class = "preprocessor" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_h_e_l_l.html#ga0b1dba28bb03cb29749f32a595d5ec57" title = "Shell manager initialization." > shellInit< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00087" > < / a > 00087 < a class = "code" href = "struct_thread.html" title = "Structure representing a thread." > Thread< / a > *< a class = "code" href = "group___s_h_e_l_l.html#gaa1ede2e94e6d3eba37cdda717f6c1656" title = "Spawns a new shell." > shellCreate< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "struct_shell_config.html" title = "Shell descriptor type." > ShellConfig< / a > *scp, < span class = "keywordtype" > size_t< / span > size, < a class = "code" href = "group__types.html#ga5f2488ba73e5969cbc0f7033735374ee" title = "Priority, use the fastest unsigned type." > tprio_t< / a > prio);
< a name = "l00088" > < / a > 00088 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_h_e_l_l.html#ga4660b06c861d5506fb35d9844e2d8288" title = "Prints a string." > shellPrint< / a > (< a class = "code" href = "struct_base_channel.html" title = "Base channel class." > BaseChannel< / a > *chp, < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *msg);
< a name = "l00089" > < / a > 00089 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_h_e_l_l.html#ga7bffb6aa1f0ec1e12dfaa86c3b692330" title = "Prints a string with a final newline." > shellPrintLine< / a > (< a class = "code" href = "struct_base_channel.html" title = "Base channel class." > BaseChannel< / a > *chp, < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *msg);
< a name = "l00090" > < / a > 00090 < a class = "code" href = "group__types.html#ga7556af1cb61728b53228fa3af1c851de" title = "Boolean, recommended the fastest signed." > bool_t< / a > < a class = "code" href = "group___s_h_e_l_l.html#ga1c7aadcfefdc616bd8450117b6972274" title = "Reads a whole line from the input channel." > shellGetLine< / a > (< a class = "code" href = "struct_base_channel.html" title = "Base channel class." > BaseChannel< / a > *chp, < span class = "keywordtype" > char< / span > *line, < span class = "keywordtype" > unsigned< / span > size);
< a name = "l00091" > < / a > 00091 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00092" > < / a > 00092 < span class = "preprocessor" > < / span > }
< a name = "l00093" > < / a > 00093 < span class = "preprocessor" > #endif< / span >
< a name = "l00094" > < / a > 00094 < span class = "preprocessor" > < / span >
< a name = "l00095" > < / a > 00095 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _SHELL_H_ */< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > < / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > /** @} */< / span >
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >
