Globally rename the header inclusion guard names.
[libav.git] / libavutil / avstring.h
1 /*
2 * Copyright (c) 2007 Mans Rullgard
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef AVUTIL_AVSTRING_H
22 #define AVUTIL_AVSTRING_H
23
24 #include <stddef.h>
25
26 /**
27 * Return non-zero if pfx is a prefix of str. If it is, *ptr is set to
28 * the address of the first character in str after the prefix.
29 *
30 * @param str input string
31 * @param pfx prefix to test
32 * @param ptr updated after the prefix in str in there is a match
33 * @return non-zero if the prefix matches, zero otherwise
34 */
35 int av_strstart(const char *str, const char *pfx, const char **ptr);
36
37 /**
38 * Return non-zero if pfx is a prefix of str independent of case. If
39 * it is, *ptr is set to the address of the first character in str
40 * after the prefix.
41 *
42 * @param str input string
43 * @param pfx prefix to test
44 * @param ptr updated after the prefix in str in there is a match
45 * @return non-zero if the prefix matches, zero otherwise
46 */
47 int av_stristart(const char *str, const char *pfx, const char **ptr);
48
49 /**
50 * Copy the string src to dst, but no more than size - 1 bytes, and
51 * null terminate dst.
52 *
53 * This function is the same as BSD strlcpy().
54 *
55 * @param dst destination buffer
56 * @param src source string
57 * @param size size of destination buffer
58 * @return the length of src
59 */
60 size_t av_strlcpy(char *dst, const char *src, size_t size);
61
62 /**
63 * Append the string src to the string dst, but to a total length of
64 * no more than size - 1 bytes, and null terminate dst.
65 *
66 * This function is similar to BSD strlcat(), but differs when
67 * size <= strlen(dst).
68 *
69 * @param dst destination buffer
70 * @param src source string
71 * @param size size of destination buffer
72 * @return the total length of src and dst
73 */
74 size_t av_strlcat(char *dst, const char *src, size_t size);
75
76 /**
77 * Append output to a string, according to a format. Never write out of
78 * the destination buffer, and and always put a terminating 0 within
79 * the buffer.
80 * @param dst destination buffer (string to which the output is
81 * appended)
82 * @param size total size of the destination buffer
83 * @param fmt printf-compatible format string, specifying how the
84 * following parameters are used
85 * @return the length of the string that would have been generated
86 * if enough space had been available
87 */
88 size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...);
89
90 #endif /* AVUTIL_AVSTRING_H */