Switch to using modules in the library

2026-01-06 11:12:50 +01:00
parent 8f0a4b9f36
commit dd97107aa8
12 changed files with 223 additions and 268 deletions
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -2,7 +2,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.

-cmake_minimum_required(VERSION 3.30)
+cmake_minimum_required(VERSION 4.0.0)
 project(Katja LANGUAGES CXX)

 include(CTest)
@@ -12,14 +12,11 @@ option(KATJA_BUILD_TUI "Build text user interface" ON)

 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_CXX_MODULE_STD 1)
+set(CMAKE_CXX_STANDARD 23)

-add_library(katja
-	katja/database.cpp include/katja/database.hpp
-	katja/sbo.cpp include/katja/sbo.hpp
-	katja/repository.cpp include/katja/repository.hpp
-)
+add_library(katja)
+target_sources(katja PUBLIC FILE_SET all_my_modules TYPE CXX_MODULES FILES
+	katja/database.cpp katja/repository.cpp katja/sbo.cpp)
 include_directories(include ${Boost_INCLUDE_DIR})

 if(KATJA_BUILD_TUI)
--- a/cli/component.cpp
+++ b/cli/component.cpp
@@ -12,9 +12,9 @@ module;
 #include <ftxui/component/component.hpp>
 #include <ftxui/dom/elements.hpp>

-#include "katja/repository.hpp"
+import katja.repository;

