firm/bare_metal/common/ntshell/ntopt.h

   1 /**
   2  * @file ntopt.h
   3  * @author Shinichiro Nakamura
   4  * @brief NT-Shell用オプション解析モジュールの定義。
   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 NTOPT_H
  38 #define NTOPT_H
  39
  40 #include "ntconf.h"
  41
  42 /**
  43  * @brief パース可能な最大文字列長。
  44  */
  45 #define NTOPT_TEXT_MAXLEN   (NTCONF_EDITOR_MAXLEN)
  46
  47 /**
  48  * @brief パース可能な最大パラメータ数。
  49  */
  50 #define NTOPT_TEXT_MAXARGS  (NTCONF_EDITOR_MAXLEN / 2)
  51
  52 /**
  53  * @brief 与えられた文字列をデリミタで分割する。
  54  *
  55  * @param str 文字列。
  56  * @param func コールバック関数。
  57  * @param extobj 拡張オブジェクト。
  58  *
  59  * @return コールバック関数が返した値。
  60  */
  61 int ntopt_parse(
  62         const char *str,
  63         int (*func)(int argc, char **argv, void *extobj),
  64         void *extobj);
  65
  66 #endif
  67