Version bump.

[fwd] / conf.h

diff --git a/conf.h b/conf.h
index 6183048..f9e25e9 100644 (file)
--- a/conf.h
+++ b/conf.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: conf.h,v 1.3 1999/07/27 18:30:14 mdw Exp $
+ * $Id: conf.h,v 1.7 2002/02/22 23:42:56 mdw Exp $
  *
  * Configuration parsing
  *
@@ -29,6 +29,21 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: conf.h,v $
+ * Revision 1.7  2002/02/22 23:42:56  mdw
+ * `fw'-specific configuration code moved out.  This file might become part
+ * of a library some day.
+ *
+ * Revision 1.6  2002/01/13 14:48:16  mdw
+ * Make delimiters be a property of a scanner.  Change the delimiter-
+ * changing functions' names.
+ *
+ * Revision 1.5  1999/10/22 22:46:44  mdw
+ * Improve documentation for conf_enum.
+ *
+ * Revision 1.4  1999/08/19 18:32:48  mdw
+ * Improve lexical analysis.  In particular, `chmod' patterns don't have to
+ * be quoted any more.
+ *
  * Revision 1.3  1999/07/27 18:30:14  mdw
  * Improve documentation and layout for @CONF_BEGIN@ and friends.  Remove
  * irritating warning about unused label by introducing a spurious `goto'.
@@ -63,6 +78,21 @@
 
 /*----- Functions provided ------------------------------------------------*/
 
+/* --- @conf_undelim@ --- *
+ *
+ * Arguments:  @scanner *sc@ = pointer to scanner definition
+ *             @const char *d, *dd@ = pointer to characters to escape
+ *
+ * Returns:    ---
+ *
+ * Use:                Modifies the tokenizer.  Characters in the first list will
+ *             always be considered to begin a word.  Characters in the
+ *             second list will always be allowed to continue a word.
+ */
+
+extern void conf_undelim(scanner */*sc*/,
+                        const char */*d*/, const char */*dd*/);
+
 /* --- @token@ --- *
  *
  * Arguments:  @scanner *sc@ = pointer to scanner definition
@@ -87,6 +117,18 @@ extern int token(scanner */*sc*/);
 
 extern void error(scanner */*sc*/, const char */*msg*/, ...);
 
+/* --- @pushback@ --- *
+ *
+ * Arguments:  @scanner *sc@ = pointer to scanner definition
+ *
+ * Returns:    ---
+ *
+ * Use:                Pushes the current token back.  This is normally a precursor
+ *             to pushing a new scanner source.
+ */
+
+extern void pushback(scanner */*sc*/);
+
 /* --- @conf_enum@ --- *
  *
  * Arguments:  @scanner *sc@ = pointer to a scanner object
@@ -97,9 +139,15 @@ extern void error(scanner */*sc*/, const char */*msg*/, ...);
  * Returns:    Index into list, zero-based, or @-1@.
  *
  * Use:                Checks whether the current token is a string which matches
- *             one of the comma-separated items given.  If not, an error is
- *             reported; otherwise the index of the matched item is
- *             returned.
+ *             one of the comma-separated items given.  The return value is
+ *             the index (zero-based) of the matched string in the list.
+ *
+ *             The flags control the behaviour if no exact match is found.
+ *             If @ENUM_ABBREV@ is set, and the current token is a left
+ *             substring of exactly one of the possibilities, then that one
+ *             is chosen.  If @ENUM_NONE@ is set, the value @-1@ is
+ *             returned; otherwise an error is reported and the program is
+ *             terminated.
  */
 
 #define ENUM_ABBREV 1u
@@ -259,17 +307,6 @@ extern int conf_prefix(scanner */*sc*/, const char */*p*/);
 
 extern void conf_name(scanner */*sc*/, char /*delim*/, dstr */*d*/);
 
-/* --- @conf_parse@ --- *
- *
- * Arguments:  @scanner *sc@ = pointer to a scanner structure
- *
- * Returns:    ---
- *
- * Use:                Parses a configuration file fragment from the scanner
- */
-
-extern void conf_parse(scanner *sc);
-
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus