Mercurial > libavutil.hg
annotate avstring.h @ 637:683a6dbdd2b2 libavutil
spelling/grammar/consistency review part III
author | diego |
---|---|
date | Wed, 28 Jan 2009 23:16:49 +0000 |
parents | 8c48a1b999a3 |
children | 81aecbb6bbb2 |
rev | line source |
---|---|
347 | 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 | |
567 | 21 #ifndef AVUTIL_AVSTRING_H |
22 #define AVUTIL_AVSTRING_H | |
347 | 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 | |
637 | 32 * @param ptr updated if the prefix is matched inside str |
347 | 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 | |
637 | 44 * @param ptr updated if the prefix is matched inside str |
347 | 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 | |
633 | 51 * null-terminate dst. |
347 | 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 | |
633 | 64 * no more than size - 1 bytes, and null-terminate dst. |
347 | 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 | |
369
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
76 /** |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
77 * Append output to a string, according to a format. Never write out of |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
78 * the destination buffer, and and always put a terminating 0 within |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
79 * the buffer. |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
80 * @param dst destination buffer (string to which the output is |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
81 * appended) |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
82 * @param size total size of the destination buffer |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
83 * @param fmt printf-compatible format string, specifying how the |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
84 * following parameters are used |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
85 * @return the length of the string that would have been generated |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
86 * if enough space had been available |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
87 */ |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
88 size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...); |
2cd0add8ac0c
Implement av_strlcatf(): a strlcat which adds a printf style formatted string
lucabe
parents:
347
diff
changeset
|
89 |
567 | 90 #endif /* AVUTIL_AVSTRING_H */ |