src/lib/cmdline_parse_string.h

   1 /*
   2  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef _PARSE_STRING_H_
  29 #define _PARSE_STRING_H_
  30
  31 #include "cmdline_parse.h"
  32
  33 /* size of a parsed string */
  34 #define STR_TOKEN_SIZE 128
  35
  36 typedef char cmdline_fixed_string_t[STR_TOKEN_SIZE];
  37
  38 struct cmdline_token_string_data {
  39         const char *str;
  40 };
  41
  42 struct cmdline_token_string {
  43         struct cmdline_token_hdr hdr;
  44         struct cmdline_token_string_data string_data;
  45 };
  46 typedef struct cmdline_token_string cmdline_parse_token_string_t;
  47
  48 extern struct cmdline_token_ops cmdline_token_string_ops;
  49
  50 int cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *srcbuf,
  51                          void *res);
  52 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk);
  53 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx,
  54                                     char *dstbuf, unsigned int size);
  55 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
  56                             unsigned int size);
  57
  58 #define TOKEN_STRING_INITIALIZER(structure, field, string)  \
  59 {                                                           \
  60         .hdr = {                                            \
  61                 .ops = &cmdline_token_string_ops,           \
  62                 .offset = offsetof(structure, field),       \
  63         },                                                  \
  64         .string_data = {                                    \
  65                 .str = string,                              \
  66         },                                                  \
  67 }
  68
  69 #endif /* _PARSE_STRING_H_ */