r24780: More work allowing libutil to be used by external users.
[kai/samba.git] / source4 / lib / charset / charset.h
1 /* 
2    Unix SMB/CIFS implementation.
3    charset defines
4    Copyright (C) Andrew Tridgell 2001
5    Copyright (C) Jelmer Vernooij 2002
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef __CHARSET_H__
22 #define __CHARSET_H__
23
24 #include "lib/talloc/talloc.h"
25
26 /* this defines the charset types used in samba */
27 typedef enum {CH_UTF16=0, CH_UNIX=1, CH_DISPLAY=2, CH_DOS=3, CH_UTF8=4, CH_UTF16BE=5} charset_t;
28
29 #define NUM_CHARSETS 6
30
31 /*
32  *   for each charset we have a function that pulls from that charset to
33  *     a ucs2 buffer, and a function that pushes to a ucs2 buffer
34  *     */
35
36 struct charset_functions {
37         const char *name;
38         size_t (*pull)(void *, const char **inbuf, size_t *inbytesleft,
39                                    char **outbuf, size_t *outbytesleft);
40         size_t (*push)(void *, const char **inbuf, size_t *inbytesleft,
41                                    char **outbuf, size_t *outbytesleft);
42         struct charset_functions *prev, *next;
43 };
44
45 /* this type is used for manipulating unicode codepoints */
46 typedef uint32_t codepoint_t;
47
48 #define INVALID_CODEPOINT ((codepoint_t)-1)
49
50
51 /* generic iconv conversion structure */
52 typedef struct {
53         size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
54                          char **outbuf, size_t *outbytesleft);
55         size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
56                        char **outbuf, size_t *outbytesleft);
57         size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
58                        char **outbuf, size_t *outbytesleft);
59         void *cd_direct, *cd_pull, *cd_push;
60 } *smb_iconv_t;
61
62 /* string manipulation flags */
63 #define STR_TERMINATE 1
64 #define STR_UPPER 2
65 #define STR_ASCII 4
66 #define STR_UNICODE 8
67 #define STR_NOALIGN 16
68 #define STR_NO_RANGE_CHECK 32
69 #define STR_LEN8BIT 64
70 #define STR_TERMINATE_ASCII 128 /* only terminate if ascii */
71 #define STR_LEN_NOTERM 256 /* the length field is the unterminated length */
72
73 #include "lib/charset/charset_proto.h"
74
75 /* replace some string functions with multi-byte
76    versions */
77 #define strlower(s) strlower_m(s)
78 #define strupper(s) strupper_m(s)
79
80 /* from lib/charset */
81 extern char *dos_charset;
82 extern char *unix_charset;
83 extern char *display_charset;
84
85 #endif /* __CHARSET_H__ */