chore: move helper function to detail namespace

Author: craftablescience

CMakeLists.txt

@@ -6,7 +6,7 @@ include(GNUInstallDirs)
 add_library(${PROJECT_NAME} INTERFACE)
 target_sources(${PROJECT_NAME} INTERFACE
         "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/cstringpp/core.hpp>"
-        "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/cstringpp/helpers.hpp>"
+        "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/cstringpp/detail.hpp>"
         "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/cstringpp.hpp>")
 target_include_directories(${PROJECT_NAME} SYSTEM INTERFACE $<INSTALL_INTERFACE:$<INSTALL_PREFIX>/include>)
 

include/cstringpp.hpp

@@ -1,4 +1,4 @@
 #pragma once
 
 #include "cstringpp/core.hpp"
-#include "cstringpp/helpers.hpp"
+#include "cstringpp/detail.hpp"

include/cstringpp/core.hpp

@@ -1,30 +1,14 @@
 #pragma once
 
 #include <cstddef>
-#include <cstring>
 #include <array>
 #include <compare>
 #include <utility>
 
-#include "helpers.hpp"
+#include "detail.hpp"
 
 namespace cstringpp {
 
-namespace detail {
-
-template<size_t Length>
-constexpr size_t getPositiveIndex(int index) {
-    while (index < 0) {
-        index += Length;
-    }
-    while (index >= Length) {
-        index -= Length;
-    }
-    return index;
-}
-
-} // namespace detail
-
 template<size_t Length>
 class String {
 public:
@@ -129,11 +113,11 @@ class String {
     }
 
     [[nodiscard]] constexpr String<Length> toLower() const {
-        return map(&cstringpp::toLower);
+        return map(&cstringpp::detail::toLower);
     }
 
     [[nodiscard]] constexpr String<Length> toUpper() const {
-        return map(&cstringpp::toUpper);
+        return map(&cstringpp::detail::toUpper);
     }
 
     [[nodiscard]] constexpr String<Length> reverse() const {

include/cstringpp/helpers.hpp renamed to include/cstringpp/detail.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-namespace cstringpp {
+namespace cstringpp::detail {
 
 [[nodiscard]] constexpr char toLower(char in) {
     if (in >= 'A' && in <= 'Z') {
@@ -16,4 +16,15 @@ namespace cstringpp {
     return in;
 }
 
+template<size_t Length>
+constexpr size_t getPositiveIndex(int index) {
+    while (index < 0) {
+        index += Length;
+    }
+    while (index >= Length) {
+        index -= Length;
+    }
+    return index;
+}
+
 } // namespace cstringpp

test/test.cpp

@@ -54,10 +54,10 @@ TEST(String, slice) {
 }
 
 TEST(String, map) {
-    constexpr String str1 = String{"HElLo"}.map([](char c) { return cstringpp::toUpper(c); });
+    constexpr String str1 = String{"HElLo"}.map([](char c) { return cstringpp::detail::toUpper(c); });
     EXPECT_STREQ(str1.toCString(), "HELLO");
 
-    constexpr String str2 = String{"HElLo"}.map(&cstringpp::toLower);
+    constexpr String str2 = String{"HElLo"}.map(&cstringpp::detail::toLower);
     EXPECT_STREQ(str2.toCString(), "hello");
 }