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