(COUNT_CONVERTED): Remove macro, comment, and all uses.
[kopensolaris-gnu/glibc.git] / iconv / loop.c
1 /* Conversion loop frame work.
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 provides a frame for the reader loop in all conversion modules.
22    The actual code must (of course) be provided in the actual module source
23    code but certain actions can be written down generically, with some
24    customization options which are these:
25
26      MIN_NEEDED_INPUT   minimal number of input bytes needed for the next
27                         conversion.
28      MIN_NEEDED_OUTPUT  minimal number of bytes produced by the next round
29                         of conversion.
30
31      MAX_NEEDED_INPUT   you guess it, this is the maximal number of input
32                         bytes needed.  It defaults to MIN_NEEDED_INPUT
33      MAX_NEEDED_OUTPUT  likewise for output bytes.
34
35      LOOPFCT            name of the function created.  If not specified
36                         the name is `loop' but this prevents the use
37                         of multiple functions in the same file.
38
39      BODY               this is supposed to expand to the body of the loop.
40                         The user must provide this.
41
42      EXTRA_LOOP_DECLS   extra arguments passed from converion loop call.
43
44      INIT_PARAMS        code to define and initialize variables from params.
45      UPDATE_PARAMS      code to store result in params.
46 */
47
48 #include <gconv.h>
49 #include <wchar.h>
50 #include <sys/param.h>          /* For MIN.  */
51 #define __need_size_t
52 #include <stddef.h>
53
54
55 /* We need at least one byte for the next round.  */
56 #ifndef MIN_NEEDED_INPUT
57 # error "MIN_NEEDED_INPUT definition missing"
58 #endif
59
60 /* Let's see how many bytes we produce.  */
61 #ifndef MAX_NEEDED_INPUT
62 # define MAX_NEEDED_INPUT       MIN_NEEDED_INPUT
63 #endif
64
65 /* We produce at least one byte in the next round.  */
66 #ifndef MIN_NEEDED_OUTPUT
67 # error "MIN_NEEDED_OUTPUT definition missing"
68 #endif
69
70 /* Let's see how many bytes we produce.  */
71 #ifndef MAX_NEEDED_OUTPUT
72 # define MAX_NEEDED_OUTPUT      MIN_NEEDED_OUTPUT
73 #endif
74
75 /* Default name for the function.  */
76 #ifndef LOOPFCT
77 # define LOOPFCT                loop
78 #endif
79
80 /* Make sure we have a loop body.  */
81 #ifndef BODY
82 # error "Definition of BODY missing for function" LOOPFCT
83 #endif
84
85
86 /* If no arguments have to passed to the loop function define the macro
87    as empty.  */
88 #ifndef EXTRA_LOOP_DECLS
89 # define EXTRA_LOOP_DECLS
90 #endif
91
92
93 /* The function returns the status, as defined in gconv.h.  */
94 static inline int
95 LOOPFCT (const unsigned char **inptrp, const unsigned char *inend,
96          unsigned char **outptrp, unsigned char *outend, mbstate_t *state,
97          void *data, size_t *converted EXTRA_LOOP_DECLS)
98 {
99   int result = __GCONV_OK;
100   const unsigned char *inptr = *inptrp;
101   unsigned char *outptr = *outptrp;
102
103   /* We run one loop where we avoid checks for underflow/overflow of the
104      buffers to speed up the conversion a bit.  */
105   size_t min_in_rounds = (inend - inptr) / MAX_NEEDED_INPUT;
106   size_t min_out_rounds = (outend - outptr) / MAX_NEEDED_OUTPUT;
107   size_t min_rounds = MIN (min_in_rounds, min_out_rounds);
108
109 #ifdef INIT_PARAMS
110   INIT_PARAMS;
111 #endif
112
113 #undef NEED_LENGTH_TEST
114 #define NEED_LENGTH_TEST        0
115   while (min_rounds-- > 0)
116     {
117       /* Here comes the body the user provides.  It can stop with RESULT
118          set to GCONV_INCOMPLETE_INPUT (if the size of the input characters
119          vary in size), GCONV_ILLEGAL_INPUT, or GCONV_FULL_OUTPUT (if the
120          output characters vary in size.  */
121       BODY
122     }
123
124   if (result == __GCONV_OK)
125     {
126 #if MIN_NEEDED_INPUT == MAX_NEEDED_INPUT \
127     && MIN_NEEDED_OUTPUT == MAX_NEEDED_OUTPUT
128       /* We don't need to start another loop since we were able to determine
129          the maximal number of characters to copy in advance.  What remains
130          to be determined is the status.  */
131       if (inptr == inend)
132         /* No more input.  */
133         result = __GCONV_EMPTY_INPUT;
134       else if ((MIN_NEEDED_OUTPUT != 1 && outptr + MIN_NEEDED_OUTPUT > outend)
135                || (MIN_NEEDED_OUTPUT == 1 && outptr >= outend))
136         /* Overflow in the output buffer.  */
137         result = __GCONV_FULL_OUTPUT;
138       else
139         /* We have something left in the input buffer.  */
140         result = __GCONV_INCOMPLETE_INPUT;
141 #else
142       result = __GCONV_EMPTY_INPUT;
143
144 # undef NEED_LENGTH_TEST
145 # define NEED_LENGTH_TEST       1
146       while (inptr != inend)
147         {
148           /* `if' cases for MIN_NEEDED_OUTPUT ==/!= 1 is made to help the
149              compiler generating better code.  It will optimized away
150              since MIN_NEEDED_OUTPUT is always a constant.  */
151           if ((MIN_NEEDED_OUTPUT != 1 && outptr + MIN_NEEDED_OUTPUT > outend)
152               || (MIN_NEEDED_OUTPUT == 1 && outptr >= outend))
153             {
154               /* Overflow in the output buffer.  */
155               result = __GCONV_FULL_OUTPUT;
156               break;
157             }
158           if (MIN_NEEDED_INPUT > 1 && inptr + MIN_NEEDED_INPUT > inend)
159             {
160               /* We don't have enough input for another complete input
161                  character.  */
162               result = __GCONV_INCOMPLETE_INPUT;
163               break;
164             }
165
166           /* Here comes the body the user provides.  It can stop with
167              RESULT set to GCONV_INCOMPLETE_INPUT (if the size of the
168              input characters vary in size), GCONV_ILLEGAL_INPUT, or
169              GCONV_FULL_OUTPUT (if the output characters vary in size).  */
170           BODY
171         }
172 #endif  /* Input and output charset are not both fixed width.  */
173     }
174
175   /* Update the pointers pointed to by the parameters.  */
176   *inptrp = inptr;
177   *outptrp = outptr;
178 #ifdef UPDATE_PARAMS
179   UPDATE_PARAMS;
180 #endif
181
182   return result;
183 }
184
185
186 /* We remove the macro definitions so that we can include this file again
187    for the definition of another function.  */
188 #undef MIN_NEEDED_INPUT
189 #undef MAX_NEEDED_INPUT
190 #undef MIN_NEEDED_OUTPUT
191 #undef MAX_NEEDED_OUTPUT
192 #undef LOOPFCT
193 #undef BODY
194 #undef LOOPFCT
195 #undef EXTRA_LOOP_DECLS
196 #undef INIT_PARAMS
197 #undef UPDATE_PARAMS