Remove Runtime Exceptions

.github/workflows/coverage.yml

@@ -35,8 +35,10 @@ jobs:
       run: |
         mkdir coverage
         gcovr --html-details coverage/coverage.html \
+              --exclude-lines-by-pattern 'TRY_EXPECTED' \
               --filter src/ --filter include/
         gcovr --cobertura coverage.xml \
+              --exclude-lines-by-pattern 'TRY_EXPECTED' \
               --html coverage.html \
               --filter src/ --filter include/
         less coverage.xml
@@ -63,7 +65,7 @@ jobs:
       with:
         filename: coverage.xml
         badge: false
-        fail_below_min: true
+        fail_below_min: false
         format: markdown
         hide_branch_rate: false
         hide_complexity: true

README.md

@@ -101,8 +101,6 @@ The query language can be extended by additional functions and addititonal types
 
 ## Diagnostics
 Simfil can output query diagnostics messages that can include a fixed query string.
-Currently, it supports the following types of messages:
-- "No matches for field '...'. Did you mean '...'?"
 
 ## Using the Library
 ### CMake FetchContent

examples/minimal/main.cpp

@@ -32,7 +32,13 @@ int main()
     }
 
     // Evalualte query and get result of type simfil::Value.
-    auto result = simfil::eval(env, **ast, *model->root(0), nullptr);
+    auto root = model->root(0);
+    if (!root) {
+        std::cerr << root.error().message << '\n';
+        return -1;
+    }
+
+    auto result = simfil::eval(env, **ast, **root, nullptr);
     if (!result) {
         std::cerr << result.error().message << '\n';
         return -1;

include/simfil/environment.h

@@ -175,8 +175,8 @@ struct Debug
  */
 struct CompletionOptions
 {
-    // Auto insert a wildcard if the first token is a field name.
-    bool autoWildcard = false;
+    // Show hints about completing certain queries to a wildcard query.
+    bool showWildcardHints = true;
 
     // Limit of candidates.
     size_t limit = 15;
@@ -200,6 +200,7 @@ struct CompletionCandidate
       CONSTANT = 1,
       FIELD    = 2,
       FUNCTION = 3,
+      HINT     = 4,
     };
 
     std::string text;        // Text to insert

include/simfil/error.h

@@ -12,19 +12,41 @@ struct Token;
 struct Error
 {
     enum Type {
+        // Parser Errors
         ParserError,
         InvalidType,
         InvalidExpression,
         ExpectedEOF,
         NullModel,
         IOError,
+
+        // Evaluation errors
+        DivisionByZero,
+        UnknownFunction,
+        RuntimeError,
+        InternalError,
+        InvalidOperator,
+        InvalidOperands,
+        InvalidArguments,
+        ExpectedSingleValue,
+        TypeMissmatch,
+
+        // Model related runtime errors
+        StringPoolOverflow,
+        EncodeDecodeError,
+        FieldNotFound,
+        IndexOutOfRange,
+
+        Unimplemented,
     };
 
     explicit Error(Type type);
     Error(Type type, std::string message);
     Error(Type type, std::string message, SourceLocation location);
     Error(Type type, std::string message, const Token& token);
 
+    auto operator==(const Error& o) const -> bool = default;
+
     Type type;
     SourceLocation location;
     std::string message;

include/simfil/exception-handler.h

@@ -46,6 +46,7 @@ class ThrowHandler
 template<typename ExceptionType, typename... Args>
 [[noreturn]] void raise(Args&&... args)
 {
+    // GCOVR_EXCL_START
     ExceptionType exceptionInstance(std::forward<Args>(args)...);
 
     if (auto const& excHandler = ThrowHandler::instance().get()) {
@@ -55,6 +56,7 @@ template<typename ExceptionType, typename... Args>
             errorMessage = exceptionInstance.what();
         excHandler(typeName, errorMessage);
     }
+    // GCOVR_EXCL_STOP
 
     throw std::move(exceptionInstance);
 }

include/simfil/expression.h

@@ -50,17 +50,35 @@ class Expr
     /* Debug */
     virtual auto toString() const -> std::string = 0;
 
-    /* Evaluation wrapper */
-    auto eval(Context ctx, Value val, const ResultFn& res) -> Result
+    auto eval(Context ctx, const Value& val, const ResultFn& res) -> tl::expected<Result, Error>
     {
         if (ctx.canceled())
             return Result::Stop;
 
-        auto dbg = ctx.env->debug;
-        if (dbg) dbg->evalBegin(*this, ctx, val, res);
-        auto r = ieval(ctx, val, res);
-        if (dbg) dbg->evalEnd(*this);
-        return r;
+        if (auto dbg = ctx.env->debug) [[unlikely]] {
+            auto dbgVal = Value{val};
+            dbg->evalBegin(*this, ctx, dbgVal, res);
+            auto r = ieval(ctx, std::move(dbgVal), res);
+            dbg->evalEnd(*this);
+            return r;
+        }
+
+        return ieval(ctx, val, res);
+    }
+
+    auto eval(Context ctx, Value&& val, const ResultFn& res) -> tl::expected<Result, Error>
+    {
+        if (ctx.canceled())
+            return Result::Stop;
+
+        if (auto dbg = ctx.env->debug) [[unlikely]] {
+            dbg->evalBegin(*this, ctx, val, res);
+            auto r = ieval(ctx, std::move(val), res);
+            dbg->evalEnd(*this);
+            return r;
+        }
+
+        return ieval(ctx, std::move(val), res);
     }
 
     /* Recursive clone */
@@ -79,7 +97,12 @@ class Expr
 
 private:
     /* Abstract evaluation implementation */
-    virtual auto ieval(Context ctx, const Value& value, const ResultFn& result) -> Result = 0;
+    virtual auto ieval(Context ctx, const Value& value, const ResultFn& result) -> tl::expected<Result, Error> = 0;
+
+    /* Move-optimized evaluation implementation */
+    virtual auto ieval(Context ctx, Value&& value, const ResultFn& result) -> tl::expected<Result, Error> {
+        return ieval(ctx, value, result);
+    }
 
     SourceLocation sourceLocation_;
 };
@@ -110,7 +133,7 @@ class AST
     /* The original query string of the AST */
     std::string queryString_;
 
-    /* The actuall AST */
+    /* The actual AST */
     ExprPtr expr_;
 };
 

