lib/mcconfig.h

   1 #ifndef MC__CONFIG_H
   2 #define MC__CONFIG_H
   3
   4 #include "lib/vfs/vfs.h"        /* vfs_path_t */
   5
   6 /*** typedefs(not structures) and defined constants **********************************************/
   7
   8 #define CONFIG_APP_SECTION "Midnight-Commander"
   9 #define CONFIG_PANELS_SECTION "Panels"
  10 #define CONFIG_LAYOUT_SECTION "Layout"
  11 #define CONFIG_MISC_SECTION "Misc"
  12 #define CONFIG_EXT_EDITOR_VIEWER_SECTION "External editor or viewer parameters"
  13
  14 /*** enums ***************************************************************************************/
  15
  16 /*** structures declarations (and typedefs of structures)*****************************************/
  17
  18 typedef struct mc_config_t
  19 {
  20     GKeyFile *handle;
  21     gchar *ini_path;
  22 } mc_config_t;
  23
  24 /*** global variables defined in .c file *********************************************************/
  25
  26 extern int num_history_items_recorded;
  27
  28 /*** declarations of public functions ************************************************************/
  29
  30 /* mcconfig/common.c: */
  31
  32 mc_config_t *mc_config_init (const gchar * ini_path, gboolean read_only);
  33 void mc_config_deinit (mc_config_t * mc_config);
  34
  35 gboolean mc_config_has_param (const mc_config_t * mc_config, const char *group,
  36                               const gchar * param);
  37 gboolean mc_config_has_group (mc_config_t * mc_config, const char *group);
  38
  39 gboolean mc_config_del_key (mc_config_t * mc_config, const char *group, const gchar * param);
  40 gboolean mc_config_del_group (mc_config_t * mc_config, const char *group);
  41
  42 gboolean mc_config_read_file (mc_config_t * mc_config, const gchar * ini_path, gboolean read_only,
  43                               gboolean remove_empty);
  44 gboolean mc_config_save_file (mc_config_t * config, GError ** mcerror);
  45 gboolean mc_config_save_to_file (mc_config_t * mc_config, const gchar * ini_path,
  46                                  GError ** mcerror);
  47
  48
  49 /* mcconfig/get.c: */
  50
  51 gchar **mc_config_get_groups (const mc_config_t * mc_config, gsize * len);
  52 gchar **mc_config_get_keys (const mc_config_t * mc_config, const gchar * group, gsize * len);
  53
  54 gchar *mc_config_get_string (mc_config_t * mc_config, const gchar * group, const gchar * param,
  55                              const gchar * def);
  56 gchar *mc_config_get_string_raw (mc_config_t * mc_config, const gchar * group, const gchar * param,
  57                                  const gchar * def);
  58 gboolean mc_config_get_bool (mc_config_t * mc_config, const gchar * group, const gchar * param,
  59                              gboolean def);
  60 int mc_config_get_int (mc_config_t * mc_config, const gchar * group, const gchar * param, int def);
  61
  62 gchar **mc_config_get_string_list (mc_config_t * mc_config, const gchar * group,
  63                                    const gchar * param, gsize * length);
  64 gboolean *mc_config_get_bool_list (mc_config_t * mc_config, const gchar * group,
  65                                    const gchar * param, gsize * length);
  66 int *mc_config_get_int_list (mc_config_t * mc_config, const gchar * group, const gchar * param,
  67                              gsize * length);
  68
  69
  70 /* mcconfig/set.c: */
  71
  72 void mc_config_set_string_raw (mc_config_t * mc_config, const gchar * group, const gchar * param,
  73                                const gchar * value);
  74 void mc_config_set_string_raw_value (mc_config_t * mc_config, const gchar * group,
  75                                      const gchar * param, const gchar * value);
  76 void mc_config_set_string (mc_config_t * mc_config, const gchar * group, const gchar * param,
  77                            const gchar * value);
  78 void mc_config_set_bool (mc_config_t * mc_config, const gchar * group, const gchar * param,
  79                          gboolean value);
  80 void mc_config_set_int (mc_config_t * mc_config, const gchar * group, const gchar * param,
  81                         int value);
  82
  83 void
  84 mc_config_set_string_list (mc_config_t * mc_config, const gchar * group, const gchar * param,
  85                            const gchar * const value[], gsize length);
  86 void mc_config_set_bool_list (mc_config_t * mc_config, const gchar * group, const gchar * param,
  87                               gboolean value[], gsize length);
  88 void mc_config_set_int_list (mc_config_t * mc_config, const gchar * group, const gchar * param,
  89                              int value[], gsize length);
  90
  91
  92 /* mcconfig/paths.c: */
  93
  94 void mc_config_init_config_paths (GError ** error);
  95 void mc_config_deinit_config_paths (void);
  96
  97 const char *mc_config_get_data_path (void);
  98 const char *mc_config_get_cache_path (void);
  99 const char *mc_config_get_home_dir (void);
 100 const char *mc_config_get_path (void);
 101 char *mc_config_get_full_path (const char *config_name);
 102 vfs_path_t *mc_config_get_full_vpath (const char *config_name);
 103
 104 /* mcconfig/history.h */
 105
 106 /* read history to the mc_config, but don't save config to file */
 107 GList *mc_config_history_get (const char *name);
 108 /* read recent item from the history */
 109 char *mc_config_history_get_recent_item (const char *name);
 110 /* load history from the mc_config */
 111 GList *mc_config_history_load (mc_config_t * cfg, const char *name);
 112 /* save history to the mc_config, but don't save config to file */
 113 void mc_config_history_save (mc_config_t * cfg, const char *name, GList * h);
 114
 115
 116 /*** inline functions ****************************************************************************/
 117
 118 #endif /* MC__CONFIG_H */