GH-548 Return Result<Application, Throwable> by Interpreter

Author: dzikoysk

panda-framework/src/main/java/org/panda_lang/language/Failure.java

@@ -16,13 +16,21 @@
 
 package org.panda_lang.language;
 
+import org.panda_lang.language.interpreter.source.IndicatedSource;
 import org.panda_lang.utilities.commons.function.Option;
 
 /**
  * Represents errors occurred in the framework
  */
 public interface Failure {
 
+    /**
+     * Get indicated source
+     *
+     * @return the indicated source
+     */
+    IndicatedSource getIndicatedSource();
+
     /**
      * Get additional information about the failure
      *

panda-framework/src/main/java/org/panda_lang/language/architecture/expression/ExpressionUtils.java

@@ -45,7 +45,6 @@ public static <T> T evaluateConstExpression(Expression expression) {
         try {
             return expression.evaluate(new PandaProcessStack(PROCESS, PandaRuntimeConstants.DEFAULT_STACK_SIZE), null);
         } catch (Exception e) {
-            e.printStackTrace();
             throw new PandaRuntimeException("Cannot evaluate static expression: " + expression, e);
         }
     }

panda-framework/src/main/java/org/panda_lang/language/architecture/module/PandaModule.java

@@ -27,7 +27,7 @@ public class PandaModule extends PandaModules implements Module {
 
     protected final String name;
     protected final TypesMap types;
-    protected @Nullable Module parent;
+    protected @Nullable final Module parent;
 
     public PandaModule(Module parent, String name) {
         this.name = name;

panda-framework/src/main/java/org/panda_lang/language/architecture/statement/StandardizedFramedScope.java

@@ -29,6 +29,6 @@ public interface StandardizedFramedScope extends FramedScope {
      *
      * @return instance of the frame
      */
-    Frame revive(ProcessStack stack, Object instance) throws Exception;
+    Frame revive(ProcessStack stack, Object instance);
 
 }   

panda-framework/src/main/java/org/panda_lang/language/architecture/type/TypeScope.java

