summaryrefslogtreecommitdiff
path: root/support/dktools/dk4enc.h
blob: 2c091f7cec940a2cfa260c3ccf56037f8620a4f2 (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
/*
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: dk4enc.ctr
*/

#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
#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



/**	Encodings for text files.
*/
enum {
				/**	Bytes 0x00 to 0xff represent
					U+0000 to U+00FF.
					Formerly misleading named "ASCII".
				*/
  DK4_FILE_ENCODING_PLAIN	=	0,

				/**	Encoding used in Windows GUI programs.
				*/
  DK4_FILE_ENCODING_WIN1252 ,

				/**	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 {
			/**	Bytes 0x00 to 0xFF represent U+0000 to U+00FF.
			*/
  DK4_ENCODING_PLAIN	=	DK4_FILE_ENCODING_PLAIN,

			/**	Encoding used by Windows GUI programs.
			*/
  DK4_ENCODING_WIN1252	=	DK4_FILE_ENCODING_WIN1252,

			/**	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