lib/librte_eal/common/include/rte_string_fns.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /**
  35  * @file
  36  *
  37  * String-related functions as replacement for libc equivalents
  38  */
  39
  40 #ifndef _RTE_STRING_FNS_H_
  41 #define _RTE_STRING_FNS_H_
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * Safer version of snprintf that writes up to buflen characters to
  49  * the output buffer and ensures that the resultant string is null-terminated,
  50  * that is, it writes at most buflen-1 actual string characters to buffer. The
  51  * return value is the number of characters which should be written to the
  52  * buffer, so string truncation can be detected by the caller by checking if
  53  * the return value is greater than or equal to the buflen.
  54  *
  55  * @param buffer
  56  *   The buffer into which the output is to be written
  57  *
  58  * @param buflen
  59  *   The size of the output buffer
  60  *
  61  * @param format
  62  *   The format string to be printed to the buffer
  63  *
  64  * @return
  65  *   The number of characters written to the buffer, or if the string has been
  66  *   truncated, the number of characters which would have been written had the
  67  *   buffer been sufficiently big.
  68  *
  69  */
  70 int
  71 rte_snprintf(char *buffer, int buflen, const char *format, ...);
  72
  73 /**
  74  * Takes string "string" parameter and splits it at character "delim"
  75  * up to maxtokens-1 times - to give "maxtokens" resulting tokens. Like
  76  * strtok or strsep functions, this modifies its input string, by replacing
  77  * instances of "delim" with '\\0'. All resultant tokens are returned in the
  78  * "tokens" array which must have enough entries to hold "maxtokens".
  79  *
  80  * @param string
  81  *   The input string to be split into tokens
  82  *
  83  * @param stringlen
  84  *   The max length of the input buffer
  85  *
  86  * @param tokens
  87  *   The array to hold the pointers to the tokens in the string
  88  *
  89  * @param maxtokens
  90  *   The number of elements in the tokens array. At most, maxtokens-1 splits
  91  *   of the string will be done.
  92  *
  93  * @param delim
  94  *   The character on which the split of the data will be done
  95  *
  96  * @return
  97  *   The number of tokens in the tokens array.
  98  */
  99 int
 100 rte_strsplit(char *string, int stringlen,
 101              char **tokens, int maxtokens, char delim);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* RTE_STRING_FNS_H */