Merge pull request #54 from contour-terminal/improvement/eradicate-gsl-dependency

Remove use of gsl::span to reduce dependencies (Microsoft.GSL).

Author: christianparpart

Changelog.md

@@ -6,6 +6,7 @@
 - Add access to the assigned name of a codepoint.
 - unicode-query: Now also prints name and age properties.
 - CMake install target also installs header and library (not just tools).
+- Reduce number of dependencies down to fmtlib and (for unit tests) Catch2.
 
 ## 0.1.0 (2022-11-03)
 

cmake/ThirdParties.cmake

@@ -49,33 +49,11 @@ else()
     set(THIRDPARTY_BUILTIN_fmt "system package")
 endif()
 
-if(TARGET GSL)
-    set(THIRDPARTY_BUILTIN_GSL "embedded")
-else()
-    set(THIRDPARTY_BUILTIN_GSL "system package")
-    if (WIN32)
-        # On Windows we use vcpkg and there the name is different
-        find_package(Microsoft.GSL CONFIG REQUIRED)
-        #target_link_libraries(main PRIVATE Microsoft.GSL::GSL)
-    else()
-        find_package(Microsoft.GSL REQUIRED)
-    endif()
-endif()
-
-if (TARGET range-v3)
-    set(THIRDPARTY_BUILTIN_range_v3 "embedded")
-else()
-    find_package(range-v3 REQUIRED)
-    set(THIRDPARTY_BUILTIN_range_v3 "system package")
-endif()
-
 macro(ThirdPartiesSummary2)
     message(STATUS "==============================================================================")
     message(STATUS "    ThirdParties")
     message(STATUS "------------------------------------------------------------------------------")
     message(STATUS "Catch2              ${THIRDPARTY_BUILTIN_Catch2}")
-    message(STATUS "GSL                 ${THIRDPARTY_BUILTIN_GSL}")
     message(STATUS "fmt                 ${THIRDPARTY_BUILTIN_fmt}")
-    message(STATUS "range-v3            ${THIRDPARTY_BUILTIN_range_v3}")
     message(STATUS "------------------------------------------------------------------------------")
 endmacro()

scripts/install-deps.ps1

@@ -13,11 +13,6 @@ class ThirdParty
 # Take care, order matters, at least as much as dependencies are of concern.
 $ThirdParties =
 @(
-    [ThirdParty]@{
-        Folder="GSL-3.1.0";
-        Archive="gsl-3.1.0.zip";
-        URI="https://github.com/microsoft/GSL/archive/refs/tags/v3.1.0.zip"
-    };
     [ThirdParty]@{
         Folder="Catch2-2.13.7";
         Archive="Catch2-2.13.7.zip";

scripts/install-deps.sh

@@ -78,14 +78,6 @@ fetch_and_unpack_fmtlib()
         https://github.com/fmtlib/fmt/archive/refs/tags/9.1.0.tar.gz
 }
 
-fetch_and_unpack_gsl()
-{
-    fetch_and_unpack \
-        GSL-3.1.0 \
-        gsl-3.1.0.tar.gz \
-        https://github.com/microsoft/GSL/archive/refs/tags/v3.1.0.tar.gz
-}
-
 fetch_and_unpack_yaml_cpp()
 {
     fetch_and_unpack \
@@ -137,7 +129,6 @@ install_deps_ubuntu()
         fi
     fi
 
-    fetch_and_unpack_gsl
     case $RELEASE in
         "18.04" | "19.04" | "20.04" | "21.04")
             # Older Ubuntu's don't have a recent enough fmt / range-v3, so supply it.
@@ -168,7 +159,6 @@ install_deps_FreeBSD()
         catch \
         cmake \
         libfmt \
-        microsoft-gsl \
         ninja \
         pkgconf \
         range-v3
@@ -184,15 +174,19 @@ install_deps_arch()
         catch2 \
         cmake \
         git \
-        microsoft-gsl \
         ninja \
         range-v3
 }
 
 install_deps_fedora()
 {
-    fetch_and_unpack_gsl
-    fetch_and_unpack_fmtlib
+    version=`cat /etc/fedora-release | awk '{print $3}'`
+
+    # Fedora 37+ contains fmtlib 9.1.0+, prefer this and fallback to embedding otherwise.
+    should_embed_fmtlib=yes
+    [ $version -ge 37 ] && should_embed_fmtlib=no
+
+    [ x$should_embed_fmtlib = xyes ] && fetch_and_unpack_fmtlib
     [ x$PREPARE_ONLY_EMBEDS = xON ] && return
 
     # catch-devel
@@ -204,7 +198,7 @@ install_deps_fedora()
         pkgconf
         range-v3-devel
     "
-    # Sadly, gsl-devel system package is too old to be used.
+    [ x$should_embed_fmtlib != xyes ] || packages="$packages fmt-devel"
     sudo dnf install $SYSDEP_ASSUME_YES $packages
 }
 
