chiark - git - mdw - become/blob - src/lexer.h

   1 /* -*-c-*-
   2  *
   3  * $Id: lexer.h,v 1.4 2004/04/08 01:36:20 mdw Exp $
   4  *
   5  * Lexical analyser for `become.conf' files
   6  *
   7  * (c) 1998 EBI
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of `become'
  13  *
  14  * `Become' is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * `Become' 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 General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with `become'; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef LEXER_H
  30 #define LEXER_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Required headers --------------------------------------------------*/
  37
  38 #include <stdio.h>
  39
  40 /*----- Global variables --------------------------------------------------*/
  41
  42 extern int lex_line;                    /* Current line number */
  43
  44 /*----- Functions provided ------------------------------------------------*/
  45
  46 /* --- @yylex@ --- *
  47  *
  48  * Arguments:   ---
  49  *
  50  * Returns:     The next token, or zero for EOF.
  51  *
  52  * Use:         Scans the input file.
  53  */
  54
  55 extern int yylex(void);
  56
  57 /* --- @lexer_scan@ --- *
  58  *
  59  * Arguments:   @FILE *fp@ = pointer to a stream object to scan
  60  *
  61  * Returns:     ---
  62  *
  63  * Use:         Initialises the scanner ready to parse from the given
  64  *              stream.
  65  */
  66
  67 extern void lexer_scan(FILE */*fp*/);
  68
  69 /*----- That's all, folks -------------------------------------------------*/
  70
  71 #ifdef __cplusplus
  72   }
  73 #endif
  74
  75 #endif