/
config.h
115 lines (98 loc) · 3.22 KB
/
config.h
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
/*
* Copyright (C) 2012 Sistemas Operativos - UTN FRBA. All rights reserved.
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef CONFIG_H_
#define CONFIG_H_
#include "collections/dictionary.h"
typedef struct {
char *path;
t_dictionary *properties;
} t_config;
/**
* @fn config_create
* @brief Crea una estructura t_config
*
* @param path Ruta hacia el archivo de configuracion
* @return Retorna un puntero hacia la estructura creada, o NULL
* en caso de no encontrar el archivo en el path especificado.
*/
t_config *config_create(char *path);
/**
* @fn config_has_property
* @brief Retorna true si key se encuentra en la configuracion.
*/
bool config_has_property(t_config*, char* key);
/**
* @fn config_get_string_value
* @brief Retorna un string con el valor asociado a key.
*/
char *config_get_string_value(t_config*, char *key);
/**
* @fn config_get_int_value
* @brief Retorna un int con el valor asociado a key.
*/
int config_get_int_value(t_config*, char *key);
/**
* @fn config_get_long_value
* @brief Retorna un long con el valor asociado a key.
*/
long config_get_long_value(t_config*, char *key);
/**
* @fn config_get_double_value
* @brief Retorna un double con el valor asociado a key.
*/
double config_get_double_value(t_config*, char *key);
/**
* @fn config_get_array_value
* @brief Retorna un array con los valores asociados a la key especificada.
*
* @note En el archivo de configuracion un valor de este tipo debería ser representado
* de la siguiente forma [lista_valores_separados_por_coma]
*
* @example VALORES=[1,2,3,4,5]
* @note El array que devuelve termina en NULL
*/
char** config_get_array_value(t_config*, char* key);
/**
* @fn config_key_amount
* @brief Retorna la cantidad de keys.
*/
int config_keys_amount(t_config*);
/**
* @fn config_destroy
* @brief Destruye la estructura config.
*/
void config_destroy(t_config *config);
/**
* @fn config_set_value
* @brief Setea el valor en el archivo de config, a la key asociada.
*/
void config_set_value(t_config*, char *key, char *value);
/**
* @fn config_remove_key
* @brief Remueve la clave y su valor asociado del archivo de config.
*/
void config_remove_key(t_config*, char *key);
/**
* @fn config_save
* @brief Reescribe el archivo de configuracion con los valores del config.
*/
int config_save(t_config*);
/**
* @fn config_save_in_file
* @brief Escribe un archivo de configuracion en el path indicado con los valores del config.
*/
int config_save_in_file(t_config*, char *path);
#endif /* CONFIG_H_ */