avstring.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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. #ifndef AVUTIL_AVSTRING_H
  21. #define AVUTIL_AVSTRING_H
  22. #include <stddef.h>
  23. #include "attributes.h"
  24. /**
  25. * @addtogroup lavu_string
  26. * @{
  27. */
  28. /**
  29. * Return non-zero if pfx is a prefix of str. If it is, *ptr is set to
  30. * the address of the first character in str after the prefix.
  31. *
  32. * @param str input string
  33. * @param pfx prefix to test
  34. * @param ptr updated if the prefix is matched inside str
  35. * @return non-zero if the prefix matches, zero otherwise
  36. */
  37. int av_strstart(const char *str, const char *pfx, const char **ptr);
  38. /**
  39. * Return non-zero if pfx is a prefix of str independent of case. If
  40. * it is, *ptr is set to the address of the first character in str
  41. * after the prefix.
  42. *
  43. * @param str input string
  44. * @param pfx prefix to test
  45. * @param ptr updated if the prefix is matched inside str
  46. * @return non-zero if the prefix matches, zero otherwise
  47. */
  48. int av_stristart(const char *str, const char *pfx, const char **ptr);
  49. /**
  50. * Locate the first case-independent occurrence in the string haystack
  51. * of the string needle. A zero-length string needle is considered to
  52. * match at the start of haystack.
  53. *
  54. * This function is a case-insensitive version of the standard strstr().
  55. *
  56. * @param haystack string to search in
  57. * @param needle string to search for
  58. * @return pointer to the located match within haystack
  59. * or a null pointer if no match
  60. */
  61. char *av_stristr(const char *haystack, const char *needle);
  62. /**
  63. * Copy the string src to dst, but no more than size - 1 bytes, and
  64. * null-terminate dst.
  65. *
  66. * This function is the same as BSD strlcpy().
  67. *
  68. * @param dst destination buffer
  69. * @param src source string
  70. * @param size size of destination buffer
  71. * @return the length of src
  72. *
  73. * @warning since the return value is the length of src, src absolutely
  74. * _must_ be a properly 0-terminated string, otherwise this will read beyond
  75. * the end of the buffer and possibly crash.
  76. */
  77. size_t av_strlcpy(char *dst, const char *src, size_t size);
  78. /**
  79. * Append the string src to the string dst, but to a total length of
  80. * no more than size - 1 bytes, and null-terminate dst.
  81. *
  82. * This function is similar to BSD strlcat(), but differs when
  83. * size <= strlen(dst).
  84. *
  85. * @param dst destination buffer
  86. * @param src source string
  87. * @param size size of destination buffer
  88. * @return the total length of src and dst
  89. *
  90. * @warning since the return value use the length of src and dst, these
  91. * absolutely _must_ be a properly 0-terminated strings, otherwise this
  92. * will read beyond the end of the buffer and possibly crash.
  93. */
  94. size_t av_strlcat(char *dst, const char *src, size_t size);
  95. /**
  96. * Append output to a string, according to a format. Never write out of
  97. * the destination buffer, and always put a terminating 0 within
  98. * the buffer.
  99. * @param dst destination buffer (string to which the output is
  100. * appended)
  101. * @param size total size of the destination buffer
  102. * @param fmt printf-compatible format string, specifying how the
  103. * following parameters are used
  104. * @return the length of the string that would have been generated
  105. * if enough space had been available
  106. */
  107. size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...) av_printf_format(3, 4);
  108. /**
  109. * Print arguments following specified format into a large enough auto
  110. * allocated buffer. It is similar to GNU asprintf().
  111. * @param fmt printf-compatible format string, specifying how the
  112. * following parameters are used.
  113. * @return the allocated string
  114. * @note You have to free the string yourself with av_free().
  115. */
  116. char *av_asprintf(const char *fmt, ...) av_printf_format(1, 2);
  117. /**
  118. * Convert a number to a av_malloced string.
  119. */
  120. char *av_d2str(double d);
  121. /**
  122. * Unescape the given string until a non escaped terminating char,
  123. * and return the token corresponding to the unescaped string.
  124. *
  125. * The normal \ and ' escaping is supported. Leading and trailing
  126. * whitespaces are removed, unless they are escaped with '\' or are
  127. * enclosed between ''.
  128. *
  129. * @param buf the buffer to parse, buf will be updated to point to the
  130. * terminating char
  131. * @param term a 0-terminated list of terminating chars
  132. * @return the malloced unescaped string, which must be av_freed by
  133. * the user, NULL in case of allocation failure
  134. */
  135. char *av_get_token(const char **buf, const char *term);
  136. /**
  137. * Split the string into several tokens which can be accessed by
  138. * successive calls to av_strtok().
  139. *
  140. * A token is defined as a sequence of characters not belonging to the
  141. * set specified in delim.
  142. *
  143. * On the first call to av_strtok(), s should point to the string to
  144. * parse, and the value of saveptr is ignored. In subsequent calls, s
  145. * should be NULL, and saveptr should be unchanged since the previous
  146. * call.
  147. *
  148. * This function is similar to strtok_r() defined in POSIX.1.
  149. *
  150. * @param s the string to parse, may be NULL
  151. * @param delim 0-terminated list of token delimiters, must be non-NULL
  152. * @param saveptr user-provided pointer which points to stored
  153. * information necessary for av_strtok() to continue scanning the same
  154. * string. saveptr is updated to point to the next character after the
  155. * first delimiter found, or to NULL if the string was terminated
  156. * @return the found token, or NULL when no token is found
  157. */
  158. char *av_strtok(char *s, const char *delim, char **saveptr);
  159. /**
  160. * Locale-independent conversion of ASCII characters to uppercase.
  161. */
  162. static inline int av_toupper(int c)
  163. {
  164. if (c >= 'a' && c <= 'z')
  165. c ^= 0x20;
  166. return c;
  167. }
  168. /**
  169. * Locale-independent conversion of ASCII characters to lowercase.
  170. */
  171. static inline int av_tolower(int c)
  172. {
  173. if (c >= 'A' && c <= 'Z')
  174. c ^= 0x20;
  175. return c;
  176. }
  177. /**
  178. * Locale-independent case-insensitive compare.
  179. * @note This means only ASCII-range characters are case-insensitive
  180. */
  181. int av_strcasecmp(const char *a, const char *b);
  182. /**
  183. * Locale-independent case-insensitive compare.
  184. * @note This means only ASCII-range characters are case-insensitive
  185. */
  186. int av_strncasecmp(const char *a, const char *b, size_t n);
  187. /**
  188. * Thread safe basename.
  189. * @param path the path, on DOS both \ and / are considered separators.
  190. * @return pointer to the basename substring.
  191. */
  192. const char *av_basename(const char *path);
  193. /**
  194. * Thread safe dirname.
  195. * @param path the path, on DOS both \ and / are considered separators.
  196. * @return the path with the separator replaced by the string terminator or ".".
  197. * @note the function may change the input string.
  198. */
  199. const char *av_dirname(char *path);
  200. /**
  201. * @}
  202. */
  203. #endif /* AVUTIL_AVSTRING_H */