1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2007 Nicolas Pennequin, Dan Everton, Matthias Mohr
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
39 #define lang_is_rtl() (false)
51 #include "wps_internals.h"
52 #include "skin_engine.h"
54 #include "settings_list.h"
55 #include "skin_fonts.h"
57 #ifdef HAVE_LCD_BITMAP
66 #include "statusbar-skinned.h"
68 #define WPS_ERROR_INVALID_PARAM -1
70 /* which screen are we parsing for? */
71 static enum screen_type curr_screen
;
73 /* level of current conditional.
74 -1 means we're not in a conditional. */
75 static int level
= -1;
77 /* index of the last WPS_TOKEN_CONDITIONAL_OPTION
78 or WPS_TOKEN_CONDITIONAL_START in current level */
79 static int lastcond
[WPS_MAX_COND_LEVEL
];
81 /* index of the WPS_TOKEN_CONDITIONAL in current level */
82 static int condindex
[WPS_MAX_COND_LEVEL
];
84 /* number of condtional options in current level */
85 static int numoptions
[WPS_MAX_COND_LEVEL
];
87 /* line number, debug only */
88 static int line_number
;
90 /* the current viewport */
91 static struct skin_viewport
*curr_vp
;
92 /* the current line, linked to the above viewport */
93 static struct skin_line
*curr_line
;
95 static int follow_lang_direction
= 0;
97 #if defined(DEBUG) || defined(SIMULATOR)
98 /* debugging function */
99 extern void print_debug_info(struct wps_data
*data
, int fail
, int line
);
100 extern void debug_skin_usage(void);
103 /* Function for parsing of details for a token. At the moment the
104 function is called, the token type has already been set. The
105 function must fill in the details and possibly add more tokens
106 to the token array. It should return the number of chars that
109 wps_bufptr points to the char following the tag (i.e. where
111 token is the pointer to the 'main' token being parsed
113 typedef int (*wps_tag_parse_func
)(const char *wps_bufptr
,
114 struct wps_token
*token
, struct wps_data
*wps_data
);
117 enum wps_token_type type
;
119 unsigned char refresh_type
;
120 const wps_tag_parse_func parse_func
;
122 static int skip_end_of_line(const char *wps_bufptr
);
123 /* prototypes of all special parse functions : */
124 static int parse_timeout(const char *wps_bufptr
,
125 struct wps_token
*token
, struct wps_data
*wps_data
);
126 static int parse_progressbar(const char *wps_bufptr
,
127 struct wps_token
*token
, struct wps_data
*wps_data
);
128 static int parse_dir_level(const char *wps_bufptr
,
129 struct wps_token
*token
, struct wps_data
*wps_data
);
130 static int parse_setting_and_lang(const char *wps_bufptr
,
131 struct wps_token
*token
, struct wps_data
*wps_data
);
134 static int parse_languagedirection(const char *wps_bufptr
,
135 struct wps_token
*token
, struct wps_data
*wps_data
)
140 follow_lang_direction
= 2; /* 2 because it is decremented immediatly after
141 this token is parsed, after the next token it
146 #ifdef HAVE_LCD_BITMAP
147 static int parse_viewport_display(const char *wps_bufptr
,
148 struct wps_token
*token
, struct wps_data
*wps_data
);
149 static int parse_playlistview(const char *wps_bufptr
,
150 struct wps_token
*token
, struct wps_data
*wps_data
);
151 static int parse_viewport(const char *wps_bufptr
,
152 struct wps_token
*token
, struct wps_data
*wps_data
);
153 static int parse_statusbar_enable(const char *wps_bufptr
,
154 struct wps_token
*token
, struct wps_data
*wps_data
);
155 static int parse_statusbar_disable(const char *wps_bufptr
,
156 struct wps_token
*token
, struct wps_data
*wps_data
);
157 static int parse_image_display(const char *wps_bufptr
,
158 struct wps_token
*token
, struct wps_data
*wps_data
);
159 static int parse_image_load(const char *wps_bufptr
,
160 struct wps_token
*token
, struct wps_data
*wps_data
);
161 static int parse_font_load(const char *wps_bufptr
,
162 struct wps_token
*token
, struct wps_data
*wps_data
);
163 #endif /*HAVE_LCD_BITMAP */
164 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
165 static int parse_image_special(const char *wps_bufptr
,
166 struct wps_token
*token
, struct wps_data
*wps_data
);
169 static int parse_albumart_load(const char *wps_bufptr
,
170 struct wps_token
*token
, struct wps_data
*wps_data
);
171 static int parse_albumart_display(const char *wps_bufptr
,
172 struct wps_token
*token
, struct wps_data
*wps_data
);
173 #endif /* HAVE_ALBUMART */
174 #ifdef HAVE_TOUCHSCREEN
175 static int parse_touchregion(const char *wps_bufptr
,
176 struct wps_token
*token
, struct wps_data
*wps_data
);
178 static int fulline_tag_not_supported(const char *wps_bufptr
,
179 struct wps_token
*token
, struct wps_data
*wps_data
)
181 (void)token
; (void)wps_data
;
182 return skip_end_of_line(wps_bufptr
);
184 #define parse_touchregion fulline_tag_not_supported
187 #define WPS_RTC_REFRESH WPS_REFRESH_DYNAMIC
189 #define WPS_RTC_REFRESH WPS_REFRESH_STATIC
192 /* array of available tags - those with more characters have to go first
193 (e.g. "xl" and "xd" before "x"). It needs to end with the unknown token. */
194 static const struct wps_tag all_tags
[] = {
196 { WPS_TOKEN_ALIGN_CENTER
, "ac", 0, NULL
},
197 { WPS_TOKEN_ALIGN_LEFT
, "al", 0, NULL
},
198 { WPS_TOKEN_ALIGN_LEFT_RTL
, "aL", 0, NULL
},
199 { WPS_TOKEN_ALIGN_RIGHT
, "ar", 0, NULL
},
200 { WPS_TOKEN_ALIGN_RIGHT_RTL
, "aR", 0, NULL
},
201 { WPS_NO_TOKEN
, "ax", 0, parse_languagedirection
},
203 { WPS_TOKEN_BATTERY_PERCENT
, "bl", WPS_REFRESH_DYNAMIC
, NULL
},
204 { WPS_TOKEN_BATTERY_VOLTS
, "bv", WPS_REFRESH_DYNAMIC
, NULL
},
205 { WPS_TOKEN_BATTERY_TIME
, "bt", WPS_REFRESH_DYNAMIC
, NULL
},
206 { WPS_TOKEN_BATTERY_SLEEPTIME
, "bs", WPS_REFRESH_DYNAMIC
, NULL
},
207 #if CONFIG_CHARGING >= CHARGING_MONITOR
208 { WPS_TOKEN_BATTERY_CHARGING
, "bc", WPS_REFRESH_DYNAMIC
, NULL
},
211 { WPS_TOKEN_BATTERY_CHARGER_CONNECTED
,"bp", WPS_REFRESH_DYNAMIC
, NULL
},
213 #ifdef HAVE_USB_POWER
214 { WPS_TOKEN_USB_POWERED
, "bu", WPS_REFRESH_DYNAMIC
, NULL
},
217 { WPS_TOKEN_RTC_PRESENT
, "cc", WPS_REFRESH_STATIC
, NULL
},
218 { WPS_TOKEN_RTC_DAY_OF_MONTH
, "cd", WPS_RTC_REFRESH
, NULL
},
219 { WPS_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED
,"ce", WPS_RTC_REFRESH
, NULL
},
220 { WPS_TOKEN_RTC_12HOUR_CFG
, "cf", WPS_RTC_REFRESH
, NULL
},
221 { WPS_TOKEN_RTC_HOUR_24_ZERO_PADDED
, "cH", WPS_RTC_REFRESH
, NULL
},
222 { WPS_TOKEN_RTC_HOUR_24
, "ck", WPS_RTC_REFRESH
, NULL
},
223 { WPS_TOKEN_RTC_HOUR_12_ZERO_PADDED
, "cI", WPS_RTC_REFRESH
, NULL
},
224 { WPS_TOKEN_RTC_HOUR_12
, "cl", WPS_RTC_REFRESH
, NULL
},
225 { WPS_TOKEN_RTC_MONTH
, "cm", WPS_RTC_REFRESH
, NULL
},
226 { WPS_TOKEN_RTC_MINUTE
, "cM", WPS_RTC_REFRESH
, NULL
},
227 { WPS_TOKEN_RTC_SECOND
, "cS", WPS_RTC_REFRESH
, NULL
},
228 { WPS_TOKEN_RTC_YEAR_2_DIGITS
, "cy", WPS_RTC_REFRESH
, NULL
},
229 { WPS_TOKEN_RTC_YEAR_4_DIGITS
, "cY", WPS_RTC_REFRESH
, NULL
},
230 { WPS_TOKEN_RTC_AM_PM_UPPER
, "cP", WPS_RTC_REFRESH
, NULL
},
231 { WPS_TOKEN_RTC_AM_PM_LOWER
, "cp", WPS_RTC_REFRESH
, NULL
},
232 { WPS_TOKEN_RTC_WEEKDAY_NAME
, "ca", WPS_RTC_REFRESH
, NULL
},
233 { WPS_TOKEN_RTC_MONTH_NAME
, "cb", WPS_RTC_REFRESH
, NULL
},
234 { WPS_TOKEN_RTC_DAY_OF_WEEK_START_MON
, "cu", WPS_RTC_REFRESH
, NULL
},
235 { WPS_TOKEN_RTC_DAY_OF_WEEK_START_SUN
, "cw", WPS_RTC_REFRESH
, NULL
},
238 { WPS_TOKEN_FILE_BITRATE
, "fb", WPS_REFRESH_STATIC
, NULL
},
239 { WPS_TOKEN_FILE_CODEC
, "fc", WPS_REFRESH_STATIC
, NULL
},
240 { WPS_TOKEN_FILE_FREQUENCY
, "ff", WPS_REFRESH_STATIC
, NULL
},
241 { WPS_TOKEN_FILE_FREQUENCY_KHZ
, "fk", WPS_REFRESH_STATIC
, NULL
},
242 { WPS_TOKEN_FILE_NAME_WITH_EXTENSION
, "fm", WPS_REFRESH_STATIC
, NULL
},
243 { WPS_TOKEN_FILE_NAME
, "fn", WPS_REFRESH_STATIC
, NULL
},
244 { WPS_TOKEN_FILE_PATH
, "fp", WPS_REFRESH_STATIC
, NULL
},
245 { WPS_TOKEN_FILE_SIZE
, "fs", WPS_REFRESH_STATIC
, NULL
},
246 { WPS_TOKEN_FILE_VBR
, "fv", WPS_REFRESH_STATIC
, NULL
},
247 { WPS_TOKEN_FILE_DIRECTORY
, "d", WPS_REFRESH_STATIC
,
251 { WPS_TOKEN_FILE_BITRATE
, "Fb", WPS_REFRESH_STATIC
, NULL
},
252 { WPS_TOKEN_FILE_CODEC
, "Fc", WPS_REFRESH_STATIC
, NULL
},
253 { WPS_TOKEN_FILE_FREQUENCY
, "Ff", WPS_REFRESH_STATIC
, NULL
},
254 { WPS_TOKEN_FILE_FREQUENCY_KHZ
, "Fk", WPS_REFRESH_STATIC
, NULL
},
255 { WPS_TOKEN_FILE_NAME_WITH_EXTENSION
, "Fm", WPS_REFRESH_STATIC
, NULL
},
256 { WPS_TOKEN_FILE_NAME
, "Fn", WPS_REFRESH_STATIC
, NULL
},
257 { WPS_TOKEN_FILE_PATH
, "Fp", WPS_REFRESH_STATIC
, NULL
},
258 { WPS_TOKEN_FILE_SIZE
, "Fs", WPS_REFRESH_STATIC
, NULL
},
259 { WPS_TOKEN_FILE_VBR
, "Fv", WPS_REFRESH_STATIC
, NULL
},
260 { WPS_TOKEN_FILE_DIRECTORY
, "D", WPS_REFRESH_STATIC
,
263 /* current metadata */
264 { WPS_TOKEN_METADATA_ARTIST
, "ia", WPS_REFRESH_STATIC
, NULL
},
265 { WPS_TOKEN_METADATA_COMPOSER
, "ic", WPS_REFRESH_STATIC
, NULL
},
266 { WPS_TOKEN_METADATA_ALBUM
, "id", WPS_REFRESH_STATIC
, NULL
},
267 { WPS_TOKEN_METADATA_ALBUM_ARTIST
, "iA", WPS_REFRESH_STATIC
, NULL
},
268 { WPS_TOKEN_METADATA_GROUPING
, "iG", WPS_REFRESH_STATIC
, NULL
},
269 { WPS_TOKEN_METADATA_GENRE
, "ig", WPS_REFRESH_STATIC
, NULL
},
270 { WPS_TOKEN_METADATA_DISC_NUMBER
, "ik", WPS_REFRESH_STATIC
, NULL
},
271 { WPS_TOKEN_METADATA_TRACK_NUMBER
, "in", WPS_REFRESH_STATIC
, NULL
},
272 { WPS_TOKEN_METADATA_TRACK_TITLE
, "it", WPS_REFRESH_STATIC
, NULL
},
273 { WPS_TOKEN_METADATA_VERSION
, "iv", WPS_REFRESH_STATIC
, NULL
},
274 { WPS_TOKEN_METADATA_YEAR
, "iy", WPS_REFRESH_STATIC
, NULL
},
275 { WPS_TOKEN_METADATA_COMMENT
, "iC", WPS_REFRESH_STATIC
, NULL
},
278 { WPS_TOKEN_METADATA_ARTIST
, "Ia", WPS_REFRESH_STATIC
, NULL
},
279 { WPS_TOKEN_METADATA_COMPOSER
, "Ic", WPS_REFRESH_STATIC
, NULL
},
280 { WPS_TOKEN_METADATA_ALBUM
, "Id", WPS_REFRESH_STATIC
, NULL
},
281 { WPS_TOKEN_METADATA_ALBUM_ARTIST
, "IA", WPS_REFRESH_STATIC
, NULL
},
282 { WPS_TOKEN_METADATA_GROUPING
, "IG", WPS_REFRESH_STATIC
, NULL
},
283 { WPS_TOKEN_METADATA_GENRE
, "Ig", WPS_REFRESH_STATIC
, NULL
},
284 { WPS_TOKEN_METADATA_DISC_NUMBER
, "Ik", WPS_REFRESH_STATIC
, NULL
},
285 { WPS_TOKEN_METADATA_TRACK_NUMBER
, "In", WPS_REFRESH_STATIC
, NULL
},
286 { WPS_TOKEN_METADATA_TRACK_TITLE
, "It", WPS_REFRESH_STATIC
, NULL
},
287 { WPS_TOKEN_METADATA_VERSION
, "Iv", WPS_REFRESH_STATIC
, NULL
},
288 { WPS_TOKEN_METADATA_YEAR
, "Iy", WPS_REFRESH_STATIC
, NULL
},
289 { WPS_TOKEN_METADATA_COMMENT
, "IC", WPS_REFRESH_STATIC
, NULL
},
291 #if (CONFIG_CODEC != MAS3507D)
292 { WPS_TOKEN_SOUND_PITCH
, "Sp", WPS_REFRESH_DYNAMIC
, NULL
},
294 #if (CONFIG_CODEC == SWCODEC)
295 { WPS_TOKEN_SOUND_SPEED
, "Ss", WPS_REFRESH_DYNAMIC
, NULL
},
297 #if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
298 { WPS_TOKEN_VLED_HDD
, "lh", WPS_REFRESH_DYNAMIC
, NULL
},
301 { WPS_TOKEN_MAIN_HOLD
, "mh", WPS_REFRESH_DYNAMIC
, NULL
},
303 #ifdef HAS_REMOTE_BUTTON_HOLD
304 { WPS_TOKEN_REMOTE_HOLD
, "mr", WPS_REFRESH_DYNAMIC
, NULL
},
306 { WPS_TOKEN_UNKNOWN
, "mr", 0, NULL
},
309 { WPS_TOKEN_REPEAT_MODE
, "mm", WPS_REFRESH_DYNAMIC
, NULL
},
310 { WPS_TOKEN_PLAYBACK_STATUS
, "mp", WPS_REFRESH_DYNAMIC
, NULL
},
311 { WPS_TOKEN_BUTTON_VOLUME
, "mv", WPS_REFRESH_DYNAMIC
,
314 #ifdef HAVE_LCD_BITMAP
315 { WPS_TOKEN_PEAKMETER
, "pm", WPS_REFRESH_PEAK_METER
, NULL
},
317 { WPS_TOKEN_PLAYER_PROGRESSBAR
, "pf",
318 WPS_REFRESH_DYNAMIC
| WPS_REFRESH_PLAYER_PROGRESS
, parse_progressbar
},
320 { WPS_TOKEN_PROGRESSBAR
, "pb", WPS_REFRESH_PLAYER_PROGRESS
,
323 { WPS_TOKEN_VOLUME
, "pv", WPS_REFRESH_DYNAMIC
, NULL
},
325 { WPS_TOKEN_TRACK_ELAPSED_PERCENT
, "px", WPS_REFRESH_DYNAMIC
, NULL
},
326 { WPS_TOKEN_TRACK_TIME_ELAPSED
, "pc", WPS_REFRESH_DYNAMIC
, NULL
},
327 { WPS_TOKEN_TRACK_TIME_REMAINING
, "pr", WPS_REFRESH_DYNAMIC
, NULL
},
328 { WPS_TOKEN_TRACK_LENGTH
, "pt", WPS_REFRESH_STATIC
, NULL
},
330 { WPS_TOKEN_PLAYLIST_POSITION
, "pp", WPS_REFRESH_STATIC
, NULL
},
331 { WPS_TOKEN_PLAYLIST_ENTRIES
, "pe", WPS_REFRESH_STATIC
, NULL
},
332 { WPS_TOKEN_PLAYLIST_NAME
, "pn", WPS_REFRESH_STATIC
, NULL
},
333 { WPS_TOKEN_PLAYLIST_SHUFFLE
, "ps", WPS_REFRESH_DYNAMIC
, NULL
},
336 { WPS_TOKEN_DATABASE_PLAYCOUNT
, "rp", WPS_REFRESH_DYNAMIC
, NULL
},
337 { WPS_TOKEN_DATABASE_RATING
, "rr", WPS_REFRESH_DYNAMIC
, NULL
},
338 { WPS_TOKEN_DATABASE_AUTOSCORE
, "ra", WPS_REFRESH_DYNAMIC
, NULL
},
341 #if CONFIG_CODEC == SWCODEC
342 { WPS_TOKEN_REPLAYGAIN
, "rg", WPS_REFRESH_STATIC
, NULL
},
343 { WPS_TOKEN_CROSSFADE
, "xf", WPS_REFRESH_DYNAMIC
, NULL
},
346 { WPS_NO_TOKEN
, "s", WPS_REFRESH_SCROLL
, NULL
},
347 { WPS_TOKEN_SUBLINE_TIMEOUT
, "t", 0, parse_timeout
},
349 #ifdef HAVE_LCD_BITMAP
350 { WPS_NO_TOKEN
, "we", 0, parse_statusbar_enable
},
351 { WPS_NO_TOKEN
, "wd", 0, parse_statusbar_disable
},
353 { WPS_NO_TOKEN
, "xl", 0, parse_image_load
},
355 { WPS_TOKEN_IMAGE_PRELOAD_DISPLAY
, "xd", WPS_REFRESH_STATIC
,
356 parse_image_display
},
358 { WPS_TOKEN_IMAGE_DISPLAY
, "x", 0, parse_image_load
},
359 { WPS_NO_TOKEN
, "Fl", 0, parse_font_load
},
361 { WPS_NO_TOKEN
, "Cl", 0, parse_albumart_load
},
362 { WPS_TOKEN_ALBUMART_DISPLAY
, "C", WPS_REFRESH_STATIC
, parse_albumart_display
},
365 { WPS_VIEWPORT_ENABLE
, "Vd", WPS_REFRESH_DYNAMIC
,
366 parse_viewport_display
},
367 #ifdef HAVE_LCD_BITMAP
368 { WPS_VIEWPORT_CUSTOMLIST
, "Vp", WPS_REFRESH_STATIC
, parse_playlistview
},
370 { WPS_NO_TOKEN
, "V", 0, parse_viewport
},
372 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
373 { WPS_TOKEN_IMAGE_BACKDROP
, "X", 0, parse_image_special
},
377 { WPS_TOKEN_SETTING
, "St", WPS_REFRESH_DYNAMIC
,
378 parse_setting_and_lang
},
379 { WPS_TOKEN_TRANSLATEDSTRING
, "Sx", WPS_REFRESH_STATIC
,
380 parse_setting_and_lang
},
381 { WPS_TOKEN_LANG_IS_RTL
, "Sr", WPS_REFRESH_STATIC
, NULL
},
383 { WPS_TOKEN_LASTTOUCH
, "Tl", WPS_REFRESH_DYNAMIC
, parse_timeout
},
384 { WPS_TOKEN_CURRENT_SCREEN
, "cs", WPS_REFRESH_DYNAMIC
, NULL
},
385 { WPS_NO_TOKEN
, "T", 0, parse_touchregion
},
388 /* Recording Tokens */
389 { WPS_TOKEN_HAVE_RECORDING
, "Rp", WPS_REFRESH_STATIC
, NULL
},
390 #ifdef HAVE_RECORDING
391 { WPS_TOKEN_REC_FREQ
, "Rf", WPS_REFRESH_DYNAMIC
, NULL
},
392 { WPS_TOKEN_REC_ENCODER
, "Re", WPS_REFRESH_DYNAMIC
, NULL
},
393 { WPS_TOKEN_REC_BITRATE
, "Rb", WPS_REFRESH_DYNAMIC
, NULL
},
394 { WPS_TOKEN_REC_MONO
, "Rm", WPS_REFRESH_DYNAMIC
, NULL
},
396 { WPS_TOKEN_UNKNOWN
, "", 0, NULL
}
397 /* the array MUST end with an empty string (first char is \0) */
401 /* add a skin_token_list item to the list chain. ALWAYS appended because some of the
402 * chains require the order to be kept.
404 static void add_to_ll_chain(struct skin_token_list
**list
, struct skin_token_list
*item
)
410 struct skin_token_list
*t
= *list
;
417 /* traverse the image linked-list for an image */
418 #ifdef HAVE_LCD_BITMAP
419 struct gui_img
* find_image(char label
, struct wps_data
*data
)
421 struct skin_token_list
*list
= data
->images
;
424 struct gui_img
*img
= (struct gui_img
*)list
->token
->value
.data
;
425 if (img
->label
== label
)
433 /* traverse the viewport linked list for a viewport */
434 struct skin_viewport
* find_viewport(char label
, struct wps_data
*data
)
436 struct skin_token_list
*list
= data
->viewports
;
439 struct skin_viewport
*vp
= (struct skin_viewport
*)list
->token
->value
.data
;
440 if (vp
->label
== label
)
448 /* create and init a new wpsll item.
449 * passing NULL to token will alloc a new one.
450 * You should only pass NULL for the token when the token type (table above)
451 * is WPS_NO_TOKEN which means it is not stored automatically in the skins token array
453 static struct skin_token_list
*new_skin_token_list_item(struct wps_token
*token
,
456 struct skin_token_list
*llitem
= skin_buffer_alloc(sizeof(struct skin_token_list
));
458 token
= skin_buffer_alloc(sizeof(struct wps_token
));
459 if (!llitem
|| !token
)
462 llitem
->token
= token
;
464 llitem
->token
->value
.data
= token_data
;
468 /* Returns the number of chars that should be skipped to jump
469 immediately after the first eol, i.e. to the start of the next line */
470 static int skip_end_of_line(const char *wps_bufptr
)
474 while(*(wps_bufptr
+ skip
) != '\n')
479 /* Starts a new subline in the current line during parsing */
480 static bool skin_start_new_subline(struct skin_line
*line
, int curr_token
)
482 struct skin_subline
*subline
= skin_buffer_alloc(sizeof(struct skin_subline
));
486 subline
->first_token_idx
= curr_token
;
487 subline
->next
= NULL
;
489 subline
->line_type
= 0;
490 subline
->time_mult
= 0;
492 line
->curr_subline
->last_token_idx
= curr_token
-1;
493 line
->curr_subline
->next
= subline
;
494 line
->curr_subline
= subline
;
498 static bool skin_start_new_line(struct skin_viewport
*vp
, int curr_token
)
500 struct skin_line
*line
= skin_buffer_alloc(sizeof(struct skin_line
));
501 struct skin_subline
*subline
= NULL
;
505 /* init the subline */
506 subline
= &line
->sublines
;
507 subline
->first_token_idx
= curr_token
;
508 subline
->next
= NULL
;
509 subline
->line_type
= 0;
510 subline
->time_mult
= 0;
512 /* init the new line */
513 line
->curr_subline
= &line
->sublines
;
515 line
->subline_expire_time
= 0;
517 /* connect to curr_line and vp pointers.
518 * 1) close the previous lines subline
519 * 2) connect to vp pointer
520 * 3) connect to curr_line global pointer
524 curr_line
->curr_subline
->last_token_idx
= curr_token
- 1;
525 curr_line
->next
= line
;
526 curr_line
->curr_subline
= NULL
;
534 #ifdef HAVE_LCD_BITMAP
536 static int parse_statusbar_enable(const char *wps_bufptr
,
537 struct wps_token
*token
,
538 struct wps_data
*wps_data
)
540 (void)token
; /* Kill warnings */
541 wps_data
->wps_sb_tag
= true;
542 wps_data
->show_sb_on_wps
= true;
543 struct skin_viewport
*default_vp
= find_viewport(VP_DEFAULT_LABEL
, wps_data
);
544 viewport_set_defaults(&default_vp
->vp
, curr_screen
);
545 return skip_end_of_line(wps_bufptr
);
548 static int parse_statusbar_disable(const char *wps_bufptr
,
549 struct wps_token
*token
,
550 struct wps_data
*wps_data
)
552 (void)token
; /* Kill warnings */
553 wps_data
->wps_sb_tag
= true;
554 wps_data
->show_sb_on_wps
= false;
555 struct skin_viewport
*default_vp
= find_viewport(VP_DEFAULT_LABEL
, wps_data
);
556 viewport_set_fullscreen(&default_vp
->vp
, curr_screen
);
557 return skip_end_of_line(wps_bufptr
);
560 static int get_image_id(int c
)
562 if(c
>= 'a' && c
<= 'z')
564 else if(c
>= 'A' && c
<= 'Z')
570 char *get_image_filename(const char *start
, const char* bmpdir
,
571 char *buf
, int buf_size
)
573 const char *end
= strchr(start
, '|');
575 if ( !end
|| (end
- start
) >= (buf_size
- (int)ROCKBOX_DIR_LEN
- 2) )
581 int bmpdirlen
= strlen(bmpdir
);
584 buf
[bmpdirlen
] = '/';
585 memcpy( &buf
[bmpdirlen
+ 1], start
, end
- start
);
586 buf
[bmpdirlen
+ 1 + end
- start
] = 0;
591 static int parse_image_display(const char *wps_bufptr
,
592 struct wps_token
*token
,
593 struct wps_data
*wps_data
)
595 char label
= wps_bufptr
[0];
597 struct gui_img
*img
;;
600 img
= find_image(label
, wps_data
);
603 token
->value
.i
= label
; /* so debug works */
604 return WPS_ERROR_INVALID_PARAM
;
607 if ((subimage
= get_image_id(wps_bufptr
[1])) != -1)
609 if (subimage
>= img
->num_subimages
)
610 return WPS_ERROR_INVALID_PARAM
;
612 /* Store sub-image number to display in high bits */
613 token
->value
.i
= label
| (subimage
<< 8);
614 return 2; /* We have consumed 2 bytes */
616 token
->value
.i
= label
;
617 return 1; /* We have consumed 1 byte */
621 static int parse_image_load(const char *wps_bufptr
,
622 struct wps_token
*token
,
623 struct wps_data
*wps_data
)
625 const char *ptr
= wps_bufptr
;
627 const char* filename
;
633 /* format: %x|n|filename.bmp|x|y|
634 or %xl|n|filename.bmp|x|y|
635 or %xl|n|filename.bmp|x|y|num_subimages|
639 return WPS_ERROR_INVALID_PARAM
;
643 if (!(ptr
= parse_list("ssdd", NULL
, '|', ptr
, &id
, &filename
, &x
, &y
)))
644 return WPS_ERROR_INVALID_PARAM
;
646 /* Check there is a terminating | */
648 return WPS_ERROR_INVALID_PARAM
;
650 /* check the image number and load state */
651 if(find_image(*id
, wps_data
))
653 /* Invalid image ID */
654 return WPS_ERROR_INVALID_PARAM
;
656 img
= skin_buffer_alloc(sizeof(struct gui_img
));
658 return WPS_ERROR_INVALID_PARAM
;
659 /* save a pointer to the filename */
660 img
->bm
.data
= (char*)filename
;
664 img
->num_subimages
= 1;
665 img
->always_display
= false;
667 /* save current viewport */
668 img
->vp
= &curr_vp
->vp
;
670 if (token
->type
== WPS_TOKEN_IMAGE_DISPLAY
)
672 img
->always_display
= true;
676 /* Parse the (optional) number of sub-images */
678 newline
= strchr(ptr
, '\n');
679 pos
= strchr(ptr
, '|');
680 if (pos
&& pos
< newline
)
681 img
->num_subimages
= atoi(ptr
);
683 if (img
->num_subimages
<= 0)
684 return WPS_ERROR_INVALID_PARAM
;
686 struct skin_token_list
*item
= new_skin_token_list_item(NULL
, img
);
688 return WPS_ERROR_INVALID_PARAM
;
689 add_to_ll_chain(&wps_data
->images
, item
);
691 /* Skip the rest of the line */
692 return skip_end_of_line(wps_bufptr
);
695 /* this array acts as a simple mapping between the id the user uses for a font
696 * and the id the font actually gets from the font loader.
697 * font id 2 is always the first skin font (regardless of how many screens */
698 static int font_ids
[MAXUSERFONTS
];
699 static int parse_font_load(const char *wps_bufptr
,
700 struct wps_token
*token
, struct wps_data
*wps_data
)
702 (void)wps_data
; (void)token
;
703 const char *ptr
= wps_bufptr
;
705 char *filename
, buf
[MAX_PATH
];
708 return WPS_ERROR_INVALID_PARAM
;
712 if (!(ptr
= parse_list("ds", NULL
, '|', ptr
, &id
, &filename
)))
713 return WPS_ERROR_INVALID_PARAM
;
715 /* Check there is a terminating | */
717 return WPS_ERROR_INVALID_PARAM
;
719 if (id
<= FONT_UI
|| id
>= MAXFONTS
-1)
720 return WPS_ERROR_INVALID_PARAM
;
723 memcpy(buf
, filename
, ptr
-filename
);
724 buf
[ptr
-filename
] = '\0';
725 font_ids
[id
] = skin_font_load(buf
);
727 return font_ids
[id
] >= 0 ? skip_end_of_line(wps_bufptr
) : WPS_ERROR_INVALID_PARAM
;
731 static int parse_viewport_display(const char *wps_bufptr
,
732 struct wps_token
*token
,
733 struct wps_data
*wps_data
)
736 char letter
= wps_bufptr
[0];
738 if (letter
< 'a' || letter
> 'z')
740 /* invalid viewport tag */
741 return WPS_ERROR_INVALID_PARAM
;
743 token
->value
.i
= letter
;
747 #ifdef HAVE_LCD_BITMAP
748 static int parse_playlistview_text(struct playlistviewer
*viewer
,
749 enum info_line_type line
, char* text
)
752 const struct wps_tag
*tag
;
754 const char *start
= text
;
758 viewer
->lines
[line
].count
= 0;
759 viewer
->lines
[line
].scroll
= false;
762 if (*text
== '%') /* it is a token of some type */
774 /* escaped characters */
775 viewer
->lines
[line
].tokens
[viewer
->lines
[line
].count
++] = WPS_TOKEN_CHARACTER
;
776 viewer
->lines
[line
].strings
[cur_string
][0] = *text
;
777 viewer
->lines
[line
].strings
[cur_string
++][1] = '\0';
781 strncmp(text
, tag
->name
, strlen(tag
->name
)) != 0;
783 /* %s isnt stored as a tag so manually check for it */
784 if (tag
->type
== WPS_NO_TOKEN
)
786 if (!strncmp(tag
->name
, "s", 1))
788 viewer
->lines
[line
].scroll
= true;
792 else if (tag
->type
== WPS_TOKEN_UNKNOWN
)
795 /* just copy the string */
796 viewer
->lines
[line
].tokens
[viewer
->lines
[line
].count
++] = WPS_TOKEN_STRING
;
797 while (i
<(MAX_PLAYLISTLINE_STRLEN
-1) && text
[i
] != '|' && text
[i
] != '%')
799 viewer
->lines
[line
].strings
[cur_string
][i
] = text
[i
];
802 viewer
->lines
[line
].strings
[cur_string
][i
] = '\0';
810 /* unsupported tag, reject */
813 taglen
= strlen(tag
->name
);
814 viewer
->lines
[line
].tokens
[viewer
->lines
[line
].count
++] = tag
->type
;
823 /* just copy the string */
824 viewer
->lines
[line
].tokens
[viewer
->lines
[line
].count
++] = WPS_TOKEN_STRING
;
825 while (i
<(MAX_PLAYLISTLINE_STRLEN
-1) && text
[i
] != '|' && text
[i
] != '%')
827 viewer
->lines
[line
].strings
[cur_string
][i
] = text
[i
];
830 viewer
->lines
[line
].strings
[cur_string
][i
] = '\0';
839 static int parse_playlistview(const char *wps_bufptr
,
840 struct wps_token
*token
, struct wps_data
*wps_data
)
843 /* %Vp|<use icons>|<start offset>|info line text|no info text| */
844 struct playlistviewer
*viewer
= skin_buffer_alloc(sizeof(struct playlistviewer
));
845 char *ptr
= strchr(wps_bufptr
, '|');
848 return WPS_ERROR_INVALID_PARAM
;
849 viewer
->vp
= &curr_vp
->vp
;
850 viewer
->show_icons
= true;
851 viewer
->start_offset
= atoi(ptr
+1);
852 token
->value
.data
= (void*)viewer
;
853 ptr
= strchr(ptr
+1, '|');
854 length
= parse_playlistview_text(viewer
, TRACK_HAS_INFO
, ptr
);
856 return WPS_ERROR_INVALID_PARAM
;
857 length
= parse_playlistview_text(viewer
, TRACK_HAS_NO_INFO
, ptr
+length
);
859 return WPS_ERROR_INVALID_PARAM
;
861 return skip_end_of_line(wps_bufptr
);
865 static int parse_viewport(const char *wps_bufptr
,
866 struct wps_token
*token
,
867 struct wps_data
*wps_data
)
869 (void)token
; /* Kill warnings */
870 const char *ptr
= wps_bufptr
;
872 struct skin_viewport
*skin_vp
= skin_buffer_alloc(sizeof(struct skin_viewport
));
874 /* check for the optional letter to signify its a hideable viewport */
875 /* %Vl|<label>|<rest of tags>| */
876 skin_vp
->hidden_flags
= 0;
877 skin_vp
->label
= VP_NO_LABEL
;
879 skin_vp
->lines
= NULL
;
882 curr_line
->curr_subline
->last_token_idx
= wps_data
->num_tokens
883 - (wps_data
->num_tokens
> 0 ? 1 : 0);
887 if (!skin_start_new_line(skin_vp
, wps_data
->num_tokens
))
888 return WPS_ERROR_INVALID_PARAM
;
893 skin_vp
->label
= VP_INFO_LABEL
;
894 skin_vp
->hidden_flags
= VP_NEVER_VISIBLE
;
897 else if (*ptr
== 'l')
901 char label
= *(ptr
+2);
902 if (label
>= 'a' && label
<= 'z')
904 skin_vp
->hidden_flags
= VP_DRAW_HIDEABLE
;
905 skin_vp
->label
= label
;
908 return WPS_ERROR_INVALID_PARAM
; /* malformed token: e.g. %Cl7 */
913 return WPS_ERROR_INVALID_PARAM
;
916 struct viewport
*vp
= &skin_vp
->vp
;
917 /* format: %V|x|y|width|height|font|fg_pattern|bg_pattern| */
918 if (!(ptr
= viewport_parse_viewport(vp
, curr_screen
, ptr
, '|')))
919 return WPS_ERROR_INVALID_PARAM
;
921 /* Check for trailing | */
923 return WPS_ERROR_INVALID_PARAM
;
925 if (follow_lang_direction
&& lang_is_rtl())
927 vp
->flags
|= VP_FLAG_ALIGN_RIGHT
;
928 vp
->x
= screens
[curr_screen
].lcdwidth
- vp
->width
- vp
->x
;
931 vp
->flags
&= ~VP_FLAG_ALIGN_RIGHT
; /* ignore right-to-left languages */
933 #ifdef HAVE_REMOTE_LCD
934 if (vp
->font
== FONT_UI
&& curr_screen
== SCREEN_REMOTE
)
935 vp
->font
= FONT_UI_REMOTE
;
938 if (vp
->font
> FONT_UI
)
939 vp
->font
= font_ids
[vp
->font
- FONT_UI
];
941 struct skin_token_list
*list
= new_skin_token_list_item(NULL
, skin_vp
);
943 return WPS_ERROR_INVALID_PARAM
;
944 add_to_ll_chain(&wps_data
->viewports
, list
);
946 /* Skip the rest of the line */
947 return skip_end_of_line(wps_bufptr
);
950 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
951 static int parse_image_special(const char *wps_bufptr
,
952 struct wps_token
*token
,
953 struct wps_data
*wps_data
)
955 (void)wps_data
; /* kill warning */
957 const char *pos
= NULL
;
961 pos
= strchr(wps_bufptr
+ 1, '|');
962 newline
= strchr(wps_bufptr
, '\n');
964 error
= (pos
> newline
);
968 if (token
->type
== WPS_TOKEN_IMAGE_BACKDROP
)
970 /* format: %X|filename.bmp| or %Xd */
971 if (*(wps_bufptr
) == 'd')
973 wps_data
->backdrop
= NULL
;
974 return skip_end_of_line(wps_bufptr
);
977 wps_data
->backdrop
= (char*)wps_bufptr
+ 1;
981 return WPS_ERROR_INVALID_PARAM
;
982 /* Skip the rest of the line */
983 return skip_end_of_line(wps_bufptr
);
987 #endif /* HAVE_LCD_BITMAP */
989 static int parse_setting_and_lang(const char *wps_bufptr
,
990 struct wps_token
*token
,
991 struct wps_data
*wps_data
)
993 /* NOTE: both the string validations that happen in here will
994 * automatically PASS on checkwps because its too hard to get
995 * settings_list.c and englinsh.lang built for it.
996 * If that ever changes remove the #ifndef __PCTOOL__'s here
999 const char *ptr
= wps_bufptr
;
1004 /* Find the setting's cfg_name */
1006 return WPS_ERROR_INVALID_PARAM
;
1008 end
= strchr(ptr
,'|');
1010 return WPS_ERROR_INVALID_PARAM
;
1011 strlcpy(temp
, ptr
,end
-ptr
+1);
1013 if (token
->type
== WPS_TOKEN_TRANSLATEDSTRING
)
1016 i
= lang_english_to_id(temp
);
1018 return WPS_ERROR_INVALID_PARAM
;
1023 /* Find the setting */
1024 for (i
=0; i
<nb_settings
; i
++)
1025 if (settings
[i
].cfg_name
&&
1026 !strncmp(settings
[i
].cfg_name
,ptr
,end
-ptr
) &&
1027 /* prevent matches on cfg_name prefixes */
1028 strlen(settings
[i
].cfg_name
)==(size_t)(end
-ptr
))
1031 if (i
== nb_settings
)
1032 return WPS_ERROR_INVALID_PARAM
;
1035 /* Store the setting number */
1038 /* Skip the rest of the line */
1043 static int parse_dir_level(const char *wps_bufptr
,
1044 struct wps_token
*token
,
1045 struct wps_data
*wps_data
)
1047 char val
[] = { *wps_bufptr
, '\0' };
1048 token
->value
.i
= atoi(val
);
1049 (void)wps_data
; /* Kill warnings */
1053 static int parse_timeout(const char *wps_bufptr
,
1054 struct wps_token
*token
,
1055 struct wps_data
*wps_data
)
1059 bool have_point
= false;
1060 bool have_tenth
= false;
1062 (void)wps_data
; /* Kill the warning */
1064 while ( isdigit(*wps_bufptr
) || *wps_bufptr
== '.' )
1066 if (*wps_bufptr
!= '.')
1069 val
+= *wps_bufptr
- '0';
1085 if (have_tenth
== false)
1088 if (val
== 0 && skip
== 0)
1090 /* decide what to do if no value was specified */
1091 switch (token
->type
)
1093 case WPS_TOKEN_SUBLINE_TIMEOUT
:
1095 case WPS_TOKEN_BUTTON_VOLUME
:
1100 token
->value
.i
= val
;
1105 static int parse_progressbar(const char *wps_bufptr
,
1106 struct wps_token
*token
,
1107 struct wps_data
*wps_data
)
1109 /* %pb or %pb|filename|x|y|width|height|
1110 using - for any of the params uses "sane" values */
1111 #ifdef HAVE_LCD_BITMAP
1119 const char *filename
;
1120 int x
, y
, height
, width
;
1122 const char *ptr
= wps_bufptr
;
1123 struct progressbar
*pb
= skin_buffer_alloc(sizeof(struct progressbar
));
1124 struct skin_token_list
*item
= new_skin_token_list_item(token
, pb
);
1127 return WPS_ERROR_INVALID_PARAM
;
1129 struct viewport
*vp
= &curr_vp
->vp
;
1131 int font_height
= font_get(vp
->font
)->height
;
1133 int font_height
= 8;
1135 /* we need to know what line number (viewport relative) this pb is,
1136 * so count them... */
1138 struct skin_line
*line
= curr_vp
->lines
;
1144 pb
->have_bitmap_pb
= false;
1145 pb
->bm
.data
= NULL
; /* no bitmap specified */
1146 pb
->follow_lang_direction
= follow_lang_direction
> 0;
1148 if (*wps_bufptr
!= '|') /* regular old style */
1151 pb
->width
= vp
->width
;
1152 pb
->height
= SYSFONT_HEIGHT
-2;
1153 pb
->y
= -line_num
- 1; /* Will be computed during the rendering */
1156 add_to_ll_chain(&wps_data
->progressbars
, item
);
1159 ptr
= wps_bufptr
+ 1;
1161 if (!(ptr
= parse_list("sdddd", &set
, '|', ptr
, &filename
,
1162 &x
, &y
, &width
, &height
)))
1163 return WPS_ERROR_INVALID_PARAM
;
1165 if (LIST_VALUE_PARSED(set
, PB_FILENAME
)) /* filename */
1166 pb
->bm
.data
= (char*)filename
;
1168 if (LIST_VALUE_PARSED(set
, PB_X
)) /* x */
1173 if (LIST_VALUE_PARSED(set
, PB_WIDTH
)) /* width */
1175 /* A zero width causes a divide-by-zero error later, so reject it */
1177 return WPS_ERROR_INVALID_PARAM
;
1182 pb
->width
= vp
->width
- pb
->x
;
1184 if (LIST_VALUE_PARSED(set
, PB_HEIGHT
)) /* height, default to font height */
1186 /* A zero height makes no sense - reject it */
1188 return WPS_ERROR_INVALID_PARAM
;
1190 pb
->height
= height
;
1193 pb
->height
= font_height
;
1195 if (LIST_VALUE_PARSED(set
, PB_Y
)) /* y */
1198 pb
->y
= -line_num
- 1; /* Will be computed during the rendering */
1201 add_to_ll_chain(&wps_data
->progressbars
, item
);
1203 /* Skip the rest of the line */
1204 return skip_end_of_line(wps_bufptr
)-1;
1208 if (*(wps_bufptr
-1) == 'f')
1209 wps_data
->full_line_progressbar
= true;
1211 wps_data
->full_line_progressbar
= false;
1218 #ifdef HAVE_ALBUMART
1219 static int parse_int(const char *newline
, const char **_pos
, int *num
)
1221 *_pos
= parse_list("d", NULL
, '|', *_pos
, num
);
1223 return (!*_pos
|| *_pos
> newline
|| **_pos
!= '|');
1226 static int parse_albumart_load(const char *wps_bufptr
,
1227 struct wps_token
*token
,
1228 struct wps_data
*wps_data
)
1230 const char *_pos
, *newline
;
1232 struct dim dimensions
;
1234 bool swap_for_rtl
= lang_is_rtl() && follow_lang_direction
;
1235 struct skin_albumart
*aa
= skin_buffer_alloc(sizeof(struct skin_albumart
));
1236 (void)token
; /* silence warning */
1238 return skip_end_of_line(wps_bufptr
);
1240 /* reset albumart info in wps */
1243 aa
->xalign
= WPS_ALBUMART_ALIGN_CENTER
; /* default */
1244 aa
->yalign
= WPS_ALBUMART_ALIGN_CENTER
; /* default */
1245 aa
->vp
= &curr_vp
->vp
;
1247 /* format: %Cl|x|y|[[l|c|r]mwidth]|[[t|c|b]mheight]| */
1249 newline
= strchr(wps_bufptr
, '\n');
1254 return WPS_ERROR_INVALID_PARAM
; /* malformed token: e.g. %Cl7 */
1258 /* initial validation and parsing of x component */
1259 if (parse_int(newline
, &_pos
, &aa
->x
))
1260 return WPS_ERROR_INVALID_PARAM
;
1264 /* initial validation and parsing of y component */
1265 if (parse_int(newline
, &_pos
, &aa
->y
))
1266 return WPS_ERROR_INVALID_PARAM
;
1268 /* parsing width field */
1272 /* apply each modifier in turn */
1280 aa
->xalign
= WPS_ALBUMART_ALIGN_RIGHT
;
1282 aa
->xalign
= WPS_ALBUMART_ALIGN_LEFT
;
1286 aa
->xalign
= WPS_ALBUMART_ALIGN_CENTER
;
1292 aa
->xalign
= WPS_ALBUMART_ALIGN_LEFT
;
1294 aa
->xalign
= WPS_ALBUMART_ALIGN_RIGHT
;
1302 /* simply ignored */
1309 /* extract max width data */
1312 if (parse_int(newline
, &_pos
, &aa
->width
))
1313 return WPS_ERROR_INVALID_PARAM
;
1316 /* parsing height field */
1320 /* apply each modifier in turn */
1327 aa
->yalign
= WPS_ALBUMART_ALIGN_TOP
;
1331 aa
->yalign
= WPS_ALBUMART_ALIGN_CENTER
;
1336 aa
->yalign
= WPS_ALBUMART_ALIGN_BOTTOM
;
1344 /* simply ignored */
1351 /* extract max height data */
1354 if (parse_int(newline
, &_pos
, &aa
->height
))
1355 return WPS_ERROR_INVALID_PARAM
;
1358 /* if we got here, we parsed everything ok .. ! */
1361 else if (aa
->width
> LCD_WIDTH
)
1362 aa
->width
= LCD_WIDTH
;
1366 else if (aa
->height
> LCD_HEIGHT
)
1367 aa
->height
= LCD_HEIGHT
;
1370 aa
->x
= LCD_WIDTH
- (aa
->x
+ aa
->width
);
1372 aa
->state
= WPS_ALBUMART_LOAD
;
1374 wps_data
->albumart
= aa
;
1376 dimensions
.width
= aa
->width
;
1377 dimensions
.height
= aa
->height
;
1379 albumart_slot
= playback_claim_aa_slot(&dimensions
);
1381 if (0 <= albumart_slot
)
1382 wps_data
->playback_aa_slot
= albumart_slot
;
1384 /* Skip the rest of the line */
1385 return skip_end_of_line(wps_bufptr
);
1388 static int parse_albumart_display(const char *wps_bufptr
,
1389 struct wps_token
*token
,
1390 struct wps_data
*wps_data
)
1393 struct wps_token
*prev
= token
-1;
1394 if ((wps_data
->num_tokens
>= 1) && (prev
->type
== WPS_TOKEN_CONDITIONAL
))
1396 token
->type
= WPS_TOKEN_ALBUMART_FOUND
;
1398 else if (wps_data
->albumart
)
1400 wps_data
->albumart
->vp
= &curr_vp
->vp
;
1403 /* the old code did this so keep it here for now...
1404 * this is to allow the posibility to showing the next tracks AA! */
1405 if (wps_bufptr
+1 == 'n')
1410 #endif /* HAVE_ALBUMART */
1412 #ifdef HAVE_TOUCHSCREEN
1414 struct touchaction
{const char* s
; int action
;};
1415 static const struct touchaction touchactions
[] = {
1416 {"play", ACTION_WPS_PLAY
}, {"stop", ACTION_WPS_STOP
},
1417 {"prev", ACTION_WPS_SKIPPREV
}, {"next", ACTION_WPS_SKIPNEXT
},
1418 {"ffwd", ACTION_WPS_SEEKFWD
}, {"rwd", ACTION_WPS_SEEKBACK
},
1419 {"menu", ACTION_WPS_MENU
}, {"browse", ACTION_WPS_BROWSE
},
1420 {"shuffle", ACTION_TOUCH_SHUFFLE
}, {"repmode", ACTION_TOUCH_REPMODE
},
1421 {"quickscreen", ACTION_WPS_QUICKSCREEN
},{"contextmenu", ACTION_WPS_CONTEXT
},
1422 {"playlist", ACTION_WPS_VIEW_PLAYLIST
}, {"pitch", ACTION_WPS_PITCHSCREEN
},
1423 {"voldown", ACTION_WPS_VOLDOWN
}, {"volup", ACTION_WPS_VOLUP
},
1425 static int parse_touchregion(const char *wps_bufptr
,
1426 struct wps_token
*token
, struct wps_data
*wps_data
)
1430 struct touchregion
*region
= NULL
;
1431 const char *ptr
= wps_bufptr
;
1433 const char pb_string
[] = "progressbar";
1434 const char vol_string
[] = "volume";
1437 /* format: %T|x|y|width|height|action|
1438 * if action starts with & the area must be held to happen
1440 * play - play/pause playback
1441 * stop - stop playback, exit the wps
1444 * ffwd - seek forward
1445 * rwd - seek backwards
1446 * menu - go back to the main menu
1447 * browse - go back to the file/db browser
1448 * shuffle - toggle shuffle mode
1449 * repmode - cycle the repeat mode
1450 * quickscreen - go into the quickscreen
1451 * contextmenu - open the context menu
1452 * playlist - go into the playlist
1453 * pitch - go into the pitchscreen
1454 * volup - increase volume by one step
1455 * voldown - decrease volume by one step
1460 return WPS_ERROR_INVALID_PARAM
;
1463 if (!(ptr
= parse_list("dddds", NULL
, '|', ptr
, &x
, &y
, &w
, &h
, &action
)))
1464 return WPS_ERROR_INVALID_PARAM
;
1466 /* Check there is a terminating | */
1468 return WPS_ERROR_INVALID_PARAM
;
1470 region
= skin_buffer_alloc(sizeof(struct touchregion
));
1472 return WPS_ERROR_INVALID_PARAM
;
1474 /* should probably do some bounds checking here with the viewport... but later */
1475 region
->action
= ACTION_NONE
;
1480 region
->wvp
= curr_vp
;
1482 if(!strncmp(pb_string
, action
, sizeof(pb_string
)-1)
1483 && *(action
+ sizeof(pb_string
)-1) == '|')
1484 region
->type
= WPS_TOUCHREGION_SCROLLBAR
;
1485 else if(!strncmp(vol_string
, action
, sizeof(vol_string
)-1)
1486 && *(action
+ sizeof(vol_string
)-1) == '|')
1487 region
->type
= WPS_TOUCHREGION_VOLUME
;
1490 region
->type
= WPS_TOUCHREGION_ACTION
;
1495 region
->repeat
= true;
1498 region
->repeat
= false;
1501 imax
= ARRAYLEN(touchactions
);
1502 while ((region
->action
== ACTION_NONE
) &&
1505 /* try to match with one of our touchregion screens */
1506 int len
= strlen(touchactions
[i
].s
);
1507 if (!strncmp(touchactions
[i
].s
, action
, len
)
1508 && *(action
+len
) == '|')
1509 region
->action
= touchactions
[i
].action
;
1512 if (region
->action
== ACTION_NONE
)
1513 return WPS_ERROR_INVALID_PARAM
;
1515 struct skin_token_list
*item
= new_skin_token_list_item(NULL
, region
);
1517 return WPS_ERROR_INVALID_PARAM
;
1518 add_to_ll_chain(&wps_data
->touchregions
, item
);
1519 return skip_end_of_line(wps_bufptr
);
1523 /* Parse a generic token from the given string. Return the length read */
1524 static int parse_token(const char *wps_bufptr
, struct wps_data
*wps_data
)
1526 int skip
= 0, taglen
= 0, ret
;
1527 struct wps_token
*token
= wps_data
->tokens
+ wps_data
->num_tokens
;
1528 const struct wps_tag
*tag
;
1529 memset(token
, 0, sizeof(*token
));
1540 /* escaped characters */
1541 token
->type
= WPS_TOKEN_CHARACTER
;
1542 token
->value
.c
= *wps_bufptr
;
1544 wps_data
->num_tokens
++;
1548 /* conditional tag */
1549 token
->type
= WPS_TOKEN_CONDITIONAL
;
1551 condindex
[level
] = wps_data
->num_tokens
;
1552 numoptions
[level
] = 1;
1553 wps_data
->num_tokens
++;
1554 ret
= parse_token(wps_bufptr
+ 1, wps_data
);
1555 if (ret
< 0) return ret
;
1560 /* find what tag we have */
1561 for (tag
= all_tags
;
1562 strncmp(wps_bufptr
, tag
->name
, strlen(tag
->name
)) != 0;
1565 taglen
= (tag
->type
!= WPS_TOKEN_UNKNOWN
) ? strlen(tag
->name
) : 2;
1566 token
->type
= tag
->type
;
1567 curr_line
->curr_subline
->line_type
|= tag
->refresh_type
;
1569 /* if the tag has a special parsing function, we call it */
1570 if (tag
->parse_func
)
1572 ret
= tag
->parse_func(wps_bufptr
+ taglen
, token
, wps_data
);
1573 if (ret
< 0) return ret
;
1577 /* Some tags we don't want to save as tokens */
1578 if (tag
->type
== WPS_NO_TOKEN
)
1581 /* tags that start with 'F', 'I' or 'D' are for the next file */
1582 if ( *(tag
->name
) == 'I' || *(tag
->name
) == 'F' ||
1583 *(tag
->name
) == 'D')
1586 wps_data
->num_tokens
++;
1596 * Returns the number of bytes to skip the buf pointer to access the false
1597 * branch in a _binary_ conditional
1600 * - before the '|' if we have a false branch, (%?<true|false> -> %?<|false>)
1601 * - or before the closing '>' if there's no false branch (%?<true> -> %?<>)
1603 * depending on the features of a target it's not called from check_feature_tag,
1604 * hence the __attribute__ or it issues compiler warnings
1608 static int find_false_branch(const char *wps_bufptr
) __attribute__((unused
));
1609 static int find_false_branch(const char *wps_bufptr
)
1611 const char *buf
= wps_bufptr
;
1612 /* wps_bufptr is after the opening '<', hence level = 1*/
1619 { /* filter out the characters we check later if they're printed
1622 if (ch
== '<' || ch
== '>' || ch
== '|')
1624 /* else: some tags/printed literals we skip over */
1626 else if (ch
== '<') /* nested conditional */
1629 { /* closed our or a nested conditional,
1630 * do NOT skip over the '>' so that wps_parse() sees it for closing
1631 * if it is the closing one for our conditional */
1634 else if (ch
== '|' && level
== 1)
1635 { /* we found our separator, point before and get out */
1638 /* if level is 0, we don't have a false branch */
1639 } while (level
> 0 && *(++buf
));
1641 return buf
- wps_bufptr
;
1645 * returns the number of bytes to get the appropriate branch of a binary
1649 * - if a feature is available, it returns 0 to not skip anything
1650 * - if the feature is not available, skip to the false branch and don't
1651 * parse the true branch at all
1654 static int check_feature_tag(const char *wps_bufptr
, const int type
)
1659 case WPS_TOKEN_RTC_PRESENT
:
1663 return find_false_branch(wps_bufptr
);
1665 case WPS_TOKEN_HAVE_RECORDING
:
1666 #ifdef HAVE_RECORDING
1669 return find_false_branch(wps_bufptr
);
1671 default: /* not a tag we care about, just don't skip */
1678 data is the pointer to the structure where the parsed WPS should be stored.
1680 wps_bufptr points to the string containing the WPS tags */
1681 #define TOKEN_BLOCK_SIZE 128
1682 static bool wps_parse(struct wps_data
*data
, const char *wps_bufptr
, bool debug
)
1684 if (!data
|| !wps_bufptr
|| !*wps_bufptr
)
1686 enum wps_parse_error fail
= PARSE_OK
;
1688 int max_tokens
= TOKEN_BLOCK_SIZE
;
1689 size_t buf_free
= 0;
1693 /* allocate enough RAM for a reasonable skin, grow as needed.
1694 * Free any used RAM before loading the images to be 100% RAM efficient */
1695 data
->tokens
= (struct wps_token
*)skin_buffer_grab(&buf_free
);
1696 if (sizeof(struct wps_token
)*max_tokens
>= buf_free
)
1698 skin_buffer_increment(max_tokens
* sizeof(struct wps_token
), false);
1699 data
->num_tokens
= 0;
1702 /* Backdrop defaults to the setting unless %X is used, so set it now */
1703 if (global_settings
.backdrop_file
[0])
1705 data
->backdrop
= "-";
1709 while (*wps_bufptr
&& !fail
)
1711 if (follow_lang_direction
)
1712 follow_lang_direction
--;
1713 /* first make sure there is enough room for tokens */
1714 if (max_tokens
<= data
->num_tokens
+ 5)
1716 int extra_tokens
= TOKEN_BLOCK_SIZE
;
1717 size_t needed
= extra_tokens
* sizeof(struct wps_token
);
1718 /* do some smarts here to grow the array a bit */
1719 if (skin_buffer_freespace() < needed
)
1721 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1724 skin_buffer_increment(needed
, false);
1725 max_tokens
+= extra_tokens
;
1728 switch(*wps_bufptr
++)
1733 if ((ret
= parse_token(wps_bufptr
, data
)) < 0)
1735 fail
= PARSE_FAIL_COND_INVALID_PARAM
;
1738 else if (level
>= WPS_MAX_COND_LEVEL
- 1)
1740 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1746 /* Alternating sublines separator */
1748 if (level
>= 0) /* there are unclosed conditionals */
1750 fail
= PARSE_FAIL_UNCLOSED_COND
;
1754 if (!skin_start_new_subline(curr_line
, data
->num_tokens
))
1755 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1759 /* Conditional list start */
1761 if (data
->tokens
[data
->num_tokens
-2].type
!= WPS_TOKEN_CONDITIONAL
)
1763 fail
= PARSE_FAIL_COND_SYNTAX_ERROR
;
1766 wps_bufptr
+= check_feature_tag(wps_bufptr
,
1767 data
->tokens
[data
->num_tokens
-1].type
);
1768 data
->tokens
[data
->num_tokens
].type
= WPS_TOKEN_CONDITIONAL_START
;
1769 lastcond
[level
] = data
->num_tokens
++;
1772 /* Conditional list end */
1774 if (level
< 0) /* not in a conditional, invalid char */
1776 fail
= PARSE_FAIL_INVALID_CHAR
;
1780 data
->tokens
[data
->num_tokens
].type
= WPS_TOKEN_CONDITIONAL_END
;
1781 if (lastcond
[level
])
1782 data
->tokens
[lastcond
[level
]].value
.i
= data
->num_tokens
;
1785 fail
= PARSE_FAIL_COND_SYNTAX_ERROR
;
1789 lastcond
[level
] = 0;
1791 data
->tokens
[condindex
[level
]].value
.i
= numoptions
[level
];
1795 /* Conditional list option */
1797 if (level
< 0) /* not in a conditional, invalid char */
1799 fail
= PARSE_FAIL_INVALID_CHAR
;
1803 data
->tokens
[data
->num_tokens
].type
= WPS_TOKEN_CONDITIONAL_OPTION
;
1804 if (lastcond
[level
])
1805 data
->tokens
[lastcond
[level
]].value
.i
= data
->num_tokens
;
1808 fail
= PARSE_FAIL_COND_SYNTAX_ERROR
;
1812 lastcond
[level
] = data
->num_tokens
;
1813 numoptions
[level
]++;
1819 if (level
>= 0) /* there are unclosed conditionals */
1821 fail
= PARSE_FAIL_UNCLOSED_COND
;
1825 wps_bufptr
+= skip_end_of_line(wps_bufptr
);
1828 /* End of this line */
1830 if (level
>= 0) /* there are unclosed conditionals */
1832 fail
= PARSE_FAIL_UNCLOSED_COND
;
1835 /* add a new token for the \n so empty lines are correct */
1836 data
->tokens
[data
->num_tokens
].type
= WPS_TOKEN_CHARACTER
;
1837 data
->tokens
[data
->num_tokens
].value
.c
= '\n';
1838 data
->tokens
[data
->num_tokens
].next
= false;
1841 if (!skin_start_new_line(curr_vp
, data
->num_tokens
))
1843 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1853 unsigned int len
= 1;
1854 const char *string_start
= wps_bufptr
- 1;
1856 /* find the length of the string */
1857 while (*wps_bufptr
&& *wps_bufptr
!= '#' &&
1858 *wps_bufptr
!= '%' && *wps_bufptr
!= ';' &&
1859 *wps_bufptr
!= '<' && *wps_bufptr
!= '>' &&
1860 *wps_bufptr
!= '|' && *wps_bufptr
!= '\n')
1866 /* look if we already have that string */
1869 struct skin_token_list
*list
= data
->strings
;
1872 str
= (char*)list
->token
->value
.data
;
1873 found
= (strlen(str
) == len
&&
1874 strncmp(string_start
, str
, len
) == 0);
1876 break; /* break here because the list item is
1877 used if its found */
1880 /* If a matching string is found, found is true and i is
1881 the index of the string. If not, found is false */
1886 str
= (char*)skin_buffer_alloc(len
+1);
1889 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1892 strlcpy(str
, string_start
, len
+1);
1893 struct skin_token_list
*item
=
1894 new_skin_token_list_item(&data
->tokens
[data
->num_tokens
], str
);
1897 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1900 add_to_ll_chain(&data
->strings
, item
);
1904 /* another occurrence of an existing string */
1905 data
->tokens
[data
->num_tokens
].value
.data
= list
->token
->value
.data
;
1907 data
->tokens
[data
->num_tokens
].type
= WPS_TOKEN_STRING
;
1914 if (!fail
&& level
>= 0) /* there are unclosed conditionals */
1915 fail
= PARSE_FAIL_UNCLOSED_COND
;
1917 if (*wps_bufptr
&& !fail
)
1918 /* one of the limits of the while loop was exceeded */
1919 fail
= PARSE_FAIL_LIMITS_EXCEEDED
;
1922 curr_line
->curr_subline
->last_token_idx
= data
->num_tokens
;
1923 data
->tokens
[data
->num_tokens
++].type
= WPS_NO_TOKEN
;
1924 /* freeup unused tokens */
1925 skin_buffer_free_from_front(sizeof(struct wps_token
)
1926 * (max_tokens
- data
->num_tokens
));
1928 #if defined(DEBUG) || defined(SIMULATOR)
1930 print_debug_info(data
, fail
, line_number
);
1940 * initial setup of wps_data; does reset everything
1941 * except fields which need to survive, i.e.
1944 static void skin_data_reset(struct wps_data
*wps_data
)
1946 #ifdef HAVE_LCD_BITMAP
1947 wps_data
->images
= NULL
;
1948 wps_data
->progressbars
= NULL
;
1950 #if LCD_DEPTH > 1 || defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
1951 wps_data
->backdrop
= NULL
;
1953 #ifdef HAVE_TOUCHSCREEN
1954 wps_data
->touchregions
= NULL
;
1956 wps_data
->viewports
= NULL
;
1957 wps_data
->strings
= NULL
;
1958 #ifdef HAVE_ALBUMART
1959 wps_data
->albumart
= NULL
;
1960 if (wps_data
->playback_aa_slot
>= 0)
1962 playback_release_aa_slot(wps_data
->playback_aa_slot
);
1963 wps_data
->playback_aa_slot
= -1;
1966 wps_data
->tokens
= NULL
;
1967 wps_data
->num_tokens
= 0;
1969 #ifdef HAVE_LCD_BITMAP
1970 wps_data
->peak_meter_enabled
= false;
1971 wps_data
->wps_sb_tag
= false;
1972 wps_data
->show_sb_on_wps
= false;
1973 #else /* HAVE_LCD_CHARCELLS */
1976 for (i
= 0; i
< 8; i
++)
1978 wps_data
->wps_progress_pat
[i
] = 0;
1980 wps_data
->full_line_progressbar
= false;
1982 wps_data
->wps_loaded
= false;
1985 #ifdef HAVE_LCD_BITMAP
1986 static bool load_skin_bmp(struct wps_data
*wps_data
, struct bitmap
*bitmap
, char* bmpdir
)
1988 (void)wps_data
; /* only needed for remote targets */
1989 char img_path
[MAX_PATH
];
1990 get_image_filename(bitmap
->data
, bmpdir
,
1991 img_path
, sizeof(img_path
));
1993 /* load the image */
1995 #ifdef HAVE_REMOTE_LCD
1996 if (curr_screen
== SCREEN_REMOTE
)
1997 format
= FORMAT_ANY
|FORMAT_REMOTE
;
2000 format
= FORMAT_ANY
|FORMAT_TRANSPARENT
;
2003 char* imgbuf
= (char*)skin_buffer_grab(&max_buf
);
2004 bitmap
->data
= imgbuf
;
2005 int ret
= read_bmp_file(img_path
, bitmap
, max_buf
, format
, NULL
);
2009 skin_buffer_increment(ret
, true);
2014 /* Abort if we can't load an image */
2019 static bool load_skin_bitmaps(struct wps_data
*wps_data
, char *bmpdir
)
2021 struct skin_token_list
*list
;
2022 bool retval
= true; /* return false if a single image failed to load */
2023 /* do the progressbars */
2024 list
= wps_data
->progressbars
;
2027 struct progressbar
*pb
= (struct progressbar
*)list
->token
->value
.data
;
2030 pb
->have_bitmap_pb
= load_skin_bmp(wps_data
, &pb
->bm
, bmpdir
);
2031 if (!pb
->have_bitmap_pb
) /* no success */
2036 /* regular images */
2037 list
= wps_data
->images
;
2040 struct gui_img
*img
= (struct gui_img
*)list
->token
->value
.data
;
2043 img
->loaded
= load_skin_bmp(wps_data
, &img
->bm
, bmpdir
);
2045 img
->subimage_height
= img
->bm
.height
/ img
->num_subimages
;
2052 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
2053 /* Backdrop load scheme:
2055 * 2) load the backdrop from settings
2057 if (wps_data
->backdrop
)
2059 bool needed
= wps_data
->backdrop
[0] != '-';
2060 wps_data
->backdrop
= skin_backdrop_load(wps_data
->backdrop
,
2061 bmpdir
, curr_screen
);
2062 if (!wps_data
->backdrop
&& needed
)
2065 #endif /* has backdrop support */
2070 #endif /* HAVE_LCD_BITMAP */
2072 /* to setup up the wps-data from a format-buffer (isfile = false)
2073 from a (wps-)file (isfile = true)*/
2074 bool skin_data_load(enum screen_type screen
, struct wps_data
*wps_data
,
2075 const char *buf
, bool isfile
)
2078 if (!wps_data
|| !buf
)
2080 #ifdef HAVE_ALBUMART
2082 struct mp3entry
*curtrack
;
2084 struct skin_albumart old_aa
= {.state
= WPS_ALBUMART_NONE
};
2085 if (wps_data
->albumart
)
2087 old_aa
.state
= wps_data
->albumart
->state
;
2088 old_aa
.height
= wps_data
->albumart
->height
;
2089 old_aa
.width
= wps_data
->albumart
->width
;
2093 skin_data_reset(wps_data
);
2094 curr_screen
= screen
;
2096 /* alloc default viewport, will be fixed up later */
2097 curr_vp
= skin_buffer_alloc(sizeof(struct skin_viewport
));
2100 struct skin_token_list
*list
= new_skin_token_list_item(NULL
, curr_vp
);
2103 add_to_ll_chain(&wps_data
->viewports
, list
);
2106 /* Initialise the first (default) viewport */
2107 curr_vp
->label
= VP_DEFAULT_LABEL
;
2109 curr_vp
->hidden_flags
= 0;
2110 curr_vp
->lines
= NULL
;
2112 viewport_set_defaults(&curr_vp
->vp
, screen
);
2115 if (!skin_start_new_line(curr_vp
, 0))
2120 if (wps_parse(wps_data
, buf
, false))
2122 #ifdef HAVE_LCD_BITMAP
2123 /* load the backdrop */
2124 if (!load_skin_bitmaps(wps_data
, BACKDROP_DIR
)) {
2125 skin_data_reset(wps_data
);
2135 int fd
= open_utf8(buf
, O_RDONLY
);
2140 /* get buffer space from the plugin buffer */
2141 size_t buffersize
= 0;
2142 char *wps_buffer
= (char *)plugin_get_buffer(&buffersize
);
2147 /* copy the file's content to the buffer for parsing,
2148 ensuring that every line ends with a newline char. */
2149 unsigned int start
= 0;
2150 while(read_line(fd
, wps_buffer
+ start
, buffersize
- start
) > 0)
2152 start
+= strlen(wps_buffer
+ start
);
2153 if (start
< buffersize
- 1)
2155 wps_buffer
[start
++] = '\n';
2156 wps_buffer
[start
] = 0;
2165 /* parse the WPS source */
2166 if (!wps_parse(wps_data
, wps_buffer
, true)) {
2167 skin_data_reset(wps_data
);
2171 wps_data
->wps_loaded
= true;
2173 #ifdef HAVE_LCD_BITMAP
2174 /* get the bitmap dir */
2175 char bmpdir
[MAX_PATH
];
2176 char *dot
= strrchr(buf
, '.');
2178 strlcpy(bmpdir
, buf
, dot
- buf
+ 1);
2180 /* load the bitmaps that were found by the parsing */
2181 if (!load_skin_bitmaps(wps_data
, bmpdir
)) {
2182 skin_data_reset(wps_data
);
2183 wps_data
->wps_loaded
= false;
2187 #if defined(HAVE_ALBUMART) && !defined(__PCTOOL__)
2188 status
= audio_status();
2189 if (status
& AUDIO_STATUS_PLAY
)
2191 struct skin_albumart
*aa
= wps_data
->albumart
;
2192 if (aa
&& ((aa
->state
&& !old_aa
.state
) ||
2194 (((old_aa
.height
!= aa
->height
) ||
2195 (old_aa
.width
!= aa
->width
))))))
2197 curtrack
= audio_current_track();
2198 offset
= curtrack
->offset
;
2200 if (!(status
& AUDIO_STATUS_PAUSE
))
2205 #if defined(DEBUG) || defined(SIMULATOR)