lib/mcconfig.h

   1 #ifndef MC_CONFIG_H
   2 #define MC_CONFIG_H
   3
   4 /*** typedefs(not structures) and defined constants **********************************************/
   5
   6 #define CONFIG_APP_SECTION "Midnight-Commander"
   7 #define CONFIG_PANELS_SECTION "Panels"
   8
   9 /*** enums ***************************************************************************************/
  10
  11 /*** structures declarations (and typedefs of structures)*****************************************/
  12
  13 typedef struct mc_config_struct
  14 {
  15     GKeyFile *handle;
  16     gchar *ini_path;
  17 } mc_config_t;
  18
  19 /*** global variables defined in .c file *********************************************************/
  20
  21 extern mc_config_t *mc_main_config;
  22 extern mc_config_t *mc_panels_config;
  23
  24 /*** declarations of public functions ************************************************************/
  25
  26 /* mcconfig/common.c: */
  27
  28 mc_config_t *mc_config_init (const gchar *);
  29 void mc_config_deinit (mc_config_t *);
  30
  31 gboolean mc_config_del_key (mc_config_t *, const char *, const gchar *);
  32 gboolean mc_config_del_group (mc_config_t *, const char *);
  33
  34 gboolean mc_config_has_param (mc_config_t *, const char *, const gchar *);
  35 gboolean mc_config_has_group (mc_config_t *, const char *);
  36
  37 gboolean mc_config_read_file (mc_config_t * mc_config, const gchar * ini_path,
  38                               gboolean remove_empty);
  39
  40 gboolean mc_config_save_file (mc_config_t * config, GError ** error);
  41
  42 gboolean mc_config_save_to_file (mc_config_t * config, const gchar * filename, GError ** error);
  43
  44
  45 /* mcconfig/get.c: */
  46
  47 gchar **mc_config_get_groups (mc_config_t *, gsize *);
  48
  49 gchar **mc_config_get_keys (mc_config_t *, const gchar *, gsize *);
  50
  51 gchar *mc_config_get_string (mc_config_t *, const gchar *, const gchar *, const gchar *);
  52
  53 gchar *mc_config_get_string_raw (mc_config_t *, const gchar *, const gchar *, const gchar *);
  54
  55 gboolean mc_config_get_bool (mc_config_t *, const gchar *, const gchar *, gboolean);
  56
  57 int mc_config_get_int (mc_config_t *, const gchar *, const gchar *, int);
  58
  59
  60 gchar **mc_config_get_string_list (mc_config_t *, const gchar *, const gchar *, gsize *);
  61
  62 gboolean *mc_config_get_bool_list (mc_config_t *, const gchar *, const gchar *, gsize *);
  63
  64 int *mc_config_get_int_list (mc_config_t *, const gchar *, const gchar *, gsize *);
  65
  66
  67 /* mcconfig/set.c: */
  68
  69 void mc_config_set_string_raw (mc_config_t *, const gchar *, const gchar *, const gchar *);
  70
  71 void mc_config_set_string (mc_config_t *, const gchar *, const gchar *, const gchar *);
  72
  73 void mc_config_set_bool (mc_config_t *, const gchar *, const gchar *, gboolean);
  74
  75 void mc_config_set_int (mc_config_t *, const gchar *, const gchar *, int);
  76
  77 void
  78 mc_config_set_string_list (mc_config_t *, const gchar *,
  79                            const gchar *, const gchar * const[], gsize);
  80
  81 void mc_config_set_bool_list (mc_config_t *, const gchar *, const gchar *, gboolean[], gsize);
  82
  83 void mc_config_set_int_list (mc_config_t *, const gchar *, const gchar *, int[], gsize);
  84
  85
  86 /* mcconfig/dialog.c: */
  87
  88 void mc_config_show_dialog (void);
  89
  90
  91 /* mcconfig/paths.c: */
  92
  93 void mc_config_init_config_paths (GError ** error);
  94
  95 void mc_config_deinit_config_paths (void);
  96
  97 gboolean mc_config_deprecated_dir_present (void);
  98
  99 void mc_config_migrate_from_old_place (GError ** error);
 100
 101 const char *mc_config_get_data_path (void);
 102
 103 const char *mc_config_get_cache_path (void);
 104
 105 const char *mc_config_get_path (void);
 106
 107 const char *mc_config_get_home_dir (void);
 108
 109
 110 /*** inline functions ****************************************************************************/
 111
 112 #endif