summaryrefslogtreecommitdiff
path: root/support/dktools/dk4pref.h
blob: 990034f6fa3180c20f6dd43280ce019987bc18db (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
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
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4pref.ctr
*/

#ifndef DK4PREF_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4PREF_H_INCLUDED 1


#line 10 "dk4pref.ctr"

/**	@file
	Preferences as key/value pairs; the module contains functions
	to create and destroy a preference structure and to compare
	preference structures by name or against a given name.

	Typically preferences are stored in a dk4_sto_t structure.

	CRT on Windows: Optional.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#ifndef	DK4STR8_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4str8.h"
#else
#include <dktools-4/dk4str8.h>
#endif
#endif

#ifndef	DK4STRW_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4strw.h"
#else
#include <dktools-4/dk4strw.h>
#endif
#endif

#ifndef DK4STRD_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4strd.h"
#else
#include <dktools-4/dk4strd.h>
#endif
#endif



/**	Preferences storage.
*/
typedef struct {
  dkChar	*name;	/**< Preference name. */
  dkChar	*value;	/**< Value. */
} dk4_pref_t;



#ifdef __cplusplus
extern "C" {
#endif

/**	Create preferences structure, allocate memory.
	@param	name	Preference name.
	@param	value	Preference value.
	@param	erp	Error report, may be NULL.
	@return	Pointer to new preferences object on success, NULL on error.
*/
dk4_pref_t *
dk4pref_open(dkChar const *name, dkChar const *value, dk4_er_t *erp);

/**	Destroy preference structure, release memory.
	@param	ptr	Preference structure to destroy.
*/
void
dk4pref_close(dk4_pref_t *ptr);

/**	Comparison function.
	@param	l	Left pointer.
	@param	r	Right pointer.
	@param	cr	Comparison criteria:
			0=structure/structure,
			1=structure/name.
	@return	Comparison result.
*/
int
dk4pref_compare(const void *l, const void *r, int cr);

#ifdef __cplusplus
}
#endif




#endif