snprintf.c 16 KB

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