summaryrefslogtreecommitdiff
path: root/support/dktools/dk4pref.h
blob: 741ae9c080641103fc4f1eef8e98d3c6c67ffcdf (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
/*
	WARNING: This file was generated by dkct.
	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
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#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
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef	DK4STR8_H_INCLUDED
#include "dk4str8.h"
#endif

#ifndef	DK4STRW_H_INCLUDED
#include "dk4strw.h"
#endif

#ifndef DK4STRD_H_INCLUDED
#include "dk4strd.h"
#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