3 * $Id: str.h,v 1.1 1999/05/17 20:37:01 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.1 1999/05/17 20:37:01 mdw
34 * Some trivial string hacks.
45 /*----- Header files ------------------------------------------------------*/
49 /*----- Functions provided ------------------------------------------------*/
51 /* --- @str_getword@ --- *
53 * Arguments: @char **pp@ = address of pointer into string
55 * Returns: Pointer to the next space-separated word from the string,
58 * Use: Parses off space-separated words from a string.
61 extern char *str_getword(char **/*pp*/);
63 /* --- @str_split@ --- *
65 * Arguments: @char *p@ = pointer to string
66 * @char *v[]@ = pointer to array to fill in
67 * @size_t c@ = count of strings to fill in
69 * Returns: Number of strings filled in.
71 * Use: Fills an array with pointers to the individual words of a
72 * string. The string is modified in place to contain zero
73 * bytes at the word boundaries, and the words have leading
74 * and trailing space stripped off. No more than @c@ words
75 * are read; the actual number is returned as the value of the
76 * function. Unused slots in the array are populated with
80 extern size_t str_split(char */*p*/, char */*v*/[], size_t /*c*/);
82 /* --- @str_sanitize@ --- *
84 * Arguments: @char *d@ = destination buffer
85 * @const char *p@ = pointer to source string
86 * @size_t sz@ = size of destination buffer
90 * Use: Writes a string into a buffer, being careful not to overflow
91 * the buffer, to null terminate the result, and to prevent
92 * nasty nonprintable characters ending up in the buffer.
95 extern void str_sanitize(char */*d*/, const char */*p*/, size_t /*sz*/);
97 /*----- That's all, folks -------------------------------------------------*/