lxdream.org :: lxdream/src/config.h r1034:7044e01148f0

view

     1 /**

     2  * $Id$

     3  *

     4  * User configuration support

     5  *

     6  * Copyright (c) 2005 Nathan Keynes.

     7  *

     8  * This program is free software; you can redistribute it and/or modify

     9  * it under the terms of the GNU General Public License as published by

    10  * the Free Software Foundation; either version 2 of the License, or

    11  * (at your option) any later version.

    12  *

    13  * This program is distributed in the hope that it will be useful,

    14  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16  * GNU General Public License for more details.

    17  */

    19 #ifndef lxdream_config_H

    20 #define lxdream_config_H 1

    22 #include <glib/gtypes.h>

    23 #include <glib/glist.h>

    24 #include "gettext.h"

    26 #ifdef __cplusplus

    27 extern "C" {

    28 #endif

    30 #define CONFIG_TYPE_NONE 0

    31 #define CONFIG_TYPE_FILE 1

    32 #define CONFIG_TYPE_PATH 2

    33 #define CONFIG_TYPE_KEY 3

    34 #define CONFIG_TYPE_FILELIST 4

    36 #define DEFAULT_CONFIG_FILENAME "lxdreamrc"

    38 typedef struct lxdream_config_entry {

    39     const gchar *key;

    40     const gchar *label; // i18n

    41     const int type;

    42     const gchar *default_value;

    43     gchar *value;

    44 } *lxdream_config_entry_t;

    46 typedef struct lxdream_config_group {

    47     const gchar *key;

    48     struct lxdream_config_entry *params;

    49 } *lxdream_config_group_t;

    51 #define CONFIG_BIOS_PATH 0

    52 #define CONFIG_FLASH_PATH 1

    53 #define CONFIG_DEFAULT_PATH 2

    54 #define CONFIG_SAVE_PATH 3

    55 #define CONFIG_VMU_PATH 4

    56 #define CONFIG_BOOTSTRAP 5

    57 #define CONFIG_GDROM 6

    58 #define CONFIG_RECENT 7

    59 #define CONFIG_VMU 8

    60 #define CONFIG_KEY_MAX CONFIG_VMU

    62 extern struct lxdream_config_group lxdream_config_root[];

    64 /* Global config values */

    65 const gchar *lxdream_get_config_value( int key );

    66 const struct lxdream_config_entry * lxdream_get_config_entry( int key );

    67 void lxdream_register_config_group( const gchar *key, lxdream_config_entry_t group );

    68 void lxdream_set_global_config_value( int key, const gchar *value );

    69 void lxdream_set_config_value( lxdream_config_entry_t entry, const gchar *value );

    70 gboolean lxdream_set_group_value( lxdream_config_group_t group, const gchar *key, const gchar *value );

    71 void lxdream_copy_config_list( lxdream_config_entry_t dest, lxdream_config_entry_t src );

    73 /**

    74  * Construct a list of strings for the given config key - The caller is

    75  * responsible for freeing the list and its values.

    76  */

    77 GList *lxdream_get_global_config_list_value( int key );

    79 /**

    80  * Set a config key based on a list of strings.

    81  */

    82 void lxdream_set_global_config_list_value( int key, const GList *list );

    83 /**

    84  * Search the standard locations for the configuration file:

    85  *   $HOME/.lxdreamrc

    86  *   $CWD/lxdreamrc

    87  *   $SYSCONF_DIR/lxdreamrc

    88  * @return TRUE if the file was found, otherwise FALSE.

    89  */

    90 gboolean lxdream_find_config( );

    92 /**

    93  * Set the configuration file filename to the supplied string.

    94  * The string is copied internally (ie can be released by the

    95  * caller).

    96  */

    97 void lxdream_set_config_filename( const gchar *filename );

    99 /**

   100  * Load the configuration from the previously determined filename.

   101  */

   102 gboolean lxdream_load_config( );

   104 /**

   105  * Update the configuration

   106  */

   107 gboolean lxdream_save_config( );

   109 #ifdef __cplusplus

   110 }

   111 #endif

   113 #endif /* !lxdream_config_H */