Fix strcpy from a user-supplied string to fixed size string.
[kugel-rb.git] / apps / misc.c
blobf9c6116205df28420754035f1fb237f2bf1599a3
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by Daniel Stenberg
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 ****************************************************************************/
21 #include <stdlib.h>
22 #include <ctype.h>
23 #include <string.h>
24 #include "config.h"
25 #include "misc.h"
26 #include "lcd.h"
27 #include "file.h"
28 #ifdef __PCTOOL__
29 #include <stdarg.h>
30 #include <stdio.h>
31 #else
32 #include "sprintf.h"
33 #include "lang.h"
34 #include "dir.h"
35 #include "lcd-remote.h"
36 #include "errno.h"
37 #include "system.h"
38 #include "timefuncs.h"
39 #include "screens.h"
40 #include "usb_screen.h"
41 #include "talk.h"
42 #include "audio.h"
43 #include "mp3_playback.h"
44 #include "settings.h"
45 #include "storage.h"
46 #include "ata_idle_notify.h"
47 #include "kernel.h"
48 #include "power.h"
49 #include "powermgmt.h"
50 #include "backlight.h"
51 #include "version.h"
52 #include "font.h"
53 #include "splash.h"
54 #include "tagcache.h"
55 #include "scrobbler.h"
56 #include "sound.h"
57 #include "playlist.h"
58 #include "yesno.h"
59 #include "viewport.h"
61 #ifdef IPOD_ACCESSORY_PROTOCOL
62 #include "iap.h"
63 #endif
65 #if (CONFIG_STORAGE & STORAGE_MMC)
66 #include "ata_mmc.h"
67 #endif
68 #include "tree.h"
69 #include "eeprom_settings.h"
70 #if defined(HAVE_RECORDING) && !defined(__PCTOOL__)
71 #include "recording.h"
72 #endif
73 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
74 #include "bmp.h"
75 #include "icons.h"
76 #endif /* End HAVE_LCD_BITMAP */
77 #include "bookmark.h"
78 #include "wps.h"
79 #include "playback.h"
81 #ifdef BOOTFILE
82 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF) \
83 || defined(HAVE_HOTSWAP_STORAGE_AS_MAIN)
84 #include "rolo.h"
85 #endif
86 #endif
88 /* units used with output_dyn_value */
89 const unsigned char * const byte_units[] =
91 ID2P(LANG_BYTE),
92 ID2P(LANG_KILOBYTE),
93 ID2P(LANG_MEGABYTE),
94 ID2P(LANG_GIGABYTE)
97 const unsigned char * const * const kbyte_units = &byte_units[1];
99 /* Format a large-range value for output, using the appropriate unit so that
100 * the displayed value is in the range 1 <= display < 1000 (1024 for "binary"
101 * units) if possible, and 3 significant digits are shown. If a buffer is
102 * given, the result is snprintf()'d into that buffer, otherwise the result is
103 * voiced.*/
104 char *output_dyn_value(char *buf, int buf_size, int value,
105 const unsigned char * const *units, bool bin_scale)
107 int scale = bin_scale ? 1024 : 1000;
108 int fraction = 0;
109 int unit_no = 0;
110 char tbuf[5];
112 while (value >= scale)
114 fraction = value % scale;
115 value /= scale;
116 unit_no++;
118 if (bin_scale)
119 fraction = fraction * 1000 / 1024;
121 if (value >= 100 || !unit_no)
122 tbuf[0] = '\0';
123 else if (value >= 10)
124 snprintf(tbuf, sizeof(tbuf), "%01d", fraction / 100);
125 else
126 snprintf(tbuf, sizeof(tbuf), "%02d", fraction / 10);
128 if (buf)
130 if (strlen(tbuf))
131 snprintf(buf, buf_size, "%d%s%s%s", value, str(LANG_POINT),
132 tbuf, P2STR(units[unit_no]));
133 else
134 snprintf(buf, buf_size, "%d%s", value, P2STR(units[unit_no]));
136 else
138 talk_fractional(tbuf, value, P2ID(units[unit_no]));
140 return buf;
143 /* Ask the user if they really want to erase the current dynamic playlist
144 * returns true if the playlist should be replaced */
145 bool warn_on_pl_erase(void)
147 if (global_settings.warnon_erase_dynplaylist &&
148 !global_settings.party_mode &&
149 playlist_modified(NULL))
151 static const char *lines[] =
152 {ID2P(LANG_WARN_ERASEDYNPLAYLIST_PROMPT)};
153 static const struct text_message message={lines, 1};
155 return (gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES);
157 else
158 return true;
161 /* Read (up to) a line of text from fd into buffer and return number of bytes
162 * read (which may be larger than the number of bytes stored in buffer). If
163 * an error occurs, -1 is returned (and buffer contains whatever could be
164 * read). A line is terminated by a LF char. Neither LF nor CR chars are
165 * stored in buffer.
167 int read_line(int fd, char* buffer, int buffer_size)
169 int count = 0;
170 int num_read = 0;
172 errno = 0;
174 while (count < buffer_size)
176 unsigned char c;
178 if (1 != read(fd, &c, 1))
179 break;
181 num_read++;
183 if ( c == '\n' )
184 break;
186 if ( c == '\r' )
187 continue;
189 buffer[count++] = c;
192 buffer[MIN(count, buffer_size - 1)] = 0;
194 return errno ? -1 : num_read;
197 /* Performance optimized version of the previous function. */
198 int fast_readline(int fd, char *buf, int buf_size, void *parameters,
199 int (*callback)(int n, const char *buf, void *parameters))
201 char *p, *next;
202 int rc, pos = 0;
203 int count = 0;
205 while ( 1 )
207 next = NULL;
209 rc = read(fd, &buf[pos], buf_size - pos - 1);
210 if (rc >= 0)
211 buf[pos+rc] = '\0';
213 if ( (p = strchr(buf, '\r')) != NULL)
215 *p = '\0';
216 next = ++p;
218 else
219 p = buf;
221 if ( (p = strchr(p, '\n')) != NULL)
223 *p = '\0';
224 next = ++p;
227 rc = callback(count, buf, parameters);
228 if (rc < 0)
229 return rc;
231 count++;
232 if (next)
234 pos = buf_size - ((long)next - (long)buf) - 1;
235 memmove(buf, next, pos);
237 else
238 break ;
241 return 0;
244 /* parse a line from a configuration file. the line format is:
246 name: value
248 Any whitespace before setting name or value (after ':') is ignored.
249 A # as first non-whitespace character discards the whole line.
250 Function sets pointers to null-terminated setting name and value.
251 Returns false if no valid config entry was found.
254 bool settings_parseline(char* line, char** name, char** value)
256 char* ptr;
258 line = skip_whitespace(line);
260 if ( *line == '#' )
261 return false;
263 ptr = strchr(line, ':');
264 if ( !ptr )
265 return false;
267 *name = line;
268 *ptr = 0;
269 ptr++;
270 ptr = skip_whitespace(ptr);
271 *value = ptr;
272 return true;
275 static void system_flush(void)
277 scrobbler_shutdown();
278 playlist_shutdown();
279 tree_flush();
280 call_storage_idle_notifys(true); /*doesnt work on usb and shutdown from ata thread */
283 static void system_restore(void)
285 tree_restore();
286 scrobbler_init();
289 static bool clean_shutdown(void (*callback)(void *), void *parameter)
291 #ifdef SIMULATOR
292 (void)callback;
293 (void)parameter;
294 bookmark_autobookmark(false);
295 call_storage_idle_notifys(true);
296 exit(0);
297 #else
298 long msg_id = -1;
299 int i;
301 scrobbler_poweroff();
303 #if CONFIG_CHARGING && !defined(HAVE_POWEROFF_WHILE_CHARGING)
304 if(!charger_inserted())
305 #endif
307 bool batt_safe = battery_level_safe();
308 int audio_stat = audio_status();
310 FOR_NB_SCREENS(i)
312 screens[i].clear_display();
313 screens[i].update();
316 if (batt_safe)
318 #ifdef HAVE_TAGCACHE
319 if (!tagcache_prepare_shutdown())
321 cancel_shutdown();
322 splash(HZ, ID2P(LANG_TAGCACHE_BUSY));
323 return false;
325 #endif
326 if (battery_level() > 10)
327 splash(0, str(LANG_SHUTTINGDOWN));
328 else
330 msg_id = LANG_WARNING_BATTERY_LOW;
331 splashf(0, "%s %s", str(LANG_WARNING_BATTERY_LOW),
332 str(LANG_SHUTTINGDOWN));
335 else
337 msg_id = LANG_WARNING_BATTERY_EMPTY;
338 splashf(0, "%s %s", str(LANG_WARNING_BATTERY_EMPTY),
339 str(LANG_SHUTTINGDOWN));
342 if (global_settings.fade_on_stop
343 && (audio_stat & AUDIO_STATUS_PLAY))
345 fade(false, false);
348 if (batt_safe) /* do not save on critical battery */
350 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
351 if (audio_stat & AUDIO_STATUS_RECORD)
353 rec_command(RECORDING_CMD_STOP);
354 /* wait for stop to complete */
355 while (audio_status() & AUDIO_STATUS_RECORD)
356 sleep(1);
358 #endif
359 bookmark_autobookmark(false);
361 /* audio_stop_recording == audio_stop for HWCODEC */
362 audio_stop();
364 if (callback != NULL)
365 callback(parameter);
367 #if CONFIG_CODEC != SWCODEC
368 /* wait for audio_stop or audio_stop_recording to complete */
369 while (audio_status())
370 sleep(1);
371 #endif
373 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
374 audio_close_recording();
375 #endif
377 if(global_settings.talk_menu)
379 bool enqueue = false;
380 if(msg_id != -1)
382 talk_id(msg_id, enqueue);
383 enqueue = true;
385 talk_id(LANG_SHUTTINGDOWN, enqueue);
386 #if CONFIG_CODEC == SWCODEC
387 voice_wait();
388 #endif
391 system_flush();
392 #ifdef HAVE_EEPROM_SETTINGS
393 if (firmware_settings.initialized)
395 firmware_settings.disk_clean = true;
396 firmware_settings.bl_version = 0;
397 eeprom_settings_store();
399 #endif
401 #ifdef HAVE_DIRCACHE
402 else
403 dircache_disable();
404 #endif
406 shutdown_hw();
408 #endif
409 return false;
412 bool list_stop_handler(void)
414 bool ret = false;
416 /* Stop the music if it is playing */
417 if(audio_status())
419 if (!global_settings.party_mode)
421 if (global_settings.fade_on_stop)
422 fade(false, false);
423 bookmark_autobookmark(true);
424 audio_stop();
425 ret = true; /* bookmarking can make a refresh necessary */
428 #if CONFIG_CHARGING
429 #if (CONFIG_KEYPAD == RECORDER_PAD) && !defined(HAVE_SW_POWEROFF)
430 else
432 if (charger_inserted())
433 charging_splash();
434 else
435 shutdown_screen(); /* won't return if shutdown actually happens */
437 ret = true; /* screen is dirty, caller needs to refresh */
439 #endif
440 #ifndef HAVE_POWEROFF_WHILE_CHARGING
442 static long last_off = 0;
444 if (TIME_BEFORE(current_tick, last_off + HZ/2))
446 if (charger_inserted())
448 charging_splash();
449 ret = true; /* screen is dirty, caller needs to refresh */
452 last_off = current_tick;
454 #endif
455 #endif /* CONFIG_CHARGING */
456 return ret;
459 #if CONFIG_CHARGING
460 static bool waiting_to_resume_play = false;
461 static long play_resume_tick;
463 static void car_adapter_mode_processing(bool inserted)
465 if (global_settings.car_adapter_mode)
467 if(inserted)
470 * Just got plugged in, delay & resume if we were playing
472 if (audio_status() & AUDIO_STATUS_PAUSE)
474 /* delay resume a bit while the engine is cranking */
475 play_resume_tick = current_tick + HZ*5;
476 waiting_to_resume_play = true;
479 else
482 * Just got unplugged, pause if playing
484 if ((audio_status() & AUDIO_STATUS_PLAY) &&
485 !(audio_status() & AUDIO_STATUS_PAUSE))
487 if (global_settings.fade_on_stop)
488 fade(false, false);
489 else
490 audio_pause();
492 waiting_to_resume_play = false;
497 static void car_adapter_tick(void)
499 if (waiting_to_resume_play)
501 if (TIME_AFTER(current_tick, play_resume_tick))
503 if (audio_status() & AUDIO_STATUS_PAUSE)
505 queue_broadcast(SYS_CAR_ADAPTER_RESUME, 0);
507 waiting_to_resume_play = false;
512 void car_adapter_mode_init(void)
514 tick_add_task(car_adapter_tick);
516 #endif
518 #ifdef HAVE_HEADPHONE_DETECTION
519 static void unplug_change(bool inserted)
521 static bool headphone_caused_pause = false;
523 if (global_settings.unplug_mode)
525 int audio_stat = audio_status();
526 if (inserted)
528 if ((audio_stat & AUDIO_STATUS_PLAY) &&
529 headphone_caused_pause &&
530 global_settings.unplug_mode > 1 )
531 audio_resume();
532 backlight_on();
533 headphone_caused_pause = false;
534 } else {
535 if ((audio_stat & AUDIO_STATUS_PLAY) &&
536 !(audio_stat & AUDIO_STATUS_PAUSE))
538 headphone_caused_pause = true;
539 audio_pause();
541 if (global_settings.unplug_rw)
543 if (audio_current_track()->elapsed >
544 (unsigned long)(global_settings.unplug_rw*1000))
545 audio_ff_rewind(audio_current_track()->elapsed -
546 (global_settings.unplug_rw*1000));
547 else
548 audio_ff_rewind(0);
554 #endif
556 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter)
558 switch(event)
560 case SYS_BATTERY_UPDATE:
561 if(global_settings.talk_battery_level)
563 talk_ids(true, VOICE_PAUSE, VOICE_PAUSE,
564 LANG_BATTERY_TIME,
565 TALK_ID(battery_level(), UNIT_PERCENT),
566 VOICE_PAUSE);
567 talk_force_enqueue_next();
569 break;
570 case SYS_USB_CONNECTED:
571 if (callback != NULL)
572 callback(parameter);
573 #if (CONFIG_STORAGE & STORAGE_MMC)
574 if (!mmc_touched() ||
575 (mmc_remove_request() == SYS_HOTSWAP_EXTRACTED))
576 #endif
578 system_flush();
579 #ifdef BOOTFILE
580 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF)
581 check_bootfile(false); /* gets initial size */
582 #endif
583 #endif
584 gui_usb_screen_run();
585 #ifdef BOOTFILE
586 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF)
587 check_bootfile(true);
588 #endif
589 #endif
590 system_restore();
592 return SYS_USB_CONNECTED;
594 case SYS_POWEROFF:
595 if (!clean_shutdown(callback, parameter))
596 return SYS_POWEROFF;
597 break;
598 #if CONFIG_CHARGING
599 case SYS_CHARGER_CONNECTED:
600 car_adapter_mode_processing(true);
601 return SYS_CHARGER_CONNECTED;
603 case SYS_CHARGER_DISCONNECTED:
604 car_adapter_mode_processing(false);
605 /*reset rockbox battery runtime*/
606 global_status.runtime = 0;
607 return SYS_CHARGER_DISCONNECTED;
609 case SYS_CAR_ADAPTER_RESUME:
610 audio_resume();
611 return SYS_CAR_ADAPTER_RESUME;
612 #endif
613 #ifdef HAVE_HOTSWAP_STORAGE_AS_MAIN
614 case SYS_FS_CHANGED:
616 /* simple sanity: assume rockbox is on the first hotswappable
617 * driver, abort out if that one isn't inserted */
618 int i;
619 for (i = 0; i < NUM_DRIVES; i++)
621 if (storage_removable(i) && !storage_present(i))
622 return SYS_FS_CHANGED;
624 system_flush();
625 check_bootfile(true); /* state gotten in main.c:init() */
626 system_restore();
628 return SYS_FS_CHANGED;
629 #endif
630 #ifdef HAVE_HEADPHONE_DETECTION
631 case SYS_PHONE_PLUGGED:
632 unplug_change(true);
633 return SYS_PHONE_PLUGGED;
635 case SYS_PHONE_UNPLUGGED:
636 unplug_change(false);
637 return SYS_PHONE_UNPLUGGED;
638 #endif
639 #ifdef IPOD_ACCESSORY_PROTOCOL
640 case SYS_IAP_PERIODIC:
641 iap_periodic();
642 return SYS_IAP_PERIODIC;
643 case SYS_IAP_HANDLEPKT:
644 iap_handlepkt();
645 return SYS_IAP_HANDLEPKT;
646 #endif
648 return 0;
651 long default_event_handler(long event)
653 return default_event_handler_ex(event, NULL, NULL);
656 int show_logo( void )
658 #ifdef HAVE_LCD_BITMAP
659 char version[32];
660 int font_h, font_w;
662 snprintf(version, sizeof(version), "Ver. %s", appsversion);
664 lcd_clear_display();
665 #if defined(SANSA_CLIP) || defined(SANSA_CLIPV2) || defined(SANSA_CLIPPLUS)
666 /* display the logo in the blue area of the screen */
667 lcd_setfont(FONT_SYSFIXED);
668 lcd_getstringsize((unsigned char *)"A", &font_w, &font_h);
669 lcd_putsxy((LCD_WIDTH/2) - ((strlen(version)*font_w)/2),
670 0, (unsigned char *)version);
671 lcd_bitmap(rockboxlogo, 0, 16, BMPWIDTH_rockboxlogo, BMPHEIGHT_rockboxlogo);
672 #else
673 lcd_bitmap(rockboxlogo, 0, 10, BMPWIDTH_rockboxlogo, BMPHEIGHT_rockboxlogo);
674 lcd_setfont(FONT_SYSFIXED);
675 lcd_getstringsize((unsigned char *)"A", &font_w, &font_h);
676 lcd_putsxy((LCD_WIDTH/2) - ((strlen(version)*font_w)/2),
677 LCD_HEIGHT-font_h, (unsigned char *)version);
678 #endif
679 lcd_setfont(FONT_UI);
681 #else
682 char *rockbox = " ROCKbox!";
684 lcd_clear_display();
685 lcd_double_height(true);
686 lcd_puts(0, 0, rockbox);
687 lcd_puts_scroll(0, 1, appsversion);
688 #endif
689 lcd_update();
691 #ifdef HAVE_REMOTE_LCD
692 lcd_remote_clear_display();
693 lcd_remote_bitmap(remote_rockboxlogo, 0, 10, BMPWIDTH_remote_rockboxlogo,
694 BMPHEIGHT_remote_rockboxlogo);
695 lcd_remote_setfont(FONT_SYSFIXED);
696 lcd_remote_getstringsize((unsigned char *)"A", &font_w, &font_h);
697 lcd_remote_putsxy((LCD_REMOTE_WIDTH/2) - ((strlen(version)*font_w)/2),
698 LCD_REMOTE_HEIGHT-font_h, (unsigned char *)version);
699 lcd_remote_setfont(FONT_UI);
700 lcd_remote_update();
701 #endif
703 return 0;
706 #ifdef BOOTFILE
707 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF) || defined(HAVE_HOTSWAP_STORAGE_AS_MAIN)
709 memorize/compare details about the BOOTFILE
710 we don't use dircache because it may not be up to date after
711 USB disconnect (scanning in the background)
713 void check_bootfile(bool do_rolo)
715 static unsigned short wrtdate = 0;
716 static unsigned short wrttime = 0;
717 DIR* dir = NULL;
718 struct dirent* entry = NULL;
720 /* 1. open BOOTDIR and find the BOOTFILE dir entry */
721 dir = opendir(BOOTDIR);
723 if(!dir) return; /* do we want an error splash? */
725 /* loop all files in BOOTDIR */
726 while(0 != (entry = readdir(dir)))
728 if(!strcasecmp(entry->d_name, BOOTFILE))
730 /* found the bootfile */
731 if(wrtdate && do_rolo)
733 if((entry->wrtdate != wrtdate) ||
734 (entry->wrttime != wrttime))
736 static const char *lines[] = { ID2P(LANG_BOOT_CHANGED),
737 ID2P(LANG_REBOOT_NOW) };
738 static const struct text_message message={ lines, 2 };
739 button_clear_queue(); /* Empty the keyboard buffer */
740 if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES)
741 rolo_load(BOOTDIR "/" BOOTFILE);
744 wrtdate = entry->wrtdate;
745 wrttime = entry->wrttime;
748 closedir(dir);
750 #endif
751 #endif
753 /* check range, set volume and save settings */
754 void setvol(void)
756 const int min_vol = sound_min(SOUND_VOLUME);
757 const int max_vol = sound_max(SOUND_VOLUME);
758 if (global_settings.volume < min_vol)
759 global_settings.volume = min_vol;
760 if (global_settings.volume > max_vol)
761 global_settings.volume = max_vol;
762 sound_set_volume(global_settings.volume);
763 global_status.last_volume_change = current_tick;
764 settings_save();
767 char* strrsplt(char* str, int c)
769 char* s = strrchr(str, c);
771 if (s != NULL)
773 *s++ = '\0';
775 else
777 s = str;
780 return s;
783 /* Test file existence, using dircache of possible */
784 bool file_exists(const char *file)
786 int fd;
788 if (!file || strlen(file) <= 0)
789 return false;
791 #ifdef HAVE_DIRCACHE
792 if (dircache_is_enabled())
793 return (dircache_get_entry_ptr(file) != NULL);
794 #endif
796 fd = open(file, O_RDONLY);
797 if (fd < 0)
798 return false;
799 close(fd);
800 return true;
803 bool dir_exists(const char *path)
805 DIR* d = opendir(path);
806 if (!d)
807 return false;
808 closedir(d);
809 return true;
813 * removes the extension of filename (if it doesn't start with a .)
814 * puts the result in buffer
816 char *strip_extension(char* buffer, int buffer_size, const char *filename)
818 char *dot = strrchr(filename, '.');
819 int len;
821 if (buffer_size <= 0)
823 return NULL;
826 buffer_size--; /* Make room for end nil */
828 if (dot != 0 && filename[0] != '.')
830 len = dot - filename;
831 len = MIN(len, buffer_size);
833 else
835 len = buffer_size;
838 strlcpy(buffer, filename, len + 1);
840 return buffer;
842 #endif /* !defined(__PCTOOL__) */
844 char* skip_whitespace(char* const str)
846 char *s = str;
848 while (isspace(*s))
849 s++;
851 return s;
854 /* Format time into buf.
856 * buf - buffer to format to.
857 * buf_size - size of buffer.
858 * t - time to format, in milliseconds.
860 void format_time(char* buf, int buf_size, long t)
862 if ( t < 3600000 )
864 snprintf(buf, buf_size, "%d:%02d",
865 (int) (t / 60000), (int) (t % 60000 / 1000));
867 else
869 snprintf(buf, buf_size, "%d:%02d:%02d",
870 (int) (t / 3600000), (int) (t % 3600000 / 60000),
871 (int) (t % 60000 / 1000));
876 /** Open a UTF-8 file and set file descriptor to first byte after BOM.
877 * If no BOM is present this behaves like open().
878 * If the file is opened for writing and O_TRUNC is set, write a BOM to
879 * the opened file and leave the file pointer set after the BOM.
881 #define BOM "\xef\xbb\xbf"
882 #define BOM_SIZE 3
884 int open_utf8(const char* pathname, int flags)
886 int fd;
887 unsigned char bom[BOM_SIZE];
889 fd = open(pathname, flags);
890 if(fd < 0)
891 return fd;
893 if(flags & (O_TRUNC | O_WRONLY))
895 write(fd, BOM, BOM_SIZE);
897 else
899 read(fd, bom, BOM_SIZE);
900 /* check for BOM */
901 if(memcmp(bom, BOM, BOM_SIZE))
902 lseek(fd, 0, SEEK_SET);
904 return fd;
908 #ifdef HAVE_LCD_COLOR
910 * Helper function to convert a string of 6 hex digits to a native colour
913 static int hex2dec(int c)
915 return (((c) >= '0' && ((c) <= '9')) ? (c) - '0' :
916 (toupper(c)) - 'A' + 10);
919 int hex_to_rgb(const char* hex, int* color)
921 int red, green, blue;
922 int i = 0;
924 while ((i < 6) && (isxdigit(hex[i])))
925 i++;
927 if (i < 6)
928 return -1;
930 red = (hex2dec(hex[0]) << 4) | hex2dec(hex[1]);
931 green = (hex2dec(hex[2]) << 4) | hex2dec(hex[3]);
932 blue = (hex2dec(hex[4]) << 4) | hex2dec(hex[5]);
934 *color = LCD_RGBPACK(red,green,blue);
936 return 0;
938 #endif /* HAVE_LCD_COLOR */
940 #ifdef HAVE_LCD_BITMAP
941 /* A simplified scanf - used (at time of writing) by wps parsing functions.
943 fmt - char array specifying the format of each list option. Valid values
944 are: d - int
945 s - string (sets pointer to string, without copying)
946 c - hex colour (RGB888 - e.g. ff00ff)
947 g - greyscale "colour" (0-3)
948 set_vals - if not NULL 1 is set in the bitplace if the item was read OK
949 0 if not read.
950 first item is LSB, (max 32 items! )
951 Stops parseing if an item is invalid unless the item == '-'
952 sep - list separator (e.g. ',' or '|')
953 str - string to parse, must be terminated by 0 or sep
954 ... - pointers to store the parsed values
956 return value - pointer to char after parsed data, 0 if there was an error.
960 /* '0'-'3' are ASCII 0x30 to 0x33 */
961 #define is0123(x) (((x) & 0xfc) == 0x30)
963 const char* parse_list(const char *fmt, uint32_t *set_vals,
964 const char sep, const char* str, ...)
966 va_list ap;
967 const char* p = str, *f = fmt;
968 const char** s;
969 int* d;
970 bool set, is_negative;
971 int i=0;
973 va_start(ap, str);
974 if (set_vals)
975 *set_vals = 0;
976 while (*fmt)
978 /* Check for separator, if we're not at the start */
979 if (f != fmt)
981 if (*p != sep)
982 goto err;
983 p++;
985 set = false;
986 switch (*fmt++)
988 case 's': /* string - return a pointer to it (not a copy) */
989 s = va_arg(ap, const char **);
991 *s = p;
992 while (*p && *p != sep)
993 p++;
994 set = (s[0][0]!='-') && (s[0][1]!=sep) ;
995 break;
997 case 'd': /* int */
998 is_negative = false;
999 d = va_arg(ap, int*);
1000 if (*p == '-' && isdigit(*(p+1)))
1002 is_negative = true;
1003 p++;
1005 if (!isdigit(*p))
1007 if (!set_vals || *p != '-')
1008 goto err;
1009 while (*p && *p != sep)
1010 p++;
1012 else
1014 *d = *p++ - '0';
1015 while (isdigit(*p))
1016 *d = (*d * 10) + (*p++ - '0');
1017 set = true;
1018 if (is_negative)
1019 *d *= -1;
1022 break;
1024 #ifdef HAVE_LCD_COLOR
1025 case 'c': /* colour (rrggbb - e.g. f3c1a8) */
1026 d = va_arg(ap, int*);
1028 if (hex_to_rgb(p, d) < 0)
1030 if (!set_vals || *p != '-')
1031 goto err;
1032 while (*p && *p != sep)
1033 p++;
1035 else
1037 p += 6;
1038 set = true;
1041 break;
1042 #endif
1044 #if LCD_DEPTH == 2 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH == 2)
1045 case 'g': /* greyscale colour (0-3) */
1046 d = va_arg(ap, int*);
1048 if (is0123(*p))
1050 *d = *p++ - '0';
1051 set = true;
1053 else if (!set_vals || *p != '-')
1054 goto err;
1055 else
1057 while (*p && *p != sep)
1058 p++;
1061 break;
1062 #endif
1064 default: /* Unknown format type */
1065 goto err;
1066 break;
1068 if (set_vals && set)
1069 *set_vals |= BIT_N(i);
1070 i++;
1073 va_end(ap);
1074 return p;
1076 err:
1077 va_end(ap);
1078 return NULL;
1081 /* only used in USB HID and set_time screen */
1082 #if defined(USB_ENABLE_HID) || (CONFIG_RTC != 0)
1083 int clamp_value_wrap(int value, int max, int min)
1085 if (value > max)
1086 return min;
1087 if (value < min)
1088 return max;
1089 return value;
1091 #endif
1092 #endif