2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_env_lib.h
23 * @brief Library providing operations for the @e environment of
24 * PSYC and Social messages, and for (de)serializing variable values.
25 * @author Gabor X Toth
29 #ifndef GNUNET_ENV_LIB_H
30 #define GNUNET_ENV_LIB_H
35 #if 0 /* keep Emacsens' auto-indent happy */
42 * Possible operations on PSYC state (persistent) and transient variables (per message).
44 enum GNUNET_ENV_Operator
47 * Set value of a transient variable.
49 GNUNET_ENV_OP_SET = ':',
52 * Assign value for a persistent state variable.
54 * If an assigned value is NULL, the variable is deleted.
56 GNUNET_ENV_OP_ASSIGN = '=',
59 * Augment state variable.
61 * Used for appending strings, adding numbers, and adding new items to a list or dictionary.
63 GNUNET_ENV_OP_AUGMENT = '+',
66 * Diminish state variable.
68 * Used for subtracting numbers, and removing items from a list or dictionary.
70 GNUNET_ENV_OP_DIMINISH = '-',
73 * Update state variable.
75 * Used for modifying a single item of a list or dictionary.
77 GNUNET_ENV_OP_UPDATE = '@',
82 * PSYC variable types.
86 GNUNET_ENV_TYPE_DATA = 0,
87 GNUNET_ENV_TYPE_NUMBER,
94 * PSYC state modifier.
96 struct GNUNET_ENV_Modifier {
100 enum GNUNET_ENV_Operator oper;
120 * Environment for a message.
122 * Contains modifiers.
124 struct GNUNET_ENV_Environment;
128 * Create an environment.
130 * @return A newly allocated environment.
132 struct GNUNET_ENV_Environment *
133 GNUNET_ENV_environment_create ();
137 * Add an operation on a variable to the environment.
139 * @param env The environment.
140 * @param oper Operation to perform.
141 * @param name Name of the variable.
142 * @param value_size Size of @a value.
143 * @param value Value of the variable.
145 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error.
148 GNUNET_ENV_environment_operation (struct GNUNET_ENV_Environment *env,
149 enum GNUNET_ENV_Operator oper,
151 size_t value_size, const void *value);
155 * Get all modifiers in the environment.
157 * FIXME: use an iterator instead, as we'll likely use a SList to store the
158 * modifiers in the environment.
160 * @param env The environment.
161 * @param[out] modifier_count Set to the number of returned modifiers.
163 * @return Array of modifiers.
165 const struct GNUNET_ENV_Modifier *
166 GNUNET_ENV_environment_get_modifiers (const struct GNUNET_ENV_Environment *env,
167 size_t *modifier_count);
171 * Add list of modifiers to the environment.
173 * @param env The environment.
174 * @param modifier_count Number of @a modifiers.
175 * @param modifiers Array of modifiers to add.
177 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error.
180 GNUNET_ENV_environment_set_modifiers (const struct GNUNET_ENV_Environment *env,
181 size_t modifier_count,
182 const struct GNUNET_ENV_Modifier *modifiers);
186 * Destroy an environment.
188 * @param env The environment to destroy.
191 GNUNET_ENV_environment_destroy (struct GNUNET_ENV_Environment *env);
195 * Get the type of variable.
197 * @param name Name of the variable.
199 * @return Variable type.
202 GNUNET_ENV_var_get_type (char *name);
206 * Perform an operation on a variable.
208 * @param name Name of variable.
209 * @param current_value Current value of variable.
210 * @param current_value_size Size of @a current_value.
211 * @param oper Operator.
212 * @param args Arguments for the operation.
213 * @param args_size Size of @a args.
214 * @param return_value Return value.
215 * @param return_value_size Size of @a return_value.
217 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
220 GNUNET_ENV_operation (char *name, void *current_value, size_t current_value_size,
221 enum GNUNET_ENV_Operator oper, void *args, size_t args_size,
222 void **return_value, size_t *return_value_size);
226 * Get the variable's value as an integer.
228 * @param size Size of value.
229 * @param value Raw value of variable.
230 * @param[out] number Value converted to a 64-bit integer.
232 * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. the value is invalid).
235 GNUNET_ENV_value_to_number (size_t size, const void *value, int64_t *number);
239 * Get the variable's value as a list.
241 * @param size Size of value.
242 * @param value Raw value of variable.
243 * @param[out] list A newly created list holding the elements.
245 * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. the value is invalid).
248 GNUNET_ENV_value_to_list (size_t size, const void *value, struct GNUNET_CONTAINER_SList **list);
252 * Get the variable's value as a dictionary.
254 * @param size Size of value.
255 * @param value Raw value of variable.
256 * @param[out] dict A newly created hashmap holding the elements of the dictionary.
258 * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. the value is invalid).
261 GNUNET_ENV_value_to_dict (size_t size, const void *value, struct GNUNET_CONTAINER_MultiHashMap **dict);
265 * Create a PSYC variable value from an integer.
267 * @param number The number to convert.
268 * @param[out] value_size Size of returned value.
270 * @return A newly allocated value or NULL on error.
273 GNUNET_ENV_value_from_number (int64_t number, size_t *value_size);
277 * Create a PSYC variable value from a list.
279 * @param list The list to convert.
280 * @param[out] value_size Size of returned value.
282 * @return A newly allocated value or NULL on error.
285 GNUNET_ENV_value_from_list (struct GNUNET_CONTAINER_SList *list, size_t *value_size);
289 * Create a PSYC variable value from a dictionary.
291 * @param dict The dict to convert.
292 * @param[out] value_size Size of returned value.
294 * @return A newly allocated value or NULL on error.
297 GNUNET_ENV_value_from_dict (struct GNUNET_CONTAINER_MultiHashMap *dict, size_t *value_size);
300 #if 0 /* keep Emacsens' auto-indent happy */
307 /* ifndef GNUNET_ENV_LIB_H */
309 /* end of gnunet_env_lib.h */