nkeynes@450 | 1 | /**
|
nkeynes@561 | 2 | * $Id$
|
nkeynes@450 | 3 | *
|
nkeynes@450 | 4 | * User configuration support
|
nkeynes@450 | 5 | *
|
nkeynes@450 | 6 | * Copyright (c) 2005 Nathan Keynes.
|
nkeynes@450 | 7 | *
|
nkeynes@450 | 8 | * This program is free software; you can redistribute it and/or modify
|
nkeynes@450 | 9 | * it under the terms of the GNU General Public License as published by
|
nkeynes@450 | 10 | * the Free Software Foundation; either version 2 of the License, or
|
nkeynes@450 | 11 | * (at your option) any later version.
|
nkeynes@450 | 12 | *
|
nkeynes@450 | 13 | * This program is distributed in the hope that it will be useful,
|
nkeynes@450 | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
nkeynes@450 | 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
nkeynes@450 | 16 | * GNU General Public License for more details.
|
nkeynes@450 | 17 | */
|
nkeynes@450 | 18 |
|
nkeynes@450 | 19 | #ifndef lxdream_config_H
|
nkeynes@450 | 20 | #define lxdream_config_H 1
|
nkeynes@450 | 21 |
|
nkeynes@450 | 22 | #include <glib/gtypes.h>
|
nkeynes@1034 | 23 | #include <glib/glist.h>
|
nkeynes@755 | 24 | #include "gettext.h"
|
nkeynes@450 | 25 |
|
nkeynes@736 | 26 | #ifdef __cplusplus
|
nkeynes@736 | 27 | extern "C" {
|
nkeynes@736 | 28 | #endif
|
nkeynes@736 | 29 |
|
nkeynes@450 | 30 | #define CONFIG_TYPE_NONE 0
|
nkeynes@450 | 31 | #define CONFIG_TYPE_FILE 1
|
nkeynes@450 | 32 | #define CONFIG_TYPE_PATH 2
|
nkeynes@450 | 33 | #define CONFIG_TYPE_KEY 3
|
nkeynes@1034 | 34 | #define CONFIG_TYPE_FILELIST 4
|
nkeynes@1038 | 35 | #define CONFIG_TYPE_INTEGER 5
|
nkeynes@450 | 36 |
|
nkeynes@450 | 37 | #define DEFAULT_CONFIG_FILENAME "lxdreamrc"
|
nkeynes@450 | 38 |
|
nkeynes@450 | 39 | typedef struct lxdream_config_entry {
|
nkeynes@450 | 40 | const gchar *key;
|
nkeynes@724 | 41 | const gchar *label; // i18n
|
nkeynes@450 | 42 | const int type;
|
nkeynes@450 | 43 | const gchar *default_value;
|
nkeynes@450 | 44 | gchar *value;
|
nkeynes@450 | 45 | } *lxdream_config_entry_t;
|
nkeynes@450 | 46 |
|
nkeynes@450 | 47 | typedef struct lxdream_config_group {
|
nkeynes@450 | 48 | const gchar *key;
|
nkeynes@450 | 49 | struct lxdream_config_entry *params;
|
nkeynes@450 | 50 | } *lxdream_config_group_t;
|
nkeynes@450 | 51 |
|
nkeynes@450 | 52 | #define CONFIG_BIOS_PATH 0
|
nkeynes@450 | 53 | #define CONFIG_FLASH_PATH 1
|
nkeynes@450 | 54 | #define CONFIG_DEFAULT_PATH 2
|
nkeynes@450 | 55 | #define CONFIG_SAVE_PATH 3
|
nkeynes@1034 | 56 | #define CONFIG_VMU_PATH 4
|
nkeynes@1034 | 57 | #define CONFIG_BOOTSTRAP 5
|
nkeynes@1034 | 58 | #define CONFIG_GDROM 6
|
nkeynes@1034 | 59 | #define CONFIG_RECENT 7
|
nkeynes@1034 | 60 | #define CONFIG_VMU 8
|
nkeynes@1038 | 61 | #define CONFIG_QUICK_STATE 9
|
nkeynes@1038 | 62 | #define CONFIG_KEY_MAX CONFIG_QUICK_STATE
|
nkeynes@450 | 63 |
|
nkeynes@450 | 64 | extern struct lxdream_config_group lxdream_config_root[];
|
nkeynes@450 | 65 |
|
nkeynes@450 | 66 | /* Global config values */
|
nkeynes@1036 | 67 | const gchar *lxdream_get_global_config_value( int key );
|
nkeynes@1036 | 68 | const struct lxdream_config_entry * lxdream_get_global_config_entry( int key );
|
nkeynes@1036 | 69 | void lxdream_set_global_config_value( int key, const gchar *value );
|
nkeynes@1036 | 70 |
|
nkeynes@1024 | 71 | void lxdream_register_config_group( const gchar *key, lxdream_config_entry_t group );
|
nkeynes@460 | 72 | void lxdream_set_config_value( lxdream_config_entry_t entry, const gchar *value );
|
nkeynes@458 | 73 | gboolean lxdream_set_group_value( lxdream_config_group_t group, const gchar *key, const gchar *value );
|
nkeynes@460 | 74 | void lxdream_copy_config_list( lxdream_config_entry_t dest, lxdream_config_entry_t src );
|
nkeynes@460 | 75 |
|
nkeynes@450 | 76 | /**
|
nkeynes@1036 | 77 | * Return a fully expanded path value for a key - this performs substitutions
|
nkeynes@1036 | 78 | * for ~ and simple shell variables ($VAR and ${VAR})
|
nkeynes@1036 | 79 | *
|
nkeynes@1036 | 80 | * The returned string is newly allocated and must be freed by the caller
|
nkeynes@1036 | 81 | */
|
nkeynes@1036 | 82 | gchar *lxdream_get_global_config_path_value( int key );
|
nkeynes@1036 | 83 |
|
nkeynes@1036 | 84 | /**
|
nkeynes@1036 | 85 | * Set a path value for a key, escaping if necessary to protect against
|
nkeynes@1036 | 86 | * shell-substitution on the round trip.
|
nkeynes@1036 | 87 | *
|
nkeynes@1036 | 88 | * @return the resultant config value.
|
nkeynes@1036 | 89 | */
|
nkeynes@1036 | 90 | const gchar *lxdream_set_global_config_path_value( int key, const gchar *value );
|
nkeynes@1036 | 91 |
|
nkeynes@1036 | 92 | /**
|
nkeynes@1034 | 93 | * Construct a list of strings for the given config key - The caller is
|
nkeynes@1034 | 94 | * responsible for freeing the list and its values.
|
nkeynes@1034 | 95 | */
|
nkeynes@1034 | 96 | GList *lxdream_get_global_config_list_value( int key );
|
nkeynes@1034 | 97 |
|
nkeynes@1034 | 98 | /**
|
nkeynes@1034 | 99 | * Set a config key based on a list of strings.
|
nkeynes@1034 | 100 | */
|
nkeynes@1034 | 101 | void lxdream_set_global_config_list_value( int key, const GList *list );
|
nkeynes@1034 | 102 | /**
|
nkeynes@450 | 103 | * Search the standard locations for the configuration file:
|
nkeynes@450 | 104 | * $HOME/.lxdreamrc
|
nkeynes@450 | 105 | * $CWD/lxdreamrc
|
nkeynes@450 | 106 | * $SYSCONF_DIR/lxdreamrc
|
nkeynes@450 | 107 | * @return TRUE if the file was found, otherwise FALSE.
|
nkeynes@450 | 108 | */
|
nkeynes@450 | 109 | gboolean lxdream_find_config( );
|
nkeynes@450 | 110 |
|
nkeynes@450 | 111 | /**
|
nkeynes@450 | 112 | * Set the configuration file filename to the supplied string.
|
nkeynes@450 | 113 | * The string is copied internally (ie can be released by the
|
nkeynes@450 | 114 | * caller).
|
nkeynes@450 | 115 | */
|
nkeynes@450 | 116 | void lxdream_set_config_filename( const gchar *filename );
|
nkeynes@450 | 117 |
|
nkeynes@450 | 118 | /**
|
nkeynes@450 | 119 | * Load the configuration from the previously determined filename.
|
nkeynes@450 | 120 | */
|
nkeynes@450 | 121 | gboolean lxdream_load_config( );
|
nkeynes@450 | 122 |
|
nkeynes@450 | 123 | /**
|
nkeynes@450 | 124 | * Update the configuration
|
nkeynes@450 | 125 | */
|
nkeynes@450 | 126 | gboolean lxdream_save_config( );
|
nkeynes@450 | 127 |
|
nkeynes@1036 | 128 | /**
|
nkeynes@1038 | 129 | * Make the user configuration directories if they don't already exist.
|
nkeynes@1038 | 130 | */
|
nkeynes@1038 | 131 | void lxdream_make_config_dir( );
|
nkeynes@1038 | 132 |
|
nkeynes@736 | 133 | #ifdef __cplusplus
|
nkeynes@736 | 134 | }
|
nkeynes@736 | 135 | #endif
|
nkeynes@450 | 136 |
|
nkeynes@450 | 137 | #endif /* !lxdream_config_H */
|