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 2 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, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 /* this defines the charset types used in samba */
  23 typedef enum {CH_UTF16=0, CH_UNIX=1, CH_DISPLAY=2, CH_DOS=3, CH_UTF8=4, CH_UTF16BE=5} charset_t;
  24
  25 #define NUM_CHARSETS 6
  26
  27 /*
  28  *   for each charset we have a function that pulls from that charset to
  29  *     a ucs2 buffer, and a function that pushes to a ucs2 buffer
  30  *     */
  31
  32 struct charset_functions {
  33         const char *name;
  34         size_t (*pull)(void *, const char **inbuf, size_t *inbytesleft,
  35                                    char **outbuf, size_t *outbytesleft);
  36         size_t (*push)(void *, const char **inbuf, size_t *inbytesleft,
  37                                    char **outbuf, size_t *outbytesleft);
  38         struct charset_functions *prev, *next;
  39 };
  40
  41 /* this type is used for manipulating unicode codepoints */
  42 typedef uint32_t codepoint_t;
  43
  44 #define INVALID_CODEPOINT ((codepoint_t)-1)
  45
  46
  47 /* generic iconv conversion structure */
  48 typedef struct {
  49         size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
  50                          char **outbuf, size_t *outbytesleft);
  51         size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
  52                        char **outbuf, size_t *outbytesleft);
  53         size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
  54                        char **outbuf, size_t *outbytesleft);
  55         void *cd_direct, *cd_pull, *cd_push;
  56 } *smb_iconv_t;
  57
  58 /* string manipulation flags */
  59 #define STR_TERMINATE 1
  60 #define STR_UPPER 2
  61 #define STR_ASCII 4
  62 #define STR_UNICODE 8
  63 #define STR_NOALIGN 16
  64 #define STR_NO_RANGE_CHECK 32
  65 #define STR_LEN8BIT 64
  66 #define STR_TERMINATE_ASCII 128 /* only terminate if ascii */
  67 #define STR_LEN_NOTERM 256 /* the length field is the unterminated length */
  68
  69 #include "lib/charset/charset_proto.h"