source/lib/replace/replace.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    macros to go along with the lib/replace/ portability layer code
   5
   6    Copyright (C) Andrew Tridgell 2005
   7    Copyright (C) Jelmer Vernooij 2006
   8
   9      ** NOTE! The following LGPL license applies to the replace
  10      ** library. This does NOT imply that all of Samba is released
  11      ** under the LGPL
  12
  13    This library is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU Lesser General Public
  15    License as published by the Free Software Foundation; either
  16    version 2 of the License, or (at your option) any later version.
  17
  18    This library is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    Lesser General Public License for more details.
  22
  23    You should have received a copy of the GNU Lesser General Public
  24    License along with this library; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 */
  27
  28 #ifndef _LIBREPLACE_REPLACE_H
  29 #define _LIBREPLACE_REPLACE_H
  30
  31 #include "config.h"
  32
  33 #ifdef HAVE_STANDARDS_H
  34 #include <standards.h>
  35 #endif
  36
  37 #include <stdio.h>
  38 #include <stdlib.h>
  39 #include <stdarg.h>
  40 #include <errno.h>
  41
  42 #if defined(_MSC_VER) || defined(__MINGW32__)
  43 #include "win32_replace.h"
  44 #endif
  45
  46 #ifdef __COMPAR_FN_T
  47 #define QSORT_CAST (__compar_fn_t)
  48 #endif
  49
  50 #ifndef QSORT_CAST
  51 #define QSORT_CAST (int (*)(const void *, const void *))
  52 #endif
  53
  54 #ifdef HAVE_STDINT_H
  55 #include <stdint.h>
  56 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
  57    which causes a warning storm on irix */
  58 #undef HAVE_INTTYPES_H
  59 #elif HAVE_INTTYPES_H
  60 #include <inttypes.h>
  61 #endif
  62
  63 #ifdef HAVE_STRING_H
  64 #include <string.h>
  65 #endif
  66
  67 #ifdef HAVE_STRINGS_H
  68 #include <strings.h>
  69 #endif
  70
  71 #ifdef HAVE_SYS_TYPES_H
  72 #include <sys/types.h>
  73 #endif
  74
  75 #if STDC_HEADERS
  76 #include <stdlib.h>
  77 #include <stddef.h>
  78 #endif
  79
  80 #ifndef HAVE_STRERROR
  81 extern char *sys_errlist[];
  82 #define strerror(i) sys_errlist[i]
  83 #endif
  84
  85 #ifndef HAVE_ERRNO_DECL
  86 extern int errno;
  87 #endif
  88
  89 #ifndef HAVE_STRDUP
  90 #define strdup rep_strdup
  91 char *rep_strdup(const char *s);
  92 #endif
  93
  94 #ifndef HAVE_MEMMOVE
  95 #define memmove rep_memmove
  96 void *rep_memmove(void *dest,const void *src,int size);
  97 #endif
  98
  99 #if !defined(HAVE_MKTIME) || !defined(HAVE_TIMEGM)
 100 #include "system/time.h"
 101 #endif
 102
 103 #ifndef HAVE_MKTIME
 104 #define mktime rep_mktime
 105 time_t rep_mktime(struct tm *t);
 106 #endif
 107
 108 #ifndef HAVE_TIMEGM
 109 struct tm;
 110 #define timegm rep_timegm
 111 time_t rep_timegm(struct tm *tm);
 112 #endif
 113
 114 #ifndef HAVE_STRLCPY
 115 #define strlcpy rep_strlcpy
 116 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 117 #endif
 118
 119 #ifndef HAVE_STRLCAT
 120 #define strlcat rep_strlcat
 121 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 122 #endif
 123
 124 #ifndef HAVE_STRNDUP
 125 #define strndup rep_strndup
 126 char *rep_strndup(const char *s, size_t n);
 127 #endif
 128
 129 #ifndef HAVE_STRNLEN
 130 #define strnlen rep_strnlen
 131 size_t rep_strnlen(const char *s, size_t n);
 132 #endif
 133
 134 #ifndef HAVE_SETENV
 135 #define setenv rep_setenv
 136 int rep_setenv(const char *name, const char *value, int overwrite);
 137 #endif
 138
 139 #ifndef HAVE_SETEUID
 140 #define seteuid rep_seteuid
 141 int rep_seteuid(uid_t);
 142 #endif
 143
 144 #ifndef HAVE_SETEGID
 145 #define setegid rep_setegid
 146 int rep_setegid(gid_t);
 147 #endif
 148
 149 #ifndef HAVE_SETLINEBUF
 150 #define setlinebuf rep_setlinebuf
 151 void rep_setlinebuf(FILE *);
 152 #endif
 153
 154 #ifndef HAVE_STRCASESTR
 155 #define strcasestr rep_strcasestr
 156 char *rep_strcasestr(const char *haystack, const char *needle);
 157 #endif
 158
 159 #ifndef HAVE_STRTOK_R
 160 #define strtok_r rep_strtok_r
 161 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 162 #endif
 163
 164 #ifndef HAVE_STRTOLL
 165 #define strtoll rep_strtoll
 166 long long int rep_strtoll(const char *str, char **endptr, int base);
 167 #endif
 168
 169 #ifndef HAVE_STRTOULL
 170 #define strtoull rep_strtoull
 171 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 172 #endif
 173
 174 #ifndef HAVE_FTRUNCATE
 175 #define ftruncate rep_ftruncate
 176 int rep_ftruncate(int,off_t);
 177 #endif
 178
 179 #ifndef HAVE_INITGROUPS
 180 #define ftruncate rep_ftruncate
 181 int rep_initgroups(char *name, gid_t id);
 182 #endif
 183
 184 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 185 #define bzero(a,b) memset((a),'\0',(b))
 186 #endif
 187
 188 #ifndef HAVE_DLERROR
 189 #define dlerror rep_dlerror
 190 char *rep_dlerror(void);
 191 #endif
 192
 193 #ifndef HAVE_DLOPEN
 194 #define dlopen rep_dlopen
 195 void *rep_dlopen(const char *name, int flags);
 196 #endif
 197
 198 #ifndef HAVE_DLSYM
 199 #define dlsym rep_dlsym
 200 void *rep_dlsym(void *handle, const char *symbol);
 201 #endif
 202
 203 #ifndef HAVE_DLCLOSE
 204 #define dlclose rep_dlclose
 205 int rep_dlclose(void *handle);
 206 #endif
 207
 208
 209 #ifndef PRINTF_ATTRIBUTE
 210 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 211 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 212  * the parameter containing the format, and a2 the index of the first
 213  * argument. Note that some gcc 2.x versions don't handle this
 214  * properly **/
 215 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 216 #else
 217 #define PRINTF_ATTRIBUTE(a1, a2)
 218 #endif
 219 #endif
 220
 221 #ifndef HAVE_VASPRINTF
 222 #define vasprintf rep_vasprintf
 223 int rep_vasprintf(char **ptr, const char *format, va_list ap);
 224 #endif
 225
 226 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 227 #define snprintf rep_snprintf
 228 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 229 #endif
 230
 231 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 232 #define vsnprintf rep_vsnprintf
 233 int rep_vsnprintf(char *,size_t ,const char *, va_list ap);
 234 #endif
 235
 236 #ifndef HAVE_ASPRINTF
 237 #define asprintf rep_asprintf
 238 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 239 #endif
 240
 241
 242 /* we used to use these fns, but now we have good replacements
 243    for snprintf and vsnprintf */
 244 #define slprintf snprintf
 245
 246
 247 #ifndef HAVE_VA_COPY
 248 #undef va_copy
 249 #ifdef HAVE___VA_COPY
 250 #define va_copy(dest, src) __va_copy(dest, src)
 251 #else
 252 #define va_copy(dest, src) (dest) = (src)
 253 #endif
 254 #endif
 255
 256 #ifndef HAVE_VOLATILE
 257 #define volatile
 258 #endif
 259
 260 #ifndef HAVE_COMPARISON_FN_T
 261 typedef int (*comparison_fn_t)(const void *, const void *);
 262 #endif
 263
 264 /* Load header file for dynamic linking stuff */
 265 #ifdef HAVE_DLFCN_H
 266 #include <dlfcn.h>
 267 #endif
 268
 269 #ifndef RTLD_LAZY
 270 #define RTLD_LAZY 0
 271 #endif
 272
 273 #ifndef HAVE_SECURE_MKSTEMP
 274 #define mkstemp(path) rep_mkstemp(path)
 275 int rep_mkstemp(char *temp);
 276 #endif
 277
 278 #ifndef HAVE_MKDTEMP
 279 #define mkdtemp rep_mkdtemp
 280 char *rep_mkdtemp(char *template);
 281 #endif
 282
 283 #ifdef HAVE_LIMITS_H
 284 #include <limits.h>
 285 #endif
 286
 287 /* The extra casts work around common compiler bugs.  */
 288 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 289 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 290    It is necessary at least when t == time_t.  */
 291 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 292                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 293 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 294
 295 #ifndef HOST_NAME_MAX
 296 #define HOST_NAME_MAX 64
 297 #endif
 298
 299 #ifndef UINT16_MAX
 300 #define UINT16_MAX 65535
 301 #endif
 302
 303 #ifndef UINT32_MAX
 304 #define UINT32_MAX (4294967295U)
 305 #endif
 306
 307 #ifndef UINT64_MAX
 308 #define UINT64_MAX ((uint64_t)-1)
 309 #endif
 310
 311 #ifndef CHAR_BIT
 312 #define CHAR_BIT 8
 313 #endif
 314
 315 #ifndef INT32_MAX
 316 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 317 #endif
 318
 319 #ifdef HAVE_STDBOOL_H
 320 #include <stdbool.h>
 321 #endif
 322
 323 #if !defined(HAVE_BOOL)
 324 #ifdef HAVE__Bool
 325 #define bool _Bool
 326 #else
 327 typedef int bool;
 328 #endif
 329 #endif
 330
 331 /*
 332  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 333  *
 334  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 335  * Tru64 needs _BOOL_EXISTS
 336  * AIX needs _BOOL,_TRUE,_FALSE
 337  */
 338 #ifndef BOOL_DEFINED
 339 #define BOOL_DEFINED
 340 #endif
 341 #ifndef _BOOL_EXISTS
 342 #define _BOOL_EXISTS
 343 #endif
 344 #ifndef _BOOL
 345 #define _BOOL
 346 #endif
 347
 348 #ifndef __bool_true_false_are_defined
 349 #define __bool_true_false_are_defined
 350 #endif
 351
 352 #ifndef true
 353 #define true (1)
 354 #endif
 355 #ifndef false
 356 #define false (0)
 357 #endif
 358
 359 #ifndef _TRUE
 360 #define _TRUE true
 361 #endif
 362 #ifndef _FALSE
 363 #define _FALSE false
 364 #endif
 365
 366 #ifndef HAVE_FUNCTION_MACRO
 367 #ifdef HAVE_func_MACRO
 368 #define __FUNCTION__ __func__
 369 #else
 370 #define __FUNCTION__ ("")
 371 #endif
 372 #endif
 373
 374 #ifdef HAVE_SYS_PARAM_H
 375 #include <sys/param.h>
 376 #endif
 377
 378 #ifndef MIN
 379 #define MIN(a,b) ((a)<(b)?(a):(b))
 380 #endif
 381
 382 #ifndef MAX
 383 #define MAX(a,b) ((a)>(b)?(a):(b))
 384 #endif
 385
 386 #ifndef __STRING
 387 #define __STRING(x)    #x
 388 #endif
 389
 390 #if MMAP_BLACKLIST
 391 #undef HAVE_MMAP
 392 #endif
 393
 394 #endif /* _LIBREPLACE_REPLACE_H */