avstring.h 7.34 KB
Newer Older
1 2 3
/*
 * Copyright (c) 2007 Mans Rullgard
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8 9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVUTIL_AVSTRING_H
#define AVUTIL_AVSTRING_H
23 24

#include <stddef.h>
25
#include "attributes.h"
26

27 28 29 30 31
/**
 * @addtogroup lavu_string
 * @{
 */

32 33 34 35 36 37
/**
 * Return non-zero if pfx is a prefix of str. If it is, *ptr is set to
 * the address of the first character in str after the prefix.
 *
 * @param str input string
 * @param pfx prefix to test
38
 * @param ptr updated if the prefix is matched inside str
39 40 41 42 43 44 45 46 47 48 49
 * @return non-zero if the prefix matches, zero otherwise
 */
int av_strstart(const char *str, const char *pfx, const char **ptr);

/**
 * Return non-zero if pfx is a prefix of str independent of case. If
 * it is, *ptr is set to the address of the first character in str
 * after the prefix.
 *
 * @param str input string
 * @param pfx prefix to test
50
 * @param ptr updated if the prefix is matched inside str
51 52 53 54
 * @return non-zero if the prefix matches, zero otherwise
 */
int av_stristart(const char *str, const char *pfx, const char **ptr);

55
/**
56 57 58
 * Locate the first case-independent occurrence in the string haystack
 * of the string needle.  A zero-length string needle is considered to
 * match at the start of haystack.
59 60 61
 *
 * This function is a case-insensitive version of the standard strstr().
 *
62 63 64 65
 * @param haystack string to search in
 * @param needle   string to search for
 * @return         pointer to the located match within haystack
 *                 or a null pointer if no match
66
 */
67
char *av_stristr(const char *haystack, const char *needle);
68

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
/**
 * Locate the first occurrence of the string needle in the string haystack
 * where not more than hay_length characters are searched. A zero-length
 * string needle is considered to match at the start of haystack.
 *
 * This function is a length-limited version of the standard strstr().
 *
 * @param haystack   string to search in
 * @param needle     string to search for
 * @param hay_length length of string to search in
 * @return           pointer to the located match within haystack
 *                   or a null pointer if no match
 */
char *av_strnstr(const char *haystack, const char *needle, size_t hay_length);

84 85
/**
 * Copy the string src to dst, but no more than size - 1 bytes, and
86
 * null-terminate dst.
87 88 89 90 91 92 93
 *
 * This function is the same as BSD strlcpy().
 *
 * @param dst destination buffer
 * @param src source string
 * @param size size of destination buffer
 * @return the length of src
94
 *
95
 * @warning since the return value is the length of src, src absolutely
96 97
 * _must_ be a properly 0-terminated string, otherwise this will read beyond
 * the end of the buffer and possibly crash.
98 99 100 101 102
 */
size_t av_strlcpy(char *dst, const char *src, size_t size);

/**
 * Append the string src to the string dst, but to a total length of
103
 * no more than size - 1 bytes, and null-terminate dst.
104 105 106 107 108 109 110 111
 *
 * This function is similar to BSD strlcat(), but differs when
 * size <= strlen(dst).
 *
 * @param dst destination buffer
 * @param src source string
 * @param size size of destination buffer
 * @return the total length of src and dst
112
 *
113 114 115
 * @warning since the return value use the length of src and dst, these
 * absolutely _must_ be a properly 0-terminated strings, otherwise this
 * will read beyond the end of the buffer and possibly crash.
116 117 118
 */
size_t av_strlcat(char *dst, const char *src, size_t size);

119 120
/**
 * Append output to a string, according to a format. Never write out of
121
 * the destination buffer, and always put a terminating 0 within
122 123 124 125 126 127 128 129 130
 * the buffer.
 * @param dst destination buffer (string to which the output is
 *  appended)
 * @param size total size of the destination buffer
 * @param fmt printf-compatible format string, specifying how the
 *  following parameters are used
 * @return the length of the string that would have been generated
 *  if enough space had been available
 */
131
size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...) av_printf_format(3, 4);
132

133 134 135 136 137
/**
 * Convert a number to a av_malloced string.
 */
char *av_d2str(double d);

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/**
 * Unescape the given string until a non escaped terminating char,
 * and return the token corresponding to the unescaped string.
 *
 * The normal \ and ' escaping is supported. Leading and trailing
 * whitespaces are removed, unless they are escaped with '\' or are
 * enclosed between ''.
 *
 * @param buf the buffer to parse, buf will be updated to point to the
 * terminating char
 * @param term a 0-terminated list of terminating chars
 * @return the malloced unescaped string, which must be av_freed by
 * the user, NULL in case of allocation failure
 */
char *av_get_token(const char **buf, const char *term);

154 155 156
/**
 * Locale-independent conversion of ASCII isdigit.
 */
157 158 159 160
static inline av_const int av_isdigit(int c)
{
    return c >= '0' && c <= '9';
}
161 162 163 164

/**
 * Locale-independent conversion of ASCII isgraph.
 */
165 166 167 168
static inline av_const int av_isgraph(int c)
{
    return c > 32 && c < 127;
}
169 170 171 172

/**
 * Locale-independent conversion of ASCII isspace.
 */
173 174 175 176 177
static inline av_const int av_isspace(int c)
{
    return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' ||
           c == '\v';
}
178

179
/**
180
 * Locale-independent conversion of ASCII characters to uppercase.
181
 */
182
static inline av_const int av_toupper(int c)
183 184 185 186 187 188 189
{
    if (c >= 'a' && c <= 'z')
        c ^= 0x20;
    return c;
}

/**
190
 * Locale-independent conversion of ASCII characters to lowercase.
191
 */
192
static inline av_const int av_tolower(int c)
193 194 195 196 197 198
{
    if (c >= 'A' && c <= 'Z')
        c ^= 0x20;
    return c;
}

199 200 201
/**
 * Locale-independent conversion of ASCII isxdigit.
 */
202 203 204 205 206
static inline av_const int av_isxdigit(int c)
{
    c = av_tolower(c);
    return av_isdigit(c) || (c >= 'a' && c <= 'f');
}
207

208
/*
209
 * Locale-independent case-insensitive compare.
210
 * @note This means only ASCII-range characters are case-insensitive
211 212 213 214
 */
int av_strcasecmp(const char *a, const char *b);

/**
215
 * Locale-independent case-insensitive compare.
216
 * @note This means only ASCII-range characters are case-insensitive
217 218 219
 */
int av_strncasecmp(const char *a, const char *b, size_t n);

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

/**
 * Thread safe basename.
 * @param path the path, on DOS both \ and / are considered separators.
 * @return pointer to the basename substring.
 */
const char *av_basename(const char *path);

/**
 * Thread safe dirname.
 * @param path the path, on DOS both \ and / are considered separators.
 * @return the path with the separator replaced by the string terminator or ".".
 * @note the function may change the input string.
 */
const char *av_dirname(char *path);

236 237 238 239 240 241 242 243 244

/**
 * Match instances of a name in a comma-separated list of names.
 * @param name  Name to look for.
 * @param names List of names.
 * @return 1 on match, 0 otherwise.
 */
int av_match_name(const char *name, const char *names);

245 246 247 248
/**
 * @}
 */

249
#endif /* AVUTIL_AVSTRING_H */