third_party/sipcc/cpr_string.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef _CPR_STRING_H_
   6 #define _CPR_STRING_H_
   7
   8 #include <stdarg.h>
   9
  10 #include "cpr_types.h"
  11 #include "cpr_strings.h"
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 /**
  18  * sstrncpy
  19  *
  20  * @brief The CPR wrapper for strncpy
  21  *
  22  * This is Cisco's *safe* version of strncpy.  The string will always
  23  * be NUL terminated (which is not ANSI compliant).
  24  *
  25  * @param[in] dst  - The destination string
  26  * @param[in] src  - The source
  27  * @param[in]  max - maximum length in octets to concatenate
  28  *
  29  * @return     Pointer to the @b end of the string
  30  *
  31  * @note       Modified to be explicitly safe for all inputs.
  32  *             Also return the number of characters copied excluding the
  33  *             NUL terminator vs. the original string s1.  This simplifies
  34  *             code where sstrncat functions follow.
  35  */
  36 unsigned long
  37 sstrncpy(char *dst, const char *src, unsigned long max);
  38
  39
  40 /**
  41  * sstrncat
  42  *
  43  * @brief The CPR wrapper for strncat
  44  *
  45  * This is Cisco's *safe* version of strncat.  The string will always
  46  * be NUL terminated (which is not ANSI compliant).
  47  *
  48  * @param[in] s1  - first string
  49  * @param[in] s2  - second string
  50  * @param[in]  max - maximum length in octets to concatenate
  51  *
  52  * @return     Pointer to the @b end of the string
  53  *
  54  * @note    Modified to be explicitly safe for all inputs.
  55  *             Also return the end vs. the beginning of the string s1
  56  *             which is useful for multiple sstrncat calls.
  57  */
  58 char *
  59 sstrncat(char *s1, const char *s2, unsigned long max);
  60
  61
  62 /*
  63  * flex_string
  64  */
  65 #define FLEX_STRING_CHUNK_SIZE 256
  66
  67 typedef struct {
  68   char *buffer;
  69   size_t buffer_length;
  70   size_t string_length;
  71 } flex_string;
  72
  73 /*
  74  * flex_string_init
  75  *
  76  * Not thread-safe
  77  */
  78 void flex_string_init(flex_string *fs);
  79
  80 /*
  81  * flex_string_free
  82  *
  83  * Not thread-safe
  84  */
  85 void flex_string_free(flex_string *fs);
  86
  87 /*
  88  * flex_string_check_alloc
  89  *
  90  * Allocate enough chunks to hold the new minimum size.
  91  *
  92  * Not thread-safe
  93  */
  94 void flex_string_check_alloc(flex_string *fs, size_t new_min_length);
  95
  96 /*
  97  * flex_string_append
  98  *
  99  * Not thread-safe
 100  */
 101 void flex_string_append(flex_string *fs, const char *more);
 102
 103 /*
 104  * flex_string_sprintf
 105  *
 106  * Not thread-safe
 107  */
 108 void flex_string_vsprintf(flex_string *fs, const char *format, va_list original_ap);
 109
 110 /*
 111  * flex_string_sprintf
 112  *
 113  * Not thread-safe
 114  */
 115 void flex_string_sprintf(flex_string *fs, const char *format, ...);
 116
 117
 118 /* From cpr_linux_string.h */
 119 /* cpr_strdup
 120  *
 121  * @brief The CPR wrapper for strdup
 122
 123  * The cpr_strdup shall return a pointer to a new string, which is a duplicate
 124  * of the string pointed to by "str" argument. A null pointer is returned if the
 125  * new string cannot be created.
 126  *
 127  * @param[in] str  - The string that needs to be duplicated
 128  *
 129  * @return The duplicated string or NULL in case of no memory
 130  *
 131  */
 132 char *
 133 cpr_strdup(const char *str);
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif