source/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 #ifndef __CHARSET_H__
  23 #define __CHARSET_H__
  24
  25 #include "lib/talloc/talloc.h"
  26
  27 /* this defines the charset types used in samba */
  28 typedef enum {CH_UTF16=0, CH_UNIX=1, CH_DISPLAY=2, CH_DOS=3, CH_UTF8=4, CH_UTF16BE=5} charset_t;
  29
  30 #define NUM_CHARSETS 6
  31
  32 /*
  33  *   for each charset we have a function that pulls from that charset to
  34  *     a ucs2 buffer, and a function that pushes to a ucs2 buffer
  35  *     */
  36
  37 struct charset_functions {
  38         const char *name;
  39         size_t (*pull)(void *, const char **inbuf, size_t *inbytesleft,
  40                                    char **outbuf, size_t *outbytesleft);
  41         size_t (*push)(void *, const char **inbuf, size_t *inbytesleft,
  42                                    char **outbuf, size_t *outbytesleft);
  43         struct charset_functions *prev, *next;
  44 };
  45
  46 /* this type is used for manipulating unicode codepoints */
  47 typedef uint32_t codepoint_t;
  48
  49 #define INVALID_CODEPOINT ((codepoint_t)-1)
  50
  51
  52 /* generic iconv conversion structure */
  53 typedef struct {
  54         size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
  55                          char **outbuf, size_t *outbytesleft);
  56         size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
  57                        char **outbuf, size_t *outbytesleft);
  58         size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
  59                        char **outbuf, size_t *outbytesleft);
  60         void *cd_direct, *cd_pull, *cd_push;
  61 } *smb_iconv_t;
  62
  63 /* string manipulation flags */
  64 #define STR_TERMINATE 1
  65 #define STR_UPPER 2
  66 #define STR_ASCII 4
  67 #define STR_UNICODE 8
  68 #define STR_NOALIGN 16
  69 #define STR_NO_RANGE_CHECK 32
  70 #define STR_LEN8BIT 64
  71 #define STR_TERMINATE_ASCII 128 /* only terminate if ascii */
  72 #define STR_LEN_NOTERM 256 /* the length field is the unterminated length */
  73
  74 #include "lib/charset/charset_proto.h"
  75
  76 /* replace some string functions with multi-byte
  77    versions */
  78 #define strlower(s) strlower_m(s)
  79 #define strupper(s) strupper_m(s)
  80
  81 #endif /* __CHARSET_H__ */