3 * $Id: str.h,v 1.2 1999/05/26 20:52:57 mdw Exp $
5 * Functions for hacking with strings
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.2 1999/05/26 20:52:57 mdw
34 * Add new `rest' argument for `str_split'.
36 * Revision 1.1 1999/05/17 20:37:01 mdw
37 * Some trivial string hacks.
48 /*----- Header files ------------------------------------------------------*/
52 /*----- Functions provided ------------------------------------------------*/
54 /* --- @str_getword@ --- *
56 * Arguments: @char **pp@ = address of pointer into string
58 * Returns: Pointer to the next space-separated word from the string,
61 * Use: Parses off space-separated words from a string.
64 extern char *str_getword(char **/
*pp*/
);
66 /* --- @str_split@ --- *
68 * Arguments: @char *p@ = pointer to string
69 * @char *v[]@ = pointer to array to fill in
70 * @size_t c@ = count of strings to fill in
71 * @char **rest@ = where to store the remainder of the string
73 * Returns: Number of strings filled in.
75 * Use: Fills an array with pointers to the individual words of a
76 * string. The string is modified in place to contain zero
77 * bytes at the word boundaries, and the words have leading
78 * and trailing space stripped off. No more than @c@ words
79 * are read; the actual number is returned as the value of the
80 * function. Unused slots in the array are populated with
81 * null bytes. If there's any string left, the address of the
82 * remainder is stored in @rest@ (if it's non-null); otherwise
83 * @rest@ is set to a null pointer.
86 extern size_t str_split(char */
*p*/
, char */
*v*/
[],
87 size_t /*c*/, char **/
*rest*/
);
89 /* --- @str_sanitize@ --- *
91 * Arguments: @char *d@ = destination buffer
92 * @const char *p@ = pointer to source string
93 * @size_t sz@ = size of destination buffer
97 * Use: Writes a string into a buffer, being careful not to overflow
98 * the buffer, to null terminate the result, and to prevent
99 * nasty nonprintable characters ending up in the buffer.
102 extern void str_sanitize(char */
*d*/
, const char */
*p*/
, size_t /*sz*/);
104 /*----- That's all, folks -------------------------------------------------*/