cli/option.h

   1 /*
   2  * option.h: Library for interactive commandline interfaces
   3  *
   4  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  19  */
  20
  21 /*!
  22  * @file
  23  */
  24
  25 #ifndef __VSC_CLI__OPTION__PRIVATE_H__
  26 #define __VSC_CLI__OPTION__PRIVATE_H__
  27
  28 #include "../include/libvsccli/types.h"
  29
  30 const char *
  31 _vsc_cli_option_syntax (const struct VscCliOptionInfo *option_info,
  32                         int synopsis);
  33
  34 int /* option_parsed */
  35 _vsc_cli_option_parse (struct VscError *error,
  36                        const struct VscCliOptionInfo *option_infos,
  37                        int untagged_option_index, const char *command_name,
  38                        const char *input, const char **input_tail,
  39                        struct VscCliOption *option);
  40
  41 const struct VscCliOptionInfo *
  42 _vsc_cli_option_infos_lookup_tagged
  43    (const struct VscCliOptionInfo *option_infos, const char *option_name,
  44     int is_long);
  45
  46 const struct VscCliOptionInfo *
  47 _vsc_cli_option_infos_lookup_untagged
  48    (const struct VscCliOptionInfo *option_infos, int position);
  49
  50 struct VscCliOption * /* option_list_duplicate */
  51 _vsc_cli_option_list_duplicate (struct VscError *error,
  52                                 const struct VscCliOption *option_list);
  53
  54 void
  55 _vsc_cli_option_list_append (struct VscError *error,
  56                              struct VscCliOption **option_list,
  57                              const struct VscCliOption *option);
  58
  59 struct VscCliOption *
  60 _vsc_cli_option_list_lookup (const struct VscCliOption *option_list,
  61                              const char *option_long_name);
  62
  63 #endif /* __VSC_CLI__OPTION__PRIVATE_H__ */