workbench/libs/codesetslib/developer/include/libraries/codesets.h

   1 #ifndef LIBRARIES_CODESETS_H
   2 #define LIBRARIES_CODESETS_H
   3
   4 /***************************************************************************
   5
   6  codesets.library - Amiga shared library for handling different codesets
   7  Copyright (C) 2001-2005 by Alfonso [alfie] Ranieri <alforan@tin.it>.
   8  Copyright (C) 2005-2008 by codesets.library Open Source Team
   9
  10  This library is free software; you can redistribute it and/or
  11  modify it under the terms of the GNU Lesser General Public
  12  License as published by the Free Software Foundation; either
  13  version 2.1 of the License, or (at your option) any later version.
  14
  15  This library is distributed in the hope that it will be useful,
  16  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  Lesser General Public License for more details.
  19
  20  codesets.library project: http://sourceforge.net/projects/codesetslib/
  21
  22  $Id$
  23
  24 ***************************************************************************/
  25
  26 #ifndef EXEC_SEMAPHORES_H
  27 #include <exec/semaphores.h>
  28 #endif
  29
  30 #ifndef UTILITY_TAGITEM_H
  31 #include <utility/tagitem.h>
  32 #endif
  33
  34 #ifndef UTILITY_HOOKS_H
  35 #include <utility/hooks.h>
  36 #endif
  37
  38 #ifdef __GNUC__
  39   #ifdef __PPC__
  40     #pragma pack(2)
  41   #endif
  42 #elif defined(__VBCC__)
  43   #pragma amiga-align
  44 #endif
  45
  46 /***********************************************************************/
  47 /*
  48 ** Actual library name and version.
  49 */
  50
  51 #define CODESETSNAME    "codesets.library"
  52 #define CODESETSVER     6
  53
  54 /***********************************************************************/
  55 /*
  56  * Types
  57  */
  58
  59 typedef unsigned long  UTF32;   /* at least 32 bits */
  60 typedef unsigned short UTF16;   /* at least 16 bits */
  61 typedef unsigned char  UTF8;    /* typically 8 bits */
  62
  63 /***********************************************************************/
  64 /*
  65  * single_convert
  66  */
  67
  68 struct single_convert
  69 {
  70   unsigned char code; /* the code in this representation */
  71   UTF8 utf8[8];       /* the utf8 string, first byte is alway the length of the string */
  72   unsigned int  ucs4; /* the full 32 bit unicode */
  73 };
  74
  75 /***********************************************************************/
  76 /*
  77  * codeset
  78  */
  79
  80 struct codeset
  81 {
  82   struct MinNode          node;
  83   char                    *name;
  84   char                    *alt_name;
  85   char                    *characterization;
  86   int                     read_only;
  87   struct single_convert   table[256];
  88   struct single_convert   table_sorted[256];
  89 };
  90
  91 /***********************************************************************/
  92 /*
  93  * codesetList
  94  */
  95
  96 struct codesetList
  97 {
  98   struct MinList list;
  99 };
 100
 101 /***********************************************************************/
 102
 103 enum
 104 {
 105   CSR_ConversionOK=0,  /* conversion successful */
 106   CSR_SourceExhausted, /* partial character in source, but hit end */
 107   CSR_TargetExhausted, /* insuff. room in target for conversion */
 108   CSR_SourceIllegal    /* source sequence is illegal/malformed */
 109 };
 110
 111 enum
 112 {
 113   CSF_StrictConversion=0,
 114   CSF_LenientConversion
 115 };
 116
 117 /***********************************************************************/
 118
 119 /*
 120 ** Enumerations for CSA_CodesetFamily
 121 */
 122 enum
 123 {
 124   CSV_CodesetFamily_Latin=0,   /* Latin Family */
 125   CSV_CodesetFamily_Cyrillic   /* Cyrillic Family */
 126 };
 127
 128 /***********************************************************************/
 129 /*
 130 ** Tags
 131 */
 132
 133 #define CODESETSLIB_TAG(n)     ((ULONG)0xfec901f4+(n))
 134
 135 #define CSA_Base                CODESETSLIB_TAG(0)
 136
 137 #define CSA_SourceLen           CODESETSLIB_TAG(1)
 138 #define CSA_Source              CODESETSLIB_TAG(2)
 139 #define CSA_Dest                CODESETSLIB_TAG(3)
 140 #define CSA_DestLen             CODESETSLIB_TAG(4)
 141 #define CSA_DestHook            CODESETSLIB_TAG(5)
 142 #define CSA_DestLenPtr          CODESETSLIB_TAG(6)
 143 #define CSA_SourceCodeset       CODESETSLIB_TAG(7)
 144 #define CSA_Pool                CODESETSLIB_TAG(8)
 145 #define CSA_PoolSem             CODESETSLIB_TAG(9)
 146 #define CSA_AllocIfNeeded       CODESETSLIB_TAG(10)
 147 #define CSA_Save                CODESETSLIB_TAG(11)
 148 #define CSA_FallbackToDefault   CODESETSLIB_TAG(12)
 149 #define CSA_DestCodeset         CODESETSLIB_TAG(13)
 150 #define CSA_CodesetDir          CODESETSLIB_TAG(14)
 151 #define CSA_CodesetFile         CODESETSLIB_TAG(15)
 152 #define CSA_CodesetList         CODESETSLIB_TAG(16)
 153 #define CSA_FreeCodesets        CODESETSLIB_TAG(17)
 154 #define CSA_CodesetFamily       CODESETSLIB_TAG(18)
 155 #define CSA_ErrPtr              CODESETSLIB_TAG(19)
 156
 157 #define CSA_B64SourceString     CODESETSLIB_TAG(20)
 158 #define CSA_B64SourceLen        CODESETSLIB_TAG(21)
 159 #define CSA_B64SourceFile       CODESETSLIB_TAG(22)
 160 #define CSA_B64DestPtr          CODESETSLIB_TAG(23)
 161 #define CSA_B64DestFile         CODESETSLIB_TAG(24)
 162 #define CSA_B64MaxLineLen       CODESETSLIB_TAG(25)
 163 #define CSA_B64Unix             CODESETSLIB_TAG(26)
 164 #define CSA_B64FLG_NtCheckErr   CODESETSLIB_TAG(27)
 165
 166 #define CSA_MapForeignChars     CODESETSLIB_TAG(28)
 167 #define CSA_MapForeignCharsHook CODESETSLIB_TAG(29)
 168
 169 /***********************************************************************/
 170 /*
 171 ** Returns code from CodesetsEncodeB64A() CodesetsDecodeB64A()
 172 */
 173
 174 enum
 175 {
 176   CSR_B64_ERROR_OK = 0,
 177   CSR_B64_ERROR_MEM,
 178   CSR_B64_ERROR_DOS,
 179   CSR_B64_ERROR_INCOMPLETE,
 180   CSR_B64_ERROR_ILLEGAL,
 181 };
 182
 183 /***********************************************************************/
 184
 185 struct convertMsg
 186 {
 187   ULONG state;
 188   ULONG len;
 189 };
 190
 191 enum
 192 {
 193   CSV_Translating,
 194   CSV_End,
 195 };
 196
 197 /***********************************************************************/
 198
 199 /*
 200 ** the message passed to a CSA_MapForeignCharsHook hook
 201 ** the hook function must return the length of the replacement string
 202 ** == 0 signals 'no replacement found'
 203 **  > 0 will use the supplied string directly
 204 **  < 0 signals an UTF8 replacement of negated length
 205 */
 206 struct replaceMsg
 207 {
 208   char **dst;          /* place the replace string here */
 209   unsigned char *src;  /* the source UTF8 string */
 210   int srclen;          /* length of the UTF8 sequence */
 211 };
 212
 213 /***********************************************************************/
 214
 215 #ifdef __GNUC__
 216   #ifdef __PPC__
 217     #pragma pack()
 218   #endif
 219 #elif defined(__VBCC__)
 220   #pragma default-align
 221 #endif
 222
 223 #endif /* LIBRARIES_CODESETS_H */