1 #ifndef INCLUDED_ircd_snprintf_h
2 #define INCLUDED_ircd_snprintf_h
4 * IRC - Internet Relay Chat, include/ircd_snprintf.h
5 * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #ifndef INCLUDED_sys_types_h
24 #include <sys/types.h>
25 #define INCLUDED_sys_types_h
27 #ifndef INCLUDED_stdarg_h
29 #define INCLUDED_stdarg_h
34 /* structure passed as argument for %v conversion */
36 size_t vd_chars; /* number of characters inserted */
37 size_t vd_overflow; /* number of characters that couldn't be */
38 const char *vd_format; /* format string */
39 va_list vd_args; /* arguments for %v */
42 extern int ircd_snprintf(struct Client *dest, char *buf, size_t buf_len,
43 const char *format, ...);
44 extern int ircd_vsnprintf(struct Client *dest, char *buf, size_t buf_len,
45 const char *format, va_list args);
50 ** These functions are intended to be a complete replacement for
51 ** sprintf and sprintf_irc. They are a (nearly) complete
52 ** reimplementation, and of course they're snprintf clones, making it
53 ** more difficult for accidental buffer overflows to crop up.
55 ** First off, what's missing? These functions support all ANSI C
56 ** conversion specifiers and selected ones from ISO 9x, with the
57 ** exception of all floating-point conversions. The floating-point
58 ** conversions are tricky, and will likely be dependent on the
59 ** representation of a floating-point number on a particular
60 ** architecture. While that representation is likely to conform to
61 ** some standard, it is not currently used in ircu, so seemed like a
62 ** good thing to omit, given the difficulty of implementing it.
64 ** There are two more things missing from this implementation that
65 ** would be required by ANSI; the first is support for multibyte
66 ** character strings, and the second is support for locales, neither
67 ** of which have any relevance for ircu, so again omission seemed to
68 ** be a good policy. Additionally, %#x always causes '0x' (or '0X')
69 ** to be printed, even if the number is zero.
71 ** These functions also have some extensions not seen in a
72 ** standards-compliant implementation; technically, the ISO 9x
73 ** extensions fall into this category, for instance. The ISO 9x
74 ** extensions supported are type extensions--%ju, %tu, and %zu, for
75 ** instance; %qu and %hhu are also supported. The extensions added
76 ** for use in ircu are %Tu, which takes a time_t, and the new %C
77 ** conversion, which inserts either a numeric or a nick, dependant on
78 ** the <dest> parameter. The GNU %m extension, which inserts the
79 ** strerror() string corresponding to the current value of errno, is
80 ** also supported, as is a special %v extension, which essentially
81 ** does a recursive call to ircd_snprintf.
83 ** The following description is descended from the Linux manpage for
84 ** the printf family of functions.
86 ** The format string is composed of zero or more directives:
87 ** ordinary characters (not %), which are copied unchanged to the
88 ** output stream; and conversion specifications, each of which results
89 ** in fetching zero or more subsequent arguments. Each conversion
90 ** specification is introduced by the character %. The arguments must
91 ** correspond properly (after type promotion) with the conversion
92 ** specifier. After the %, the following appear in sequence:
94 ** * Zero or more of the following flags:
96 ** # specifying that the value should be converted to an
97 ** "alternate form." For c, d, i, n, p, s, and u conversions,
98 ** this option has no effect. For o conversions, the precision
99 ** of the number is increased to force the first character of the
100 ** output string to a zero (except if a zero value is printed
101 ** with an explicit precision of zero). For x and X conversions,
102 ** the string '0x' (or '0X' for X conversions) is prepended to
103 ** it. For e, E, f, g, and G conversions, the result will always
104 ** contain a decimal point, even if no digits follow it
105 ** (normally, a decimal point appears in the results of those
106 ** conversions only if a digit follows). For g and G
107 ** conversions, trailing zeros are not removed from the result as
108 ** they would otherwise be. For C conversions, if the
109 ** destination is local and the origin is a user, the
110 ** nick!user@host form is used.
112 ** 0 specifying zero padding. For all conversions except n, the
113 ** converted value is padded on the left with zeros rather than
114 ** blanks. If a precision is given with a numeric conversion (d,
115 ** i, o, u, i, x, and X), the 0 flag is ignored.
117 ** - (a negative field width flag) indicates the converted value is
118 ** to be left adjusted on the field boundary. Except for n
119 ** conversions, the converted value is padded on the right with
120 ** blanks, rather than on the left with blanks or zeros. A -
121 ** overrides a 0 if both are given.
123 ** ' ' (a space) specifying that a blank should be left before a
124 ** positive number produced by a signed conversion (d, e, E, f,
127 ** + specifying that a sign always be placed before a number
128 ** produced by a signed conversion. A + overrides a space if
131 ** : specifying that a struct Client name should be preceded by a
132 ** ':' character if the destination is a user
134 ** * An optional decimal digit string specifying a minimum field
135 ** width. If the converted value has fewer characters than the
136 ** field width, it will be padded with spaces on the left (or right,
137 ** if the left-adjustment flag has been given) to fill out the field
140 ** * An optional precision, in the form of a period (`.') followed by
141 ** an optional digit string. If the digit string is omitted, the
142 ** precision is taken as zero. This gives the minimum number of
143 ** digits to appear for d, i, o, u, x, and X conversions, the number
144 ** of digits to appear after the decimal-point for e, E, and f
145 ** conversions, the maximum number of significant digits for g and G
146 ** conversions, or the maximum number of characters to be printed
147 ** from a string for s conversions.
149 ** * The optional character h, specifying that a following d, i, o, u,
150 ** x, or X conversion corresponds to a short int or unsigned short
151 ** int argument, or that a following n conversion corresponds to a
152 ** pointer to a short int argument. If the h character is given
153 ** again, char is used instead of short int.
155 ** * The optional character l (ell) specifying that a following d, i,
156 ** o, u, x, or X conversion applies to a pointer to a long int or
157 ** unsigned long int argument, or that a following n conversion
158 ** corresponds to a pointer to a long int argument.
160 ** * The character L specifying that a following e, E, f, g, or G
161 ** conversion corresponds to a long double argument, or a following
162 ** d, i, o, u, x, or X conversion corresponds to a long long
163 ** argument. Note that long long is not specified in ANSI C and
164 ** therefore not portable to all architectures.
166 ** * The optional character q. This is equivalent to L.
168 ** * A j character specifying that the following integer (d, i, o, u,
169 ** x, or X) conversion corresponds to an intmax_t argument.
171 ** * A t character specifying that the following integer (d, i, o, u,
172 ** x, or X) conversion corresponds to a ptrdiff_t argument.
174 ** * A z character specifying that the following integer (d, i, o, u,
175 ** x, or X) conversion corresponds to a size_t argument.
177 ** * A T character specifying that the following integer (d, i, o, u,
178 ** x, or X) conversion corresponds to a time_t argument.
180 ** * A character that specifies the type of conversion to be applied.
182 ** A field width or precision, or both, may be indicated by an
183 ** asterisk `*' instead of a digit string. In this case, an int
184 ** argument supplies the field width or precision. A negative field
185 ** width is treated as a left adjustment flag followed by a positive
186 ** field width; a negative precision is treated as though it were
189 ** The conversion specifiers and their meanings are:
191 ** diouxX The int (or appropriate variant) argument is converted
192 ** to signed decimal (d and i), unsigned octal (o),
193 ** unsigned decimal (u), or unsigned hexadecimal (x and
194 ** X) notation. The letters abcdef are used for x
195 ** conversions; the letters ABCDEF are used for X
196 ** conversions. The precision, if any, gives the minimum
197 ** number of digits that must appear; if the converted
198 ** value requires fewer digits, it is padded on the left
201 ** eE [NOT IMPLEMENTED] The double argument is rounded and
202 ** converted in the style [-]d.dddedd where there is one
203 ** digit before the decimal-point character and the
204 ** number of digits after it is equal to the precision;
205 ** if the precision is missing, it is taken as 6; if the
206 ** precision is zero, no decimal-point character appears.
207 ** An E conversion uses the letter E (rather than e) to
208 ** introduce the exponent. The exponent always contains
209 ** at least two digits; if the value is zero, the
212 ** f [NOT IMPLEMENTED] The double argument is rounded and
213 ** converted to decimal notation in the style
214 ** [-]ddd.ddd, where the number of digits after the
215 ** decimal-point character is equal to the precision
216 ** specification. If the precision is missing, it is
217 ** taken as 6; if the precision is explicitly zero, no
218 ** decimal-point character appears. If a decimal point
219 ** appears, at least one digit appears before it.
221 ** g [NOT IMPLEMENTED] The double argument is converted in
222 ** style f or e (or E for G conversions). The precision
223 ** specifies the number of significant digits. If the
224 ** precision is missing, 6 digits are given; if the
225 ** precision is zero, it is treated as 1. Style e is
226 ** used if the exponent from its conversion is less than
227 ** -4 or greater than or equal to the precision.
228 ** Trailing zeros are removed from the fractional part of
229 ** the result; a decimal point appears only if it is
230 ** followed by at least one digit.
232 ** c The int argument is converted to an unsigned char, and
233 ** the resulting character is written.
235 ** s The "char *" argument is expected to be a pointer to
236 ** an array of character type (pointer to a string).
237 ** Characters from the array are written up to (but not
238 ** including) a terminating NUL character; if a precision
239 ** is specified, no more than the number specified are
240 ** written. If a precision is given, no null character
241 ** need be present; if the precision is not specified, or
242 ** is greater than the size of the array, the array must
243 ** contain a terminating NUL character.
245 ** p The "void *" pointer argument is printed in
246 ** hexadecimal (as if by %#x or %#lx).
248 ** n The number of characters written so far is stored into
249 ** the integer indicated by the ``int *'' (or variant)
250 ** pointer argument. No argument is converted.
252 ** m The error message associated with the current value of
253 ** errno is printed as if by %s.
255 ** C The client argument identifier is printed under the
256 ** control of the <dest> argument; if <dest> is NULL or
257 ** is a user, the client's name (nickname or server name)
258 ** is printed; otherwise, the client's network numeric is
261 ** H The channel argument identifier (channel name) is
264 ** v The argument given must be a pointer to a struct
265 ** VarData with vd_format and vd_args must be initialized
266 ** appropriately. On return, vd_chars will contain the
267 ** number of characters added to the buffer, and
268 ** vd_overflow will contain the number of characters that
269 ** could not be added due to buffer overflow or due to a
272 ** % A `%' is written. No argument is converted. The
273 ** complete conversion specification is `%%'.
275 ** In no case does a non-existent or small field width cause
276 ** truncation of a field; if the result of a conversion is wider than
277 ** the field width, the field is expanded to contain the conversion
281 #endif /* INCLUDED_ircd_snprintf_h */