summaryrefslogtreecommitdiff
path: root/support/dktools/dk3se.h
blob: 818fbf3ebdbe0ce7b41769c8a186db6e07f879b9 (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
/*
Copyright (C) 2013-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: dk3se.ctr
*/

/**	@file dk3se.h Header file for the dk3se module.
*/

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


#line 9 "dk3se.ctr"

#include <dk3conf.h>
#include <dk3types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**	Write ANSI character or check ANSI compatibility.
	@param	c32	Character to write or check.
	@param	fipo	File to write to (NULL for check).
	@return	1 on success, 0 on error (No representation for this
	character in ANSI encoding).
*/
int
dk3se_ansi_fputc(dk3_c32_t c32, FILE *fipo);

/**	Write URL character or check URL compatibility.
	@param	c32	Character to write or check.
	@param	fipo	File to write to (NULL for check).
	@return	1 on success, 0 on error.
*/
int
dk3se_url_fputc(dk3_c32_t c32, FILE *fipo);

/**	Convert to ANSI and write URL character or check URL compatibility.
	@param	c32	Character to write or check.
	@param	fipo	File to write to (NULL for check).
	@return	1 on success, 0 on error.
*/
int
dk3se_ansi_url_fputc(dk3_c32_t c32, FILE *fipo);

/**	Write ANSI string or check ANSI compatibility.
	@param	str	String to write.
	@param	enc	String encoding.
	@param	fipo	File to write to (NULL for compatibility check).
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3se_ansi_fputs(dkChar const *str, int enc, FILE *fipo, dk3_app_t *app);

/**	Write URL string or check URL compatibility.
	@param	str	String to write.
	@param	enc	String encoding.
	@param	fipo	File to write to (NULL for compatibility check).
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3se_url_fputs(dkChar const *str, int enc, FILE *fipo, dk3_app_t *app);

/**	Convert to ANSI and write URL string or check URL compatibility.
	@param	str	String to write.
	@param	enc	String encoding.
	@param	fipo	File to write to (NULL for compatibility check).
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3se_ansi_url_fputs(dkChar const *str, int enc, FILE *fipo, dk3_app_t *app);

/**	Check whether a string can be converted to ANSI or URL.
	@param	str	String to test.
	@param	enc	String encoding.
	@param	se	Output encoding (DK3SE_ANSI and/or DK3SE_URL).
	@param	ev	Pointer to encoding violation variable.
	@param	we	Pointer to write error variable.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3se_check(dkChar const *str,int enc,int se,int *ev,int *we,dk3_app_t *app);

#ifdef __cplusplus
}
#endif

/**	ANSI encoding.
*/
#define	DK3SE_ANSI	1

/**	URL encoding.
*/
#define	DK3SE_URL	2


#endif