M2compiler-V2/src/M2comp.mod

MODULE M2comp;
(* Driver for the M2comp Modula-2 compiler (Coco/R frontend).
   Generated <Grammar>S (scanner) + <Grammar>P (parser) do lexing,
   parsing, SymTab checking and AST building; on success the MGen
   tree-walking backend emits a single-module MC64 .MC4 image. *)

  FROM M2compS IMPORT lst, src, errors, Error, CharAt;
  FROM M2compP IMPORT Parse, Successful;
  IMPORT
    Strings, Storage, SYSTEM, FileIO, AST, MGen;

  TYPE
    INT32 = FileIO.INT32 (* 32 bit integers needed *);

  MODULE ListHandler;
  (* ------------------- Source Listing and Error handler -------------- *)
    FROM FileIO IMPORT CR, LF, EOF, WriteString, Write, WriteLn, WriteInt, Long0;
    FROM Storage IMPORT ALLOCATE;
    FROM SYSTEM IMPORT TSIZE;
    IMPORT lst, CharAt, errors, INT32;
    EXPORT StoreError, PrintListing;

    TYPE
      Err = POINTER TO ErrDesc;
      ErrDesc = RECORD
        nr, line, col: INTEGER;
        next: Err
      END;

    CONST
      tab = 11C;

    VAR
      firstErr, lastErr: Err;
      Extra: INTEGER;

    PROCEDURE StoreError (nr, line, col: INTEGER; pos: INT32);
    (* Store an error message for later printing *)
      VAR
        nextErr: Err;
      BEGIN
        ALLOCATE(nextErr, TSIZE(ErrDesc));
        nextErr^.nr := nr; nextErr^.line := line; nextErr^.col := col;
        nextErr^.next := NIL;
        IF firstErr = NIL
          THEN firstErr := nextErr
          ELSE lastErr^.next := nextErr
        END;
        lastErr := nextErr;
        INC(errors)
      END StoreError;

    PROCEDURE GetLine (VAR pos: INT32;
                       VAR line: ARRAY OF CHAR;
                       VAR eof: BOOLEAN);
    (* Read a source line. Return empty line if eof *)
      VAR
        ch: CHAR;
        i: CARDINAL;
      BEGIN
        i := 0; eof := FALSE; ch := CharAt(pos); INC(pos);
        WHILE (ch # CR) & (ch # LF) & (ch # EOF) DO
          line[i] := ch; INC(i); ch := CharAt(pos); INC(pos);
        END;
        eof := (i = 0) & (ch = EOF); line[i] := 0C;
        IF ch = CR THEN (* check for MsDos *)
          ch := CharAt(pos);
          IF ch = LF THEN INC(pos); Extra := 0 END
        END
      END GetLine;

    PROCEDURE PrintErr (line: ARRAY OF CHAR; nr, col: INTEGER);
    (* Print an error message *)

      PROCEDURE Msg (s: ARRAY OF CHAR);
        BEGIN
          WriteString(lst, s)
        END Msg;

      PROCEDURE Pointer;
        VAR
          i: INTEGER;
        BEGIN
          WriteString(lst, "*****  ");
          i := 0;
          WHILE i < col + Extra - 2 DO
            IF line[i] = tab
              THEN Write(lst, tab)
              ELSE Write(lst, ' ')
            END;
            INC(i)
          END;
          WriteString(lst, "^ ")
        END Pointer;

      BEGIN
        Pointer;
        CASE nr OF
           0: Msg("EOF expected")
        |  1: Msg("ident expected")
        |  2: Msg("integer expected")
        |  3: Msg("real expected")
        |  4: Msg("string expected")
        |  5: Msg("'.' expected")
        |  6: Msg("'MODULE' expected")
        |  7: Msg("';' expected")
        |  8: Msg("'FROM' expected")
        |  9: Msg("'IMPORT' expected")
        | 10: Msg("',' expected")
        | 11: Msg("'BEGIN' expected")
        | 12: Msg("'END' expected")
        | 13: Msg("'CONST' expected")
        | 14: Msg("'TYPE' expected")
        | 15: Msg("'VAR' expected")
        | 16: Msg("'=' expected")
        | 17: Msg("':' expected")
        | 18: Msg("'PROCEDURE' expected")
        | 19: Msg("'(' expected")
        | 20: Msg("')' expected")
        | 21: Msg("'[' expected")
        | 22: Msg("']' expected")
        | 23: Msg("'EXPORT' expected")
        | 24: Msg("'QUALIFIED' expected")
        | 25: Msg("'ARRAY' expected")
        | 26: Msg("'OF' expected")
        | 27: Msg("'RECORD' expected")
        | 28: Msg("'SET' expected")
        | 29: Msg("'POINTER' expected")
        | 30: Msg("'TO' expected")
        | 31: Msg("'..' expected")
        | 32: Msg("'EXIT' expected")
        | 33: Msg("':=' expected")
        | 34: Msg("'^' expected")
        | 35: Msg("'IF' expected")
        | 36: Msg("'THEN' expected")
        | 37: Msg("'ELSIF' expected")
        | 38: Msg("'ELSE' expected")
        | 39: Msg("'WHILE' expected")
        | 40: Msg("'DO' expected")
        | 41: Msg("'REPEAT' expected")
        | 42: Msg("'UNTIL' expected")
        | 43: Msg("'LOOP' expected")
        | 44: Msg("'FOR' expected")
        | 45: Msg("'BY' expected")
        | 46: Msg("'RETURN' expected")
        | 47: Msg("'#' expected")
        | 48: Msg("'<>' expected")
        | 49: Msg("'<' expected")
        | 50: Msg("'<=' expected")
        | 51: Msg("'>' expected")
        | 52: Msg("'>=' expected")
        | 53: Msg("'IN' expected")
        | 54: Msg("'+' expected")
        | 55: Msg("'-' expected")
        | 56: Msg("'OR' expected")
        | 57: Msg("'*' expected")
        | 58: Msg("'/' expected")
        | 59: Msg("'DIV' expected")
        | 60: Msg("'MOD' expected")
        | 61: Msg("'AND' expected")
        | 62: Msg("'NOT' expected")
        | 63: Msg("not expected")
        | 64: Msg("invalid MulOp")
        | 65: Msg("invalid AddOp")
        | 66: Msg("invalid Fact")
        | 67: Msg("invalid Relation")
        | 68: Msg("invalid SimExpr")
        | 69: Msg("invalid AssignOrCall")
        | 70: Msg("invalid IndexType")
        | 71: Msg("invalid BoundedBase")
        | 72: Msg("invalid Type")
        | 73: Msg("invalid Declaration")
        
        (* add customized cases here *)
        | 200: Msg("duplicate identifier")
        | 201: Msg("undeclared identifier")
        | 202: Msg("module/procedure name mismatch")
        | 210: Msg("incompatible assignment")
        | 211: Msg("arithmetic operand must be numeric")
        | 212: Msg("boolean operand required")
        | 213: Msg("incompatible comparison")
        | 214: Msg("BOOLEAN condition required")
        | 215: Msg("not a RECORD type")
        | 216: Msg("unknown field")
        | 217: Msg("not an ARRAY type")
        | 218: Msg("array index must be integer")
        | 219: Msg("not a POINTER type")
        | 220: Msg("FOR needs integer variable and bounds")
        | 221: Msg("not a type name")
        | 222: Msg("set operand mismatch")
        | 223: Msg("cyclical type definition")
        | 224: Msg("ordinal type required")
        | 230: Msg("not supported in this phase")
        | 231: Msg("procedure forward mismatch or missing body")
        | 232: Msg("bad RETURN")
        | 233: Msg("invalid procedure call")
        ELSE         Msg("Error: "); WriteInt(lst, nr, 0);
        END;
        WriteLn(lst)
      END PrintErr;

    PROCEDURE PrintListing;
    (* Print a source listing with error messages *)
      VAR
        nextErr: Err;
        eof: BOOLEAN;
        lnr, errC: INTEGER;
        srcPos: INT32;
        line: ARRAY [0 .. 255] OF CHAR;
      BEGIN
        WriteString(lst, "Listing:");
        WriteLn(lst); WriteLn(lst);
        srcPos := 0; nextErr := firstErr;
        GetLine(srcPos, line, eof); lnr := 1; errC := 0;
        WHILE ~ eof DO
          WriteInt(lst, lnr, 5); WriteString(lst, "  ");
          WriteString(lst, line); WriteLn(lst);
          WHILE (nextErr # NIL) & (nextErr^.line = lnr) DO
            PrintErr(line, nextErr^.nr, nextErr^.col); INC(errC);
            nextErr := nextErr^.next
          END;
          GetLine(srcPos, line, eof); INC(lnr);
        END;
        IF nextErr # NIL THEN
          WriteInt(lst, lnr, 5); WriteLn(lst);
          WHILE nextErr # NIL DO
            PrintErr(line, nextErr^.nr, nextErr^.col); INC(errC);
            nextErr := nextErr^.next
          END
        END;
        WriteLn(lst);
        WriteInt(lst, errC, 5); WriteString(lst, " error");
        IF errC # 1 THEN Write(lst, 's') END;
        WriteLn(lst); WriteLn(lst); WriteLn(lst);
      END PrintListing;

    BEGIN
      firstErr := NIL; Extra := 1;
    END ListHandler;

  (* --------------------------- main module ------------------------------- *)

  PROCEDURE ChangeExtension (oldName, Ext: ARRAY OF CHAR;
                             VAR newName: ARRAY OF CHAR);
  (* Constructs newName by replacing the extension of oldName with Ext. *)
    VAR
      i, l: CARDINAL;
    BEGIN
      Strings.Assign(oldName, newName);
      i := LENGTH(oldName); l := i;
      WHILE (i > 0) & (oldName[i -1] # '.')
            & (oldName[i -1] # '\') & (oldName[i -1] # '/') DO
        DEC(i)
      END;
      IF (i > 0) & (oldName[i-1] = '.') THEN
        Strings.Delete(newName, i - 1, l + 1 - i)
      END;
      IF Ext[0] = '.' THEN Strings.Delete(Ext, 0, 1) END;
      Strings.Append(".", newName);
      Strings.Append(Ext, newName)
    END ChangeExtension;

  VAR
    sourceName, listName: ARRAY [0 .. 255] OF CHAR;
    failed: BOOLEAN;
    emitOk: BOOLEAN;

  BEGIN
    (* check on correct parameter usage *)
    FileIO.NextParameter(sourceName);
    IF sourceName[0] = 0C THEN
      FileIO.WriteString(FileIO.StdOut, "No input file specified");
      HALT
    END;

    (* step 1: syntax only, no symbol table yet (see M2comp.atg) *)

    (* install error reporting procedure - Scanner.Error *)
    Error := StoreError;

    failed := FALSE;
    LOOP
      IF sourceName[0] = 0C THEN EXIT END;

      (* open the source file - Scanner.src *)
      FileIO.Open(src, sourceName, FALSE);
      IF ~ FileIO.Okay THEN
        FileIO.WriteString(FileIO.StdOut, "Could not open input file");
        FileIO.WriteLn(FileIO.StdOut);
        HALT
      END;

      (* open the output file for the source listing - Scanner.lst *)
      ChangeExtension(sourceName, ".LST", listName);
      FileIO.Open(lst, listName, TRUE);
      IF ~ FileIO.Okay THEN
        FileIO.WriteString(FileIO.StdOut, "Could not open listing file");
        FileIO.WriteLn(FileIO.StdOut);
        (* default Scanner.lst to screen *) lst := FileIO.StdOut;
      END;

      (* instigate the compilation - Parser.Parse *)
      FileIO.WriteString(FileIO.StdOut, "Parsing ");
      FileIO.WriteString(FileIO.StdOut, sourceName);
      FileIO.WriteLn(FileIO.StdOut);
      Parse;

      (* backend: emit the MC64 image while errors still reach
         the listing below *)
      IF Successful() THEN
        emitOk := MGen.EmitModule(AST.GetRoot())
      ELSE emitOk := FALSE
      END;

      (* generate the source listing on lst file *)
      PrintListing;
      IF lst # FileIO.StdOut THEN FileIO.Close(lst) END;

      (* fail fast: later files build on this one's tables *)
      IF NOT (Successful() & emitOk)
        THEN
          FileIO.WriteString(FileIO.StdOut, "Incorrect source");
          FileIO.WriteLn(FileIO.StdOut);
          failed := TRUE;
          EXIT
      END;

      FileIO.NextParameter(sourceName);
    END;

    (* examine the outcome *)
    IF NOT failed THEN
      FileIO.WriteString(FileIO.StdOut, "Parsed correctly");
    END;
  END M2comp.