summaryrefslogtreecommitdiff
path: root/support/dktools/dk4wxpref.h
blob: 4f777ee7c92af59e18d1ce2c9e79e12689e0f2b0 (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
	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: dk4wxpref.cpt
*/

/*
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 DK4WXPREF_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4WXPREF_H_INCLUDED 1


#line 10 "dk4wxpref.cpt"

/**	@file	dk4wxpref.h	Preferences as wxChar strings.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

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

#ifndef DK4CONST_H_INCLUDED
#include "dk4const.h"
#endif

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

#ifndef DK4STO_H_INCLUDED
#include "dk4sto.h"
#endif

#ifndef DK4STRM_H_INCLUDED
#include "dk4strm.h"
#endif

#ifndef DK4STRMR_H_INCLUDED
#include "dk4strmr.h"
#endif


#ifndef	WX_WXPREC_H_INCLUDED
#include <wx/wxprec.h>
#define	WX_WXPREC_H_INCLUDED 1
#endif
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#if	DK4_HAVE_WX_CHARTYPE_H
#ifndef	WX_CHARTYPE_H_INCLUDED
#include <wx/chartype.h>
#define	WX_CHARTYPE_H_INCLUDED 1
#endif
#else
#if	DK4_HAVE_WX_WXCHAR_H
#ifndef	WX_WXCHAR_H_INCLUDED
#include <wx/wxchar.h>
#define	WX_WXCHAR_H_INCLUDED 1
#endif
#else
#ifndef	WX_WX_H_INCLUDED
#include <wx/wx.h>
#define	WX_WX_H_INCLUDED
#endif
#endif
#endif
#endif


/**	Preferences data.
*/
typedef struct {
  wxChar	*name;	/**< Name. */
  wxChar	*value;	/**< Value. */
} dk4_wx_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.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if name or value is NULL,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if a memory allocation failed due to insufficient memory.
*/
dk4_wx_pref_t *
dk4wxpref_open(const wxChar *name, const wxChar *value, dk4_er_t *erp);

/**	Destroy preference structure, release memory.
	@param	ptr	Preference structure to destroy.
*/
void
dk4wxpref_close(dk4_wx_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
dk4wxpref_compare(const void *l, const void *r, int cr);

/**	Add dk4pref.conf file for one pass.
	@param	spref		Preferences storage.
	@param	ipref		Iterator for preferences storage.
	@param	nameApp		Application name.
	@param	nameGrp		Application group name.
	@param	nameLog		Users login name.
	@param	nameHost	Host name.
	@param	language	Language.
	@param	region		Region.
	@param	dirHome		Users home directory.
	@param	dirEtc		System configuration directory.
	@param	dirShare	Data file directory.
	@param	encWx		Encoding for wxChar strings.
	@param	encDk		Encoding for dkChar strings.
	@param	encFile		Expected encoding for files.
	@param	pn		Pass number.
*/
void
dk4wxpref_one_pass(
  dk4_sto_t		*spref,
  dk4_sto_it_t		*ipref,
  const dkChar		*nameApp,
  const dkChar		*nameGrp,
  const	dkChar		*nameLog,
  const dkChar		*nameHost,
  const dkChar		*language,
  const dkChar		*region,
  const dkChar		*dirHome,
  const dkChar		*dirEtc,
  const dkChar		*dirShare,
  int			 encWx,
  int			 encDk,
  int			 encFile,
  int			 pn
);

#ifdef __cplusplus
}
#endif




#endif