gcc/m2/gm2-compiler/m2flex.def

   1 (* m2flex.def provides access to the C lexical implemenation m2.flex.
   2
   3 Copyright (C) 2001-2024 Free Software Foundation, Inc.
   4 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   5
   6 This file is part of GNU Modula-2.
   7
   8 GNU Modula-2 is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GNU Modula-2 is distributed in the hope that it will be useful, but
  14 WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU Modula-2; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  *)
  21
  22 DEFINITION MODULE m2flex ;
  23
  24 (*
  25     Title      : m2flex
  26     Author     : Gaius Mulley
  27     System     : UNIX (GNU Modula-2)
  28     Date       : Tue Jul 31 17:46:41 2001
  29     Last edit  : $Date: 2013/02/11 14:45:17 $
  30     Revision   : $Version$
  31     Description: provides a Modula-2 definition module for the C lexical
  32                  analysis flex file m2.flex
  33 *)
  34
  35 FROM SYSTEM IMPORT ADDRESS ;
  36 FROM m2linemap IMPORT location_t ;
  37
  38 EXPORT QUALIFIED GetToken, M2Error, OpenSource, CloseSource, GetLineNo,
  39                  GetColumnNo, GetLocation, GetTotalLines ;
  40
  41
  42 (*
  43    CloseSource - provided for semantic sugar
  44 *)
  45
  46 PROCEDURE CloseSource ;
  47
  48
  49 (*
  50    OpenSource - returns TRUE if file, s, can be opened and
  51                 all tokens are taken from this file.
  52 *)
  53
  54 PROCEDURE OpenSource (s: ADDRESS) : BOOLEAN ;
  55
  56
  57 (*
  58    GetToken - returns the ADDRESS of the next token and advances to
  59               the next token.
  60 *)
  61
  62 PROCEDURE GetToken () : [ ADDRESS ] ;
  63
  64
  65 (*
  66    GetLineNo - returns the current line number.
  67 *)
  68
  69 PROCEDURE GetLineNo () : CARDINAL ;
  70
  71
  72 (*
  73    GetColumnNo - returns the column where the current token starts.
  74 *)
  75
  76 PROCEDURE GetColumnNo () : CARDINAL ;
  77
  78
  79 (*
  80    GetLocation - returns the gcc location_t of the current token.
  81 *)
  82
  83 PROCEDURE GetLocation () : location_t ;
  84
  85
  86 (*
  87    M2Error - displays the error message, s, after the code line and pointer
  88              to the erroneous token.
  89 *)
  90
  91 PROCEDURE M2Error (s: ADDRESS) ;
  92
  93
  94 (*
  95    GetTotalLines - returns the total number of lines parsed.
  96 *)
  97
  98 PROCEDURE GetTotalLines () : CARDINAL ;
  99
 100
 101 END m2flex.