aboutsummaryrefslogtreecommitdiff
path: root/src/include/ipxe/params.h
blob: d78adf562ece9402f41f2aee659b9158a864cb7f (plain)
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
#ifndef _IPXE_PARAMS_H
#define _IPXE_PARAMS_H

/** @file
 *
 * Form parameters
 *
 */

FILE_LICENCE ( GPL2_OR_LATER );

#include <ipxe/list.h>
#include <ipxe/refcnt.h>

/** A form parameter list */
struct parameters {
	/** List of all parameter lists */
	struct list_head list;
	/** Name */
	const char *name;
	/** Parameters */
	struct list_head entries;
};

/** A form parameter */
struct parameter {
	/** List of form parameters */
	struct list_head list;
	/** Key */
	const char *key;
	/** Value */
	const char *value;
};

/** Iterate over all form parameters in a list */
#define for_each_param( param, params )				\
	list_for_each_entry ( (param), &(params)->entries, list )

extern struct parameters * find_parameters ( const char *name );
extern struct parameters * create_parameters ( const char *name );
extern struct parameter * add_parameter ( struct parameters *params,
					  const char *key, const char *value );
extern void destroy_parameters ( struct parameters *params );
extern void claim_parameters ( struct parameters *params );

#endif /* _IPXE_PARAMS_H */