refactor: Rename project to byte-span

range3 · range3 · commit 6027d5caee5d · 2024-12-11T09:56:35.000+09:00
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -14,7 +14,6 @@
         "llvm-vs-code-extensions.vscode-clangd",
         "xaver.clang-format",
         "cschlosser.doxdocgen",
-        "streetsidesoftware.code-spell-checker",
         "GitHub.copilot",
         "GitHub.copilot-chat"
       ],
diff --git a/BUILDING.md b/BUILDING.md
@@ -65,18 +65,18 @@ cmake --install build --config Release
 This project exports a CMake package to be used with the [`find_package`][3]
 command of CMake:
 
-* Package name: `lsm-tree`
-* Target name: `lsm-tree::lsm-tree`
+* Package name: `byte-span`
+* Target name: `byte-span::byte-span`
 
 Example usage:
 
 ```cmake
-find_package(lsm-tree REQUIRED)
+find_package(byte-span REQUIRED)
 # Declare the imported target as a build requirement using PRIVATE, where
 # project_target is a target created in the consuming project
 target_link_libraries(
     project_target PRIVATE
-    lsm-tree::lsm-tree
+    byte-span::byte-span
 )
 ```
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,37 +3,33 @@ cmake_minimum_required(VERSION 3.14)
 include(cmake/prelude.cmake)
 
 project(
-    lsm-tree
+    byte-span
     VERSION 0.1.0
-    DESCRIPTION "LSM-tree"
-    HOMEPAGE_URL "https://github.com/range3/lsm-tree"
-    LANGUAGES NONE
+    DESCRIPTION "Lightweight view class for efficient handling of byte data"
+    HOMEPAGE_URL "https://github.com/range3/byte-span"
+    LANGUAGES CXX
 )
 
 include(cmake/project-is-top-level.cmake)
 include(cmake/variables.cmake)
 
 # ---- Declare library ----
 
-add_library(lsm-tree_lsm-tree INTERFACE)
-add_library(lsm-tree::lsm-tree ALIAS lsm-tree_lsm-tree)
+add_library(byte-span_byte-span INTERFACE)
+add_library(byte-span::byte-span ALIAS byte-span_byte-span)
 
 set_property(
-    TARGET lsm-tree_lsm-tree PROPERTY
-    EXPORT_NAME lsm-tree
+    TARGET byte-span_byte-span PROPERTY
+    EXPORT_NAME byte-span
 )
 
 target_include_directories(
-    lsm-tree_lsm-tree ${warning_guard}
+    byte-span_byte-span ${warning_guard}
     INTERFACE
     "\$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"
 )
 
-target_compile_features(lsm-tree_lsm-tree INTERFACE cxx_std_20)
-
-find_package(fmt REQUIRED)
-find_package(inspector REQUIRED)
-target_link_libraries(lsm-tree_lsm-tree INTERFACE fmt::fmt inspector::inspector)
+target_compile_features(byte-span_byte-span INTERFACE cxx_std_20)
 
 # ---- Install rules ----
 
@@ -43,12 +39,12 @@ endif()
 
 # ---- Developer mode ----
 
-if(NOT lsm-tree_DEVELOPER_MODE)
+if(NOT byte-span_DEVELOPER_MODE)
   return()
 elseif(NOT PROJECT_IS_TOP_LEVEL)
   message(
       AUTHOR_WARNING
-      "Developer mode is intended for developers of lsm-tree"
+      "Developer mode is intended for developers of byte-span"
   )
 endif()
 
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -10,7 +10,7 @@
       "name": "dev-mode",
       "hidden": true,
       "cacheVariables": {
-        "lsm-tree_DEVELOPER_MODE": "ON",
+        "byte-span_DEVELOPER_MODE": "ON",
         "VCPKG_MANIFEST_FEATURES": "test"
       }
     },
diff --git a/HACKING.md b/HACKING.md
@@ -9,7 +9,7 @@ guide.
 ## Developer mode
 
 Build system targets that are only useful for developers of this project are
