apr_strings.h revision 251875
1/* Licensed to the Apache Software Foundation (ASF) under one or more 2 * contributor license agreements. See the NOTICE file distributed with 3 * this work for additional information regarding copyright ownership. 4 * The ASF licenses this file to You under the Apache License, Version 2.0 5 * (the "License"); you may not use this file except in compliance with 6 * the License. You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17/* Portions of this file are covered by */ 18/* -*- mode: c; c-file-style: "k&r" -*- 19 20 strnatcmp.c -- Perform 'natural order' comparisons of strings in C. 21 Copyright (C) 2000 by Martin Pool <mbp@humbug.org.au> 22 23 This software is provided 'as-is', without any express or implied 24 warranty. In no event will the authors be held liable for any damages 25 arising from the use of this software. 26 27 Permission is granted to anyone to use this software for any purpose, 28 including commercial applications, and to alter it and redistribute it 29 freely, subject to the following restrictions: 30 31 1. The origin of this software must not be misrepresented; you must not 32 claim that you wrote the original software. If you use this software 33 in a product, an acknowledgment in the product documentation would be 34 appreciated but is not required. 35 2. Altered source versions must be plainly marked as such, and must not be 36 misrepresented as being the original software. 37 3. This notice may not be removed or altered from any source distribution. 38*/ 39 40#ifndef APR_STRINGS_H 41#define APR_STRINGS_H 42 43/** 44 * @file apr_strings.h 45 * @brief APR Strings library 46 */ 47 48#include "apr.h" 49#include "apr_errno.h" 50#include "apr_pools.h" 51#define APR_WANT_IOVEC 52#include "apr_want.h" 53 54#if APR_HAVE_STDARG_H 55#include <stdarg.h> 56#endif 57 58#ifdef __cplusplus 59extern "C" { 60#endif /* __cplusplus */ 61 62/** 63 * @defgroup apr_strings String routines 64 * @ingroup APR 65 * @{ 66 */ 67 68/** 69 * Do a natural order comparison of two strings. 70 * @param a The first string to compare 71 * @param b The second string to compare 72 * @return Either <0, 0, or >0. If the first string is less than the second 73 * this returns <0, if they are equivalent it returns 0, and if the 74 * first string is greater than second string it retuns >0. 75 */ 76APR_DECLARE(int) apr_strnatcmp(char const *a, char const *b); 77 78/** 79 * Do a natural order comparison of two strings ignoring the case of the 80 * strings. 81 * @param a The first string to compare 82 * @param b The second string to compare 83 * @return Either <0, 0, or >0. If the first string is less than the second 84 * this returns <0, if they are equivalent it returns 0, and if the 85 * first string is greater than second string it retuns >0. 86 */ 87APR_DECLARE(int) apr_strnatcasecmp(char const *a, char const *b); 88 89/** 90 * duplicate a string into memory allocated out of a pool 91 * @param p The pool to allocate out of 92 * @param s The string to duplicate 93 * @return The new string 94 */ 95APR_DECLARE(char *) apr_pstrdup(apr_pool_t *p, const char *s); 96 97/** 98 * Create a null-terminated string by making a copy of a sequence 99 * of characters and appending a null byte 100 * @param p The pool to allocate out of 101 * @param s The block of characters to duplicate 102 * @param n The number of characters to duplicate 103 * @return The new string 104 * @remark This is a faster alternative to apr_pstrndup, for use 105 * when you know that the string being duplicated really 106 * has 'n' or more characters. If the string might contain 107 * fewer characters, use apr_pstrndup. 108 */ 109APR_DECLARE(char *) apr_pstrmemdup(apr_pool_t *p, const char *s, apr_size_t n); 110 111/** 112 * Duplicate at most n characters of a string into memory allocated 113 * out of a pool; the new string will be NUL-terminated 114 * @param p The pool to allocate out of 115 * @param s The string to duplicate 116 * @param n The maximum number of characters to duplicate 117 * @return The new string 118 * @remark The amount of memory allocated from the pool is the length 119 * of the returned string including the NUL terminator 120 */ 121APR_DECLARE(char *) apr_pstrndup(apr_pool_t *p, const char *s, apr_size_t n); 122 123/** 124 * Duplicate a block of memory. 125 * 126 * @param p The pool to allocate from 127 * @param m The memory to duplicate 128 * @param n The number of bytes to duplicate 129 * @return The new block of memory 130 */ 131APR_DECLARE(void *) apr_pmemdup(apr_pool_t *p, const void *m, apr_size_t n); 132 133/** 134 * Concatenate multiple strings, allocating memory out a pool 135 * @param p The pool to allocate out of 136 * @param ... The strings to concatenate. The final string must be NULL 137 * @return The new string 138 */ 139APR_DECLARE_NONSTD(char *) apr_pstrcat(apr_pool_t *p, ...) 140#if defined(__GNUC__) && __GNUC__ >= 4 141 __attribute__((sentinel)) 142#endif 143 ; 144 145/** 146 * Concatenate multiple strings specified in a writev-style vector 147 * @param p The pool from which to allocate 148 * @param vec The strings to concatenate 149 * @param nvec The number of strings to concatenate 150 * @param nbytes (output) strlen of new string (pass in NULL to omit) 151 * @return The new string 152 */ 153APR_DECLARE(char *) apr_pstrcatv(apr_pool_t *p, const struct iovec *vec, 154 apr_size_t nvec, apr_size_t *nbytes); 155 156/** 157 * printf-style style printing routine. The data is output to a string 158 * allocated from a pool 159 * @param p The pool to allocate out of 160 * @param fmt The format of the string 161 * @param ap The arguments to use while printing the data 162 * @return The new string 163 */ 164APR_DECLARE(char *) apr_pvsprintf(apr_pool_t *p, const char *fmt, va_list ap); 165 166/** 167 * printf-style style printing routine. The data is output to a string 168 * allocated from a pool 169 * @param p The pool to allocate out of 170 * @param fmt The format of the string 171 * @param ... The arguments to use while printing the data 172 * @return The new string 173 */ 174APR_DECLARE_NONSTD(char *) apr_psprintf(apr_pool_t *p, const char *fmt, ...) 175 __attribute__((format(printf,2,3))); 176 177/** 178 * Copy up to dst_size characters from src to dst; does not copy 179 * past a NUL terminator in src, but always terminates dst with a NUL 180 * regardless. 181 * @param dst The destination string 182 * @param src The source string 183 * @param dst_size The space available in dst; dst always receives 184 * NUL termination, so if src is longer than 185 * dst_size, the actual number of characters copied is 186 * dst_size - 1. 187 * @return Pointer to the NUL terminator of the destination string, dst 188 * @remark 189 * <PRE> 190 * Note the differences between this function and strncpy(): 191 * 1) strncpy() doesn't always NUL terminate; apr_cpystrn() does. 192 * 2) strncpy() pads the destination string with NULs, which is often 193 * unnecessary; apr_cpystrn() does not. 194 * 3) strncpy() returns a pointer to the beginning of the dst string; 195 * apr_cpystrn() returns a pointer to the NUL terminator of dst, 196 * to allow a check for truncation. 197 * </PRE> 198 */ 199APR_DECLARE(char *) apr_cpystrn(char *dst, const char *src, 200 apr_size_t dst_size); 201 202/** 203 * Remove all whitespace from a string 204 * @param dest The destination string. It is okay to modify the string 205 * in place. Namely dest == src 206 * @param src The string to rid the spaces from. 207 * @return A pointer to the destination string's null terminator. 208 */ 209APR_DECLARE(char *) apr_collapse_spaces(char *dest, const char *src); 210 211/** 212 * Convert the arguments to a program from one string to an array of 213 * strings terminated by a NULL pointer 214 * @param arg_str The arguments to convert 215 * @param argv_out Output location. This is a pointer to an array of strings. 216 * @param token_context Pool to use. 217 */ 218APR_DECLARE(apr_status_t) apr_tokenize_to_argv(const char *arg_str, 219 char ***argv_out, 220 apr_pool_t *token_context); 221 222/** 223 * Split a string into separate null-terminated tokens. The tokens are 224 * delimited in the string by one or more characters from the sep 225 * argument. 226 * @param str The string to separate; this should be specified on the 227 * first call to apr_strtok() for a given string, and NULL 228 * on subsequent calls. 229 * @param sep The set of delimiters 230 * @param last Internal state saved by apr_strtok() between calls. 231 * @return The next token from the string 232 */ 233APR_DECLARE(char *) apr_strtok(char *str, const char *sep, char **last); 234 235/** 236 * @defgroup APR_Strings_Snprintf snprintf implementations 237 * @warning 238 * These are snprintf implementations based on apr_vformatter(). 239 * 240 * Note that various standards and implementations disagree on the return 241 * value of snprintf, and side-effects due to %n in the formatting string. 242 * apr_snprintf (and apr_vsnprintf) behaves as follows: 243 * 244 * Process the format string until the entire string is exhausted, or 245 * the buffer fills. If the buffer fills then stop processing immediately 246 * (so no further %n arguments are processed), and return the buffer 247 * length. In all cases the buffer is NUL terminated. It will return the 248 * number of characters inserted into the buffer, not including the 249 * terminating NUL. As a special case, if len is 0, apr_snprintf will 250 * return the number of characters that would have been inserted if 251 * the buffer had been infinite (in this case, *buffer can be NULL) 252 * 253 * In no event does apr_snprintf return a negative number. 254 * @{ 255 */ 256 257/** 258 * snprintf routine based on apr_vformatter. This means it understands the 259 * same extensions. 260 * @param buf The buffer to write to 261 * @param len The size of the buffer 262 * @param format The format string 263 * @param ... The arguments to use to fill out the format string. 264 */ 265APR_DECLARE_NONSTD(int) apr_snprintf(char *buf, apr_size_t len, 266 const char *format, ...) 267 __attribute__((format(printf,3,4))); 268 269/** 270 * vsnprintf routine based on apr_vformatter. This means it understands the 271 * same extensions. 272 * @param buf The buffer to write to 273 * @param len The size of the buffer 274 * @param format The format string 275 * @param ap The arguments to use to fill out the format string. 276 */ 277APR_DECLARE(int) apr_vsnprintf(char *buf, apr_size_t len, const char *format, 278 va_list ap); 279/** @} */ 280 281/** 282 * create a string representation of an int, allocated from a pool 283 * @param p The pool from which to allocate 284 * @param n The number to format 285 * @return The string representation of the number 286 */ 287APR_DECLARE(char *) apr_itoa(apr_pool_t *p, int n); 288 289/** 290 * create a string representation of a long, allocated from a pool 291 * @param p The pool from which to allocate 292 * @param n The number to format 293 * @return The string representation of the number 294 */ 295APR_DECLARE(char *) apr_ltoa(apr_pool_t *p, long n); 296 297/** 298 * create a string representation of an apr_off_t, allocated from a pool 299 * @param p The pool from which to allocate 300 * @param n The number to format 301 * @return The string representation of the number 302 */ 303APR_DECLARE(char *) apr_off_t_toa(apr_pool_t *p, apr_off_t n); 304 305/** 306 * Convert a numeric string into an apr_off_t numeric value. 307 * @param offset The value of the parsed string. 308 * @param buf The string to parse. It may contain optional whitespace, 309 * followed by an optional '+' (positive, default) or '-' (negative) 310 * character, followed by an optional '0x' prefix if base is 0 or 16, 311 * followed by numeric digits appropriate for base. 312 * @param end A pointer to the end of the valid character in buf. If 313 * not NULL, it is set to the first invalid character in buf. 314 * @param base A numeric base in the range between 2 and 36 inclusive, 315 * or 0. If base is zero, buf will be treated as base ten unless its 316 * digits are prefixed with '0x', in which case it will be treated as 317 * base 16. 318 * @bug *end breaks type safety; where *buf is const, *end needs to be 319 * declared as const in APR 2.0 320 */ 321APR_DECLARE(apr_status_t) apr_strtoff(apr_off_t *offset, const char *buf, 322 char **end, int base); 323 324/** 325 * parse a numeric string into a 64-bit numeric value 326 * @param buf The string to parse. It may contain optional whitespace, 327 * followed by an optional '+' (positive, default) or '-' (negative) 328 * character, followed by an optional '0x' prefix if base is 0 or 16, 329 * followed by numeric digits appropriate for base. 330 * @param end A pointer to the end of the valid character in buf. If 331 * not NULL, it is set to the first invalid character in buf. 332 * @param base A numeric base in the range between 2 and 36 inclusive, 333 * or 0. If base is zero, buf will be treated as base ten unless its 334 * digits are prefixed with '0x', in which case it will be treated as 335 * base 16. 336 * @return The numeric value of the string. On overflow, errno is set 337 * to ERANGE. On success, errno is set to 0. 338 */ 339APR_DECLARE(apr_int64_t) apr_strtoi64(const char *buf, char **end, int base); 340 341/** 342 * parse a base-10 numeric string into a 64-bit numeric value. 343 * Equivalent to apr_strtoi64(buf, (char**)NULL, 10). 344 * @param buf The string to parse 345 * @return The numeric value of the string. On overflow, errno is set 346 * to ERANGE. On success, errno is set to 0. 347 */ 348APR_DECLARE(apr_int64_t) apr_atoi64(const char *buf); 349 350/** 351 * Format a binary size (magnitiudes are 2^10 rather than 10^3) from an apr_off_t, 352 * as bytes, K, M, T, etc, to a four character compacted human readable string. 353 * @param size The size to format 354 * @param buf The 5 byte text buffer (counting the trailing null) 355 * @return The buf passed to apr_strfsize() 356 * @remark All negative sizes report ' - ', apr_strfsize only formats positive values. 357 */ 358APR_DECLARE(char *) apr_strfsize(apr_off_t size, char *buf); 359 360/** @} */ 361 362#ifdef __cplusplus 363} 364#endif 365 366#endif /* !APR_STRINGS_H */ 367