compat/xstring.h

   1 /*
   2  * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_COMPAT_XSTRING_H
  10 #define SQUID_COMPAT_XSTRING_H
  11
  12 #if HAVE_STRING_H
  13 #include <string.h>
  14 #endif
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 /**
  21  * xstrdup() - same as strdup(3).  Used for portability.
  22  * Never returns NULL; fatal on error.
  23  *
  24  * Sets errno to EINVAL if a NULL pointer is passed.
  25  *
  26  * Define failure_notify to receive error message.
  27  * otherwise perror() is used to display it.
  28  */
  29 char *xstrdup(const char *s);
  30
  31 #ifdef strdup
  32 #undef strdup
  33 #endif
  34 #define strdup(X) xstrdup((X))
  35
  36 /*
  37  *  xstrncpy() - similar to strncpy(3) but terminates string
  38  *  always with '\0' if (n != 0 and dst != NULL),
  39  *  and doesn't do padding
  40  */
  41 char *xstrncpy(char *dst, const char *src, size_t n);
  42
  43 /**
  44  * xstrndup() - Somewhat similar(XXX) to strndup(3): Allocates up to n bytes,
  45  * while strndup(3) copies up to n bytes and allocates up to n+1 bytes
  46  * to fit the terminating character. Assumes s is 0-terminated (another XXX).
  47  *
  48  * Never returns NULL; fatal on error.
  49  *
  50  * Sets errno to EINVAL if a NULL pointer or negative
  51  * length is passed.
  52  *
  53  * Define failure_notify to receive error message.
  54  * otherwise perror() is used to display it.
  55  */
  56 char *xstrndup(const char *s, size_t n);
  57
  58 #ifdef strndup
  59 #undef strndup
  60 #endif
  61 #define strndup(X) xstrndup((X))
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif /* SQUID_COMPAT_XSTRING_H */
  68