Shorten zalloc()'s description to the part that makes sense (to me)
[privoxy.git] / miscutil.c
1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.68 2011/09/04 11:10:56 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.c,v $
5  *
6  * Purpose     :  zalloc, hash_string, strcmpic, strncmpic, and
7  *                MinGW32 strdup functions.  These are each too small
8  *                to deserve their own file but don't really fit in
9  *                any other file.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2011 the
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
18  *                The timegm replacement function was taken from GnuPG,
19  *                Copyright (C) 2004 Free Software Foundation, Inc.
20  *
21  *                The snprintf replacement function is written by
22  *                Mark Martinec who also holds the copyright. It can be
23  *                used under the terms of the GPL or the terms of the
24  *                "Frontier Artistic License".
25  *
26  *                This program is free software; you can redistribute it
27  *                and/or modify it under the terms of the GNU General
28  *                Public License as published by the Free Software
29  *                Foundation; either version 2 of the License, or (at
30  *                your option) any later version.
31  *
32  *                This program is distributed in the hope that it will
33  *                be useful, but WITHOUT ANY WARRANTY; without even the
34  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
35  *                PARTICULAR PURPOSE.  See the GNU General Public
36  *                License for more details.
37  *
38  *                The GNU General Public License should be included with
39  *                this file.  If not, you can view it at
40  *                http://www.gnu.org/copyleft/gpl.html
41  *                or write to the Free Software Foundation, Inc., 59
42  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
43  *
44  *********************************************************************/
45
46
47 #include "config.h"
48
49 #include <stdio.h>
50 #include <sys/types.h>
51 #include <stdlib.h>
52 #if !defined(_WIN32) && !defined(__OS2__)
53 #include <unistd.h>
54 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
55 #include <string.h>
56 #include <ctype.h>
57 #include <assert.h>
58
59 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
60 #include <time.h>
61 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
62
63 #include "project.h"
64 #include "miscutil.h"
65 #include "errlog.h"
66 #include "jcc.h"
67
68 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
69
70 /*********************************************************************
71  *
72  * Function    :  zalloc
73  *
74  * Description :  Malloc some memory and set it to '\0'.
75  *
76  * Parameters  :
77  *          1  :  size = Size of memory chunk to return.
78  *
79  * Returns     :  Pointer to newly malloc'd memory chunk.
80  *
81  *********************************************************************/
82 void *zalloc(size_t size)
83 {
84    void * ret;
85
86    if ((ret = (void *)malloc(size)) != NULL)
87    {
88       memset(ret, 0, size);
89    }
90
91    return(ret);
92
93 }
94
95
96 #if defined(unix)
97 /*********************************************************************
98  *
99  * Function    :  write_pid_file
100  *
101  * Description :  Writes a pid file with the pid of the main process
102  *
103  * Parameters  :  None
104  *
105  * Returns     :  N/A
106  *
107  *********************************************************************/
108 void write_pid_file(void)
109 {
110    FILE   *fp;
111
112    /*
113     * If no --pidfile option was given,
114     * we can live without one.
115     */
116    if (pidfile == NULL) return;
117
118    if ((fp = fopen(pidfile, "w")) == NULL)
119    {
120       log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
121    }
122    else
123    {
124       fprintf(fp, "%u\n", (unsigned int) getpid());
125       fclose (fp);
126    }
127    return;
128
129 }
130 #endif /* def unix */
131
132
133 /*********************************************************************
134  *
135  * Function    :  hash_string
136  *
137  * Description :  Take a string and compute a (hopefuly) unique numeric
138  *                integer value.  This has several uses, but being able
139  *                to "switch" a string the one of my favorites.
140  *
141  * Parameters  :
142  *          1  :  s : string to be hashed.
143  *
144  * Returns     :  an unsigned long variable with the hashed value.
145  *
146  *********************************************************************/
147 unsigned int hash_string( const char* s )
148 {
149    unsigned int h = 0;
150
151    for ( ; *s; ++s )
152    {
153       h = 5 * h + (unsigned int)*s;
154    }
155
156    return (h);
157
158 }
159
160
161 /*********************************************************************
162  *
163  * Function    :  strcmpic
164  *
165  * Description :  Case insensitive string comparison
166  *
167  * Parameters  :
168  *          1  :  s1 = string 1 to compare
169  *          2  :  s2 = string 2 to compare
170  *
171  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
172  *
173  *********************************************************************/
174 int strcmpic(const char *s1, const char *s2)
175 {
176    if (!s1) s1 = "";
177    if (!s2) s2 = "";
178
179    while (*s1 && *s2)
180    {
181       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
182       {
183          break;
184       }
185       s1++, s2++;
186    }
187    return(ijb_tolower(*s1) - ijb_tolower(*s2));
188
189 }
190
191
192 /*********************************************************************
193  *
194  * Function    :  strncmpic
195  *
196  * Description :  Case insensitive string comparison (up to n characters)
197  *
198  * Parameters  :
199  *          1  :  s1 = string 1 to compare
200  *          2  :  s2 = string 2 to compare
201  *          3  :  n = maximum characters to compare
202  *
203  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
204  *
205  *********************************************************************/
206 int strncmpic(const char *s1, const char *s2, size_t n)
207 {
208    if (n <= (size_t)0) return(0);
209    if (!s1) s1 = "";
210    if (!s2) s2 = "";
211
212    while (*s1 && *s2)
213    {
214       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
215       {
216          break;
217       }
218
219       if (--n <= (size_t)0) break;
220
221       s1++, s2++;
222    }
223    return(ijb_tolower(*s1) - ijb_tolower(*s2));
224
225 }
226
227
228 /*********************************************************************
229  *
230  * Function    :  chomp
231  *
232  * Description :  In-situ-eliminate all leading and trailing whitespace
233  *                from a string.
234  *
235  * Parameters  :
236  *          1  :  s : string to be chomped.
237  *
238  * Returns     :  chomped string
239  *
240  *********************************************************************/
241 char *chomp(char *string)
242 {
243    char *p, *q, *r;
244
245    /*
246     * strip trailing whitespace
247     */
248    p = string + strlen(string);
249    while (p > string && ijb_isspace(*(p-1)))
250    {
251       p--;
252    }
253    *p = '\0';
254
255    /*
256     * find end of leading whitespace
257     */
258    q = r = string;
259    while (*q && ijb_isspace(*q))
260    {
261       q++;
262    }
263
264    /*
265     * if there was any, move the rest forwards
266     */
267    if (q != string)
268    {
269       while (q <= p)
270       {
271          *r++ = *q++;
272       }
273    }
274
275    return(string);
276
277 }
278
279
280 /*********************************************************************
281  *
282  * Function    :  string_append
283  *
284  * Description :  Reallocate target_string and append text to it.
285  *                This makes it easier to append to malloc'd strings.
286  *                This is similar to the (removed) strsav(), but
287  *                running out of memory isn't catastrophic.
288  *
289  *                Programming style:
290  *
291  *                The following style provides sufficient error
292  *                checking for this routine, with minimal clutter
293  *                in the source code.  It is recommended if you
294  *                have many calls to this function:
295  *
296  *                char * s = strdup(...); // don't check for error
297  *                string_append(&s, ...);  // don't check for error
298  *                string_append(&s, ...);  // don't check for error
299  *                string_append(&s, ...);  // don't check for error
300  *                if (NULL == s) { ... handle error ... }
301  *
302  *                OR, equivalently:
303  *
304  *                char * s = strdup(...); // don't check for error
305  *                string_append(&s, ...);  // don't check for error
306  *                string_append(&s, ...);  // don't check for error
307  *                if (string_append(&s, ...)) {... handle error ...}
308  *
309  * Parameters  :
310  *          1  :  target_string = Pointer to old text that is to be
311  *                extended.  *target_string will be free()d by this
312  *                routine.  target_string must be non-NULL.
313  *                If *target_string is NULL, this routine will
314  *                do nothing and return with an error - this allows
315  *                you to make many calls to this routine and only
316  *                check for errors after the last one.
317  *          2  :  text_to_append = Text to be appended to old.
318  *                Must not be NULL.
319  *
320  * Returns     :  JB_ERR_OK on success, and sets *target_string
321  *                   to newly malloc'ed appended string.  Caller
322  *                   must free(*target_string).
323  *                JB_ERR_MEMORY on out-of-memory.  (And free()s
324  *                   *target_string and sets it to NULL).
325  *                JB_ERR_MEMORY if *target_string is NULL.
326  *
327  *********************************************************************/
328 jb_err string_append(char **target_string, const char *text_to_append)
329 {
330    size_t old_len;
331    char *new_string;
332    size_t new_size;
333
334    assert(target_string);
335    assert(text_to_append);
336
337    if (*target_string == NULL)
338    {
339       return JB_ERR_MEMORY;
340    }
341
342    if (*text_to_append == '\0')
343    {
344       return JB_ERR_OK;
345    }
346
347    old_len = strlen(*target_string);
348
349    new_size = strlen(text_to_append) + old_len + 1;
350
351    if (NULL == (new_string = realloc(*target_string, new_size)))
352    {
353       free(*target_string);
354
355       *target_string = NULL;
356       return JB_ERR_MEMORY;
357    }
358
359    strlcpy(new_string + old_len, text_to_append, new_size - old_len);
360
361    *target_string = new_string;
362    return JB_ERR_OK;
363 }
364
365
366 /*********************************************************************
367  *
368  * Function    :  string_join
369  *
370  * Description :  Join two strings together.  Frees BOTH the original
371  *                strings.  If either or both input strings are NULL,
372  *                fails as if it had run out of memory.
373  *
374  *                For comparison, string_append requires that the
375  *                second string is non-NULL, and doesn't free it.
376  *
377  *                Rationale: Too often, we want to do
378  *                string_append(s, html_encode(s2)).  That assert()s
379  *                if s2 is NULL or if html_encode() runs out of memory.
380  *                It also leaks memory.  Proper checking is cumbersome.
381  *                The solution: string_join(s, html_encode(s2)) is safe,
382  *                and will free the memory allocated by html_encode().
383  *
384  * Parameters  :
385  *          1  :  target_string = Pointer to old text that is to be
386  *                extended.  *target_string will be free()d by this
387  *                routine.  target_string must be non-NULL.
388  *          2  :  text_to_append = Text to be appended to old.
389  *
390  * Returns     :  JB_ERR_OK on success, and sets *target_string
391  *                   to newly malloc'ed appended string.  Caller
392  *                   must free(*target_string).
393  *                JB_ERR_MEMORY on out-of-memory, or if
394  *                   *target_string or text_to_append is NULL.  (In
395  *                   this case, frees *target_string and text_to_append,
396  *                   sets *target_string to NULL).
397  *
398  *********************************************************************/
399 jb_err string_join(char **target_string, char *text_to_append)
400 {
401    jb_err err;
402
403    assert(target_string);
404
405    if (text_to_append == NULL)
406    {
407       freez(*target_string);
408       return JB_ERR_MEMORY;
409    }
410
411    err = string_append(target_string, text_to_append);
412
413    freez(text_to_append);
414
415    return err;
416 }
417
418
419 /*********************************************************************
420  *
421  * Function    :  string_toupper
422  *
423  * Description :  Produce a copy of string with all convertible
424  *                characters converted to uppercase.
425  *
426  * Parameters  :
427  *          1  :  string = string to convert
428  *
429  * Returns     :  Uppercase copy of string if possible,
430  *                NULL on out-of-memory or if string was NULL.
431  *
432  *********************************************************************/
433 char *string_toupper(const char *string)
434 {
435    char *result, *p;
436    const char *q;
437
438    if (!string || ((result = (char *) zalloc(strlen(string) + 1)) == NULL))
439    {
440       return NULL;
441    }
442
443    q = string;
444    p = result;
445
446    while (*q != '\0')
447    {
448       *p++ = (char)toupper((int) *q++);
449    }
450
451    return result;
452
453 }
454
455
456 /*********************************************************************
457  *
458  * Function    :  bindup
459  *
460  * Description :  Duplicate the first n characters of a string that may
461  *                contain '\0' characters.
462  *
463  * Parameters  :
464  *          1  :  string = string to be duplicated
465  *          2  :  len = number of bytes to duplicate
466  *
467  * Returns     :  pointer to copy, or NULL if failiure
468  *
469  *********************************************************************/
470 char *bindup(const char *string, size_t len)
471 {
472    char *duplicate;
473
474    if (NULL == (duplicate = (char *)malloc(len)))
475    {
476       return NULL;
477    }
478    else
479    {
480      memcpy(duplicate, string, len);
481    }
482
483    return duplicate;
484
485 }
486
487
488 /*********************************************************************
489  *
490  * Function    :  make_path
491  *
492  * Description :  Takes a directory name and a file name, returns
493  *                the complete path.  Handles windows/unix differences.
494  *                If the file name is already an absolute path, or if
495  *                the directory name is NULL or empty, it returns
496  *                the filename.
497  *
498  * Parameters  :
499  *          1  :  dir: Name of directory or NULL for none.
500  *          2  :  file: Name of file.  Should not be NULL or empty.
501  *
502  * Returns     :  "dir/file" (Or on windows, "dir\file").
503  *                It allocates the string on the heap.  Caller frees.
504  *                Returns NULL in error (i.e. NULL file or out of
505  *                memory)
506  *
507  *********************************************************************/
508 char * make_path(const char * dir, const char * file)
509 {
510 #ifdef AMIGA
511    char path[512];
512
513    if(dir)
514    {
515       if(dir[0] == '.')
516       {
517          if(dir[1] == '/')
518          {
519             strncpy(path,dir+2,512);
520          }
521          else
522          {
523             strncpy(path,dir+1,512);
524          }
525       }
526       else
527       {
528          strncpy(path,dir,512);
529       }
530       path[511]=0;
531    }
532    else
533    {
534       path[0]=0;
535    }
536    if(AddPart(path,file,512))
537    {
538       return strdup(path);
539    }
540    else
541    {
542       return NULL;
543    }
544 #else /* ndef AMIGA */
545
546    if ((file == NULL) || (*file == '\0'))
547    {
548       return NULL; /* Error */
549    }
550
551    if ((dir == NULL) || (*dir == '\0') /* No directory specified */
552 #if defined(_WIN32) || defined(__OS2__)
553       || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
554 #else /* ifndef _WIN32 || __OS2__ */
555       || (*file == '/') /* Absolute path (U*ix) */
556 #endif /* ifndef _WIN32 || __OS2__  */
557       )
558    {
559       return strdup(file);
560    }
561    else
562    {
563       char * path;
564       size_t path_size = strlen(dir) + strlen(file) + 2; /* +2 for trailing (back)slash and \0 */
565
566 #if defined(unix)
567       if ( *dir != '/' && basedir && *basedir )
568       {
569          /*
570           * Relative path, so start with the base directory.
571           */
572          path_size += strlen(basedir) + 1; /* +1 for the slash */
573          path = malloc(path_size);
574          if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
575          strlcpy(path, basedir, path_size);
576          strlcat(path, "/", path_size);
577          strlcat(path, dir, path_size);
578       }
579       else
580 #endif /* defined unix */
581       {
582          path = malloc(path_size);
583          if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
584          strlcpy(path, dir, path_size);
585       }
586
587       assert(NULL != path);
588 #if defined(_WIN32) || defined(__OS2__)
589       if(path[strlen(path)-1] != '\\')
590       {
591          strlcat(path, "\\", path_size);
592       }
593 #else /* ifndef _WIN32 || __OS2__ */
594       if(path[strlen(path)-1] != '/')
595       {
596          strlcat(path, "/", path_size);
597       }
598 #endif /* ifndef _WIN32 || __OS2__ */
599       strlcat(path, file, path_size);
600
601       return path;
602    }
603 #endif /* ndef AMIGA */
604 }
605
606
607 /*********************************************************************
608  *
609  * Function    :  pick_from_range
610  *
611  * Description :  Pick a positive number out of a given range.
612  *                Should only be used if randomness would be nice,
613  *                but isn't really necessary.
614  *
615  * Parameters  :
616  *          1  :  range: Highest possible number to pick.
617  *
618  * Returns     :  Picked number.
619  *
620  *********************************************************************/
621 long int pick_from_range(long int range)
622 {
623    long int number;
624 #ifdef _WIN32
625    static unsigned long seed = 0;
626 #endif /* def _WIN32 */
627
628    assert(range != 0);
629    assert(range > 0);
630
631    if (range <= 0) return 0;
632
633 #ifdef HAVE_RANDOM
634    number = random() % range + 1;
635 #elif defined(MUTEX_LOCKS_AVAILABLE)
636    privoxy_mutex_lock(&rand_mutex);
637 #ifdef _WIN32
638    if (!seed)
639    {
640       seed = (unsigned long)(GetCurrentThreadId()+GetTickCount());
641    }
642    srand(seed);
643    seed = (unsigned long)((rand() << 16) + rand());
644 #endif /* def _WIN32 */
645    number = (unsigned long)((rand() << 16) + (rand())) % (unsigned long)(range + 1);
646    privoxy_mutex_unlock(&rand_mutex);
647 #else
648    /*
649     * XXX: Which platforms reach this and are there
650     * better options than just using rand() and hoping
651     * that it's safe?
652     */
653    log_error(LOG_LEVEL_INFO, "No thread-safe PRNG available? Header time randomization "
654       "might cause crashes, predictable results or even combine these fine options.");
655    number = rand() % (long int)(range + 1);
656
657 #endif /* (def HAVE_RANDOM) */
658
659    return number;
660 }
661
662
663 #ifdef USE_PRIVOXY_STRLCPY
664 /*********************************************************************
665  *
666  * Function    :  privoxy_strlcpy
667  *
668  * Description :  strlcpy(3) look-alike for those without decent libc.
669  *
670  * Parameters  :
671  *          1  :  destination: buffer to copy into.
672  *          2  :  source: String to copy.
673  *          3  :  size: Size of destination buffer.
674  *
675  * Returns     :  The length of the string that privoxy_strlcpy() tried to create.
676  *
677  *********************************************************************/
678 size_t privoxy_strlcpy(char *destination, const char *source, const size_t size)
679 {
680    if (0 < size)
681    {
682       snprintf(destination, size, "%s", source);
683       /*
684        * Platforms that lack strlcpy() also tend to have
685        * a broken snprintf implementation that doesn't
686        * guarantee nul termination.
687        *
688        * XXX: the configure script should detect and reject those.
689        */
690       destination[size-1] = '\0';
691    }
692    return strlen(source);
693 }
694 #endif /* def USE_PRIVOXY_STRLCPY */
695
696
697 #ifndef HAVE_STRLCAT
698 /*********************************************************************
699  *
700  * Function    :  privoxy_strlcat
701  *
702  * Description :  strlcat(3) look-alike for those without decent libc.
703  *
704  * Parameters  :
705  *          1  :  destination: C string.
706  *          2  :  source: String to copy.
707  *          3  :  size: Size of destination buffer.
708  *
709  * Returns     :  The length of the string that privoxy_strlcat() tried to create.
710  *
711  *********************************************************************/
712 size_t privoxy_strlcat(char *destination, const char *source, const size_t size)
713 {
714    const size_t old_length = strlen(destination);
715    return old_length + strlcpy(destination + old_length, source, size - old_length);
716 }
717 #endif /* ndef HAVE_STRLCAT */
718
719
720 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
721 /*********************************************************************
722  *
723  * Function    :  timegm
724  *
725  * Description :  libc replacement function for the inverse of gmtime().
726  *                Copyright (C) 2004 Free Software Foundation, Inc.
727  *
728  *                Code originally copied from GnuPG, modifications done
729  *                for Privoxy: style changed, #ifdefs for _WIN32 added
730  *                to have it work on mingw32.
731  *
732  *                XXX: It's very unlikely to happen, but if the malloc()
733  *                call fails the time zone will be permanently set to UTC.
734  *
735  * Parameters  :
736  *          1  :  tm: Broken-down time struct.
737  *
738  * Returns     :  tm converted into time_t seconds.
739  *
740  *********************************************************************/
741 time_t timegm(struct tm *tm)
742 {
743    time_t answer;
744    char *zone;
745
746    zone = getenv("TZ");
747    putenv("TZ=UTC");
748    tzset();
749    answer = mktime(tm);
750    if (zone)
751    {
752       char *old_zone;
753
754       old_zone = malloc(3 + strlen(zone) + 1);
755       if (old_zone)
756       {
757          strcpy(old_zone, "TZ=");
758          strcat(old_zone, zone);
759          putenv(old_zone);
760 #ifdef _WIN32
761          free(old_zone);
762 #endif /* def _WIN32 */
763       }
764    }
765    else
766    {
767 #ifdef HAVE_UNSETENV
768       unsetenv("TZ");
769 #elif defined(_WIN32)
770       putenv("TZ=");
771 #else
772       putenv("TZ");
773 #endif
774    }
775    tzset();
776
777    return answer;
778 }
779 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
780
781
782 #ifndef HAVE_SNPRINTF
783 /*
784  * What follows is a portable snprintf routine, written by Mark Martinec.
785  * See: http://www.ijs.si/software/snprintf/
786
787                                   snprintf.c
788                    - a portable implementation of snprintf,
789        including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
790
791    snprintf is a routine to convert numeric and string arguments to
792    formatted strings. It is similar to sprintf(3) provided in a system's
793    C library, yet it requires an additional argument - the buffer size -
794    and it guarantees never to store anything beyond the given buffer,
795    regardless of the format or arguments to be formatted. Some newer
796    operating systems do provide snprintf in their C library, but many do
797    not or do provide an inadequate (slow or idiosyncratic) version, which
798    calls for a portable implementation of this routine.
799
800 Author
801
802    Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
803    Copyright © 1999, Mark Martinec
804
805  */
806
807 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
808 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
809
810 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
811 # if defined(NEED_SNPRINTF_ONLY)
812 # undef NEED_SNPRINTF_ONLY
813 # endif
814 # if !defined(PREFER_PORTABLE_SNPRINTF)
815 # define PREFER_PORTABLE_SNPRINTF
816 # endif
817 #endif
818
819 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
820 #define SOLARIS_COMPATIBLE
821 #endif
822
823 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
824 #define HPUX_COMPATIBLE
825 #endif
826
827 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
828 #define DIGITAL_UNIX_COMPATIBLE
829 #endif
830
831 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
832 #define PERL_COMPATIBLE
833 #endif
834
835 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
836 #define LINUX_COMPATIBLE
837 #endif
838
839 #include <sys/types.h>
840 #include <string.h>
841 #include <stdlib.h>
842 #include <stdio.h>
843 #include <stdarg.h>
844 #include <assert.h>
845 #include <errno.h>
846
847 #ifdef isdigit
848 #undef isdigit
849 #endif
850 #define isdigit(c) ((c) >= '0' && (c) <= '9')
851
852 /* For copying strings longer or equal to 'breakeven_point'
853  * it is more efficient to call memcpy() than to do it inline.
854  * The value depends mostly on the processor architecture,
855  * but also on the compiler and its optimization capabilities.
856  * The value is not critical, some small value greater than zero
857  * will be just fine if you don't care to squeeze every drop
858  * of performance out of the code.
859  *
860  * Small values favor memcpy, large values favor inline code.
861  */
862 #if defined(__alpha__) || defined(__alpha)
863 #  define breakeven_point   2    /* AXP (DEC Alpha)     - gcc or cc or egcs */
864 #endif
865 #if defined(__i386__)  || defined(__i386)
866 #  define breakeven_point  12    /* Intel Pentium/Linux - gcc 2.96 */
867 #endif
868 #if defined(__hppa)
869 #  define breakeven_point  10    /* HP-PA               - gcc */
870 #endif
871 #if defined(__sparc__) || defined(__sparc)
872 #  define breakeven_point  33    /* Sun Sparc 5         - gcc 2.8.1 */
873 #endif
874
875 /* some other values of possible interest: */
876 /* #define breakeven_point  8 */ /* VAX 4000          - vaxc */
877 /* #define breakeven_point 19 */ /* VAX 4000          - gcc 2.7.0 */
878
879 #ifndef breakeven_point
880 #  define breakeven_point   6    /* some reasonable one-size-fits-all value */
881 #endif
882
883 #define fast_memcpy(d,s,n) \
884   { register size_t nn = (size_t)(n); \
885     if (nn >= breakeven_point) memcpy((d), (s), nn); \
886     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
887       register char *dd; register const char *ss; \
888       for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
889
890 #define fast_memset(d,c,n) \
891   { register size_t nn = (size_t)(n); \
892     if (nn >= breakeven_point) memset((d), (int)(c), nn); \
893     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
894       register char *dd; register const int cc=(int)(c); \
895       for (dd=(d); nn>0; nn--) *dd++ = cc; } }
896
897 /* prototypes */
898
899 #if defined(NEED_ASPRINTF)
900 int asprintf   (char **ptr, const char *fmt, /*args*/ ...);
901 #endif
902 #if defined(NEED_VASPRINTF)
903 int vasprintf  (char **ptr, const char *fmt, va_list ap);
904 #endif
905 #if defined(NEED_ASNPRINTF)
906 int asnprintf  (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
907 #endif
908 #if defined(NEED_VASNPRINTF)
909 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
910 #endif
911
912 #if defined(HAVE_SNPRINTF)
913 /* declare our portable snprintf  routine under name portable_snprintf  */
914 /* declare our portable vsnprintf routine under name portable_vsnprintf */
915 #else
916 /* declare our portable routines under names snprintf and vsnprintf */
917 #define portable_snprintf snprintf
918 #if !defined(NEED_SNPRINTF_ONLY)
919 #define portable_vsnprintf vsnprintf
920 #endif
921 #endif
922
923 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
924 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
925 #if !defined(NEED_SNPRINTF_ONLY)
926 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
927 #endif
928 #endif
929
930 /* declarations */
931
932 static char credits[] = "\n\
933 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
934 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
935 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
936
937 #if defined(NEED_ASPRINTF)
938 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
939   va_list ap;
940   size_t str_m;
941   int str_l;
942
943   *ptr = NULL;
944   va_start(ap, fmt);                            /* measure the required size */
945   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
946   va_end(ap);
947   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
948   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
949   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
950   else {
951     int str_l2;
952     va_start(ap, fmt);
953     str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
954     va_end(ap);
955     assert(str_l2 == str_l);
956   }
957   return str_l;
958 }
959 #endif
960
961 #if defined(NEED_VASPRINTF)
962 int vasprintf(char **ptr, const char *fmt, va_list ap) {
963   size_t str_m;
964   int str_l;
965
966   *ptr = NULL;
967   { va_list ap2;
968     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
969     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
970     va_end(ap2);
971   }
972   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
973   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
974   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
975   else {
976     int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
977     assert(str_l2 == str_l);
978   }
979   return str_l;
980 }
981 #endif
982
983 #if defined(NEED_ASNPRINTF)
984 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
985   va_list ap;
986   int str_l;
987
988   *ptr = NULL;
989   va_start(ap, fmt);                            /* measure the required size */
990   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
991   va_end(ap);
992   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
993   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
994   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
995   if (str_m == 0) {  /* not interested in resulting string, just return size */
996   } else {
997     *ptr = (char *) malloc(str_m);
998     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
999     else {
1000       int str_l2;
1001       va_start(ap, fmt);
1002       str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1003       va_end(ap);
1004       assert(str_l2 == str_l);
1005     }
1006   }
1007   return str_l;
1008 }
1009 #endif
1010
1011 #if defined(NEED_VASNPRINTF)
1012 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1013   int str_l;
1014
1015   *ptr = NULL;
1016   { va_list ap2;
1017     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
1018     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1019     va_end(ap2);
1020   }
1021   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1022   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
1023   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1024   if (str_m == 0) {  /* not interested in resulting string, just return size */
1025   } else {
1026     *ptr = (char *) malloc(str_m);
1027     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1028     else {
1029       int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1030       assert(str_l2 == str_l);
1031     }
1032   }
1033   return str_l;
1034 }
1035 #endif
1036
1037 /*
1038  * If the system does have snprintf and the portable routine is not
1039  * specifically required, this module produces no code for snprintf/vsnprintf.
1040  */
1041 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1042
1043 #if !defined(NEED_SNPRINTF_ONLY)
1044 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1045   va_list ap;
1046   int str_l;
1047
1048   va_start(ap, fmt);
1049   str_l = portable_vsnprintf(str, str_m, fmt, ap);
1050   va_end(ap);
1051   return str_l;
1052 }
1053 #endif
1054
1055 #if defined(NEED_SNPRINTF_ONLY)
1056 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1057 #else
1058 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1059 #endif
1060
1061 #if defined(NEED_SNPRINTF_ONLY)
1062   va_list ap;
1063 #endif
1064   size_t str_l = 0;
1065   const char *p = fmt;
1066
1067 /* In contrast with POSIX, the ISO C99 now says
1068  * that str can be NULL and str_m can be 0.
1069  * This is more useful than the old:  if (str_m < 1) return -1; */
1070
1071 #if defined(NEED_SNPRINTF_ONLY)
1072   va_start(ap, fmt);
1073 #endif
1074   if (!p) p = "";
1075   while (*p) {
1076     if (*p != '%') {
1077    /* if (str_l < str_m) str[str_l++] = *p++;    -- this would be sufficient */
1078    /* but the following code achieves better performance for cases
1079     * where format string is long and contains few conversions */
1080       const char *q = strchr(p+1,'%');
1081       size_t n = !q ? strlen(p) : (q-p);
1082       if (str_l < str_m) {
1083         size_t avail = str_m-str_l;
1084         fast_memcpy(str+str_l, p, (n>avail?avail:n));
1085       }
1086       p += n; str_l += n;
1087     } else {
1088       const char *starting_p;
1089       size_t min_field_width = 0, precision = 0;
1090       int zero_padding = 0, precision_specified = 0, justify_left = 0;
1091       int alternate_form = 0, force_sign = 0;
1092       int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1093                                      the ' ' flag should be ignored. */
1094       char length_modifier = '\0';            /* allowed values: \0, h, l, L */
1095       char tmp[32];/* temporary buffer for simple numeric->string conversion */
1096
1097       const char *str_arg;      /* string address in case of string argument */
1098       size_t str_arg_l;         /* natural field width of arg without padding
1099                                    and sign */
1100       unsigned char uchar_arg;
1101         /* unsigned char argument value - only defined for c conversion.
1102            N.B. standard explicitly states the char argument for
1103            the c conversion is unsigned */
1104
1105       size_t number_of_zeros_to_pad = 0;
1106         /* number of zeros to be inserted for numeric conversions
1107            as required by the precision or minimal field width */
1108
1109       size_t zero_padding_insertion_ind = 0;
1110         /* index into tmp where zero padding is to be inserted */
1111
1112       char fmt_spec = '\0';
1113         /* current conversion specifier character */
1114
1115       str_arg = credits;/* just to make compiler happy (defined but not used)*/
1116       str_arg = NULL;
1117       starting_p = p; p++;  /* skip '%' */
1118    /* parse flags */
1119       while (*p == '0' || *p == '-' || *p == '+' ||
1120              *p == ' ' || *p == '#' || *p == '\'') {
1121         switch (*p) {
1122         case '0': zero_padding = 1; break;
1123         case '-': justify_left = 1; break;
1124         case '+': force_sign = 1; space_for_positive = 0; break;
1125         case ' ': force_sign = 1;
1126      /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1127 #ifdef PERL_COMPATIBLE
1128      /* ... but in Perl the last of ' ' and '+' applies */
1129                   space_for_positive = 1;
1130 #endif
1131                   break;
1132         case '#': alternate_form = 1; break;
1133         case '\'': break;
1134         }
1135         p++;
1136       }
1137    /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1138
1139    /* parse field width */
1140       if (*p == '*') {
1141         int j;
1142         p++; j = va_arg(ap, int);
1143         if (j >= 0) min_field_width = j;
1144         else { min_field_width = -j; justify_left = 1; }
1145       } else if (isdigit((int)(*p))) {
1146         /* size_t could be wider than unsigned int;
1147            make sure we treat argument like common implementations do */
1148         unsigned int uj = *p++ - '0';
1149         while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1150         min_field_width = uj;
1151       }
1152    /* parse precision */
1153       if (*p == '.') {
1154         p++; precision_specified = 1;
1155         if (*p == '*') {
1156           int j = va_arg(ap, int);
1157           p++;
1158           if (j >= 0) precision = j;
1159           else {
1160             precision_specified = 0; precision = 0;
1161          /* NOTE:
1162           *   Solaris 2.6 man page claims that in this case the precision
1163           *   should be set to 0.  Digital Unix 4.0, HPUX 10 and BSD man page
1164           *   claim that this case should be treated as unspecified precision,
1165           *   which is what we do here.
1166           */
1167           }
1168         } else if (isdigit((int)(*p))) {
1169           /* size_t could be wider than unsigned int;
1170              make sure we treat argument like common implementations do */
1171           unsigned int uj = *p++ - '0';
1172           while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1173           precision = uj;
1174         }
1175       }
1176    /* parse 'h', 'l' and 'll' length modifiers */
1177       if (*p == 'h' || *p == 'l') {
1178         length_modifier = *p; p++;
1179         if (length_modifier == 'l' && *p == 'l') {   /* double l = long long */
1180 #ifdef SNPRINTF_LONGLONG_SUPPORT
1181           length_modifier = '2';                  /* double l encoded as '2' */
1182 #else
1183           length_modifier = 'l';                 /* treat it as a single 'l' */
1184 #endif
1185           p++;
1186         }
1187       }
1188       fmt_spec = *p;
1189    /* common synonyms: */
1190       switch (fmt_spec) {
1191       case 'i': fmt_spec = 'd'; break;
1192       case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1193       case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1194       case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1195       default: break;
1196       }
1197    /* get parameter value, do initial processing */
1198       switch (fmt_spec) {
1199       case '%': /* % behaves similar to 's' regarding flags and field widths */
1200       case 'c': /* c behaves similar to 's' regarding flags and field widths */
1201       case 's':
1202         length_modifier = '\0';          /* wint_t and wchar_t not supported */
1203      /* the result of zero padding flag with non-numeric conversion specifier*/
1204      /* is undefined. Solaris and HPUX 10 does zero padding in this case,    */
1205      /* Digital Unix and Linux does not. */
1206 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1207         zero_padding = 0;    /* turn zero padding off for string conversions */
1208 #endif
1209         str_arg_l = 1;
1210         switch (fmt_spec) {
1211         case '%':
1212           str_arg = p; break;
1213         case 'c': {
1214           int j = va_arg(ap, int);
1215           uchar_arg = (unsigned char) j;   /* standard demands unsigned char */
1216           str_arg = (const char *) &uchar_arg;
1217           break;
1218         }
1219         case 's':
1220           str_arg = va_arg(ap, const char *);
1221           if (!str_arg) str_arg_l = 0;
1222        /* make sure not to address string beyond the specified precision !!! */
1223           else if (!precision_specified) str_arg_l = strlen(str_arg);
1224        /* truncate string if necessary as requested by precision */
1225           else if (precision == 0) str_arg_l = 0;
1226           else {
1227        /* memchr on HP does not like n > 2^31  !!! */
1228             const char *q = memchr(str_arg, '\0',
1229                              precision <= 0x7fffffff ? precision : 0x7fffffff);
1230             str_arg_l = !q ? precision : (q-str_arg);
1231           }
1232           break;
1233         default: break;
1234         }
1235         break;
1236       case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1237         /* NOTE: the u, o, x, X and p conversion specifiers imply
1238                  the value is unsigned;  d implies a signed value */
1239
1240         int arg_sign = 0;
1241           /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1242             +1 if greater than zero (or nonzero for unsigned arguments),
1243             -1 if negative (unsigned argument is never negative) */
1244
1245         int int_arg = 0;  unsigned int uint_arg = 0;
1246           /* only defined for length modifier h, or for no length modifiers */
1247
1248         long int long_arg = 0;  unsigned long int ulong_arg = 0;
1249           /* only defined for length modifier l */
1250
1251         void *ptr_arg = NULL;
1252           /* pointer argument value -only defined for p conversion */
1253
1254 #ifdef SNPRINTF_LONGLONG_SUPPORT
1255         long long int long_long_arg = 0;
1256         unsigned long long int ulong_long_arg = 0;
1257           /* only defined for length modifier ll */
1258 #endif
1259         if (fmt_spec == 'p') {
1260         /* HPUX 10: An l, h, ll or L before any other conversion character
1261          *   (other than d, i, u, o, x, or X) is ignored.
1262          * Digital Unix:
1263          *   not specified, but seems to behave as HPUX does.
1264          * Solaris: If an h, l, or L appears before any other conversion
1265          *   specifier (other than d, i, u, o, x, or X), the behavior
1266          *   is undefined. (Actually %hp converts only 16-bits of address
1267          *   and %llp treats address as 64-bit data which is incompatible
1268          *   with (void *) argument on a 32-bit system).
1269          */
1270 #ifdef SOLARIS_COMPATIBLE
1271 #  ifdef SOLARIS_BUG_COMPATIBLE
1272           /* keep length modifiers even if it represents 'll' */
1273 #  else
1274           if (length_modifier == '2') length_modifier = '\0';
1275 #  endif
1276 #else
1277           length_modifier = '\0';
1278 #endif
1279           ptr_arg = va_arg(ap, void *);
1280           if (ptr_arg != NULL) arg_sign = 1;
1281         } else if (fmt_spec == 'd') {  /* signed */
1282           switch (length_modifier) {
1283           case '\0':
1284           case 'h':
1285          /* It is non-portable to specify a second argument of char or short
1286           * to va_arg, because arguments seen by the called function
1287           * are not char or short.  C converts char and short arguments
1288           * to int before passing them to a function.
1289           */
1290             int_arg = va_arg(ap, int);
1291             if      (int_arg > 0) arg_sign =  1;
1292             else if (int_arg < 0) arg_sign = -1;
1293             break;
1294           case 'l':
1295             long_arg = va_arg(ap, long int);
1296             if      (long_arg > 0) arg_sign =  1;
1297             else if (long_arg < 0) arg_sign = -1;
1298             break;
1299 #ifdef SNPRINTF_LONGLONG_SUPPORT
1300           case '2':
1301             long_long_arg = va_arg(ap, long long int);
1302             if      (long_long_arg > 0) arg_sign =  1;
1303             else if (long_long_arg < 0) arg_sign = -1;
1304             break;
1305 #endif
1306           }
1307         } else {  /* unsigned */
1308           switch (length_modifier) {
1309           case '\0':
1310           case 'h':
1311             uint_arg = va_arg(ap, unsigned int);
1312             if (uint_arg) arg_sign = 1;
1313             break;
1314           case 'l':
1315             ulong_arg = va_arg(ap, unsigned long int);
1316             if (ulong_arg) arg_sign = 1;
1317             break;
1318 #ifdef SNPRINTF_LONGLONG_SUPPORT
1319           case '2':
1320             ulong_long_arg = va_arg(ap, unsigned long long int);
1321             if (ulong_long_arg) arg_sign = 1;
1322             break;
1323 #endif
1324           }
1325         }
1326         str_arg = tmp; str_arg_l = 0;
1327      /* NOTE:
1328       *   For d, i, u, o, x, and X conversions, if precision is specified,
1329       *   the '0' flag should be ignored. This is so with Solaris 2.6,
1330       *   Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1331       */
1332 #ifndef PERL_COMPATIBLE
1333         if (precision_specified) zero_padding = 0;
1334 #endif
1335         if (fmt_spec == 'd') {
1336           if (force_sign && arg_sign >= 0)
1337             tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1338          /* leave negative numbers for sprintf to handle,
1339             to avoid handling tricky cases like (short int)(-32768) */
1340 #ifdef LINUX_COMPATIBLE
1341         } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1342           tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1343 #endif
1344         } else if (alternate_form) {
1345           if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1346             { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1347          /* alternate form should have no effect for p conversion, but ... */
1348 #ifdef HPUX_COMPATIBLE
1349           else if (fmt_spec == 'p'
1350          /* HPUX 10: for an alternate form of p conversion,
1351           *          a nonzero result is prefixed by 0x. */
1352 #ifndef HPUX_BUG_COMPATIBLE
1353          /* Actually it uses 0x prefix even for a zero value. */
1354                    && arg_sign != 0
1355 #endif
1356                   ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1357 #endif
1358         }
1359         zero_padding_insertion_ind = str_arg_l;
1360         if (!precision_specified) precision = 1;   /* default precision is 1 */
1361         if (precision == 0 && arg_sign == 0
1362 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1363             && fmt_spec != 'p'
1364          /* HPUX 10 man page claims: With conversion character p the result of
1365           * converting a zero value with a precision of zero is a null string.
1366           * Actually HP returns all zeroes, and Linux returns "(nil)". */
1367 #endif
1368         ) {
1369          /* converted to null string */
1370          /* When zero value is formatted with an explicit precision 0,
1371             the resulting formatted string is empty (d, i, u, o, x, X, p).   */
1372         } else {
1373           char f[5]; int f_l = 0;
1374           f[f_l++] = '%';    /* construct a simple format string for sprintf */
1375           if (!length_modifier) { }
1376           else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1377           else f[f_l++] = length_modifier;
1378           f[f_l++] = fmt_spec; f[f_l++] = '\0';
1379           if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1380           else if (fmt_spec == 'd') {  /* signed */
1381             switch (length_modifier) {
1382             case '\0':
1383             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg);  break;
1384             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1385 #ifdef SNPRINTF_LONGLONG_SUPPORT
1386             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1387 #endif
1388             }
1389           } else {  /* unsigned */
1390             switch (length_modifier) {
1391             case '\0':
1392             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg);  break;
1393             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1394 #ifdef SNPRINTF_LONGLONG_SUPPORT
1395             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1396 #endif
1397             }
1398           }
1399          /* include the optional minus sign and possible "0x"
1400             in the region before the zero padding insertion point */
1401           if (zero_padding_insertion_ind < str_arg_l &&
1402               tmp[zero_padding_insertion_ind] == '-') {
1403             zero_padding_insertion_ind++;
1404           }
1405           if (zero_padding_insertion_ind+1 < str_arg_l &&
1406               tmp[zero_padding_insertion_ind]   == '0' &&
1407              (tmp[zero_padding_insertion_ind+1] == 'x' ||
1408               tmp[zero_padding_insertion_ind+1] == 'X') ) {
1409             zero_padding_insertion_ind += 2;
1410           }
1411         }
1412         { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1413           if (alternate_form && fmt_spec == 'o'
1414 #ifdef HPUX_COMPATIBLE                                  /* ("%#.o",0) -> ""  */
1415               && (str_arg_l > 0)
1416 #endif
1417 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE                      /* ("%#o",0) -> "00" */
1418 #else
1419               /* unless zero is already the first character */
1420               && !(zero_padding_insertion_ind < str_arg_l
1421                    && tmp[zero_padding_insertion_ind] == '0')
1422 #endif
1423           ) {        /* assure leading zero for alternate-form octal numbers */
1424             if (!precision_specified || precision < num_of_digits+1) {
1425              /* precision is increased to force the first character to be zero,
1426                 except if a zero value is formatted with an explicit precision
1427                 of zero */
1428               precision = num_of_digits+1; precision_specified = 1;
1429             }
1430           }
1431        /* zero padding to specified precision? */
1432           if (num_of_digits < precision)
1433             number_of_zeros_to_pad = precision - num_of_digits;
1434         }
1435      /* zero padding to specified minimal field width? */
1436         if (!justify_left && zero_padding) {
1437           int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1438           if (n > 0) number_of_zeros_to_pad += n;
1439         }
1440         break;
1441       }
1442       default: /* unrecognized conversion specifier, keep format string as-is*/
1443         zero_padding = 0;  /* turn zero padding off for non-numeric convers. */
1444 #ifndef DIGITAL_UNIX_COMPATIBLE
1445         justify_left = 1; min_field_width = 0;                /* reset flags */
1446 #endif
1447 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1448      /* keep the entire format string unchanged */
1449         str_arg = starting_p; str_arg_l = p - starting_p;
1450      /* well, not exactly so for Linux, which does something between,
1451       * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y"  */
1452 #else
1453      /* discard the unrecognized conversion, just keep *
1454       * the unrecognized conversion character          */
1455         str_arg = p; str_arg_l = 0;
1456 #endif
1457         if (*p) str_arg_l++;  /* include invalid conversion specifier unchanged
1458                                  if not at end-of-string */
1459         break;
1460       }
1461       if (*p) p++;      /* step over the just processed conversion specifier */
1462    /* insert padding to the left as requested by min_field_width;
1463       this does not include the zero padding in case of numerical conversions*/
1464       if (!justify_left) {                /* left padding with blank or zero */
1465         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1466         if (n > 0) {
1467           if (str_l < str_m) {
1468             size_t avail = str_m-str_l;
1469             fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1470           }
1471           str_l += n;
1472         }
1473       }
1474    /* zero padding as requested by the precision or by the minimal field width
1475     * for numeric conversions required? */
1476       if (number_of_zeros_to_pad <= 0) {
1477      /* will not copy first part of numeric right now, *
1478       * force it to be copied later in its entirety    */
1479         zero_padding_insertion_ind = 0;
1480       } else {
1481      /* insert first part of numerics (sign or '0x') before zero padding */
1482         int n = zero_padding_insertion_ind;
1483         if (n > 0) {
1484           if (str_l < str_m) {
1485             size_t avail = str_m-str_l;
1486             fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1487           }
1488           str_l += n;
1489         }
1490      /* insert zero padding as requested by the precision or min field width */
1491         n = number_of_zeros_to_pad;
1492         if (n > 0) {
1493           if (str_l < str_m) {
1494             size_t avail = str_m-str_l;
1495             fast_memset(str+str_l, '0', (n>avail?avail:n));
1496           }
1497           str_l += n;
1498         }
1499       }
1500    /* insert formatted string
1501     * (or as-is conversion specifier for unknown conversions) */
1502       { int n = str_arg_l - zero_padding_insertion_ind;
1503         if (n > 0) {
1504           if (str_l < str_m) {
1505             size_t avail = str_m-str_l;
1506             fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1507                         (n>avail?avail:n));
1508           }
1509           str_l += n;
1510         }
1511       }
1512    /* insert right padding */
1513       if (justify_left) {          /* right blank padding to the field width */
1514         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1515         if (n > 0) {
1516           if (str_l < str_m) {
1517             size_t avail = str_m-str_l;
1518             fast_memset(str+str_l, ' ', (n>avail?avail:n));
1519           }
1520           str_l += n;
1521         }
1522       }
1523     }
1524   }
1525 #if defined(NEED_SNPRINTF_ONLY)
1526   va_end(ap);
1527 #endif
1528   if (str_m > 0) { /* make sure the string is null-terminated
1529                       even at the expense of overwriting the last character
1530                       (shouldn't happen, but just in case) */
1531     str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1532   }
1533   /* Return the number of characters formatted (excluding trailing null
1534    * character), that is, the number of characters that would have been
1535    * written to the buffer if it were large enough.
1536    *
1537    * The value of str_l should be returned, but str_l is of unsigned type
1538    * size_t, and snprintf is int, possibly leading to an undetected
1539    * integer overflow, resulting in a negative return value, which is illegal.
1540    * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1541    * Should errno be set to EOVERFLOW and EOF returned in this case???
1542    */
1543   return (int) str_l;
1544 }
1545 #endif
1546 #endif /* ndef HAVE_SNPRINTF */
1547 /*
1548   Local Variables:
1549   tab-width: 3
1550   end:
1551 */