-export module component;
+export module katja.component;

 export namespace katja
 {
--- a/cli/main.cpp
+++ b/cli/main.cpp
@@ -3,17 +3,20 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
+module;
+
 #include <filesystem>
+#include <memory>

 #include <ftxui/component/screen_interactive.hpp>
 #include <ftxui/dom/elements.hpp>
 #include <ftxui/component/component.hpp>
 #include <toml.hpp>

-#include "katja/sbo.hpp"
-#include "katja/database.hpp"
-
-import page;
+import katja.database;
+import katja.repository;
+import katja.sbo;
+import katja.page;

 int main(int argc, const char **argv)
 {
--- a/cli/page.cpp
+++ b/cli/page.cpp
@@ -9,11 +9,12 @@ module;

 #include <ftxui/component/component.hpp>

-#include "katja/repository.hpp"
+import katja.database;
+import katja.repository;

-export module page;
+export module katja.page;

-import component;
+import katja.component;

 export namespace katja
 {
--- a/include/katja/database.hpp
+++ b/include/katja/database.hpp
@@ -1,39 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-#pragma once
-
-#include <string>
-#include <map>
-
-namespace katja
-{
-    constexpr const char *database = "/var/lib/pkgtools/packages";
-
-    class database_package
-    {
-        database_package(std::string&& name, std::string&& version,
-                std::string&& architecture, std::string&& build_tag);
-
-        static database_package create_database_package(const std::string& fullname);
-
-    public:
-        const std::string name;
-        const std::string version;
-        const std::string architecture;
-        const std::string build_tag;
-
-        database_package(const std::string& fullname);
-
-        bool operator<(const database_package& that) const;
-        bool operator>(const database_package& that) const;
-
-        std::string to_string() const;
-    };
-
-    using package_database = std::multimap<std::string, database_package>;
-
-    package_database read_installed_database();
-}
--- a/include/katja/repository.hpp
+++ b/include/katja/repository.hpp
@@ -1,32 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-#pragma once
-
-#include <string>
-#include <vector>
-
-#include "katja/database.hpp"
-
-namespace katja
-{
-    struct package_identifier
-    {
-        const std::string name;
-        const std::string version;
-        const std::string architecture;
-        const std::string data;
-
-        std::string to_string() const;
-    };
-
-    class repository
-    {
-    public:
-        virtual std::vector<package_identifier> get_updates(const package_database& database) = 0;
-        virtual std::vector<package_identifier> search_names(const std::string& architecture,
-                const std::string& needle) = 0;
-    };
-}
--- a/include/katja/sbo.hpp
+++ b/include/katja/sbo.hpp
@@ -1,44 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-#pragma once
-
-#include <string>
-#include <vector>
-#include <filesystem>
-#include <optional>
-
-#include "katja/repository.hpp"
-
-namespace katja
-{
-    struct info_file
-    {
-        const std::string program_name;
-        const std::string version;
-        const std::string homepage;
-        const std::string email;
-        const std::string maintainer;
-
-        info_file(const std::string& program_name, const std::string& version,
-                const std::string homepage, const std::string& email, const std::string& maintainer);
-
-        package_identifier identifier_for(const std::string& architecture);
-    };
-
-    class sbo_repository final : public repository
-    {
-        std::map<std::string, std::filesystem::path> info_paths;
-
-    public:
-        sbo_repository(const std::filesystem::path& repository_path);
-
-        std::vector<package_identifier> get_updates(const package_database& database) override;
-        std::vector<package_identifier> search_names(const std::string& architecture,
-                const std::string& needle) override;
-    };
-
-    std::optional<info_file> read_slackbuild_info(const std::filesystem::path& info_filepath);
-}
--- a/katja/database.cpp
+++ b/katja/database.cpp
@@ -3,13 +3,27 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
-#include "katja/database.hpp"
+module;

+#include <string>
+#include <map>
 #include <filesystem>

-namespace katja
+export module katja.database;
+
+export namespace katja
 {
-    database_package database_package::create_database_package(const std::string& fullname)
+    constexpr const char *database = "/var/lib/pkgtools/packages";
+
+    class database_package
+    {
+        database_package(std::string&& name, std::string&& version,
+                    std::string&& architecture, std::string&& build_tag)
+            : name(name), version(version), architecture(architecture), build_tag(build_tag)
+        {
+        }
+
+        static database_package create_database_package(const std::string& fullname)
        {
            std::string::const_reverse_iterator begin_iterator = std::crbegin(fullname);
            std::string::const_reverse_iterator end_iterator = begin_iterator;
@@ -43,28 +57,28 @@ namespace katja
                    std::move(version), std::move(architecture), std::move(build_tag));
        }

-    database_package::database_package(std::string&& name, std::string&& version,
-                std::string&& architecture, std::string&& build_tag)
-        : name(name), version(version), architecture(architecture), build_tag(build_tag)
-    {
-    }
+    public:
+        const std::string name;
+        const std::string version;
+        const std::string architecture;
+        const std::string build_tag;

-    database_package::database_package(const std::string& fullname)
+        database_package(const std::string& fullname)
            : database_package(create_database_package(fullname))
        {
        }

-    bool database_package::operator<(const database_package& that) const
+        bool operator<(const database_package& that) const
        {
            return this->name < that.name;
        }

-    bool database_package::operator>(const database_package& that) const
+        bool operator>(const database_package& that) const
        {
            return this->name > that.name;
        }

-    std::string database_package::to_string() const
+        std::string to_string() const
        {
            std::string package_string;
            const std::size_t total_size = this->name.size() + this->version.size()
@@ -81,6 +95,9 @@ namespace katja

            return package_string;
        }
+    };
+
+    using package_database = std::multimap<std::string, database_package>;

    package_database read_installed_database()
    {
--- a/katja/repository.cpp
+++ b/katja/repository.cpp
@@ -3,11 +3,25 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
-#include "katja/repository.hpp"
+module;

-namespace katja
+#include <string>
+#include <vector>
+
+export module katja.repository;
+
+import katja.database;
+
+export namespace katja
 {
-    std::string package_identifier::to_string() const
+    struct package_identifier
+    {
+        const std::string name;
+        const std::string version;
+        const std::string architecture;
+        const std::string data;
+
+        std::string to_string() const
        {
            std::string identifier;
            const std::size_t total_size = this->name.size() + this->version.size()
@@ -24,4 +38,13 @@ namespace katja

            return identifier;
        }
+    };
+
+    class repository
+    {
+    public:
+        virtual std::vector<package_identifier> get_updates(const package_database& database) = 0;
+        virtual std::vector<package_identifier> search_names(const std::string& architecture,
+                const std::string& needle) = 0;
+    };
 }
--- a/katja/sbo.cpp
+++ b/katja/sbo.cpp
@@ -3,14 +3,61 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
+module;
+
 #include <fstream>
+#include <string>
+#include <vector>
+#include <filesystem>
+#include <optional>
+#include <map>

 #include <boost/algorithm/string.hpp>

-#include "katja/sbo.hpp"
+export module katja.sbo;
+
+import katja.database;
+import katja.repository;

 namespace katja
 {
+    static
+    bool trim_info_line(std::string& info_value)
+    {
+        if (boost::algorithm::ends_with(info_value, "\""))
+        {
+            info_value.pop_back();
+            return false;
+        }
+        else if (boost::algorithm::ends_with(info_value, "\\"))
+        {
+            info_value.pop_back();
+            return true;
+        }
+        return false;
+    }
+
+    export struct info_file
+    {
+        const std::string program_name;
+        const std::string version;
+        const std::string homepage;
+        const std::string email;
+        const std::string maintainer;
+
+        info_file(const std::string& program_name, const std::string& version,
+                const std::string homepage, const std::string& email, const std::string& maintainer)
+            : program_name(program_name), version(version), homepage(homepage), email(email), maintainer(maintainer)
+        {
+        }
+
+        package_identifier identifier_for(const std::string& architecture)
+        {
+            return package_identifier{ this->program_name, this->version, architecture, "SBo" };
+        }
+    };
+    export std::optional<info_file> read_slackbuild_info(const std::filesystem::path& info_filepath);
+
    static
    void search_for_slackbuilds(std::map<std::string, std::filesystem::path>& info_files,
            const std::filesystem::path& directory)
@@ -50,24 +97,21 @@ namespace katja
            }
        }
    }
-
-    info_file::info_file(const std::string& program_name, const std::string& version,
-            const std::string homepage, const std::string& email, const std::string& maintainer)
-        : program_name(program_name), version(version), homepage(homepage), email(email), maintainer(maintainer)
-    {
 }

-    package_identifier info_file::identifier_for(const std::string& architecture)
+export namespace katja
 {
-        return package_identifier{ this->program_name, this->version, architecture, "SBo" };
-    }
+    class sbo_repository final : public repository
+    {
+        std::map<std::string, std::filesystem::path> info_paths;

-    sbo_repository::sbo_repository(const std::filesystem::path& repository_path)
+    public:
+        sbo_repository(const std::filesystem::path& repository_path)
        {
            search_for_slackbuilds(this->info_paths, repository_path);
        }

-    std::vector<package_identifier> sbo_repository::get_updates(const package_database& database)
+        std::vector<package_identifier> get_updates(const package_database& database) override
        {
            std::vector<package_identifier> identifiers;

@@ -88,8 +132,8 @@ namespace katja
            return identifiers;
        }

-    std::vector<package_identifier> sbo_repository::search_names(const std::string& architecture,
-            const std::string& needle)
+        std::vector<package_identifier> search_names(const std::string& architecture,
+                const std::string& needle) override
        {
            std::vector<package_identifier> identifiers;

@@ -104,22 +148,7 @@ namespace katja
            }
            return identifiers;
        }
-
-    static
-    bool trim_info_line(std::string& info_value)
-    {
-        if (boost::algorithm::ends_with(info_value, "\""))
-        {
-            info_value.pop_back();
-            return false;
-        }
-        else if (boost::algorithm::ends_with(info_value, "\\"))
-        {
-            info_value.pop_back();
-            return true;
-        }
-        return false;
-    }
+    };

    std::optional<info_file> read_slackbuild_info(const std::filesystem::path& info_filepath)
    {
--- a/tests/database.cpp
+++ b/tests/database.cpp
@@ -6,7 +6,7 @@
 #define BOOST_TEST_MODULE database tests

 #include <boost/test/unit_test.hpp>
-#include "katja/database.hpp"
+import katja.database;

 BOOST_AUTO_TEST_CASE(generate_package_identifier)
 {
--- a/tests/repository.cpp
+++ b/tests/repository.cpp
@@ -6,7 +6,7 @@
 #define BOOST_TEST_MODULE repository tests

 #include <boost/test/unit_test.hpp>
-#include "katja/repository.hpp"
+import katja.repository;

 BOOST_AUTO_TEST_CASE(construct_valid_database_package)
 {