@@ -218,7 +212,6 @@ install_deps_darwin()
     # NB: Also available in brew: mimalloc
     # catch2: available in brew, but too new (version 3+)
     brew install $SYSDEP_ASSUME_YES \
-        cpp-gsl \
         fmt \
         pkg-config \
         range-v3

src/unicode/CMakeLists.txt

@@ -36,7 +36,7 @@ add_library(unicode_ucd STATIC
 )
 add_library(unicode::ucd ALIAS unicode_ucd)
 target_include_directories(unicode_ucd PUBLIC ${PROJECT_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/src)
-target_link_libraries(unicode_ucd PUBLIC fmt::fmt-header-only Microsoft.GSL::GSL)
+target_link_libraries(unicode_ucd PUBLIC fmt::fmt-header-only)
 
 # =========================================================================================================
 
@@ -60,7 +60,7 @@ add_custom_command(
 add_library(unicode_loader STATIC codepoint_properties_loader.h codepoint_properties_loader.cpp)
 add_library(unicode::loader ALIAS unicode_loader)
 target_include_directories(unicode_loader PUBLIC ${PROJECT_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/src)
-target_link_libraries(unicode_loader PUBLIC fmt::fmt-header-only Microsoft.GSL::GSL unicode::ucd)
+target_link_libraries(unicode_loader PUBLIC fmt::fmt-header-only unicode::ucd)
 
 # =========================================================================================================
 
@@ -98,15 +98,15 @@ set_target_properties(unicode PROPERTIES PUBLIC_HEADER "${public_headers}")
 
 add_library(unicode::core ALIAS unicode)
 target_include_directories(unicode PUBLIC ${PROJECT_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/src)
-target_link_libraries(unicode PUBLIC unicode::ucd fmt::fmt-header-only Microsoft.GSL::GSL)
+target_link_libraries(unicode PUBLIC unicode::ucd fmt::fmt-header-only)
 
 install(TARGETS unicode
         LIBRARY DESTINATION lib
         PUBLIC_HEADER DESTINATION include/unicode)
 
 add_executable(unicode_tablegen tablegen.cpp)
 target_include_directories(unicode_tablegen PRIVATE ${PROJECT_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/src)
-target_link_libraries(unicode_tablegen PRIVATE unicode::loader fmt::fmt-header-only Microsoft.GSL::GSL)
+target_link_libraries(unicode_tablegen PRIVATE unicode::loader fmt::fmt-header-only)
 
 # --------------------------------------------------------------------------------------------------------
 # unicode_test

src/unicode/codepoint_properties.cpp

@@ -17,20 +17,14 @@
 namespace unicode
 {
 
-using table_view = codepoint_properties::tables_view;
-
-codepoint_properties::tables_view codepoint_properties::configured_tables {
-    gsl::span<table_view::stage1_element_type const>(precompiled::stage1.data(), precompiled::stage1.size()),
-    gsl::span<table_view::stage2_element_type const>(precompiled::stage2.data(), precompiled::stage2.size()),
-    gsl::span<codepoint_properties const>(precompiled::properties.data(), precompiled::properties.size())
-};
+codepoint_properties::tables_view codepoint_properties::configured_tables { precompiled::stage1.data(),
+                                                                            precompiled::stage2.data(),
+                                                                            precompiled::properties.data() };
 
 codepoint_properties::names_view codepoint_properties::configured_names {
-    gsl::span<table_view::stage1_element_type const>(precompiled::names_stage1.data(),
-                                                     precompiled::names_stage1.size()),
-    gsl::span<table_view::stage2_element_type const>(precompiled::names_stage2.data(),
-                                                     precompiled::names_stage2.size()),
-    gsl::span<std::string_view const>(precompiled::names_stage3.data(), precompiled::names_stage3.size())
+    precompiled::names_stage1.data(),
+    precompiled::names_stage2.data(),
+    precompiled::names_stage3.data(),
 };
 
 } // namespace unicode

src/unicode/codepoint_properties.h

@@ -18,8 +18,6 @@
 #include <unicode/support/multistage_table_view.h>
 #include <unicode/ucd_enums.h> // Only for the UCD enums.
 
-#include <gsl/span>
-
 #include <type_traits>
 
 namespace unicode

src/unicode/codepoint_properties_loader.cpp

@@ -638,14 +638,12 @@ namespace
     {
         {
             auto const _ = scoped_timer { _log, "Creating multistage tables (properties)" };
-            auto input = gsl::span<codepoint_properties const>(_codepoints.data(), _codepoints.size());
-            support::generate(input, _output);
+            support::generate(_codepoints.data(), _codepoints.size(), _output);
         }
 
         {
             auto const _ = scoped_timer { _log, "Creating multistage tables (names)" };
-            auto const names = gsl::span<string const>(_names.data(), _names.size());
-            support::generate(names, _outputNames);
+            support::generate(_names.data(), _names.size(), _outputNames);
         }
     }
 } // namespace

src/unicode/support/multistage_table_generator.h

@@ -18,9 +18,6 @@
 
 #include <fmt/format.h>
 
-#include <gsl/span>
-#include <gsl/span_ext>
-
 #include <algorithm>
 #include <cassert>
 #include <cstdint>
@@ -48,12 +45,7 @@ struct multistage_table
     std::vector<Stage2ElementType> stage2; // mod
     std::vector<T> stage3;                 // values
 
-    auto to_view() const noexcept
-    {
-        return view_type { gsl::span<Stage1ElementType const>(stage1.data(), stage1.size()),
-                           gsl::span<Stage2ElementType const>(stage2.data(), stage2.size()),
-                           gsl::span<T const>(stage3.data(), stage3.size()) };
-    }
+    auto to_view() const noexcept { return view_type { stage1.data(), stage2.data(), stage3.data() }; }
 
     T const& get(SourceType index) const noexcept { return to_view().get(index); }
 };
@@ -67,20 +59,21 @@ template <typename T,
 class multistage_table_generator
 {
   public:
-    gsl::span<T const> _input;
+    T const* _input;
+    size_t _inputSize;
     multistage_table<T, SourceType, Stage1ElementType, Stage2ElementType, BlockSize, MaxValue>& _output;
 
     void generate()
     {
-        assert(_input.size() % BlockSize == 0);
-        _output.stage1.resize(_input.size());
-        for (SourceType blockStart = 0; blockStart <= _input.size() - BlockSize; blockStart += BlockSize)
+        assert(_inputSize % BlockSize == 0);
+        _output.stage1.resize(_inputSize);
+        for (SourceType blockStart = 0; blockStart <= _inputSize - BlockSize; blockStart += BlockSize)
             _output.stage1[blockStart / BlockSize] = get_or_create_index_to_stage2_block(blockStart);
     }
 
     void verify() const
     {
-        for (SourceType blockStart = 0; blockStart <= _input.size() - BlockSize; ++blockStart)
+        for (SourceType blockStart = 0; blockStart <= _inputSize - BlockSize; ++blockStart)
             verify_block(blockStart / BlockSize);
     }
 
@@ -124,7 +117,7 @@ class multistage_table_generator
     std::optional<size_t> find_same_block(size_t blockStart) const noexcept
     {
         assert(blockStart % BlockSize == 0);
-        assert(blockStart + BlockSize <= _input.size());
+        assert(blockStart + BlockSize <= _inputSize);
 
         for (size_t otherBlockStart = 0; otherBlockStart < blockStart; otherBlockStart += BlockSize)
             if (is_same_block(otherBlockStart, blockStart))
@@ -139,8 +132,8 @@ class multistage_table_generator
     {
         assert(a % BlockSize == 0);
         assert(b % BlockSize == 0);
-        assert(a + BlockSize <= _input.size());
-        assert(b + BlockSize <= _input.size());
+        assert(a + BlockSize <= _inputSize);
+        assert(b + BlockSize <= _inputSize);
 
         for (size_t i = 0; i < BlockSize; ++i)
             if (_input[a + i] != _input[b + i])
@@ -170,12 +163,13 @@ template <typename T,
           SourceType BlockSize,
           SourceType MaxValue = std::numeric_limits<SourceType>::max()>
 void generate(
-    gsl::span<T const> input,
+    T const* input,
+    size_t inputSize,
     multistage_table<T, SourceType, Stage1ElementType, Stage2ElementType, BlockSize, MaxValue>& output)
 {
     auto builder =
         multistage_table_generator<T, SourceType, Stage1ElementType, Stage2ElementType, BlockSize, MaxValue> {
-            input, output
+            input, inputSize, output
         };
     builder.generate();
 }

src/unicode/support/multistage_table_view.h

@@ -13,9 +13,6 @@
  */
 #pragma once
 
-#include <gsl/span>
-#include <gsl/span_ext>
-
 #include <cstdint>
 #include <limits>
 
@@ -35,13 +32,13 @@ struct multistage_table_view
     using stage2_element_type = Stage2ElementType;
     using value_type = T;
 
-    gsl::span<stage1_element_type const> stage1; // div
-    gsl::span<stage2_element_type const> stage2; // mod
-    gsl::span<value_type const> stage3;          // values
+    stage1_element_type const* stage1; // div
+    stage2_element_type const* stage2; // mod
+    value_type const* stage3;          // values
 
     static size_t constexpr block_size = BlockSize;
 
-    size_t size() const noexcept { return stage1.size(); }
+    // size_t size() const noexcept { return stage1.size(); }
 
     value_type const& get(source_type index, source_type fallback = source_type {}) const noexcept
     {
@@ -50,11 +47,11 @@ struct multistage_table_view
 
     value_type const& unsafe_get(source_type index) const noexcept
     {
-        auto const block_number = stage1.data()[index / BlockSize];
+        auto const block_number = stage1[index / BlockSize];
         auto const block_start = block_number * BlockSize;
         auto const element_offset = index % BlockSize;
-        auto const property_index = stage2.data()[block_start + element_offset];
-        return stage3.data()[property_index];
+        auto const property_index = stage2[block_start + element_offset];
+        return stage3[property_index];
     }
 };