From 46c7ab4a82cf220b47ee979266ee73bce126880c Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 28 Oct 2019 03:04:25 +0100 Subject: [PATCH 01/17] Reduce unnecessary indentation. --- src/cli/main.cpp | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/src/cli/main.cpp b/src/cli/main.cpp index f7e142c..e696280 100644 --- a/src/cli/main.cpp +++ b/src/cli/main.cpp @@ -50,21 +50,19 @@ int App::main(const std::vector &args) { return 0; } - else + + if (_argument_error) { - if (_argument_error) - { - return 1; - } - if (!args.empty()) - { - _uri = args[0]; - } - if (_uri.empty() && _format == export_format::undefined) - { - cerr << "Error: You have to specify either an URI or --export.\n"; - return 1; - } + return 1; + } + if (!args.empty()) + { + _uri = args[0]; + } + if (_uri.empty() && _format == export_format::undefined) + { + cerr << "Error: You have to specify either an URI or --export.\n"; + return 1; } Database db; From eb77d8fc75aa9af0979a0bf7ec173dd80be3046a Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 28 Oct 2019 06:46:08 +0100 Subject: [PATCH 02/17] Implement all special member functions for ExportBase. --- include/export/export.hpp | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/export/export.hpp b/include/export/export.hpp index 5802a1c..de13d2f 100644 --- a/include/export/export.hpp +++ b/include/export/export.hpp @@ -47,6 +47,11 @@ public: explicit ExportBase(const list &entries, ostream &out = cout); virtual ~ExportBase() = default; + ExportBase(const ExportBase &) = delete; + ExportBase &operator=(const ExportBase &) = delete; + ExportBase(ExportBase &&) = delete; + ExportBase &operator=(ExportBase &&) = delete; + /*! * @brief Print output to std::ostream. From ea585751fc6841294ffd498755c191959c52bb77 Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 28 Oct 2019 06:46:34 +0100 Subject: [PATCH 03/17] Fix typo in NOLINT-comment. --- src/lib/uri.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/uri.cpp b/src/lib/uri.cpp index 26fc179..c257dd0 100644 --- a/src/lib/uri.cpp +++ b/src/lib/uri.cpp @@ -93,7 +93,7 @@ void URI::set_proxy() proxy.host = matches[3]; if (!matches[4].empty()) { - // NOLINTNEXTLINE(google-runtime-lint) - Need to use same as stoul. + // NOLINTNEXTLINE(google-runtime-int) - Need to use same as stoul. const unsigned long port = std::stoul(matches[4]); if (port > 65535) { From e40140fb038b9686837d08022d0c5a67805665e9 Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 28 Oct 2019 06:46:58 +0100 Subject: [PATCH 04/17] Remove unnecessary const in function declaration. --- include/uri.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/uri.hpp b/include/uri.hpp index 54b2dce..c317f74 100644 --- a/include/uri.hpp +++ b/include/uri.hpp @@ -170,7 +170,7 @@ protected: * * @since 0.8.5 */ - string cut_text(const string &text, const uint16_t n_chars) const; + string cut_text(const string &text, uint16_t n_chars) const; }; } // namespace remwharead From bd60a4970d95ac41f865dd1b22f6eadb560fa6f1 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 04:46:15 +0100 Subject: [PATCH 05/17] Specify different indentation for CMake files in EditorConfig. --- .editorconfig | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 66c443a..ad5e59f 100644 --- a/.editorconfig +++ b/.editorconfig @@ -5,10 +5,16 @@ root = true [*] indent_style = space -indent_size = 4 -tab_width = 4 end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true max_line_length = 80 + +[*.?pp] +indent_size = 4 +tab_width = 4 + +[{CMakeLists.txt,*.cmake}] +indent_size = 2 +tab_width = 2 From 6ff101370ede84d2304776cd210451619c635f64 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 04:47:38 +0100 Subject: [PATCH 06/17] Require at least CMake 3.9. --- CMakeLists.txt | 12 ++++-------- README.adoc | 2 +- cmake/packages.cmake | 3 +-- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 8049415..e6c1f78 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ -# Support version 3.6 and above, but use policy settings up to 3.14. -# 3.6 is needed because of IMPORTED_TARGET in pkg_check_modules(). -cmake_minimum_required(VERSION 3.6...3.14) +# Support version 3.9 and above, but use policy settings up to 3.14. +# 3.9 is needed for project description. +cmake_minimum_required(VERSION 3.9...3.14) # Ranges are supported from 3.12, set policy to current for < 3.12. if(${CMAKE_VERSION} VERSION_LESS 3.12) cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) @@ -8,12 +8,8 @@ endif() project(remwharead VERSION 0.8.5 + DESCRIPTION "Saves URIs of things you want to remember in a database." LANGUAGES CXX) -# DESCRIPTION was introduced in version 3.9. -if(NOT (${CMAKE_VERSION} VERSION_LESS 3.9)) - set(PROJECT_DESCRIPTION - "Saves URIs of things you want to remember in a database.") -endif() include(GNUInstallDirs) diff --git a/README.adoc b/README.adoc index 35693e9..b9b60c6 100644 --- a/README.adoc +++ b/README.adoc @@ -77,7 +77,7 @@ only. * Tested OS: Linux * C++ compiler (tested: {uri-gcc}[gcc] 7/8/9, {uri-clang}[clang] 6/7) -* {uri-cmake}[cmake] (at least: 3.6) +* {uri-cmake}[cmake] (at least: 3.9) * {uri-poco}[POCO] (tested: 1.9 / 1.7) * Optional: ** Manpage: {uri-asciidoc}[asciidoc] (tested: 8.6) diff --git a/cmake/packages.cmake b/cmake/packages.cmake index 2f89eba..806fddc 100644 --- a/cmake/packages.cmake +++ b/cmake/packages.cmake @@ -3,8 +3,7 @@ set(CPACK_PACKAGE_VERSION_MAJOR ${${PROJECT_NAME}_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${${PROJECT_NAME}_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${${PROJECT_NAME}_VERSION_PATCH}) set(CPACK_PACKAGE_VERSION ${${PROJECT_NAME}_VERSION}) -set(CPACK_PACKAGE_DESCRIPTION_SUMMARY - "Saves URIs of things you want to remember in a database. ") +set(CPACK_PACKAGE_DESCRIPTION_SUMMARY ${PROJECT_DESCRIPTION}) set(CPACK_PACKAGE_CONTACT "tastytea ") set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE") set(CPACK_RESOURCE_FILE_README "${PROJECT_SOURCE_DIR}/README.adoc") From 3a30cedfb60881aacbc846c47f8154706bb5fbab Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 04:50:11 +0100 Subject: [PATCH 07/17] Fix indentation of root CMake recipe. --- CMakeLists.txt | 86 +++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index e6c1f78..72ed4a3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -28,53 +28,53 @@ set(CMAKE_CXX_EXTENSIONS OFF) set(DEBUG_CXXFLAGS "") # GCC >= 5.0 or Clang >= 5.0 is assumed. if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") + list(APPEND DEBUG_CXXFLAGS + "-Wall" + "-Wextra" + "-Wpedantic" + "-Wuninitialized" + "-Wshadow" + "-Wnon-virtual-dtor" + "-Wconversion" + "-Wsign-conversion" + "-Wold-style-cast" + "-Wzero-as-null-pointer-constant" + # "-Wmissing-declarations" + "-Wcast-align" + "-Wunused" + "-Woverloaded-virtual" + "-Wdouble-promotion" + "-Wformat=2" + "-ftrapv" + "-fsanitize=undefined" + "-g" + "-Og" + "-fno-omit-frame-pointer") + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") list(APPEND DEBUG_CXXFLAGS - "-Wall" - "-Wextra" - "-Wpedantic" - "-Wuninitialized" - "-Wshadow" - "-Wnon-virtual-dtor" - "-Wconversion" - "-Wsign-conversion" - "-Wold-style-cast" - "-Wzero-as-null-pointer-constant" - # "-Wmissing-declarations" - "-Wcast-align" - "-Wunused" - "-Woverloaded-virtual" - "-Wdouble-promotion" - "-Wformat=2" - "-ftrapv" - "-fsanitize=undefined" - "-g" - "-Og" - "-fno-omit-frame-pointer") - if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + "-Wlogical-op" + "-Wuseless-cast") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6") + list(APPEND DEBUG_CXXFLAGS + "-Wmisleading-indentation" + "-Wduplicated-cond" + "-Wnull-dereference") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "7") list(APPEND DEBUG_CXXFLAGS - "-Wlogical-op" - "-Wuseless-cast") - if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6") - list(APPEND DEBUG_CXXFLAGS - "-Wmisleading-indentation" - "-Wduplicated-cond" - "-Wnull-dereference") - if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "7") - list(APPEND DEBUG_CXXFLAGS - "-Wduplicated-branches") - endif() - endif() + "-Wduplicated-branches") + endif() endif() + endif() - set(DEBUG_LDFLAGS - "-fsanitize=undefined") - add_compile_options("$<$:${DEBUG_CXXFLAGS}>") - # add_link_options was introduced in version 3.13. - if(${CMAKE_VERSION} VERSION_LESS 3.13) - set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${DEBUG_LDFLAGS}") - else() - add_link_options("$<$:${DEBUG_LDFLAGS}>") - endif() + set(DEBUG_LDFLAGS + "-fsanitize=undefined") + add_compile_options("$<$:${DEBUG_CXXFLAGS}>") + # add_link_options was introduced in version 3.13. + if(${CMAKE_VERSION} VERSION_LESS 3.13) + set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${DEBUG_LDFLAGS}") + else() + add_link_options("$<$:${DEBUG_LDFLAGS}>") + endif() endif() add_subdirectory(src) From 6a9d96c208d59fec6bac694f8cd2d28005dd3aa4 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 04:58:59 +0100 Subject: [PATCH 08/17] Remove spaces betweeen `if` and `(` in root CMake file. --- CMakeLists.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 72ed4a3..df36c8a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -84,11 +84,11 @@ add_subdirectory(src/cli) add_subdirectory(pkg-config) add_subdirectory(cmake) -if (WITH_MAN) +if(WITH_MAN) add_subdirectory(man) endif() -if (WITH_MOZILLA) +if(WITH_MOZILLA) add_subdirectory(browser-plugins/webextension/native-wrapper) endif() From cada434f2b35663fccd5844636ca9cec9f2fc545 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 05:04:00 +0100 Subject: [PATCH 09/17] Default to Release build. --- CMakeLists.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index df36c8a..9abe4ef 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -20,6 +20,7 @@ option(WITH_MOZILLA "Build and install wrapper for Mozilla browsers." YES) option(BUILD_SHARED_LIBS "Build shared libraries." YES) set(MOZILLA_NMH_DIR "${CMAKE_INSTALL_LIBDIR}/mozilla/native-messaging-hosts" CACHE STRING "Directory for the Mozilla extension wrapper.") +set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.") set(CMAKE_CXX_STANDARD 14) set(CMAKE_CXX_STANDARD_REQUIRED ON) From 6b5a6c4b8586967285ad6cf3a6e62ef3f582ac49 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 05:26:48 +0100 Subject: [PATCH 10/17] Move debug compiler flags into CMake module. --- CMakeLists.txt | 54 +++----------------------------------- cmake/debug_flags.cmake | 58 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 51 deletions(-) create mode 100644 cmake/debug_flags.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 9abe4ef..a180288 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,6 +11,8 @@ project(remwharead DESCRIPTION "Saves URIs of things you want to remember in a database." LANGUAGES CXX) +set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") + include(GNUInstallDirs) # All custom build switches. @@ -26,57 +28,7 @@ set(CMAKE_CXX_STANDARD 14) set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF) -set(DEBUG_CXXFLAGS "") -# GCC >= 5.0 or Clang >= 5.0 is assumed. -if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") - list(APPEND DEBUG_CXXFLAGS - "-Wall" - "-Wextra" - "-Wpedantic" - "-Wuninitialized" - "-Wshadow" - "-Wnon-virtual-dtor" - "-Wconversion" - "-Wsign-conversion" - "-Wold-style-cast" - "-Wzero-as-null-pointer-constant" - # "-Wmissing-declarations" - "-Wcast-align" - "-Wunused" - "-Woverloaded-virtual" - "-Wdouble-promotion" - "-Wformat=2" - "-ftrapv" - "-fsanitize=undefined" - "-g" - "-Og" - "-fno-omit-frame-pointer") - if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") - list(APPEND DEBUG_CXXFLAGS - "-Wlogical-op" - "-Wuseless-cast") - if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6") - list(APPEND DEBUG_CXXFLAGS - "-Wmisleading-indentation" - "-Wduplicated-cond" - "-Wnull-dereference") - if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "7") - list(APPEND DEBUG_CXXFLAGS - "-Wduplicated-branches") - endif() - endif() - endif() - - set(DEBUG_LDFLAGS - "-fsanitize=undefined") - add_compile_options("$<$:${DEBUG_CXXFLAGS}>") - # add_link_options was introduced in version 3.13. - if(${CMAKE_VERSION} VERSION_LESS 3.13) - set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${DEBUG_LDFLAGS}") - else() - add_link_options("$<$:${DEBUG_LDFLAGS}>") - endif() -endif() +include(debug_flags) add_subdirectory(src) add_subdirectory(src/lib) diff --git a/cmake/debug_flags.cmake b/cmake/debug_flags.cmake new file mode 100644 index 0000000..976b611 --- /dev/null +++ b/cmake/debug_flags.cmake @@ -0,0 +1,58 @@ +# Set compiler flags for Debug builds. +# Only has an effect on GCC/Clang >= 5.0. + +set(DEBUG_CXXFLAGS "") +if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang" + AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5") + list(APPEND DEBUG_CXXFLAGS + "-Wall" + "-Wextra" + "-Wpedantic" + "-Wuninitialized" + "-Wshadow" + "-Wnon-virtual-dtor" + "-Wconversion" + "-Wsign-conversion" + "-Wold-style-cast" + "-Wzero-as-null-pointer-constant" + # "-Wmissing-declarations" + "-Wcast-align" + "-Wunused" + "-Woverloaded-virtual" + "-Wdouble-promotion" + "-Wformat=2" + "-ftrapv" + "-fsanitize=undefined" + "-g" + "-Og" + "-fno-omit-frame-pointer") + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + list(APPEND DEBUG_CXXFLAGS + "-Wlogical-op" + "-Wuseless-cast") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6") + list(APPEND DEBUG_CXXFLAGS + "-Wmisleading-indentation" + "-Wduplicated-cond" + "-Wnull-dereference") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "7") + list(APPEND DEBUG_CXXFLAGS + "-Wduplicated-branches") + endif() + endif() + endif() + add_compile_options("$<$:${DEBUG_CXXFLAGS}>") + + set(DEBUG_LDFLAGS + "-fsanitize=undefined") + # add_link_options was introduced in version 3.13. + if(${CMAKE_VERSION} VERSION_LESS 3.13) + set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${DEBUG_LDFLAGS}") + else() + add_link_options("$<$:${DEBUG_LDFLAGS}>") + endif() +else() + message(STATUS + "No additional compiler flags were set, " + "because your compiler was not anticipated.") +endif() From e8f015629640bf567ef7d4d5db41ad5eded5c991 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 06:54:40 +0100 Subject: [PATCH 11/17] Do not terminate before all threads are joined. --- src/cli/main.cpp | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/cli/main.cpp b/src/cli/main.cpp index e696280..d95f40b 100644 --- a/src/cli/main.cpp +++ b/src/cli/main.cpp @@ -87,12 +87,6 @@ int App::main(const std::vector &args) } html_extract page = uri.get(); - if (!page) - { - cerr << "Error: Could not fetch page.\n"; - cerr << page.error << endl; - return 3; - } if (_archive) { @@ -103,6 +97,13 @@ int App::main(const std::vector &args) } } + if (!page) + { + cerr << "Error: Could not fetch page.\n"; + cerr << page.error << endl; + return 3; + } + db.store({_uri, archive_data.uri, system_clock::now(), _tags, page.title, page.description, page.fulltext}); } From a5ec7609f92f16a1b9267bce71bf1fed044e66e2 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 07:47:39 +0100 Subject: [PATCH 12/17] Fix/supress clang-tidy warnings in Mozilla-wrapper. --- .../native-wrapper/remwharead_wrapper.cpp | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/browser-plugins/webextension/native-wrapper/remwharead_wrapper.cpp b/browser-plugins/webextension/native-wrapper/remwharead_wrapper.cpp index 172f2b1..31ddd99 100644 --- a/browser-plugins/webextension/native-wrapper/remwharead_wrapper.cpp +++ b/browser-plugins/webextension/native-wrapper/remwharead_wrapper.cpp @@ -27,7 +27,11 @@ using std::cout; using std::uint32_t; using std::system; -const string read_input() +string read_input(); +void send_message(const string &message); +int launch(const string &args); + +string read_input() { // Read message length. uint32_t length; @@ -55,7 +59,8 @@ const string read_input() void send_message(const string &message) { - const uint32_t length = static_cast(message.length() + 2); + const auto length = static_cast(message.length() + 2); + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) - Necessary. cout.write(reinterpret_cast(&length), sizeof(uint32_t)); cout << '"' << message << '"'; } @@ -63,10 +68,11 @@ void send_message(const string &message) int launch(const string &args) { const string cmd = "remwharead " + args + " 2>/dev/null"; + // NOLINTNEXTLINE(cert-env33-c) - We get the arguments in a string. int ret = system(cmd.c_str()); - if (WIFEXITED(ret)) + if (WIFEXITED(ret)) // NOLINT(hicpp-signed-bitwise) - Necessary. { - ret = WEXITSTATUS(ret); + ret = WEXITSTATUS(ret); // NOLINT(hicpp-signed-bitwise) - Necessary. } return ret; From 47d89ce01ab9eab4eb4a685ab1e939d2c0220704 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 07:48:50 +0100 Subject: [PATCH 13/17] Enable -Wmissing-declarations. --- cmake/debug_flags.cmake | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmake/debug_flags.cmake b/cmake/debug_flags.cmake index 976b611..0009039 100644 --- a/cmake/debug_flags.cmake +++ b/cmake/debug_flags.cmake @@ -15,7 +15,7 @@ if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang" "-Wsign-conversion" "-Wold-style-cast" "-Wzero-as-null-pointer-constant" - # "-Wmissing-declarations" + "-Wmissing-declarations" "-Wcast-align" "-Wunused" "-Woverloaded-virtual" From 382c35856eb7599fa8170d9db2d078ea61a5f4f7 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 07:49:12 +0100 Subject: [PATCH 14/17] Switch to C++17, but support g++-6 / clang++-6. --- CMakeLists.txt | 2 +- README.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index a180288..a59dfca 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -24,7 +24,7 @@ set(MOZILLA_NMH_DIR "${CMAKE_INSTALL_LIBDIR}/mozilla/native-messaging-hosts" CACHE STRING "Directory for the Mozilla extension wrapper.") set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.") -set(CMAKE_CXX_STANDARD 14) +set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF) diff --git a/README.adoc b/README.adoc index b9b60c6..494e266 100644 --- a/README.adoc +++ b/README.adoc @@ -76,7 +76,7 @@ only. ==== Dependencies * Tested OS: Linux -* C++ compiler (tested: {uri-gcc}[gcc] 7/8/9, {uri-clang}[clang] 6/7) +* C++ compiler ({uri-gcc}[gcc] 6+, {uri-clang}[clang] 6+) * {uri-cmake}[cmake] (at least: 3.9) * {uri-poco}[POCO] (tested: 1.9 / 1.7) * Optional: From 32cf647131e86d6654a98b3ec72813934f87b619 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 08:06:12 +0100 Subject: [PATCH 15/17] Nest namespaces. --- include/export/adoc.hpp | 7 ++----- include/export/bookmarks.hpp | 7 ++----- include/export/csv.hpp | 7 ++----- include/export/export.hpp | 7 ++----- include/export/json.hpp | 7 ++----- include/export/rss.hpp | 7 ++----- include/export/simple.hpp | 7 ++----- src/lib/export/export.cpp | 7 ++----- 8 files changed, 16 insertions(+), 40 deletions(-) diff --git a/include/export/adoc.hpp b/include/export/adoc.hpp index 3c3eb51..7eaf467 100644 --- a/include/export/adoc.hpp +++ b/include/export/adoc.hpp @@ -23,9 +23,7 @@ #include #include -namespace remwharead -{ -namespace Export +namespace remwharead::Export { using std::string; @@ -68,7 +66,6 @@ private: //! Get ISO-8601 time from Database::entry. string get_time(const Database::entry &entry) const; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_ADOC_HPP diff --git a/include/export/bookmarks.hpp b/include/export/bookmarks.hpp index 805b51f..98842d5 100644 --- a/include/export/bookmarks.hpp +++ b/include/export/bookmarks.hpp @@ -19,9 +19,7 @@ #include "export.hpp" -namespace remwharead -{ -namespace Export +namespace remwharead::Export { /*! * @brief Export as Netscape bookmark file. @@ -37,7 +35,6 @@ namespace Export void print() const override; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_BOOKMARKS_HPP diff --git a/include/export/csv.hpp b/include/export/csv.hpp index a0eaccd..8499835 100644 --- a/include/export/csv.hpp +++ b/include/export/csv.hpp @@ -20,9 +20,7 @@ #include "export.hpp" #include -namespace remwharead -{ -namespace Export +namespace remwharead::Export { using std::string; @@ -44,7 +42,6 @@ namespace Export //! replaces " with "". string quote(string field) const; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_CSV_HPP diff --git a/include/export/export.hpp b/include/export/export.hpp index de13d2f..0ecf9e0 100644 --- a/include/export/export.hpp +++ b/include/export/export.hpp @@ -21,9 +21,7 @@ #include #include -namespace remwharead -{ -namespace Export +namespace remwharead::Export { using std::list; using std::ostream; @@ -71,7 +69,6 @@ protected: */ list sort_entries(list entries) const; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_EXPORT_HPP diff --git a/include/export/json.hpp b/include/export/json.hpp index 68648dc..d7b26b8 100644 --- a/include/export/json.hpp +++ b/include/export/json.hpp @@ -20,9 +20,7 @@ #include "export.hpp" #include -namespace remwharead -{ -namespace Export +namespace remwharead::Export { using std::string; @@ -40,7 +38,6 @@ public: void print() const override; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_JSON_HPP diff --git a/include/export/rss.hpp b/include/export/rss.hpp index 9190d62..6d8e42a 100644 --- a/include/export/rss.hpp +++ b/include/export/rss.hpp @@ -20,9 +20,7 @@ #include #include "export.hpp" -namespace remwharead -{ -namespace Export +namespace remwharead::Export { using std::string; @@ -40,7 +38,6 @@ public: void print() const override; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_RSS_HPP diff --git a/include/export/simple.hpp b/include/export/simple.hpp index e8f1cc3..918b177 100644 --- a/include/export/simple.hpp +++ b/include/export/simple.hpp @@ -19,9 +19,7 @@ #include "export.hpp" -namespace remwharead -{ -namespace Export +namespace remwharead::Export { /*! * @brief Export as simple list. @@ -36,7 +34,6 @@ public: using ExportBase::ExportBase; void print() const override; }; -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export #endif // REMWHAREAD_EXPORT_SIMPLE_HPP diff --git a/src/lib/export/export.cpp b/src/lib/export/export.cpp index 1128e98..745a4ef 100644 --- a/src/lib/export/export.cpp +++ b/src/lib/export/export.cpp @@ -17,9 +17,7 @@ #include "export/export.hpp" #include -namespace remwharead -{ -namespace Export +namespace remwharead::Export { ExportBase::ExportBase(const list &entries, ostream &out) : _entries(sort_entries(entries)) @@ -37,5 +35,4 @@ ExportBase::sort_entries(list entries) const return entries; } -} // namespace Export -} // namespace remwharead +} // namespace remwharead::Export From 37f6da67105e6d9f7ef76bf3d4946fc8bcdcc986 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 30 Oct 2019 08:51:07 +0100 Subject: [PATCH 16/17] [[nodiscard]] all the functions. --- include/export/adoc.hpp | 6 ++++++ include/export/csv.hpp | 1 + include/export/export.hpp | 1 + include/search.hpp | 5 +++++ include/sqlite.hpp | 3 +++ include/time.hpp | 2 ++ include/uri.hpp | 24 +++++++++++++++++------- src/lib/uri.cpp | 12 ++++++------ 8 files changed, 41 insertions(+), 13 deletions(-) diff --git a/include/export/adoc.hpp b/include/export/adoc.hpp index 7eaf467..7d8a984 100644 --- a/include/export/adoc.hpp +++ b/include/export/adoc.hpp @@ -46,24 +46,30 @@ private: using replacemap = const std::map; //! Replace strings in text. + [[nodiscard]] string replace(string text, const replacemap &replacements) const; //! Replaces characters in tags that asciidoctor doesn't like. + [[nodiscard]] string replace_in_tag(const string &text) const; //! Replaces characters in title that asciidoctor doesn't like. + [[nodiscard]] string replace_in_title(const string &text) const; //! Replaces characters in URI that asciidoctor doesn't like. + [[nodiscard]] string replace_in_uri(const string &text) const; //! Print things sorted by tag. void print_tags(const tagmap &tags) const; //! Get ISO-8601 day from Database::entry. + [[nodiscard]] string get_day(const Database::entry &entry) const; //! Get ISO-8601 time from Database::entry. + [[nodiscard]] string get_time(const Database::entry &entry) const; }; } // namespace remwharead::Export diff --git a/include/export/csv.hpp b/include/export/csv.hpp index 8499835..7810185 100644 --- a/include/export/csv.hpp +++ b/include/export/csv.hpp @@ -40,6 +40,7 @@ namespace remwharead::Export private: //! replaces " with "". + [[nodiscard]] string quote(string field) const; }; } // namespace remwharead::Export diff --git a/include/export/export.hpp b/include/export/export.hpp index 0ecf9e0..b4528ae 100644 --- a/include/export/export.hpp +++ b/include/export/export.hpp @@ -67,6 +67,7 @@ protected: * * @return Sorted list of Database::entry. */ + [[nodiscard]] list sort_entries(list entries) const; }; } // namespace remwharead::Export diff --git a/include/search.hpp b/include/search.hpp index 25a4a6d..3a935b9 100644 --- a/include/search.hpp +++ b/include/search.hpp @@ -57,6 +57,7 @@ public: * * @since 0.7.0 */ + [[nodiscard]] list search_tags(const string &expression, bool is_re) const; @@ -72,6 +73,7 @@ public: * * @since 0.7.0 */ + [[nodiscard]] list search_all(const string &expression, bool is_re) const; @@ -89,6 +91,7 @@ public: * @since 0.7.2 */ // TODO(tastytea): Think of something more elegant. + [[nodiscard]] list search_all_threaded(const string &expression, bool is_re) const; @@ -106,6 +109,7 @@ private: * * @since 0.7.0 */ + [[nodiscard]] vector> parse_expression(const string &expression) const; /*! @@ -113,6 +117,7 @@ private: * * @since 0.7.0 */ + [[nodiscard]] inline string to_lowercase(const string &str) const; }; } // namespace remwharead diff --git a/include/sqlite.hpp b/include/sqlite.hpp index d341683..f91cea9 100644 --- a/include/sqlite.hpp +++ b/include/sqlite.hpp @@ -75,6 +75,7 @@ public: * * @since 0.6.0 */ + [[nodiscard]] string fulltext_oneline() const; }; @@ -104,6 +105,7 @@ public: * * @since 0.6.0 */ + [[nodiscard]] list retrieve(const time_point &start = time_point(), const time_point &end = system_clock::now()) const; @@ -112,6 +114,7 @@ private: std::unique_ptr _session; bool _connected; + [[nodiscard]] fs::path get_data_home() const; }; } // namespace remwharead diff --git a/include/time.hpp b/include/time.hpp index e5fdb84..ce696e4 100644 --- a/include/time.hpp +++ b/include/time.hpp @@ -36,6 +36,7 @@ using time_point = system_clock::time_point; * @param strtime Time string in ISO 8601 or SQLite format. * @param sqlite Is the string in SQLite format? */ +[[nodiscard]] time_point string_to_timepoint(const string &strtime, bool sqlite = false); /*! @@ -46,6 +47,7 @@ time_point string_to_timepoint(const string &strtime, bool sqlite = false); * @param time_point The std::chrono::system_clock::time_point. * @param sqlite Is the string in SQLite format? */ +[[nodiscard]] string timepoint_to_string(const time_point &tp, bool sqlite = false); } // namespace remwharead diff --git a/include/uri.hpp b/include/uri.hpp index c317f74..8d2c5f1 100644 --- a/include/uri.hpp +++ b/include/uri.hpp @@ -94,13 +94,15 @@ public: * * @since 0.6.0 */ + [[nodiscard]] html_extract get(); /*! * @brief Save %URI in archive and return archive-URI. * * @since 0.6.0 - */ + */ + [[nodiscard]] archive_answer archive() const; protected: @@ -111,6 +113,7 @@ protected: * * @since 0.6.0 */ + [[nodiscard]] string make_request(const string &uri, bool archive = false) const; /*! @@ -118,21 +121,24 @@ protected: * * @since 0.6.0 */ - string extract_title(const string &html); + [[nodiscard]] + string extract_title(const string &html) const; /*! * @brief Extract the description from an HTML page. * * @since 0.6.0 */ - string extract_description(const string &html); + [[nodiscard]] + string extract_description(const string &html) const; /*! * @brief Removes HTML tags and superflous spaces from an HTML page. * * @since 0.6.0 */ - string strip_html(const string &html); + [[nodiscard]] + string strip_html(const string &html) const; /*! * @brief Remove HTML tags. @@ -142,21 +148,24 @@ protected: * * @since 0.6.0 */ - string remove_html_tags(const string &html, const string &tag = ""); + [[nodiscard]] + string remove_html_tags(const string &html, const string &tag = "") const; /*! * @brief Convert HTML entities to UTF-8. * * @since 0.6.0 */ - string unescape_html(string html); + [[nodiscard]] + string unescape_html(string html) const; /*! * @brief Replace newlines with spaces. * * @since 0.6.0 */ - string remove_newlines(string text); + [[nodiscard]] + string remove_newlines(string text) const; /*! * @brief Set proxy server. @@ -170,6 +179,7 @@ protected: * * @since 0.8.5 */ + [[nodiscard]] string cut_text(const string &text, uint16_t n_chars) const; }; } // namespace remwharead diff --git a/src/lib/uri.cpp b/src/lib/uri.cpp index c257dd0..4328b7b 100644 --- a/src/lib/uri.cpp +++ b/src/lib/uri.cpp @@ -224,7 +224,7 @@ string URI::make_request(const string &uri, bool archive) const } } -string URI::extract_title(const string &html) +string URI::extract_title(const string &html) const { const RegEx re_htmlfile(".*\\.(.?html?|xml|rss)$", RegEx::RE_CASELESS); if (_uri.substr(0, 4) == "http" || re_htmlfile.match(_uri)) @@ -241,7 +241,7 @@ string URI::extract_title(const string &html) return ""; } -string URI::extract_description(const string &html) +string URI::extract_description(const string &html) const { const RegEx re_htmlfile(".*\\.(.?html?|xml|rss)$", RegEx::RE_CASELESS); if (_uri.substr(0, 4) == "http" || re_htmlfile.match(_uri)) @@ -259,7 +259,7 @@ string URI::extract_description(const string &html) return ""; } -string URI::strip_html(const string &html) +string URI::strip_html(const string &html) const { string out; @@ -280,7 +280,7 @@ string URI::strip_html(const string &html) return unescape_html(out); } -string URI::remove_html_tags(const string &html, const string &tag) +string URI::remove_html_tags(const string &html, const string &tag) const { // NOTE: I did this with regex_replace before, but libstdc++ segfaulted. string out; @@ -318,7 +318,7 @@ string URI::remove_html_tags(const string &html, const string &tag) return out; } -string URI::unescape_html(string html) +string URI::unescape_html(string html) const { // Used to convert int to utf-8 char. std::wstring_convert, char32_t> u8c; @@ -642,7 +642,7 @@ archive_answer URI::archive() const return { false, "Unknown error.", "" }; } -string URI::remove_newlines(string text) +string URI::remove_newlines(string text) const { size_t posn = 0; while ((posn = text.find('\n', posn)) != std::string::npos) From 693580a44af37809e29a7fdd0fe3f615a237362f Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 6 Nov 2019 12:06:37 +0100 Subject: [PATCH 17/17] Add support for Hunter package manager. --- CMakeLists.txt | 44 +++- README.adoc | 2 + cmake/Hunter/config.cmake | 3 + cmake/HunterGate.cmake | 539 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 582 insertions(+), 6 deletions(-) create mode 100644 cmake/Hunter/config.cmake create mode 100644 cmake/HunterGate.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index a59dfca..7f91bed 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,23 +6,55 @@ if(${CMAKE_VERSION} VERSION_LESS 3.12) cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) endif() +# Global build options. +set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.") +option(BUILD_SHARED_LIBS "Build shared libraries." YES) +option(HUNTER_ENABLED "Use the Hunter package manager" NO) + +if(${HUNTER_ENABLED}) + set(BUILD_SHARED_LIBS "NO") + set(HUNTER_PocoCpp_CMAKE_ARGS + ENABLE_CRYPTO=ON + ENABLE_DATA=ON + ENABLE_JSON=ON + ENABLE_NET=ON + ENABLE_NETSSL=ON + ENABLE_SQL_SQLITE=ON + ENABLE_UTIL=ON + ENABLE_XML=ON) + + # FetchContent_MakeAvailable needs 3.14. + if(NOT (${CMAKE_VERSION} VERSION_LESS 3.14)) + set(HUNTER_PACKAGES PocoCpp) + include(FetchContent) + FetchContent_Declare(SetupHunter GIT_REPOSITORY https://github.com/cpp-pm/gate) + FetchContent_MakeAvailable(SetupHunter) + else() + include("cmake/HunterGate.cmake") + HunterGate( + URL "https://github.com/cpp-pm/hunter/archive/v0.23.225.tar.gz" + SHA1 "4b018ec7b673817475c1fb9f0bd4dfb7c5e7f343" + LOCAL) # Load cmake/Hunter/config.cmake. + endif() +endif() + project(remwharead VERSION 0.8.5 - DESCRIPTION "Saves URIs of things you want to remember in a database." - LANGUAGES CXX) + DESCRIPTION "Saves URIs of things you want to remember in a database.") + +if(${HUNTER_ENABLED} AND ${CMAKE_VERSION} VERSION_LESS 3.14) + hunter_add_package(PocoCpp) +endif() set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") - include(GNUInstallDirs) -# All custom build switches. +# Project build options. option(WITH_MAN "Compile and install manpage." YES) option(WITH_TESTS "Compile tests." NO) option(WITH_MOZILLA "Build and install wrapper for Mozilla browsers." YES) -option(BUILD_SHARED_LIBS "Build shared libraries." YES) set(MOZILLA_NMH_DIR "${CMAKE_INSTALL_LIBDIR}/mozilla/native-messaging-hosts" CACHE STRING "Directory for the Mozilla extension wrapper.") -set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.") set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) diff --git a/README.adoc b/README.adoc index 494e266..147094a 100644 --- a/README.adoc +++ b/README.adoc @@ -19,6 +19,7 @@ :uri-rpm: http://www.rpm.org/ :uri-ff-addon: https://addons.mozilla.org/firefox/addon/remwharead :uri-papirus: https://github.com/PapirusDevelopmentTeam/papirus-icon-theme +:uri-hunter: https://github.com/cpp-pm/hunter *remwharead* saves URIs of things you want to remember in a database along with an URI to the archived version, the current date and time, title, description, @@ -124,6 +125,7 @@ cmake --build . * `-DMOZILLA_NMH_DIR` lets you set the directory for the Mozilla extension wrapper. The complete path is `${CMAKE_INSTALL_PREFIX}/${MOZILLA_NMH_DIR}`. +* `-DHUNTER_ENABLED=YES` to use the package manager link:{uri-hunter}[Hunter]. * One of: ** `-DWITH_DEB=YES` if you want to be able to generate a deb-package. ** `-DWITH_RPM=YES` if you want to be able to generate an rpm-package. diff --git a/cmake/Hunter/config.cmake b/cmake/Hunter/config.cmake new file mode 100644 index 0000000..9301c0d --- /dev/null +++ b/cmake/Hunter/config.cmake @@ -0,0 +1,3 @@ +hunter_config(PocoCpp + VERSION ${HUNTER_PocoCpp_VERSION} + CMAKE_ARGS ${HUNTER_PocoCpp_CMAKE_ARGS}) diff --git a/cmake/HunterGate.cmake b/cmake/HunterGate.cmake new file mode 100644 index 0000000..6d9cc24 --- /dev/null +++ b/cmake/HunterGate.cmake @@ -0,0 +1,539 @@ +# Copyright (c) 2013-2019, Ruslan Baratov +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# This is a gate file to Hunter package manager. +# Include this file using `include` command and add package you need, example: +# +# cmake_minimum_required(VERSION 3.2) +# +# include("cmake/HunterGate.cmake") +# HunterGate( +# URL "https://github.com/path/to/hunter/archive.tar.gz" +# SHA1 "798501e983f14b28b10cda16afa4de69eee1da1d" +# ) +# +# project(MyProject) +# +# hunter_add_package(Foo) +# hunter_add_package(Boo COMPONENTS Bar Baz) +# +# Projects: +# * https://github.com/hunter-packages/gate/ +# * https://github.com/ruslo/hunter + +option(HUNTER_ENABLED "Enable Hunter package manager support" ON) + +if(HUNTER_ENABLED) + if(CMAKE_VERSION VERSION_LESS "3.2") + message( + FATAL_ERROR + "At least CMake version 3.2 required for Hunter dependency management." + " Update CMake or set HUNTER_ENABLED to OFF." + ) + endif() +endif() + +include(CMakeParseArguments) # cmake_parse_arguments + +option(HUNTER_STATUS_PRINT "Print working status" ON) +option(HUNTER_STATUS_DEBUG "Print a lot info" OFF) +option(HUNTER_TLS_VERIFY "Enable/disable TLS certificate checking on downloads" ON) + +set(HUNTER_ERROR_PAGE "https://docs.hunter.sh/en/latest/reference/errors") + +function(hunter_gate_status_print) + if(HUNTER_STATUS_PRINT OR HUNTER_STATUS_DEBUG) + foreach(print_message ${ARGV}) + message(STATUS "[hunter] ${print_message}") + endforeach() + endif() +endfunction() + +function(hunter_gate_status_debug) + if(HUNTER_STATUS_DEBUG) + foreach(print_message ${ARGV}) + string(TIMESTAMP timestamp) + message(STATUS "[hunter *** DEBUG *** ${timestamp}] ${print_message}") + endforeach() + endif() +endfunction() + +function(hunter_gate_error_page error_page) + message("------------------------------ ERROR ------------------------------") + message(" ${HUNTER_ERROR_PAGE}/${error_page}.html") + message("-------------------------------------------------------------------") + message("") + message(FATAL_ERROR "") +endfunction() + +function(hunter_gate_internal_error) + message("") + foreach(print_message ${ARGV}) + message("[hunter ** INTERNAL **] ${print_message}") + endforeach() + message("[hunter ** INTERNAL **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") + message("") + hunter_gate_error_page("error.internal") +endfunction() + +function(hunter_gate_fatal_error) + cmake_parse_arguments(hunter "" "ERROR_PAGE" "" "${ARGV}") + if("${hunter_ERROR_PAGE}" STREQUAL "") + hunter_gate_internal_error("Expected ERROR_PAGE") + endif() + message("") + foreach(x ${hunter_UNPARSED_ARGUMENTS}) + message("[hunter ** FATAL ERROR **] ${x}") + endforeach() + message("[hunter ** FATAL ERROR **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") + message("") + hunter_gate_error_page("${hunter_ERROR_PAGE}") +endfunction() + +function(hunter_gate_user_error) + hunter_gate_fatal_error(${ARGV} ERROR_PAGE "error.incorrect.input.data") +endfunction() + +function(hunter_gate_self root version sha1 result) + string(COMPARE EQUAL "${root}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("root is empty") + endif() + + string(COMPARE EQUAL "${version}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("version is empty") + endif() + + string(COMPARE EQUAL "${sha1}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("sha1 is empty") + endif() + + string(SUBSTRING "${sha1}" 0 7 archive_id) + + if(EXISTS "${root}/cmake/Hunter") + set(hunter_self "${root}") + else() + set( + hunter_self + "${root}/_Base/Download/Hunter/${version}/${archive_id}/Unpacked" + ) + endif() + + set("${result}" "${hunter_self}" PARENT_SCOPE) +endfunction() + +# Set HUNTER_GATE_ROOT cmake variable to suitable value. +function(hunter_gate_detect_root) + # Check CMake variable + string(COMPARE NOTEQUAL "${HUNTER_ROOT}" "" not_empty) + if(not_empty) + set(HUNTER_GATE_ROOT "${HUNTER_ROOT}" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT detected by cmake variable") + return() + endif() + + # Check environment variable + string(COMPARE NOTEQUAL "$ENV{HUNTER_ROOT}" "" not_empty) + if(not_empty) + set(HUNTER_GATE_ROOT "$ENV{HUNTER_ROOT}" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT detected by environment variable") + return() + endif() + + # Check HOME environment variable + string(COMPARE NOTEQUAL "$ENV{HOME}" "" result) + if(result) + set(HUNTER_GATE_ROOT "$ENV{HOME}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT set using HOME environment variable") + return() + endif() + + # Check SYSTEMDRIVE and USERPROFILE environment variable (windows only) + if(WIN32) + string(COMPARE NOTEQUAL "$ENV{SYSTEMDRIVE}" "" result) + if(result) + set(HUNTER_GATE_ROOT "$ENV{SYSTEMDRIVE}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug( + "HUNTER_ROOT set using SYSTEMDRIVE environment variable" + ) + return() + endif() + + string(COMPARE NOTEQUAL "$ENV{USERPROFILE}" "" result) + if(result) + set(HUNTER_GATE_ROOT "$ENV{USERPROFILE}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug( + "HUNTER_ROOT set using USERPROFILE environment variable" + ) + return() + endif() + endif() + + hunter_gate_fatal_error( + "Can't detect HUNTER_ROOT" + ERROR_PAGE "error.detect.hunter.root" + ) +endfunction() + +function(hunter_gate_download dir) + string( + COMPARE + NOTEQUAL + "$ENV{HUNTER_DISABLE_AUTOINSTALL}" + "" + disable_autoinstall + ) + if(disable_autoinstall AND NOT HUNTER_RUN_INSTALL) + hunter_gate_fatal_error( + "Hunter not found in '${dir}'" + "Set HUNTER_RUN_INSTALL=ON to auto-install it from '${HUNTER_GATE_URL}'" + "Settings:" + " HUNTER_ROOT: ${HUNTER_GATE_ROOT}" + " HUNTER_SHA1: ${HUNTER_GATE_SHA1}" + ERROR_PAGE "error.run.install" + ) + endif() + string(COMPARE EQUAL "${dir}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("Empty 'dir' argument") + endif() + + string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("HUNTER_GATE_SHA1 empty") + endif() + + string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("HUNTER_GATE_URL empty") + endif() + + set(done_location "${dir}/DONE") + set(sha1_location "${dir}/SHA1") + + set(build_dir "${dir}/Build") + set(cmakelists "${dir}/CMakeLists.txt") + + hunter_gate_status_debug("Locking directory: ${dir}") + file(LOCK "${dir}" DIRECTORY GUARD FUNCTION) + hunter_gate_status_debug("Lock done") + + if(EXISTS "${done_location}") + # while waiting for lock other instance can do all the job + hunter_gate_status_debug("File '${done_location}' found, skip install") + return() + endif() + + file(REMOVE_RECURSE "${build_dir}") + file(REMOVE_RECURSE "${cmakelists}") + + file(MAKE_DIRECTORY "${build_dir}") # check directory permissions + + # Disabling languages speeds up a little bit, reduces noise in the output + # and avoids path too long windows error + file( + WRITE + "${cmakelists}" + "cmake_minimum_required(VERSION 3.2)\n" + "project(HunterDownload LANGUAGES NONE)\n" + "include(ExternalProject)\n" + "ExternalProject_Add(\n" + " Hunter\n" + " URL\n" + " \"${HUNTER_GATE_URL}\"\n" + " URL_HASH\n" + " SHA1=${HUNTER_GATE_SHA1}\n" + " DOWNLOAD_DIR\n" + " \"${dir}\"\n" + " TLS_VERIFY\n" + " ${HUNTER_TLS_VERIFY}\n" + " SOURCE_DIR\n" + " \"${dir}/Unpacked\"\n" + " CONFIGURE_COMMAND\n" + " \"\"\n" + " BUILD_COMMAND\n" + " \"\"\n" + " INSTALL_COMMAND\n" + " \"\"\n" + ")\n" + ) + + if(HUNTER_STATUS_DEBUG) + set(logging_params "") + else() + set(logging_params OUTPUT_QUIET) + endif() + + hunter_gate_status_debug("Run generate") + + # Need to add toolchain file too. + # Otherwise on Visual Studio + MDD this will fail with error: + # "Could not find an appropriate version of the Windows 10 SDK installed on this machine" + if(EXISTS "${CMAKE_TOOLCHAIN_FILE}") + get_filename_component(absolute_CMAKE_TOOLCHAIN_FILE "${CMAKE_TOOLCHAIN_FILE}" ABSOLUTE) + set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=${absolute_CMAKE_TOOLCHAIN_FILE}") + else() + # 'toolchain_arg' can't be empty + set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=") + endif() + + string(COMPARE EQUAL "${CMAKE_MAKE_PROGRAM}" "" no_make) + if(no_make) + set(make_arg "") + else() + # Test case: remove Ninja from PATH but set it via CMAKE_MAKE_PROGRAM + set(make_arg "-DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}") + endif() + + execute_process( + COMMAND + "${CMAKE_COMMAND}" + "-H${dir}" + "-B${build_dir}" + "-G${CMAKE_GENERATOR}" + "${toolchain_arg}" + ${make_arg} + WORKING_DIRECTORY "${dir}" + RESULT_VARIABLE download_result + ${logging_params} + ) + + if(NOT download_result EQUAL 0) + hunter_gate_internal_error( + "Configure project failed." + "To reproduce the error run: ${CMAKE_COMMAND} -H${dir} -B${build_dir} -G${CMAKE_GENERATOR} ${toolchain_arg} ${make_arg}" + "In directory ${dir}" + ) + endif() + + hunter_gate_status_print( + "Initializing Hunter workspace (${HUNTER_GATE_SHA1})" + " ${HUNTER_GATE_URL}" + " -> ${dir}" + ) + execute_process( + COMMAND "${CMAKE_COMMAND}" --build "${build_dir}" + WORKING_DIRECTORY "${dir}" + RESULT_VARIABLE download_result + ${logging_params} + ) + + if(NOT download_result EQUAL 0) + hunter_gate_internal_error("Build project failed") + endif() + + file(REMOVE_RECURSE "${build_dir}") + file(REMOVE_RECURSE "${cmakelists}") + + file(WRITE "${sha1_location}" "${HUNTER_GATE_SHA1}") + file(WRITE "${done_location}" "DONE") + + hunter_gate_status_debug("Finished") +endfunction() + +# Must be a macro so master file 'cmake/Hunter' can +# apply all variables easily just by 'include' command +# (otherwise PARENT_SCOPE magic needed) +macro(HunterGate) + if(HUNTER_GATE_DONE) + # variable HUNTER_GATE_DONE set explicitly for external project + # (see `hunter_download`) + set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) + endif() + + # First HunterGate command will init Hunter, others will be ignored + get_property(_hunter_gate_done GLOBAL PROPERTY HUNTER_GATE_DONE SET) + + if(NOT HUNTER_ENABLED) + # Empty function to avoid error "unknown function" + function(hunter_add_package) + endfunction() + + set( + _hunter_gate_disabled_mode_dir + "${CMAKE_CURRENT_LIST_DIR}/cmake/Hunter/disabled-mode" + ) + if(EXISTS "${_hunter_gate_disabled_mode_dir}") + hunter_gate_status_debug( + "Adding \"disabled-mode\" modules: ${_hunter_gate_disabled_mode_dir}" + ) + list(APPEND CMAKE_PREFIX_PATH "${_hunter_gate_disabled_mode_dir}") + endif() + elseif(_hunter_gate_done) + hunter_gate_status_debug("Secondary HunterGate (use old settings)") + hunter_gate_self( + "${HUNTER_CACHED_ROOT}" + "${HUNTER_VERSION}" + "${HUNTER_SHA1}" + _hunter_self + ) + include("${_hunter_self}/cmake/Hunter") + else() + set(HUNTER_GATE_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}") + + string(COMPARE NOTEQUAL "${PROJECT_NAME}" "" _have_project_name) + if(_have_project_name) + hunter_gate_fatal_error( + "Please set HunterGate *before* 'project' command. " + "Detected project: ${PROJECT_NAME}" + ERROR_PAGE "error.huntergate.before.project" + ) + endif() + + cmake_parse_arguments( + HUNTER_GATE "LOCAL" "URL;SHA1;GLOBAL;FILEPATH" "" ${ARGV} + ) + + string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" _empty_sha1) + string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" _empty_url) + string( + COMPARE + NOTEQUAL + "${HUNTER_GATE_UNPARSED_ARGUMENTS}" + "" + _have_unparsed + ) + string(COMPARE NOTEQUAL "${HUNTER_GATE_GLOBAL}" "" _have_global) + string(COMPARE NOTEQUAL "${HUNTER_GATE_FILEPATH}" "" _have_filepath) + + if(_have_unparsed) + hunter_gate_user_error( + "HunterGate unparsed arguments: ${HUNTER_GATE_UNPARSED_ARGUMENTS}" + ) + endif() + if(_empty_sha1) + hunter_gate_user_error("SHA1 suboption of HunterGate is mandatory") + endif() + if(_empty_url) + hunter_gate_user_error("URL suboption of HunterGate is mandatory") + endif() + if(_have_global) + if(HUNTER_GATE_LOCAL) + hunter_gate_user_error("Unexpected LOCAL (already has GLOBAL)") + endif() + if(_have_filepath) + hunter_gate_user_error("Unexpected FILEPATH (already has GLOBAL)") + endif() + endif() + if(HUNTER_GATE_LOCAL) + if(_have_global) + hunter_gate_user_error("Unexpected GLOBAL (already has LOCAL)") + endif() + if(_have_filepath) + hunter_gate_user_error("Unexpected FILEPATH (already has LOCAL)") + endif() + endif() + if(_have_filepath) + if(_have_global) + hunter_gate_user_error("Unexpected GLOBAL (already has FILEPATH)") + endif() + if(HUNTER_GATE_LOCAL) + hunter_gate_user_error("Unexpected LOCAL (already has FILEPATH)") + endif() + endif() + + hunter_gate_detect_root() # set HUNTER_GATE_ROOT + + # Beautify path, fix probable problems with windows path slashes + get_filename_component( + HUNTER_GATE_ROOT "${HUNTER_GATE_ROOT}" ABSOLUTE + ) + hunter_gate_status_debug("HUNTER_ROOT: ${HUNTER_GATE_ROOT}") + if(NOT HUNTER_ALLOW_SPACES_IN_PATH) + string(FIND "${HUNTER_GATE_ROOT}" " " _contain_spaces) + if(NOT _contain_spaces EQUAL -1) + hunter_gate_fatal_error( + "HUNTER_ROOT (${HUNTER_GATE_ROOT}) contains spaces." + "Set HUNTER_ALLOW_SPACES_IN_PATH=ON to skip this error" + "(Use at your own risk!)" + ERROR_PAGE "error.spaces.in.hunter.root" + ) + endif() + endif() + + string( + REGEX + MATCH + "[0-9]+\\.[0-9]+\\.[0-9]+[-_a-z0-9]*" + HUNTER_GATE_VERSION + "${HUNTER_GATE_URL}" + ) + string(COMPARE EQUAL "${HUNTER_GATE_VERSION}" "" _is_empty) + if(_is_empty) + set(HUNTER_GATE_VERSION "unknown") + endif() + + hunter_gate_self( + "${HUNTER_GATE_ROOT}" + "${HUNTER_GATE_VERSION}" + "${HUNTER_GATE_SHA1}" + _hunter_self + ) + + set(_master_location "${_hunter_self}/cmake/Hunter") + if(EXISTS "${HUNTER_GATE_ROOT}/cmake/Hunter") + # Hunter downloaded manually (e.g. by 'git clone') + set(_unused "xxxxxxxxxx") + set(HUNTER_GATE_SHA1 "${_unused}") + set(HUNTER_GATE_VERSION "${_unused}") + else() + get_filename_component(_archive_id_location "${_hunter_self}/.." ABSOLUTE) + set(_done_location "${_archive_id_location}/DONE") + set(_sha1_location "${_archive_id_location}/SHA1") + + # Check Hunter already downloaded by HunterGate + if(NOT EXISTS "${_done_location}") + hunter_gate_download("${_archive_id_location}") + endif() + + if(NOT EXISTS "${_done_location}") + hunter_gate_internal_error("hunter_gate_download failed") + endif() + + if(NOT EXISTS "${_sha1_location}") + hunter_gate_internal_error("${_sha1_location} not found") + endif() + file(READ "${_sha1_location}" _sha1_value) + string(COMPARE EQUAL "${_sha1_value}" "${HUNTER_GATE_SHA1}" _is_equal) + if(NOT _is_equal) + hunter_gate_internal_error( + "Short SHA1 collision:" + " ${_sha1_value} (from ${_sha1_location})" + " ${HUNTER_GATE_SHA1} (HunterGate)" + ) + endif() + if(NOT EXISTS "${_master_location}") + hunter_gate_user_error( + "Master file not found:" + " ${_master_location}" + "try to update Hunter/HunterGate" + ) + endif() + endif() + include("${_master_location}") + set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) + endif() +endmacro()