cups/string-private.h

   1 /*
   2  * Private string definitions for CUPS.
   3  *
   4  * Copyright © 2007-2018 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
   8  * information.
   9  */
  10
  11 #ifndef _CUPS_STRING_PRIVATE_H_
  12 #  define _CUPS_STRING_PRIVATE_H_
  13
  14 /*
  15  * Include necessary headers...
  16  */
  17
  18 #  include <stdio.h>
  19 #  include <stdlib.h>
  20 #  include <stdarg.h>
  21 #  include <ctype.h>
  22 #  include <errno.h>
  23 #  include <locale.h>
  24 #  include <time.h>
  25
  26 #  include "config.h"
  27
  28 #  ifdef HAVE_STRING_H
  29 #    include <string.h>
  30 #  endif /* HAVE_STRING_H */
  31
  32 #  ifdef HAVE_STRINGS_H
  33 #    include <strings.h>
  34 #  endif /* HAVE_STRINGS_H */
  35
  36 #  ifdef HAVE_BSTRING_H
  37 #    include <bstring.h>
  38 #  endif /* HAVE_BSTRING_H */
  39
  40 #  if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
  41 #    define __CUPS_SSIZE_T_DEFINED
  42 #    include <stddef.h>
  43 /* Windows does not support the ssize_t type, so map it to long... */
  44 typedef long ssize_t;                   /* @private@ */
  45 #  endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */
  46
  47
  48 /*
  49  * C++ magic...
  50  */
  51
  52 #  ifdef __cplusplus
  53 extern "C" {
  54 #  endif /* __cplusplus */
  55
  56
  57 /*
  58  * String pool structures...
  59  */
  60
  61 #  define _CUPS_STR_GUARD       0x12344321
  62
  63 typedef struct _cups_sp_item_s          /**** String Pool Item ****/
  64 {
  65 #  ifdef DEBUG_GUARDS
  66   unsigned int  guard;                  /* Guard word */
  67 #  endif /* DEBUG_GUARDS */
  68   unsigned int  ref_count;              /* Reference count */
  69   char          str[1];                 /* String */
  70 } _cups_sp_item_t;
  71
  72
  73 /*
  74  * Replacements for the ctype macros that are not affected by locale, since we
  75  * really only care about testing for ASCII characters when parsing files, etc.
  76  *
  77  * The _CUPS_INLINE definition controls whether we get an inline function body,
  78  * and external function body, or an external definition.
  79  */
  80
  81 #  if defined(__GNUC__) || __STDC_VERSION__ >= 199901L
  82 #    define _CUPS_INLINE static inline
  83 #  elif defined(_MSC_VER)
  84 #    define _CUPS_INLINE static __inline
  85 #  elif defined(_CUPS_STRING_C_)
  86 #    define _CUPS_INLINE
  87 #  endif /* __GNUC__ || __STDC_VERSION__ */
  88
  89 #  ifdef _CUPS_INLINE
  90 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
  91 _cups_isalnum(int ch)                   /* I - Character to test */
  92 {
  93   return ((ch >= '0' && ch <= '9') ||
  94           (ch >= 'A' && ch <= 'Z') ||
  95           (ch >= 'a' && ch <= 'z'));
  96 }
  97
  98 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
  99 _cups_isalpha(int ch)                   /* I - Character to test */
 100 {
 101   return ((ch >= 'A' && ch <= 'Z') ||
 102           (ch >= 'a' && ch <= 'z'));
 103 }
 104
 105 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 106 _cups_islower(int ch)                   /* I - Character to test */
 107 {
 108   return (ch >= 'a' && ch <= 'z');
 109 }
 110
 111 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 112 _cups_isspace(int ch)                   /* I - Character to test */
 113 {
 114   return (ch == ' ' || ch == '\f' || ch == '\n' || ch == '\r' || ch == '\t' ||
 115           ch == '\v');
 116 }
 117
 118 _CUPS_INLINE int                        /* O - 1 on match, 0 otherwise */
 119 _cups_isupper(int ch)                   /* I - Character to test */
 120 {
 121   return (ch >= 'A' && ch <= 'Z');
 122 }
 123
 124 _CUPS_INLINE int                        /* O - Converted character */
 125 _cups_tolower(int ch)                   /* I - Character to convert */
 126 {
 127   return (_cups_isupper(ch) ? ch - 'A' + 'a' : ch);
 128 }
 129
 130 _CUPS_INLINE int                        /* O - Converted character */
 131 _cups_toupper(int ch)                   /* I - Character to convert */
 132 {
 133   return (_cups_islower(ch) ? ch - 'a' + 'A' : ch);
 134 }
 135 #  else
 136 extern int _cups_isalnum(int ch);
 137 extern int _cups_isalpha(int ch);
 138 extern int _cups_islower(int ch);
 139 extern int _cups_isspace(int ch);
 140 extern int _cups_isupper(int ch);
 141 extern int _cups_tolower(int ch);
 142 extern int _cups_toupper(int ch);
 143 #  endif /* _CUPS_INLINE */
 144
 145
 146 /*
 147  * Prototypes...
 148  */
 149
 150 extern ssize_t  _cups_safe_vsnprintf(char *, size_t, const char *, va_list);
 151 extern void     _cups_strcpy(char *dst, const char *src);
 152
 153 #  ifndef HAVE_STRDUP
 154 extern char     *_cups_strdup(const char *);
 155 #    define strdup _cups_strdup
 156 #  endif /* !HAVE_STRDUP */
 157
 158 extern int      _cups_strcasecmp(const char *, const char *);
 159
 160 extern int      _cups_strncasecmp(const char *, const char *, size_t n);
 161
 162 #  ifndef HAVE_STRLCAT
 163 extern size_t _cups_strlcat(char *, const char *, size_t);
 164 #    define strlcat _cups_strlcat
 165 #  endif /* !HAVE_STRLCAT */
 166
 167 #  ifndef HAVE_STRLCPY
 168 extern size_t _cups_strlcpy(char *, const char *, size_t);
 169 #    define strlcpy _cups_strlcpy
 170 #  endif /* !HAVE_STRLCPY */
 171
 172 #  ifndef HAVE_SNPRINTF
 173 extern int      _cups_snprintf(char *, size_t, const char *, ...) _CUPS_FORMAT(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_ */