-hidden if the `lsm-tree_DEVELOPER_MODE` option is disabled. Enabling this
+hidden if the `byte-span_DEVELOPER_MODE` option is disabled. Enabling this
 option makes tests and other developer targets and options available. Not
 enabling this option means that you are a consumer of this project and thus you
 have no need for these targets and options.
@@ -23,7 +23,7 @@ the project. As a developer, you are recommended to always have the [latest
 CMake version][2] installed to make use of the latest Quality-of-Life
 additions.
 
-You have a few options to pass `lsm-tree_DEVELOPER_MODE` to the configure
+You have a few options to pass `byte-span_DEVELOPER_MODE` to the configure
 command, but this project prefers to use presets.
 
 As a developer, you should create a `CMakeUserPresets.json` file at the root of
diff --git a/cmake/install-config.cmake b/cmake/install-config.cmake
@@ -2,5 +2,5 @@ include(CMakeFindDependencyMacro)
 find_dependency(fmt)
 
 if(fmt_FOUND)
-  include("${CMAKE_CURRENT_LIST_DIR}/lsm-treeTargets.cmake")
+  include("${CMAKE_CURRENT_LIST_DIR}/byte-spanTargets.cmake")
 endif()
diff --git a/cmake/install-rules.cmake b/cmake/install-rules.cmake
@@ -1,6 +1,6 @@
 if(PROJECT_IS_TOP_LEVEL)
   set(
-      CMAKE_INSTALL_INCLUDEDIR "include/lsm-tree-${PROJECT_VERSION}"
+      CMAKE_INSTALL_INCLUDEDIR "include/byte-span-${PROJECT_VERSION}"
       CACHE STRING ""
   )
   set_property(CACHE CMAKE_INSTALL_INCLUDEDIR PROPERTY TYPE PATH)
@@ -13,17 +13,17 @@ include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)
 
 # find_package(<package>) call for consumers to find this project
-set(package lsm-tree)
+set(package byte-span)
 
 install(
     DIRECTORY include/
     DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-    COMPONENT lsm-tree_Development
+    COMPONENT byte-span_Development
 )
 
 install(
-    TARGETS lsm-tree_lsm-tree
-    EXPORT lsm-treeTargets
+    TARGETS byte-span_byte-span
+    EXPORT byte-spanTargets
     INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 )
 
