🎉 Tiny buffers are golden now, thanks @lunasorcery 💚💚

- 📝 Fix up some of the documentation for execution and friends - 🛠 Completely revamp the __scheme_handler for decode and encode steps - 🛠 Fix up some of the CMake Files
soasis · Jul 27, 2021 · 6cf1fa1 · 6cf1fa1
1 parent a57714b
commit 6cf1fa1
Show file tree

Hide file tree

Showing 206 changed files with 2,796 additions and 907 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -100,6 +100,7 @@ if (ZTD_TEXT_IS_TOP_LEVEL_PROJECT)
 		check_compiler_flag(warn-pedantic MSVC /permissive- GCC -pedantic)
 		check_compiler_flag(warn-all MSVC /W4 GCC -Wall)
 		check_compiler_flag(warn-errors MSVC /WX GCC -Werror)
+		check_compiler_flag(warn-extra GCC -Wextra CLANG -Wextra)
 		check_compiler_flag(utf8-literal-encoding MSVC /execution-charset:utf-8 GCC -fexec-charset=utf-8)
 		check_compiler_flag(utf8-source-encoding MSVC /source-charset:utf-8 GCC -finput-charset=utf-8)
 		check_compiler_flag(extra-constexpr-depth MSVC /constexpr:depth2147483647 GCC -fconstexpr-depth=2147483647 CLANG -fconstexpr-depth=2147483647)
@@ -205,5 +206,6 @@ if (ZTD_TEXT_SCRATCH)
 		${--disable-permissive}
 		${--warn-pedantic}
 		${--warn-all}
+		${--warn-extra}
 		${--warn-errors})
 endif()
diff --git a/cmake/ztd.text-config.cmake.in b/cmake/ztd.text-config.cmake.in
@@ -14,8 +14,7 @@ endif()
 if(TARGET ztd::text::single)
 	get_target_property(ZTD_TEXT_SINGLE_INCLUDE_DIRS
 		ztd.text.single INTERFACE_INCLUDE_DIRECTORIES)
-	set_and_check(ZTD_TEXT_INCLUDE_DIRS "${ZTD_TEXT_SINGLE_INCLUDE_DIRS}")
-	set(ZTD_TEXT_LIBRARIES_SINGLE ztd::text::single)
+	set_and_check(ZTD_TEXT_SINGLE_INCLUDE_DIRS "${ZTD_TEXT_SINGLE_INCLUDE_DIRS}")
 	if (TARGET ztd::cuneicode::single)
 		set(ZTD_TEXT_LIBRARIES_SINGLE ztd::text::single ztd::cuneicode::single)
 	else()

diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
@@ -39,14 +39,22 @@ include(GNUInstallDirs)
 # Find all the public headers
 file(GLOB_RECURSE ztd_text_public_headers
 	LIST_DIRECTORIES NO
-	CONFIGURE_DEPENDS ${PROJECT_SOURCE_DIR}/include/**.*)
+	CONFIGURE_DEPENDS
+	${PROJECT_SOURCE_DIR}/include/**.*)
 # make a list copy for use with dependency tracking later down below
 set(ztd_text_doxygen_public_headers ${ztd_text_public_headers})
 # Remove every single public header
 list(FILTER ztd_text_doxygen_public_headers EXCLUDE REGEX /detail/.*)
 # separate text with spaces and surround them with quotes for Doxygen to understand them all
 list(TRANSFORM ztd_text_doxygen_public_headers REPLACE "(.+)" [["\1"]])
 list(JOIN ztd_text_doxygen_public_headers " " ztd_text_doxygen_public_headers)
+# do the same for the include paths
+get_target_property(ztd_text_doxygen_include_paths ztd::text INTERFACE_INCLUDE_DIRECTORIES)
+get_target_property(ztd_idk_doxygen_include_paths ztd::idk INTERFACE_INCLUDE_DIRECTORIES)
+list(TRANSFORM ztd_text_doxygen_include_paths REPLACE "(.+)" [["\1"]])
+list(TRANSFORM ztd_idk_doxygen_include_paths REPLACE "(.+)" [["\1"]])
+list(JOIN ztd_text_doxygen_include_paths " " ztd_text_doxygen_include_paths)
+list(JOIN ztd_idk_doxygen_include_paths " " ztd_text_doxygen_include_paths)
 
 set(ZTD_TEXT_DOXYGEN_PROJECT_DESCRIPTION ${PROJECT_DESCRIPTION})
 set(ZTD_TEXT_DOXYGEN_PROJECT_VERSION ${PROJECT_VERSION})
@@ -55,6 +63,7 @@ set(ZTD_TEXT_DOXYGEN_INPUT ${ztd_text_doxygen_public_headers})
 set(ZTD_TEXT_DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
 set(ZTD_TEXT_DOXYGEN_XML_OUTPUT_DIR ${ZTD_TEXT_DOXYGEN_OUTPUT_DIR}/xml)
 set(ZTD_TEXT_DOXYGEN_HTML_OUTPUT_DIR ${ZTD_TEXT_DOXYGEN_OUTPUT_DIR}/html)
+set(ZTD_TEXT_DOXYGEN_INCLUDE_PATH ${ztd_text_doxygen_include_paths})
 set(ZTD_TEXT_DOXYGEN_INDEX_FILE ${ZTD_TEXT_DOXYGEN_XML_OUTPUT_DIR}/index.xml)
 set(ZTD_TEXT_DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
 set(ZTD_TEXT_DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
@@ -66,8 +75,12 @@ file(GLOB_RECURSE ztd_text_sphinx_sources
 	LIST_DIRECTORIES NO
 	CONFIGURE_DEPENDS ${ZTD_TEXT_SPHINX_SOURCE_DIR}/**.*)
 
-#Replace variables inside @@ with the current values
-configure_file(${ZTD_TEXT_DOXYFILE_IN} ${ZTD_TEXT_DOXYFILE_OUT} @ONLY)
+# Do generator expressions and
+# Replace variables inside @...@ with the current values
+set(ZTD_TEXT_DOXYFILE_IN_CONFIGURED ${ZTD_TEXT_DOXYFILE_OUT}.conf)
+configure_file(${ZTD_TEXT_DOXYFILE_IN} ${ZTD_TEXT_DOXYFILE_IN_CONFIGURED} @ONLY)
+file(GENERATE OUTPUT ${ZTD_TEXT_DOXYFILE_OUT}
+	INPUT ${ZTD_TEXT_DOXYFILE_IN_CONFIGURED})
 
 # Ensure Doxygen/Sphinx won't crash because it doesn't create directories for us
 file(MAKE_DIRECTORY ${ZTD_TEXT_DOXYGEN_OUTPUT_DIR})

diff --git a/documentation/Doxyfile.in b/documentation/Doxyfile.in
@@ -2266,7 +2266,7 @@ SEARCH_INCLUDES        = YES
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
 
-INCLUDE_PATH           =
+INCLUDE_PATH           = @ZTD_TEXT_DOXYGEN_INCLUDE_PATH@
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the

diff --git a/documentation/source/api.rst b/documentation/source/api.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/code_point.rst b/documentation/source/api/code_point.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/code_unit.rst b/documentation/source/api/code_unit.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/containers/basic_text.rst b/documentation/source/api/containers/basic_text.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/contains_unicode_encoding.rst b/documentation/source/api/contains_unicode_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/count_decodable.rst b/documentation/source/api/conversions/count_decodable.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/count_encodable.rst b/documentation/source/api/conversions/count_encodable.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/count_transcodable.rst b/documentation/source/api/conversions/count_transcodable.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/decode.rst b/documentation/source/api/conversions/decode.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/encode.rst b/documentation/source/api/conversions/encode.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/transcode.rst b/documentation/source/api/conversions/transcode.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/validate_decodable_as.rst b/documentation/source/api/conversions/validate_decodable_as.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/validate_encodable_as.rst b/documentation/source/api/conversions/validate_encodable_as.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/conversions/validate_transcodable_as.rst b/documentation/source/api/conversions/validate_transcodable_as.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/count_result.rst b/documentation/source/api/count_result.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/decode_result.rst b/documentation/source/api/decode_result.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/decode_state.rst b/documentation/source/api/decode_state.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/default_code_point_encoding.rst b/documentation/source/api/default_code_point_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/default_code_unit_encoding.rst b/documentation/source/api/default_code_unit_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encode_result.rst b/documentation/source/api/encode_result.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encode_state.rst b/documentation/source/api/encode_state.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encoding_error.rst b/documentation/source/api/encoding_error.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/any_encoding.rst b/documentation/source/api/encodings/any_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/any_encoding_with.rst b/documentation/source/api/encodings/any_encoding_with.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/ascii.rst b/documentation/source/api/encodings/ascii.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/cuneicode_encoding.rst b/documentation/source/api/encodings/cuneicode_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/encoding_scheme.rst b/documentation/source/api/encodings/encoding_scheme.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/execution.rst b/documentation/source/api/encodings/execution.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,
@@ -31,4 +31,41 @@
 Execution
 =========
 
+This is the locale-based, runtime encoding. It uses a number of compile-time and runtime heuristics to eventually be resolved to an implementation-defined encoding. It is not required to work in constant expressions either: for this, use :doc:`ztd::text::literal </api/encodings/literal>`, which represents the compile-time string (e.g. ``"my string"``) encoding.
+
+Currently, the hierachy of behaviors is like so:
+
+- If the platform is MacOS, then it assumes this is :doc:`UTF-8 </api/encodings/utf8>`;
+- Otherwise, if libiconv is available, then it attempts to use :doc:`iconv </api/encodings/iconv_encoding>` configured to the ``"char"``-identified encoding;
+- Otherwise, if the headers ``<cuchar>`` or ``<uchar.h>`` are available, then it attempts to use a gnarly, lossy, and dangerous encoding that potentially traffics through the C Standard Library and Locale APIs;
+- Otherwise, it produces a compile-time error.
+
+.. warning::
+
+	The C Standard Library has many design defects in its production of code points, which may make it unsuitable even if your C Standard Library recognizes certain locales (e.g., Big5-HKSCS). The runtime will always attempt to load ``iconv`` if the definition is turned on, since it may do a better job than the C Standard Library's interfaces until C23.
+
+Even if, on a given platform, it can be assumed to be a static encoding (e.g., Apple/MacOS where it always returns the "C" Locale but processes text as UTF-8), ``ztd::text::execution`` will always present itself as a runtime and unknowable encoding. This is to prevent portability issues from relying on, e.g., ``ztd::text::is_decode_injective_v<ztd::text::execution>`` being true during development and working with that assumption, only to have it break when ported to a platform where that assumption no longer holds.
+
 .. doxygentypedef:: ztd::text::execution
+
+
+
+Internal Types
+--------------
+
+.. warning::
+
+	|reserved_name|
+
+
+.. ``<cuchar>``-based
+.. ++++++++++++++++++
+.. 
+.. .. doxygenclass:: ztd::text::__txt_impl::__execution_cuchar
+.. 	:members:
+
+MacOS-based
++++++++++++
+
+.. doxygenclass:: ztd::text::__txt_impl::__execution_mac_os
+	:members:
diff --git a/documentation/source/api/encodings/iconv_encoding.rst b/documentation/source/api/encodings/iconv_encoding.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/documentation/source/api/encodings/literal.rst b/documentation/source/api/encodings/literal.rst
@@ -18,7 +18,7 @@
 .. file except in compliance with the License. You may obtain a copy of the
 .. License at
 ..
-..		http:..www.apache.org/licenses/LICENSE-2.0
+.. 		https://www.apache.org/licenses/LICENSE-2.0
 ..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,