xref: /freebsd/lib/libc/stdlib/strfmon.c (revision d5980dff)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 Alexey Zelkin <phantom@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Copyright (c) 2011 The FreeBSD Foundation
8  *
9  * Portions of this software were developed by David Chisnall
10  * under sponsorship from the FreeBSD Foundation.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/types.h>
39 #include <ctype.h>
40 #include <errno.h>
41 #include <limits.h>
42 #include <locale.h>
43 #include <monetary.h>
44 #include <stdarg.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 
49 #include "xlocale_private.h"
50 
51 /* internal flags */
52 #define	NEED_GROUPING		0x01	/* print digits grouped (default) */
53 #define	SIGN_POSN_USED		0x02	/* '+' or '(' usage flag */
54 #define	LOCALE_POSN		0x04	/* use locale defined +/- (default) */
55 #define	PARENTH_POSN		0x08	/* enclose negative amount in () */
56 #define	SUPPRESS_CURR_SYMBOL	0x10	/* suppress the currency from output */
57 #define	LEFT_JUSTIFY		0x20	/* left justify */
58 #define	USE_INTL_CURRENCY	0x40	/* use international currency symbol */
59 #define	IS_NEGATIVE		0x80	/* is argument value negative ? */
60 
61 /* internal macros */
62 #define	PRINT(CH) do {						\
63 	if (dst >= s + maxsize)				\
64 		goto e2big_error;				\
65 	*dst++ = CH;						\
66 } while (0)
67 
68 #define	PRINTS(STR) do {					\
69 	char *tmps = STR;					\
70 	while (*tmps != '\0')					\
71 		PRINT(*tmps++);					\
72 } while (0)
73 
74 #define	GET_NUMBER(VAR) do {					\
75 	VAR = 0;						\
76 	while (isdigit((unsigned char)*fmt)) {			\
77 		if (VAR > INT_MAX / 10)				\
78 			goto e2big_error;			\
79 		VAR *= 10;					\
80 		VAR += *fmt - '0';				\
81 		if (VAR < 0)					\
82 			goto e2big_error;			\
83 		fmt++;						\
84 	}							\
85 } while (0)
86 
87 #define	GRPCPY(howmany) do {					\
88 	int i = howmany;					\
89 	while (i-- > 0) {					\
90 		avalue_size--;					\
91 		*--bufend = *(avalue + avalue_size + padded);	\
92 	}							\
93 } while (0)
94 
95 #define	GRPSEP do {						\
96 	bufend -= thousands_sep_size;				\
97 	memcpy(bufend, thousands_sep, thousands_sep_size);	\
98 	groups++;						\
99 } while (0)
100 
101 static void __setup_vars(int, char *, char *, char *, char **);
102 static int __calc_left_pad(int, char *);
103 static char *__format_grouped_double(double, int *, int, int, int);
104 
105 static ssize_t
106 vstrfmon_l(char * __restrict s, size_t maxsize, locale_t loc,
107     const char * __restrict format, va_list ap)
108 {
109 	char		*dst;		/* output destination pointer */
110 	const char	*fmt;		/* current format poistion pointer */
111 	struct lconv	*lc;		/* pointer to lconv structure */
112 	char		*asciivalue;	/* formatted double pointer */
113 
114 	int		flags;		/* formatting options */
115 	int		pad_char;	/* padding character */
116 	int		pad_size;	/* pad size */
117 	int		width;		/* field width */
118 	int		left_prec;	/* left precision */
119 	int		right_prec;	/* right precision */
120 	double		value;		/* just value */
121 	char		space_char = ' '; /* space after currency */
122 
123 	char		cs_precedes,	/* values gathered from struct lconv */
124 			sep_by_space,
125 			sign_posn,
126 			*signstr,
127 			*currency_symbol;
128 
129 	char		*tmpptr;	/* temporary vars */
130 	int		sverrno;
131 	FIX_LOCALE(loc);
132 
133 	lc = localeconv_l(loc);
134 	dst = s;
135 	fmt = format;
136 	asciivalue = NULL;
137 	currency_symbol = NULL;
138 	pad_size = 0;
139 
140 	while (*fmt) {
141 		/* pass nonformating characters AS IS */
142 		if (*fmt != '%')
143 			goto literal;
144 
145 		/* '%' found ! */
146 
147 		/* "%%" mean just '%' */
148 		if (*(fmt + 1) == '%') {
149 			fmt++;
150 	literal:
151 			PRINT(*fmt++);
152 			continue;
153 		}
154 
155 		/* set up initial values */
156 		flags = (NEED_GROUPING|LOCALE_POSN);
157 		pad_char = ' ';		/* padding character is "space" */
158 		left_prec = -1;		/* no left precision specified */
159 		right_prec = -1;	/* no right precision specified */
160 		width = -1;		/* no width specified */
161 		value = 0;		/* we have no value to print now */
162 
163 		/* Flags */
164 		while (1) {
165 			switch (*++fmt) {
166 				case '=':	/* fill character */
167 					pad_char = *++fmt;
168 					if (pad_char == '\0')
169 						goto format_error;
170 					continue;
171 				case '^':	/* not group currency  */
172 					flags &= ~(NEED_GROUPING);
173 					continue;
174 				case '+':	/* use locale defined signs */
175 					if (flags & SIGN_POSN_USED)
176 						goto format_error;
177 					flags |= (SIGN_POSN_USED|LOCALE_POSN);
178 					continue;
179 				case '(':	/* enclose negatives with () */
180 					if (flags & SIGN_POSN_USED)
181 						goto format_error;
182 					flags |= (SIGN_POSN_USED|PARENTH_POSN);
183 					continue;
184 				case '!':	/* suppress currency symbol */
185 					flags |= SUPPRESS_CURR_SYMBOL;
186 					continue;
187 				case '-':	/* alignment (left)  */
188 					flags |= LEFT_JUSTIFY;
189 					continue;
190 				default:
191 					break;
192 			}
193 			break;
194 		}
195 
196 		/* field Width */
197 		if (isdigit((unsigned char)*fmt)) {
198 			GET_NUMBER(width);
199 			/* Do we have enough space to put number with
200 			 * required width ?
201 			 */
202 			if ((unsigned int)width >= maxsize - (dst - s))
203 				goto e2big_error;
204 		}
205 
206 		/* Left precision */
207 		if (*fmt == '#') {
208 			if (!isdigit((unsigned char)*++fmt))
209 				goto format_error;
210 			GET_NUMBER(left_prec);
211 			if ((unsigned int)left_prec >= maxsize - (dst - s))
212 				goto e2big_error;
213 		}
214 
215 		/* Right precision */
216 		if (*fmt == '.') {
217 			if (!isdigit((unsigned char)*++fmt))
218 				goto format_error;
219 			GET_NUMBER(right_prec);
220 			if ((unsigned int)right_prec >= maxsize - (dst - s) -
221 			    left_prec)
222 				goto e2big_error;
223 		}
224 
225 		/* Conversion Characters */
226 		switch (*fmt++) {
227 			case 'i':	/* use internaltion currency format */
228 				flags |= USE_INTL_CURRENCY;
229 				break;
230 			case 'n':	/* use national currency format */
231 				flags &= ~(USE_INTL_CURRENCY);
232 				break;
233 			default:	/* required character is missing or
234 					   premature EOS */
235 				goto format_error;
236 		}
237 
238 		if (currency_symbol != NULL)
239 			free(currency_symbol);
240 		if (flags & USE_INTL_CURRENCY) {
241 			currency_symbol = strdup(lc->int_curr_symbol);
242 			if (currency_symbol != NULL)
243 				space_char = *(currency_symbol+3);
244 		} else
245 			currency_symbol = strdup(lc->currency_symbol);
246 
247 		if (currency_symbol == NULL)
248 			goto end_error;			/* ENOMEM. */
249 
250 		/* value itself */
251 		value = va_arg(ap, double);
252 
253 		/* detect sign */
254 		if (value < 0) {
255 			flags |= IS_NEGATIVE;
256 			value = -value;
257 		}
258 
259 		/* fill left_prec with amount of padding chars */
260 		if (left_prec >= 0) {
261 			pad_size = __calc_left_pad((flags ^ IS_NEGATIVE),
262 							currency_symbol) -
263 				   __calc_left_pad(flags, currency_symbol);
264 			if (pad_size < 0)
265 				pad_size = 0;
266 		}
267 
268 		if (asciivalue != NULL)
269 			free(asciivalue);
270 		asciivalue = __format_grouped_double(value, &flags,
271 				left_prec, right_prec, pad_char);
272 		if (asciivalue == NULL)
273 			goto end_error;		/* errno already set     */
274 						/* to ENOMEM by malloc() */
275 
276 		/* set some variables for later use */
277 		__setup_vars(flags, &cs_precedes, &sep_by_space,
278 				&sign_posn, &signstr);
279 
280 		/*
281 		 * Description of some LC_MONETARY's values:
282 		 *
283 		 * p_cs_precedes & n_cs_precedes
284 		 *
285 		 * = 1 - $currency_symbol precedes the value
286 		 *       for a monetary quantity with a non-negative value
287 		 * = 0 - symbol succeeds the value
288 		 *
289 		 * p_sep_by_space & n_sep_by_space
290 		 *
291 		 * = 0 - no space separates $currency_symbol
292 		 *       from the value for a monetary quantity with a
293 		 *       non-negative value
294 		 * = 1 - space separates the symbol from the value
295 		 * = 2 - space separates the symbol and the sign string,
296 		 *       if adjacent.
297 		 *
298 		 * p_sign_posn & n_sign_posn
299 		 *
300 		 * = 0 - parentheses enclose the quantity and the
301 		 *       $currency_symbol
302 		 * = 1 - the sign string precedes the quantity and the
303 		 *       $currency_symbol
304 		 * = 2 - the sign string succeeds the quantity and the
305 		 *       $currency_symbol
306 		 * = 3 - the sign string precedes the $currency_symbol
307 		 * = 4 - the sign string succeeds the $currency_symbol
308 		 *
309 		 */
310 
311 		tmpptr = dst;
312 
313 		while (pad_size-- > 0)
314 			PRINT(' ');
315 
316 		if (sign_posn == 0 && (flags & IS_NEGATIVE))
317 			PRINT('(');
318 
319 		if (cs_precedes == 1) {
320 			if (sign_posn == 1 || sign_posn == 3) {
321 				PRINTS(signstr);
322 				if (sep_by_space == 2)		/* XXX: ? */
323 					PRINT(' ');
324 			}
325 
326 			if (!(flags & SUPPRESS_CURR_SYMBOL)) {
327 				PRINTS(currency_symbol);
328 
329 				if (sign_posn == 4) {
330 					if (sep_by_space == 2)
331 						PRINT(space_char);
332 					PRINTS(signstr);
333 					if (sep_by_space == 1)
334 						PRINT(' ');
335 				} else if (sep_by_space == 1)
336 					PRINT(space_char);
337 			}
338 		} else if (sign_posn == 1)
339 			PRINTS(signstr);
340 
341 		PRINTS(asciivalue);
342 
343 		if (cs_precedes == 0) {
344 			if (sign_posn == 3) {
345 				if (sep_by_space == 1)
346 					PRINT(' ');
347 				PRINTS(signstr);
348 			}
349 
350 			if (!(flags & SUPPRESS_CURR_SYMBOL)) {
351 				if ((sign_posn == 3 && sep_by_space == 2)
352 				    || (sep_by_space == 1
353 				    && (sign_posn == 0
354 				    || sign_posn == 1
355 				    || sign_posn == 2
356 				    || sign_posn == 4)))
357 					PRINT(space_char);
358 				PRINTS(currency_symbol); /* XXX: len */
359 				if (sign_posn == 4) {
360 					if (sep_by_space == 2)
361 						PRINT(' ');
362 					PRINTS(signstr);
363 				}
364 			}
365 		}
366 
367 		if (sign_posn == 2) {
368 			if (sep_by_space == 2)
369 				PRINT(' ');
370 			PRINTS(signstr);
371 		}
372 
373 		if (sign_posn == 0 && (flags & IS_NEGATIVE))
374 			PRINT(')');
375 
376 		if (dst - tmpptr < width) {
377 			if (flags & LEFT_JUSTIFY) {
378 				while (dst - tmpptr < width)
379 					PRINT(' ');
380 			} else {
381 				pad_size = dst - tmpptr;
382 				memmove(tmpptr + width - pad_size, tmpptr,
383 				    pad_size);
384 				memset(tmpptr, ' ', width - pad_size);
385 				dst += width - pad_size;
386 			}
387 		}
388 	}
389 
390 	PRINT('\0');
391 	free(asciivalue);
392 	free(currency_symbol);
393 	return (dst - s - 1);	/* return size of put data except trailing '\0' */
394 
395 e2big_error:
396 	errno = E2BIG;
397 	goto end_error;
398 
399 format_error:
400 	errno = EINVAL;
401 
402 end_error:
403 	sverrno = errno;
404 	if (asciivalue != NULL)
405 		free(asciivalue);
406 	if (currency_symbol != NULL)
407 		free(currency_symbol);
408 	errno = sverrno;
409 	return (-1);
410 }
411 
412 static void
413 __setup_vars(int flags, char *cs_precedes, char *sep_by_space,
414     char *sign_posn, char **signstr)
415 {
416 	struct lconv *lc = localeconv();
417 
418 	if ((flags & IS_NEGATIVE) && (flags & USE_INTL_CURRENCY)) {
419 		*cs_precedes = lc->int_n_cs_precedes;
420 		*sep_by_space = lc->int_n_sep_by_space;
421 		*sign_posn = (flags & PARENTH_POSN) ? 0 : lc->int_n_sign_posn;
422 		*signstr = (lc->negative_sign[0] == '\0') ? "-"
423 		    : lc->negative_sign;
424 	} else if (flags & USE_INTL_CURRENCY) {
425 		*cs_precedes = lc->int_p_cs_precedes;
426 		*sep_by_space = lc->int_p_sep_by_space;
427 		*sign_posn = (flags & PARENTH_POSN) ? 0 : lc->int_p_sign_posn;
428 		*signstr = lc->positive_sign;
429 	} else if (flags & IS_NEGATIVE) {
430 		*cs_precedes = lc->n_cs_precedes;
431 		*sep_by_space = lc->n_sep_by_space;
432 		*sign_posn = (flags & PARENTH_POSN) ? 0 : lc->n_sign_posn;
433 		*signstr = (lc->negative_sign[0] == '\0') ? "-"
434 		    : lc->negative_sign;
435 	} else {
436 		*cs_precedes = lc->p_cs_precedes;
437 		*sep_by_space = lc->p_sep_by_space;
438 		*sign_posn = (flags & PARENTH_POSN) ? 0 : lc->p_sign_posn;
439 		*signstr = lc->positive_sign;
440 	}
441 
442 	/* Set defult values for unspecified information. */
443 	if (*cs_precedes != 0)
444 		*cs_precedes = 1;
445 	if (*sep_by_space == CHAR_MAX)
446 		*sep_by_space = 0;
447 	if (*sign_posn == CHAR_MAX)
448 		*sign_posn = 0;
449 }
450 
451 static int
452 __calc_left_pad(int flags, char *cur_symb)
453 {
454 	char cs_precedes, sep_by_space, sign_posn, *signstr;
455 	int left_chars = 0;
456 
457 	__setup_vars(flags, &cs_precedes, &sep_by_space, &sign_posn, &signstr);
458 
459 	if (cs_precedes != 0) {
460 		left_chars += strlen(cur_symb);
461 		if (sep_by_space != 0)
462 			left_chars++;
463 	}
464 
465 	switch (sign_posn) {
466 		case 1:
467 			left_chars += strlen(signstr);
468 			break;
469 		case 3:
470 		case 4:
471 			if (cs_precedes != 0)
472 				left_chars += strlen(signstr);
473 	}
474 	return (left_chars);
475 }
476 
477 static int
478 get_groups(int size, char *grouping)
479 {
480 	int	chars = 0;
481 
482 	if (*grouping == CHAR_MAX || *grouping <= 0)	/* no grouping ? */
483 		return (0);
484 
485 	while (size > (int)*grouping) {
486 		chars++;
487 		size -= (int)*grouping++;
488 		/* no more grouping ? */
489 		if (*grouping == CHAR_MAX)
490 			break;
491 		/* rest grouping with same value ? */
492 		if (*grouping == 0) {
493 			chars += (size - 1) / *(grouping - 1);
494 			break;
495 		}
496 	}
497 	return (chars);
498 }
499 
500 /* convert double to locale-encoded string */
501 static char *
502 __format_grouped_double(double value, int *flags,
503     int left_prec, int right_prec, int pad_char)
504 {
505 
506 	char		*rslt;
507 	char		*avalue;
508 	int		avalue_size;
509 
510 	size_t		bufsize;
511 	char		*bufend;
512 
513 	int		padded;
514 
515 	struct lconv	*lc = localeconv();
516 	char		*grouping;
517 	const char	*decimal_point;
518 	const char	*thousands_sep;
519 	size_t		decimal_point_size;
520 	size_t		thousands_sep_size;
521 
522 	int groups = 0;
523 
524 	grouping = lc->mon_grouping;
525 	decimal_point = lc->mon_decimal_point;
526 	if (*decimal_point == '\0')
527 		decimal_point = lc->decimal_point;
528 	thousands_sep = lc->mon_thousands_sep;
529 	if (*thousands_sep == '\0')
530 		thousands_sep = lc->thousands_sep;
531 
532 	decimal_point_size = strlen(decimal_point);
533 	thousands_sep_size = strlen(thousands_sep);
534 
535 	/* fill left_prec with default value */
536 	if (left_prec == -1)
537 		left_prec = 0;
538 
539 	/* fill right_prec with default value */
540 	if (right_prec == -1) {
541 		if (*flags & USE_INTL_CURRENCY)
542 			right_prec = lc->int_frac_digits;
543 		else
544 			right_prec = lc->frac_digits;
545 
546 		if (right_prec == CHAR_MAX)	/* POSIX locale ? */
547 			right_prec = 2;
548 	}
549 
550 	if (*flags & NEED_GROUPING)
551 		left_prec += get_groups(left_prec, grouping);
552 
553 	/* convert to string */
554 	avalue_size = asprintf(&avalue, "%*.*f", left_prec + right_prec + 1,
555 	    right_prec, value);
556 	if (avalue_size < 0)
557 		return (NULL);
558 
559 	/* make sure that we've enough space for result string */
560 	bufsize = avalue_size * (1 + thousands_sep_size) + decimal_point_size +
561 	    1;
562 	rslt = calloc(1, bufsize);
563 	if (rslt == NULL) {
564 		free(avalue);
565 		return (NULL);
566 	}
567 	bufend = rslt + bufsize - 1;	/* reserve space for trailing '\0' */
568 
569 	/* skip spaces at beginning */
570 	padded = 0;
571 	while (avalue[padded] == ' ') {
572 		padded++;
573 		avalue_size--;
574 	}
575 
576 	if (right_prec > 0) {
577 		bufend -= right_prec;
578 		memcpy(bufend, avalue + avalue_size + padded - right_prec,
579 		    right_prec);
580 		bufend -= decimal_point_size;
581 		memcpy(bufend, decimal_point, decimal_point_size);
582 		avalue_size -= (right_prec + 1);
583 	}
584 
585 	if ((*flags & NEED_GROUPING) &&
586 	    thousands_sep_size > 0 &&	/* XXX: need investigation */
587 	    *grouping != CHAR_MAX &&
588 	    *grouping > 0) {
589 		while (avalue_size > (int)*grouping) {
590 			GRPCPY(*grouping);
591 			GRPSEP;
592 			grouping++;
593 
594 			/* no more grouping ? */
595 			if (*grouping == CHAR_MAX)
596 				break;
597 
598 			/* rest grouping with same value ? */
599 			if (*grouping == 0) {
600 				grouping--;
601 				while (avalue_size > *grouping) {
602 					GRPCPY(*grouping);
603 					GRPSEP;
604 				}
605 			}
606 		}
607 		if (avalue_size != 0)
608 			GRPCPY(avalue_size);
609 		padded -= groups;
610 	} else {
611 		bufend -= avalue_size;
612 		memcpy(bufend, avalue + padded, avalue_size);
613 		/* decrease assumed $decimal_point */
614 		if (right_prec == 0)
615 			padded -= decimal_point_size;
616 	}
617 
618 	/* do padding with pad_char */
619 	if (padded > 0) {
620 		bufend -= padded;
621 		memset(bufend, pad_char, padded);
622 	}
623 
624 	bufsize = rslt + bufsize - bufend;
625 	memmove(rslt, bufend, bufsize);
626 	free(avalue);
627 	return (rslt);
628 }
629 
630 ssize_t
631 strfmon(char * __restrict s, size_t maxsize, const char * __restrict format,
632     ...)
633 {
634 	size_t ret;
635 	va_list ap;
636 
637 	va_start(ap, format);
638 	ret = vstrfmon_l(s, maxsize, __get_locale(), format, ap);
639 	va_end(ap);
640 
641 	return (ret);
642 }
643 
644 ssize_t
645 strfmon_l(char * __restrict s, size_t maxsize, locale_t loc,
646     const char * __restrict format, ...)
647 {
648 	size_t ret;
649 	va_list ap;
650 
651 	va_start(ap, format);
652 	ret = vstrfmon_l(s, maxsize, loc, format, ap);
653 	va_end(ap);
654 
655 	return (ret);
656 }
657