1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.30 2002/03/04 18:27:42 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/miscutil.c,v $
6 * Purpose : zalloc, hash_string, safe_strerror, strcmpic,
7 * strncmpic, chomp, and MinGW32 strdup
9 * These are each too small to deserve their own file
10 * but don't really fit in any other file.
12 * Copyright : Written by and Copyright (C) 2001 the SourceForge
13 * IJBSWA team. http://ijbswa.sourceforge.net
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
38 * $Log: miscutil.c,v $
39 * Revision 1.30 2002/03/04 18:27:42 oes
40 * - Deleted deletePidFile
41 * - Made write_pid_file use the --pidfile option value
42 * (or no PID file, if the option was absent)
43 * - Played styleguide police
45 * Revision 1.29 2002/03/04 02:08:02 david__schmidt
46 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
48 * Revision 1.28 2002/03/03 09:18:03 joergs
49 * Made jumbjuster work on AmigaOS again.
51 * Revision 1.27 2002/01/21 00:52:32 jongfoster
52 * Adding string_join()
54 * Revision 1.26 2001/12/30 14:07:32 steudten
55 * - Add signal handling (unix)
56 * - Add SIGHUP handler (unix)
57 * - Add creation of pidfile (unix)
58 * - Add action 'top' in rc file (RH)
59 * - Add entry 'SIGNALS' to manpage
60 * - Add exit message to logfile (unix)
62 * Revision 1.25 2001/11/13 00:16:38 jongfoster
63 * Replacing references to malloc.h with the standard stdlib.h
64 * (See ANSI or K&R 2nd Ed)
66 * Revision 1.24 2001/11/05 21:41:43 steudten
67 * Add changes to be a real daemon just for unix os.
68 * (change cwd to /, detach from controlling tty, set
69 * process group and session leader to the own process.
71 * Add some fatal-error log message for failed malloc().
72 * Add '-d' if compiled with 'configure --with-debug' to
73 * enable debug output.
75 * Revision 1.23 2001/10/29 03:48:10 david__schmidt
76 * OS/2 native needed a snprintf() routine. Added one to miscutil, brackedted
77 * by and __OS2__ ifdef.
79 * Revision 1.22 2001/10/26 17:39:38 oes
80 * Moved ijb_isspace and ijb_tolower to project.h
82 * Revision 1.21 2001/10/23 21:27:50 jongfoster
83 * Standardising error codes in string_append
84 * make_path() no longer adds '\\' if the dir already ends in '\\' (this
85 * is just copying a UNIX-specific fix to the Windows-specific part)
87 * Revision 1.20 2001/10/22 15:33:56 david__schmidt
88 * Special-cased OS/2 out of the Netscape-abort-on-404-in-js problem in
89 * filters.c. Added a FIXME in front of the offending code. I'll gladly
90 * put in a better/more robust fix for all parties if one is presented...
91 * It seems that just returning 200 instead of 404 would pretty much fix
92 * it for everyone, but I don't know all the history of the problem.
94 * Revision 1.19 2001/10/14 22:02:57 jongfoster
95 * New function string_append() which is like strsav(), but running
96 * out of memory isn't automatically FATAL.
98 * Revision 1.18 2001/09/20 13:33:43 steudten
100 * change long to int as return value in hash_string(). Remember the wraparound
101 * for int = long = sizeof(4) - thats maybe not what we want.
103 * Revision 1.17 2001/09/13 20:51:29 jongfoster
104 * Fixing potential problems with characters >=128 in simplematch()
105 * This was also a compiler warning.
107 * Revision 1.16 2001/09/10 10:56:59 oes
108 * Silenced compiler warnings
110 * Revision 1.15 2001/07/13 14:02:24 oes
111 * Removed vim-settings
113 * Revision 1.14 2001/06/29 21:45:41 oes
114 * Indentation, CRLF->LF, Tab-> Space
116 * Revision 1.13 2001/06/29 13:32:14 oes
117 * Removed logentry from cancelled commit
119 * Revision 1.12 2001/06/09 10:55:28 jongfoster
120 * Changing BUFSIZ ==> BUFFER_SIZE
122 * Revision 1.11 2001/06/07 23:09:19 jongfoster
123 * Cosmetic indentation changes.
125 * Revision 1.10 2001/06/07 14:51:38 joergs
126 * make_path() no longer adds '/' if the dir already ends in '/'.
128 * Revision 1.9 2001/06/07 14:43:17 swa
129 * slight mistake in make_path, unix path style is /.
131 * Revision 1.8 2001/06/05 22:32:01 jongfoster
132 * New function make_path() to splice directory and file names together.
134 * Revision 1.7 2001/06/03 19:12:30 oes
135 * introduced bindup()
137 * Revision 1.6 2001/06/01 18:14:49 jongfoster
138 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
139 * in config.h if appropriate) rather than the NO_STRERR macro.
141 * Revision 1.5 2001/06/01 10:31:51 oes
142 * Added character class matching to trivimatch; renamed to simplematch
144 * Revision 1.4 2001/05/31 17:32:31 oes
146 * - Enhanced domain part globbing with infix and prefix asterisk
147 * matching and optional unanchored operation
149 * Revision 1.3 2001/05/29 23:10:09 oes
152 * - Introduced chomp()
153 * - Moved strsav() from showargs to miscutil
155 * Revision 1.2 2001/05/29 09:50:24 jongfoster
156 * Unified blocklist/imagelist/permissionslist.
157 * File format is still under discussion, but the internal changes
160 * Also modified interceptor behaviour:
161 * - We now intercept all URLs beginning with one of the following
162 * prefixes (and *only* these prefixes):
164 * * http://ijbswa.sf.net/config/
165 * * http://ijbswa.sourceforge.net/config/
166 * - New interceptors "home page" - go to http://i.j.b/ to see it.
167 * - Internal changes so that intercepted and fast redirect pages
168 * are not replaced with an image.
169 * - Interceptors now have the option to send a binary page direct
170 * to the client. (i.e. ijb-send-banner uses this)
171 * - Implemented show-url-info interceptor. (Which is why I needed
172 * the above interceptors changes - a typical URL is
173 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
174 * The previous mechanism would not have intercepted that, and
175 * if it had been intercepted then it then it would have replaced
178 * Revision 1.1.1.1 2001/05/15 13:59:00 oes
179 * Initial import of version 2.9.3 source tree
182 *********************************************************************/
188 #include <sys/types.h>
190 #if !defined(_WIN32) && !defined(__OS2__)
192 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
198 #include "miscutil.h"
202 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
204 /*********************************************************************
208 * Description : Malloc some memory and set it to '\0'.
209 * The way calloc() ought to be -acjc
212 * 1 : size = Size of memory chunk to return.
214 * Returns : Pointer to newly malloc'd memory chunk.
216 *********************************************************************/
217 void *zalloc(int size)
221 if ((ret = (void *)malloc(size)) != NULL)
223 memset(ret, 0, size);
232 /*********************************************************************
234 * Function : write_pid_file
236 * Description : Writes a pid file with the pid of the main process
242 *********************************************************************/
243 void write_pid_file(void)
248 * If no --pidfile option was given,
249 * we can live without one.
251 if (pidfile == NULL) return;
253 if ((fp = fopen(pidfile, "w")) == NULL)
255 log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
259 fprintf(fp, "%u\n", (unsigned int) getpid());
265 #endif /* def unix */
268 /*********************************************************************
270 * Function : hash_string
272 * Description : Take a string and compute a (hopefuly) unique numeric
273 * integer value. This has several uses, but being able
274 * to "switch" a string the one of my favorites.
277 * 1 : s : string to be hashed.
279 * Returns : an unsigned long variable with the hashed value.
281 *********************************************************************/
282 unsigned int hash_string( const char* s )
297 /*********************************************************************
301 * Description : For some reason (which is beyond me), gcc and WIN32
302 * don't like strdup. When a "free" is executed on a
303 * strdup'd ptr, it can at times freez up! So I just
304 * replaced it and problem was solved.
307 * 1 : s = string to duplicate
309 * Returns : Pointer to newly malloc'ed copy of the string.
311 *********************************************************************/
312 char *strdup( const char *s )
314 char * result = (char *)malloc( strlen(s)+1 );
324 #endif /* def __MINGW32__ */
328 /*********************************************************************
330 * Function : safe_strerror
332 * Description : Variant of the library routine strerror() which will
333 * work on systems without the library routine, and
334 * which should never return NULL.
337 * 1 : err = the `errno' of the last operation.
339 * Returns : An "English" string of the last `errno'. Allocated
340 * with strdup(), so caller frees. May be NULL if the
341 * system is out of memory.
343 *********************************************************************/
344 char *safe_strerror(int err)
347 char buf[BUFFER_SIZE];
352 #endif /* HAVE_STRERROR */
356 sprintf(buf, "(errno = %d)", err);
365 /*********************************************************************
367 * Function : strcmpic
369 * Description : Case insensitive string comparison
372 * 1 : s1 = string 1 to compare
373 * 2 : s2 = string 2 to compare
375 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
377 *********************************************************************/
378 int strcmpic(const char *s1, const char *s2)
382 if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
388 return(ijb_tolower(*s1) - ijb_tolower(*s2));
393 /*********************************************************************
395 * Function : strncmpic
397 * Description : Case insensitive string comparison (upto n characters)
400 * 1 : s1 = string 1 to compare
401 * 2 : s2 = string 2 to compare
402 * 3 : n = maximum characters to compare
404 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
406 *********************************************************************/
407 int strncmpic(const char *s1, const char *s2, size_t n)
409 if (n <= 0) return(0);
413 if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
422 return(ijb_tolower(*s1) - ijb_tolower(*s2));
427 /*********************************************************************
431 * Description : In-situ-eliminate all leading and trailing whitespace
435 * 1 : s : string to be chomped.
437 * Returns : chomped string
439 *********************************************************************/
440 char *chomp(char *string)
445 * strip trailing whitespace
447 p = string + strlen(string);
448 while (p > string && ijb_isspace(*(p-1)))
455 * find end of leading whitespace
458 while (*q && ijb_isspace(*q))
464 * if there was any, move the rest forwards
479 /*********************************************************************
483 * Description : Reallocate "old" and append text to it. This makes
484 * it easier to append to malloc'd strings.
485 * Running out of memory is a FATAL error.
488 * 1 : old = Old text that is to be extended. Will be
489 * free()d by this routine. May be NULL.
490 * 2 : text_to_append = Text to be appended to old.
493 * Returns : Pointer to newly malloc'ed appended string.
494 * If there is no text to append, return old. Caller
497 *********************************************************************/
498 char *strsav(char *old, const char *text_to_append)
500 int old_len, new_len = 0;
503 if (( text_to_append == NULL) || (*text_to_append == '\0'))
510 if ((p = strdup(text_to_append)) == NULL)
512 log_error(LOG_LEVEL_FATAL, "strdup() failed!", new_len);
513 /* Never get here - LOG_LEVEL_FATAL causes program exit */
518 old_len = strlen(old);
519 new_len = old_len + strlen(text_to_append) + 1;
521 if ((p = realloc(old, new_len)) == NULL)
523 log_error(LOG_LEVEL_FATAL, "realloc(%d) bytes failed!", new_len);
524 /* Never get here - LOG_LEVEL_FATAL causes program exit */
527 strcpy(p + old_len, text_to_append);
532 /*********************************************************************
534 * Function : string_append
536 * Description : Reallocate target_string and append text to it.
537 * This makes it easier to append to malloc'd strings.
538 * This is similar to the (removed) strsav(), but
539 * running out of memory isn't catastrophic.
543 * The following style provides sufficient error
544 * checking for this routine, with minimal clutter
545 * in the source code. It is recommended if you
546 * have many calls to this function:
548 * char * s = strdup(...); // don't check for error
549 * string_append(&s, ...); // don't check for error
550 * string_append(&s, ...); // don't check for error
551 * string_append(&s, ...); // don't check for error
552 * if (NULL == s) { ... handle error ... }
556 * char * s = strdup(...); // don't check for error
557 * string_append(&s, ...); // don't check for error
558 * string_append(&s, ...); // don't check for error
559 * if (string_append(&s, ...)) {... handle error ...}
562 * 1 : target_string = Pointer to old text that is to be
563 * extended. *target_string will be free()d by this
564 * routine. target_string must be non-NULL.
565 * If *target_string is NULL, this routine will
566 * do nothing and return with an error - this allows
567 * you to make many calls to this routine and only
568 * check for errors after the last one.
569 * 2 : text_to_append = Text to be appended to old.
572 * Returns : JB_ERR_OK on success, and sets *target_string
573 * to newly malloc'ed appended string. Caller
574 * must free(*target_string).
575 * JB_ERR_MEMORY on out-of-memory. (And free()s
576 * *target_string and sets it to NULL).
577 * JB_ERR_MEMORY if *target_string is NULL.
579 *********************************************************************/
580 jb_err string_append(char **target_string, const char *text_to_append)
585 assert(target_string);
586 assert(text_to_append);
588 if (*target_string == NULL)
590 return JB_ERR_MEMORY;
593 if (*text_to_append == '\0')
598 old_len = strlen(*target_string);
600 if (NULL == (new_string = realloc(*target_string,
601 strlen(text_to_append) + old_len + 1)))
603 free(*target_string);
605 *target_string = NULL;
606 return JB_ERR_MEMORY;
609 strcpy(new_string + old_len, text_to_append);
611 *target_string = new_string;
616 /*********************************************************************
618 * Function : string_join
620 * Description : Join two strings together. Frees BOTH the original
621 * strings. If either or both input strings are NULL,
622 * fails as if it had run out of memory.
624 * For comparison, string_append requires that the
625 * second string is non-NULL, and doesn't free it.
627 * Rationale: Too often, we want to do
628 * string_append(s, html_encode(s2)). That assert()s
629 * if s2 is NULL or if html_encode() runs out of memory.
630 * It also leaks memory. Proper checking is cumbersome.
631 * The solution: string_join(s, html_encode(s2)) is safe,
632 * and will free the memory allocated by html_encode().
635 * 1 : target_string = Pointer to old text that is to be
636 * extended. *target_string will be free()d by this
637 * routine. target_string must be non-NULL.
638 * 2 : text_to_append = Text to be appended to old.
640 * Returns : JB_ERR_OK on success, and sets *target_string
641 * to newly malloc'ed appended string. Caller
642 * must free(*target_string).
643 * JB_ERR_MEMORY on out-of-memory, or if
644 * *target_string or text_to_append is NULL. (In
645 * this case, frees *target_string and text_to_append,
646 * sets *target_string to NULL).
648 *********************************************************************/
649 jb_err string_join(char **target_string, char *text_to_append)
653 assert(target_string);
655 if (text_to_append == NULL)
657 freez(*target_string);
658 return JB_ERR_MEMORY;
661 err = string_append(target_string, text_to_append);
663 free(text_to_append);
669 /*********************************************************************
671 * Function : simplematch
673 * Description : String matching, with a (greedy) '*' wildcard that
674 * stands for zero or more arbitrary characters and
675 * character classes in [], which take both enumerations
679 * 1 : pattern = pattern for matching
680 * 2 : text = text to be matched
682 * Returns : 0 if match, else nonzero
684 *********************************************************************/
685 int simplematch(char *pattern, char *text)
687 unsigned char *pat = (unsigned char *) pattern;
688 unsigned char *txt = (unsigned char *) text;
689 unsigned char *fallback = pat;
692 unsigned char lastchar = 'a';
694 unsigned char charmap[32];
700 /* EOF pattern but !EOF text? */
706 /* '*' in the pattern? */
710 /* The pattern ends afterwards? Speed up the return. */
716 /* Else, set wildcard mode and remember position after '*' */
721 /* Character range specification? */
724 memset(charmap, '\0', sizeof(charmap));
726 while (*++pat != ']')
732 else if (*pat == '-')
734 if ((*++pat == ']') || *pat == '\0')
738 for(i = lastchar; i <= *pat; i++)
740 charmap[i / 8] |= (1 << (i % 8));
745 charmap[*pat / 8] |= (1 << (*pat % 8));
749 } /* -END- if Character range specification */
752 /* Compare: Char match, or char range match*/
754 || ((*pat == ']') && (charmap[*txt / 8] & (1 << (*txt % 8)))) )
756 /* Sucess, go ahead */
761 /* In wildcard mode, just try again after failiure */
776 /* Cut off extra '*'s */
777 if(*pat == '*') pat++;
779 /* If this is the pattern's end, fine! */
785 /*********************************************************************
789 * Description : Duplicate the first n characters of a string that may
790 * contain '\0' characters.
793 * 1 : string = string to be duplicated
794 * 2 : n = number of bytes to duplicate
796 * Returns : pointer to copy, or NULL if failiure
798 *********************************************************************/
799 char *bindup(const char *string, int n)
803 if (NULL == (dup = (char *)malloc(n)))
809 memcpy(dup, string, n);
817 /*********************************************************************
819 * Function : make_path
821 * Description : Takes a directory name and a file name, returns
822 * the complete path. Handles windows/unix differences.
823 * If the file name is already an absolute path, or if
824 * the directory name is NULL or empty, it returns
828 * 1 : dir: Name of directory or NULL for none.
829 * 2 : file: Name of file. Should not be NULL or empty.
831 * Returns : "dir/file" (Or on windows, "dir\file").
832 * It allocates the string on the heap. Caller frees.
833 * Returns NULL in error (i.e. NULL file or out of
836 *********************************************************************/
837 char * make_path(const char * dir, const char * file)
848 strncpy(path,dir+2,512);
852 strncpy(path,dir+1,512);
857 strncpy(path,dir,512);
863 if(AddPart(path,file,512))
869 #else /* ndef AMIGA */
871 if ((file == NULL) || (*file == '\0'))
873 return NULL; /* Error */
876 if ((dir == NULL) || (*dir == '\0') /* No directory specified */
877 #if defined(_WIN32) || defined(__OS2__)
878 || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
879 #else /* ifndef _WIN32 || __OS2__ */
880 || (*file == '/') /* Absolute path (U*ix) */
881 #endif /* ifndef _WIN32 || __OS2__ */
891 if ( *dir != '/' && basedir && *basedir )
893 path = malloc( strlen( basedir ) + strlen(dir) + strlen(file) + 3);
894 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
895 strcpy(path, basedir);
901 path = malloc(strlen(dir) + strlen(file) + 2);
902 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
907 path = malloc(strlen(dir) + strlen(file) + 2);
908 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
911 #endif /* defined unix */
913 #if defined(_WIN32) || defined(__OS2__)
914 if(path[strlen(path)-1] != '\\')
918 #else /* ifndef _WIN32 || __OS2__ */
919 if(path[strlen(path)-1] != '/')
923 #endif /* ifndef _WIN32 || __OS2__ */
928 #endif /* ndef AMIGA */
933 * What follows is a portable snprintf routine, written by Mark Martinec.
934 * See: http://www.ijs.si/software/snprintf/
935 * Anyone who needs it can add a define for themselves... so far, only
936 * OS/2 (native) lacks snprintf.
939 - a portable implementation of snprintf,
940 including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
942 snprintf is a routine to convert numeric and string arguments to
943 formatted strings. It is similar to sprintf(3) provided in a system's
944 C library, yet it requires an additional argument - the buffer size -
945 and it guarantees never to store anything beyond the given buffer,
946 regardless of the format or arguments to be formatted. Some newer
947 operating systems do provide snprintf in their C library, but many do
948 not or do provide an inadequate (slow or idiosyncratic) version, which
949 calls for a portable implementation of this routine.
953 Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
954 Copyright © 1999, Mark Martinec
960 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
961 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
963 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
964 # if defined(NEED_SNPRINTF_ONLY)
965 # undef NEED_SNPRINTF_ONLY
967 # if !defined(PREFER_PORTABLE_SNPRINTF)
968 # define PREFER_PORTABLE_SNPRINTF
972 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
973 #define SOLARIS_COMPATIBLE
976 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
977 #define HPUX_COMPATIBLE
980 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
981 #define DIGITAL_UNIX_COMPATIBLE
984 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
985 #define PERL_COMPATIBLE
988 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
989 #define LINUX_COMPATIBLE
992 #include <sys/types.h>
1003 #define isdigit(c) ((c) >= '0' && (c) <= '9')
1005 /* For copying strings longer or equal to 'breakeven_point'
1006 * it is more efficient to call memcpy() than to do it inline.
1007 * The value depends mostly on the processor architecture,
1008 * but also on the compiler and its optimization capabilities.
1009 * The value is not critical, some small value greater than zero
1010 * will be just fine if you don't care to squeeze every drop
1011 * of performance out of the code.
1013 * Small values favor memcpy, large values favor inline code.
1015 #if defined(__alpha__) || defined(__alpha)
1016 # define breakeven_point 2 /* AXP (DEC Alpha) - gcc or cc or egcs */
1018 #if defined(__i386__) || defined(__i386)
1019 # define breakeven_point 12 /* Intel Pentium/Linux - gcc 2.96 */
1022 # define breakeven_point 10 /* HP-PA - gcc */
1024 #if defined(__sparc__) || defined(__sparc)
1025 # define breakeven_point 33 /* Sun Sparc 5 - gcc 2.8.1 */
1028 /* some other values of possible interest: */
1029 /* #define breakeven_point 8 */ /* VAX 4000 - vaxc */
1030 /* #define breakeven_point 19 */ /* VAX 4000 - gcc 2.7.0 */
1032 #ifndef breakeven_point
1033 # define breakeven_point 6 /* some reasonable one-size-fits-all value */
1036 #define fast_memcpy(d,s,n) \
1037 { register size_t nn = (size_t)(n); \
1038 if (nn >= breakeven_point) memcpy((d), (s), nn); \
1039 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1040 register char *dd; register const char *ss; \
1041 for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
1043 #define fast_memset(d,c,n) \
1044 { register size_t nn = (size_t)(n); \
1045 if (nn >= breakeven_point) memset((d), (int)(c), nn); \
1046 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1047 register char *dd; register const int cc=(int)(c); \
1048 for (dd=(d); nn>0; nn--) *dd++ = cc; } }
1052 #if defined(NEED_ASPRINTF)
1053 int asprintf (char **ptr, const char *fmt, /*args*/ ...);
1055 #if defined(NEED_VASPRINTF)
1056 int vasprintf (char **ptr, const char *fmt, va_list ap);
1058 #if defined(NEED_ASNPRINTF)
1059 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
1061 #if defined(NEED_VASNPRINTF)
1062 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
1065 #if defined(HAVE_SNPRINTF)
1066 /* declare our portable snprintf routine under name portable_snprintf */
1067 /* declare our portable vsnprintf routine under name portable_vsnprintf */
1069 /* declare our portable routines under names snprintf and vsnprintf */
1070 #define portable_snprintf snprintf
1071 #if !defined(NEED_SNPRINTF_ONLY)
1072 #define portable_vsnprintf vsnprintf
1076 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1077 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
1078 #if !defined(NEED_SNPRINTF_ONLY)
1079 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
1085 static char credits[] = "\n\
1086 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
1087 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
1088 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
1090 #if defined(NEED_ASPRINTF)
1091 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
1097 va_start(ap, fmt); /* measure the required size */
1098 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1100 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1101 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1102 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1106 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1108 assert(str_l2 == str_l);
1114 #if defined(NEED_VASPRINTF)
1115 int vasprintf(char **ptr, const char *fmt, va_list ap) {
1121 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1122 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1125 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1126 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1127 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1129 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1130 assert(str_l2 == str_l);
1136 #if defined(NEED_ASNPRINTF)
1137 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
1142 va_start(ap, fmt); /* measure the required size */
1143 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1145 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1146 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1147 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1148 if (str_m == 0) { /* not interested in resulting string, just return size */
1150 *ptr = (char *) malloc(str_m);
1151 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1155 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1157 assert(str_l2 == str_l);
1164 #if defined(NEED_VASNPRINTF)
1165 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1170 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1171 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1174 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1175 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1176 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1177 if (str_m == 0) { /* not interested in resulting string, just return size */
1179 *ptr = (char *) malloc(str_m);
1180 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1182 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1183 assert(str_l2 == str_l);
1191 * If the system does have snprintf and the portable routine is not
1192 * specifically required, this module produces no code for snprintf/vsnprintf.
1194 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1196 #if !defined(NEED_SNPRINTF_ONLY)
1197 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1202 str_l = portable_vsnprintf(str, str_m, fmt, ap);
1208 #if defined(NEED_SNPRINTF_ONLY)
1209 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1211 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1214 #if defined(NEED_SNPRINTF_ONLY)
1218 const char *p = fmt;
1220 /* In contrast with POSIX, the ISO C99 now says
1221 * that str can be NULL and str_m can be 0.
1222 * This is more useful than the old: if (str_m < 1) return -1; */
1224 #if defined(NEED_SNPRINTF_ONLY)
1230 /* if (str_l < str_m) str[str_l++] = *p++; -- this would be sufficient */
1231 /* but the following code achieves better performance for cases
1232 * where format string is long and contains few conversions */
1233 const char *q = strchr(p+1,'%');
1234 size_t n = !q ? strlen(p) : (q-p);
1235 if (str_l < str_m) {
1236 size_t avail = str_m-str_l;
1237 fast_memcpy(str+str_l, p, (n>avail?avail:n));
1241 const char *starting_p;
1242 size_t min_field_width = 0, precision = 0;
1243 int zero_padding = 0, precision_specified = 0, justify_left = 0;
1244 int alternate_form = 0, force_sign = 0;
1245 int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1246 the ' ' flag should be ignored. */
1247 char length_modifier = '\0'; /* allowed values: \0, h, l, L */
1248 char tmp[32];/* temporary buffer for simple numeric->string conversion */
1250 const char *str_arg; /* string address in case of string argument */
1251 size_t str_arg_l; /* natural field width of arg without padding
1253 unsigned char uchar_arg;
1254 /* unsigned char argument value - only defined for c conversion.
1255 N.B. standard explicitly states the char argument for
1256 the c conversion is unsigned */
1258 size_t number_of_zeros_to_pad = 0;
1259 /* number of zeros to be inserted for numeric conversions
1260 as required by the precision or minimal field width */
1262 size_t zero_padding_insertion_ind = 0;
1263 /* index into tmp where zero padding is to be inserted */
1265 char fmt_spec = '\0';
1266 /* current conversion specifier character */
1268 str_arg = credits;/* just to make compiler happy (defined but not used)*/
1270 starting_p = p; p++; /* skip '%' */
1272 while (*p == '0' || *p == '-' || *p == '+' ||
1273 *p == ' ' || *p == '#' || *p == '\'') {
1275 case '0': zero_padding = 1; break;
1276 case '-': justify_left = 1; break;
1277 case '+': force_sign = 1; space_for_positive = 0; break;
1278 case ' ': force_sign = 1;
1279 /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1280 #ifdef PERL_COMPATIBLE
1281 /* ... but in Perl the last of ' ' and '+' applies */
1282 space_for_positive = 1;
1285 case '#': alternate_form = 1; break;
1290 /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1292 /* parse field width */
1295 p++; j = va_arg(ap, int);
1296 if (j >= 0) min_field_width = j;
1297 else { min_field_width = -j; justify_left = 1; }
1298 } else if (isdigit((int)(*p))) {
1299 /* size_t could be wider than unsigned int;
1300 make sure we treat argument like common implementations do */
1301 unsigned int uj = *p++ - '0';
1302 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1303 min_field_width = uj;
1305 /* parse precision */
1307 p++; precision_specified = 1;
1309 int j = va_arg(ap, int);
1311 if (j >= 0) precision = j;
1313 precision_specified = 0; precision = 0;
1315 * Solaris 2.6 man page claims that in this case the precision
1316 * should be set to 0. Digital Unix 4.0, HPUX 10 and BSD man page
1317 * claim that this case should be treated as unspecified precision,
1318 * which is what we do here.
1321 } else if (isdigit((int)(*p))) {
1322 /* size_t could be wider than unsigned int;
1323 make sure we treat argument like common implementations do */
1324 unsigned int uj = *p++ - '0';
1325 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1329 /* parse 'h', 'l' and 'll' length modifiers */
1330 if (*p == 'h' || *p == 'l') {
1331 length_modifier = *p; p++;
1332 if (length_modifier == 'l' && *p == 'l') { /* double l = long long */
1333 #ifdef SNPRINTF_LONGLONG_SUPPORT
1334 length_modifier = '2'; /* double l encoded as '2' */
1336 length_modifier = 'l'; /* treat it as a single 'l' */
1342 /* common synonyms: */
1344 case 'i': fmt_spec = 'd'; break;
1345 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1346 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1347 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1350 /* get parameter value, do initial processing */
1352 case '%': /* % behaves similar to 's' regarding flags and field widths */
1353 case 'c': /* c behaves similar to 's' regarding flags and field widths */
1355 length_modifier = '\0'; /* wint_t and wchar_t not supported */
1356 /* the result of zero padding flag with non-numeric conversion specifier*/
1357 /* is undefined. Solaris and HPUX 10 does zero padding in this case, */
1358 /* Digital Unix and Linux does not. */
1359 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1360 zero_padding = 0; /* turn zero padding off for string conversions */
1367 int j = va_arg(ap, int);
1368 uchar_arg = (unsigned char) j; /* standard demands unsigned char */
1369 str_arg = (const char *) &uchar_arg;
1373 str_arg = va_arg(ap, const char *);
1374 if (!str_arg) str_arg_l = 0;
1375 /* make sure not to address string beyond the specified precision !!! */
1376 else if (!precision_specified) str_arg_l = strlen(str_arg);
1377 /* truncate string if necessary as requested by precision */
1378 else if (precision == 0) str_arg_l = 0;
1380 /* memchr on HP does not like n > 2^31 !!! */
1381 const char *q = memchr(str_arg, '\0',
1382 precision <= 0x7fffffff ? precision : 0x7fffffff);
1383 str_arg_l = !q ? precision : (q-str_arg);
1389 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1390 /* NOTE: the u, o, x, X and p conversion specifiers imply
1391 the value is unsigned; d implies a signed value */
1394 /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1395 +1 if greater than zero (or nonzero for unsigned arguments),
1396 -1 if negative (unsigned argument is never negative) */
1398 int int_arg = 0; unsigned int uint_arg = 0;
1399 /* only defined for length modifier h, or for no length modifiers */
1401 long int long_arg = 0; unsigned long int ulong_arg = 0;
1402 /* only defined for length modifier l */
1404 void *ptr_arg = NULL;
1405 /* pointer argument value -only defined for p conversion */
1407 #ifdef SNPRINTF_LONGLONG_SUPPORT
1408 long long int long_long_arg = 0;
1409 unsigned long long int ulong_long_arg = 0;
1410 /* only defined for length modifier ll */
1412 if (fmt_spec == 'p') {
1413 /* HPUX 10: An l, h, ll or L before any other conversion character
1414 * (other than d, i, u, o, x, or X) is ignored.
1416 * not specified, but seems to behave as HPUX does.
1417 * Solaris: If an h, l, or L appears before any other conversion
1418 * specifier (other than d, i, u, o, x, or X), the behavior
1419 * is undefined. (Actually %hp converts only 16-bits of address
1420 * and %llp treats address as 64-bit data which is incompatible
1421 * with (void *) argument on a 32-bit system).
1423 #ifdef SOLARIS_COMPATIBLE
1424 # ifdef SOLARIS_BUG_COMPATIBLE
1425 /* keep length modifiers even if it represents 'll' */
1427 if (length_modifier == '2') length_modifier = '\0';
1430 length_modifier = '\0';
1432 ptr_arg = va_arg(ap, void *);
1433 if (ptr_arg != NULL) arg_sign = 1;
1434 } else if (fmt_spec == 'd') { /* signed */
1435 switch (length_modifier) {
1438 /* It is non-portable to specify a second argument of char or short
1439 * to va_arg, because arguments seen by the called function
1440 * are not char or short. C converts char and short arguments
1441 * to int before passing them to a function.
1443 int_arg = va_arg(ap, int);
1444 if (int_arg > 0) arg_sign = 1;
1445 else if (int_arg < 0) arg_sign = -1;
1448 long_arg = va_arg(ap, long int);
1449 if (long_arg > 0) arg_sign = 1;
1450 else if (long_arg < 0) arg_sign = -1;
1452 #ifdef SNPRINTF_LONGLONG_SUPPORT
1454 long_long_arg = va_arg(ap, long long int);
1455 if (long_long_arg > 0) arg_sign = 1;
1456 else if (long_long_arg < 0) arg_sign = -1;
1460 } else { /* unsigned */
1461 switch (length_modifier) {
1464 uint_arg = va_arg(ap, unsigned int);
1465 if (uint_arg) arg_sign = 1;
1468 ulong_arg = va_arg(ap, unsigned long int);
1469 if (ulong_arg) arg_sign = 1;
1471 #ifdef SNPRINTF_LONGLONG_SUPPORT
1473 ulong_long_arg = va_arg(ap, unsigned long long int);
1474 if (ulong_long_arg) arg_sign = 1;
1479 str_arg = tmp; str_arg_l = 0;
1481 * For d, i, u, o, x, and X conversions, if precision is specified,
1482 * the '0' flag should be ignored. This is so with Solaris 2.6,
1483 * Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1485 #ifndef PERL_COMPATIBLE
1486 if (precision_specified) zero_padding = 0;
1488 if (fmt_spec == 'd') {
1489 if (force_sign && arg_sign >= 0)
1490 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1491 /* leave negative numbers for sprintf to handle,
1492 to avoid handling tricky cases like (short int)(-32768) */
1493 #ifdef LINUX_COMPATIBLE
1494 } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1495 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1497 } else if (alternate_form) {
1498 if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1499 { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1500 /* alternate form should have no effect for p conversion, but ... */
1501 #ifdef HPUX_COMPATIBLE
1502 else if (fmt_spec == 'p'
1503 /* HPUX 10: for an alternate form of p conversion,
1504 * a nonzero result is prefixed by 0x. */
1505 #ifndef HPUX_BUG_COMPATIBLE
1506 /* Actually it uses 0x prefix even for a zero value. */
1509 ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1512 zero_padding_insertion_ind = str_arg_l;
1513 if (!precision_specified) precision = 1; /* default precision is 1 */
1514 if (precision == 0 && arg_sign == 0
1515 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1517 /* HPUX 10 man page claims: With conversion character p the result of
1518 * converting a zero value with a precision of zero is a null string.
1519 * Actually HP returns all zeroes, and Linux returns "(nil)". */
1522 /* converted to null string */
1523 /* When zero value is formatted with an explicit precision 0,
1524 the resulting formatted string is empty (d, i, u, o, x, X, p). */
1526 char f[5]; int f_l = 0;
1527 f[f_l++] = '%'; /* construct a simple format string for sprintf */
1528 if (!length_modifier) { }
1529 else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1530 else f[f_l++] = length_modifier;
1531 f[f_l++] = fmt_spec; f[f_l++] = '\0';
1532 if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1533 else if (fmt_spec == 'd') { /* signed */
1534 switch (length_modifier) {
1536 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg); break;
1537 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1538 #ifdef SNPRINTF_LONGLONG_SUPPORT
1539 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1542 } else { /* unsigned */
1543 switch (length_modifier) {
1545 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg); break;
1546 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1547 #ifdef SNPRINTF_LONGLONG_SUPPORT
1548 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1552 /* include the optional minus sign and possible "0x"
1553 in the region before the zero padding insertion point */
1554 if (zero_padding_insertion_ind < str_arg_l &&
1555 tmp[zero_padding_insertion_ind] == '-') {
1556 zero_padding_insertion_ind++;
1558 if (zero_padding_insertion_ind+1 < str_arg_l &&
1559 tmp[zero_padding_insertion_ind] == '0' &&
1560 (tmp[zero_padding_insertion_ind+1] == 'x' ||
1561 tmp[zero_padding_insertion_ind+1] == 'X') ) {
1562 zero_padding_insertion_ind += 2;
1565 { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1566 if (alternate_form && fmt_spec == 'o'
1567 #ifdef HPUX_COMPATIBLE /* ("%#.o",0) -> "" */
1570 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE /* ("%#o",0) -> "00" */
1572 /* unless zero is already the first character */
1573 && !(zero_padding_insertion_ind < str_arg_l
1574 && tmp[zero_padding_insertion_ind] == '0')
1576 ) { /* assure leading zero for alternate-form octal numbers */
1577 if (!precision_specified || precision < num_of_digits+1) {
1578 /* precision is increased to force the first character to be zero,
1579 except if a zero value is formatted with an explicit precision
1581 precision = num_of_digits+1; precision_specified = 1;
1584 /* zero padding to specified precision? */
1585 if (num_of_digits < precision)
1586 number_of_zeros_to_pad = precision - num_of_digits;
1588 /* zero padding to specified minimal field width? */
1589 if (!justify_left && zero_padding) {
1590 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1591 if (n > 0) number_of_zeros_to_pad += n;
1595 default: /* unrecognized conversion specifier, keep format string as-is*/
1596 zero_padding = 0; /* turn zero padding off for non-numeric convers. */
1597 #ifndef DIGITAL_UNIX_COMPATIBLE
1598 justify_left = 1; min_field_width = 0; /* reset flags */
1600 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1601 /* keep the entire format string unchanged */
1602 str_arg = starting_p; str_arg_l = p - starting_p;
1603 /* well, not exactly so for Linux, which does something inbetween,
1604 * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y" */
1606 /* discard the unrecognized conversion, just keep *
1607 * the unrecognized conversion character */
1608 str_arg = p; str_arg_l = 0;
1610 if (*p) str_arg_l++; /* include invalid conversion specifier unchanged
1611 if not at end-of-string */
1614 if (*p) p++; /* step over the just processed conversion specifier */
1615 /* insert padding to the left as requested by min_field_width;
1616 this does not include the zero padding in case of numerical conversions*/
1617 if (!justify_left) { /* left padding with blank or zero */
1618 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1620 if (str_l < str_m) {
1621 size_t avail = str_m-str_l;
1622 fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1627 /* zero padding as requested by the precision or by the minimal field width
1628 * for numeric conversions required? */
1629 if (number_of_zeros_to_pad <= 0) {
1630 /* will not copy first part of numeric right now, *
1631 * force it to be copied later in its entirety */
1632 zero_padding_insertion_ind = 0;
1634 /* insert first part of numerics (sign or '0x') before zero padding */
1635 int n = zero_padding_insertion_ind;
1637 if (str_l < str_m) {
1638 size_t avail = str_m-str_l;
1639 fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1643 /* insert zero padding as requested by the precision or min field width */
1644 n = number_of_zeros_to_pad;
1646 if (str_l < str_m) {
1647 size_t avail = str_m-str_l;
1648 fast_memset(str+str_l, '0', (n>avail?avail:n));
1653 /* insert formatted string
1654 * (or as-is conversion specifier for unknown conversions) */
1655 { int n = str_arg_l - zero_padding_insertion_ind;
1657 if (str_l < str_m) {
1658 size_t avail = str_m-str_l;
1659 fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1665 /* insert right padding */
1666 if (justify_left) { /* right blank padding to the field width */
1667 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1669 if (str_l < str_m) {
1670 size_t avail = str_m-str_l;
1671 fast_memset(str+str_l, ' ', (n>avail?avail:n));
1678 #if defined(NEED_SNPRINTF_ONLY)
1681 if (str_m > 0) { /* make sure the string is null-terminated
1682 even at the expense of overwriting the last character
1683 (shouldn't happen, but just in case) */
1684 str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1686 /* Return the number of characters formatted (excluding trailing null
1687 * character), that is, the number of characters that would have been
1688 * written to the buffer if it were large enough.
1690 * The value of str_l should be returned, but str_l is of unsigned type
1691 * size_t, and snprintf is int, possibly leading to an undetected
1692 * integer overflow, resulting in a negative return value, which is illegal.
1693 * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1694 * Should errno be set to EOVERFLOW and EOF returned in this case???
1699 #endif /* __OS2__ */