Skip to content

Commit

Permalink
✨ Break up tests and use Doxygen 1.9.2!
Browse files Browse the repository at this point in the history
  • Loading branch information
ThePhD committed Nov 8, 2021
1 parent fb6c76b commit f9dbda3
Show file tree
Hide file tree
Showing 11 changed files with 300 additions and 14 deletions.
File renamed without changes.
8 changes: 6 additions & 2 deletions documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
sphinx==4.0.0
sphinx_rtd_theme
# Python requirements to generate documentation
# Run: pip3 install -r requirements.txt
breathe>=4.31.0
sphinx==4.2.0
sphinx_rtd_theme>=0.5.2
sphinxcontrib_plantuml>=0.21
breathe
myst_parser
cmake
Expand Down
2 changes: 1 addition & 1 deletion documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
.. |specializations_okay_true_false_type| replace:: User Specializations: ✔️ Okay! You can add other types to this classification by specializing the class template to a definition that derives from ``std::true_type``, or turn it off explicitly by having a definition that derives from ``std::false_type``. Note that specializing any type not explicitly marked with this notice is |ub|.
.. |reserved_name| replace:: ⚠️ Names with double underscores, and within the ``__detail`` and ``__impl`` namespaces are reserved for the implementation. Referencing this entity directly is bad, and the name/functionality can be changed at any point in the future. Relying on anything not guaranteed by the documentation is |ub|.
.. |reserved_name| replace:: ⚠️ Names with double underscores, and within the ``__*detail`` and ``__*impl`` namespaces are reserved for the implementation. Referencing this entity directly is bad, and the name/functionality can be changed at any point in the future. Relying on anything not guaranteed by the documentation is |ub|.
.. |unfinished_warning| replace:: 🔨 This isn't finished yet! Come check back by the next major or minor version update.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,6 @@ inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode
static_assert(ztd::text::validate_decodable_as(ztd::tests::w_unicode_sequence_truth_native_endian));
}
#endif
static_assert(ztd::text::validate_decodable_as(ztd::tests::u8_unicode_sequence_truth_native_endian));
static_assert(ztd::text::validate_decodable_as(ztd::tests::u16_unicode_sequence_truth_native_endian));
static_assert(ztd::text::validate_decodable_as(ztd::tests::u32_unicode_sequence_truth_native_endian));
}

void instantiate() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf16 {

template <typename T>
static void delayed() {
static_assert(ztd::text::validate_decodable_as(ztd::tests::u16_unicode_sequence_truth_native_endian));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf16
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf32 {

template <typename T>
static void delayed() {
static_assert(ztd::text::validate_decodable_as(ztd::tests::u32_unicode_sequence_truth_native_endian));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf32
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf8 {

template <typename T>
static void delayed() {
static_assert(ztd::text::validate_decodable_as(ztd::tests::u8_unicode_sequence_truth_native_endian));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_default_utf8
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,12 @@ inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode
// Larger unicode sequences, explicit encoding
if constexpr (ztd::always_true_v<T> && ztd::text::is_unicode_encoding_v<ztd::text::literal_t>) {
static_assert(ztd::text::validate_decodable_as(
ztd::tests::unicode_sequence_truth_native_endian, ztd::text::literal_t()));
ztd::tests::unicode_sequence_truth_native_endian, ztd::text::literal));
}
if constexpr (ztd::always_true_v<T> && ztd::text::is_unicode_encoding_v<ztd::text::wide_literal_t>) {
static_assert(ztd::text::validate_decodable_as(
ztd::tests::w_unicode_sequence_truth_native_endian, ztd::text::wide_literal_t()));
ztd::tests::w_unicode_sequence_truth_native_endian, ztd::text::wide_literal));
}
static_assert(ztd::text::validate_decodable_as(
ztd::tests::u8_unicode_sequence_truth_native_endian, ztd::text::utf8_t()));
static_assert(ztd::text::validate_decodable_as(
ztd::tests::u16_unicode_sequence_truth_native_endian, ztd::text::utf16_t()));
static_assert(ztd::text::validate_decodable_as(
ztd::tests::u32_unicode_sequence_truth_native_endian, ztd::text::utf32_t()));
}

void instantiate() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf16 {

template <typename T>
static void delayed() {
static_assert(ztd::text::validate_decodable_as(
ztd::tests::u16_unicode_sequence_truth_native_endian, ztd::text::utf16));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf16
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf32 {

template <typename T>
static void delayed() {
static_assert(ztd::text::validate_decodable_as(
ztd::tests::u32_unicode_sequence_truth_native_endian, ztd::text::utf32));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf32
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// =============================================================================
//
// ztd.text
// Copyright © 2021 JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
// Contact: opensource@soasis.org
//
// Commercial License Usage
// Licensees holding valid commercial ztd.text licenses may use this file in
// accordance with the commercial license agreement provided with the
// Software or, alternatively, in accordance with the terms contained in
// a written agreement between you and Shepherd's Oasis, LLC.
// For licensing terms and conditions see your agreement. For
// further information contact opensource@soasis.org.
//
// Apache License Version 2 Usage
// Alternatively, this file may be used under the terms of Apache License
// Version 2.0 (the "License") for non-commercial use; you may not use this
// file except in compliance with the License. You may obtain a copy of the
// License at
//
// http://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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ============================================================================>

#include <ztd/text/tests/basic_unicode_strings.hpp>

#include <ztd/text/validate_decodable_as.hpp>
#include <ztd/text/encoding.hpp>
#include <ztd/text/is_unicode_encoding.hpp>

inline namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf8 {

template <typename T>
static void delayed() {
static_assert(
ztd::text::validate_decodable_as(ztd::tests::u8_unicode_sequence_truth_native_endian, ztd::text::utf8));
}

void instantiate() {
delayed<void>();
}

} // namespace ztd_text_tests_basic_compile_time_validate_decodable_as_unicode_explicit_utf8

0 comments on commit f9dbda3

Please sign in to comment.