snprintf.c 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665
  1. #include "common.h"
  2. #include "snprintf.h"
  3. /*
  4. * Copyright Patrick Powell 1995
  5. * This code is based on code written by Patrick Powell (papowell@astart.com)
  6. * It may be used for any purpose as long as this notice remains intact
  7. * on all source code distributions
  8. */
  9. /**************************************************************
  10. * Original:
  11. * Patrick Powell Tue Apr 11 09:48:21 PDT 1995
  12. * A bombproof version of doprnt (dopr) included.
  13. * Sigh. This sort of thing is always nasty do deal with. Note that
  14. * the version here does not include floating point...
  15. *
  16. * snprintf() is used instead of sprintf() as it does limit checks
  17. * for string length. This covers a nasty loophole.
  18. *
  19. * The other functions are there to prevent NULL pointers from
  20. * causing nast effects.
  21. *
  22. * More Recently:
  23. * Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
  24. * This was ugly. It is still ugly. I opted out of floating point
  25. * numbers, but the formatter understands just about everything
  26. * from the normal C string format, at least as far as I can tell from
  27. * the Solaris 2.5 printf(3S) man page.
  28. *
  29. * Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
  30. * Ok, added some minimal floating point support, which means this
  31. * probably requires libm on most operating systems. Don't yet
  32. * support the exponent (e,E) and sigfig (g,G). Also, fmtint()
  33. * was pretty badly broken, it just wasn't being exercised in ways
  34. * which showed it, so that's been fixed. Also, formated the code
  35. * to mutt conventions, and removed dead code left over from the
  36. * original. Also, there is now a builtin-test, just compile with:
  37. * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
  38. * and run snprintf for results.
  39. *
  40. * Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
  41. * The PGP code was using unsigned hexadecimal formats.
  42. * Unfortunately, unsigned formats simply didn't work.
  43. *
  44. * Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
  45. * The original code assumed that both snprintf() and vsnprintf() were
  46. * missing. Some systems only have snprintf() but not vsnprintf(), so
  47. * the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
  48. *
  49. * Ben Lindstrom <mouring@eviladmin.org> 09/27/00 for OpenSSH
  50. * Welcome to the world of %lld and %qd support. With other
  51. * long long support. This is needed for sftp-server to work
  52. * right.
  53. *
  54. * Ben Lindstrom <mouring@eviladmin.org> 02/12/01 for OpenSSH
  55. * Removed all hint of VARARGS stuff and banished it to the void,
  56. * and did a bit of KNF style work to make things a bit more
  57. * acceptable. Consider stealing from mutt or enlightenment.
  58. **************************************************************/
  59. #include <string.h>
  60. #include <ctype.h>
  61. #include <sys/types.h>
  62. #if defined(BROKEN_SNPRINTF) /* For those with broken snprintf() */
  63. # undef HAVE_SNPRINTF
  64. # undef HAVE_VSNPRINTF
  65. #endif
  66. #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
  67. static void
  68. dopr(char *buffer, size_t maxlen, const char *format, va_list args);
  69. static void
  70. fmtstr(char *buffer, size_t *currlen, size_t maxlen, char *value, int flags,
  71. int min, int max);
  72. static void
  73. fmtint(char *buffer, size_t *currlen, size_t maxlen, long value, int base,
  74. int min, int max, int flags);
  75. static void
  76. fmtfp(char *buffer, size_t *currlen, size_t maxlen, long double fvalue,
  77. int min, int max, int flags);
  78. static void
  79. dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c);
  80. /*
  81. * dopr(): poor man's version of doprintf
  82. */
  83. /* format read states */
  84. #define DP_S_DEFAULT 0
  85. #define DP_S_FLAGS 1
  86. #define DP_S_MIN 2
  87. #define DP_S_DOT 3
  88. #define DP_S_MAX 4
  89. #define DP_S_MOD 5
  90. #define DP_S_CONV 6
  91. #define DP_S_DONE 7
  92. /* format flags - Bits */
  93. #define DP_F_MINUS (1 << 0)
  94. #define DP_F_PLUS (1 << 1)
  95. #define DP_F_SPACE (1 << 2)
  96. #define DP_F_NUM (1 << 3)
  97. #define DP_F_ZERO (1 << 4)
  98. #define DP_F_UP (1 << 5)
  99. #define DP_F_UNSIGNED (1 << 6)
  100. /* Conversion Flags */
  101. #define DP_C_SHORT 1
  102. #define DP_C_LONG 2
  103. #define DP_C_LDOUBLE 3
  104. #define DP_C_LONG_LONG 4
  105. #define char_to_int(p) (p - '0')
  106. #define abs_val(p) (p < 0 ? -p : p)
  107. static void
  108. dopr(char *buffer, size_t maxlen, const char *format, va_list args)
  109. {
  110. char *strvalue, ch;
  111. long value;
  112. long double fvalue;
  113. int min = 0, max = -1, state = DP_S_DEFAULT, flags = 0, cflags = 0;
  114. size_t currlen = 0;
  115. ch = *format++;
  116. while (state != DP_S_DONE) {
  117. if ((ch == '\0') || (currlen >= maxlen))
  118. state = DP_S_DONE;
  119. switch(state) {
  120. case DP_S_DEFAULT:
  121. if (ch == '%')
  122. state = DP_S_FLAGS;
  123. else
  124. dopr_outch(buffer, &currlen, maxlen, ch);
  125. ch = *format++;
  126. break;
  127. case DP_S_FLAGS:
  128. switch (ch) {
  129. case '-':
  130. flags |= DP_F_MINUS;
  131. ch = *format++;
  132. break;
  133. case '+':
  134. flags |= DP_F_PLUS;
  135. ch = *format++;
  136. break;
  137. case ' ':
  138. flags |= DP_F_SPACE;
  139. ch = *format++;
  140. break;
  141. case '#':
  142. flags |= DP_F_NUM;
  143. ch = *format++;
  144. break;
  145. case '0':
  146. flags |= DP_F_ZERO;
  147. ch = *format++;
  148. break;
  149. default:
  150. state = DP_S_MIN;
  151. break;
  152. }
  153. break;
  154. case DP_S_MIN:
  155. if (egg_isdigit((unsigned char)ch)) {
  156. min = 10 * min + char_to_int (ch);
  157. ch = *format++;
  158. } else if (ch == '*') {
  159. min = va_arg (args, int);
  160. ch = *format++;
  161. state = DP_S_DOT;
  162. } else
  163. state = DP_S_DOT;
  164. break;
  165. case DP_S_DOT:
  166. if (ch == '.') {
  167. state = DP_S_MAX;
  168. ch = *format++;
  169. } else
  170. state = DP_S_MOD;
  171. break;
  172. case DP_S_MAX:
  173. if (egg_isdigit((unsigned char)ch)) {
  174. if (max < 0)
  175. max = 0;
  176. max = 10 * max + char_to_int(ch);
  177. ch = *format++;
  178. } else if (ch == '*') {
  179. max = va_arg (args, int);
  180. ch = *format++;
  181. state = DP_S_MOD;
  182. } else
  183. state = DP_S_MOD;
  184. break;
  185. case DP_S_MOD:
  186. switch (ch) {
  187. case 'z': /* size_t */
  188. case 'Z':
  189. if (sizeof (size_t) > sizeof (unsigned long int))
  190. cflags = DP_C_LONG_LONG;
  191. else if (sizeof (size_t) > sizeof (unsigned int))
  192. cflags = DP_C_LONG;
  193. ch = *format++;
  194. break;
  195. case 'h':
  196. cflags = DP_C_SHORT;
  197. ch = *format++;
  198. break;
  199. case 'l':
  200. cflags = DP_C_LONG;
  201. ch = *format++;
  202. if (ch == 'l') {
  203. cflags = DP_C_LONG_LONG;
  204. ch = *format++;
  205. }
  206. break;
  207. case 'q':
  208. cflags = DP_C_LONG_LONG;
  209. ch = *format++;
  210. break;
  211. case 'L':
  212. cflags = DP_C_LDOUBLE;
  213. ch = *format++;
  214. break;
  215. default:
  216. break;
  217. }
  218. state = DP_S_CONV;
  219. break;
  220. case DP_S_CONV:
  221. switch (ch) {
  222. case 'd':
  223. case 'i':
  224. if (cflags == DP_C_SHORT)
  225. value = va_arg(args, int);
  226. else if (cflags == DP_C_LONG)
  227. value = va_arg(args, long int);
  228. else if (cflags == DP_C_LONG_LONG)
  229. value = va_arg (args, long long);
  230. else
  231. value = va_arg (args, int);
  232. fmtint(buffer, &currlen, maxlen, value, 10, min, max, flags);
  233. break;
  234. case 'o':
  235. flags |= DP_F_UNSIGNED;
  236. if (cflags == DP_C_SHORT)
  237. value = va_arg(args, unsigned int);
  238. else if (cflags == DP_C_LONG)
  239. value = va_arg(args, unsigned long int);
  240. else if (cflags == DP_C_LONG_LONG)
  241. value = va_arg(args, unsigned long long);
  242. else
  243. value = va_arg(args, unsigned int);
  244. fmtint(buffer, &currlen, maxlen, value, 8, min, max, flags);
  245. break;
  246. case 'u':
  247. flags |= DP_F_UNSIGNED;
  248. if (cflags == DP_C_SHORT)
  249. value = va_arg(args, unsigned int);
  250. else if (cflags == DP_C_LONG)
  251. value = va_arg(args, unsigned long int);
  252. else if (cflags == DP_C_LONG_LONG)
  253. value = va_arg(args, unsigned long long);
  254. else
  255. value = va_arg(args, unsigned int);
  256. fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
  257. break;
  258. case 'X':
  259. flags |= DP_F_UP;
  260. case 'x':
  261. flags |= DP_F_UNSIGNED;
  262. if (cflags == DP_C_SHORT)
  263. value = va_arg(args, unsigned int);
  264. else if (cflags == DP_C_LONG)
  265. value = va_arg(args, unsigned long int);
  266. else if (cflags == DP_C_LONG_LONG)
  267. value = va_arg(args, unsigned long long);
  268. else
  269. value = va_arg(args, unsigned int);
  270. fmtint(buffer, &currlen, maxlen, value, 16, min, max, flags);
  271. break;
  272. case 'f':
  273. if (cflags == DP_C_LDOUBLE)
  274. fvalue = va_arg(args, long double);
  275. else
  276. fvalue = va_arg(args, double);
  277. /* um, floating point? */
  278. fmtfp(buffer, &currlen, maxlen, fvalue, min, max, flags);
  279. break;
  280. case 'E':
  281. flags |= DP_F_UP;
  282. case 'e':
  283. if (cflags == DP_C_LDOUBLE)
  284. fvalue = va_arg(args, long double);
  285. else
  286. fvalue = va_arg(args, double);
  287. break;
  288. case 'G':
  289. flags |= DP_F_UP;
  290. case 'g':
  291. if (cflags == DP_C_LDOUBLE)
  292. fvalue = va_arg(args, long double);
  293. else
  294. fvalue = va_arg(args, double);
  295. break;
  296. case 'c':
  297. dopr_outch(buffer, &currlen, maxlen, va_arg(args, int));
  298. break;
  299. case 's':
  300. strvalue = va_arg(args, char *);
  301. if (max < 0)
  302. max = maxlen; /* ie, no max */
  303. fmtstr(buffer, &currlen, maxlen, strvalue, flags, min, max);
  304. break;
  305. case 'p':
  306. strvalue = va_arg(args, void *);
  307. fmtint(buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
  308. break;
  309. case 'n':
  310. if (cflags == DP_C_SHORT) {
  311. short int *num;
  312. num = va_arg(args, short int *);
  313. *num = currlen;
  314. } else if (cflags == DP_C_LONG) {
  315. long int *num;
  316. num = va_arg(args, long int *);
  317. *num = currlen;
  318. } else if (cflags == DP_C_LONG_LONG) {
  319. long long *num;
  320. num = va_arg(args, long long *);
  321. *num = currlen;
  322. } else {
  323. int *num;
  324. num = va_arg(args, int *);
  325. *num = currlen;
  326. }
  327. break;
  328. case '%':
  329. dopr_outch(buffer, &currlen, maxlen, ch);
  330. break;
  331. case 'w': /* not supported yet, treat as next char */
  332. ch = *format++;
  333. break;
  334. default: /* Unknown, skip */
  335. break;
  336. }
  337. ch = *format++;
  338. state = DP_S_DEFAULT;
  339. flags = cflags = min = 0;
  340. max = -1;
  341. break;
  342. case DP_S_DONE:
  343. break;
  344. default: /* hmm? */
  345. break; /* some picky compilers need this */
  346. }
  347. }
  348. if (currlen < maxlen - 1)
  349. buffer[currlen] = '\0';
  350. else
  351. buffer[maxlen - 1] = '\0';
  352. }
  353. static void
  354. fmtstr(char *buffer, size_t *currlen, size_t maxlen,
  355. char *value, int flags, int min, int max)
  356. {
  357. int cnt = 0, padlen, strln; /* amount to pad */
  358. if (value == 0)
  359. value = "<NULL>";
  360. for (strln = 0; value[strln]; ++strln); /* strlen */
  361. padlen = min - strln;
  362. if (padlen < 0)
  363. padlen = 0;
  364. if (flags & DP_F_MINUS)
  365. padlen = -padlen; /* Left Justify */
  366. while ((padlen > 0) && (cnt < max)) {
  367. dopr_outch(buffer, currlen, maxlen, ' ');
  368. --padlen;
  369. ++cnt;
  370. }
  371. while (*value && (cnt < max)) {
  372. dopr_outch(buffer, currlen, maxlen, *value++);
  373. ++cnt;
  374. }
  375. while ((padlen < 0) && (cnt < max)) {
  376. dopr_outch(buffer, currlen, maxlen, ' ');
  377. ++padlen;
  378. ++cnt;
  379. }
  380. }
  381. /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
  382. static void
  383. fmtint(char *buffer, size_t *currlen, size_t maxlen,
  384. long value, int base, int min, int max, int flags)
  385. {
  386. unsigned long uvalue;
  387. char convert[20];
  388. int signvalue = 0, place = 0, caps = 0;
  389. int spadlen = 0; /* amount to space pad */
  390. int zpadlen = 0; /* amount to zero pad */
  391. if (max < 0)
  392. max = 0;
  393. uvalue = value;
  394. if (!(flags & DP_F_UNSIGNED)) {
  395. if (value < 0) {
  396. signvalue = '-';
  397. uvalue = -value;
  398. } else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
  399. signvalue = '+';
  400. else if (flags & DP_F_SPACE)
  401. signvalue = ' ';
  402. }
  403. if (flags & DP_F_UP)
  404. caps = 1; /* Should characters be upper case? */
  405. do {
  406. convert[place++] =
  407. (caps ? "0123456789ABCDEF" : "0123456789abcdef")
  408. [uvalue % (unsigned)base];
  409. uvalue = (uvalue / (unsigned)base );
  410. } while (uvalue && (place < 20));
  411. if (place == 20)
  412. place--;
  413. convert[place] = 0;
  414. zpadlen = max - place;
  415. spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
  416. if (zpadlen < 0)
  417. zpadlen = 0;
  418. if (spadlen < 0)
  419. spadlen = 0;
  420. if (flags & DP_F_ZERO) {
  421. zpadlen = MAX(zpadlen, spadlen);
  422. spadlen = 0;
  423. }
  424. if (flags & DP_F_MINUS)
  425. spadlen = -spadlen; /* Left Justifty */
  426. /* Spaces */
  427. while (spadlen > 0) {
  428. dopr_outch(buffer, currlen, maxlen, ' ');
  429. --spadlen;
  430. }
  431. /* Sign */
  432. if (signvalue)
  433. dopr_outch(buffer, currlen, maxlen, signvalue);
  434. /* Zeros */
  435. if (zpadlen > 0) {
  436. while (zpadlen > 0) {
  437. dopr_outch(buffer, currlen, maxlen, '0');
  438. --zpadlen;
  439. }
  440. }
  441. /* Digits */
  442. while (place > 0)
  443. dopr_outch(buffer, currlen, maxlen, convert[--place]);
  444. /* Left Justified spaces */
  445. while (spadlen < 0) {
  446. dopr_outch (buffer, currlen, maxlen, ' ');
  447. ++spadlen;
  448. }
  449. }
  450. static long double
  451. pow10(int exp)
  452. {
  453. long double result = 1;
  454. while (exp) {
  455. result *= 10;
  456. exp--;
  457. }
  458. return result;
  459. }
  460. static long
  461. round(long double value)
  462. {
  463. long intpart = value;
  464. value -= intpart;
  465. if (value >= 0.5)
  466. intpart++;
  467. return intpart;
  468. }
  469. static void
  470. fmtfp(char *buffer, size_t *currlen, size_t maxlen, long double fvalue,
  471. int min, int max, int flags)
  472. {
  473. char iconvert[20], fconvert[20];
  474. int signvalue = 0, iplace = 0, fplace = 0;
  475. int padlen = 0; /* amount to pad */
  476. int zpadlen = 0, caps = 0;
  477. long intpart, fracpart;
  478. long double ufvalue;
  479. /*
  480. * AIX manpage says the default is 0, but Solaris says the default
  481. * is 6, and sprintf on AIX defaults to 6
  482. */
  483. if (max < 0)
  484. max = 6;
  485. ufvalue = abs_val(fvalue);
  486. if (fvalue < 0)
  487. signvalue = '-';
  488. else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
  489. signvalue = '+';
  490. else if (flags & DP_F_SPACE)
  491. signvalue = ' ';
  492. intpart = ufvalue;
  493. /*
  494. * Sorry, we only support 9 digits past the decimal because of our
  495. * conversion method
  496. */
  497. if (max > 9)
  498. max = 9;
  499. /* We "cheat" by converting the fractional part to integer by
  500. * multiplying by a factor of 10
  501. */
  502. fracpart = round((pow10 (max)) * (ufvalue - intpart));
  503. if (fracpart >= pow10 (max)) {
  504. intpart++;
  505. fracpart -= pow10 (max);
  506. }
  507. /* Convert integer part */
  508. do {
  509. iconvert[iplace++] =
  510. (caps ? "0123456789ABCDEF" : "0123456789abcdef")
  511. [intpart % 10];
  512. intpart = (intpart / 10);
  513. } while(intpart && (iplace < 20));
  514. if (iplace == 20)
  515. iplace--;
  516. iconvert[iplace] = 0;
  517. /* Convert fractional part */
  518. do {
  519. fconvert[fplace++] =
  520. (caps ? "0123456789ABCDEF" : "0123456789abcdef")
  521. [fracpart % 10];
  522. fracpart = (fracpart / 10);
  523. } while(fracpart && (fplace < 20));
  524. if (fplace == 20)
  525. fplace--;
  526. fconvert[fplace] = 0;
  527. /* -1 for decimal point, another -1 if we are printing a sign */
  528. padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
  529. zpadlen = max - fplace;
  530. if (zpadlen < 0)
  531. zpadlen = 0;
  532. if (padlen < 0)
  533. padlen = 0;
  534. if (flags & DP_F_MINUS)
  535. padlen = -padlen; /* Left Justifty */
  536. if ((flags & DP_F_ZERO) && (padlen > 0)) {
  537. if (signvalue) {
  538. dopr_outch(buffer, currlen, maxlen, signvalue);
  539. --padlen;
  540. signvalue = 0;
  541. }
  542. while (padlen > 0) {
  543. dopr_outch(buffer, currlen, maxlen, '0');
  544. --padlen;
  545. }
  546. }
  547. while (padlen > 0) {
  548. dopr_outch(buffer, currlen, maxlen, ' ');
  549. --padlen;
  550. }
  551. if (signvalue)
  552. dopr_outch(buffer, currlen, maxlen, signvalue);
  553. while (iplace > 0)
  554. dopr_outch(buffer, currlen, maxlen, iconvert[--iplace]);
  555. /*
  556. * Decimal point. This should probably use locale to find the
  557. * correct char to print out.
  558. */
  559. dopr_outch(buffer, currlen, maxlen, '.');
  560. while (fplace > 0)
  561. dopr_outch(buffer, currlen, maxlen, fconvert[--fplace]);
  562. while (zpadlen > 0) {
  563. dopr_outch(buffer, currlen, maxlen, '0');
  564. --zpadlen;
  565. }
  566. while (padlen < 0) {
  567. dopr_outch(buffer, currlen, maxlen, ' ');
  568. ++padlen;
  569. }
  570. }
  571. inline static void
  572. dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c)
  573. {
  574. if (*currlen < maxlen)
  575. buffer[(*currlen)++] = c;
  576. }
  577. #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
  578. #ifndef HAVE_VSNPRINTF
  579. int
  580. egg_vsnprintf(char *str, size_t count, const char *fmt, va_list args)
  581. {
  582. str[0] = 0;
  583. dopr(str, count, fmt, args);
  584. return(strlen(str));
  585. }
  586. #endif /* !HAVE_VSNPRINTF */
  587. #ifndef HAVE_SNPRINTF
  588. int
  589. egg_snprintf(char *str,size_t count,const char *fmt, ...)
  590. {
  591. va_list ap;
  592. va_start(ap, fmt);
  593. (void) vsnprintf(str, count, fmt, ap);
  594. va_end(ap);
  595. return(strlen(str));
  596. }
  597. #endif /* !HAVE_SNPRINTF */