annotate lib/sprintf.c @ 9309:bbbbbf4cd1c5

Change copyright notice from GPLv2+ to GPLv3+.
author Bruno Haible <bruno@clisp.org>
date Sun, 07 Oct 2007 19:14:58 +0200
parents 3b5cd6b6e134
children 787bf3487678
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Formatted output to strings.
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2 Copyright (C) 2004, 2006-2007 Free Software Foundation, Inc.
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
4 This program is free software: you can redistribute it and/or modify
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
7 (at your option) any later version.
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 GNU General Public License for more details.
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
14 You should have received a copy of the GNU General Public License
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17 #ifdef HAVE_CONFIG_H
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 # include <config.h>
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #endif
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 /* Specification. */
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #include <stdio.h>
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 #include <errno.h>
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 #include <limits.h>
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #include <stdarg.h>
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
27 #include <stdint.h>
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 #include <stdlib.h>
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 #include "vasnprintf.h"
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 /* Some systems, like OSF/1 4.0 and Woe32, don't have EOVERFLOW. */
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 #ifndef EOVERFLOW
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 # define EOVERFLOW E2BIG
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 #endif
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 #ifndef SIZE_MAX
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 # define SIZE_MAX ((size_t) -1)
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 #endif
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 /* Print formatted output to string STR.
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 Return string length of formatted string. On error, return a negative
8381
8c96722f8bd0 Whitespace change.
Bruno Haible <bruno@clisp.org>
parents: 8373
diff changeset
43 value. */
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 int
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 sprintf (char *str, const char *format, ...)
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 {
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 char *output;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 size_t len;
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
49 size_t lenbuf;
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
50 va_list args;
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
51
8468
336e69863755 Fix endless loop when the given allocated size was > INT_MAX.
Bruno Haible <bruno@clisp.org>
parents: 8381
diff changeset
52 /* vasnprintf fails with EOVERFLOW when the buffer size argument is larger
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
53 than INT_MAX (if that fits into a 'size_t' at all).
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
54 Also note that glibc's iconv fails with E2BIG when we pass a length that
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
55 is so large that str + lenbuf wraps around, i.e.
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
56 (uintptr_t) (str + lenbuf) < (uintptr_t) str.
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
57 Therefore set lenbuf = min (SIZE_MAX, INT_MAX, - (uintptr_t) str - 1). */
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
58 lenbuf = (SIZE_MAX < INT_MAX ? SIZE_MAX : INT_MAX);
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
59 if (lenbuf > ~ (uintptr_t) str)
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
60 lenbuf = ~ (uintptr_t) str;
8373
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 va_start (args, format);
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 output = vasnprintf (str, &lenbuf, format, args);
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 len = lenbuf;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 va_end (args);
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67 if (!output)
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 return -1;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 if (output != str)
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 {
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 /* len is near SIZE_MAX. */
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 free (output);
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 errno = EOVERFLOW;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 return -1;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 }
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78 if (len > INT_MAX)
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 {
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 errno = EOVERFLOW;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 return -1;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 }
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84 return len;
b975f31a2a92 New module 'sprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85 }