summaryrefslogtreecommitdiff
path: root/support/dktools/dk4enc.h
blob: cdeba4e9a17cf82118dde066344c7a8dd898e2da (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
/*
	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: dk4enc.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 DK4ENC_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4ENC_H_INCLUDED 1


#line 10 "dk4enc.ctr"

/**	@file
	File and memory encodings for characters.

	CRT on Windows: Optional, disabling CRT degrades performance.
*/

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

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

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



/**	Encodings for text files.
*/
enum {
				/**	ASCII character set.
				*/
  DK4_FILE_ENCODING_ASCII	=	0,

				/**	ANSII encoding (used ie on Windows).
				*/
  DK4_FILE_ENCODING_ANSI ,

				/**	UTF-8 encoding used on Linux and Unix.
				*/
  DK4_FILE_ENCODING_UTF8 ,

				/**	UTF-16 encoding, least significant
					byte first.
				*/
  DK4_FILE_ENCODING_UTF16_LE ,

				/**	UTF-16 encoding, most significant
					byte first.
				*/
  DK4_FILE_ENCODING_UTF16_BE ,

				/**	32-bit unicode characters, least
					significant byte first.
				*/
  DK4_FILE_ENCODING_32_LE ,

				/**	32-bit unicode characters, most
					significant byte first.
				*/
  DK4_FILE_ENCODING_32_BE
};

/**	Encoding for characters in memory.
*/
enum {
			/**	ASCII character set (0 to 255) in
				ISO-LATIN-8859-1.
			*/
  DK4_ENCODING_ASCII	=	DK4_FILE_ENCODING_ASCII,

			/**	ANSII encoding (used ie on Windows).
			*/
  DK4_ENCODING_ANSI	=	DK4_FILE_ENCODING_ANSI,

			/**	UTF-8 encoding used on Linux and Unix.
			*/
  DK4_ENCODING_UTF8	=	DK4_FILE_ENCODING_UTF8,

#if DK4_WORDS_BIGENDIAN

			/**	UTF-16 encoding.
			*/
  DK4_ENCODING_UTF16	=	DK4_FILE_ENCODING_UTF16_BE,

			/**	32-bit unicode characters.
			*/
  DK4_ENCODING_32	=	DK4_FILE_ENCODING_32_BE

#else

			/**	UTF-16 encoding.
			*/
  DK4_ENCODING_UTF16	=	DK4_FILE_ENCODING_UTF16_LE,

			/**	32-bit unicode characters.
  			*/
  DK4_ENCODING_32	=	DK4_FILE_ENCODING_32_LE

#endif
};



#ifdef __cplusplus
extern "C" {
#endif

/**	Find encoding by name.
	@param	encptr	Pointer to result variable for encoding.
	@param	bomptr	Pointer to result variable for BOM writing.
	@param	src	Source text containing encoding name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if encptr or src is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the text is too long to create a local copy for modification, or
	- DK4_E_SYNTAX<br>
	  if invalid encoding, options or encoding/option combinations are
	  specified.
*/
int
dk4enc_find(int *encptr, int *bomptr, const dkChar *src, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif




#endif