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