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