Use single bits/msq.h for all architectures.
[glibc.git] / manual / string.texi
bloba1c58e58fa488f7807c87390ea7b42417f24106c
1 @node String and Array Utilities, Character Set Handling, Character Handling, Top
2 @c %MENU% Utilities for copying and comparing strings and arrays
3 @chapter String and Array Utilities
5 Operations on strings (null-terminated byte sequences) are an important part of
6 many programs.  @Theglibc{} provides an extensive set of string
7 utility functions, including functions for copying, concatenating,
8 comparing, and searching strings.  Many of these functions can also
9 operate on arbitrary regions of storage; for example, the @code{memcpy}
10 function can be used to copy the contents of any kind of array.
12 It's fairly common for beginning C programmers to ``reinvent the wheel''
13 by duplicating this functionality in their own code, but it pays to
14 become familiar with the library functions and to make use of them,
15 since this offers benefits in maintenance, efficiency, and portability.
17 For instance, you could easily compare one string to another in two
18 lines of C code, but if you use the built-in @code{strcmp} function,
19 you're less likely to make a mistake.  And, since these library
20 functions are typically highly optimized, your program may run faster
21 too.
23 @menu
24 * Representation of Strings::   Introduction to basic concepts.
25 * String/Array Conventions::    Whether to use a string function or an
26                                  arbitrary array function.
27 * String Length::               Determining the length of a string.
28 * Copying Strings and Arrays::  Functions to copy strings and arrays.
29 * Concatenating Strings::       Functions to concatenate strings while copying.
30 * Truncating Strings::          Functions to truncate strings while copying.
31 * String/Array Comparison::     Functions for byte-wise and character-wise
32                                  comparison.
33 * Collation Functions::         Functions for collating strings.
34 * Search Functions::            Searching for a specific element or substring.
35 * Finding Tokens in a String::  Splitting a string into tokens by looking
36                                  for delimiters.
37 * Erasing Sensitive Data::      Clearing memory which contains sensitive
38                                  data, after it's no longer needed.
39 * Shuffling Bytes::             Or how to flash-cook a string.
40 * Obfuscating Data::            Reversibly obscuring data from casual view.
41 * Encode Binary Data::          Encoding and Decoding of Binary Data.
42 * Argz and Envz Vectors::       Null-separated string vectors.
43 @end menu
45 @node Representation of Strings
46 @section Representation of Strings
47 @cindex string, representation of
49 This section is a quick summary of string concepts for beginning C
50 programmers.  It describes how strings are represented in C
51 and some common pitfalls.  If you are already familiar with this
52 material, you can skip this section.
54 @cindex string
55 A @dfn{string} is a null-terminated array of bytes of type @code{char},
56 including the terminating null byte.  String-valued
57 variables are usually declared to be pointers of type @code{char *}.
58 Such variables do not include space for the text of a string; that has
59 to be stored somewhere else---in an array variable, a string constant,
60 or dynamically allocated memory (@pxref{Memory Allocation}).  It's up to
61 you to store the address of the chosen memory space into the pointer
62 variable.  Alternatively you can store a @dfn{null pointer} in the
63 pointer variable.  The null pointer does not point anywhere, so
64 attempting to reference the string it points to gets an error.
66 @cindex multibyte character
67 @cindex multibyte string
68 @cindex wide string
69 A @dfn{multibyte character} is a sequence of one or more bytes that
70 represents a single character using the locale's encoding scheme; a
71 null byte always represents the null character.  A @dfn{multibyte
72 string} is a string that consists entirely of multibyte
73 characters.  In contrast, a @dfn{wide string} is a null-terminated
74 sequence of @code{wchar_t} objects.  A wide-string variable is usually
75 declared to be a pointer of type @code{wchar_t *}, by analogy with
76 string variables and @code{char *}.  @xref{Extended Char Intro}.
78 @cindex null byte
79 @cindex null wide character
80 By convention, the @dfn{null byte}, @code{'\0'},
81 marks the end of a string and the @dfn{null wide character},
82 @code{L'\0'}, marks the end of a wide string.  For example, in
83 testing to see whether the @code{char *} variable @var{p} points to a
84 null byte marking the end of a string, you can write
85 @code{!*@var{p}} or @code{*@var{p} == '\0'}.
87 A null byte is quite different conceptually from a null pointer,
88 although both are represented by the integer constant @code{0}.
90 @cindex string literal
91 A @dfn{string literal} appears in C program source as a multibyte
92 string between double-quote characters (@samp{"}).  If the
93 initial double-quote character is immediately preceded by a capital
94 @samp{L} (ell) character (as in @code{L"foo"}), it is a wide string
95 literal.  String literals can also contribute to @dfn{string
96 concatenation}: @code{"a" "b"} is the same as @code{"ab"}.
97 For wide strings one can use either
98 @code{L"a" L"b"} or @code{L"a" "b"}.  Modification of string literals is
99 not allowed by the GNU C compiler, because literals are placed in
100 read-only storage.
102 Arrays that are declared @code{const} cannot be modified
103 either.  It's generally good style to declare non-modifiable string
104 pointers to be of type @code{const char *}, since this often allows the
105 C compiler to detect accidental modifications as well as providing some
106 amount of documentation about what your program intends to do with the
107 string.
109 The amount of memory allocated for a byte array may extend past the null byte
110 that marks the end of the string that the array contains.  In this
111 document, the term @dfn{allocated size} is always used to refer to the
112 total amount of memory allocated for an array, while the term
113 @dfn{length} refers to the number of bytes up to (but not including)
114 the terminating null byte.  Wide strings are similar, except their
115 sizes and lengths count wide characters, not bytes.
116 @cindex length of string
117 @cindex allocation size of string
118 @cindex size of string
119 @cindex string length
120 @cindex string allocation
122 A notorious source of program bugs is trying to put more bytes into a
123 string than fit in its allocated size.  When writing code that extends
124 strings or moves bytes into a pre-allocated array, you should be
125 very careful to keep track of the length of the text and make explicit
126 checks for overflowing the array.  Many of the library functions
127 @emph{do not} do this for you!  Remember also that you need to allocate
128 an extra byte to hold the null byte that marks the end of the
129 string.
131 @cindex single-byte string
132 @cindex multibyte string
133 Originally strings were sequences of bytes where each byte represented a
134 single character.  This is still true today if the strings are encoded
135 using a single-byte character encoding.  Things are different if the
136 strings are encoded using a multibyte encoding (for more information on
137 encodings see @ref{Extended Char Intro}).  There is no difference in
138 the programming interface for these two kind of strings; the programmer
139 has to be aware of this and interpret the byte sequences accordingly.
141 But since there is no separate interface taking care of these
142 differences the byte-based string functions are sometimes hard to use.
143 Since the count parameters of these functions specify bytes a call to
144 @code{memcpy} could cut a multibyte character in the middle and put an
145 incomplete (and therefore unusable) byte sequence in the target buffer.
147 @cindex wide string
148 To avoid these problems later versions of the @w{ISO C} standard
149 introduce a second set of functions which are operating on @dfn{wide
150 characters} (@pxref{Extended Char Intro}).  These functions don't have
151 the problems the single-byte versions have since every wide character is
152 a legal, interpretable value.  This does not mean that cutting wide
153 strings at arbitrary points is without problems.  It normally
154 is for alphabet-based languages (except for non-normalized text) but
155 languages based on syllables still have the problem that more than one
156 wide character is necessary to complete a logical unit.  This is a
157 higher level problem which the @w{C library} functions are not designed
158 to solve.  But it is at least good that no invalid byte sequences can be
159 created.  Also, the higher level functions can also much more easily operate
160 on wide characters than on multibyte characters so that a common strategy
161 is to use wide characters internally whenever text is more than simply
162 copied.
164 The remaining of this chapter will discuss the functions for handling
165 wide strings in parallel with the discussion of
166 strings since there is almost always an exact equivalent
167 available.
169 @node String/Array Conventions
170 @section String and Array Conventions
172 This chapter describes both functions that work on arbitrary arrays or
173 blocks of memory, and functions that are specific to strings and wide
174 strings.
176 Functions that operate on arbitrary blocks of memory have names
177 beginning with @samp{mem} and @samp{wmem} (such as @code{memcpy} and
178 @code{wmemcpy}) and invariably take an argument which specifies the size
179 (in bytes and wide characters respectively) of the block of memory to
180 operate on.  The array arguments and return values for these functions
181 have type @code{void *} or @code{wchar_t}.  As a matter of style, the
182 elements of the arrays used with the @samp{mem} functions are referred
183 to as ``bytes''.  You can pass any kind of pointer to these functions,
184 and the @code{sizeof} operator is useful in computing the value for the
185 size argument.  Parameters to the @samp{wmem} functions must be of type
186 @code{wchar_t *}.  These functions are not really usable with anything
187 but arrays of this type.
189 In contrast, functions that operate specifically on strings and wide
190 strings have names beginning with @samp{str} and @samp{wcs}
191 respectively (such as @code{strcpy} and @code{wcscpy}) and look for a
192 terminating null byte or null wide character instead of requiring an explicit
193 size argument to be passed.  (Some of these functions accept a specified
194 maximum length, but they also check for premature termination.)
195 The array arguments and return values for these
196 functions have type @code{char *} and @code{wchar_t *} respectively, and
197 the array elements are referred to as ``bytes'' and ``wide
198 characters''.
200 In many cases, there are both @samp{mem} and @samp{str}/@samp{wcs}
201 versions of a function.  The one that is more appropriate to use depends
202 on the exact situation.  When your program is manipulating arbitrary
203 arrays or blocks of storage, then you should always use the @samp{mem}
204 functions.  On the other hand, when you are manipulating
205 strings it is usually more convenient to use the @samp{str}/@samp{wcs}
206 functions, unless you already know the length of the string in advance.
207 The @samp{wmem} functions should be used for wide character arrays with
208 known size.
210 @cindex wint_t
211 @cindex parameter promotion
212 Some of the memory and string functions take single characters as
213 arguments.  Since a value of type @code{char} is automatically promoted
214 into a value of type @code{int} when used as a parameter, the functions
215 are declared with @code{int} as the type of the parameter in question.
216 In case of the wide character functions the situation is similar: the
217 parameter type for a single wide character is @code{wint_t} and not
218 @code{wchar_t}.  This would for many implementations not be necessary
219 since @code{wchar_t} is large enough to not be automatically
220 promoted, but since the @w{ISO C} standard does not require such a
221 choice of types the @code{wint_t} type is used.
223 @node String Length
224 @section String Length
226 You can get the length of a string using the @code{strlen} function.
227 This function is declared in the header file @file{string.h}.
228 @pindex string.h
230 @deftypefun size_t strlen (const char *@var{s})
231 @standards{ISO, string.h}
232 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
233 The @code{strlen} function returns the length of the
234 string @var{s} in bytes.  (In other words, it returns the offset of the
235 terminating null byte within the array.)
237 For example,
238 @smallexample
239 strlen ("hello, world")
240     @result{} 12
241 @end smallexample
243 When applied to an array, the @code{strlen} function returns
244 the length of the string stored there, not its allocated size.  You can
245 get the allocated size of the array that holds a string using
246 the @code{sizeof} operator:
248 @smallexample
249 char string[32] = "hello, world";
250 sizeof (string)
251     @result{} 32
252 strlen (string)
253     @result{} 12
254 @end smallexample
256 But beware, this will not work unless @var{string} is the
257 array itself, not a pointer to it.  For example:
259 @smallexample
260 char string[32] = "hello, world";
261 char *ptr = string;
262 sizeof (string)
263     @result{} 32
264 sizeof (ptr)
265     @result{} 4  /* @r{(on a machine with 4 byte pointers)} */
266 @end smallexample
268 This is an easy mistake to make when you are working with functions that
269 take string arguments; those arguments are always pointers, not arrays.
271 It must also be noted that for multibyte encoded strings the return
272 value does not have to correspond to the number of characters in the
273 string.  To get this value the string can be converted to wide
274 characters and @code{wcslen} can be used or something like the following
275 code can be used:
277 @smallexample
278 /* @r{The input is in @code{string}.}
279    @r{The length is expected in @code{n}.}  */
281   mbstate_t t;
282   char *scopy = string;
283   /* In initial state.  */
284   memset (&t, '\0', sizeof (t));
285   /* Determine number of characters.  */
286   n = mbsrtowcs (NULL, &scopy, strlen (scopy), &t);
288 @end smallexample
290 This is cumbersome to do so if the number of characters (as opposed to
291 bytes) is needed often it is better to work with wide characters.
292 @end deftypefun
294 The wide character equivalent is declared in @file{wchar.h}.
296 @deftypefun size_t wcslen (const wchar_t *@var{ws})
297 @standards{ISO, wchar.h}
298 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
299 The @code{wcslen} function is the wide character equivalent to
300 @code{strlen}.  The return value is the number of wide characters in the
301 wide string pointed to by @var{ws} (this is also the offset of
302 the terminating null wide character of @var{ws}).
304 Since there are no multi wide character sequences making up one wide
305 character the return value is not only the offset in the array, it is
306 also the number of wide characters.
308 This function was introduced in @w{Amendment 1} to @w{ISO C90}.
309 @end deftypefun
311 @deftypefun size_t strnlen (const char *@var{s}, size_t @var{maxlen})
312 @standards{GNU, string.h}
313 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
314 If the array @var{s} of size @var{maxlen} contains a null byte,
315 the @code{strnlen} function returns the length of the string @var{s} in
316 bytes.  Otherwise it
317 returns @var{maxlen}.  Therefore this function is equivalent to
318 @code{(strlen (@var{s}) < @var{maxlen} ? strlen (@var{s}) : @var{maxlen})}
319 but it
320 is more efficient and works even if @var{s} is not null-terminated so
321 long as @var{maxlen} does not exceed the size of @var{s}'s array.
323 @smallexample
324 char string[32] = "hello, world";
325 strnlen (string, 32)
326     @result{} 12
327 strnlen (string, 5)
328     @result{} 5
329 @end smallexample
331 This function is a GNU extension and is declared in @file{string.h}.
332 @end deftypefun
334 @deftypefun size_t wcsnlen (const wchar_t *@var{ws}, size_t @var{maxlen})
335 @standards{GNU, wchar.h}
336 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
337 @code{wcsnlen} is the wide character equivalent to @code{strnlen}.  The
338 @var{maxlen} parameter specifies the maximum number of wide characters.
340 This function is a GNU extension and is declared in @file{wchar.h}.
341 @end deftypefun
343 @node Copying Strings and Arrays
344 @section Copying Strings and Arrays
346 You can use the functions described in this section to copy the contents
347 of strings, wide strings, and arrays.  The @samp{str} and @samp{mem}
348 functions are declared in @file{string.h} while the @samp{w} functions
349 are declared in @file{wchar.h}.
350 @pindex string.h
351 @pindex wchar.h
352 @cindex copying strings and arrays
353 @cindex string copy functions
354 @cindex array copy functions
355 @cindex concatenating strings
356 @cindex string concatenation functions
358 A helpful way to remember the ordering of the arguments to the functions
359 in this section is that it corresponds to an assignment expression, with
360 the destination array specified to the left of the source array.  Most
361 of these functions return the address of the destination array; a few
362 return the address of the destination's terminating null, or of just
363 past the destination.
365 Most of these functions do not work properly if the source and
366 destination arrays overlap.  For example, if the beginning of the
367 destination array overlaps the end of the source array, the original
368 contents of that part of the source array may get overwritten before it
369 is copied.  Even worse, in the case of the string functions, the null
370 byte marking the end of the string may be lost, and the copy
371 function might get stuck in a loop trashing all the memory allocated to
372 your program.
374 All functions that have problems copying between overlapping arrays are
375 explicitly identified in this manual.  In addition to functions in this
376 section, there are a few others like @code{sprintf} (@pxref{Formatted
377 Output Functions}) and @code{scanf} (@pxref{Formatted Input
378 Functions}).
380 @deftypefun {void *} memcpy (void *restrict @var{to}, const void *restrict @var{from}, size_t @var{size})
381 @standards{ISO, string.h}
382 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
383 The @code{memcpy} function copies @var{size} bytes from the object
384 beginning at @var{from} into the object beginning at @var{to}.  The
385 behavior of this function is undefined if the two arrays @var{to} and
386 @var{from} overlap; use @code{memmove} instead if overlapping is possible.
388 The value returned by @code{memcpy} is the value of @var{to}.
390 Here is an example of how you might use @code{memcpy} to copy the
391 contents of an array:
393 @smallexample
394 struct foo *oldarray, *newarray;
395 int arraysize;
396 @dots{}
397 memcpy (new, old, arraysize * sizeof (struct foo));
398 @end smallexample
399 @end deftypefun
401 @deftypefun {wchar_t *} wmemcpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom}, size_t @var{size})
402 @standards{ISO, wchar.h}
403 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
404 The @code{wmemcpy} function copies @var{size} wide characters from the object
405 beginning at @var{wfrom} into the object beginning at @var{wto}.  The
406 behavior of this function is undefined if the two arrays @var{wto} and
407 @var{wfrom} overlap; use @code{wmemmove} instead if overlapping is possible.
409 The following is a possible implementation of @code{wmemcpy} but there
410 are more optimizations possible.
412 @smallexample
413 wchar_t *
414 wmemcpy (wchar_t *restrict wto, const wchar_t *restrict wfrom,
415          size_t size)
417   return (wchar_t *) memcpy (wto, wfrom, size * sizeof (wchar_t));
419 @end smallexample
421 The value returned by @code{wmemcpy} is the value of @var{wto}.
423 This function was introduced in @w{Amendment 1} to @w{ISO C90}.
424 @end deftypefun
426 @deftypefun {void *} mempcpy (void *restrict @var{to}, const void *restrict @var{from}, size_t @var{size})
427 @standards{GNU, string.h}
428 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
429 The @code{mempcpy} function is nearly identical to the @code{memcpy}
430 function.  It copies @var{size} bytes from the object beginning at
431 @code{from} into the object pointed to by @var{to}.  But instead of
432 returning the value of @var{to} it returns a pointer to the byte
433 following the last written byte in the object beginning at @var{to}.
434 I.e., the value is @code{((void *) ((char *) @var{to} + @var{size}))}.
436 This function is useful in situations where a number of objects shall be
437 copied to consecutive memory positions.
439 @smallexample
440 void *
441 combine (void *o1, size_t s1, void *o2, size_t s2)
443   void *result = malloc (s1 + s2);
444   if (result != NULL)
445     mempcpy (mempcpy (result, o1, s1), o2, s2);
446   return result;
448 @end smallexample
450 This function is a GNU extension.
451 @end deftypefun
453 @deftypefun {wchar_t *} wmempcpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom}, size_t @var{size})
454 @standards{GNU, wchar.h}
455 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
456 The @code{wmempcpy} function is nearly identical to the @code{wmemcpy}
457 function.  It copies @var{size} wide characters from the object
458 beginning at @code{wfrom} into the object pointed to by @var{wto}.  But
459 instead of returning the value of @var{wto} it returns a pointer to the
460 wide character following the last written wide character in the object
461 beginning at @var{wto}.  I.e., the value is @code{@var{wto} + @var{size}}.
463 This function is useful in situations where a number of objects shall be
464 copied to consecutive memory positions.
466 The following is a possible implementation of @code{wmemcpy} but there
467 are more optimizations possible.
469 @smallexample
470 wchar_t *
471 wmempcpy (wchar_t *restrict wto, const wchar_t *restrict wfrom,
472           size_t size)
474   return (wchar_t *) mempcpy (wto, wfrom, size * sizeof (wchar_t));
476 @end smallexample
478 This function is a GNU extension.
479 @end deftypefun
481 @deftypefun {void *} memmove (void *@var{to}, const void *@var{from}, size_t @var{size})
482 @standards{ISO, string.h}
483 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
484 @code{memmove} copies the @var{size} bytes at @var{from} into the
485 @var{size} bytes at @var{to}, even if those two blocks of space
486 overlap.  In the case of overlap, @code{memmove} is careful to copy the
487 original values of the bytes in the block at @var{from}, including those
488 bytes which also belong to the block at @var{to}.
490 The value returned by @code{memmove} is the value of @var{to}.
491 @end deftypefun
493 @deftypefun {wchar_t *} wmemmove (wchar_t *@var{wto}, const wchar_t *@var{wfrom}, size_t @var{size})
494 @standards{ISO, wchar.h}
495 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
496 @code{wmemmove} copies the @var{size} wide characters at @var{wfrom}
497 into the @var{size} wide characters at @var{wto}, even if those two
498 blocks of space overlap.  In the case of overlap, @code{wmemmove} is
499 careful to copy the original values of the wide characters in the block
500 at @var{wfrom}, including those wide characters which also belong to the
501 block at @var{wto}.
503 The following is a possible implementation of @code{wmemcpy} but there
504 are more optimizations possible.
506 @smallexample
507 wchar_t *
508 wmempcpy (wchar_t *restrict wto, const wchar_t *restrict wfrom,
509           size_t size)
511   return (wchar_t *) mempcpy (wto, wfrom, size * sizeof (wchar_t));
513 @end smallexample
515 The value returned by @code{wmemmove} is the value of @var{wto}.
517 This function is a GNU extension.
518 @end deftypefun
520 @deftypefun {void *} memccpy (void *restrict @var{to}, const void *restrict @var{from}, int @var{c}, size_t @var{size})
521 @standards{SVID, string.h}
522 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
523 This function copies no more than @var{size} bytes from @var{from} to
524 @var{to}, stopping if a byte matching @var{c} is found.  The return
525 value is a pointer into @var{to} one byte past where @var{c} was copied,
526 or a null pointer if no byte matching @var{c} appeared in the first
527 @var{size} bytes of @var{from}.
528 @end deftypefun
530 @deftypefun {void *} memset (void *@var{block}, int @var{c}, size_t @var{size})
531 @standards{ISO, string.h}
532 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
533 This function copies the value of @var{c} (converted to an
534 @code{unsigned char}) into each of the first @var{size} bytes of the
535 object beginning at @var{block}.  It returns the value of @var{block}.
536 @end deftypefun
538 @deftypefun {wchar_t *} wmemset (wchar_t *@var{block}, wchar_t @var{wc}, size_t @var{size})
539 @standards{ISO, wchar.h}
540 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
541 This function copies the value of @var{wc} into each of the first
542 @var{size} wide characters of the object beginning at @var{block}.  It
543 returns the value of @var{block}.
544 @end deftypefun
546 @deftypefun {char *} strcpy (char *restrict @var{to}, const char *restrict @var{from})
547 @standards{ISO, string.h}
548 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
549 This copies bytes from the string @var{from} (up to and including
550 the terminating null byte) into the string @var{to}.  Like
551 @code{memcpy}, this function has undefined results if the strings
552 overlap.  The return value is the value of @var{to}.
553 @end deftypefun
555 @deftypefun {wchar_t *} wcscpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom})
556 @standards{ISO, wchar.h}
557 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
558 This copies wide characters from the wide string @var{wfrom} (up to and
559 including the terminating null wide character) into the string
560 @var{wto}.  Like @code{wmemcpy}, this function has undefined results if
561 the strings overlap.  The return value is the value of @var{wto}.
562 @end deftypefun
564 @deftypefun {char *} strdup (const char *@var{s})
565 @standards{SVID, string.h}
566 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
567 This function copies the string @var{s} into a newly
568 allocated string.  The string is allocated using @code{malloc}; see
569 @ref{Unconstrained Allocation}.  If @code{malloc} cannot allocate space
570 for the new string, @code{strdup} returns a null pointer.  Otherwise it
571 returns a pointer to the new string.
572 @end deftypefun
574 @deftypefun {wchar_t *} wcsdup (const wchar_t *@var{ws})
575 @standards{GNU, wchar.h}
576 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
577 This function copies the wide string @var{ws}
578 into a newly allocated string.  The string is allocated using
579 @code{malloc}; see @ref{Unconstrained Allocation}.  If @code{malloc}
580 cannot allocate space for the new string, @code{wcsdup} returns a null
581 pointer.  Otherwise it returns a pointer to the new wide string.
583 This function is a GNU extension.
584 @end deftypefun
586 @deftypefun {char *} stpcpy (char *restrict @var{to}, const char *restrict @var{from})
587 @standards{Unknown origin, string.h}
588 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
589 This function is like @code{strcpy}, except that it returns a pointer to
590 the end of the string @var{to} (that is, the address of the terminating
591 null byte @code{to + strlen (from)}) rather than the beginning.
593 For example, this program uses @code{stpcpy} to concatenate @samp{foo}
594 and @samp{bar} to produce @samp{foobar}, which it then prints.
596 @smallexample
597 @include stpcpy.c.texi
598 @end smallexample
600 This function is part of POSIX.1-2008 and later editions, but was
601 available in @theglibc{} and other systems as an extension long before
602 it was standardized.
604 Its behavior is undefined if the strings overlap.  The function is
605 declared in @file{string.h}.
606 @end deftypefun
608 @deftypefun {wchar_t *} wcpcpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom})
609 @standards{GNU, wchar.h}
610 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
611 This function is like @code{wcscpy}, except that it returns a pointer to
612 the end of the string @var{wto} (that is, the address of the terminating
613 null wide character @code{wto + wcslen (wfrom)}) rather than the beginning.
615 This function is not part of ISO or POSIX but was found useful while
616 developing @theglibc{} itself.
618 The behavior of @code{wcpcpy} is undefined if the strings overlap.
620 @code{wcpcpy} is a GNU extension and is declared in @file{wchar.h}.
621 @end deftypefun
623 @deftypefn {Macro} {char *} strdupa (const char *@var{s})
624 @standards{GNU, string.h}
625 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
626 This macro is similar to @code{strdup} but allocates the new string
627 using @code{alloca} instead of @code{malloc} (@pxref{Variable Size
628 Automatic}).  This means of course the returned string has the same
629 limitations as any block of memory allocated using @code{alloca}.
631 For obvious reasons @code{strdupa} is implemented only as a macro;
632 you cannot get the address of this function.  Despite this limitation
633 it is a useful function.  The following code shows a situation where
634 using @code{malloc} would be a lot more expensive.
636 @smallexample
637 @include strdupa.c.texi
638 @end smallexample
640 Please note that calling @code{strtok} using @var{path} directly is
641 invalid.  It is also not allowed to call @code{strdupa} in the argument
642 list of @code{strtok} since @code{strdupa} uses @code{alloca}
643 (@pxref{Variable Size Automatic}) can interfere with the parameter
644 passing.
646 This function is only available if GNU CC is used.
647 @end deftypefn
649 @deftypefun void bcopy (const void *@var{from}, void *@var{to}, size_t @var{size})
650 @standards{BSD, string.h}
651 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
652 This is a partially obsolete alternative for @code{memmove}, derived from
653 BSD.  Note that it is not quite equivalent to @code{memmove}, because the
654 arguments are not in the same order and there is no return value.
655 @end deftypefun
657 @deftypefun void bzero (void *@var{block}, size_t @var{size})
658 @standards{BSD, string.h}
659 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
660 This is a partially obsolete alternative for @code{memset}, derived from
661 BSD.  Note that it is not as general as @code{memset}, because the only
662 value it can store is zero.
663 @end deftypefun
665 @node Concatenating Strings
666 @section Concatenating Strings
667 @pindex string.h
668 @pindex wchar.h
669 @cindex concatenating strings
670 @cindex string concatenation functions
672 The functions described in this section concatenate the contents of a
673 string or wide string to another.  They follow the string-copying
674 functions in their conventions.  @xref{Copying Strings and Arrays}.
675 @samp{strcat} is declared in the header file @file{string.h} while
676 @samp{wcscat} is declared in @file{wchar.h}.
678 @deftypefun {char *} strcat (char *restrict @var{to}, const char *restrict @var{from})
679 @standards{ISO, string.h}
680 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
681 The @code{strcat} function is similar to @code{strcpy}, except that the
682 bytes from @var{from} are concatenated or appended to the end of
683 @var{to}, instead of overwriting it.  That is, the first byte from
684 @var{from} overwrites the null byte marking the end of @var{to}.
686 An equivalent definition for @code{strcat} would be:
688 @smallexample
689 char *
690 strcat (char *restrict to, const char *restrict from)
692   strcpy (to + strlen (to), from);
693   return to;
695 @end smallexample
697 This function has undefined results if the strings overlap.
699 As noted below, this function has significant performance issues.
700 @end deftypefun
702 @deftypefun {wchar_t *} wcscat (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom})
703 @standards{ISO, wchar.h}
704 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
705 The @code{wcscat} function is similar to @code{wcscpy}, except that the
706 wide characters from @var{wfrom} are concatenated or appended to the end of
707 @var{wto}, instead of overwriting it.  That is, the first wide character from
708 @var{wfrom} overwrites the null wide character marking the end of @var{wto}.
710 An equivalent definition for @code{wcscat} would be:
712 @smallexample
713 wchar_t *
714 wcscat (wchar_t *wto, const wchar_t *wfrom)
716   wcscpy (wto + wcslen (wto), wfrom);
717   return wto;
719 @end smallexample
721 This function has undefined results if the strings overlap.
723 As noted below, this function has significant performance issues.
724 @end deftypefun
726 Programmers using the @code{strcat} or @code{wcscat} function (or the
727 @code{strncat} or @code{wcsncat} functions defined in
728 a later section, for that matter)
729 can easily be recognized as lazy and reckless.  In almost all situations
730 the lengths of the participating strings are known (it better should be
731 since how can one otherwise ensure the allocated size of the buffer is
732 sufficient?)  Or at least, one could know them if one keeps track of the
733 results of the various function calls.  But then it is very inefficient
734 to use @code{strcat}/@code{wcscat}.  A lot of time is wasted finding the
735 end of the destination string so that the actual copying can start.
736 This is a common example:
738 @cindex va_copy
739 @smallexample
740 /* @r{This function concatenates arbitrarily many strings.  The last}
741    @r{parameter must be @code{NULL}.}  */
742 char *
743 concat (const char *str, @dots{})
745   va_list ap, ap2;
746   size_t total = 1;
747   const char *s;
748   char *result;
750   va_start (ap, str);
751   va_copy (ap2, ap);
753   /* @r{Determine how much space we need.}  */
754   for (s = str; s != NULL; s = va_arg (ap, const char *))
755     total += strlen (s);
757   va_end (ap);
759   result = (char *) malloc (total);
760   if (result != NULL)
761     @{
762       result[0] = '\0';
764       /* @r{Copy the strings.}  */
765       for (s = str; s != NULL; s = va_arg (ap2, const char *))
766         strcat (result, s);
767     @}
769   va_end (ap2);
771   return result;
773 @end smallexample
775 This looks quite simple, especially the second loop where the strings
776 are actually copied.  But these innocent lines hide a major performance
777 penalty.  Just imagine that ten strings of 100 bytes each have to be
778 concatenated.  For the second string we search the already stored 100
779 bytes for the end of the string so that we can append the next string.
780 For all strings in total the comparisons necessary to find the end of
781 the intermediate results sums up to 5500!  If we combine the copying
782 with the search for the allocation we can write this function more
783 efficiently:
785 @smallexample
786 char *
787 concat (const char *str, @dots{})
789   va_list ap;
790   size_t allocated = 100;
791   char *result = (char *) malloc (allocated);
793   if (result != NULL)
794     @{
795       char *newp;
796       char *wp;
797       const char *s;
799       va_start (ap, str);
801       wp = result;
802       for (s = str; s != NULL; s = va_arg (ap, const char *))
803         @{
804           size_t len = strlen (s);
806           /* @r{Resize the allocated memory if necessary.}  */
807           if (wp + len + 1 > result + allocated)
808             @{
809               allocated = (allocated + len) * 2;
810               newp = (char *) realloc (result, allocated);
811               if (newp == NULL)
812                 @{
813                   free (result);
814                   return NULL;
815                 @}
816               wp = newp + (wp - result);
817               result = newp;
818             @}
820           wp = mempcpy (wp, s, len);
821         @}
823       /* @r{Terminate the result string.}  */
824       *wp++ = '\0';
826       /* @r{Resize memory to the optimal size.}  */
827       newp = realloc (result, wp - result);
828       if (newp != NULL)
829         result = newp;
831       va_end (ap);
832     @}
834   return result;
836 @end smallexample
838 With a bit more knowledge about the input strings one could fine-tune
839 the memory allocation.  The difference we are pointing to here is that
840 we don't use @code{strcat} anymore.  We always keep track of the length
841 of the current intermediate result so we can save ourselves the search for the
842 end of the string and use @code{mempcpy}.  Please note that we also
843 don't use @code{stpcpy} which might seem more natural since we are handling
844 strings.  But this is not necessary since we already know the
845 length of the string and therefore can use the faster memory copying
846 function.  The example would work for wide characters the same way.
848 Whenever a programmer feels the need to use @code{strcat} she or he
849 should think twice and look through the program to see whether the code cannot
850 be rewritten to take advantage of already calculated results.  Again: it
851 is almost always unnecessary to use @code{strcat}.
853 @node Truncating Strings
854 @section Truncating Strings while Copying
855 @cindex truncating strings
856 @cindex string truncation
858 The functions described in this section copy or concatenate the
859 possibly-truncated contents of a string or array to another, and
860 similarly for wide strings.  They follow the string-copying functions
861 in their header conventions.  @xref{Copying Strings and Arrays}.  The
862 @samp{str} functions are declared in the header file @file{string.h}
863 and the @samp{wc} functions are declared in the file @file{wchar.h}.
865 @deftypefun {char *} strncpy (char *restrict @var{to}, const char *restrict @var{from}, size_t @var{size})
866 @standards{C90, string.h}
867 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
868 This function is similar to @code{strcpy} but always copies exactly
869 @var{size} bytes into @var{to}.
871 If @var{from} does not contain a null byte in its first @var{size}
872 bytes, @code{strncpy} copies just the first @var{size} bytes.  In this
873 case no null terminator is written into @var{to}.
875 Otherwise @var{from} must be a string with length less than
876 @var{size}.  In this case @code{strncpy} copies all of @var{from},
877 followed by enough null bytes to add up to @var{size} bytes in all.
879 The behavior of @code{strncpy} is undefined if the strings overlap.
881 This function was designed for now-rarely-used arrays consisting of
882 non-null bytes followed by zero or more null bytes.  It needs to set
883 all @var{size} bytes of the destination, even when @var{size} is much
884 greater than the length of @var{from}.  As noted below, this function
885 is generally a poor choice for processing text.
886 @end deftypefun
888 @deftypefun {wchar_t *} wcsncpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom}, size_t @var{size})
889 @standards{ISO, wchar.h}
890 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
891 This function is similar to @code{wcscpy} but always copies exactly
892 @var{size} wide characters into @var{wto}.
894 If @var{wfrom} does not contain a null wide character in its first
895 @var{size} wide characters, then @code{wcsncpy} copies just the first
896 @var{size} wide characters.  In this case no null terminator is
897 written into @var{wto}.
899 Otherwise @var{wfrom} must be a wide string with length less than
900 @var{size}.  In this case @code{wcsncpy} copies all of @var{wfrom},
901 followed by enough null wide characters to add up to @var{size} wide
902 characters in all.
904 The behavior of @code{wcsncpy} is undefined if the strings overlap.
906 This function is the wide-character counterpart of @code{strncpy} and
907 suffers from most of the problems that @code{strncpy} does.  For
908 example, as noted below, this function is generally a poor choice for
909 processing text.
910 @end deftypefun
912 @deftypefun {char *} strndup (const char *@var{s}, size_t @var{size})
913 @standards{GNU, string.h}
914 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
915 This function is similar to @code{strdup} but always copies at most
916 @var{size} bytes into the newly allocated string.
918 If the length of @var{s} is more than @var{size}, then @code{strndup}
919 copies just the first @var{size} bytes and adds a closing null byte.
920 Otherwise all bytes are copied and the string is terminated.
922 This function differs from @code{strncpy} in that it always terminates
923 the destination string.
925 As noted below, this function is generally a poor choice for
926 processing text.
928 @code{strndup} is a GNU extension.
929 @end deftypefun
931 @deftypefn {Macro} {char *} strndupa (const char *@var{s}, size_t @var{size})
932 @standards{GNU, string.h}
933 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
934 This function is similar to @code{strndup} but like @code{strdupa} it
935 allocates the new string using @code{alloca} @pxref{Variable Size
936 Automatic}.  The same advantages and limitations of @code{strdupa} are
937 valid for @code{strndupa}, too.
939 This function is implemented only as a macro, just like @code{strdupa}.
940 Just as @code{strdupa} this macro also must not be used inside the
941 parameter list in a function call.
943 As noted below, this function is generally a poor choice for
944 processing text.
946 @code{strndupa} is only available if GNU CC is used.
947 @end deftypefn
949 @deftypefun {char *} stpncpy (char *restrict @var{to}, const char *restrict @var{from}, size_t @var{size})
950 @standards{GNU, string.h}
951 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
952 This function is similar to @code{stpcpy} but copies always exactly
953 @var{size} bytes into @var{to}.
955 If the length of @var{from} is more than @var{size}, then @code{stpncpy}
956 copies just the first @var{size} bytes and returns a pointer to the
957 byte directly following the one which was copied last.  Note that in
958 this case there is no null terminator written into @var{to}.
960 If the length of @var{from} is less than @var{size}, then @code{stpncpy}
961 copies all of @var{from}, followed by enough null bytes to add up
962 to @var{size} bytes in all.  This behavior is rarely useful, but it
963 is implemented to be useful in contexts where this behavior of the
964 @code{strncpy} is used.  @code{stpncpy} returns a pointer to the
965 @emph{first} written null byte.
967 This function is not part of ISO or POSIX but was found useful while
968 developing @theglibc{} itself.
970 Its behavior is undefined if the strings overlap.  The function is
971 declared in @file{string.h}.
973 As noted below, this function is generally a poor choice for
974 processing text.
975 @end deftypefun
977 @deftypefun {wchar_t *} wcpncpy (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom}, size_t @var{size})
978 @standards{GNU, wchar.h}
979 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
980 This function is similar to @code{wcpcpy} but copies always exactly
981 @var{wsize} wide characters into @var{wto}.
983 If the length of @var{wfrom} is more than @var{size}, then
984 @code{wcpncpy} copies just the first @var{size} wide characters and
985 returns a pointer to the wide character directly following the last
986 non-null wide character which was copied last.  Note that in this case
987 there is no null terminator written into @var{wto}.
989 If the length of @var{wfrom} is less than @var{size}, then @code{wcpncpy}
990 copies all of @var{wfrom}, followed by enough null wide characters to add up
991 to @var{size} wide characters in all.  This behavior is rarely useful, but it
992 is implemented to be useful in contexts where this behavior of the
993 @code{wcsncpy} is used.  @code{wcpncpy} returns a pointer to the
994 @emph{first} written null wide character.
996 This function is not part of ISO or POSIX but was found useful while
997 developing @theglibc{} itself.
999 Its behavior is undefined if the strings overlap.
1001 As noted below, this function is generally a poor choice for
1002 processing text.
1004 @code{wcpncpy} is a GNU extension.
1005 @end deftypefun
1007 @deftypefun {char *} strncat (char *restrict @var{to}, const char *restrict @var{from}, size_t @var{size})
1008 @standards{ISO, string.h}
1009 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1010 This function is like @code{strcat} except that not more than @var{size}
1011 bytes from @var{from} are appended to the end of @var{to}, and
1012 @var{from} need not be null-terminated.  A single null byte is also
1013 always appended to @var{to}, so the total
1014 allocated size of @var{to} must be at least @code{@var{size} + 1} bytes
1015 longer than its initial length.
1017 The @code{strncat} function could be implemented like this:
1019 @smallexample
1020 @group
1021 char *
1022 strncat (char *to, const char *from, size_t size)
1024   size_t len = strlen (to);
1025   memcpy (to + len, from, strnlen (from, size));
1026   to[len + strnlen (from, size)] = '\0';
1027   return to;
1029 @end group
1030 @end smallexample
1032 The behavior of @code{strncat} is undefined if the strings overlap.
1034 As a companion to @code{strncpy}, @code{strncat} was designed for
1035 now-rarely-used arrays consisting of non-null bytes followed by zero
1036 or more null bytes.  As noted below, this function is generally a poor
1037 choice for processing text.  Also, this function has significant
1038 performance issues.  @xref{Concatenating Strings}.
1039 @end deftypefun
1041 @deftypefun {wchar_t *} wcsncat (wchar_t *restrict @var{wto}, const wchar_t *restrict @var{wfrom}, size_t @var{size})
1042 @standards{ISO, wchar.h}
1043 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1044 This function is like @code{wcscat} except that not more than @var{size}
1045 wide characters from @var{from} are appended to the end of @var{to},
1046 and @var{from} need not be null-terminated.  A single null wide
1047 character is also always appended to @var{to}, so the total allocated
1048 size of @var{to} must be at least @code{wcsnlen (@var{wfrom},
1049 @var{size}) + 1} wide characters longer than its initial length.
1051 The @code{wcsncat} function could be implemented like this:
1053 @smallexample
1054 @group
1055 wchar_t *
1056 wcsncat (wchar_t *restrict wto, const wchar_t *restrict wfrom,
1057          size_t size)
1059   size_t len = wcslen (wto);
1060   memcpy (wto + len, wfrom, wcsnlen (wfrom, size) * sizeof (wchar_t));
1061   wto[len + wcsnlen (wfrom, size)] = L'\0';
1062   return wto;
1064 @end group
1065 @end smallexample
1067 The behavior of @code{wcsncat} is undefined if the strings overlap.
1069 As noted below, this function is generally a poor choice for
1070 processing text.  Also, this function has significant performance
1071 issues.  @xref{Concatenating Strings}.
1072 @end deftypefun
1074 Because these functions can abruptly truncate strings or wide strings,
1075 they are generally poor choices for processing text.  When coping or
1076 concatening multibyte strings, they can truncate within a multibyte
1077 character so that the result is not a valid multibyte string.  When
1078 combining or concatenating multibyte or wide strings, they may
1079 truncate the output after a combining character, resulting in a
1080 corrupted grapheme.  They can cause bugs even when processing
1081 single-byte strings: for example, when calculating an ASCII-only user
1082 name, a truncated name can identify the wrong user.
1084 Although some buffer overruns can be prevented by manually replacing
1085 calls to copying functions with calls to truncation functions, there
1086 are often easier and safer automatic techniques that cause buffer
1087 overruns to reliably terminate a program, such as GCC's
1088 @option{-fcheck-pointer-bounds} and @option{-fsanitize=address}
1089 options.  @xref{Debugging Options,, Options for Debugging Your Program
1090 or GCC, gcc, Using GCC}.  Because truncation functions can mask
1091 application bugs that would otherwise be caught by the automatic
1092 techniques, these functions should be used only when the application's
1093 underlying logic requires truncation.
1095 @strong{Note:} GNU programs should not truncate strings or wide
1096 strings to fit arbitrary size limits.  @xref{Semantics, , Writing
1097 Robust Programs, standards, The GNU Coding Standards}.  Instead of
1098 string-truncation functions, it is usually better to use dynamic
1099 memory allocation (@pxref{Unconstrained Allocation}) and functions
1100 such as @code{strdup} or @code{asprintf} to construct strings.
1102 @node String/Array Comparison
1103 @section String/Array Comparison
1104 @cindex comparing strings and arrays
1105 @cindex string comparison functions
1106 @cindex array comparison functions
1107 @cindex predicates on strings
1108 @cindex predicates on arrays
1110 You can use the functions in this section to perform comparisons on the
1111 contents of strings and arrays.  As well as checking for equality, these
1112 functions can also be used as the ordering functions for sorting
1113 operations.  @xref{Searching and Sorting}, for an example of this.
1115 Unlike most comparison operations in C, the string comparison functions
1116 return a nonzero value if the strings are @emph{not} equivalent rather
1117 than if they are.  The sign of the value indicates the relative ordering
1118 of the first part of the strings that are not equivalent:  a
1119 negative value indicates that the first string is ``less'' than the
1120 second, while a positive value indicates that the first string is
1121 ``greater''.
1123 The most common use of these functions is to check only for equality.
1124 This is canonically done with an expression like @w{@samp{! strcmp (s1, s2)}}.
1126 All of these functions are declared in the header file @file{string.h}.
1127 @pindex string.h
1129 @deftypefun int memcmp (const void *@var{a1}, const void *@var{a2}, size_t @var{size})
1130 @standards{ISO, string.h}
1131 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1132 The function @code{memcmp} compares the @var{size} bytes of memory
1133 beginning at @var{a1} against the @var{size} bytes of memory beginning
1134 at @var{a2}.  The value returned has the same sign as the difference
1135 between the first differing pair of bytes (interpreted as @code{unsigned
1136 char} objects, then promoted to @code{int}).
1138 If the contents of the two blocks are equal, @code{memcmp} returns
1139 @code{0}.
1140 @end deftypefun
1142 @deftypefun int wmemcmp (const wchar_t *@var{a1}, const wchar_t *@var{a2}, size_t @var{size})
1143 @standards{ISO, wchar.h}
1144 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1145 The function @code{wmemcmp} compares the @var{size} wide characters
1146 beginning at @var{a1} against the @var{size} wide characters beginning
1147 at @var{a2}.  The value returned is smaller than or larger than zero
1148 depending on whether the first differing wide character is @var{a1} is
1149 smaller or larger than the corresponding wide character in @var{a2}.
1151 If the contents of the two blocks are equal, @code{wmemcmp} returns
1152 @code{0}.
1153 @end deftypefun
1155 On arbitrary arrays, the @code{memcmp} function is mostly useful for
1156 testing equality.  It usually isn't meaningful to do byte-wise ordering
1157 comparisons on arrays of things other than bytes.  For example, a
1158 byte-wise comparison on the bytes that make up floating-point numbers
1159 isn't likely to tell you anything about the relationship between the
1160 values of the floating-point numbers.
1162 @code{wmemcmp} is really only useful to compare arrays of type
1163 @code{wchar_t} since the function looks at @code{sizeof (wchar_t)} bytes
1164 at a time and this number of bytes is system dependent.
1166 You should also be careful about using @code{memcmp} to compare objects
1167 that can contain ``holes'', such as the padding inserted into structure
1168 objects to enforce alignment requirements, extra space at the end of
1169 unions, and extra bytes at the ends of strings whose length is less
1170 than their allocated size.  The contents of these ``holes'' are
1171 indeterminate and may cause strange behavior when performing byte-wise
1172 comparisons.  For more predictable results, perform an explicit
1173 component-wise comparison.
1175 For example, given a structure type definition like:
1177 @smallexample
1178 struct foo
1179   @{
1180     unsigned char tag;
1181     union
1182       @{
1183         double f;
1184         long i;
1185         char *p;
1186       @} value;
1187   @};
1188 @end smallexample
1190 @noindent
1191 you are better off writing a specialized comparison function to compare
1192 @code{struct foo} objects instead of comparing them with @code{memcmp}.
1194 @deftypefun int strcmp (const char *@var{s1}, const char *@var{s2})
1195 @standards{ISO, string.h}
1196 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1197 The @code{strcmp} function compares the string @var{s1} against
1198 @var{s2}, returning a value that has the same sign as the difference
1199 between the first differing pair of bytes (interpreted as
1200 @code{unsigned char} objects, then promoted to @code{int}).
1202 If the two strings are equal, @code{strcmp} returns @code{0}.
1204 A consequence of the ordering used by @code{strcmp} is that if @var{s1}
1205 is an initial substring of @var{s2}, then @var{s1} is considered to be
1206 ``less than'' @var{s2}.
1208 @code{strcmp} does not take sorting conventions of the language the
1209 strings are written in into account.  To get that one has to use
1210 @code{strcoll}.
1211 @end deftypefun
1213 @deftypefun int wcscmp (const wchar_t *@var{ws1}, const wchar_t *@var{ws2})
1214 @standards{ISO, wchar.h}
1215 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1217 The @code{wcscmp} function compares the wide string @var{ws1}
1218 against @var{ws2}.  The value returned is smaller than or larger than zero
1219 depending on whether the first differing wide character is @var{ws1} is
1220 smaller or larger than the corresponding wide character in @var{ws2}.
1222 If the two strings are equal, @code{wcscmp} returns @code{0}.
1224 A consequence of the ordering used by @code{wcscmp} is that if @var{ws1}
1225 is an initial substring of @var{ws2}, then @var{ws1} is considered to be
1226 ``less than'' @var{ws2}.
1228 @code{wcscmp} does not take sorting conventions of the language the
1229 strings are written in into account.  To get that one has to use
1230 @code{wcscoll}.
1231 @end deftypefun
1233 @deftypefun int strcasecmp (const char *@var{s1}, const char *@var{s2})
1234 @standards{BSD, string.h}
1235 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1236 @c Although this calls tolower multiple times, it's a macro, and
1237 @c strcasecmp is optimized so that the locale pointer is read only once.
1238 @c There are some asm implementations too, for which the single-read
1239 @c from locale TLS pointers also applies.
1240 This function is like @code{strcmp}, except that differences in case are
1241 ignored, and its arguments must be multibyte strings.
1242 How uppercase and lowercase characters are related is
1243 determined by the currently selected locale.  In the standard @code{"C"}
1244 locale the characters @"A and @"a do not match but in a locale which
1245 regards these characters as parts of the alphabet they do match.
1247 @noindent
1248 @code{strcasecmp} is derived from BSD.
1249 @end deftypefun
1251 @deftypefun int wcscasecmp (const wchar_t *@var{ws1}, const wchar_t *@var{ws2})
1252 @standards{GNU, wchar.h}
1253 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1254 @c Since towlower is not a macro, the locale object may be read multiple
1255 @c times.
1256 This function is like @code{wcscmp}, except that differences in case are
1257 ignored.  How uppercase and lowercase characters are related is
1258 determined by the currently selected locale.  In the standard @code{"C"}
1259 locale the characters @"A and @"a do not match but in a locale which
1260 regards these characters as parts of the alphabet they do match.
1262 @noindent
1263 @code{wcscasecmp} is a GNU extension.
1264 @end deftypefun
1266 @deftypefun int strncmp (const char *@var{s1}, const char *@var{s2}, size_t @var{size})
1267 @standards{ISO, string.h}
1268 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1269 This function is the similar to @code{strcmp}, except that no more than
1270 @var{size} bytes are compared.  In other words, if the two
1271 strings are the same in their first @var{size} bytes, the
1272 return value is zero.
1273 @end deftypefun
1275 @deftypefun int wcsncmp (const wchar_t *@var{ws1}, const wchar_t *@var{ws2}, size_t @var{size})
1276 @standards{ISO, wchar.h}
1277 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1278 This function is similar to @code{wcscmp}, except that no more than
1279 @var{size} wide characters are compared.  In other words, if the two
1280 strings are the same in their first @var{size} wide characters, the
1281 return value is zero.
1282 @end deftypefun
1284 @deftypefun int strncasecmp (const char *@var{s1}, const char *@var{s2}, size_t @var{n})
1285 @standards{BSD, string.h}
1286 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1287 This function is like @code{strncmp}, except that differences in case
1288 are ignored, and the compared parts of the arguments should consist of
1289 valid multibyte characters.
1290 Like @code{strcasecmp}, it is locale dependent how
1291 uppercase and lowercase characters are related.
1293 @noindent
1294 @code{strncasecmp} is a GNU extension.
1295 @end deftypefun
1297 @deftypefun int wcsncasecmp (const wchar_t *@var{ws1}, const wchar_t *@var{s2}, size_t @var{n})
1298 @standards{GNU, wchar.h}
1299 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1300 This function is like @code{wcsncmp}, except that differences in case
1301 are ignored.  Like @code{wcscasecmp}, it is locale dependent how
1302 uppercase and lowercase characters are related.
1304 @noindent
1305 @code{wcsncasecmp} is a GNU extension.
1306 @end deftypefun
1308 Here are some examples showing the use of @code{strcmp} and
1309 @code{strncmp} (equivalent examples can be constructed for the wide
1310 character functions).  These examples assume the use of the ASCII
1311 character set.  (If some other character set---say, EBCDIC---is used
1312 instead, then the glyphs are associated with different numeric codes,
1313 and the return values and ordering may differ.)
1315 @smallexample
1316 strcmp ("hello", "hello")
1317     @result{} 0    /* @r{These two strings are the same.} */
1318 strcmp ("hello", "Hello")
1319     @result{} 32   /* @r{Comparisons are case-sensitive.} */
1320 strcmp ("hello", "world")
1321     @result{} -15  /* @r{The byte @code{'h'} comes before @code{'w'}.} */
1322 strcmp ("hello", "hello, world")
1323     @result{} -44  /* @r{Comparing a null byte against a comma.} */
1324 strncmp ("hello", "hello, world", 5)
1325     @result{} 0    /* @r{The initial 5 bytes are the same.} */
1326 strncmp ("hello, world", "hello, stupid world!!!", 5)
1327     @result{} 0    /* @r{The initial 5 bytes are the same.} */
1328 @end smallexample
1330 @deftypefun int strverscmp (const char *@var{s1}, const char *@var{s2})
1331 @standards{GNU, string.h}
1332 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1333 @c Calls isdigit multiple times, locale may change in between.
1334 The @code{strverscmp} function compares the string @var{s1} against
1335 @var{s2}, considering them as holding indices/version numbers.  The
1336 return value follows the same conventions as found in the
1337 @code{strcmp} function.  In fact, if @var{s1} and @var{s2} contain no
1338 digits, @code{strverscmp} behaves like @code{strcmp}
1339 (in the sense that the sign of the result is the same).
1341 The comparison algorithm which the @code{strverscmp} function implements
1342 differs slightly from other version-comparison algorithms.  The
1343 implementation is based on a finite-state machine, whose behavior is
1344 approximated below.
1346 @itemize @bullet
1347 @item
1348 The input strings are each split into sequences of non-digits and
1349 digits.  These sequences can be empty at the beginning and end of the
1350 string.  Digits are determined by the @code{isdigit} function and are
1351 thus subject to the current locale.
1353 @item
1354 Comparison starts with a (possibly empty) non-digit sequence.  The first
1355 non-equal sequences of non-digits or digits determines the outcome of
1356 the comparison.
1358 @item
1359 Corresponding non-digit sequences in both strings are compared
1360 lexicographically if their lengths are equal.  If the lengths differ,
1361 the shorter non-digit sequence is extended with the input string
1362 character immediately following it (which may be the null terminator),
1363 the other sequence is truncated to be of the same (extended) length, and
1364 these two sequences are compared lexicographically.  In the last case,
1365 the sequence comparison determines the result of the function because
1366 the extension character (or some character before it) is necessarily
1367 different from the character at the same offset in the other input
1368 string.
1370 @item
1371 For two sequences of digits, the number of leading zeros is counted (which
1372 can be zero).  If the count differs, the string with more leading zeros
1373 in the digit sequence is considered smaller than the other string.
1375 @item
1376 If the two sequences of digits have no leading zeros, they are compared
1377 as integers, that is, the string with the longer digit sequence is
1378 deemed larger, and if both sequences are of equal length, they are
1379 compared lexicographically.
1381 @item
1382 If both digit sequences start with a zero and have an equal number of
1383 leading zeros, they are compared lexicographically if their lengths are
1384 the same.  If the lengths differ, the shorter sequence is extended with
1385 the following character in its input string, and the other sequence is
1386 truncated to the same length, and both sequences are compared
1387 lexicographically (similar to the non-digit sequence case above).
1388 @end itemize
1390 The treatment of leading zeros and the tie-breaking extension characters
1391 (which in effect propagate across non-digit/digit sequence boundaries)
1392 differs from other version-comparison algorithms.
1394 @smallexample
1395 strverscmp ("no digit", "no digit")
1396     @result{} 0    /* @r{same behavior as strcmp.} */
1397 strverscmp ("item#99", "item#100")
1398     @result{} <0   /* @r{same prefix, but 99 < 100.} */
1399 strverscmp ("alpha1", "alpha001")
1400     @result{} >0   /* @r{different number of leading zeros (0 and 2).} */
1401 strverscmp ("part1_f012", "part1_f01")
1402     @result{} >0   /* @r{lexicographical comparison with leading zeros.} */
1403 strverscmp ("foo.009", "foo.0")
1404     @result{} <0   /* @r{different number of leading zeros (2 and 1).} */
1405 @end smallexample
1407 @code{strverscmp} is a GNU extension.
1408 @end deftypefun
1410 @deftypefun int bcmp (const void *@var{a1}, const void *@var{a2}, size_t @var{size})
1411 @standards{BSD, string.h}
1412 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1413 This is an obsolete alias for @code{memcmp}, derived from BSD.
1414 @end deftypefun
1416 @node Collation Functions
1417 @section Collation Functions
1419 @cindex collating strings
1420 @cindex string collation functions
1422 In some locales, the conventions for lexicographic ordering differ from
1423 the strict numeric ordering of character codes.  For example, in Spanish
1424 most glyphs with diacritical marks such as accents are not considered
1425 distinct letters for the purposes of collation.  On the other hand, the
1426 two-character sequence @samp{ll} is treated as a single letter that is
1427 collated immediately after @samp{l}.
1429 You can use the functions @code{strcoll} and @code{strxfrm} (declared in
1430 the headers file @file{string.h}) and @code{wcscoll} and @code{wcsxfrm}
1431 (declared in the headers file @file{wchar}) to compare strings using a
1432 collation ordering appropriate for the current locale.  The locale used
1433 by these functions in particular can be specified by setting the locale
1434 for the @code{LC_COLLATE} category; see @ref{Locales}.
1435 @pindex string.h
1436 @pindex wchar.h
1438 In the standard C locale, the collation sequence for @code{strcoll} is
1439 the same as that for @code{strcmp}.  Similarly, @code{wcscoll} and
1440 @code{wcscmp} are the same in this situation.
1442 Effectively, the way these functions work is by applying a mapping to
1443 transform the characters in a multibyte string to a byte
1444 sequence that represents
1445 the string's position in the collating sequence of the current locale.
1446 Comparing two such byte sequences in a simple fashion is equivalent to
1447 comparing the strings with the locale's collating sequence.
1449 The functions @code{strcoll} and @code{wcscoll} perform this translation
1450 implicitly, in order to do one comparison.  By contrast, @code{strxfrm}
1451 and @code{wcsxfrm} perform the mapping explicitly.  If you are making
1452 multiple comparisons using the same string or set of strings, it is
1453 likely to be more efficient to use @code{strxfrm} or @code{wcsxfrm} to
1454 transform all the strings just once, and subsequently compare the
1455 transformed strings with @code{strcmp} or @code{wcscmp}.
1457 @deftypefun int strcoll (const char *@var{s1}, const char *@var{s2})
1458 @standards{ISO, string.h}
1459 @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
1460 @c Calls strcoll_l with the current locale, which dereferences only the
1461 @c LC_COLLATE data pointer.
1462 The @code{strcoll} function is similar to @code{strcmp} but uses the
1463 collating sequence of the current locale for collation (the
1464 @code{LC_COLLATE} locale).  The arguments are multibyte strings.
1465 @end deftypefun
1467 @deftypefun int wcscoll (const wchar_t *@var{ws1}, const wchar_t *@var{ws2})
1468 @standards{ISO, wchar.h}
1469 @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
1470 @c Same as strcoll, but calling wcscoll_l.
1471 The @code{wcscoll} function is similar to @code{wcscmp} but uses the
1472 collating sequence of the current locale for collation (the
1473 @code{LC_COLLATE} locale).
1474 @end deftypefun
1476 Here is an example of sorting an array of strings, using @code{strcoll}
1477 to compare them.  The actual sort algorithm is not written here; it
1478 comes from @code{qsort} (@pxref{Array Sort Function}).  The job of the
1479 code shown here is to say how to compare the strings while sorting them.
1480 (Later on in this section, we will show a way to do this more
1481 efficiently using @code{strxfrm}.)
1483 @smallexample
1484 /* @r{This is the comparison function used with @code{qsort}.} */
1487 compare_elements (const void *v1, const void *v2)
1489   char * const *p1 = v1;
1490   char * const *p2 = v2;
1492   return strcoll (*p1, *p2);
1495 /* @r{This is the entry point---the function to sort}
1496    @r{strings using the locale's collating sequence.} */
1498 void
1499 sort_strings (char **array, int nstrings)
1501   /* @r{Sort @code{temp_array} by comparing the strings.} */
1502   qsort (array, nstrings,
1503          sizeof (char *), compare_elements);
1505 @end smallexample
1507 @cindex converting string to collation order
1508 @deftypefun size_t strxfrm (char *restrict @var{to}, const char *restrict @var{from}, size_t @var{size})
1509 @standards{ISO, string.h}
1510 @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
1511 The function @code{strxfrm} transforms the multibyte string
1512 @var{from} using the
1513 collation transformation determined by the locale currently selected for
1514 collation, and stores the transformed string in the array @var{to}.  Up
1515 to @var{size} bytes (including a terminating null byte) are
1516 stored.
1518 The behavior is undefined if the strings @var{to} and @var{from}
1519 overlap; see @ref{Copying Strings and Arrays}.
1521 The return value is the length of the entire transformed string.  This
1522 value is not affected by the value of @var{size}, but if it is greater
1523 or equal than @var{size}, it means that the transformed string did not
1524 entirely fit in the array @var{to}.  In this case, only as much of the
1525 string as actually fits was stored.  To get the whole transformed
1526 string, call @code{strxfrm} again with a bigger output array.
1528 The transformed string may be longer than the original string, and it
1529 may also be shorter.
1531 If @var{size} is zero, no bytes are stored in @var{to}.  In this
1532 case, @code{strxfrm} simply returns the number of bytes that would
1533 be the length of the transformed string.  This is useful for determining
1534 what size the allocated array should be.  It does not matter what
1535 @var{to} is if @var{size} is zero; @var{to} may even be a null pointer.
1536 @end deftypefun
1538 @deftypefun size_t wcsxfrm (wchar_t *restrict @var{wto}, const wchar_t *@var{wfrom}, size_t @var{size})
1539 @standards{ISO, wchar.h}
1540 @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
1541 The function @code{wcsxfrm} transforms wide string @var{wfrom}
1542 using the collation transformation determined by the locale currently
1543 selected for collation, and stores the transformed string in the array
1544 @var{wto}.  Up to @var{size} wide characters (including a terminating null
1545 wide character) are stored.
1547 The behavior is undefined if the strings @var{wto} and @var{wfrom}
1548 overlap; see @ref{Copying Strings and Arrays}.
1550 The return value is the length of the entire transformed wide
1551 string.  This value is not affected by the value of @var{size}, but if
1552 it is greater or equal than @var{size}, it means that the transformed
1553 wide string did not entirely fit in the array @var{wto}.  In
1554 this case, only as much of the wide string as actually fits
1555 was stored.  To get the whole transformed wide string, call
1556 @code{wcsxfrm} again with a bigger output array.
1558 The transformed wide string may be longer than the original
1559 wide string, and it may also be shorter.
1561 If @var{size} is zero, no wide characters are stored in @var{to}.  In this
1562 case, @code{wcsxfrm} simply returns the number of wide characters that
1563 would be the length of the transformed wide string.  This is
1564 useful for determining what size the allocated array should be (remember
1565 to multiply with @code{sizeof (wchar_t)}).  It does not matter what
1566 @var{wto} is if @var{size} is zero; @var{wto} may even be a null pointer.
1567 @end deftypefun
1569 Here is an example of how you can use @code{strxfrm} when
1570 you plan to do many comparisons.  It does the same thing as the previous
1571 example, but much faster, because it has to transform each string only
1572 once, no matter how many times it is compared with other strings.  Even
1573 the time needed to allocate and free storage is much less than the time
1574 we save, when there are many strings.
1576 @smallexample
1577 struct sorter @{ char *input; char *transformed; @};
1579 /* @r{This is the comparison function used with @code{qsort}}
1580    @r{to sort an array of @code{struct sorter}.} */
1583 compare_elements (const void *v1, const void *v2)
1585   const struct sorter *p1 = v1;
1586   const struct sorter *p2 = v2;
1588   return strcmp (p1->transformed, p2->transformed);
1591 /* @r{This is the entry point---the function to sort}
1592    @r{strings using the locale's collating sequence.} */
1594 void
1595 sort_strings_fast (char **array, int nstrings)
1597   struct sorter temp_array[nstrings];
1598   int i;
1600   /* @r{Set up @code{temp_array}.  Each element contains}
1601      @r{one input string and its transformed string.} */
1602   for (i = 0; i < nstrings; i++)
1603     @{
1604       size_t length = strlen (array[i]) * 2;
1605       char *transformed;
1606       size_t transformed_length;
1608       temp_array[i].input = array[i];
1610       /* @r{First try a buffer perhaps big enough.}  */
1611       transformed = (char *) xmalloc (length);
1613       /* @r{Transform @code{array[i]}.}  */
1614       transformed_length = strxfrm (transformed, array[i], length);
1616       /* @r{If the buffer was not large enough, resize it}
1617          @r{and try again.}  */
1618       if (transformed_length >= length)
1619         @{
1620           /* @r{Allocate the needed space. +1 for terminating}
1621              @r{@code{'\0'} byte.}  */
1622           transformed = (char *) xrealloc (transformed,
1623                                            transformed_length + 1);
1625           /* @r{The return value is not interesting because we know}
1626              @r{how long the transformed string is.}  */
1627           (void) strxfrm (transformed, array[i],
1628                           transformed_length + 1);
1629         @}
1631       temp_array[i].transformed = transformed;
1632     @}
1634   /* @r{Sort @code{temp_array} by comparing transformed strings.} */
1635   qsort (temp_array, nstrings,
1636          sizeof (struct sorter), compare_elements);
1638   /* @r{Put the elements back in the permanent array}
1639      @r{in their sorted order.} */
1640   for (i = 0; i < nstrings; i++)
1641     array[i] = temp_array[i].input;
1643   /* @r{Free the strings we allocated.} */
1644   for (i = 0; i < nstrings; i++)
1645     free (temp_array[i].transformed);
1647 @end smallexample
1649 The interesting part of this code for the wide character version would
1650 look like this:
1652 @smallexample
1653 void
1654 sort_strings_fast (wchar_t **array, int nstrings)
1656   @dots{}
1657       /* @r{Transform @code{array[i]}.}  */
1658       transformed_length = wcsxfrm (transformed, array[i], length);
1660       /* @r{If the buffer was not large enough, resize it}
1661          @r{and try again.}  */
1662       if (transformed_length >= length)
1663         @{
1664           /* @r{Allocate the needed space. +1 for terminating}
1665              @r{@code{L'\0'} wide character.}  */
1666           transformed = (wchar_t *) xrealloc (transformed,
1667                                               (transformed_length + 1)
1668                                               * sizeof (wchar_t));
1670           /* @r{The return value is not interesting because we know}
1671              @r{how long the transformed string is.}  */
1672           (void) wcsxfrm (transformed, array[i],
1673                           transformed_length + 1);
1674         @}
1675   @dots{}
1676 @end smallexample
1678 @noindent
1679 Note the additional multiplication with @code{sizeof (wchar_t)} in the
1680 @code{realloc} call.
1682 @strong{Compatibility Note:} The string collation functions are a new
1683 feature of @w{ISO C90}.  Older C dialects have no equivalent feature.
1684 The wide character versions were introduced in @w{Amendment 1} to @w{ISO
1685 C90}.
1687 @node Search Functions
1688 @section Search Functions
1690 This section describes library functions which perform various kinds
1691 of searching operations on strings and arrays.  These functions are
1692 declared in the header file @file{string.h}.
1693 @pindex string.h
1694 @cindex search functions (for strings)
1695 @cindex string search functions
1697 @deftypefun {void *} memchr (const void *@var{block}, int @var{c}, size_t @var{size})
1698 @standards{ISO, string.h}
1699 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1700 This function finds the first occurrence of the byte @var{c} (converted
1701 to an @code{unsigned char}) in the initial @var{size} bytes of the
1702 object beginning at @var{block}.  The return value is a pointer to the
1703 located byte, or a null pointer if no match was found.
1704 @end deftypefun
1706 @deftypefun {wchar_t *} wmemchr (const wchar_t *@var{block}, wchar_t @var{wc}, size_t @var{size})
1707 @standards{ISO, wchar.h}
1708 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1709 This function finds the first occurrence of the wide character @var{wc}
1710 in the initial @var{size} wide characters of the object beginning at
1711 @var{block}.  The return value is a pointer to the located wide
1712 character, or a null pointer if no match was found.
1713 @end deftypefun
1715 @deftypefun {void *} rawmemchr (const void *@var{block}, int @var{c})
1716 @standards{GNU, string.h}
1717 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1718 Often the @code{memchr} function is used with the knowledge that the
1719 byte @var{c} is available in the memory block specified by the
1720 parameters.  But this means that the @var{size} parameter is not really
1721 needed and that the tests performed with it at runtime (to check whether
1722 the end of the block is reached) are not needed.
1724 The @code{rawmemchr} function exists for just this situation which is
1725 surprisingly frequent.  The interface is similar to @code{memchr} except
1726 that the @var{size} parameter is missing.  The function will look beyond
1727 the end of the block pointed to by @var{block} in case the programmer
1728 made an error in assuming that the byte @var{c} is present in the block.
1729 In this case the result is unspecified.  Otherwise the return value is a
1730 pointer to the located byte.
1732 This function is of special interest when looking for the end of a
1733 string.  Since all strings are terminated by a null byte a call like
1735 @smallexample
1736    rawmemchr (str, '\0')
1737 @end smallexample
1739 @noindent
1740 will never go beyond the end of the string.
1742 This function is a GNU extension.
1743 @end deftypefun
1745 @deftypefun {void *} memrchr (const void *@var{block}, int @var{c}, size_t @var{size})
1746 @standards{GNU, string.h}
1747 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1748 The function @code{memrchr} is like @code{memchr}, except that it searches
1749 backwards from the end of the block defined by @var{block} and @var{size}
1750 (instead of forwards from the front).
1752 This function is a GNU extension.
1753 @end deftypefun
1755 @deftypefun {char *} strchr (const char *@var{string}, int @var{c})
1756 @standards{ISO, string.h}
1757 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1758 The @code{strchr} function finds the first occurrence of the byte
1759 @var{c} (converted to a @code{char}) in the string
1760 beginning at @var{string}.  The return value is a pointer to the located
1761 byte, or a null pointer if no match was found.
1763 For example,
1764 @smallexample
1765 strchr ("hello, world", 'l')
1766     @result{} "llo, world"
1767 strchr ("hello, world", '?')
1768     @result{} NULL
1769 @end smallexample
1771 The terminating null byte is considered to be part of the string,
1772 so you can use this function get a pointer to the end of a string by
1773 specifying zero as the value of the @var{c} argument.
1775 When @code{strchr} returns a null pointer, it does not let you know
1776 the position of the terminating null byte it has found.  If you
1777 need that information, it is better (but less portable) to use
1778 @code{strchrnul} than to search for it a second time.
1779 @end deftypefun
1781 @deftypefun {wchar_t *} wcschr (const wchar_t *@var{wstring}, int @var{wc})
1782 @standards{ISO, wchar.h}
1783 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1784 The @code{wcschr} function finds the first occurrence of the wide
1785 character @var{wc} in the wide string
1786 beginning at @var{wstring}.  The return value is a pointer to the
1787 located wide character, or a null pointer if no match was found.
1789 The terminating null wide character is considered to be part of the wide
1790 string, so you can use this function get a pointer to the end
1791 of a wide string by specifying a null wide character as the
1792 value of the @var{wc} argument.  It would be better (but less portable)
1793 to use @code{wcschrnul} in this case, though.
1794 @end deftypefun
1796 @deftypefun {char *} strchrnul (const char *@var{string}, int @var{c})
1797 @standards{GNU, string.h}
1798 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1799 @code{strchrnul} is the same as @code{strchr} except that if it does
1800 not find the byte, it returns a pointer to string's terminating
1801 null byte rather than a null pointer.
1803 This function is a GNU extension.
1804 @end deftypefun
1806 @deftypefun {wchar_t *} wcschrnul (const wchar_t *@var{wstring}, wchar_t @var{wc})
1807 @standards{GNU, wchar.h}
1808 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1809 @code{wcschrnul} is the same as @code{wcschr} except that if it does not
1810 find the wide character, it returns a pointer to the wide string's
1811 terminating null wide character rather than a null pointer.
1813 This function is a GNU extension.
1814 @end deftypefun
1816 One useful, but unusual, use of the @code{strchr}
1817 function is when one wants to have a pointer pointing to the null byte
1818 terminating a string.  This is often written in this way:
1820 @smallexample
1821   s += strlen (s);
1822 @end smallexample
1824 @noindent
1825 This is almost optimal but the addition operation duplicated a bit of
1826 the work already done in the @code{strlen} function.  A better solution
1827 is this:
1829 @smallexample
1830   s = strchr (s, '\0');
1831 @end smallexample
1833 There is no restriction on the second parameter of @code{strchr} so it
1834 could very well also be zero.  Those readers thinking very
1835 hard about this might now point out that the @code{strchr} function is
1836 more expensive than the @code{strlen} function since we have two abort
1837 criteria.  This is right.  But in @theglibc{} the implementation of
1838 @code{strchr} is optimized in a special way so that @code{strchr}
1839 actually is faster.
1841 @deftypefun {char *} strrchr (const char *@var{string}, int @var{c})
1842 @standards{ISO, string.h}
1843 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1844 The function @code{strrchr} is like @code{strchr}, except that it searches
1845 backwards from the end of the string @var{string} (instead of forwards
1846 from the front).
1848 For example,
1849 @smallexample
1850 strrchr ("hello, world", 'l')
1851     @result{} "ld"
1852 @end smallexample
1853 @end deftypefun
1855 @deftypefun {wchar_t *} wcsrchr (const wchar_t *@var{wstring}, wchar_t @var{c})
1856 @standards{ISO, wchar.h}
1857 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1858 The function @code{wcsrchr} is like @code{wcschr}, except that it searches
1859 backwards from the end of the string @var{wstring} (instead of forwards
1860 from the front).
1861 @end deftypefun
1863 @deftypefun {char *} strstr (const char *@var{haystack}, const char *@var{needle})
1864 @standards{ISO, string.h}
1865 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1866 This is like @code{strchr}, except that it searches @var{haystack} for a
1867 substring @var{needle} rather than just a single byte.  It
1868 returns a pointer into the string @var{haystack} that is the first
1869 byte of the substring, or a null pointer if no match was found.  If
1870 @var{needle} is an empty string, the function returns @var{haystack}.
1872 For example,
1873 @smallexample
1874 strstr ("hello, world", "l")
1875     @result{} "llo, world"
1876 strstr ("hello, world", "wo")
1877     @result{} "world"
1878 @end smallexample
1879 @end deftypefun
1881 @deftypefun {wchar_t *} wcsstr (const wchar_t *@var{haystack}, const wchar_t *@var{needle})
1882 @standards{ISO, wchar.h}
1883 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1884 This is like @code{wcschr}, except that it searches @var{haystack} for a
1885 substring @var{needle} rather than just a single wide character.  It
1886 returns a pointer into the string @var{haystack} that is the first wide
1887 character of the substring, or a null pointer if no match was found.  If
1888 @var{needle} is an empty string, the function returns @var{haystack}.
1889 @end deftypefun
1891 @deftypefun {wchar_t *} wcswcs (const wchar_t *@var{haystack}, const wchar_t *@var{needle})
1892 @standards{XPG, wchar.h}
1893 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1894 @code{wcswcs} is a deprecated alias for @code{wcsstr}.  This is the
1895 name originally used in the X/Open Portability Guide before the
1896 @w{Amendment 1} to @w{ISO C90} was published.
1897 @end deftypefun
1900 @deftypefun {char *} strcasestr (const char *@var{haystack}, const char *@var{needle})
1901 @standards{GNU, string.h}
1902 @safety{@prelim{}@mtsafe{@mtslocale{}}@assafe{}@acsafe{}}
1903 @c There may be multiple calls of strncasecmp, each accessing the locale
1904 @c object independently.
1905 This is like @code{strstr}, except that it ignores case in searching for
1906 the substring.   Like @code{strcasecmp}, it is locale dependent how
1907 uppercase and lowercase characters are related, and arguments are
1908 multibyte strings.
1911 For example,
1912 @smallexample
1913 strcasestr ("hello, world", "L")
1914     @result{} "llo, world"
1915 strcasestr ("hello, World", "wo")
1916     @result{} "World"
1917 @end smallexample
1918 @end deftypefun
1921 @deftypefun {void *} memmem (const void *@var{haystack}, size_t @var{haystack-len},@*const void *@var{needle}, size_t @var{needle-len})
1922 @standards{GNU, string.h}
1923 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1924 This is like @code{strstr}, but @var{needle} and @var{haystack} are byte
1925 arrays rather than strings.  @var{needle-len} is the
1926 length of @var{needle} and @var{haystack-len} is the length of
1927 @var{haystack}.@refill
1929 This function is a GNU extension.
1930 @end deftypefun
1932 @deftypefun size_t strspn (const char *@var{string}, const char *@var{skipset})
1933 @standards{ISO, string.h}
1934 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1935 The @code{strspn} (``string span'') function returns the length of the
1936 initial substring of @var{string} that consists entirely of bytes that
1937 are members of the set specified by the string @var{skipset}.  The order
1938 of the bytes in @var{skipset} is not important.
1940 For example,
1941 @smallexample
1942 strspn ("hello, world", "abcdefghijklmnopqrstuvwxyz")
1943     @result{} 5
1944 @end smallexample
1946 In a multibyte string, characters consisting of
1947 more than one byte are not treated as single entities.  Each byte is treated
1948 separately.  The function is not locale-dependent.
1949 @end deftypefun
1951 @deftypefun size_t wcsspn (const wchar_t *@var{wstring}, const wchar_t *@var{skipset})
1952 @standards{ISO, wchar.h}
1953 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1954 The @code{wcsspn} (``wide character string span'') function returns the
1955 length of the initial substring of @var{wstring} that consists entirely
1956 of wide characters that are members of the set specified by the string
1957 @var{skipset}.  The order of the wide characters in @var{skipset} is not
1958 important.
1959 @end deftypefun
1961 @deftypefun size_t strcspn (const char *@var{string}, const char *@var{stopset})
1962 @standards{ISO, string.h}
1963 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1964 The @code{strcspn} (``string complement span'') function returns the length
1965 of the initial substring of @var{string} that consists entirely of bytes
1966 that are @emph{not} members of the set specified by the string @var{stopset}.
1967 (In other words, it returns the offset of the first byte in @var{string}
1968 that is a member of the set @var{stopset}.)
1970 For example,
1971 @smallexample
1972 strcspn ("hello, world", " \t\n,.;!?")
1973     @result{} 5
1974 @end smallexample
1976 In a multibyte string, characters consisting of
1977 more than one byte are not treated as a single entities.  Each byte is treated
1978 separately.  The function is not locale-dependent.
1979 @end deftypefun
1981 @deftypefun size_t wcscspn (const wchar_t *@var{wstring}, const wchar_t *@var{stopset})
1982 @standards{ISO, wchar.h}
1983 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1984 The @code{wcscspn} (``wide character string complement span'') function
1985 returns the length of the initial substring of @var{wstring} that
1986 consists entirely of wide characters that are @emph{not} members of the
1987 set specified by the string @var{stopset}.  (In other words, it returns
1988 the offset of the first wide character in @var{string} that is a member of
1989 the set @var{stopset}.)
1990 @end deftypefun
1992 @deftypefun {char *} strpbrk (const char *@var{string}, const char *@var{stopset})
1993 @standards{ISO, string.h}
1994 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
1995 The @code{strpbrk} (``string pointer break'') function is related to
1996 @code{strcspn}, except that it returns a pointer to the first byte
1997 in @var{string} that is a member of the set @var{stopset} instead of the
1998 length of the initial substring.  It returns a null pointer if no such
1999 byte from @var{stopset} is found.
2001 @c @group  Invalid outside the example.
2002 For example,
2004 @smallexample
2005 strpbrk ("hello, world", " \t\n,.;!?")
2006     @result{} ", world"
2007 @end smallexample
2008 @c @end group
2010 In a multibyte string, characters consisting of
2011 more than one byte are not treated as single entities.  Each byte is treated
2012 separately.  The function is not locale-dependent.
2013 @end deftypefun
2015 @deftypefun {wchar_t *} wcspbrk (const wchar_t *@var{wstring}, const wchar_t *@var{stopset})
2016 @standards{ISO, wchar.h}
2017 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2018 The @code{wcspbrk} (``wide character string pointer break'') function is
2019 related to @code{wcscspn}, except that it returns a pointer to the first
2020 wide character in @var{wstring} that is a member of the set
2021 @var{stopset} instead of the length of the initial substring.  It
2022 returns a null pointer if no such wide character from @var{stopset} is found.
2023 @end deftypefun
2026 @subsection Compatibility String Search Functions
2028 @deftypefun {char *} index (const char *@var{string}, int @var{c})
2029 @standards{BSD, string.h}
2030 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2031 @code{index} is another name for @code{strchr}; they are exactly the same.
2032 New code should always use @code{strchr} since this name is defined in
2033 @w{ISO C} while @code{index} is a BSD invention which never was available
2034 on @w{System V} derived systems.
2035 @end deftypefun
2037 @deftypefun {char *} rindex (const char *@var{string}, int @var{c})
2038 @standards{BSD, string.h}
2039 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2040 @code{rindex} is another name for @code{strrchr}; they are exactly the same.
2041 New code should always use @code{strrchr} since this name is defined in
2042 @w{ISO C} while @code{rindex} is a BSD invention which never was available
2043 on @w{System V} derived systems.
2044 @end deftypefun
2046 @node Finding Tokens in a String
2047 @section Finding Tokens in a String
2049 @cindex tokenizing strings
2050 @cindex breaking a string into tokens
2051 @cindex parsing tokens from a string
2052 It's fairly common for programs to have a need to do some simple kinds
2053 of lexical analysis and parsing, such as splitting a command string up
2054 into tokens.  You can do this with the @code{strtok} function, declared
2055 in the header file @file{string.h}.
2056 @pindex string.h
2058 @deftypefun {char *} strtok (char *restrict @var{newstring}, const char *restrict @var{delimiters})
2059 @standards{ISO, string.h}
2060 @safety{@prelim{}@mtunsafe{@mtasurace{:strtok}}@asunsafe{}@acsafe{}}
2061 A string can be split into tokens by making a series of calls to the
2062 function @code{strtok}.
2064 The string to be split up is passed as the @var{newstring} argument on
2065 the first call only.  The @code{strtok} function uses this to set up
2066 some internal state information.  Subsequent calls to get additional
2067 tokens from the same string are indicated by passing a null pointer as
2068 the @var{newstring} argument.  Calling @code{strtok} with another
2069 non-null @var{newstring} argument reinitializes the state information.
2070 It is guaranteed that no other library function ever calls @code{strtok}
2071 behind your back (which would mess up this internal state information).
2073 The @var{delimiters} argument is a string that specifies a set of delimiters
2074 that may surround the token being extracted.  All the initial bytes
2075 that are members of this set are discarded.  The first byte that is
2076 @emph{not} a member of this set of delimiters marks the beginning of the
2077 next token.  The end of the token is found by looking for the next
2078 byte that is a member of the delimiter set.  This byte in the
2079 original string @var{newstring} is overwritten by a null byte, and the
2080 pointer to the beginning of the token in @var{newstring} is returned.
2082 On the next call to @code{strtok}, the searching begins at the next
2083 byte beyond the one that marked the end of the previous token.
2084 Note that the set of delimiters @var{delimiters} do not have to be the
2085 same on every call in a series of calls to @code{strtok}.
2087 If the end of the string @var{newstring} is reached, or if the remainder of
2088 string consists only of delimiter bytes, @code{strtok} returns
2089 a null pointer.
2091 In a multibyte string, characters consisting of
2092 more than one byte are not treated as single entities.  Each byte is treated
2093 separately.  The function is not locale-dependent.
2094 @end deftypefun
2096 @deftypefun {wchar_t *} wcstok (wchar_t *@var{newstring}, const wchar_t *@var{delimiters}, wchar_t **@var{save_ptr})
2097 @standards{ISO, wchar.h}
2098 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2099 A string can be split into tokens by making a series of calls to the
2100 function @code{wcstok}.
2102 The string to be split up is passed as the @var{newstring} argument on
2103 the first call only.  The @code{wcstok} function uses this to set up
2104 some internal state information.  Subsequent calls to get additional
2105 tokens from the same wide string are indicated by passing a
2106 null pointer as the @var{newstring} argument, which causes the pointer
2107 previously stored in @var{save_ptr} to be used instead.
2109 The @var{delimiters} argument is a wide string that specifies
2110 a set of delimiters that may surround the token being extracted.  All
2111 the initial wide characters that are members of this set are discarded.
2112 The first wide character that is @emph{not} a member of this set of
2113 delimiters marks the beginning of the next token.  The end of the token
2114 is found by looking for the next wide character that is a member of the
2115 delimiter set.  This wide character in the original wide
2116 string @var{newstring} is overwritten by a null wide character, the
2117 pointer past the overwritten wide character is saved in @var{save_ptr},
2118 and the pointer to the beginning of the token in @var{newstring} is
2119 returned.
2121 On the next call to @code{wcstok}, the searching begins at the next
2122 wide character beyond the one that marked the end of the previous token.
2123 Note that the set of delimiters @var{delimiters} do not have to be the
2124 same on every call in a series of calls to @code{wcstok}.
2126 If the end of the wide string @var{newstring} is reached, or
2127 if the remainder of string consists only of delimiter wide characters,
2128 @code{wcstok} returns a null pointer.
2129 @end deftypefun
2131 @strong{Warning:} Since @code{strtok} and @code{wcstok} alter the string
2132 they is parsing, you should always copy the string to a temporary buffer
2133 before parsing it with @code{strtok}/@code{wcstok} (@pxref{Copying Strings
2134 and Arrays}).  If you allow @code{strtok} or @code{wcstok} to modify
2135 a string that came from another part of your program, you are asking for
2136 trouble; that string might be used for other purposes after
2137 @code{strtok} or @code{wcstok} has modified it, and it would not have
2138 the expected value.
2140 The string that you are operating on might even be a constant.  Then
2141 when @code{strtok} or @code{wcstok} tries to modify it, your program
2142 will get a fatal signal for writing in read-only memory.  @xref{Program
2143 Error Signals}.  Even if the operation of @code{strtok} or @code{wcstok}
2144 would not require a modification of the string (e.g., if there is
2145 exactly one token) the string can (and in the @glibcadj{} case will) be
2146 modified.
2148 This is a special case of a general principle: if a part of a program
2149 does not have as its purpose the modification of a certain data
2150 structure, then it is error-prone to modify the data structure
2151 temporarily.
2153 The function @code{strtok} is not reentrant, whereas @code{wcstok} is.
2154 @xref{Nonreentrancy}, for a discussion of where and why reentrancy is
2155 important.
2157 Here is a simple example showing the use of @code{strtok}.
2159 @comment Yes, this example has been tested.
2160 @smallexample
2161 #include <string.h>
2162 #include <stddef.h>
2164 @dots{}
2166 const char string[] = "words separated by spaces -- and, punctuation!";
2167 const char delimiters[] = " .,;:!-";
2168 char *token, *cp;
2170 @dots{}
2172 cp = strdupa (string);                /* Make writable copy.  */
2173 token = strtok (cp, delimiters);      /* token => "words" */
2174 token = strtok (NULL, delimiters);    /* token => "separated" */
2175 token = strtok (NULL, delimiters);    /* token => "by" */
2176 token = strtok (NULL, delimiters);    /* token => "spaces" */
2177 token = strtok (NULL, delimiters);    /* token => "and" */
2178 token = strtok (NULL, delimiters);    /* token => "punctuation" */
2179 token = strtok (NULL, delimiters);    /* token => NULL */
2180 @end smallexample
2182 @Theglibc{} contains two more functions for tokenizing a string
2183 which overcome the limitation of non-reentrancy.  They are not
2184 available available for wide strings.
2186 @deftypefun {char *} strtok_r (char *@var{newstring}, const char *@var{delimiters}, char **@var{save_ptr})
2187 @standards{POSIX, string.h}
2188 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2189 Just like @code{strtok}, this function splits the string into several
2190 tokens which can be accessed by successive calls to @code{strtok_r}.
2191 The difference is that, as in @code{wcstok}, the information about the
2192 next token is stored in the space pointed to by the third argument,
2193 @var{save_ptr}, which is a pointer to a string pointer.  Calling
2194 @code{strtok_r} with a null pointer for @var{newstring} and leaving
2195 @var{save_ptr} between the calls unchanged does the job without
2196 hindering reentrancy.
2198 This function is defined in POSIX.1 and can be found on many systems
2199 which support multi-threading.
2200 @end deftypefun
2202 @deftypefun {char *} strsep (char **@var{string_ptr}, const char *@var{delimiter})
2203 @standards{BSD, string.h}
2204 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2205 This function has a similar functionality as @code{strtok_r} with the
2206 @var{newstring} argument replaced by the @var{save_ptr} argument.  The
2207 initialization of the moving pointer has to be done by the user.
2208 Successive calls to @code{strsep} move the pointer along the tokens
2209 separated by @var{delimiter}, returning the address of the next token
2210 and updating @var{string_ptr} to point to the beginning of the next
2211 token.
2213 One difference between @code{strsep} and @code{strtok_r} is that if the
2214 input string contains more than one byte from @var{delimiter} in a
2215 row @code{strsep} returns an empty string for each pair of bytes
2216 from @var{delimiter}.  This means that a program normally should test
2217 for @code{strsep} returning an empty string before processing it.
2219 This function was introduced in 4.3BSD and therefore is widely available.
2220 @end deftypefun
2222 Here is how the above example looks like when @code{strsep} is used.
2224 @comment Yes, this example has been tested.
2225 @smallexample
2226 #include <string.h>
2227 #include <stddef.h>
2229 @dots{}
2231 const char string[] = "words separated by spaces -- and, punctuation!";
2232 const char delimiters[] = " .,;:!-";
2233 char *running;
2234 char *token;
2236 @dots{}
2238 running = strdupa (string);
2239 token = strsep (&running, delimiters);    /* token => "words" */
2240 token = strsep (&running, delimiters);    /* token => "separated" */
2241 token = strsep (&running, delimiters);    /* token => "by" */
2242 token = strsep (&running, delimiters);    /* token => "spaces" */
2243 token = strsep (&running, delimiters);    /* token => "" */
2244 token = strsep (&running, delimiters);    /* token => "" */
2245 token = strsep (&running, delimiters);    /* token => "" */
2246 token = strsep (&running, delimiters);    /* token => "and" */
2247 token = strsep (&running, delimiters);    /* token => "" */
2248 token = strsep (&running, delimiters);    /* token => "punctuation" */
2249 token = strsep (&running, delimiters);    /* token => "" */
2250 token = strsep (&running, delimiters);    /* token => NULL */
2251 @end smallexample
2253 @deftypefun {char *} basename (const char *@var{filename})
2254 @standards{GNU, string.h}
2255 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2256 The GNU version of the @code{basename} function returns the last
2257 component of the path in @var{filename}.  This function is the preferred
2258 usage, since it does not modify the argument, @var{filename}, and
2259 respects trailing slashes.  The prototype for @code{basename} can be
2260 found in @file{string.h}.  Note, this function is overridden by the XPG
2261 version, if @file{libgen.h} is included.
2263 Example of using GNU @code{basename}:
2265 @smallexample
2266 #include <string.h>
2269 main (int argc, char *argv[])
2271   char *prog = basename (argv[0]);
2273   if (argc < 2)
2274     @{
2275       fprintf (stderr, "Usage %s <arg>\n", prog);
2276       exit (1);
2277     @}
2279   @dots{}
2281 @end smallexample
2283 @strong{Portability Note:} This function may produce different results
2284 on different systems.
2286 @end deftypefun
2288 @deftypefun {char *} basename (char *@var{path})
2289 @standards{XPG, libgen.h}
2290 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2291 This is the standard XPG defined @code{basename}.  It is similar in
2292 spirit to the GNU version, but may modify the @var{path} by removing
2293 trailing '/' bytes.  If the @var{path} is made up entirely of '/'
2294 bytes, then "/" will be returned.  Also, if @var{path} is
2295 @code{NULL} or an empty string, then "." is returned.  The prototype for
2296 the XPG version can be found in @file{libgen.h}.
2298 Example of using XPG @code{basename}:
2300 @smallexample
2301 #include <libgen.h>
2304 main (int argc, char *argv[])
2306   char *prog;
2307   char *path = strdupa (argv[0]);
2309   prog = basename (path);
2311   if (argc < 2)
2312     @{
2313       fprintf (stderr, "Usage %s <arg>\n", prog);
2314       exit (1);
2315     @}
2317   @dots{}
2320 @end smallexample
2321 @end deftypefun
2323 @deftypefun {char *} dirname (char *@var{path})
2324 @standards{XPG, libgen.h}
2325 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2326 The @code{dirname} function is the compliment to the XPG version of
2327 @code{basename}.  It returns the parent directory of the file specified
2328 by @var{path}.  If @var{path} is @code{NULL}, an empty string, or
2329 contains no '/' bytes, then "." is returned.  The prototype for this
2330 function can be found in @file{libgen.h}.
2331 @end deftypefun
2333 @node Erasing Sensitive Data
2334 @section Erasing Sensitive Data
2336 Sensitive data, such as cryptographic keys, should be erased from
2337 memory after use, to reduce the risk that a bug will expose it to the
2338 outside world.  However, compiler optimizations may determine that an
2339 erasure operation is ``unnecessary,'' and remove it from the generated
2340 code, because no @emph{correct} program could access the variable or
2341 heap object containing the sensitive data after it's deallocated.
2342 Since erasure is a precaution against bugs, this optimization is
2343 inappropriate.
2345 The function @code{explicit_bzero} erases a block of memory, and
2346 guarantees that the compiler will not remove the erasure as
2347 ``unnecessary.''
2349 @smallexample
2350 @group
2351 #include <string.h>
2353 extern void encrypt (const char *key, const char *in,
2354                      char *out, size_t n);
2355 extern void genkey (const char *phrase, char *key);
2357 void encrypt_with_phrase (const char *phrase, const char *in,
2358                           char *out, size_t n)
2360   char key[16];
2361   genkey (phrase, key);
2362   encrypt (key, in, out, n);
2363   explicit_bzero (key, 16);
2365 @end group
2366 @end smallexample
2368 @noindent
2369 In this example, if @code{memset}, @code{bzero}, or a hand-written
2370 loop had been used, the compiler might remove them as ``unnecessary.''
2372 @strong{Warning:} @code{explicit_bzero} does not guarantee that
2373 sensitive data is @emph{completely} erased from the computer's memory.
2374 There may be copies in temporary storage areas, such as registers and
2375 ``scratch'' stack space; since these are invisible to the source code,
2376 a library function cannot erase them.
2378 Also, @code{explicit_bzero} only operates on RAM.  If a sensitive data
2379 object never needs to have its address taken other than to call
2380 @code{explicit_bzero}, it might be stored entirely in CPU registers
2381 @emph{until} the call to @code{explicit_bzero}.  Then it will be
2382 copied into RAM, the copy will be erased, and the original will remain
2383 intact.  Data in RAM is more likely to be exposed by a bug than data
2384 in registers, so this creates a brief window where the data is at
2385 greater risk of exposure than it would have been if the program didn't
2386 try to erase it at all.
2388 Declaring sensitive variables as @code{volatile} will make both the
2389 above problems @emph{worse}; a @code{volatile} variable will be stored
2390 in memory for its entire lifetime, and the compiler will make
2391 @emph{more} copies of it than it would otherwise have.  Attempting to
2392 erase a normal variable ``by hand'' through a
2393 @code{volatile}-qualified pointer doesn't work at all---because the
2394 variable itself is not @code{volatile}, some compilers will ignore the
2395 qualification on the pointer and remove the erasure anyway.
2397 Having said all that, in most situations, using @code{explicit_bzero}
2398 is better than not using it.  At present, the only way to do a more
2399 thorough job is to write the entire sensitive operation in assembly
2400 language.  We anticipate that future compilers will recognize calls to
2401 @code{explicit_bzero} and take appropriate steps to erase all the
2402 copies of the affected data, whereever they may be.
2404 @deftypefun void explicit_bzero (void *@var{block}, size_t @var{len})
2405 @standards{BSD, string.h}
2406 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2408 @code{explicit_bzero} writes zero into @var{len} bytes of memory
2409 beginning at @var{block}, just as @code{bzero} would.  The zeroes are
2410 always written, even if the compiler could determine that this is
2411 ``unnecessary'' because no correct program could read them back.
2413 @strong{Note:} The @emph{only} optimization that @code{explicit_bzero}
2414 disables is removal of ``unnecessary'' writes to memory.  The compiler
2415 can perform all the other optimizations that it could for a call to
2416 @code{memset}.  For instance, it may replace the function call with
2417 inline memory writes, and it may assume that @var{block} cannot be a
2418 null pointer.
2420 @strong{Portability Note:} This function first appeared in OpenBSD 5.5
2421 and has not been standardized.  Other systems may provide the same
2422 functionality under a different name, such as @code{explicit_memset},
2423 @code{memset_s}, or @code{SecureZeroMemory}.
2425 @Theglibc{} declares this function in @file{string.h}, but on other
2426 systems it may be in @file{strings.h} instead.
2427 @end deftypefun
2430 @node Shuffling Bytes
2431 @section Shuffling Bytes
2433 The function below addresses the perennial programming quandary: ``How do
2434 I take good data in string form and painlessly turn it into garbage?''
2435 This is not a difficult thing to code for oneself, but the authors of
2436 @theglibc{} wish to make it as convenient as possible.
2438 To @emph{erase} data, use @code{explicit_bzero} (@pxref{Erasing
2439 Sensitive Data}); to obfuscate it reversibly, use @code{memfrob}
2440 (@pxref{Obfuscating Data}).
2442 @deftypefun {char *} strfry (char *@var{string})
2443 @standards{GNU, string.h}
2444 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2445 @c Calls initstate_r, time, getpid, strlen, and random_r.
2447 @code{strfry} performs an in-place shuffle on @var{string}.  Each
2448 character is swapped to a position selected at random, within the
2449 portion of the string starting with the character's original position.
2450 (This is the Fisher-Yates algorithm for unbiased shuffling.)
2452 Calling @code{strfry} will not disturb any of the random number
2453 generators that have global state (@pxref{Pseudo-Random Numbers}).
2455 The return value of @code{strfry} is always @var{string}.
2457 @strong{Portability Note:}  This function is unique to @theglibc{}.
2458 It is declared in @file{string.h}.
2459 @end deftypefun
2462 @node Obfuscating Data
2463 @section Obfuscating Data
2464 @cindex Rot13
2466 The @code{memfrob} function reversibly obfuscates an array of binary
2467 data.  This is not true encryption; the obfuscated data still bears a
2468 clear relationship to the original, and no secret key is required to
2469 undo the obfuscation.  It is analogous to the ``Rot13'' cipher used on
2470 Usenet for obscuring offensive jokes, spoilers for works of fiction,
2471 and so on, but it can be applied to arbitrary binary data.
2473 Programs that need true encryption---a transformation that completely
2474 obscures the original and cannot be reversed without knowledge of a
2475 secret key---should use a dedicated cryptography library, such as
2476 @uref{https://www.gnu.org/software/libgcrypt/,,libgcrypt}.
2478 Programs that need to @emph{destroy} data should use
2479 @code{explicit_bzero} (@pxref{Erasing Sensitive Data}), or possibly
2480 @code{strfry} (@pxref{Shuffling Bytes}).
2482 @deftypefun {void *} memfrob (void *@var{mem}, size_t @var{length})
2483 @standards{GNU, string.h}
2484 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2486 The function @code{memfrob} obfuscates @var{length} bytes of data
2487 beginning at @var{mem}, in place.  Each byte is bitwise xor-ed with
2488 the binary pattern 00101010 (hexadecimal 0x2A).  The return value is
2489 always @var{mem}.
2491 @code{memfrob} a second time on the same data returns it to
2492 its original state.
2494 @strong{Portability Note:}  This function is unique to @theglibc{}.
2495 It is declared in @file{string.h}.
2496 @end deftypefun
2498 @node Encode Binary Data
2499 @section Encode Binary Data
2501 To store or transfer binary data in environments which only support text
2502 one has to encode the binary data by mapping the input bytes to
2503 bytes in the range allowed for storing or transferring.  SVID
2504 systems (and nowadays XPG compliant systems) provide minimal support for
2505 this task.
2507 @deftypefun {char *} l64a (long int @var{n})
2508 @standards{XPG, stdlib.h}
2509 @safety{@prelim{}@mtunsafe{@mtasurace{:l64a}}@asunsafe{}@acsafe{}}
2510 This function encodes a 32-bit input value using bytes from the
2511 basic character set.  It returns a pointer to a 7 byte buffer which
2512 contains an encoded version of @var{n}.  To encode a series of bytes the
2513 user must copy the returned string to a destination buffer.  It returns
2514 the empty string if @var{n} is zero, which is somewhat bizarre but
2515 mandated by the standard.@*
2516 @strong{Warning:} Since a static buffer is used this function should not
2517 be used in multi-threaded programs.  There is no thread-safe alternative
2518 to this function in the C library.@*
2519 @strong{Compatibility Note:} The XPG standard states that the return
2520 value of @code{l64a} is undefined if @var{n} is negative.  In the GNU
2521 implementation, @code{l64a} treats its argument as unsigned, so it will
2522 return a sensible encoding for any nonzero @var{n}; however, portable
2523 programs should not rely on this.
2525 To encode a large buffer @code{l64a} must be called in a loop, once for
2526 each 32-bit word of the buffer.  For example, one could do something
2527 like this:
2529 @smallexample
2530 char *
2531 encode (const void *buf, size_t len)
2533   /* @r{We know in advance how long the buffer has to be.} */
2534   unsigned char *in = (unsigned char *) buf;
2535   char *out = malloc (6 + ((len + 3) / 4) * 6 + 1);
2536   char *cp = out, *p;
2538   /* @r{Encode the length.} */
2539   /* @r{Using `htonl' is necessary so that the data can be}
2540      @r{decoded even on machines with different byte order.}
2541      @r{`l64a' can return a string shorter than 6 bytes, so }
2542      @r{we pad it with encoding of 0 (}'.'@r{) at the end by }
2543      @r{hand.} */
2545   p = stpcpy (cp, l64a (htonl (len)));
2546   cp = mempcpy (p, "......", 6 - (p - cp));
2548   while (len > 3)
2549     @{
2550       unsigned long int n = *in++;
2551       n = (n << 8) | *in++;
2552       n = (n << 8) | *in++;
2553       n = (n << 8) | *in++;
2554       len -= 4;
2555       p = stpcpy (cp, l64a (htonl (n)));
2556       cp = mempcpy (p, "......", 6 - (p - cp));
2557     @}
2558   if (len > 0)
2559     @{
2560       unsigned long int n = *in++;
2561       if (--len > 0)
2562         @{
2563           n = (n << 8) | *in++;
2564           if (--len > 0)
2565             n = (n << 8) | *in;
2566         @}
2567       cp = stpcpy (cp, l64a (htonl (n)));
2568     @}
2569   *cp = '\0';
2570   return out;
2572 @end smallexample
2574 It is strange that the library does not provide the complete
2575 functionality needed but so be it.
2577 @end deftypefun
2579 To decode data produced with @code{l64a} the following function should be
2580 used.
2582 @deftypefun {long int} a64l (const char *@var{string})
2583 @standards{XPG, stdlib.h}
2584 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2585 The parameter @var{string} should contain a string which was produced by
2586 a call to @code{l64a}.  The function processes at least 6 bytes of
2587 this string, and decodes the bytes it finds according to the table
2588 below.  It stops decoding when it finds a byte not in the table,
2589 rather like @code{atoi}; if you have a buffer which has been broken into
2590 lines, you must be careful to skip over the end-of-line bytes.
2592 The decoded number is returned as a @code{long int} value.
2593 @end deftypefun
2595 The @code{l64a} and @code{a64l} functions use a base 64 encoding, in
2596 which each byte of an encoded string represents six bits of an
2597 input word.  These symbols are used for the base 64 digits:
2599 @multitable {xxxxx} {xxx} {xxx} {xxx} {xxx} {xxx} {xxx} {xxx} {xxx}
2600 @item              @tab 0 @tab 1 @tab 2 @tab 3 @tab 4 @tab 5 @tab 6 @tab 7
2601 @item       0      @tab @code{.} @tab @code{/} @tab @code{0} @tab @code{1}
2602                    @tab @code{2} @tab @code{3} @tab @code{4} @tab @code{5}
2603 @item       8      @tab @code{6} @tab @code{7} @tab @code{8} @tab @code{9}
2604                    @tab @code{A} @tab @code{B} @tab @code{C} @tab @code{D}
2605 @item       16     @tab @code{E} @tab @code{F} @tab @code{G} @tab @code{H}
2606                    @tab @code{I} @tab @code{J} @tab @code{K} @tab @code{L}
2607 @item       24     @tab @code{M} @tab @code{N} @tab @code{O} @tab @code{P}
2608                    @tab @code{Q} @tab @code{R} @tab @code{S} @tab @code{T}
2609 @item       32     @tab @code{U} @tab @code{V} @tab @code{W} @tab @code{X}
2610                    @tab @code{Y} @tab @code{Z} @tab @code{a} @tab @code{b}
2611 @item       40     @tab @code{c} @tab @code{d} @tab @code{e} @tab @code{f}
2612                    @tab @code{g} @tab @code{h} @tab @code{i} @tab @code{j}
2613 @item       48     @tab @code{k} @tab @code{l} @tab @code{m} @tab @code{n}
2614                    @tab @code{o} @tab @code{p} @tab @code{q} @tab @code{r}
2615 @item       56     @tab @code{s} @tab @code{t} @tab @code{u} @tab @code{v}
2616                    @tab @code{w} @tab @code{x} @tab @code{y} @tab @code{z}
2617 @end multitable
2619 This encoding scheme is not standard.  There are some other encoding
2620 methods which are much more widely used (UU encoding, MIME encoding).
2621 Generally, it is better to use one of these encodings.
2623 @node Argz and Envz Vectors
2624 @section Argz and Envz Vectors
2626 @cindex argz vectors (string vectors)
2627 @cindex string vectors, null-byte separated
2628 @cindex argument vectors, null-byte separated
2629 @dfn{argz vectors} are vectors of strings in a contiguous block of
2630 memory, each element separated from its neighbors by null bytes
2631 (@code{'\0'}).
2633 @cindex envz vectors (environment vectors)
2634 @cindex environment vectors, null-byte separated
2635 @dfn{Envz vectors} are an extension of argz vectors where each element is a
2636 name-value pair, separated by a @code{'='} byte (as in a Unix
2637 environment).
2639 @menu
2640 * Argz Functions::              Operations on argz vectors.
2641 * Envz Functions::              Additional operations on environment vectors.
2642 @end menu
2644 @node Argz Functions, Envz Functions, , Argz and Envz Vectors
2645 @subsection Argz Functions
2647 Each argz vector is represented by a pointer to the first element, of
2648 type @code{char *}, and a size, of type @code{size_t}, both of which can
2649 be initialized to @code{0} to represent an empty argz vector.  All argz
2650 functions accept either a pointer and a size argument, or pointers to
2651 them, if they will be modified.
2653 The argz functions use @code{malloc}/@code{realloc} to allocate/grow
2654 argz vectors, and so any argz vector created using these functions may
2655 be freed by using @code{free}; conversely, any argz function that may
2656 grow a string expects that string to have been allocated using
2657 @code{malloc} (those argz functions that only examine their arguments or
2658 modify them in place will work on any sort of memory).
2659 @xref{Unconstrained Allocation}.
2661 All argz functions that do memory allocation have a return type of
2662 @code{error_t}, and return @code{0} for success, and @code{ENOMEM} if an
2663 allocation error occurs.
2665 @pindex argz.h
2666 These functions are declared in the standard include file @file{argz.h}.
2668 @deftypefun {error_t} argz_create (char *const @var{argv}[], char **@var{argz}, size_t *@var{argz_len})
2669 @standards{GNU, argz.h}
2670 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2671 The @code{argz_create} function converts the Unix-style argument vector
2672 @var{argv} (a vector of pointers to normal C strings, terminated by
2673 @code{(char *)0}; @pxref{Program Arguments}) into an argz vector with
2674 the same elements, which is returned in @var{argz} and @var{argz_len}.
2675 @end deftypefun
2677 @deftypefun {error_t} argz_create_sep (const char *@var{string}, int @var{sep}, char **@var{argz}, size_t *@var{argz_len})
2678 @standards{GNU, argz.h}
2679 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2680 The @code{argz_create_sep} function converts the string
2681 @var{string} into an argz vector (returned in @var{argz} and
2682 @var{argz_len}) by splitting it into elements at every occurrence of the
2683 byte @var{sep}.
2684 @end deftypefun
2686 @deftypefun {size_t} argz_count (const char *@var{argz}, size_t @var{argz_len})
2687 @standards{GNU, argz.h}
2688 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2689 Returns the number of elements in the argz vector @var{argz} and
2690 @var{argz_len}.
2691 @end deftypefun
2693 @deftypefun {void} argz_extract (const char *@var{argz}, size_t @var{argz_len}, char **@var{argv})
2694 @standards{GNU, argz.h}
2695 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2696 The @code{argz_extract} function converts the argz vector @var{argz} and
2697 @var{argz_len} into a Unix-style argument vector stored in @var{argv},
2698 by putting pointers to every element in @var{argz} into successive
2699 positions in @var{argv}, followed by a terminator of @code{0}.
2700 @var{Argv} must be pre-allocated with enough space to hold all the
2701 elements in @var{argz} plus the terminating @code{(char *)0}
2702 (@code{(argz_count (@var{argz}, @var{argz_len}) + 1) * sizeof (char *)}
2703 bytes should be enough).  Note that the string pointers stored into
2704 @var{argv} point into @var{argz}---they are not copies---and so
2705 @var{argz} must be copied if it will be changed while @var{argv} is
2706 still active.  This function is useful for passing the elements in
2707 @var{argz} to an exec function (@pxref{Executing a File}).
2708 @end deftypefun
2710 @deftypefun {void} argz_stringify (char *@var{argz}, size_t @var{len}, int @var{sep})
2711 @standards{GNU, argz.h}
2712 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2713 The @code{argz_stringify} converts @var{argz} into a normal string with
2714 the elements separated by the byte @var{sep}, by replacing each
2715 @code{'\0'} inside @var{argz} (except the last one, which terminates the
2716 string) with @var{sep}.  This is handy for printing @var{argz} in a
2717 readable manner.
2718 @end deftypefun
2720 @deftypefun {error_t} argz_add (char **@var{argz}, size_t *@var{argz_len}, const char *@var{str})
2721 @standards{GNU, argz.h}
2722 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2723 @c Calls strlen and argz_append.
2724 The @code{argz_add} function adds the string @var{str} to the end of the
2725 argz vector @code{*@var{argz}}, and updates @code{*@var{argz}} and
2726 @code{*@var{argz_len}} accordingly.
2727 @end deftypefun
2729 @deftypefun {error_t} argz_add_sep (char **@var{argz}, size_t *@var{argz_len}, const char *@var{str}, int @var{delim})
2730 @standards{GNU, argz.h}
2731 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2732 The @code{argz_add_sep} function is similar to @code{argz_add}, but
2733 @var{str} is split into separate elements in the result at occurrences of
2734 the byte @var{delim}.  This is useful, for instance, for
2735 adding the components of a Unix search path to an argz vector, by using
2736 a value of @code{':'} for @var{delim}.
2737 @end deftypefun
2739 @deftypefun {error_t} argz_append (char **@var{argz}, size_t *@var{argz_len}, const char *@var{buf}, size_t @var{buf_len})
2740 @standards{GNU, argz.h}
2741 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2742 The @code{argz_append} function appends @var{buf_len} bytes starting at
2743 @var{buf} to the argz vector @code{*@var{argz}}, reallocating
2744 @code{*@var{argz}} to accommodate it, and adding @var{buf_len} to
2745 @code{*@var{argz_len}}.
2746 @end deftypefun
2748 @deftypefun {void} argz_delete (char **@var{argz}, size_t *@var{argz_len}, char *@var{entry})
2749 @standards{GNU, argz.h}
2750 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2751 @c Calls free if no argument is left.
2752 If @var{entry} points to the beginning of one of the elements in the
2753 argz vector @code{*@var{argz}}, the @code{argz_delete} function will
2754 remove this entry and reallocate @code{*@var{argz}}, modifying
2755 @code{*@var{argz}} and @code{*@var{argz_len}} accordingly.  Note that as
2756 destructive argz functions usually reallocate their argz argument,
2757 pointers into argz vectors such as @var{entry} will then become invalid.
2758 @end deftypefun
2760 @deftypefun {error_t} argz_insert (char **@var{argz}, size_t *@var{argz_len}, char *@var{before}, const char *@var{entry})
2761 @standards{GNU, argz.h}
2762 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2763 @c Calls argz_add or realloc and memmove.
2764 The @code{argz_insert} function inserts the string @var{entry} into the
2765 argz vector @code{*@var{argz}} at a point just before the existing
2766 element pointed to by @var{before}, reallocating @code{*@var{argz}} and
2767 updating @code{*@var{argz}} and @code{*@var{argz_len}}.  If @var{before}
2768 is @code{0}, @var{entry} is added to the end instead (as if by
2769 @code{argz_add}).  Since the first element is in fact the same as
2770 @code{*@var{argz}}, passing in @code{*@var{argz}} as the value of
2771 @var{before} will result in @var{entry} being inserted at the beginning.
2772 @end deftypefun
2774 @deftypefun {char *} argz_next (const char *@var{argz}, size_t @var{argz_len}, const char *@var{entry})
2775 @standards{GNU, argz.h}
2776 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2777 The @code{argz_next} function provides a convenient way of iterating
2778 over the elements in the argz vector @var{argz}.  It returns a pointer
2779 to the next element in @var{argz} after the element @var{entry}, or
2780 @code{0} if there are no elements following @var{entry}.  If @var{entry}
2781 is @code{0}, the first element of @var{argz} is returned.
2783 This behavior suggests two styles of iteration:
2785 @smallexample
2786     char *entry = 0;
2787     while ((entry = argz_next (@var{argz}, @var{argz_len}, entry)))
2788       @var{action};
2789 @end smallexample
2791 (the double parentheses are necessary to make some C compilers shut up
2792 about what they consider a questionable @code{while}-test) and:
2794 @smallexample
2795     char *entry;
2796     for (entry = @var{argz};
2797          entry;
2798          entry = argz_next (@var{argz}, @var{argz_len}, entry))
2799       @var{action};
2800 @end smallexample
2802 Note that the latter depends on @var{argz} having a value of @code{0} if
2803 it is empty (rather than a pointer to an empty block of memory); this
2804 invariant is maintained for argz vectors created by the functions here.
2805 @end deftypefun
2807 @deftypefun error_t argz_replace (@w{char **@var{argz}, size_t *@var{argz_len}}, @w{const char *@var{str}, const char *@var{with}}, @w{unsigned *@var{replace_count}})
2808 @standards{GNU, argz.h}
2809 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2810 Replace any occurrences of the string @var{str} in @var{argz} with
2811 @var{with}, reallocating @var{argz} as necessary.  If
2812 @var{replace_count} is non-zero, @code{*@var{replace_count}} will be
2813 incremented by the number of replacements performed.
2814 @end deftypefun
2816 @node Envz Functions, , Argz Functions, Argz and Envz Vectors
2817 @subsection Envz Functions
2819 Envz vectors are just argz vectors with additional constraints on the form
2820 of each element; as such, argz functions can also be used on them, where it
2821 makes sense.
2823 Each element in an envz vector is a name-value pair, separated by a @code{'='}
2824 byte; if multiple @code{'='} bytes are present in an element, those
2825 after the first are considered part of the value, and treated like all other
2826 non-@code{'\0'} bytes.
2828 If @emph{no} @code{'='} bytes are present in an element, that element is
2829 considered the name of a ``null'' entry, as distinct from an entry with an
2830 empty value: @code{envz_get} will return @code{0} if given the name of null
2831 entry, whereas an entry with an empty value would result in a value of
2832 @code{""}; @code{envz_entry} will still find such entries, however.  Null
2833 entries can be removed with the @code{envz_strip} function.
2835 As with argz functions, envz functions that may allocate memory (and thus
2836 fail) have a return type of @code{error_t}, and return either @code{0} or
2837 @code{ENOMEM}.
2839 @pindex envz.h
2840 These functions are declared in the standard include file @file{envz.h}.
2842 @deftypefun {char *} envz_entry (const char *@var{envz}, size_t @var{envz_len}, const char *@var{name})
2843 @standards{GNU, envz.h}
2844 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2845 The @code{envz_entry} function finds the entry in @var{envz} with the name
2846 @var{name}, and returns a pointer to the whole entry---that is, the argz
2847 element which begins with @var{name} followed by a @code{'='} byte.  If
2848 there is no entry with that name, @code{0} is returned.
2849 @end deftypefun
2851 @deftypefun {char *} envz_get (const char *@var{envz}, size_t @var{envz_len}, const char *@var{name})
2852 @standards{GNU, envz.h}
2853 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2854 The @code{envz_get} function finds the entry in @var{envz} with the name
2855 @var{name} (like @code{envz_entry}), and returns a pointer to the value
2856 portion of that entry (following the @code{'='}).  If there is no entry with
2857 that name (or only a null entry), @code{0} is returned.
2858 @end deftypefun
2860 @deftypefun {error_t} envz_add (char **@var{envz}, size_t *@var{envz_len}, const char *@var{name}, const char *@var{value})
2861 @standards{GNU, envz.h}
2862 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2863 @c Calls envz_remove, which calls enz_entry and argz_delete, and then
2864 @c argz_add or equivalent code that reallocs and appends name=value.
2865 The @code{envz_add} function adds an entry to @code{*@var{envz}}
2866 (updating @code{*@var{envz}} and @code{*@var{envz_len}}) with the name
2867 @var{name}, and value @var{value}.  If an entry with the same name
2868 already exists in @var{envz}, it is removed first.  If @var{value} is
2869 @code{0}, then the new entry will be the special null type of entry
2870 (mentioned above).
2871 @end deftypefun
2873 @deftypefun {error_t} envz_merge (char **@var{envz}, size_t *@var{envz_len}, const char *@var{envz2}, size_t @var{envz2_len}, int @var{override})
2874 @standards{GNU, envz.h}
2875 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2876 The @code{envz_merge} function adds each entry in @var{envz2} to @var{envz},
2877 as if with @code{envz_add}, updating @code{*@var{envz}} and
2878 @code{*@var{envz_len}}.  If @var{override} is true, then values in @var{envz2}
2879 will supersede those with the same name in @var{envz}, otherwise not.
2881 Null entries are treated just like other entries in this respect, so a null
2882 entry in @var{envz} can prevent an entry of the same name in @var{envz2} from
2883 being added to @var{envz}, if @var{override} is false.
2884 @end deftypefun
2886 @deftypefun {void} envz_strip (char **@var{envz}, size_t *@var{envz_len})
2887 @standards{GNU, envz.h}
2888 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
2889 The @code{envz_strip} function removes any null entries from @var{envz},
2890 updating @code{*@var{envz}} and @code{*@var{envz_len}}.
2891 @end deftypefun
2893 @deftypefun {void} envz_remove (char **@var{envz}, size_t *@var{envz_len}, const char *@var{name})
2894 @standards{GNU, envz.h}
2895 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
2896 The @code{envz_remove} function removes an entry named @var{name} from
2897 @var{envz}, updating @code{*@var{envz}} and @code{*@var{envz_len}}.
2898 @end deftypefun
2900 @c FIXME this are undocumented:
2901 @c strcasecmp_l @safety{@mtsafe{}@assafe{}@acsafe{}} see strcasecmp