(error): Handle wide oriented stderr stream correctly.
[kopensolaris-gnu/glibc.git] / misc / error.c
1 /* Error handler for noninteractive utilities
2    Copyright (C) 1990-1998, 2000, 2001 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.  Its master source is NOT part of
4    the C library, however.  The master source lives in /gd/gnu/lib.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the 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    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 /* Written by David MacKenzie <djm@gnu.ai.mit.edu>.  */
22
23 #ifdef HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include <stdio.h>
28 #include <libintl.h>
29 #ifdef _LIBC
30 # include <wchar.h>
31 #endif
32
33 #if HAVE_VPRINTF || HAVE_DOPRNT || _LIBC
34 # if __STDC__
35 #  include <stdarg.h>
36 #  define VA_START(args, lastarg) va_start(args, lastarg)
37 # else
38 #  include <varargs.h>
39 #  define VA_START(args, lastarg) va_start(args)
40 # endif
41 #else
42 # define va_alist a1, a2, a3, a4, a5, a6, a7, a8
43 # define va_dcl char *a1, *a2, *a3, *a4, *a5, *a6, *a7, *a8;
44 #endif
45
46 #if STDC_HEADERS || _LIBC
47 # include <stdlib.h>
48 # include <string.h>
49 #else
50 void exit ();
51 #endif
52
53 #include "error.h"
54
55 #ifndef _
56 # define _(String) String
57 #endif
58
59 /* If NULL, error will flush stdout, then print on stderr the program
60    name, a colon and a space.  Otherwise, error will call this
61    function without parameters instead.  */
62 void (*error_print_progname) (
63 #if __STDC__ - 0
64                               void
65 #endif
66                               );
67
68 /* This variable is incremented each time `error' is called.  */
69 unsigned int error_message_count;
70
71 #ifdef _LIBC
72 /* In the GNU C library, there is a predefined variable for this.  */
73
74 # define program_name program_invocation_name
75 # include <errno.h>
76
77 /* In GNU libc we want do not want to use the common name `error' directly.
78    Instead make it a weak alias.  */
79 extern void __error (int status, int errnum, const char *message, ...)
80      __attribute__ ((__format__ (__printf__, 3, 4)));
81 extern void __error_at_line (int status, int errnum, const char *file_name,
82                              unsigned int line_number, const char *message,
83                              ...)
84      __attribute__ ((__format__ (__printf__, 5, 6)));;
85 # define error __error
86 # define error_at_line __error_at_line
87
88 # ifdef USE_IN_LIBIO
89 # include <libio/iolibio.h>
90 #  define fflush(s) _IO_fflush (s)
91 # endif
92
93 #else /* not _LIBC */
94
95 /* The calling program should define program_name and set it to the
96    name of the executing program.  */
97 extern char *program_name;
98
99 # ifdef HAVE_STRERROR_R
100 #  define __strerror_r strerror_r
101 # else
102 #  if HAVE_STRERROR
103 #   ifndef strerror             /* On some systems, strerror is a macro */
104 char *strerror ();
105 #   endif
106 #  else
107 static char *
108 private_strerror (errnum)
109      int errnum;
110 {
111   extern char *sys_errlist[];
112   extern int sys_nerr;
113
114   if (errnum > 0 && errnum <= sys_nerr)
115     return _(sys_errlist[errnum]);
116   return _("Unknown system error");
117 }
118 #   define strerror private_strerror
119 #  endif /* HAVE_STRERROR */
120 # endif /* HAVE_STRERROR_R */
121 #endif  /* not _LIBC */
122
123
124 #ifdef VA_START
125 static void
126 error_tail (int status, int errnum, const char *message, va_list args)
127 {
128 # if HAVE_VPRINTF || _LIBC
129 #  ifdef _LIBC
130   if (_IO_fwide (stderr, 0) > 0)
131     {
132 #   define ALLOCA_LIMIT 2000
133       size_t len = strlen (message) + 1;
134       wchar_t *wmessage = NULL;
135       mbstate_t st;
136       size_t res;
137       const char *tmp;
138
139       do
140         {
141           if (len < ALLOCA_LIMIT)
142             wmessage = (wchar_t *) alloca (len * sizeof (wchar_t));
143           else
144             {
145               if (wmessage != NULL && len / 2 < ALLOCA_LIMIT)
146                 wmessage = NULL;
147
148               wmessage = (wchar_t *) realloc (wmessage,
149                                               len * sizeof (wchar_t));
150
151               if (wmessage == NULL)
152                 {
153                   fputws (L"out of memory\n", stderr);
154                   return;
155                 }
156             }
157
158           memset (&st, '\0', sizeof (st));
159           tmp =message;
160         }
161       while ((res = mbsrtowcs (wmessage, &tmp, len, &st)) == len);
162
163       if (res == (size_t) -1)
164         /* The string cannot be converted.  */
165         wmessage = (wchar_t *) L"???";
166
167       vfwprintf (stderr, wmessage, args);
168     }
169   else
170 #  endif
171     vfprintf (stderr, message, args);
172 # else
173   _doprnt (message, args, stderr);
174 # endif
175   va_end (args);
176
177   ++error_message_count;
178   if (errnum)
179     {
180 #if defined HAVE_STRERROR_R || _LIBC
181       char errbuf[1024];
182       char *s = __strerror_r (errnum, errbuf, sizeof errbuf);
183 # ifdef _LIBC
184       if (_IO_fwide (stderr, 0) > 0)
185         fwprintf (stderr, L": %s", s);
186       else
187 # endif
188         fprintf (stderr, ": %s", s);
189 #else
190       fprintf (stderr, ": %s", strerror (errnum));
191 #endif
192     }
193 #ifdef _LIBC
194   if (_IO_fwide (stderr, 0) > 0)
195     putwc (L'\n', stderr);
196   else
197 #endif
198     putc ('\n', stderr);
199   fflush (stderr);
200   if (status)
201     exit (status);
202 }
203 #endif
204
205
206 /* Print the program name and error message MESSAGE, which is a printf-style
207    format string with optional args.
208    If ERRNUM is nonzero, print its corresponding system error message.
209    Exit with status STATUS if it is nonzero.  */
210 /* VARARGS */
211 void
212 #if defined VA_START && __STDC__
213 error (int status, int errnum, const char *message, ...)
214 #else
215 error (status, errnum, message, va_alist)
216      int status;
217      int errnum;
218      char *message;
219      va_dcl
220 #endif
221 {
222 #ifdef VA_START
223   va_list args;
224 #endif
225
226   fflush (stdout);
227 #ifdef _LIBC
228   flockfile (stderr);
229 #endif
230   if (error_print_progname)
231     (*error_print_progname) ();
232   else
233     {
234 #ifdef _LIBC
235       if (_IO_fwide (stderr, 0) > 0)
236         fwprintf (stderr, L"%s: ", program_name);
237       else
238 #endif
239         fprintf (stderr, "%s: ", program_name);
240     }
241
242 #ifdef VA_START
243   VA_START (args, message);
244   error_tail (status, errnum, message, args);
245 # ifdef _LIBC
246   funlockfile (stderr);
247 # endif
248 #else
249   fprintf (stderr, message, a1, a2, a3, a4, a5, a6, a7, a8);
250
251   ++error_message_count;
252   if (errnum)
253     fprintf (stderr, ": %s", strerror (errnum));
254   putc ('\n', stderr);
255   fflush (stderr);
256   if (status)
257     exit (status);
258 #endif
259 }
260 \f
261 /* Sometimes we want to have at most one error per line.  This
262    variable controls whether this mode is selected or not.  */
263 int error_one_per_line;
264
265 void
266 #if defined VA_START && __STDC__
267 error_at_line (int status, int errnum, const char *file_name,
268                unsigned int line_number, const char *message, ...)
269 #else
270 error_at_line (status, errnum, file_name, line_number, message, va_alist)
271      int status;
272      int errnum;
273      const char *file_name;
274      unsigned int line_number;
275      char *message;
276      va_dcl
277 #endif
278 {
279 #ifdef VA_START
280   va_list args;
281 #endif
282
283   if (error_one_per_line)
284     {
285       static const char *old_file_name;
286       static unsigned int old_line_number;
287
288       if (old_line_number == line_number
289           && (file_name == old_file_name
290               || strcmp (old_file_name, file_name) == 0))
291         /* Simply return and print nothing.  */
292         return;
293
294       old_file_name = file_name;
295       old_line_number = line_number;
296     }
297
298   fflush (stdout);
299 #ifdef _LIBC
300   flockfile (stderr);
301 #endif
302   if (error_print_progname)
303     (*error_print_progname) ();
304   else
305     {
306 #ifdef _LIBC
307       if (_IO_fwide (stderr, 0) > 0)
308         fwprintf (stderr, L"%s: ", program_name);
309       else
310 #endif
311         fprintf (stderr, "%s:", program_name);
312     }
313
314   if (file_name != NULL)
315     {
316 #ifdef _LIBC
317       if (_IO_fwide (stderr, 0) > 0)
318         fwprintf (stderr, L"%s:%d: ", file_name, line_number);
319       else
320 #endif
321         fprintf (stderr, "%s:%d: ", file_name, line_number);
322     }
323
324 #ifdef VA_START
325   VA_START (args, message);
326   error_tail (status, errnum, message, args);
327 # ifdef _LIBC
328   funlockfile (stderr);
329 # endif
330 #else
331   fprintf (stderr, message, a1, a2, a3, a4, a5, a6, a7, a8);
332
333   ++error_message_count;
334   if (errnum)
335     fprintf (stderr, ": %s", strerror (errnum));
336   putc ('\n', stderr);
337   fflush (stderr);
338   if (status)
339     exit (status);
340 #endif
341 }
342
343 #ifdef _LIBC
344 /* Make the weak alias.  */
345 # undef error
346 # undef error_at_line
347 weak_alias (__error, error)
348 weak_alias (__error_at_line, error_at_line)
349 #endif