utils/themeeditor/tag_table.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   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 #endif
  29
  30
  31 enum skin_token_type {
  32
  33   TOKEN_MARKER_CONTROL_TOKENS = -1,
  34     SKIN_TOKEN_UNKNOWN,
  35
  36     /* Markers */
  37     SKIN_TOKEN_CHARACTER,
  38     SKIN_TOKEN_STRING,
  39     SKIN_TOKEN_TRANSLATEDSTRING,
  40
  41     /* Alignment */
  42     SKIN_TOKEN_ALIGN_LEFT,
  43     SKIN_TOKEN_ALIGN_LEFT_RTL,
  44     SKIN_TOKEN_ALIGN_CENTER,
  45     SKIN_TOKEN_ALIGN_RIGHT,
  46     SKIN_TOKEN_ALIGN_RIGHT_RTL,
  47     SKIN_TOKEN_ALIGN_LANGDIRECTION,
  48
  49
  50     /* Sublines */
  51     SKIN_TOKEN_SUBLINE_TIMEOUT,
  52     SKIN_TOKEN_SUBLINE_SCROLL,
  53
  54     /* Conditional */
  55     SKIN_TOKEN_CONDITIONAL,
  56     SKIN_TOKEN_CONDITIONAL_START,
  57     SKIN_TOKEN_CONDITIONAL_OPTION,
  58     SKIN_TOKEN_CONDITIONAL_END,
  59
  60     /* Viewport display */
  61     SKIN_TOKEN_VIEWPORT_LOAD,
  62     SKIN_TOKEN_VIEWPORT_CONDITIONAL,
  63     SKIN_TOKEN_VIEWPORT_ENABLE,
  64     SKIN_TOKEN_VIEWPORT_CUSTOMLIST,
  65     SKIN_TOKEN_UIVIEWPORT_ENABLE,
  66     SKIN_TOKEN_UIVIEWPORT_LOAD,
  67
  68     /* Battery */
  69   TOKEN_MARKER_BATTERY,
  70     SKIN_TOKEN_BATTERY_PERCENT,
  71     SKIN_TOKEN_BATTERY_PERCENTBAR,
  72     SKIN_TOKEN_BATTERY_VOLTS,
  73     SKIN_TOKEN_BATTERY_TIME,
  74     SKIN_TOKEN_BATTERY_CHARGER_CONNECTED,
  75     SKIN_TOKEN_BATTERY_CHARGING,
  76     SKIN_TOKEN_BATTERY_SLEEPTIME,
  77     SKIN_TOKEN_USB_POWERED,
  78
  79     /* Sound */
  80   TOKEN_MARKER_SOUND,
  81     SKIN_TOKEN_SOUND_PITCH,
  82     SKIN_TOKEN_SOUND_SPEED,
  83     SKIN_TOKEN_REPLAYGAIN,
  84     SKIN_TOKEN_CROSSFADE,
  85
  86     /* Time */
  87   TOKEN_MARKER_RTC,
  88     SKIN_TOKEN_RTC_PRESENT,
  89
  90     /* The begin/end values allow us to know if a token is an RTC one.
  91        New RTC tokens should be added between the markers. */
  92
  93     SKIN_TOKENs_RTC_BEGIN, /* just the start marker, not an actual token */
  94
  95     SKIN_TOKEN_RTC_DAY_OF_MONTH,
  96     SKIN_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED,
  97     SKIN_TOKEN_RTC_12HOUR_CFG,
  98     SKIN_TOKEN_RTC_HOUR_24_ZERO_PADDED,
  99     SKIN_TOKEN_RTC_HOUR_24,
 100     SKIN_TOKEN_RTC_HOUR_12_ZERO_PADDED,
 101     SKIN_TOKEN_RTC_HOUR_12,
 102     SKIN_TOKEN_RTC_MONTH,
 103     SKIN_TOKEN_RTC_MINUTE,
 104     SKIN_TOKEN_RTC_SECOND,
 105     SKIN_TOKEN_RTC_YEAR_2_DIGITS,
 106     SKIN_TOKEN_RTC_YEAR_4_DIGITS,
 107     SKIN_TOKEN_RTC_AM_PM_UPPER,
 108     SKIN_TOKEN_RTC_AM_PM_LOWER,
 109     SKIN_TOKEN_RTC_WEEKDAY_NAME,
 110     SKIN_TOKEN_RTC_MONTH_NAME,
 111     SKIN_TOKEN_RTC_DAY_OF_WEEK_START_MON,
 112     SKIN_TOKEN_RTC_DAY_OF_WEEK_START_SUN,
 113
 114     SKIN_TOKENS_RTC_END,     /* just the end marker, not an actual token */
 115
 116     /* Database */
 117   TOKEN_MARKER_DATABASE,
 118     SKIN_TOKEN_DATABASE_PLAYCOUNT,
 119     SKIN_TOKEN_DATABASE_RATING,
 120     SKIN_TOKEN_DATABASE_AUTOSCORE,
 121
 122     /* File */
 123   TOKEN_MARKER_FILE,
 124     SKIN_TOKEN_FILE_BITRATE,
 125     SKIN_TOKEN_FILE_CODEC,
 126     SKIN_TOKEN_FILE_FREQUENCY,
 127     SKIN_TOKEN_FILE_FREQUENCY_KHZ,
 128     SKIN_TOKEN_FILE_NAME,
 129     SKIN_TOKEN_FILE_NAME_WITH_EXTENSION,
 130     SKIN_TOKEN_FILE_PATH,
 131     SKIN_TOKEN_FILE_SIZE,
 132     SKIN_TOKEN_FILE_VBR,
 133     SKIN_TOKEN_FILE_DIRECTORY,
 134
 135     /* Image */
 136   TOKEN_MARKER_IMAGES,
 137     SKIN_TOKEN_IMAGE_BACKDROP,
 138     SKIN_TOKEN_IMAGE_PROGRESS_BAR,
 139     SKIN_TOKEN_IMAGE_PRELOAD,
 140     SKIN_TOKEN_IMAGE_PRELOAD_DISPLAY,
 141     SKIN_TOKEN_IMAGE_DISPLAY,
 142
 143     /* Albumart */
 144     SKIN_TOKEN_ALBUMART_LOAD,
 145     SKIN_TOKEN_ALBUMART_DISPLAY,
 146
 147     /* Metadata */
 148   TOKEN_MARKER_METADATA,
 149     SKIN_TOKEN_METADATA_ARTIST,
 150     SKIN_TOKEN_METADATA_COMPOSER,
 151     SKIN_TOKEN_METADATA_ALBUM_ARTIST,
 152     SKIN_TOKEN_METADATA_GROUPING,
 153     SKIN_TOKEN_METADATA_ALBUM,
 154     SKIN_TOKEN_METADATA_GENRE,
 155     SKIN_TOKEN_METADATA_DISC_NUMBER,
 156     SKIN_TOKEN_METADATA_TRACK_NUMBER,
 157     SKIN_TOKEN_METADATA_TRACK_TITLE,
 158     SKIN_TOKEN_METADATA_VERSION,
 159     SKIN_TOKEN_METADATA_YEAR,
 160     SKIN_TOKEN_METADATA_COMMENT,
 161
 162   TOKEN_MARKER_PLAYBACK_INFO,
 163     /* Mode */
 164     SKIN_TOKEN_REPEAT_MODE,
 165     SKIN_TOKEN_PLAYBACK_STATUS,
 166     /* Progressbar */
 167     SKIN_TOKEN_PROGRESSBAR,
 168     SKIN_TOKEN_PLAYER_PROGRESSBAR,
 169     /* Peakmeter */
 170     SKIN_TOKEN_PEAKMETER,
 171
 172     /* Current track */
 173     SKIN_TOKEN_TRACK_ELAPSED_PERCENT,
 174     SKIN_TOKEN_TRACK_TIME_ELAPSED,
 175     SKIN_TOKEN_TRACK_TIME_REMAINING,
 176     SKIN_TOKEN_TRACK_LENGTH,
 177     SKIN_TOKEN_TRACK_STARTING,
 178     SKIN_TOKEN_TRACK_ENDING,
 179
 180     /* Playlist */
 181   TOKEN_MARKER_PLAYLIST,
 182     SKIN_TOKEN_PLAYLIST_ENTRIES,
 183     SKIN_TOKEN_PLAYLIST_NAME,
 184     SKIN_TOKEN_PLAYLIST_POSITION,
 185     SKIN_TOKEN_PLAYLIST_SHUFFLE,
 186
 187
 188   TOKEN_MARKER_MISC,
 189     SKIN_TOKEN_ENABLE_THEME,
 190     SKIN_TOKEN_DISABLE_THEME,
 191     SKIN_TOKEN_DRAW_INBUILTBAR,
 192     SKIN_TOKEN_LIST_TITLE_TEXT,
 193     SKIN_TOKEN_LIST_TITLE_ICON,
 194
 195     SKIN_TOKEN_LOAD_FONT,
 196
 197     /* buttons */
 198     SKIN_TOKEN_BUTTON_VOLUME,
 199     SKIN_TOKEN_LASTTOUCH,
 200     SKIN_TOKEN_TOUCHREGION,
 201     /* Virtual LED */
 202     SKIN_TOKEN_VLED_HDD,
 203     /* Volume level */
 204     SKIN_TOKEN_VOLUME,
 205     SKIN_TOKEN_VOLUMEBAR,
 206     /* hold */
 207     SKIN_TOKEN_MAIN_HOLD,
 208     SKIN_TOKEN_REMOTE_HOLD,
 209
 210     /* Setting option */
 211     SKIN_TOKEN_SETTING,
 212     SKIN_TOKEN_CURRENT_SCREEN,
 213     SKIN_TOKEN_LANG_IS_RTL,
 214
 215     /* Recording Tokens */
 216   TOKEN_MARKER_RECORDING,
 217     SKIN_TOKEN_HAVE_RECORDING,
 218     SKIN_TOKEN_IS_RECORDING,
 219     SKIN_TOKEN_REC_FREQ,
 220     SKIN_TOKEN_REC_ENCODER,
 221     SKIN_TOKEN_REC_BITRATE, /* SWCODEC: MP3 bitrate, HWCODEC: MP3 "quality" */
 222     SKIN_TOKEN_REC_MONO,
 223     SKIN_TOKEN_REC_SECONDS,
 224     SKIN_TOKEN_REC_MINUTES,
 225     SKIN_TOKEN_REC_HOURS,
 226
 227
 228     /* Radio Tokens */
 229   TOKEN_MARKER_TUNER,
 230     SKIN_TOKEN_HAVE_TUNER,
 231     SKIN_TOKEN_TUNER_TUNED,
 232     SKIN_TOKEN_TUNER_SCANMODE,
 233     SKIN_TOKEN_TUNER_STEREO,
 234     SKIN_TOKEN_TUNER_MINFREQ, /* changes based on "region" */
 235     SKIN_TOKEN_TUNER_MAXFREQ, /* changes based on "region" */
 236     SKIN_TOKEN_TUNER_CURFREQ,
 237     SKIN_TOKEN_PRESET_ID, /* "id" of this preset.. really the array element number */
 238     SKIN_TOKEN_PRESET_NAME,
 239     SKIN_TOKEN_PRESET_FREQ,
 240     SKIN_TOKEN_PRESET_COUNT,
 241     /* RDS tokens */
 242     SKIN_TOKEN_HAVE_RDS,
 243     SKIN_TOKEN_RDS_NAME,
 244     SKIN_TOKEN_RDS_TEXT,
 245
 246
 247   TOKEN_MARKER_END, /* this needs to be the last value in this enum */
 248 };
 249
 250 /*
 251  * Struct for tag parsing information
 252  * name   - The name of the tag, i.e. V for %V
 253  * params - A string specifying all of the tags parameters, each
 254  *          character representing a single parameter.  Valid
 255  *          characters for parameters are:
 256  *             I - Required integer
 257  *             i - Nullable integer
 258  *             S - Required string
 259  *             s - Nullable string
 260  *             F - Required file name
 261  *             f - Nullable file name
 262  *             C - Required WPS code
 263  *          Any nullable parameter may be replaced in the WPS file
 264  *          with a '-'.  To specify that parameters may be left off
 265  *          altogether, place a '|' in the parameter string.  For
 266  *          instance, with the parameter string...
 267  *             Ii|Ss
 268  *          one integer must be specified, one integer can be
 269  *          specified or set to default with '-', and the user can
 270  *          stop providing parameters at any time after that.
 271  *          To specify multiple instances of the same type, put a
 272  *          number before the character.  For instance, the string...
 273  *             2s
 274  *          will specify two strings.  An asterisk (*) at the beginning of the
 275  *          string will specify that either all or none of the optional
 276  *
 277  */
 278 struct tag_info
 279 {
 280     enum skin_token_type type;
 281     char* name;
 282     char* params;
 283
 284 };
 285
 286 /*
 287  * Finds a tag by name and returns its parameter list, or an empty
 288  * string if the tag is not found in the table
 289  */
 290 struct tag_info* find_tag(char* name);
 291
 292 /*
 293  * Determines whether a character is legal to escape or not.  If
 294  * lookup is not found in the legal escape characters string, returns
 295  * false, otherwise returns true
 296  */
 297 int find_escape_character(char lookup);
 298
 299 #ifdef __cplusplus
 300 }
 301 #endif
 302
 303 #endif /* TAG_TABLE_H */