gcc/m2/gm2-libs/M2EXCEPTION.def

   1 (* M2EXCEPTION.def enumerates all exceptions.
   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 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 3.1, as published by the Free Software Foundation.
  21
  22 You should have received a copy of the GNU General Public License and
  23 a copy of the GCC Runtime Library Exception along with this program;
  24 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  25 <http://www.gnu.org/licenses/>.  *)
  26
  27 DEFINITION MODULE M2EXCEPTION;
  28
  29
  30 (* This enumerated list of exceptions must match the exceptions in gm2-libs-iso to
  31    allow mixed module dialect projects.  *)
  32
  33 TYPE
  34   M2Exceptions =
  35     (indexException,     rangeException,         caseSelectException,  invalidLocation,
  36      functionException,  wholeValueException,    wholeDivException,    realValueException,
  37      realDivException,   complexValueException,  complexDivException,  protException,
  38      sysException,       coException,            exException
  39     );
  40
  41
  42 (* If the program or coroutine is in the exception state then return the enumeration
  43    value representing the exception cause.  If it is not in the exception state then
  44    raises and exception (exException).  *)
  45
  46 PROCEDURE M2Exception () : M2Exceptions;
  47
  48 (* Returns TRUE if the program or coroutine is in the exception state.
  49    Returns FALSE if the program or coroutine is not in the exception state.  *)
  50
  51 PROCEDURE IsM2Exception () : BOOLEAN;
  52
  53
  54 END M2EXCEPTION.