Generalized way to show source located errors (parse and runtime errors)

aNNiMON · aNNiMON · commit 02e9d1f6c5a7 · 2024-01-12T20:52:30.000+01:00
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/Console.java b/ownlang-core/src/main/java/com/annimon/ownlang/Console.java
@@ -3,10 +3,15 @@
 import com.annimon.ownlang.lib.CallStack;
 import com.annimon.ownlang.outputsettings.ConsoleOutputSettings;
 import com.annimon.ownlang.outputsettings.OutputSettings;
+import com.annimon.ownlang.stages.StagesData;
+import com.annimon.ownlang.util.ErrorsLocationFormatterStage;
+import com.annimon.ownlang.util.ExceptionConverterStage;
+import com.annimon.ownlang.util.ExceptionStackTraceToStringStage;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.PrintStream;
 import java.nio.charset.StandardCharsets;
+import java.util.List;
 
 public class Console {
 
@@ -58,6 +63,17 @@ public static void error(CharSequence value) {
         outputSettings.error(value);
     }
 
+    public static void handleException(StagesData stagesData, Thread thread, Exception exception) {
+        String mainError = new ExceptionConverterStage()
+                .then((data, error) -> List.of(error))
+                .then(new ErrorsLocationFormatterStage())
+                .perform(stagesData, exception);
+        String callStack = CallStack.getFormattedCalls();
+        String stackTrace = new ExceptionStackTraceToStringStage()
+                .perform(stagesData, exception);
+        error(String.join("\n", mainError, "Thread: " + thread.getName(), callStack, stackTrace));
+    }
+
     public static void handleException(Thread thread, Throwable throwable) {
         final ByteArrayOutputStream baos = new ByteArrayOutputStream();
         try(final PrintStream ps = new PrintStream(baos)) {
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/exceptions/OwnLangRuntimeException.java b/ownlang-core/src/main/java/com/annimon/ownlang/exceptions/OwnLangRuntimeException.java
@@ -1,19 +1,36 @@
 package com.annimon.ownlang.exceptions;
 
+import com.annimon.ownlang.util.Range;
+import com.annimon.ownlang.util.SourceLocatedError;
+
 /**
  * Base type for all runtime exceptions
  */
-public class OwnLangRuntimeException extends RuntimeException {
+public class OwnLangRuntimeException extends RuntimeException implements SourceLocatedError {
+
+    private final Range range;
 
     public OwnLangRuntimeException() {
         super();
+        this.range = null;
     }
 
     public OwnLangRuntimeException(String message) {
+        this(message, (Range) null);
+    }
+
+    public OwnLangRuntimeException(String message, Range range) {
         super(message);
+        this.range = range;
     }
 
     public OwnLangRuntimeException(String message, Throwable ex) {
         super(message, ex);
+        this.range = null;
+    }
+
+    @Override
+    public Range getRange() {
+        return range;
     }
 }
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/lib/CallStack.java b/ownlang-core/src/main/java/com/annimon/ownlang/lib/CallStack.java
@@ -1,7 +1,9 @@
 package com.annimon.ownlang.lib;
 
+import com.annimon.ownlang.util.Range;
 import java.util.Deque;
 import java.util.concurrent.ConcurrentLinkedDeque;
+import java.util.stream.Collectors;
 
 public final class CallStack {
     
@@ -13,7 +15,7 @@ public static synchronized void clear() {
         calls.clear();
     }
     
-    public static synchronized void enter(String name, Function function, String position) {
+    public static synchronized void enter(String name, Function function, Range range) {
         String func = function.toString();
         if (func.contains("com.annimon.ownlang.modules")) {
             func = func.replaceAll(
@@ -22,7 +24,7 @@ public static synchronized void enter(String name, Function function, String pos
         if (func.contains("\n")) {
             func = func.substring(0, func.indexOf("\n")).trim();
         }
-        calls.push(new CallInfo(name, func, position));
+        calls.push(new CallInfo(name, func, range));
     }
     
     public static synchronized void exit() {
@@ -32,14 +34,24 @@ public static synchronized void exit() {
     public static synchronized Deque<CallInfo> getCalls() {
         return calls;
     }
+
+    public static String getFormattedCalls() {
+        return calls.stream()
+                .map(CallInfo::format)
+                .collect(Collectors.joining("\n"));
+    }
     
-    public record CallInfo(String name, String function, String position) {
+    public record CallInfo(String name, String function, Range range) {
+        String format() {
+            return "\tat " + this;
+        }
+
         @Override
         public String toString() {
-            if (position == null) {
+            if (range == null) {
                 return String.format("%s: %s", name, function);
             } else {
-                return String.format("%s: %s %s", name, function, position);
+                return String.format("%s: %s %s", name, function, range.format());
             }
         }
     }
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/ErrorsLocationFormatterStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/ErrorsLocationFormatterStage.java
@@ -0,0 +1,55 @@
+package com.annimon.ownlang.util;
+
+import com.annimon.ownlang.Console;
+import com.annimon.ownlang.stages.Stage;
+import com.annimon.ownlang.stages.StagesData;
+
+public class ErrorsLocationFormatterStage implements Stage<Iterable<? extends SourceLocatedError>, String> {
+
+    @Override
+    public String perform(StagesData stagesData, Iterable<? extends SourceLocatedError> input) {
+        final var sb = new StringBuilder();
+        final String source = stagesData.get(SourceLoaderStage.TAG_SOURCE);
+        final var lines = source.split("\r?\n");
+        for (SourceLocatedError error : input) {
+            sb.append(Console.newline());
+            sb.append(error);
+            sb.append(Console.newline());
+            final Range range = error.getRange();
+            if (range != null) {
+                printPosition(sb, range.normalize(), lines);
+            }
+        }
+        return sb.toString();
+    }
+
+    private static void printPosition(StringBuilder sb, Range range, String[] lines) {
+        final Pos start = range.start();
+        final int linesCount = lines.length;;
+        if (range.isOnSameLine()) {
+            if (start.row() < linesCount) {
+                sb.append(lines[start.row()]);
+                sb.append(Console.newline());
+                sb.append(" ".repeat(start.col()));
+                sb.append("^".repeat(range.end().col() - start.col() + 1));
+                sb.append(Console.newline());
+            }
+        } else {
+            if (start.row() < linesCount) {
+                String line = lines[start.row()];
+                sb.append(line);
+                sb.append(Console.newline());
+                sb.append(" ".repeat(start.col()));
+                sb.append("^".repeat(Math.max(1, line.length() - start.col())));
+                sb.append(Console.newline());
+            }
+            final Pos end = range.end();
+            if (end.row() < linesCount) {
+                sb.append(lines[end.row()]);
+                sb.append(Console.newline());
+                sb.append("^".repeat(end.col()));
+                sb.append(Console.newline());
+            }
+        }
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/ErrorsStackTraceFormatterStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/ErrorsStackTraceFormatterStage.java
@@ -0,0 +1,20 @@
+package com.annimon.ownlang.util;
+
+import com.annimon.ownlang.Console;
+import com.annimon.ownlang.stages.Stage;
+import com.annimon.ownlang.stages.StagesData;
+
+public class ErrorsStackTraceFormatterStage implements Stage<Iterable<? extends SourceLocatedError>, String> {
+
+    @Override
+    public String perform(StagesData stagesData, Iterable<? extends SourceLocatedError> input) {
+        final var sb = new StringBuilder();
+        for (SourceLocatedError error : input) {
+            if (!error.hasStackTrace()) continue;
+            for (StackTraceElement el : error.getStackTrace()) {
+                sb.append("\t").append(el).append(Console.newline());
+            }
+        }
+        return sb.toString();
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/ExceptionConverterStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/ExceptionConverterStage.java
@@ -0,0 +1,12 @@
+package com.annimon.ownlang.util;
+
+import com.annimon.ownlang.stages.Stage;
+import com.annimon.ownlang.stages.StagesData;
+
+public class ExceptionConverterStage implements Stage<Exception, SourceLocatedError> {
+    @Override
+    public SourceLocatedError perform(StagesData stagesData, Exception ex) {
+        if (ex instanceof SourceLocatedError sle) return sle;
+        return new SimpleError(ex.getMessage());
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/ExceptionStackTraceToStringStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/ExceptionStackTraceToStringStage.java
@@ -0,0 +1,20 @@
+package com.annimon.ownlang.util;
+
+import com.annimon.ownlang.stages.Stage;
+import com.annimon.ownlang.stages.StagesData;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+public class ExceptionStackTraceToStringStage implements Stage<Exception, String> {
+    @Override
+    public String perform(StagesData stagesData, Exception ex) {
+        final var baos = new ByteArrayOutputStream();
+        try (final PrintStream ps = new PrintStream(baos)) {
+            for (StackTraceElement traceElement : ex.getStackTrace()) {
+                ps.println("\tat " + traceElement);
+            }
+        }
+        return baos.toString(StandardCharsets.UTF_8);
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/SimpleError.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/SimpleError.java
@@ -0,0 +1,13 @@
+package com.annimon.ownlang.util;
+
+public record SimpleError(String message) implements SourceLocatedError {
+    @Override
+    public String getMessage() {
+        return message;
+    }
+
+    @Override
+    public String toString() {
+        return message;
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLoaderStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLoaderStage.java
@@ -0,0 +1,48 @@
+package com.annimon.ownlang.util;
+
+import com.annimon.ownlang.exceptions.OwnLangRuntimeException;
+import com.annimon.ownlang.stages.Stage;
+import com.annimon.ownlang.stages.StagesData;
+import java.io.ByteArrayOutputStream;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+
+public class SourceLoaderStage implements Stage<String, String> {
+
+    public static final String TAG_SOURCE = "source";
+
+    @Override
+    public String perform(StagesData stagesData, String name) {
+        try {
+            String result = readSource(name);
+            stagesData.put(TAG_SOURCE, result);
+            return result;
+        } catch (IOException e) {
+            throw new OwnLangRuntimeException("Unable to read input " + name, e);
+        }
+    }
+
+    private String readSource(String name) throws IOException {
+        try (InputStream is = getClass().getResourceAsStream("/" + name)) {
+            if (is != null) {
+                return readStream(is);
+            }
+        }
+        try (InputStream is = new FileInputStream(name)) {
+            return readStream(is);
+        }
+    }
+
+    public static String readStream(InputStream is) throws IOException {
+        final ByteArrayOutputStream result = new ByteArrayOutputStream();
+        final int bufferSize = 1024;
+        final byte[] buffer = new byte[bufferSize];
+        int read;
+        while ((read = is.read(buffer)) != -1) {
+            result.write(buffer, 0, read);
+        }
+        return result.toString(StandardCharsets.UTF_8);
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocatedError.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocatedError.java
@@ -0,0 +1,19 @@
+package com.annimon.ownlang.util;
+
+public interface SourceLocatedError extends SourceLocation {
+
+    String getMessage();
+
+    default StackTraceElement[] getStackTrace() {
+        return new StackTraceElement[0];
+    }
+
+    default boolean hasStackTrace() {
+        return !stackTraceIsEmpty();
+    }
+
+    private boolean stackTraceIsEmpty() {
+        final var st = getStackTrace();
+        return st == null || st.length == 0;
+    }
+}
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocation.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocation.java
@@ -5,9 +5,4 @@ public interface SourceLocation {
     default Range getRange() {
         return null;
     }
-
-    default String formatRange() {
-        final var range = getRange();
-        return range == null ? "" : range.format();
-    }
 }
diff --git a/ownlang-desktop/src/main/java/com/annimon/ownlang/Main.java b/ownlang-desktop/src/main/java/com/annimon/ownlang/Main.java
@@ -2,7 +2,9 @@
 
 import com.annimon.ownlang.exceptions.OwnLangParserException;
 import com.annimon.ownlang.exceptions.StoppedException;
-import com.annimon.ownlang.parser.*;
+import com.annimon.ownlang.parser.Beautifier;
+import com.annimon.ownlang.parser.SourceLoader;
+import com.annimon.ownlang.parser.Token;
 import com.annimon.ownlang.parser.ast.Statement;
 import com.annimon.ownlang.parser.error.ParseErrorsFormatterStage;
 import com.annimon.ownlang.parser.linters.LinterStage;
@@ -163,7 +165,7 @@ private static void run(String input, RunOptions options) {
         } catch (StoppedException ex) {
             // skip
         } catch (Exception ex) {
-            Console.handleException(Thread.currentThread(), ex);
+            Console.handleException(stagesData, Thread.currentThread(), ex);
         } finally {
             if (options.showTokens) {
                 final List<Token> tokens = stagesData.get(LexerStage.TAG_TOKENS);
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/Parser.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/Parser.java
@@ -81,7 +81,7 @@ public Statement parse() {
                 parseErrors.add(new ParseError(ex.getMessage(), ex.getRange()));
                 recover();
             } catch (Exception ex) {
-                parseErrors.add(new ParseError(ex.getMessage(), getRange(), List.of(ex.getStackTrace())));
+                parseErrors.add(new ParseError(ex.getMessage(), getRange(), ex.getStackTrace()));
                 recover();
             }
         }
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ast/FunctionalExpression.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ast/FunctionalExpression.java
@@ -51,7 +51,7 @@ public Value eval() {
             values[i] = arguments.get(i).eval();
         }
         final Function f = consumeFunction(functionExpr);
-        CallStack.enter(functionExpr.toString(), f, formatRange());
+        CallStack.enter(functionExpr.toString(), f, range);
         final Value result = f.execute(values);
         CallStack.exit();
         return result;
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/error/ParseError.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/error/ParseError.java
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/error/ParseErrorsFormatterStage.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/error/ParseErrorsFormatterStage.java
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/stages/SourceLoaderStage.java b/ownlang-parser/src/main/java/com/annimon/ownlang/stages/SourceLoaderStage.java
diff --git a/ownlang-parser/src/test/java/com/annimon/ownlang/parser/ProgramsTest.java b/ownlang-parser/src/test/java/com/annimon/ownlang/parser/ProgramsTest.java
diff --git a/ownlang-utils/src/main/java/com/annimon/ownlang/utils/Sandbox.java b/ownlang-utils/src/main/java/com/annimon/ownlang/utils/Sandbox.java
