utils/skinupdater/tag_table.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id: tag_table.h 26292 2010-05-25 22:24:08Z bieber $
   9  *
  10  * Copyright (C) 2010 Robert Bieber
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef TAG_TABLE_H
  23 #define TAG_TABLE_H
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 namespace wps
  29 {
  30 #endif
  31
  32
  33 /*
  34  * Struct for tag parsing information
  35  * name   - The name of the tag, i.e. V for %V
  36  * params - A string specifying all of the tags parameters, each
  37  *          character representing a single parameter.  Valid
  38  *          characters for parameters are:
  39  *             I - Required integer
  40  *             i - Nullable integer
  41  *             S - Required string
  42  *             s - Nullable string
  43  *             F - Required file name
  44  *             f - Nullable file name
  45  *             C - Required WPS code
  46  *          Any nullable parameter may be replaced in the WPS file
  47  *          with a '-'.  To specify that parameters may be left off
  48  *          altogether, place a '|' in the parameter string.  For
  49  *          instance, with the parameter string...
  50  *             Ii|Ss
  51  *          one integer must be specified, one integer can be
  52  *          specified or set to default with '-', and the user can
  53  *          stop providing parameters at any time after that.
  54  *          To specify multiple instances of the same type, put a
  55  *          number before the character.  For instance, the string...
  56  *             2s
  57  *          will specify two strings.  An asterisk (*) at the beginning of the
  58  *          string will specify that either all or none of the optional
  59  *
  60  */
  61 struct tag_info
  62 {
  63
  64     char* name;
  65     char* params;
  66
  67 };
  68
  69 /*
  70  * Finds a tag by name and returns its parameter list, or an empty
  71  * string if the tag is not found in the table
  72  */
  73 char* find_tag(char* name);
  74
  75 /*
  76  * Determines whether a character is legal to escape or not.  If
  77  * lookup is not found in the legal escape characters string, returns
  78  * false, otherwise returns true
  79  */
  80 int find_escape_character(char lookup);
  81
  82 #endif /* TAG_TABLE_H */