@@ -35,30 +35,30 @@ write_basic_package_version_file(
 
 # Allow package maintainers to freely override the path for the configs
 set(
-    lsm-tree_INSTALL_CMAKEDIR "${CMAKE_INSTALL_DATADIR}/${package}"
+    byte-span_INSTALL_CMAKEDIR "${CMAKE_INSTALL_DATADIR}/${package}"
     CACHE STRING "CMake package config location relative to the install prefix"
 )
-set_property(CACHE lsm-tree_INSTALL_CMAKEDIR PROPERTY TYPE PATH)
-mark_as_advanced(lsm-tree_INSTALL_CMAKEDIR)
+set_property(CACHE byte-span_INSTALL_CMAKEDIR PROPERTY TYPE PATH)
+mark_as_advanced(byte-span_INSTALL_CMAKEDIR)
 
 install(
     FILES cmake/install-config.cmake
-    DESTINATION "${lsm-tree_INSTALL_CMAKEDIR}"
+    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
     RENAME "${package}Config.cmake"
-    COMPONENT lsm-tree_Development
+    COMPONENT byte-span_Development
 )
 
 install(
     FILES "${PROJECT_BINARY_DIR}/${package}ConfigVersion.cmake"
-    DESTINATION "${lsm-tree_INSTALL_CMAKEDIR}"
-    COMPONENT lsm-tree_Development
+    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
+    COMPONENT byte-span_Development
 )
 
 install(
-    EXPORT lsm-treeTargets
-    NAMESPACE lsm-tree::
-    DESTINATION "${lsm-tree_INSTALL_CMAKEDIR}"
-    COMPONENT lsm-tree_Development
+    EXPORT byte-spanTargets
+    NAMESPACE byte-span::
+    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
+    COMPONENT byte-span_Development
 )
 
 if(PROJECT_IS_TOP_LEVEL)
diff --git a/cmake/variables.cmake b/cmake/variables.cmake
@@ -1,11 +1,11 @@
 # ---- Developer mode ----
 
 # Developer mode enables targets and code paths in the CMake scripts that are
-# only relevant for the developer(s) of lsm-tree
+# only relevant for the developer(s) of byte-span
 # Targets necessary to build the project must be provided unconditionally, so
 # consumers can trivially build and package the project
 if(PROJECT_IS_TOP_LEVEL)
-  option(lsm-tree_DEVELOPER_MODE "Enable developer mode" OFF)
+  option(byte-span_DEVELOPER_MODE "Enable developer mode" OFF)
 endif()
 
 # ---- Warning guard ----
@@ -17,12 +17,12 @@ endif()
 set(warning_guard "")
 if(NOT PROJECT_IS_TOP_LEVEL)
   option(
-      lsm-tree_INCLUDES_WITH_SYSTEM
-      "Use SYSTEM modifier for lsm-tree's includes, disabling warnings"
+      byte-span_INCLUDES_WITH_SYSTEM
+      "Use SYSTEM modifier for byte-span's includes, disabling warnings"
       ON
   )
-  mark_as_advanced(lsm-tree_INCLUDES_WITH_SYSTEM)
-  if(lsm-tree_INCLUDES_WITH_SYSTEM)
+  mark_as_advanced(byte-span_INCLUDES_WITH_SYSTEM)
+  if(byte-span_INCLUDES_WITH_SYSTEM)
     set(warning_guard SYSTEM)
   endif()
 endif()
diff --git a/include/byte_span/byte_span.hpp b/include/byte_span/byte_span.hpp
@@ -10,7 +10,7 @@
 #include <string_view>
 #include <type_traits>
 
-namespace lsm::utils {
+namespace range3 {
 
 using std::dynamic_extent;
 
@@ -469,13 +469,13 @@ byte_span(Range&&)
 using byte_view = byte_span<std::byte>;
 using cbyte_view = byte_span<const std::byte>;
 
-}  // namespace lsm::utils
+}  // namespace range3
 
 // Opt-in to borrowed_range concept
 template <typename T, std::size_t N>
-constexpr bool std::ranges::enable_borrowed_range<lsm::utils::byte_span<T, N>> =
+constexpr bool std::ranges::enable_borrowed_range<range3::byte_span<T, N>> =
     true;
 
 // Opt-in to view concept
 template <typename B, size_t N>
-constexpr bool std::ranges::enable_view<lsm::utils::byte_span<B, N>> = true;
+constexpr bool std::ranges::enable_view<range3::byte_span<B, N>> = true;
diff --git a/include/lsm-tree/lsm-tree.hpp b/include/lsm-tree/lsm-tree.hpp
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -1,14 +1,14 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(lsm-treeTests LANGUAGES CXX)
+project(byte-spanTests LANGUAGES CXX)
 
 include(../cmake/project-is-top-level.cmake)
 include(../cmake/folders.cmake)
 
 # ---- Dependencies ----
 
 if(PROJECT_IS_TOP_LEVEL)
-  find_package(lsm-tree REQUIRED)
+  find_package(byte-span REQUIRED)
   enable_testing()
 endif()
 
@@ -19,15 +19,15 @@ include(Catch)
 file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS
      "${CMAKE_CURRENT_SOURCE_DIR}/source/*_test.cpp")
 
-add_executable(lsm-tree_test ${TEST_SOURCES})
+add_executable(byte-span_test ${TEST_SOURCES})
 target_link_libraries(
-    lsm-tree_test PRIVATE
-    lsm-tree::lsm-tree
+    byte-span_test PRIVATE
+    byte-span::byte-span
     Catch2::Catch2WithMain
 )
-target_compile_features(lsm-tree_test PRIVATE cxx_std_20)
+target_compile_features(byte-span_test PRIVATE cxx_std_20)
 
-catch_discover_tests(lsm-tree_test)
+catch_discover_tests(byte-span_test)
 
 # ---- End-of-file commands ----
 
diff --git a/test/source/byte_span_1_test.cpp b/test/source/byte_span_1_test.cpp
@@ -6,13 +6,13 @@
 #include <catch2/catch_template_test_macros.hpp>
 #include <catch2/catch_test_macros.hpp>
 
