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