gcc/m2/mc/mcflex.def

   1 (* mcflex.def provides a Modula-2 definition module for the C lexical.
   2
   3 Copyright (C) 2015-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 mcflex ;
  23
  24 FROM SYSTEM IMPORT ADDRESS ;
  25
  26
  27 (*
  28    closeSource - provided for semantic sugar
  29 *)
  30
  31 PROCEDURE closeSource ;
  32
  33
  34 (*
  35    OpenSource - returns TRUE if file, s, can be opened and
  36                 all tokens are taken from this file.
  37 *)
  38
  39 PROCEDURE openSource (s: ADDRESS) : BOOLEAN ;
  40
  41
  42 (*
  43    getToken - returns the ADDRESS of the next token.
  44 *)
  45
  46 PROCEDURE getToken () : ADDRESS ;
  47
  48
  49 (*
  50    getLineNo - returns the current line number.
  51 *)
  52
  53 PROCEDURE getLineNo () : CARDINAL ;
  54
  55
  56 (*
  57    getColumnNo - returns the column where the current token starts.
  58 *)
  59
  60 PROCEDURE getColumnNo () : CARDINAL ;
  61
  62
  63 (*
  64    mcError - displays the error message, s, after the code line and pointer
  65              to the erroneous token.
  66 *)
  67
  68 PROCEDURE mcError (s: ADDRESS) ;
  69
  70
  71 (*
  72    getTotalLines - returns the total number of lines parsed.
  73 *)
  74
  75 PROCEDURE getTotalLines () : CARDINAL ;
  76
  77
  78 END mcflex.