string.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. /* Copyright (C) 1991-1993, 1995-2003, 2004 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, write to the Free
  13. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  14. 02111-1307 USA. */
  15. /*
  16. * ISO C99 Standard: 7.21 String handling <string.h>
  17. */
  18. #ifndef _STRING_H
  19. #define _STRING_H 1
  20. #include <features.h>
  21. __BEGIN_DECLS
  22. /* Get size_t and NULL from <stddef.h>. */
  23. #define __need_size_t
  24. #define __need_NULL
  25. #include <stddef.h>
  26. __BEGIN_NAMESPACE_STD
  27. /* Copy N bytes of SRC to DEST. */
  28. extern void *memcpy (void *__restrict __dest,
  29. __const void *__restrict __src, size_t __n)
  30. __THROW __nonnull ((1, 2));
  31. libc_hidden_proto(memcpy)
  32. /* Copy N bytes of SRC to DEST, guaranteeing
  33. correct behavior for overlapping strings. */
  34. extern void *memmove (void *__dest, __const void *__src, size_t __n)
  35. __THROW __nonnull ((1, 2));
  36. libc_hidden_proto(memmove)
  37. __END_NAMESPACE_STD
  38. /* Copy no more than N bytes of SRC to DEST, stopping when C is found.
  39. Return the position in DEST one byte past where C was copied,
  40. or NULL if C was not found in the first N bytes of SRC. */
  41. #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
  42. extern void *memccpy (void *__restrict __dest, __const void *__restrict __src,
  43. int __c, size_t __n)
  44. __THROW __nonnull ((1, 2));
  45. libc_hidden_proto(memccpy)
  46. #endif /* SVID. */
  47. __BEGIN_NAMESPACE_STD
  48. /* Set N bytes of S to C. */
  49. extern void *memset (void *__s, int __c, size_t __n) __THROW __nonnull ((1));
  50. libc_hidden_proto(memset)
  51. /* Compare N bytes of S1 and S2. */
  52. extern int memcmp (__const void *__s1, __const void *__s2, size_t __n)
  53. __THROW __attribute_pure__ __nonnull ((1, 2));
  54. libc_hidden_proto(memcmp)
  55. /* Search N bytes of S for C. */
  56. extern void *memchr (__const void *__s, int __c, size_t __n)
  57. __THROW __attribute_pure__ __nonnull ((1));
  58. libc_hidden_proto(memchr)
  59. __END_NAMESPACE_STD
  60. #ifdef __USE_GNU
  61. /* Search in S for C. This is similar to `memchr' but there is no
  62. length limit. */
  63. extern void *rawmemchr (__const void *__s, int __c)
  64. __THROW __attribute_pure__ __nonnull ((1));
  65. libc_hidden_proto(rawmemchr)
  66. /* Search N bytes of S for the final occurrence of C. */
  67. extern void *memrchr (__const void *__s, int __c, size_t __n)
  68. __THROW __attribute_pure__ __nonnull ((1));
  69. libc_hidden_proto(memrchr)
  70. #endif
  71. __BEGIN_NAMESPACE_STD
  72. /* Copy SRC to DEST. */
  73. extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
  74. __THROW __nonnull ((1, 2));
  75. libc_hidden_proto(strcpy)
  76. /* Copy no more than N characters of SRC to DEST. */
  77. extern char *strncpy (char *__restrict __dest,
  78. __const char *__restrict __src, size_t __n)
  79. __THROW __nonnull ((1, 2));
  80. libc_hidden_proto(strncpy)
  81. /* Append SRC onto DEST. */
  82. extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
  83. __THROW __nonnull ((1, 2));
  84. libc_hidden_proto(strcat)
  85. /* Append no more than N characters from SRC onto DEST. */
  86. extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
  87. size_t __n) __THROW __nonnull ((1, 2));
  88. libc_hidden_proto(strncat)
  89. /* Compare S1 and S2. */
  90. extern int strcmp (__const char *__s1, __const char *__s2)
  91. __THROW __attribute_pure__ __nonnull ((1, 2));
  92. libc_hidden_proto(strcmp)
  93. /* Compare N characters of S1 and S2. */
  94. extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
  95. __THROW __attribute_pure__ __nonnull ((1, 2));
  96. libc_hidden_proto(strncmp)
  97. /* Compare the collated forms of S1 and S2. */
  98. extern int strcoll (__const char *__s1, __const char *__s2)
  99. __THROW __attribute_pure__ __nonnull ((1, 2));
  100. libc_hidden_proto(strcoll)
  101. /* Put a transformation of SRC into no more than N bytes of DEST. */
  102. extern size_t strxfrm (char *__restrict __dest,
  103. __const char *__restrict __src, size_t __n)
  104. __THROW __nonnull ((2));
  105. __END_NAMESPACE_STD
  106. #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
  107. /* The following functions are equivalent to the both above but they
  108. take the locale they use for the collation as an extra argument.
  109. This is not standardsized but something like will come. */
  110. # include <xlocale.h>
  111. /* Compare the collated forms of S1 and S2 using rules from L. */
  112. extern int strcoll_l (__const char *__s1, __const char *__s2, __locale_t __l)
  113. __THROW __attribute_pure__ __nonnull ((1, 2, 3));
  114. libc_hidden_proto(strcoll_l)
  115. /* Put a transformation of SRC into no more than N bytes of DEST. */
  116. extern size_t strxfrm_l (char *__dest, __const char *__src, size_t __n,
  117. __locale_t __l) __THROW __nonnull ((2, 4));
  118. libc_hidden_proto(strxfrm_l)
  119. #endif
  120. #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
  121. /* Duplicate S, returning an identical malloc'd string. */
  122. extern char *strdup (__const char *__s)
  123. __THROW __attribute_malloc__ __nonnull ((1));
  124. libc_hidden_proto(strdup)
  125. #endif
  126. /* Return a malloc'd copy of at most N bytes of STRING. The
  127. resultant string is terminated even if no null terminator
  128. appears before STRING[N]. */
  129. #if defined __USE_GNU
  130. extern char *strndup (__const char *__string, size_t __n)
  131. __THROW __attribute_malloc__ __nonnull ((1));
  132. libc_hidden_proto(strndup)
  133. #endif
  134. #if defined __USE_GNU && defined __GNUC__
  135. /* Duplicate S, returning an identical alloca'd string. */
  136. # define strdupa(s) \
  137. (__extension__ \
  138. ({ \
  139. __const char *__old = (s); \
  140. size_t __len = strlen (__old) + 1; \
  141. char *__new = (char *) __builtin_alloca (__len); \
  142. (char *) memcpy (__new, __old, __len); \
  143. }))
  144. /* Return an alloca'd copy of at most N bytes of string. */
  145. # define strndupa(s, n) \
  146. (__extension__ \
  147. ({ \
  148. __const char *__old = (s); \
  149. size_t __len = strnlen (__old, (n)); \
  150. char *__new = (char *) __builtin_alloca (__len + 1); \
  151. __new[__len] = '\0'; \
  152. (char *) memcpy (__new, __old, __len); \
  153. }))
  154. #endif
  155. __BEGIN_NAMESPACE_STD
  156. /* Find the first occurrence of C in S. */
  157. extern char *strchr (__const char *__s, int __c)
  158. __THROW __attribute_pure__ __nonnull ((1));
  159. libc_hidden_proto(strchr)
  160. /* Find the last occurrence of C in S. */
  161. extern char *strrchr (__const char *__s, int __c)
  162. __THROW __attribute_pure__ __nonnull ((1));
  163. libc_hidden_proto(strrchr)
  164. __END_NAMESPACE_STD
  165. #ifdef __USE_GNU
  166. /* This function is similar to `strchr'. But it returns a pointer to
  167. the closing NUL byte in case C is not found in S. */
  168. extern char *strchrnul (__const char *__s, int __c)
  169. __THROW __attribute_pure__ __nonnull ((1));
  170. libc_hidden_proto(strchrnul)
  171. #endif
  172. __BEGIN_NAMESPACE_STD
  173. /* Return the length of the initial segment of S which
  174. consists entirely of characters not in REJECT. */
  175. extern size_t strcspn (__const char *__s, __const char *__reject)
  176. __THROW __attribute_pure__ __nonnull ((1, 2));
  177. libc_hidden_proto(strcspn)
  178. /* Return the length of the initial segment of S which
  179. consists entirely of characters in ACCEPT. */
  180. extern size_t strspn (__const char *__s, __const char *__accept)
  181. __THROW __attribute_pure__ __nonnull ((1, 2));
  182. libc_hidden_proto(strspn)
  183. /* Find the first occurrence in S of any character in ACCEPT. */
  184. extern char *strpbrk (__const char *__s, __const char *__accept)
  185. __THROW __attribute_pure__ __nonnull ((1, 2));
  186. libc_hidden_proto(strpbrk)
  187. /* Find the first occurrence of NEEDLE in HAYSTACK. */
  188. extern char *strstr (__const char *__haystack, __const char *__needle)
  189. __THROW __attribute_pure__ __nonnull ((1, 2));
  190. libc_hidden_proto(strstr)
  191. /* Divide S into tokens separated by characters in DELIM. */
  192. extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
  193. __THROW __nonnull ((2));
  194. libc_hidden_proto(strtok)
  195. __END_NAMESPACE_STD
  196. /* Divide S into tokens separated by characters in DELIM. Information
  197. passed between calls are stored in SAVE_PTR. */
  198. #if 0 /* uClibc: disabled */
  199. extern char *__strtok_r (char *__restrict __s,
  200. __const char *__restrict __delim,
  201. char **__restrict __save_ptr)
  202. __THROW __nonnull ((2, 3));
  203. #endif
  204. #if defined __USE_POSIX || defined __USE_MISC
  205. extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
  206. char **__restrict __save_ptr)
  207. __THROW __nonnull ((2, 3));
  208. libc_hidden_proto(strtok_r)
  209. #endif
  210. #ifdef __USE_GNU
  211. /* Similar to `strstr' but this function ignores the case of both strings. */
  212. extern char *strcasestr (__const char *__haystack, __const char *__needle)
  213. __THROW __attribute_pure__ __nonnull ((1, 2));
  214. libc_hidden_proto(strcasestr)
  215. #endif
  216. #ifdef __USE_GNU
  217. /* Find the first occurrence of NEEDLE in HAYSTACK.
  218. NEEDLE is NEEDLELEN bytes long;
  219. HAYSTACK is HAYSTACKLEN bytes long. */
  220. extern void *memmem (__const void *__haystack, size_t __haystacklen,
  221. __const void *__needle, size_t __needlelen)
  222. __THROW __attribute_pure__ __nonnull ((1, 3));
  223. /* Copy N bytes of SRC to DEST, return pointer to bytes after the
  224. last written byte. */
  225. #if 0 /* uClibc: disabled */
  226. extern void *__mempcpy (void *__restrict __dest,
  227. __const void *__restrict __src, size_t __n)
  228. __THROW __nonnull ((1, 2));
  229. #endif
  230. extern void *mempcpy (void *__restrict __dest,
  231. __const void *__restrict __src, size_t __n)
  232. __THROW __nonnull ((1, 2));
  233. libc_hidden_proto(mempcpy)
  234. #endif
  235. __BEGIN_NAMESPACE_STD
  236. /* Return the length of S. */
  237. extern size_t strlen (__const char *__s)
  238. __THROW __attribute_pure__ __nonnull ((1));
  239. libc_hidden_proto(strlen)
  240. __END_NAMESPACE_STD
  241. #ifdef __USE_GNU
  242. /* Find the length of STRING, but scan at most MAXLEN characters.
  243. If no '\0' terminator is found in that many characters, return MAXLEN. */
  244. extern size_t strnlen (__const char *__string, size_t __maxlen)
  245. __THROW __attribute_pure__ __nonnull ((1));
  246. libc_hidden_proto(strnlen)
  247. #endif
  248. __BEGIN_NAMESPACE_STD
  249. /* Return a string describing the meaning of the `errno' code in ERRNUM. */
  250. extern char *strerror (int __errnum) __THROW;
  251. libc_hidden_proto(strerror)
  252. __END_NAMESPACE_STD
  253. #if defined __USE_XOPEN2K || defined __USE_MISC
  254. /* Reentrant version of `strerror'.
  255. There are 2 flavors of `strerror_r', GNU which returns the string
  256. and may or may not use the supplied temporary buffer and POSIX one
  257. which fills the string into the buffer.
  258. To use the POSIX version, -D_XOPEN_SOURCE=600 or -D_POSIX_C_SOURCE=200112L
  259. without -D_GNU_SOURCE is needed, otherwise the GNU version is
  260. preferred. */
  261. # if defined __USE_XOPEN2K && !defined __USE_GNU
  262. /* Fill BUF with a string describing the meaning of the `errno' code in
  263. ERRNUM. */
  264. extern int __xpg_strerror_r (int __errnum, char *__buf, size_t __buflen)
  265. __THROW __nonnull ((2));
  266. libc_hidden_proto(__xpg_strerror_r)
  267. # ifdef __REDIRECT_NTH
  268. extern int __REDIRECT_NTH (strerror_r,
  269. (int __errnum, char *__buf, size_t __buflen),
  270. __xpg_strerror_r) __nonnull ((2));
  271. # else
  272. # define strerror_r __xpg_strerror_r
  273. # endif
  274. # else
  275. /* If a temporary buffer is required, at most BUFLEN bytes of BUF will be
  276. used. */
  277. extern char *__glibc_strerror_r (int __errnum, char *__buf, size_t __buflen)
  278. __THROW __nonnull ((2));
  279. libc_hidden_proto(__glibc_strerror_r)
  280. # ifdef __REDIRECT_NTH
  281. extern char * __REDIRECT_NTH (strerror_r,
  282. (int __errnum, char *__buf, size_t __buflen),
  283. __glibc_strerror_r) __nonnull ((2));
  284. # else
  285. # define strerror_r __glibc_strerror_r
  286. # endif
  287. # endif
  288. #endif
  289. /* We define this function always since `bzero' is sometimes needed when
  290. the namespace rules does not allow this. */
  291. #if 0 /* uClibc: disabled */
  292. extern void __bzero (void *__s, size_t __n) __THROW __nonnull ((1));
  293. #endif
  294. #ifdef __USE_BSD
  295. # ifdef __UCLIBC_SUSV3_LEGACY__
  296. /* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
  297. extern void bcopy (__const void *__src, void *__dest, size_t __n)
  298. __THROW __nonnull ((1, 2));
  299. /* Set N bytes of S to 0. */
  300. extern void bzero (void *__s, size_t __n) __THROW __nonnull ((1));
  301. /* Compare N bytes of S1 and S2 (same as memcmp). */
  302. extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
  303. __THROW __attribute_pure__ __nonnull ((1, 2));
  304. /* Find the first occurrence of C in S (same as strchr). */
  305. extern char *index (__const char *__s, int __c)
  306. __THROW __attribute_pure__ __nonnull ((1));
  307. /* Find the last occurrence of C in S (same as strrchr). */
  308. extern char *rindex (__const char *__s, int __c)
  309. __THROW __attribute_pure__ __nonnull ((1));
  310. # else
  311. # ifdef __UCLIBC_SUSV3_LEGACY_MACROS__
  312. /* bcopy/bzero/bcmp/index/rindex are marked LEGACY in SuSv3.
  313. * They are replaced as proposed by SuSv3. Don't sync this part
  314. * with glibc and keep it in sync with strings.h. */
  315. # define bcopy(src,dest,n) (memmove((dest), (src), (n)), (void) 0)
  316. # define bzero(s,n) (memset((s), '\0', (n)), (void) 0)
  317. # define bcmp(s1,s2,n) memcmp((s1), (s2), (size_t)(n))
  318. # define index(s,c) strchr((s), (c))
  319. # define rindex(s,c) strrchr((s), (c))
  320. # endif
  321. # endif
  322. /* Return the position of the first bit set in I, or 0 if none are set.
  323. The least-significant bit is position 1, the most-significant 32. */
  324. extern int ffs (int __i) __THROW __attribute__ ((__const__));
  325. libc_hidden_proto(ffs)
  326. /* The following two functions are non-standard but necessary for non-32 bit
  327. platforms. */
  328. #ifdef __USE_GNU
  329. extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
  330. # ifdef __GNUC__
  331. __extension__ extern int ffsll (long long int __ll)
  332. __THROW __attribute__ ((__const__));
  333. # endif
  334. # endif
  335. /* Compare S1 and S2, ignoring case. */
  336. extern int strcasecmp (__const char *__s1, __const char *__s2)
  337. __THROW __attribute_pure__ __nonnull ((1, 2));
  338. libc_hidden_proto(strcasecmp)
  339. /* Compare no more than N chars of S1 and S2, ignoring case. */
  340. extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
  341. __THROW __attribute_pure__ __nonnull ((1, 2));
  342. libc_hidden_proto(strncasecmp)
  343. #endif /* Use BSD. */
  344. #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
  345. /* Again versions of a few functions which use the given locale instead
  346. of the global one. */
  347. extern int strcasecmp_l (__const char *__s1, __const char *__s2,
  348. __locale_t __loc)
  349. __THROW __attribute_pure__ __nonnull ((1, 2, 3));
  350. libc_hidden_proto(strcasecmp_l)
  351. extern int strncasecmp_l (__const char *__s1, __const char *__s2,
  352. size_t __n, __locale_t __loc)
  353. __THROW __attribute_pure__ __nonnull ((1, 2, 4));
  354. libc_hidden_proto(strncasecmp_l)
  355. #endif
  356. #ifdef __USE_BSD
  357. /* Return the next DELIM-delimited token from *STRINGP,
  358. terminating it with a '\0', and update *STRINGP to point past it. */
  359. extern char *strsep (char **__restrict __stringp,
  360. __const char *__restrict __delim)
  361. __THROW __nonnull ((1, 2));
  362. libc_hidden_proto(strsep)
  363. #endif
  364. #ifdef __USE_GNU
  365. /* Compare S1 and S2 as strings holding name & indices/version numbers. */
  366. extern int strverscmp (__const char *__s1, __const char *__s2)
  367. __THROW __attribute_pure__ __nonnull ((1, 2));
  368. libc_hidden_proto(strverscmp)
  369. /* Return a string describing the meaning of the signal number in SIG. */
  370. extern char *strsignal (int __sig) __THROW;
  371. libc_hidden_proto(strsignal)
  372. /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
  373. # if 0 /* uClibc: disabled */
  374. extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
  375. __THROW __nonnull ((1, 2));
  376. # endif
  377. extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
  378. __THROW __nonnull ((1, 2));
  379. libc_hidden_proto(stpcpy)
  380. /* Copy no more than N characters of SRC to DEST, returning the address of
  381. the last character written into DEST. */
  382. # if 0 /* uClibc: disabled */
  383. extern char *__stpncpy (char *__restrict __dest,
  384. __const char *__restrict __src, size_t __n)
  385. __THROW __nonnull ((1, 2));
  386. # endif
  387. extern char *stpncpy (char *__restrict __dest,
  388. __const char *__restrict __src, size_t __n)
  389. __THROW __nonnull ((1, 2));
  390. # if 0 /* uClibc does not support strfry or memfrob. */
  391. /* Sautee STRING briskly. */
  392. extern char *strfry (char *__string) __THROW __nonnull ((1));
  393. /* Frobnicate N bytes of S. */
  394. extern void *memfrob (void *__s, size_t __n) __THROW __nonnull ((1));
  395. # endif
  396. # ifndef basename
  397. /* Return the file name within directory of FILENAME. We don't
  398. declare the function if the `basename' macro is available (defined
  399. in <libgen.h>) which makes the XPG version of this function
  400. available. */
  401. extern char *basename (__const char *__filename) __THROW __nonnull ((1));
  402. libc_hidden_proto(basename)
  403. # endif
  404. #endif /* __USE_GNU */
  405. #ifdef __USE_BSD
  406. /* Two OpenBSD extension functions. */
  407. extern size_t strlcat(char *__restrict dst, const char *__restrict src,
  408. size_t n) __THROW __nonnull ((1, 2));
  409. libc_hidden_proto(strlcat)
  410. extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
  411. size_t n) __THROW __nonnull ((1, 2));
  412. libc_hidden_proto(strlcpy)
  413. #endif
  414. __END_DECLS
  415. #if defined(_LIBC) && defined(__UCLIBC_HAS_STRING_ARCH_OPT__)
  416. # if defined __i386__
  417. # include <../libc/string/i386/string.h>
  418. # endif
  419. #endif
  420. #endif /* string.h */