X-Git-Url: https://git.distorted.org.uk/~mdw/fwd/blobdiff_plain/e73034b0d2191f00a8b00f38383843ea8858c576..a9bd543ab4ebe415bca9d6f27b90f16ddac79bc0:/conf.h

diff --git a/conf.h b/conf.h
index e0eddf8..99cce31 100644
--- a/conf.h
+++ b/conf.h
@@ -1,13 +1,11 @@
 /* -*-c-*-
  *
- * $Id: conf.h,v 1.4 1999/08/19 18:32:48 mdw Exp $
- *
  * Configuration parsing
  *
  * (c) 1999 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of the `fw' port forwarder.
  *
@@ -15,36 +13,17 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * `fw' is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with `fw'; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: conf.h,v $
- * 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'.
- *
- * Revision 1.2  1999/07/26 23:28:39  mdw
- * Major reconstruction work for new design.
- *
- * Revision 1.1.1.1  1999/07/01 08:56:23  mdw
- * Initial revision.
- *
- */
-
 #ifndef CONF_H
 #define CONF_H
 
@@ -67,9 +46,10 @@
 
 /*----- Functions provided ------------------------------------------------*/
 
-/* --- @undelim@ --- *
+/* --- @conf_undelim@ --- *
  *
- * Arguments:	@const char *d, dd@ = pointer to characters to escape
+ * Arguments:	@scanner *sc@ = pointer to scanner definition
+ *		@const char *d, *dd@ = pointer to characters to escape
  *
  * Returns:	---
  *
@@ -78,7 +58,8 @@
  *		second list will always be allowed to continue a word.
  */
 
-extern void undelim(const char */*d*/, const char */*dd*/);
+extern void conf_undelim(scanner */*sc*/,
+			 const char */*d*/, const char */*dd*/);
 
 /* --- @token@ --- *
  *
@@ -104,6 +85,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
@@ -114,9 +107,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
@@ -201,7 +200,7 @@ extern int conf_prefix(scanner */*sc*/, const char */*p*/);
      * because the option wasn't accepted.				\
      */									\
 									\
-     goto _conf_reject;							\
+    goto _conf_reject;							\
   _conf_reject:								\
     if (_conf_state == CS_PLAIN)					\
       _conf_state = CS_UNKNOWN;						\
@@ -276,17 +275,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