Generate errors outside AST tree

takev · takev · commit 05e72d5326b7 · 2025-09-14T17:29:59.000+02:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -42,6 +42,7 @@ add_library(hk_objects OBJECT
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/import_declaration_node.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/import_library_declaration_node.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/import_module_declaration_node.hpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/import_repository_declaration_node.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/import_repository_declaration_node.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/module_declaration_node.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/ast/module_node.cpp"
@@ -51,6 +52,7 @@ add_library(hk_objects OBJECT
     "${CMAKE_CURRENT_SOURCE_DIR}/src/error/error_code.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/error/error_item.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/error/error_list.hpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/error/error_location.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/error/errors.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/error/make_error.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/parser/consume.hpp"
@@ -100,6 +102,8 @@ add_library(hk_objects OBJECT
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/fixed_fifo.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/fqname.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/generator.hpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/git_error.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/git_error.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/git.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/git.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/src/utility/log.cpp"
@@ -193,19 +197,11 @@ if(BUILD_TESTING)
     endif()
 
     add_custom_command(
-        OUTPUT ${CMAKE_BINARY_DIR}/test_data/.copied
+        TARGET hktests POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E copy_directory
                 ${CMAKE_SOURCE_DIR}/test_data
                 ${CMAKE_BINARY_DIR}/test_data
-        COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_BINARY_DIR}/test_data/.copied
-        DEPENDS ${CMAKE_SOURCE_DIR}/test_data  # optional, see note
-        COMMENT "Copying test_data directory"
     )
 
-    add_custom_target(copy_test_data ALL
-        DEPENDS ${CMAKE_BINARY_DIR}/test_data/.copied
-    )
-
-    add_dependencies(hktests copy_test_data)
     add_test(NAME hktests COMMAND hktests)
 endif()
diff --git a/src/ast/import_declaration_node.hpp b/src/ast/import_declaration_node.hpp
@@ -4,14 +4,19 @@
 #include "node.hpp"
 #include "utility/fqname.hpp"
 #include "utility/generator.hpp"
-
+#include "utility/repository_url.hpp"
+#include "error/error_location.hpp"
 
 namespace hk::ast {
 
 class import_declaration_node : public node {
 public:
     using node::node;
 
+    [[nodiscard]] virtual generator<std::pair<repository_url, error_location>> remote_repositories(error_list &errors) const
+    {
+        co_return;
+    }
 };
 
 using import_declaration_node_ptr = std::unique_ptr<import_declaration_node>;
diff --git a/src/ast/import_repository_declaration_node.cpp b/src/ast/import_repository_declaration_node.cpp
@@ -0,0 +1,12 @@
+
+#include "import_repository_declaration_node.hpp"
+
+namespace hk::ast {
+
+[[nodiscard]] generator<std::pair<repository_url, error_location>>
+import_repository_declaration_node::remote_repositories(error_list& errors) const
+{
+    co_yield {url, error_location{errors, first, last}};
+}
+
+} // namespace hk::ast
diff --git a/src/ast/import_repository_declaration_node.hpp b/src/ast/import_repository_declaration_node.hpp
@@ -6,14 +6,17 @@ namespace hk::ast {
 
 class import_repository_declaration_node : public import_declaration_node {
 public:
+    repository_url url;
+
     using import_declaration_node::import_declaration_node;
 
     import_repository_declaration_node(file_location first, file_location last, repository_url url) :
         import_declaration_node(first, last), url(url)
     {
     }
 
-    repository_url url;
+    [[nodiscard]] generator<std::pair<repository_url, error_location>> remote_repositories(error_list &errors) const override;
+
 };
 
 } // namespace hk::ast
diff --git a/src/ast/module_node.cpp b/src/ast/module_node.cpp
@@ -4,11 +4,11 @@
 
 namespace hk::ast {
 
-[[nodiscard]] generator<module_node::remote_repository_result> module_node::remote_repositories() const
+[[nodiscard]] generator<std::pair<repository_url, error_location>> module_node::remote_repositories() const
 {
     for (auto const& import : imports) {
-        if (auto repository_import_ptr = dynamic_cast<import_repository_declaration_node const*>(import.get())) {
-            co_yield remote_repository_result{repository_import_ptr->url, fxxxxxxxst, this};
+        for (auto result : import->remote_repositories(errors)) {
+            co_yield std::move(result);
         }
     }
 }
diff --git a/src/ast/module_node.hpp b/src/ast/module_node.hpp
@@ -5,6 +5,7 @@
 #include "module_declaration_node.hpp"
 #include "import_declaration_node.hpp"
 #include "error/error_list.hpp"
+#include "error/error_location.hpp"
 #include "utility/repository_url.hpp"
 #include <memory>
 #include <vector>
@@ -24,7 +25,7 @@ class module_node : public node {
 
     /** List of errors found.
      */
-    error_list errors;
+    mutable error_list errors;
 
     /** The path to the module file.
      */
@@ -49,13 +50,7 @@ class module_node : public node {
     std::vector<import_declaration_node_ptr> imports;
     std::vector<node_ptr> body;
 
-    struct remote_repository_result {
-        repository_url url;
-        file_location first;
-        file_location last;
-        module_node *node;
-    };
-    [[nodiscard]] generator<remote_repository_result> remote_repositories() const;
+    [[nodiscard]] generator<std::pair<repository_url, error_location>> remote_repositories() const;
 
 };
 
diff --git a/src/error/error_location.hpp b/src/error/error_location.hpp
@@ -0,0 +1,54 @@
+
+#pragma once
+
+#include "utility/file_location.hpp"
+#include "error_list.hpp"
+
+namespace hk {
+
+/** This class holds an error-location in module.
+ *
+ * If a error occurs outside of the AST tree, this class can be used to report
+ * an error inside that module.
+ */
+class error_location {
+public:
+    constexpr error_location() noexcept = default;
+    constexpr error_location(error_location const&) noexcept = default;
+    constexpr error_location(error_location&&) noexcept = default;
+    constexpr error_location &operator=(error_location const&) noexcept = default;
+    constexpr error_location &operator=(error_location&&) noexcept = default;
+
+    /** Create an error location.
+     *
+     * @param errors The error list of the module.
+     * @param first The location of the first character of the module where an
+     *              optional error can appear.
+     * @param last One beyond the last character.
+     */
+    constexpr error_location(error_list &errors, file_location first, file_location last = file_location{})
+        : _errors_ptr(&errors), _first(first), _last(last) {}
+
+    /** Add an error to the list. 
+     * 
+     *  @tparam ErrorCode The error being raised, including the format string.
+     *  @param args The arguments to format the error message.
+     *  @return A unexpected error containing the error code.
+     */
+    template<typename ErrorType, typename... Args>
+    std::unexpected<error_code> add(Args&&... args)
+    {
+        assert(_errors_ptr != nullptr);
+
+        auto e = error_item{_first, _last, ErrorType::code, ErrorType::fmt, std::forward<Args>(args)...};
+        _errors_ptr->push_back(std::move(e));
+        return std::unexpected{ErrorType::code};
+    }
+
+private:
+    error_list *_errors_ptr = nullptr;
+    file_location _first = {};
+    file_location _last = {};
+};
+
+}
diff --git a/src/error/errors.hpp b/src/error/errors.hpp
@@ -22,6 +22,7 @@ E(missing_import_mod_declaration_name, "E0012: Expected fully qualified name aft
 E(missing_import_declaration_semicolon, "E0013: Expected ';' after a import-declaration.");
 E(missing_fqname_identifier_after_dot, "E0014: Expected identifier after '.' in fully qualified name.");
 
+E(could_not_clone_repository, "W0001: Could not clone repository '{}' rev '{}': {}.");
 
 #undef E
 
diff --git a/src/repository/repository.cpp b/src/repository/repository.cpp
@@ -4,9 +4,11 @@
 #include "utility/vector_set.hpp"
 #include "utility/file_cursor.hpp"
 #include "utility/git.hpp"
+#include "error/errors.hpp"
 #include "parser/parse_module.hpp"
 #include <cassert>
 #include <algorithm>
+#include <map>
 
 namespace hk {
 
@@ -71,12 +73,12 @@ void repository::scan_prologues(repository_flags flags)
 
 void repository::recursive_scan_prologues(repository_flags flags)
 {
-    auto todo = std::set<repository_url>{};
-    auto done = std::set<repository_url>{};
+    auto todo = std::map<repository_url, error_location>{};
+    auto done = std::map<repository_url, error_location>{};
 
     scan_prologues(flags);
-    for (auto child_repo_url : remote_repositories()) {
-        todo.insert(std::move(child_repo_url));
+    for (auto item : remote_repositories()) {
+        todo.insert(std::move(item));
     }
 
     auto hkdeps = _path / "_hkdeps";
@@ -88,11 +90,11 @@ void repository::recursive_scan_prologues(repository_flags flags)
         }
 
         assert(it != done.end());
-        auto child_repo_path = hkdeps / it->directory();
-        auto &child_repo = get_child_repository(*it);
+        auto child_repo_path = hkdeps / it->first.directory();
+        auto &child_repo = get_child_repository(it->first);
         if (not child_repo.repository) {
-            if (auto r = git_checkout_or_clone(*it, child_repo_path, flags); r != git_error::ok) {
-
+            if (auto r = git_checkout_or_clone(it->first, child_repo_path, flags); r != git_error::ok) {
+                it->second.add<error::could_not_clone_repository>(it->first.url(), it->first.rev(), r);
             }
 
             child_repo.repository = std::make_unique<repository>(child_repo_path);
@@ -115,11 +117,11 @@ void repository::untouch(bool remove)
     }
 }
 
-[[nodiscard]] generator<repository_url> repository::remote_repositories() const
+[[nodiscard]] generator<std::pair<repository_url, error_location>> repository::remote_repositories() const
 {
     for (auto const& m : _modules) {
-        for (auto u : m.ast->remote_repositories()) {
-            co_yield std::move(u);
+        for (auto repo : m.ast->remote_repositories()) {
+            co_yield std::move(repo);
         }
     }
 }
diff --git a/src/repository/repository.hpp b/src/repository/repository.hpp
@@ -29,7 +29,7 @@ class repository {
      */
     void recursive_scan_prologues(repository_flags flags);
 
-    [[nodiscard]] generator<repository_url> remote_repositories() const;
+    [[nodiscard]] generator<std::pair<repository_url, error_location>> remote_repositories() const;
 
 private:
     struct module_type {
diff --git a/src/repository/repository_tests.cpp b/src/repository/repository_tests.cpp
@@ -11,12 +11,12 @@ TEST_CASE(single_repository_scan)
     auto test_data_path = hk::test_data_path();
     auto repository_path = std::filesystem::canonical(test_data_path / "prologue_scan" / "root");
     auto repository = hk::repository{repository_path};
-    repository.scan_prologues(false);
+    repository.scan_prologues(hk::repository_flags{});
 
     auto urls = std::ranges::to<std::vector>(repository.remote_repositories());
     REQUIRE(urls.size() == 1);
-    REQUIRE(urls[0].url() == "https://github.com/hikogui/hikolang-tests-a.git");
-    REQUIRE(urls[0].rev() == "main");
+    REQUIRE(urls[0].first.url() == "https://github.com/hikogui/hikolang-tests-a.git");
+    REQUIRE(urls[0].first.rev() == "main");
 }
 
 
diff --git a/src/utility/git.cpp b/src/utility/git.cpp
@@ -72,84 +72,6 @@ class git_lib {
     return global;
 }
 
-[[nodiscard]] constexpr git_error make_git_error(int code)
-{
-    switch (code) {
-    case GIT_OK:
-        return git_error::ok;
-    case GIT_ERROR:
-        return git_error::error;
-    case GIT_ENOTFOUND:
-        return git_error::not_found;
-    case GIT_EEXISTS:
-        return git_error::exists;
-    case GIT_EAMBIGUOUS:
-        return git_error::ambiguous;
-    case GIT_EBUFS:
-        return git_error::bufs;
-    case GIT_EUSER:
-        return git_error::user;
-    case GIT_EBAREREPO:
-        return git_error::bare_repo;
-    case GIT_EUNBORNBRANCH:
-        return git_error::unborn_branch;
-    case GIT_EUNMERGED:
-        return git_error::unmerged;
-    case GIT_ENONFASTFORWARD:
-        return git_error::non_fast_forward;
-    case GIT_EINVALIDSPEC:
-        return git_error::invalid_spec;
-    case GIT_ECONFLICT:
-        return git_error::conflict;
-    case GIT_ELOCKED:
-        return git_error::locked;
-    case GIT_EMODIFIED:
-        return git_error::modified;
-    case GIT_EAUTH:
-        return git_error::auth;
-    case GIT_ECERTIFICATE:
-        return git_error::certificate;
-    case GIT_EAPPLIED:
-        return git_error::applied;
-    case GIT_EPEEL:
-        return git_error::peel;
-    case GIT_EEOF:
-        return git_error::eof;
-    case GIT_EINVALID:
-        return git_error::invalid;
-    case GIT_EUNCOMMITTED:
-        return git_error::uncommitted;
-    case GIT_EDIRECTORY:
-        return git_error::directory;
-    case GIT_EMERGECONFLICT:
-        return git_error::merge_conflict;
-    case GIT_PASSTHROUGH:
-        return git_error::pass_through;
-    case GIT_ITEROVER:
-        return git_error::iter_over;
-    case GIT_RETRY:
-        return git_error::retry;
-    case GIT_EMISMATCH:
-        return git_error::mismatch;
-    case GIT_EINDEXDIRTY:
-        return git_error::index_dirty;
-    case GIT_EAPPLYFAIL:
-        return git_error::apply_fail;
-    case GIT_EOWNER:
-        return git_error::owner;
-    case GIT_TIMEOUT:
-        return git_error::timeout;
-    case GIT_EUNCHANGED:
-        return git_error::unchanged;
-    case GIT_ENOTSUPPORTED:
-        return git_error::not_supported;
-    case GIT_EREADONLY:
-        return git_error::read_only;
-    default:
-        throw std::runtime_error(std::format("Unknown git error code {}", code));
-    }
-}
-
 [[nodiscard]] std::expected<git_references, git_error> git_list(std::string const& url)
 {
     auto const& _ = git_lib_initialize();
diff --git a/src/utility/git.hpp b/src/utility/git.hpp
diff --git a/src/utility/git_error.cpp b/src/utility/git_error.cpp
diff --git a/src/utility/git_error.hpp b/src/utility/git_error.hpp
diff --git a/src/utility/unicode_tests.cpp b/src/utility/unicode_tests.cpp

Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,11 @@`
`4`	`4`
`5`	`5`	`namespace hk::ast {`
`6`	`6`
`7`		`-[[nodiscard]] generator<module_node::remote_repository_result> module_node::remote_repositories() const`
	`7`	`+[[nodiscard]] generator<std::pair<repository_url, error_location>> module_node::remote_repositories() const`
`8`	`8`	`{`
`9`	`9`	`for (auto const& import : imports) {`
`10`		`- if (auto repository_import_ptr = dynamic_cast<import_repository_declaration_node const*>(import.get())) {`
`11`		`- co_yield remote_repository_result{repository_import_ptr->url, fxxxxxxxst, this};`
	`10`	`+ for (auto result : import->remote_repositories(errors)) {`
	`11`	`+ co_yield std::move(result);`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,11 @@`
`4`	`4`	`#include "utility/vector_set.hpp"`
`5`	`5`	`#include "utility/file_cursor.hpp"`
`6`	`6`	`#include "utility/git.hpp"`
	`7`	`+#include "error/errors.hpp"`
`7`	`8`	`#include "parser/parse_module.hpp"`
`8`	`9`	`#include <cassert>`
`9`	`10`	`#include <algorithm>`
	`11`	`+#include <map>`
`10`	`12`
`11`	`13`	`namespace hk {`
`12`	`14`
`@@ -71,12 +73,12 @@ void repository::scan_prologues(repository_flags flags)`
`71`	`73`
`72`	`74`	`void repository::recursive_scan_prologues(repository_flags flags)`
`73`	`75`	`{`
`74`		`- auto todo = std::set<repository_url>{};`
`75`		`- auto done = std::set<repository_url>{};`
	`76`	`+ auto todo = std::map<repository_url, error_location>{};`
	`77`	`+ auto done = std::map<repository_url, error_location>{};`
`76`	`78`
`77`	`79`	`scan_prologues(flags);`
`78`		`- for (auto child_repo_url : remote_repositories()) {`
`79`		`- todo.insert(std::move(child_repo_url));`
	`80`	`+ for (auto item : remote_repositories()) {`
	`81`	`+ todo.insert(std::move(item));`
`80`	`82`	`}`
`81`	`83`
`82`	`84`	`auto hkdeps = _path / "_hkdeps";`
`@@ -88,11 +90,11 @@ void repository::recursive_scan_prologues(repository_flags flags)`
`88`	`90`	`}`
`89`	`91`
`90`	`92`	`assert(it != done.end());`
`91`		`- auto child_repo_path = hkdeps / it->directory();`
`92`		`- auto &child_repo = get_child_repository(*it);`
	`93`	`+ auto child_repo_path = hkdeps / it->first.directory();`
	`94`	`+ auto &child_repo = get_child_repository(it->first);`
`93`	`95`	`if (not child_repo.repository) {`
`94`		`- if (auto r = git_checkout_or_clone(*it, child_repo_path, flags); r != git_error::ok) {`
`95`		`-`
	`96`	`+ if (auto r = git_checkout_or_clone(it->first, child_repo_path, flags); r != git_error::ok) {`
	`97`	`+ it->second.add<error::could_not_clone_repository>(it->first.url(), it->first.rev(), r);`
`96`	`98`	`}`
`97`	`99`
`98`	`100`	`child_repo.repository = std::make_unique<repository>(child_repo_path);`
`@@ -115,11 +117,11 @@ void repository::untouch(bool remove)`
`115`	`117`	`}`
`116`	`118`	`}`
`117`	`119`
`118`		`-[[nodiscard]] generator<repository_url> repository::remote_repositories() const`
	`120`	`+[[nodiscard]] generator<std::pair<repository_url, error_location>> repository::remote_repositories() const`
`119`	`121`	`{`
`120`	`122`	`for (auto const& m : _modules) {`
`121`		`- for (auto u : m.ast->remote_repositories()) {`
`122`		`- co_yield std::move(u);`
	`123`	`+ for (auto repo : m.ast->remote_repositories()) {`
	`124`	`+ co_yield std::move(repo);`
`123`	`125`	`}`
`124`	`126`	`}`
`125`	`127`	`}`