apps/misc.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Daniel Stenberg
  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 #ifndef MISC_H
  22 #define MISC_H
  23
  24 #include <stdbool.h>
  25 #include <inttypes.h>
  26 #include "config.h"
  27 #include "system.h"
  28
  29 extern const unsigned char * const byte_units[];
  30 extern const unsigned char * const * const kbyte_units;
  31
  32 /* Format a large-range value for output, using the appropriate unit so that
  33  * the displayed value is in the range 1 <= display < 1000 (1024 for "binary"
  34  * units) if possible, and 3 significant digits are shown. If a buffer is
  35  * given, the result is snprintf()'d into that buffer, otherwise the result is
  36  * voiced.*/
  37 char *output_dyn_value(char *buf, int buf_size, int value,
  38                       const unsigned char * const *units, bool bin_scale);
  39
  40 /* Format time into buf.
  41  *
  42  * buf      - buffer to format to.
  43  * buf_size - size of buffer.
  44  * t        - time to format, in milliseconds.
  45  */
  46 void format_time(char* buf, int buf_size, long t);
  47
  48 /* Ask the user if they really want to erase the current dynamic playlist
  49  * returns true if the playlist should be replaced */
  50 bool warn_on_pl_erase(void);
  51
  52 /* Read (up to) a line of text from fd into buffer and return number of bytes
  53  * read (which may be larger than the number of bytes stored in buffer). If
  54  * an error occurs, -1 is returned (and buffer contains whatever could be
  55  * read). A line is terminated by a LF char. Neither LF nor CR chars are
  56  * stored in buffer.
  57  */
  58 int read_line(int fd, char* buffer, int buffer_size);
  59 int fast_readline(int fd, char *buf, int buf_size, void *parameters,
  60                   int (*callback)(int n, const char *buf, void *parameters));
  61
  62 bool settings_parseline(char* line, char** name, char** value);
  63 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter);
  64 long default_event_handler(long event);
  65 bool list_stop_handler(void);
  66 void car_adapter_mode_init(void);
  67 extern int show_logo(void);
  68
  69 int open_utf8(const char* pathname, int flags);
  70
  71 #ifdef BOOTFILE
  72 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF) \
  73         || defined(HAVE_HOTSWAP_STORAGE_AS_MAIN)
  74 void check_bootfile(bool do_rolo);
  75 #endif
  76 #endif
  77
  78 /* check range, set volume and save settings */
  79 void setvol(void);
  80
  81 #ifdef HAVE_LCD_COLOR
  82 int hex_to_rgb(const char* hex, int* color);
  83 #endif
  84
  85 char* strrsplt(char* str, int c);
  86 char* skip_whitespace(char* const str);
  87 bool file_exists(const char *file);
  88 bool dir_exists(const char *path);
  89
  90 /*
  91  * removes the extension of filename (if it doesn't start with a .)
  92  * puts the result in buffer
  93  */
  94 char *strip_extension(char* buffer, int buffer_size, const char *filename);
  95
  96 #ifdef HAVE_LCD_BITMAP
  97 /* A simplified scanf */
  98 /*
  99  * Checks whether the value at position 'position' was really read
 100  * during a call to 'parse_list'
 101  *   - position: 0-based number of the value
 102  *   - valid_vals: value after the call to 'parse_list'
 103  */
 104 #define LIST_VALUE_PARSED(setvals, position) ((setvals) & BIT_N(position))
 105 const char* parse_list(const char *fmt, uint32_t *set_vals,
 106                        const char sep, const char* str, ...);
 107
 108 /* only used in USB HID and set_time screen */
 109 #if defined(USB_ENABLE_HID) || (CONFIG_RTC != 0)
 110 int clamp_value_wrap(int value, int max, int min);
 111 #endif
 112 #endif
 113
 114 #endif /* MISC_H */