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