(* mcflex.def provides a Modula-2 definition module for the C lexical.

Copyright (C) 2015-2024 Free Software Foundation, Inc.
Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.

This file is part of GNU Modula-2.

GNU Modula-2 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.

GNU Modula-2 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 GNU Modula-2; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  *)

DEFINITION MODULE mcflex ;

FROM SYSTEM IMPORT ADDRESS ;


(*
   closeSource - provided for semantic sugar
*)

PROCEDURE closeSource ;


(*
   OpenSource - returns TRUE if file, s, can be opened and
                all tokens are taken from this file.
*)

PROCEDURE openSource (s: ADDRESS) : BOOLEAN ;


(*
   getToken - returns the ADDRESS of the next token.
*)

PROCEDURE getToken () : ADDRESS ;


(*
   getLineNo - returns the current line number.
*)

PROCEDURE getLineNo () : CARDINAL ;


(*
   getColumnNo - returns the column where the current token starts.
*)

PROCEDURE getColumnNo () : CARDINAL ;


(*
   mcError - displays the error message, s, after the code line and pointer
             to the erroneous token.
*)

PROCEDURE mcError (s: ADDRESS) ;


(*
   getTotalLines - returns the total number of lines parsed.
*)

PROCEDURE getTotalLines () : CARDINAL ;


END mcflex.