iconv/skeleton.c

   1 /* Skeleton for a conversion module.
   2    Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Library General Public License as
   8    published by the Free Software Foundation; either version 2 of the
   9    License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Library General Public License for more details.
  15
  16    You should have received a copy of the GNU Library General Public
  17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 /* This file can be included to provide definitions of several things
  22    many modules have in common.  It can be customized using the following
  23    macros:
  24
  25      DEFINE_INIT        define the default initializer.  This requires the
  26                         following symbol to be defined.
  27
  28      CHARSET_NAME       string with official name of the coded character
  29                         set (in all-caps)
  30
  31      DEFINE_FINI        define the default destructor function.
  32
  33      MIN_NEEDED_FROM    minimal number of bytes needed for the from-charset.
  34      MIN_NEEDED_TO      likewise for the to-charset.
  35
  36      MAX_NEEDED_FROM    maximal number of bytes needed for the from-charset.
  37                         This macro is optional, it defaults to MIN_NEEDED_FROM.
  38      MAX_NEEDED_TO      likewise for the to-charset.
  39
  40      DEFINE_DIRECTION_OBJECTS
  41                         two objects will be defined to be used when the
  42                         `gconv' function must only distinguish two
  43                         directions.  This is implied by DEFINE_INIT.
  44                         If this macro is not defined the following
  45                         macro must be available.
  46
  47      FROM_DIRECTION     this macro is supposed to return a value != 0
  48                         if we convert from the current character set,
  49                         otherwise it return 0.
  50
  51      EMIT_SHIFT_TO_INIT this symbol is optional.  If it is defined it
  52                         defines some code which writes out a sequence
  53                         of characters which bring the current state into
  54                         the initial state.
  55
  56      FROM_LOOP          name of the function implementing the conversion
  57                         from the current characters.
  58      TO_LOOP            likewise for the other direction
  59
  60      RESET_STATE        in case of an error we must reset the state for
  61                         the rerun so this macro must be defined for
  62                         stateful encodings.  It takes an argument which
  63                         is nonzero when saving.
  64
  65      RESET_INPUT_BUFFER If the input character sets allow this the macro
  66                         can be defined to reset the input buffer pointers
  67                         to cover only those characters up to the error.
  68
  69      FUNCTION_NAME      if not set the conversion function is named `gconv'.
  70
  71      PREPARE_LOOP       optional code preparing the conversion loop.  Can
  72                         contain variable definitions.
  73      END_LOOP           also optional, may be used to store information
  74
  75      EXTRA_LOOP_ARGS    optional macro specifying extra arguments passed
  76                         to loop function.
  77  */
  78
  79 #include <assert.h>
  80 #include <gconv.h>
  81 #include <string.h>
  82 #define __need_size_t
  83 #define __need_NULL
  84 #include <stddef.h>
  85
  86 #ifndef STATIC_GCONV
  87 # include <dlfcn.h>
  88 #endif
  89
  90 #ifndef DL_CALL_FCT
  91 # define DL_CALL_FCT(fct, args) fct args
  92 #endif
  93
  94 /* The direction objects.  */
  95 #if DEFINE_DIRECTION_OBJECTS || DEFINE_INIT
  96 static int from_object;
  97 static int to_object;
  98
  99 # ifndef FROM_DIRECTION
 100 #  define FROM_DIRECTION (step->__data == &from_object)
 101 # endif
 102 #else
 103 # ifndef FROM_DIRECTION
 104 #  error "FROM_DIRECTION must be provided if direction objects are not used"
 105 # endif
 106 #endif
 107
 108
 109 /* How many bytes are needed at most for the from-charset.  */
 110 #ifndef MAX_NEEDED_FROM
 111 # define MAX_NEEDED_FROM        MIN_NEEDED_FROM
 112 #endif
 113
 114 /* Same for the to-charset.  */
 115 #ifndef MAX_NEEDED_TO
 116 # define MAX_NEEDED_TO          MIN_NEEDED_TO
 117 #endif
 118
 119
 120 /* Define macros which can access unaligned buffers.  These macros are
 121    supposed to be used only in code outside the inner loops.  For the inner
 122    loops we have other definitions which allow optimized access.  */
 123 #ifdef _STRING_ARCH_unaligned
 124 /* We can handle unaligned memory access.  */
 125 # define get16u(addr) *((uint16_t *) (addr))
 126 # define get32u(addr) *((uint32_t *) (addr))
 127
 128 /* We need no special support for writing values either.  */
 129 # define put16u(addr, val) *((uint16_t *) (addr)) = (val)
 130 # define put32u(addr, val) *((uint32_t *) (addr)) = (val)
 131 #else
 132 /* Distinguish between big endian and little endian.  */
 133 # if __BYTE_ORDER == __LITTLE_ENDIAN
 134 #  define get16u(addr) \
 135      (((__const unsigned char *) (addr))[1] << 8                              \
 136       | ((__const unsigned char *) (addr))[0])
 137 #  define get32u(addr) \
 138      (((((__const unsigned char *) (addr))[3] << 8                            \
 139         | ((__const unsigned char *) (addr))[2]) << 8                         \
 140        | ((__const unsigned char *) (addr))[1]) << 8                          \
 141       | ((__const unsigned char *) (addr))[0])
 142
 143 #  define put16u(addr, val) \
 144      ({ uint16_t __val = (val);                                               \
 145         ((unsigned char *) (addr))[0] = __val;                                \
 146         ((unsigned char *) (addr))[1] = __val >> 8;                           \
 147         (void) 0; })
 148 #  define put32u(addr, val) \
 149      ({ uint32_t __val = (val);                                               \
 150         ((unsigned char *) (addr))[0] = __val;                                \
 151         __val >>= 8;                                                          \
 152         ((unsigned char *) (addr))[1] = __val;                                \
 153         __val >>= 8;                                                          \
 154         ((unsigned char *) (addr))[2] = __val;                                \
 155         __val >>= 8;                                                          \
 156         ((unsigned char *) (addr))[3] = __val;                                \
 157         (void) 0; })
 158 # else
 159 #  define get16u(addr) \
 160      (((__const unsigned char *) (addr))[0] << 8                              \
 161       | ((__const unsigned char *) (addr))[1])
 162 #  define get32u(addr) \
 163      (((((__const unsigned char *) (addr))[0] << 8                            \
 164         | ((__const unsigned char *) (addr))[1]) << 8                         \
 165        | ((__const unsigned char *) (addr))[2]) << 8                          \
 166       | ((__const unsigned char *) (addr))[3])
 167
 168 #  define put16u(addr, val) \
 169      ({ uint16_t __val = (val);                                               \
 170         ((unsigned char *) (addr))[1] = __val;                                \
 171         ((unsigned char *) (addr))[2] = __val >> 8;                           \
 172         (void) 0; })
 173 #  define put32u(addr, val) \
 174      ({ uint32_t __val = (val);                                               \
 175         ((unsigned char *) (addr))[3] = __val;                                \
 176         __val >>= 8;                                                          \
 177         ((unsigned char *) (addr))[2] = __val;                                \
 178         __val >>= 8;                                                          \
 179         ((unsigned char *) (addr))[1] = __val;                                \
 180         __val >>= 8;                                                          \
 181         ((unsigned char *) (addr))[0] = __val;                                \
 182         (void) 0; })
 183 # endif
 184 #endif
 185
 186
 187 /* For conversions from a fixed width character sets to another fixed width
 188    character set we we can define RESET_INPUT_BUFFER is necessary.  */
 189 #if !defined RESET_INPUT_BUFFER && !defined SAVE_RESET_STATE
 190 # if MIN_NEEDED_FROM == MAX_NEEDED_FROM && MIN_NEEDED_TO == MAX_NEEDED_TO
 191 /* We have to use these `if's here since the compiler cannot know that
 192    (outbuf - outerr) is always divisible by MIN_NEEDED_TO.  */
 193 #  define RESET_INPUT_BUFFER \
 194   if (MIN_NEEDED_FROM % MIN_NEEDED_TO == 0)                                   \
 195     *inbuf -= (outbuf - outerr) * (MIN_NEEDED_FROM / MIN_NEEDED_TO);          \
 196   else if (MIN_NEEDED_TO % MIN_NEEDED_FROM == 0)                              \
 197     *inbuf -= (outbuf - outerr) / (MIN_NEEDED_TO / MIN_NEEDED_FROM);          \
 198   else                                                                        \
 199     *inbuf -= ((outbuf - outerr) / MIN_NEEDED_TO) * MIN_NEEDED_FROM
 200 # endif
 201 #endif
 202
 203
 204 /* The default init function.  It simply matches the name and initializes
 205    the step data to point to one of the objects above.  */
 206 #if DEFINE_INIT
 207 # ifndef CHARSET_NAME
 208 #  error "CHARSET_NAME not defined"
 209 # endif
 210
 211 int
 212 gconv_init (struct __gconv_step *step)
 213 {
 214   /* Determine which direction.  */
 215   if (strcmp (step->__from_name, CHARSET_NAME) == 0)
 216     {
 217       step->__data = &from_object;
 218
 219       step->__min_needed_from = MIN_NEEDED_FROM;
 220       step->__max_needed_from = MAX_NEEDED_FROM;
 221       step->__min_needed_to = MIN_NEEDED_TO;
 222       step->__max_needed_to = MAX_NEEDED_TO;
 223     }
 224   else if (strcmp (step->__to_name, CHARSET_NAME) == 0)
 225     {
 226       step->__data = &to_object;
 227
 228       step->__min_needed_from = MIN_NEEDED_TO;
 229       step->__max_needed_from = MAX_NEEDED_TO;
 230       step->__min_needed_to = MIN_NEEDED_FROM;
 231       step->__max_needed_to = MAX_NEEDED_FROM;
 232     }
 233   else
 234     return __GCONV_NOCONV;
 235
 236 #ifdef RESET_STATE
 237   step->__stateful = 1;
 238 #else
 239   step->__stateful = 0;
 240 #endif
 241
 242   return __GCONV_OK;
 243 }
 244 #endif
 245
 246
 247 /* The default destructor function does nothing in the moment and so
 248    be define it at all.  But we still provide the macro just in case
 249    we need it some day.  */
 250 #if DEFINE_FINI
 251 #endif
 252
 253
 254 /* If no arguments have to passed to the loop function define the macro
 255    as empty.  */
 256 #ifndef EXTRA_LOOP_ARGS
 257 # define EXTRA_LOOP_ARGS
 258 #endif
 259
 260
 261 /* This is the actual conversion function.  */
 262 #ifndef FUNCTION_NAME
 263 # define FUNCTION_NAME  gconv
 264 #endif
 265
 266 int
 267 FUNCTION_NAME (struct __gconv_step *step, struct __gconv_step_data *data,
 268                const unsigned char **inbuf, const unsigned char *inbufend,
 269                size_t *written, int do_flush)
 270 {
 271   struct __gconv_step *next_step = step + 1;
 272   struct __gconv_step_data *next_data = data + 1;
 273   __gconv_fct fct = data->__is_last ? NULL : next_step->__fct;
 274   int status;
 275
 276   /* If the function is called with no input this means we have to reset
 277      to the initial state.  The possibly partly converted input is
 278      dropped.  */
 279   if (do_flush)
 280     {
 281       status = __GCONV_OK;
 282
 283 #ifdef EMIT_SHIFT_TO_INIT
 284       /* Emit the escape sequence to reset the state.  */
 285       EMIT_SHIFT_TO_INIT;
 286 #endif
 287       /* Call the steps down the chain if there are any but only if we
 288          successfully emitted the escape sequence.  */
 289       if (status == __GCONV_OK && ! data->__is_last)
 290         status = DL_CALL_FCT (fct, (next_step, next_data, NULL, NULL,
 291                                     written, 1));
 292     }
 293   else
 294     {
 295       /* We preserve the initial values of the pointer variables.  */
 296       const unsigned char *inptr = *inbuf;
 297       unsigned char *outbuf = data->__outbuf;
 298       unsigned char *outend = data->__outbufend;
 299       unsigned char *outstart;
 300       /* This variable is used to count the number of characters we
 301          actually converted.  */
 302       size_t converted = 0;
 303 #if defined _STRING_ARCH_unaligned \
 304     || MIN_NEEDED_FROM == 1 || MAX_NEEDED_FROM % MIN_NEEDED_FROM != 0 \
 305     || MIN_NEEDED_TO == 1 || MAX_NEEDED_TO % MIN_NEEDED_TO != 0
 306 # define unaligned 0
 307 #else
 308       int unaligned;
 309 # define GEN_unaligned(name) GEN_unaligned2 (name)
 310 # define GEN_unaligned2(name) name##_unaligned
 311 #endif
 312
 313 #ifdef PREPARE_LOOP
 314       PREPARE_LOOP
 315 #endif
 316
 317 #if !defined _STRING_ARCH_unaligned \
 318     && MIN_NEEDED_FROM != 1 && MAX_NEEDED_FROM % MIN_NEEDED_FROM == 0 \
 319     && MIN_NEEDED_TO != 1 && MAX_NEEDED_TO % MIN_NEEDED_TO == 0
 320       /* The following assumes that encodings, which have a variable length
 321          what might unalign a buffer even though it is a aligned in the
 322          beginning, either don't have the minimal number of bytes as a divisor
 323          of the maximum length or have a minimum length of 1.  This is true
 324          for all known and supported encodings.  */
 325       unaligned = ((FROM_DIRECTION
 326                     && ((uintptr_t) inptr % MIN_NEEDED_FROM != 0
 327                         || (data->__is_last
 328                             && (uintptr_t) outbuf % MIN_NEEDED_TO != 0)))
 329                    || (!FROM_DIRECTION
 330                        && ((data->__is_last
 331                             && (uintptr_t) outbuf % MIN_NEEDED_FROM != 0)
 332                            || (uintptr_t) inptr % MIN_NEEDED_TO != 0)));
 333 #endif
 334
 335       do
 336         {
 337           /* Remember the start value for this round.  */
 338           inptr = *inbuf;
 339           /* The outbuf buffer is empty.  */
 340           outstart = outbuf;
 341
 342 #ifdef SAVE_RESET_STATE
 343           SAVE_RESET_STATE (1);
 344 #endif
 345
 346           if (!unaligned)
 347             {
 348               if (FROM_DIRECTION)
 349                 /* Run the conversion loop.  */
 350                 status = FROM_LOOP (inbuf, inbufend, &outbuf, outend,
 351                                     data->__statep, step->__data, &converted
 352                                     EXTRA_LOOP_ARGS);
 353               else
 354                 /* Run the conversion loop.  */
 355                 status = TO_LOOP (inbuf, inbufend, &outbuf, outend,
 356                                   data->__statep, step->__data, &converted
 357                                   EXTRA_LOOP_ARGS);
 358             }
 359 #if !defined _STRING_ARCH_unaligned \
 360     && MIN_NEEDED_FROM != 1 && MAX_NEEDED_FROM % MIN_NEEDED_FROM == 0 \
 361     && MIN_NEEDED_TO != 1 && MAX_NEEDED_TO % MIN_NEEDED_TO == 0
 362           else
 363             {
 364               if (FROM_DIRECTION)
 365                 /* Run the conversion loop.  */
 366                 status = GEN_unaligned (FROM_LOOP) (inbuf, inbufend, &outbuf,
 367                                                     outend, data->__statep,
 368                                                     step->__data, &converted
 369                                                     EXTRA_LOOP_ARGS);
 370               else
 371                 /* Run the conversion loop.  */
 372                 status = GEN_unaligned (TO_LOOP) (inbuf, inbufend, &outbuf,
 373                                                   outend, data->__statep,
 374                                                   step->__data, &converted
 375                                                   EXTRA_LOOP_ARGS);
 376             }
 377 #endif
 378
 379           /* We finished one use of the loops.  */
 380           ++data->__invocation_counter;
 381
 382           /* If this is the last step leave the loop, there is nothing
 383              we can do.  */
 384           if (data->__is_last)
 385             {
 386               /* Store information about how many bytes are available.  */
 387               data->__outbuf = outbuf;
 388
 389               /* Remember how many non-identical characters we converted.  */
 390               *written += converted;
 391
 392               break;
 393             }
 394
 395           /* Write out all output which was produced.  */
 396           if (outbuf > outstart)
 397             {
 398               const unsigned char *outerr = data->__outbuf;
 399               int result;
 400
 401               result = DL_CALL_FCT (fct, (next_step, next_data, &outerr,
 402                                           outbuf, written, 0));
 403
 404               if (result != __GCONV_EMPTY_INPUT)
 405                 {
 406                   if (outerr != outbuf)
 407                     {
 408 #ifdef RESET_INPUT_BUFFER
 409                       RESET_INPUT_BUFFER;
 410 #else
 411                       /* We have a problem with the in on of the functions
 412                          below.  Undo the conversion upto the error point.  */
 413                       size_t nstatus;
 414
 415                       /* Reload the pointers.  */
 416                       *inbuf = inptr;
 417                       outbuf = outstart;
 418
 419                       /* Reset the state.  */
 420 # ifdef SAVE_RESET_STATE
 421                       SAVE_RESET_STATE (0);
 422 # endif
 423
 424                       if (FROM_DIRECTION)
 425                         /* Run the conversion loop.  */
 426                         nstatus = FROM_LOOP ((const unsigned char **) inbuf,
 427                                              (const unsigned char *) inbufend,
 428                                              (unsigned char **) &outbuf,
 429                                              (unsigned char *) outerr,
 430                                              data->__statep, step->__data,
 431                                              &converted EXTRA_LOOP_ARGS);
 432                       else
 433                         /* Run the conversion loop.  */
 434                         nstatus = TO_LOOP ((const unsigned char **) inbuf,
 435                                            (const unsigned char *) inbufend,
 436                                            (unsigned char **) &outbuf,
 437                                            (unsigned char *) outerr,
 438                                            data->__statep, step->__data,
 439                                            &converted EXTRA_LOOP_ARGS);
 440
 441                       /* We must run out of output buffer space in this
 442                          rerun.  */
 443                       assert (outbuf == outerr);
 444                       assert (nstatus == __GCONV_FULL_OUTPUT);
 445
 446                       /* If we haven't consumed a single byte decrement
 447                          the invocation counter.  */
 448                       if (outbuf == outstart)
 449                         --data->__invocation_counter;
 450 #endif  /* reset input buffer */
 451                     }
 452
 453                   /* Change the status.  */
 454                   status = result;
 455                 }
 456               else
 457                 /* All the output is consumed, we can make another run
 458                    if everything was ok.  */
 459                 if (status == __GCONV_FULL_OUTPUT)
 460                   status = __GCONV_OK;
 461             }
 462         }
 463       while (status == __GCONV_OK);
 464
 465 #ifdef END_LOOP
 466       END_LOOP
 467 #endif
 468     }
 469
 470   return status;
 471 }
 472
 473 #undef DEFINE_INIT
 474 #undef CHARSET_NAME
 475 #undef DEFINE_FINI
 476 #undef MIN_NEEDED_FROM
 477 #undef MIN_NEEDED_TO
 478 #undef MAX_NEEDED_FROM
 479 #undef MAX_NEEDED_TO
 480 #undef DEFINE_DIRECTION_OBJECTS
 481 #undef FROM_DIRECTION
 482 #undef EMIT_SHIFT_TO_INIT
 483 #undef FROM_LOOP
 484 #undef TO_LOOP
 485 #undef RESET_STATE
 486 #undef RESET_INPUT_BUFFER
 487 #undef FUNCTION_NAME
 488 #undef PREPARE_LOOP
 489 #undef END_LOOP