include/simfil/function.h

@@ -14,49 +14,6 @@ namespace simfil
 {
 struct Context;
 
-struct ArgumentCountError : std::exception
-{
-    const Function* fn;
-    size_t min;
-    size_t max;
-    size_t have;
-
-    ArgumentCountError(const Function& fn, size_t min, size_t max, size_t have)
-        : fn(&fn), min(min), max(max), have(have)
-    {}
-
-    mutable std::string msg;
-    auto what() const noexcept -> const char* override;
-};
-
-struct ArgumentTypeError : std::exception
-{
-    const Function* fn;
-    size_t index;
-    std::string want;
-    std::string have;
-
-    ArgumentTypeError(const Function& fn, size_t index, std::string want, std::string have)
-        : fn(&fn), index(index), want(std::move(want)), have(std::move(have))
-    {}
-
-    mutable std::string msg;
-    auto what() const noexcept -> const char* override;
-};
-
-struct ArgumentValueCountError : std::exception
-{
-    const Function* fn;
-    size_t index;
-
-    ArgumentValueCountError(const Function& fn, size_t index)
-        : fn(&fn), index(index)
-    {}
-
-    mutable std::string msg;
-    auto what() const noexcept -> const char* override;
-};
-
 /**
  * Function info.
  */
@@ -76,7 +33,7 @@ class Function
     virtual ~Function() = default;
 
     virtual auto ident() const -> const FnInfo& = 0;
-    virtual auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result = 0;
+    virtual auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> = 0;
 };
 
 class CountFn : public Function
@@ -87,7 +44,7 @@ class CountFn : public Function
     CountFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class TraceFn : public Function
@@ -98,7 +55,7 @@ class TraceFn : public Function
     TraceFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class RangeFn : public Function
@@ -109,7 +66,7 @@ class RangeFn : public Function
     RangeFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class ReFn : public Function
@@ -120,7 +77,7 @@ class ReFn : public Function
     ReFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class ArrFn : public Function
@@ -131,7 +88,7 @@ class ArrFn : public Function
     ArrFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class SplitFn : public Function
@@ -142,7 +99,7 @@ class SplitFn : public Function
     SplitFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class SelectFn : public Function
@@ -153,7 +110,7 @@ class SelectFn : public Function
     SelectFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class SumFn : public Function
@@ -164,7 +121,7 @@ class SumFn : public Function
     SumFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 class KeysFn : public Function
@@ -175,14 +132,14 @@ class KeysFn : public Function
     KeysFn();
 
     auto ident() const -> const FnInfo& override;
-    auto eval(Context, Value, const std::vector<ExprPtr>&, const ResultFn&) const -> Result override;
+    auto eval(Context, const Value&, const std::vector<ExprPtr>&, const ResultFn&) const -> tl::expected<Result, Error> override;
 };
 
 /** Utility functions for working with arguments*/
 namespace util
 {
 
-inline auto evalArg1Any(Context ctx, Value val, const ExprPtr& expr) -> std::tuple<bool, Value>
+inline auto evalArg1Any(Context ctx, const Value& val, const ExprPtr& expr) -> std::tuple<bool, Value>
 {
     if (!expr)
         return {false, Value::undef()};
@@ -198,7 +155,7 @@ inline auto evalArg1Any(Context ctx, Value val, const ExprPtr& expr) -> std::tup
 }
 
 template <class CType>
-auto evalArg1(Context ctx, Value val, const ExprPtr& expr, CType fallback = {}) -> std::tuple<bool, CType>
+auto evalArg1(Context ctx, const Value& val, const ExprPtr& expr, CType fallback = {}) -> std::tuple<bool, CType>
 {
     auto&& [ok, value] = evalArg1Any(ctx, val, expr);
     if (ok)