@@ -49,9 +49,8 @@ public TypeInstance createInstance(ProcessStack stack, @Nullable Object instance
 
         try {
             typeInstance = getConstructor(parameterTypes).newInstance(ArrayUtils.merge(typeFrame, arguments, Object[]::new));
-        } catch (InvocationTargetException e) {
-            e.printStackTrace();
-            throw new PandaRuntimeException(e.getTargetException().getMessage(), e.getTargetException());
+        } catch (InvocationTargetException targetException) {
+            throw new PandaRuntimeException(targetException.getTargetException().getMessage(), targetException.getTargetException());
         }
 
         for (TypeField field : type.getFields().getDeclaredProperties()) {

panda-framework/src/main/java/org/panda_lang/language/architecture/type/dynamic/DynamicClassGenerator.java

@@ -49,7 +49,7 @@ final class DynamicClassGenerator {
 
     private final Type type;
     private final CtClass generatedStructure;
-    private boolean isInterface;
+    private final boolean isInterface;
 
     DynamicClassGenerator(Type type, CtClass generatedStructure) {
         this.type = type;

panda-framework/src/main/java/org/panda_lang/language/interpreter/Interpreter.java

@@ -19,6 +19,7 @@
 import org.panda_lang.language.architecture.Application;
 import org.panda_lang.language.architecture.Environment;
 import org.panda_lang.language.interpreter.source.Source;
+import org.panda_lang.utilities.commons.function.Result;
 
 /**
  * Translate source code into efficient intermediate representation and build an application
@@ -30,7 +31,7 @@ public interface Interpreter {
      *
      * @return interpreted application
      */
-    Application interpret(Source source);
+    Result<Application, Throwable> interpret(Source source);
 
     /**
      * Get associated environment

panda-framework/src/main/java/org/panda_lang/language/interpreter/InterpreterFailure.java

@@ -16,29 +16,37 @@
 
 package org.panda_lang.language.interpreter;
 
-import org.panda_lang.language.PandaFrameworkException;
+import org.jetbrains.annotations.Nullable;
 import org.panda_lang.language.Failure;
+import org.panda_lang.language.PandaFrameworkException;
 import org.panda_lang.language.interpreter.source.IndicatedSource;
+import org.panda_lang.utilities.commons.function.Option;
 
-/**
- * InterpreterFailures are dedicated exceptions thrown by the Panda Framework.
- * It contains extra data about the error and may be used to enhance logging/tooling.
- */
-public abstract class InterpreterFailure extends PandaFrameworkException implements Failure {
+public class InterpreterFailure extends PandaFrameworkException implements Failure {
 
-    protected InterpreterFailure(String message, Throwable cause) {
+    private final IndicatedSource indicatedSource;
+    private final String note;
+
+    public InterpreterFailure(IndicatedSource indicatedSource, String message, @Nullable String note) {
+        super(message);
+        this.indicatedSource = indicatedSource;
+        this.note = note;
+    }
+
+    public InterpreterFailure(Throwable cause, IndicatedSource indicatedSource, String message, String note) {
         super(message, cause);
+        this.indicatedSource = indicatedSource;
+        this.note = note;
     }
 
-    protected InterpreterFailure(String message) {
-        super(message);
+    @Override
+    public Option<String> getNote() {
+        return Option.of(note);
     }
 
-    /**
-     * Get indicated source
-     *
-     * @return the indicated source
-     */
-    public abstract IndicatedSource getIndicatedSource();
+    @Override
+    public IndicatedSource getIndicatedSource() {
+        return indicatedSource;
+    }
 
 }

panda-framework/src/main/java/org/panda_lang/language/interpreter/PandaInterpreterFailure.java

@@ -19,13 +19,13 @@
 import org.jetbrains.annotations.Nullable;
 import org.panda_lang.language.interpreter.source.Location;
 import org.panda_lang.language.interpreter.token.Snippetable;
-import org.panda_lang.language.interpreter.PandaInterpreterFailure;
+import org.panda_lang.language.interpreter.InterpreterFailure;
 import org.panda_lang.language.interpreter.source.PandaIndicatedSource;
 import org.panda_lang.language.interpreter.token.PandaToken;
 import org.panda_lang.language.interpreter.token.PandaTokenInfo;
 import org.panda_lang.language.resource.syntax.TokenTypes;
 
-public final class PandaLexerFailure extends PandaInterpreterFailure {
+public final class PandaLexerFailure extends InterpreterFailure {
 
     public PandaLexerFailure(Snippetable line, Snippetable indicated, String message, @Nullable String note) {
         super(new PandaIndicatedSource(line, indicated), message, note);

panda-framework/src/main/java/org/panda_lang/language/interpreter/lexer/PandaLexerFailure.java

@@ -27,12 +27,12 @@ public class Channel implements Comparable<Channel> {
 
     private static final Collection<Channel> VALUES = new ArrayList<>();
 
-    public static Channel FATAL = add(VALUES, new Channel("fatal", 6.0));
-    public static Channel ERROR = add(VALUES, new Channel("error", 5.0));
-    public static Channel WARN = add(VALUES, new Channel("warn", 4.0));
-    public static Channel INFO = add(VALUES, new Channel("info", 3.0));
-    public static Channel DEBUG = add(VALUES, new Channel("debug", 2.0));
-    public static Channel TRACE = add(VALUES, new Channel("trace", 1.0));
+    public static final Channel FATAL = add(VALUES, new Channel("fatal", 6.0));
+    public static final Channel ERROR = add(VALUES, new Channel("error", 5.0));
+    public static final Channel WARN = add(VALUES, new Channel("warn", 4.0));
+    public static final Channel INFO = add(VALUES, new Channel("info", 3.0));
+    public static final Channel DEBUG = add(VALUES, new Channel("debug", 2.0));
+    public static final Channel TRACE = add(VALUES, new Channel("trace", 1.0));
 
     private final String channel;
     private final double priority;

panda-framework/src/main/java/org/panda_lang/language/interpreter/logging/Channel.java

@@ -16,6 +16,7 @@
 
 package org.panda_lang.language.interpreter.logging;
 
+import org.panda_lang.language.Failure;
 import org.panda_lang.utilities.commons.StackTraceUtils;
 import org.panda_lang.utilities.commons.console.Effect;
 
@@ -47,6 +48,10 @@ public void error(String message) {
     public void exception(Throwable throwable) {
         StackTraceElement[] stackTrace = StackTraceUtils.startsWith(throwable.getStackTrace(), element -> element.toString().contains("org.junit"));
 
+        if (throwable instanceof Failure) {
+
+        }
+
         error("");
         error("&b- - ~ ~< Exception >~ ~ - -&r");
         error("");
@@ -64,8 +69,6 @@ public void exception(Throwable throwable) {
         error("");
         error("Environment:");
         error("");
-
-        throwable.printStackTrace(System.err);
     }
 
 }

panda-framework/src/main/java/org/panda_lang/language/interpreter/logging/SystemLogger.java

@@ -17,12 +17,12 @@
 package org.panda_lang.language.interpreter.parser;
 
 import org.jetbrains.annotations.Nullable;
-import org.panda_lang.language.interpreter.PandaInterpreterFailure;
+import org.panda_lang.language.interpreter.InterpreterFailure;
 import org.panda_lang.language.interpreter.source.Location;
 import org.panda_lang.language.interpreter.source.PandaIndicatedSource;
 import org.panda_lang.language.interpreter.token.Snippetable;
 
-public class PandaParserFailure extends PandaInterpreterFailure implements ParserFailure {
+public class PandaParserFailure extends InterpreterFailure implements ParserFailure {
 
     private final Context context;
 

panda-framework/src/main/java/org/panda_lang/language/interpreter/parser/PandaParserFailure.java

@@ -16,9 +16,8 @@
 
 package org.panda_lang.language.interpreter.parser.pipeline;
 
-import org.panda_lang.language.interpreter.InterpreterFailure;
+import org.panda_lang.language.Failure;
 import org.panda_lang.language.interpreter.parser.Parser;
-
 import org.panda_lang.utilities.commons.function.Option;
 
 /**
@@ -42,7 +41,7 @@ default boolean isFound() {
      *
      * @return the failure
      */
-    Option<InterpreterFailure> getFailure();
+    Option<Failure> getFailure();
 
     /**
      * Get matched parser

panda-framework/src/main/java/org/panda_lang/language/interpreter/parser/pipeline/HandleResult.java

@@ -16,31 +16,30 @@
 
 package org.panda_lang.language.interpreter.parser.pipeline;
 
-import org.panda_lang.language.interpreter.InterpreterFailure;
+import org.panda_lang.language.Failure;
 import org.panda_lang.language.interpreter.parser.Parser;
-
 import org.panda_lang.utilities.commons.function.Option;
 
 final class PandaHandleResult<T extends Parser> implements HandleResult<T> {
 
     private final T parser;
-    private final InterpreterFailure failure;
+    private final Failure failure;
 
     public PandaHandleResult(T parser) {
         this(parser, null);
     }
 
-    public PandaHandleResult(InterpreterFailure failure) {
+    public PandaHandleResult(Failure failure) {
         this(null, failure);
     }
 
-    private PandaHandleResult(T parser, InterpreterFailure failure) {
+    private PandaHandleResult(T parser, Failure failure) {
         this.parser = parser;
         this.failure = failure;
     }
 
     @Override
-    public Option<InterpreterFailure> getFailure() {
+    public Option<Failure> getFailure() {
         return Option.of(failure);
     }
 

panda-framework/src/main/java/org/panda_lang/language/interpreter/parser/pipeline/PandaHandleResult.java

@@ -16,12 +16,12 @@
 
 package org.panda_lang.language.interpreter.parser.pipeline;
 
+import org.panda_lang.language.Failure;
 import org.panda_lang.language.PandaFrameworkException;
-import org.panda_lang.language.interpreter.InterpreterFailure;
 import org.panda_lang.language.interpreter.parser.Context;
+import org.panda_lang.language.interpreter.parser.LocalChannel;
 import org.panda_lang.language.interpreter.parser.Parser;
 import org.panda_lang.language.interpreter.parser.ParserRepresentation;
-import org.panda_lang.language.interpreter.parser.LocalChannel;
 import org.panda_lang.language.interpreter.token.Snippet;
 
 import java.util.ArrayList;
@@ -69,14 +69,14 @@ public HandleResult<P> handle(Context context, LocalChannel channel, Snippet sou
 
     private HandleResult<P> handle(Context context, LocalChannel channel, Snippet source, Collection<? extends ParserRepresentation<P>> representations) {
         long currentTime = System.nanoTime();
-        InterpreterFailure failure = null;
+        Failure failure = null;
 
         for (ParserRepresentation<P> representation : representations) {
             Handler handler = representation.getHandler();
             Object value = handler.handle(context, channel, source);
 
-            if (value instanceof InterpreterFailure) {
-                failure = (InterpreterFailure) value;
+            if (value instanceof Failure) {
+                failure = (Failure) value;
                 continue;
             }
 

panda-framework/src/main/java/org/panda_lang/language/interpreter/parser/pipeline/PandaPipeline.java

@@ -36,11 +36,6 @@ private PipelineComponent(String name, Class<P> type) {
         super(name, type, 0);
     }
 
-    @Override
-    public String toString() {
-        return super.toString();
-    }
-
     /**
      * Create component
      *

panda-framework/src/main/java/org/panda_lang/language/interpreter/parser/pipeline/PipelineComponent.java

@@ -19,11 +19,11 @@
 import org.panda_lang.language.interpreter.parser.Components;
 import org.panda_lang.language.interpreter.parser.Context;
 import org.panda_lang.language.interpreter.parser.ContextParser;
-import org.panda_lang.language.interpreter.parser.Parser;
 import org.panda_lang.language.interpreter.parser.LocalChannel;
+import org.panda_lang.language.interpreter.parser.PandaParserFailure;
+import org.panda_lang.language.interpreter.parser.Parser;
 import org.panda_lang.language.interpreter.token.Snippet;
 import org.panda_lang.language.interpreter.token.SourceStream;
-import org.panda_lang.language.interpreter.parser.PandaParserFailure;
 import org.panda_lang.language.resource.syntax.separator.Separators;
 
 public final class PipelineParser<T extends ContextParser<?>> implements Parser {
@@ -56,9 +56,9 @@ public boolean parse(Context context, SourceStream stream) {
             HandleResult<T> result = pipeline.handle(context, channel, source);
 
             ContextParser<?> parser = result.getParser().orThrow(() -> {
-                return result.getFailure().orElseGet(() -> {
-                    throw new PandaParserFailure(delegatedContext, source, "Unrecognized syntax");
-                });
+                return result.getFailure()
+                        .map(failure -> (RuntimeException) failure)
+                        .orElseGet(() -> new PandaParserFailure(delegatedContext, source, "Unrecognized syntax"));
             });
 
             int sourceLength = stream.getUnreadLength();