File: mod-cfg-get-param.c

package info (click to toggle)
gpredict 2.3-72-gc596101-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 12,264 kB
  • sloc: ansic: 39,918; makefile: 469; python: 143; sh: 85
file content (241 lines) | stat: -rw-r--r-- 7,058 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
    Gpredict: Real-time satellite tracking and orbit prediction program

    Copyright (C)  2001-2009  Alexandru Csete, OZ9AEC.

    Authors: Alexandru Csete <oz9aec@gmail.com>

    Comments, questions and bugreports should be submitted via
    http://sourceforge.net/projects/gpredict/
    More details can be found at the project home page:

            http://gpredict.oz9aec.net/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
  
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
  
    You should have received a copy of the GNU General Public License
    along with this program; if not, visit http://www.fsf.org/
*/

/**
 * \brief Utilities to read module configuration parameters.
 *
 * This file contains utility functions that can can be used by modules
 * to read configuration parameters from the GKeyFile of the module. If
 * a parameter does not exist in the GKeyFile the corrersponding value
 * from sat-cfg will be returned.
 *
 * The intended use of these functions is to read parameters when creating
 * new modules. A module may have it's own configuration for most settings
 * while for some settings the global/default values may be needed. To avoid
 * too much repetitive coding in the module implementations, the functions
 * warp this code into one convenient function call.
 */

#ifdef HAVE_CONFIG_H
#include <build-config.h>
#endif

#include <glib/gi18n.h>
#include <gtk/gtk.h>

#include "config-keys.h"
#include "sat-cfg.h"
#include "sat-log.h"


/**
 * \brief Get boolean parameter.
 * \param f The configuration data for the module.
 * \param sec Configuration section in the cfg data (see config-keys.h).
 * \param key Configuration key in the cfg data (see config-keys.h).
 * \param p SatCfg index to use as fallback.
 */
gboolean mod_cfg_get_bool(GKeyFile * f, const gchar * sec, const gchar * key,
                          sat_cfg_bool_e p)
{
    GError         *error = NULL;
    gboolean        param;

    /* check whether parameter is present in GKeyFile, otherwise use sat-cfg */
    if (g_key_file_has_key(f, sec, key, NULL))
    {
        param = g_key_file_get_boolean(f, sec, key, &error);

        if (error != NULL)
        {
            sat_log_log(SAT_LOG_LEVEL_INFO,
                        _("%s: Failed to read boolean (%s)"),
                        __func__, error->message);

            g_clear_error(&error);

            /* get a timeout from global config */
            param = sat_cfg_get_bool(p);
        }
    }
    else
    {
        param = sat_cfg_get_bool(p);
    }

    return param;
}


gint mod_cfg_get_int(GKeyFile * f, const gchar * sec, const gchar * key,
                     sat_cfg_int_e p)
{
    GError         *error = NULL;
    gint            param;

    /* check whether parameter is present in GKeyFile */
    if (g_key_file_has_key(f, sec, key, NULL))
    {
        param = g_key_file_get_integer(f, sec, key, &error);

        if (error != NULL)
        {
            sat_log_log(SAT_LOG_LEVEL_WARN,
                        _("%s: Failed to read integer (%s)"),
                        __func__, error->message);

            g_clear_error(&error);

            /* get a timeout from global config */
            param = sat_cfg_get_int(p);
        }
    }
    /* get value from sat-cfg */
    else
    {
        param = sat_cfg_get_int(p);
    }

    return param;
}


gchar          *mod_cfg_get_str(GKeyFile * f, const gchar * sec,
                                const gchar * key, sat_cfg_str_e p)
{
    GError         *error = NULL;
    gchar          *param;

    /* check whether parameter is present in GKeyFile, otherwise use sat-cfg */
    if (g_key_file_has_key(f, sec, key, NULL))
    {
        param = g_key_file_get_string(f, sec, key, &error);

        if (error != NULL)
        {
            sat_log_log(SAT_LOG_LEVEL_WARN,
                        _("%s: Failed to read string (%s)"),
                        __func__, error->message);

            g_clear_error(&error);

            /* get a timeout from global config */
            param = sat_cfg_get_str(p);
        }
    }
    else
    {
        param = sat_cfg_get_str(p);
    }

    return param;
}

/**
 * \brief Load an integer list into a hash table that uses the 
 * existinence of datain the hash as a boolean.
 * It loads NULL's into the hash table.  
 */
void mod_cfg_get_integer_list_boolean(GKeyFile * cfgdata,
                                      const gchar * section, const gchar * key,
                                      GHashTable * dest)
{
    gint           *sats = NULL;
    gsize           length;
    GError         *error = NULL;
    guint           i;
    guint          *tkey;

    if (!g_key_file_has_key(cfgdata, section, key, NULL))
        return;

    sats = g_key_file_get_integer_list(cfgdata, section, key, &length, &error);
    if (error != NULL)
    {
        sat_log_log(SAT_LOG_LEVEL_WARN,
                    _("%s: Failed to get integer list: %s"),
                    __func__, error->message);

        g_clear_error(&error);

        /* GLib API says nothing about the contents in case of error */
        if (sats)
        {
            g_free(sats);
        }

        return;
    }

    /* read each satellite into hash table */
    for (i = 0; i < length; i++)
    {
        tkey = g_new0(guint, 1);
        *tkey = sats[i];
        //printf("loading sat %d\n",sats[i]);
        if (!(g_hash_table_lookup_extended(dest, tkey, NULL, NULL)))
        {
            /* just add a one to the value so there is presence indicator */
            g_hash_table_insert(dest, tkey, NULL);
        }
    }
    g_free(sats);
}

/**
 * \brief Convert the "boolean" hash back into an integer list and 
 * save it to the cfgdata.
 */
void mod_cfg_set_integer_list_boolean(GKeyFile * cfgdata, GHashTable * hash,
                                      const gchar * cfgsection,
                                      const gchar * cfgkey)
{
    gint           *showtrack;
    gint           *something;
    gint            i, length;
    GList          *keys = g_hash_table_get_keys(hash);

    length = g_list_length(keys);
    if (g_list_length(keys) > 0)
    {
        showtrack = g_try_new0(gint, g_list_length(keys));
        for (i = 0; i < length; i++)
        {
            something = g_list_nth_data(keys, i);
            showtrack[i] = *something;
        }
        g_key_file_set_integer_list(cfgdata,
                                    cfgsection,
                                    cfgkey, showtrack, g_list_length(keys));
    }
    else
    {
        g_key_file_remove_key(cfgdata, cfgsection, cfgkey, NULL);
    }

    g_list_free(keys);
}