Merge pull request #360 from ArkScript-lang/refactor/errors

Refactor/errors

Former-commit-id: 21d07eb58a548cdcb95df7ddcecb115547f720b5

Author: SuperFola

.github/workflows/ci.yml

@@ -270,22 +270,21 @@ jobs:
       with:
         submodules: recursive
 
-    - name: Update LLVM compilers
-      shell: bash
-      run: sudo apt-get install -y clang-11 lld-11 libc++-11-dev libc++abi-11-dev clang-tools-11 valgrind
+    - name: Download artifact
+      id: download
+      uses: actions/download-artifact@v2
+      with:
+        name: "ubuntu-clang-11"
+        path: build
 
-    - name: Configure CMake Ark
-      shell: bash
+    - shell: bash
       run: |
-        cmake -Bbuild \
-          -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
-          -DCMAKE_C_COMPILER=clang-11 \
-          -DCMAKE_CXX_COMPILER=clang++-11 \
-          -DARK_BUILD_EXE=On -DARK_BUILD_MODULES=On
+        mv build/lib/*.arkm lib/
+        chmod u+x build/ark build/arkscript
 
-    - name: Build ArkScript
+    - name: Update LLVM compilers
       shell: bash
-      run: cmake --build build --config $BUILD_TYPE
+      run: sudo apt-get install -y clang-11 lld-11 libc++-11-dev libc++abi-11-dev clang-tools-11 valgrind
 
     - name: Valgrind checks for memory leaks
       shell: bash

CHANGELOG.md

@@ -6,13 +6,19 @@
     - the VM can have multiple independant context running on the same bytecode
 - the VM now takes a reference to an `Ark::State` instead of a raw non-owning pointer
 - adding `ARK_PROFILER_MIPS` to toggle instruction per second calculation
+- adding new way to typecheck in builtins
 - new CI build step now running valgrind to check for memory leaks
+- new type checker (to be used by builtins)
+- better type errors generation (with the list of arguments, if they are matching or not, and more)
 
 ### Changed
 - splitting Utils.hpp into multiple files for easier maintenance and contextualisation
 - reserving a default scope size of 3, which yields really good performance results compared to nothing being reserved
+- upgrading the builtins error handling to use the `BetterTypeError`
+- the VM now displays the debug info (ip, pp, sp) at the end of the backtrace instead of the beginning
 
 ### Removed
+- `BetterTypeError` has been removed in favor of a type checker using templates and an error generator
 
 ### Deprecated
 - deprecating `VM(State*)` in favor of `VM(State&)`

CMakeLists.txt

@@ -184,6 +184,10 @@ if (ARK_ENABLE_SYSTEM)
     target_compile_definitions(ArkReactor PRIVATE -DARK_ENABLE_SYSTEM)
 endif()
 
+if (ARK_PROFILER_MIPS)
+    target_compile_definitions(ArkReactor PRIVATE -DARK_PROFILER_MIPS)
+endif()
+
 if (ARK_BUILD_MODULES)
     add_subdirectory(${ark_SOURCE_DIR}/lib/modules)
 endif()

include/Ark/Builtins/BuiltinsErrors.inl

@@ -1,98 +1,8 @@
-// IO
-
-#define IO_INPUT_TE "input: prompt must be a String"
-
-#define IO_WRITE_ARITY "writeFile needs 2 to 3 arguments: filename, [mode], content"
-#define IO_WRITE_TE0 "writeFile: filename must be a String"
-#define IO_WRITE_TE1 "writeFile: mode must be a String"
-#define IO_WRITE_VE_1 "writeFile: mode must be equal to \"a\" or \"w\""
-
-#define IO_READ_ARITY "readFile needs 1 argument: filename"
-#define IO_READ_TE0 "readFile: filename must be a String"
-
-#define IO_EXISTS_ARITY "fileExists? needs 1 argument: filename"
-#define IO_EXISTS_TE0 "fileExists?: filename must be a String"
-
-#define IO_LS_ARITY "listFiles needs 1 argument: filename"
-#define IO_LS_TE0 "listFiles: filename must be a String"
-
-#define IO_ISDIR_ARITY "isDir? needs 1 argument: path"
-#define IO_ISDIR_TE0 "isDir?: path must be a String"
-
-#define IO_MKD_ARITY "makeDir needs 1 argument: filename"
-#define IO_MKD_TE0 "makeDir: filename must be a String"
-
-#define IO_RM_ARITY "removeFiles needs at least 1 argument: filename [...]"
-#define IO_RM_TE0 "removeFiles: filename must be a String"
-
 // List
 
-#define LIST_REVERSE_ARITY "list:reverse needs 1 argument: list"
-#define LIST_REVERSE_TE0 "list:reverse: list must be a List"
-
-#define LIST_FIND_ARITY "list:find needs 2 arguments: list, value"
-#define LIST_FIND_TE0 "list:find: list must be a List"
-
 // TO BE DEPRECATED
 #define LIST_RMAT_ARITY "list:removeAt needs 2 arguments: list, index"
 #define LIST_RMAT_TE0 "list:removeAt: list must be a List"
 #define LIST_RMAT_TE1 "list:removeAt: index must be a Number"
 #define LIST_RMAT_OOR "list:removeAt: index out of range"
 // --
-
-#define LIST_SLICE_ARITY "list:slice needs 4 arguments: list, start, end, step"
-#define LIST_SLICE_TE0 "list:slice: list must be a List"
-#define LIST_SLICE_TE1 "list:slice: start must be a Number"
-#define LIST_SLICE_TE2 "list:slice: end must be a Number"
-#define LIST_SLICE_TE3 "list:slice: step must be a Number"
-#define LIST_SLICE_STEP "list:slice: step can not be null"
-#define LIST_SLICE_ORDER "list:slice: start position must be less or equal to the end position"
-#define LIST_SLICE_OOR "list:slice: indices out of range"
-
-#define LIST_SORT_ARITY "list:sort needs 1 argument: a list"
-#define LIST_SORT_TE0 "list:sort: list must be a List"
-
-#define LIST_FILL_ARITY "list:fill needs 2 arguments: size, value"
-#define LIST_FILL_TE0 "list:fill: size must be a Number"
-
-#define LIST_SETAT_ARITY "list:setAt needs 3 arguments: list, index, value"
-#define LIST_SETAT_TE0 "list:setAt: list must be a List"
-#define LIST_SETAT_TE1 "list:setAt: index must be a Number"
-
-// Mathematics
-
-#define MATH_ARITY(name) (name " needs 1 argument: value")
-#define MATH_TE0(name) (name ": value must be a Number")
-
-// String
-
-#define STR_FORMAT_ARITY "str:format needs at least 1 argument: string, [values...]"
-#define STR_FORMAT_TE0 "str:format: string must be a String"
-
-#define STR_FIND_ARITY "str:find needs 2 arguments: string, substr"
-#define STR_FIND_TE0 "str:find: string must be a String"
-#define STR_FIND_TE1 "str:find: substr must be a String"
-
-#define STR_RM_ARITY "str:removeAt needs 2 arguments: string, index"
-#define STR_RM_TE0 "str:removeAt: string must be a String"
-#define STR_RM_TE1 "str:removeAt: index must be a Number"
-#define STR_RM_OOR "str:removeAt: index out of range"
-
-#define STR_ORD_ARITY "str:ord needs at least 1 argument: string"
-#define STR_ORD_TE0 "str:ord: string must be a String"
-
-#define STR_CHR_ARITY "str:chr needs at least 1 argument: codepoint"
-#define STR_CHR_TE0 "str:chr: codepoint must be a Number"
-
-// System
-
-#define SYS_SYS_ARITY "sys:exec needs 1 argument: command"
-#define SYS_SYS_TE0 "sys:exec: command must be a String"
-
-#define SYS_SLEEP_ARITY "sleep needs 1 argument: duration (milliseconds)"
-#define SYS_SLEEP_TE0 "sleep: duration must be a Number"
-
-#define SYS_EXIT_ARITY "sys:exit needs 1 argument: exit code"
-#define SYS_EXIT_TE0 "sys:exit: exit code must be a Number"
-
-// Time

include/Ark/Exceptions.hpp

@@ -21,33 +21,6 @@
 
 namespace Ark
 {
-    class Error : public std::runtime_error
-    {
-    public:
-        explicit Error(const std::string& message = "") :
-            std::runtime_error(message)
-        {}
-    };
-
-    /**
-     * @brief A type error triggered when types don't match
-     * 
-     */
-    class BetterTypeError : public Error
-    {
-    public:
-        BetterTypeError(std::string_view func_name, std::size_t expected_argc, const std::vector<Value>& args);
-
-        BetterTypeError& withArg(std::string_view arg_name, ValueType arg_type);
-        BetterTypeError& withArg(std::string_view arg_name, const std::vector<ValueType>& arg_type);
-
-    protected:
-        std::string_view m_funcname;
-        std::size_t m_arg_index;
-        std::size_t m_expected_argc;
-        std::vector<Value> m_args;
-    };
-
     /**
      * @brief A type error triggered when types don't match
      * 
@@ -56,7 +29,7 @@ namespace Ark
     {
     public:
         explicit TypeError(const std::string& message) :
-            std::runtime_error("TypeError: " + message)
+            std::runtime_error(message)
         {}
     };
 

include/Ark/TypeChecker.hpp

@@ -0,0 +1,104 @@
+/**
+ * @file TypeChecker.hpp
+ * @author Alexandre Plateau ([email protected])
+ * @brief 
+ * @version 0.3
+ * @date 2022-01-16
+ * 
+ * @copyright Copyright (c) 2022
+ * 
+ */
+
+#ifndef INCLUDE_ARK_TYPECHECKER_HPP
+#define INCLUDE_ARK_TYPECHECKER_HPP
+
+#include <limits>
+#include <string>
+#include <vector>
+#include <type_traits>
+
+#define NOMINMAX
+#include <Ark/VM/Value.hpp>
+
+#ifdef max
+#    undef max
+#endif
+
+namespace Ark::types
+{
+    namespace details
+    {
+        template <typename T, typename... Ts>
+        using AllSame = std::enable_if_t<std::conjunction_v<std::is_same<T, Ts>...>>;
+
+        template <int I>
+        bool checkN([[maybe_unused]] const std::vector<Value>& args)
+        {
+            return true;
+        }
+
+        template <int I, typename T, typename... Ts>
+        bool checkN(const std::vector<Value>& args, T type, Ts... xs)
+        {
+            if (I >= args.size() || (type != ValueType::Any && args[I].valueType() != type))
+                return false;
+            return checkN<I + 1>(args, xs...);
+        }
+    }
+
+    /**
+     * @brief Helper to see if a builtin has been given a wanted set of types
+     * 
+     * @tparam Ts Variadic argument list composed of ValueTypes
+     * @param args arguments passed to the function
+     * @param types accepted types
+     * @return true if the contract is respected
+     * @return false otherwise
+     */
+    template <typename... Ts, typename = details::AllSame<ValueType, Ts...>>
+    bool check(const std::vector<Value>& args, Ts... types)
+    {
+        if (sizeof...(types) != args.size())
+            return false;
+        return details::checkN<0>(args, types...);
+    }
+
+    /**
+     * @brief A type definition within a contract
+     * 
+     */
+    struct Typedef
+    {
+        std::string_view name;
+        std::vector<ValueType> types;
+        bool variadic;
+
+        Typedef(std::string_view name, ValueType type, bool variadic = false) :
+            name(name), types { { type } }, variadic(variadic)
+        {}
+
+        Typedef(std::string_view name, const std::vector<ValueType>& types, bool variadic = false) :
+            name(name), types(types), variadic(variadic)
+        {}
+    };
+
+    /**
+     * @brief A contract is a list of typed arguments that a function can follow
+     * 
+     */
+    struct Contract
+    {
+        std::vector<Typedef> arguments;
+    };
+
+    /**
+     * @brief Generate an error message based on a given set of types contracts provided argument list
+     * 
+     * @param funcname ArkScript name of the function
+     * @param contracts types contracts the function can follow
+     * @param args provided argument list
+     */
+    void generateError(std::string_view funcname, const std::vector<Contract>& contracts, const std::vector<Value>& args);
+}
+
+#endif

include/Ark/VM/Value.hpp

@@ -2,7 +2,7 @@
  * @file Value.hpp
  * @author Default value type handled by the virtual machine
  * @brief 
- * @version 0.2
+ * @version 0.3
  * @date 2020-10-27
  * 
  * @copyright Copyright (c) 2020-2021
@@ -51,7 +51,9 @@ namespace Ark
         False = 9,
         Undefined = 10,
         Reference = 11,
-        InstPtr = 12
+        InstPtr = 12,
+
+        Any = 99
     };
 
     const std::array<std::string, 13> types_to_str = {