/* -*-c-*-
*
- * $Id: str.h,v 1.1 1999/05/17 20:37:01 mdw Exp $
+ * $Id: str.h,v 1.4 2000/10/08 09:43:34 mdw Exp $
*
* Functions for hacking with strings
*
/*----- Revision history --------------------------------------------------*
*
* $Log: str.h,v $
+ * Revision 1.4 2000/10/08 09:43:34 mdw
+ * New quoted string handling and simple pattern matching.
+ *
+ * Revision 1.3 1999/12/10 23:42:04 mdw
+ * Change header file guard names.
+ *
+ * Revision 1.2 1999/05/26 20:52:57 mdw
+ * Add new `rest' argument for `str_split'.
+ *
* Revision 1.1 1999/05/17 20:37:01 mdw
* Some trivial string hacks.
*
*/
-#ifndef STR_H
-#define STR_H
+#ifndef MLIB_STR_H
+#define MLIB_STR_H
#ifdef __cplusplus
extern "C" {
/*----- Functions provided ------------------------------------------------*/
-/* --- @str_getword@ --- *
+/* --- @str_qword@ --- *
*
* Arguments: @char **pp@ = address of pointer into string
+ * @unsigned f@ = various flags
*
- * Returns: Pointer to the next space-separated word from the string,
- * or null.
+ * Returns: Pointer to the next space-separated possibly-quoted word from
+ * the string, or null.
*
- * Use: Parses off space-separated words from a string.
+ * Use: Fetches the next word from a string. If the flag
+ * @STRF_QUOTE@ is set, the `\' character acts as an escape, and
+ * single and double quotes protect whitespace.
*/
-extern char *str_getword(char **/*pp*/);
+#define STRF_QUOTE 1u
-/* --- @str_split@ --- *
+extern char *str_qword(char **/*pp*/, unsigned /*f*/);
+
+/* --- @str_qsplit@ --- *
*
* Arguments: @char *p@ = pointer to string
* @char *v[]@ = pointer to array to fill in
* @size_t c@ = count of strings to fill in
+ * @char **rest@ = where to store the remainder of the string
+ * @unsigned f@ = flags for @str_qword@
*
* Returns: Number of strings filled in.
*
* and trailing space stripped off. No more than @c@ words
* are read; the actual number is returned as the value of the
* function. Unused slots in the array are populated with
- * null bytes.
+ * null bytes. If there's any string left, the address of the
+ * remainder is stored in @rest@ (if it's non-null); otherwise
+ * @rest@ is set to a null pointer.
+ */
+
+extern size_t str_qsplit(char */*p*/, char */*v*/[], size_t /*c*/,
+ char **/*rest*/, unsigned /*f*/);
+
+/* --- @str_getword@ --- *
+ *
+ * Arguments: @char **pp@ = address of pointer into string
+ *
+ * Returns: Pointer to the next space-separated word from the string,
+ * or null.
+ *
+ * Use: Parses off space-separated words from a string. This is a
+ * compatibility veneer over @str_qword@.
+ */
+
+extern char *str_getword(char **/*pp*/);
+
+/* --- @str_split@ --- *
+ *
+ * Arguments: @char *p@ = pointer to string
+ * @char *v[]@ = pointer to array to fill in
+ * @size_t c@ = count of strings to fill in
+ * @char **rest@ = where to store the remainder of the string
+ *
+ * Returns: Number of strings filled in.
+ *
+ * Use: Fills an array with pointers to the individual words of a
+ * string. This is a compatibility veneer over @str_qsplit@.
+ */
+
+extern size_t str_split(char */*p*/, char */*v*/[],
+ size_t /*c*/, char **/*rest*/);
+
+/* --- @str_match@ --- *
+ *
+ * Arguments: @const char *p@ = pointer to pattern string
+ * @const char *s@ = string to compare with
+ *
+ * Returns: Nonzero if the pattern matches the string.
+ *
+ * Use: Does simple wildcard matching. This is quite nasty and more
+ * than a little slow. Supports metacharacters `*', `?' and
+ * '['.
*/
-extern size_t str_split(char */*p*/, char */*v*/[], size_t /*c*/);
+extern int str_match(const char */*p*/, const char */*s*/);
/* --- @str_sanitize@ --- *
*