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