-#include "lsm-tree/byte_span.hpp"
+#include "byte_span/byte_span.hpp"
 
-using lsm::utils::byte_span;
-using lsm::utils::byte_view;
-using lsm::utils::cbyte_view;
-using lsm::utils::detail::byte_like;
-using lsm::utils::detail::const_convertible;
+using range3::byte_span;
+using range3::byte_view;
+using range3::cbyte_view;
+using range3::detail::byte_like;
+using range3::detail::const_convertible;
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wunused-variable"
@@ -385,7 +385,7 @@ TEST_CASE("byte_span construction from std::array - size checks",
   SECTION("dynamic extent") {
     auto const span = byte_span<std::byte>{arr};
     REQUIRE(span.size() == sizeof(int) * 3);
-    STATIC_REQUIRE(span.extent == lsm::utils::dynamic_extent);
+    STATIC_REQUIRE(span.extent == range3::dynamic_extent);
   }
 
   SECTION("static extent") {
diff --git a/test/source/byte_span_2_test.cpp b/test/source/byte_span_2_test.cpp
@@ -11,20 +11,20 @@
 #include <catch2/catch_template_test_macros.hpp>
 #include <catch2/catch_test_macros.hpp>
 
-#include "lsm-tree/byte_span.hpp"
+#include "byte_span/byte_span.hpp"
 
 // NOLINTBEGIN(misc-const-correctness,clang-analyzer-deadcode.DeadStores)
 
-using lsm::utils::as_bytes;
-using lsm::utils::as_span;
-using lsm::utils::as_sv;
-using lsm::utils::as_writable_bytes;
-using lsm::utils::as_writable_span;
-using lsm::utils::byte_span;
-using lsm::utils::byte_view;
-using lsm::utils::cbyte_view;
-using lsm::utils::detail::byte_like;
-using lsm::utils::detail::const_convertible;
+using range3::as_bytes;
+using range3::as_span;
+using range3::as_sv;
+using range3::as_writable_bytes;
+using range3::as_writable_span;
+using range3::byte_span;
+using range3::byte_view;
+using range3::cbyte_view;
+using range3::detail::byte_like;
+using range3::detail::const_convertible;
 using namespace std::string_view_literals;
 
 #pragma GCC diagnostic push
@@ -179,7 +179,7 @@ TEST_CASE("byte_span construction from other byte_span", "[byte_span]") {
 
     REQUIRE(bs.size() == original.size());
     REQUIRE(bs.data() == original.data());
-    REQUIRE(bs2.extent == lsm::utils::dynamic_extent);
+    REQUIRE(bs2.extent == range3::dynamic_extent);
   }
 
   SECTION("explicit conversions - static extent") {
diff --git a/test/source/byte_span_3_range_test.cpp b/test/source/byte_span_3_range_test.cpp
@@ -6,11 +6,11 @@
 #include <catch2/catch_template_test_macros.hpp>
 #include <catch2/catch_test_macros.hpp>
 
-#include "lsm-tree/byte_span.hpp"
+#include "byte_span/byte_span.hpp"
 
-using lsm::utils::byte_span;
-using lsm::utils::byte_view;
-using lsm::utils::cbyte_view;
+using range3::byte_span;
+using range3::byte_view;
+using range3::cbyte_view;
 
 struct trivial_struct {
   int x;
diff --git a/test/source/byte_span_ctad_test.cpp b/test/source/byte_span_ctad_test.cpp
diff --git a/test/source/lsm-tree_test.cpp b/test/source/lsm-tree_test.cpp
diff --git a/vcpkg.json b/vcpkg.json

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"name": "dev-mode",`
`11`	`11`	`"hidden": true,`
`12`	`12`	`"cacheVariables": {`
`13`		`- "lsm-tree_DEVELOPER_MODE": "ON",`
	`13`	`+ "byte-span_DEVELOPER_MODE": "ON",`
`14`	`14`	`"VCPKG_MANIFEST_FEATURES": "test"`
`15`	`15`	`}`
`16`	`16`	`},`