cups/string-private.h

   1 /*
   2  * Private string definitions for CUPS.
   3  *
   4  * Copyright 2007-2015 by Apple Inc.
   5  * Copyright 1997-2006 by Easy Software Products.
   6  *
   7  * Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
   8  */
   9
  10 #ifndef _CUPS_STRING_PRIVATE_H_
  11 #  define _CUPS_STRING_PRIVATE_H_
  12
  13 /*
  14  * Include necessary headers...
  15  */
  16
  17 #  include <stdio.h>
  18 #  include <stdlib.h>
  19 #  include <stdarg.h>
  20 #  include <ctype.h>
  21 #  include <errno.h>
  22 #  include <locale.h>
  23 #  include <time.h>
  24
  25 #  include "config.h"
  26
  27 #  ifdef HAVE_STRING_H
  28 #    include <string.h>
  29 #  endif /* HAVE_STRING_H */
  30
  31 #  ifdef HAVE_STRINGS_H
  32 #    include <strings.h>
  33 #  endif /* HAVE_STRINGS_H */
  34
  35 #  ifdef HAVE_BSTRING_H
  36 #    include <bstring.h>
  37 #  endif /* HAVE_BSTRING_H */
  38
  39 #  if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
  40 #    define __CUPS_SSIZE_T_DEFINED
  41 #    include <stddef.h>
  42 /* Windows does not support the ssize_t type, so map it to long... */
  43 typedef long ssize_t;                   /* @private@ */
  44 #  endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
  45
  46
  47 /*
  48  * C++ magic...
  49  */
  50
  51 #  ifdef __cplusplus
  52 extern "C" {
  53 #  endif /* __cplusplus */
  54
  55
  56 /*
  57  * String pool structures...
  58  */
  59
  60 #  define _CUPS_STR_GUARD       0x12344321
  61
  62 typedef struct _cups_sp_item_s          /**** String Pool Item ****/
  63 {
  64 #  ifdef DEBUG_GUARDS
  65   unsigned int  guard;                  /* Guard word */
  66 #  endif /* DEBUG_GUARDS */
  67   unsigned int  ref_count;              /* Reference count */
  68   char          str[1];                 /* String */
  69 } _cups_sp_item_t;
  70
  71
  72 /*
  73  * Replacements for the ctype macros that are not affected by locale, since we
  74  * really only care about testing for ASCII characters when parsing files, etc.
  75  *
  76  * The _CUPS_INLINE definition controls whether we get an inline function body,
  77  * and external function body, or an external definition.
  78  */
  79
  80 #  if defined(__GNUC__) || __STDC_VERSION__ >= 199901L
  81 #    define _CUPS_INLINE static inline
  82 #  elif defined(_MSC_VER)
  83 #    define _CUPS_INLINE static __inline
  84 #  elif defined(_CUPS_STRING_C_)
  85 #    define _CUPS_INLINE
  86 #  endif /* __GNUC__ || __STDC_VERSION__ */
  87
  88 #  ifdef _CUPS_INLINE
  89 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
  90 _cups_isalnum(int ch)                   /* I - Character to test */
  91 {
  92   return ((ch >= '0' && ch <= '9') ||
  93           (ch >= 'A' && ch <= 'Z') ||
  94           (ch >= 'a' && ch <= 'z'));
  95 }
  96
  97 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
  98 _cups_isalpha(int ch)                   /* I - Character to test */
  99 {
 100   return ((ch >= 'A' && ch <= 'Z') ||
 101           (ch >= 'a' && ch <= 'z'));
 102 }
 103
 104 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 105 _cups_islower(int ch)                   /* I - Character to test */
 106 {
 107   return (ch >= 'a' && ch <= 'z');
 108 }
 109
 110 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 111 _cups_isspace(int ch)                   /* I - Character to test */
 112 {
 113   return (ch == ' ' || ch == '\f' || ch == '\n' || ch == '\r' || ch == '\t' ||
 114           ch == '\v');
 115 }
 116
 117 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 118 _cups_isupper(int ch)                   /* I - Character to test */
 119 {
 120   return (ch >= 'A' && ch <= 'Z');
 121 }
 122
 123 _CUPS_INLINE int                        /* O - Converted character */
 124 _cups_tolower(int ch)                   /* I - Character to convert */
 125 {
 126   return (_cups_isupper(ch) ? ch - 'A' + 'a' : ch);
 127 }
 128
 129 _CUPS_INLINE int                        /* O - Converted character */
 130 _cups_toupper(int ch)                   /* I - Character to convert */
 131 {
 132   return (_cups_islower(ch) ? ch - 'a' + 'A' : ch);
 133 }
 134 #  else
 135 extern int _cups_isalnum(int ch);
 136 extern int _cups_isalpha(int ch);
 137 extern int _cups_islower(int ch);
 138 extern int _cups_isspace(int ch);
 139 extern int _cups_isupper(int ch);
 140 extern int _cups_tolower(int ch);
 141 extern int _cups_toupper(int ch);
 142 #  endif /* _CUPS_INLINE */
 143
 144
 145 /*
 146  * Prototypes...
 147  */
 148
 149 extern ssize_t  _cups_safe_vsnprintf(char *, size_t, const char *, va_list);
 150 extern void     _cups_strcpy(char *dst, const char *src);
 151
 152 #  ifndef HAVE_STRDUP
 153 extern char     *_cups_strdup(const char *);
 154 #    define strdup _cups_strdup
 155 #  endif /* !HAVE_STRDUP */
 156
 157 extern int      _cups_strcasecmp(const char *, const char *);
 158
 159 extern int      _cups_strncasecmp(const char *, const char *, size_t n);
 160
 161 #  ifndef HAVE_STRLCAT
 162 extern size_t _cups_strlcat(char *, const char *, size_t);
 163 #    define strlcat _cups_strlcat
 164 #  endif /* !HAVE_STRLCAT */
 165
 166 #  ifndef HAVE_STRLCPY
 167 extern size_t _cups_strlcpy(char *, const char *, size_t);
 168 #    define strlcpy _cups_strlcpy
 169 #  endif /* !HAVE_STRLCPY */
 170
 171 #  ifndef HAVE_SNPRINTF
 172 extern int      _cups_snprintf(char *, size_t, const char *, ...)
 173                 __attribute__ ((__format__ (__printf__, 3, 4)));
 174 #    define snprintf _cups_snprintf
 175 #  endif /* !HAVE_SNPRINTF */
 176
 177 #  ifndef HAVE_VSNPRINTF
 178 extern int      _cups_vsnprintf(char *, size_t, const char *, va_list);
 179 #    define vsnprintf _cups_vsnprintf
 180 #  endif /* !HAVE_VSNPRINTF */
 181
 182 /*
 183  * String pool functions...
 184  */
 185
 186 extern char     *_cupsStrAlloc(const char *s);
 187 extern void     _cupsStrFlush(void);
 188 extern void     _cupsStrFree(const char *s);
 189 extern char     *_cupsStrRetain(const char *s);
 190 extern size_t   _cupsStrStatistics(size_t *alloc_bytes, size_t *total_bytes);
 191
 192
 193 /*
 194  * Floating point number functions...
 195  */
 196
 197 extern char     *_cupsStrFormatd(char *buf, char *bufend, double number,
 198                                  struct lconv *loc);
 199 extern double   _cupsStrScand(const char *buf, char **bufptr,
 200                               struct lconv *loc);
 201
 202
 203 /*
 204  * Date function...
 205  */
 206
 207 extern char     *_cupsStrDate(char *buf, size_t bufsize, time_t timeval);
 208
 209
 210 /*
 211  * C++ magic...
 212  */
 213
 214 #  ifdef __cplusplus
 215 }
 216 #  endif /* __cplusplus */
 217
 218 #endif /* !_CUPS_STRING_H_ */