gcc/m2/gm2-libs/Debug.mod

   1 (* Debug.mod provides some simple debugging routines.
   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 IMPLEMENTATION MODULE Debug ;
  28
  29 FROM ASCII IMPORT cr, nul, lf ;
  30 FROM NumberIO IMPORT CardToStr ;
  31 FROM StdIO IMPORT Write ;
  32 FROM libc IMPORT exit ;
  33
  34
  35 (*
  36    Halt - writes a message in the format:
  37           Module:Function:Line:Message
  38
  39           It then terminates by calling HALT.
  40 *)
  41
  42 PROCEDURE Halt (Message,
  43                 Module,
  44                 Function: ARRAY OF CHAR ;
  45                 LineNo  : CARDINAL) ;
  46 CONST
  47    MaxNoOfDigits = 12 ;  (* should be large enough for most source files.. *)
  48 VAR
  49    No               : ARRAY [0..MaxNoOfDigits] OF CHAR ;
  50 BEGIN
  51    DebugString(Module) ;
  52    DebugString(':') ;
  53    DebugString(Function) ;
  54    DebugString(':') ;
  55    CardToStr(LineNo, 0, No) ;
  56    DebugString(':') ;
  57    DebugString(No) ;
  58    DebugString(':') ;
  59    DebugString(Message) ;
  60    DebugString('\n') ;
  61    HALT
  62 END Halt ;
  63
  64
  65 (*
  66    DebugString - writes a string to the debugging device (Scn.Write).
  67                  It interprets \n as carriage return, linefeed.
  68 *)
  69
  70 PROCEDURE DebugString (a: ARRAY OF CHAR) ;
  71 VAR
  72    n, high: CARDINAL ;
  73 BEGIN
  74    high := HIGH( a ) ;
  75    n := 0 ;
  76    WHILE (n <= high) AND (a[n] # nul) DO
  77       IF a[n]='\'
  78       THEN
  79          IF n+1<=high
  80          THEN
  81             IF a[n+1]='n'
  82             THEN
  83                WriteLn ;
  84                INC(n)
  85             ELSIF a[n+1]='\'
  86             THEN
  87                Write('\') ;
  88                INC(n)
  89             END
  90          END
  91       ELSE
  92          Write( a[n] )
  93       END ;
  94       INC( n )
  95    END
  96 END DebugString ;
  97
  98
  99 (*
 100    WriteLn - writes a carriage return and a newline
 101              character.
 102 *)
 103
 104 PROCEDURE WriteLn ;
 105 BEGIN
 106    Write(cr) ;
 107    Write(lf)
 108 END WriteLn ;
 109
 110
 111 END Debug.