From 6879e5bb1c598a9a517d7bdec8ba1a0bace3ef10 Mon Sep 17 00:00:00 2001 From: Merry Date: Sat, 31 Dec 2022 17:28:39 +0000 Subject: [PATCH] Squashed 'externals/catch/' content from commit ab6c7375b git-subtree-dir: externals/catch git-subtree-split: ab6c7375be9a8e71ee84c6f8537113f9f47daf99 --- .bazelrc | 10 + .clang-format | 44 + .conan/build.py | 94 + .conan/test_package/CMakeLists.txt | 12 + .conan/test_package/conanfile.py | 20 + .conan/test_package/test_package.cpp | 13 + .gitattributes | 22 + .github/FUNDING.yml | 2 + .github/ISSUE_TEMPLATE/bug_report.md | 29 + .github/ISSUE_TEMPLATE/feature_request.md | 14 + .github/pull_request_template.md | 28 + .github/workflows/linux-bazel-builds.yml | 24 + .github/workflows/linux-meson-builds.yml | 43 + .github/workflows/linux-other-builds.yml | 104 + .github/workflows/linux-simple-builds.yml | 122 + .github/workflows/mac-builds.yml | 52 + .github/workflows/validate-header-guards.yml | 36 + .gitignore | 37 + BUILD.bazel | 92 + CMake/Catch2Config.cmake.in | 10 + CMake/CatchConfigOptions.cmake | 79 + CMake/CatchMiscFunctions.cmake | 120 + CMake/FindGcov.cmake | 157 + CMake/FindLcov.cmake | 354 + CMake/Findcodecov.cmake | 258 + CMake/catch2-with-main.pc.in | 10 + CMake/catch2.pc.in | 11 + CMake/llvm-cov-wrapper | 56 + CMakeLists.txt | 199 + CMakePresets.json | 25 + CODE_OF_CONDUCT.md | 46 + Doxyfile | 2484 ++ LICENSE.txt | 23 + README.md | 99 + SECURITY.md | 19 + WORKSPACE.bazel | 15 + appveyor.yml | 129 + codecov.yml | 22 + conanfile.py | 60 + data/artwork/catch2-c-logo.png | Bin 0 -> 10636 bytes data/artwork/catch2-hand-logo.png | Bin 0 -> 33761 bytes .../catch2-logo-small-with-background.png | Bin 0 -> 25330 bytes data/artwork/catch2-logo-small.png | Bin 0 -> 20939 bytes docs/Readme.md | 42 + docs/assertions.md | 182 + docs/benchmarks.md | 251 + docs/ci-and-misc.md | 110 + docs/cmake-integration.md | 402 + docs/command-line.md | 585 + docs/commercial-users.md | 23 + docs/comparing-floating-point-numbers.md | 192 + docs/configuration.md | 269 + docs/contributing.md | 332 + docs/deprecations.md | 31 + docs/event-listeners.md | 44 + docs/faq.md | 94 + docs/generators.md | 219 + docs/limitations.md | 185 + docs/list-of-examples.md | 46 + docs/logging.md | 159 + docs/matchers.md | 394 + docs/migrate-v2-to-v3.md | 98 + docs/opensource-users.md | 150 + docs/other-macros.md | 155 + docs/own-main.md | 132 + docs/release-notes.md | 1600 ++ docs/release-process.md | 66 + docs/reporter-events.md | 175 + docs/reporters.md | 213 + docs/test-cases-and-sections.md | 338 + docs/test-fixtures.md | 162 + docs/tostring.md | 132 + docs/tutorial.md | 227 + docs/usage-tips.md | 100 + docs/why-catch.md | 59 + examples/010-TestCase.cpp | 33 + examples/020-TestCase-1.cpp | 29 + examples/020-TestCase-2.cpp | 33 + examples/030-Asn-Require-Check.cpp | 74 + examples/100-Fix-Section.cpp | 70 + examples/110-Fix-ClassFixture.cpp | 66 + examples/120-Bdd-ScenarioGivenWhenThen.cpp | 73 + examples/210-Evt-EventListeners.cpp | 429 + examples/231-Cfg-OutputStreams.cpp | 55 + examples/300-Gen-OwnGenerator.cpp | 69 + examples/301-Gen-MapTypeConversion.cpp | 60 + examples/302-Gen-Table.cpp | 55 + examples/310-Gen-VariablesInGenerators.cpp | 35 + examples/311-Gen-CustomCapture.cpp | 43 + examples/CMakeLists.txt | 61 + extras/Catch.cmake | 220 + extras/CatchAddTests.cmake | 156 + extras/CatchShardTests.cmake | 66 + extras/CatchShardTestsImpl.cmake | 52 + extras/ParseAndAddCatchTests.cmake | 252 + extras/catch_amalgamated.cpp | 10517 ++++++++ extras/catch_amalgamated.hpp | 12524 ++++++++++ extras/gdbinit | 16 + extras/lldbinit | 16 + fuzzing/CMakeLists.txt | 20 + fuzzing/NullOStream.cpp | 10 + fuzzing/NullOStream.h | 20 + fuzzing/build_fuzzers.sh | 33 + fuzzing/fuzz_TestSpecParser.cpp | 16 + fuzzing/fuzz_XmlWriter.cpp | 16 + fuzzing/fuzz_textflow.cpp | 47 + mdsnippets.json | 9 + meson.build | 17 + src/CMakeLists.txt | 507 + src/catch2/benchmark/catch_benchmark.hpp | 144 + src/catch2/benchmark/catch_benchmark_all.hpp | 44 + src/catch2/benchmark/catch_chronometer.cpp | 17 + src/catch2/benchmark/catch_chronometer.hpp | 75 + src/catch2/benchmark/catch_clock.hpp | 39 + src/catch2/benchmark/catch_constructor.hpp | 82 + src/catch2/benchmark/catch_environment.hpp | 37 + src/catch2/benchmark/catch_estimate.hpp | 30 + src/catch2/benchmark/catch_execution_plan.hpp | 58 + src/catch2/benchmark/catch_optimizer.hpp | 71 + .../catch_outlier_classification.hpp | 29 + .../benchmark/catch_sample_analysis.hpp | 49 + src/catch2/benchmark/detail/catch_analyse.hpp | 80 + .../detail/catch_benchmark_function.cpp | 17 + .../detail/catch_benchmark_function.hpp | 108 + .../detail/catch_complete_invoke.hpp | 63 + .../benchmark/detail/catch_estimate_clock.hpp | 121 + src/catch2/benchmark/detail/catch_measure.hpp | 33 + src/catch2/benchmark/detail/catch_repeat.hpp | 36 + .../detail/catch_run_for_at_least.cpp | 30 + .../detail/catch_run_for_at_least.hpp | 65 + src/catch2/benchmark/detail/catch_stats.cpp | 257 + src/catch2/benchmark/detail/catch_stats.hpp | 144 + src/catch2/benchmark/detail/catch_timing.hpp | 31 + src/catch2/catch_all.hpp | 125 + src/catch2/catch_approx.cpp | 85 + src/catch2/catch_approx.hpp | 128 + src/catch2/catch_assertion_info.hpp | 28 + src/catch2/catch_assertion_result.cpp | 105 + src/catch2/catch_assertion_result.hpp | 60 + src/catch2/catch_config.cpp | 247 + src/catch2/catch_config.hpp | 153 + src/catch2/catch_get_random_seed.cpp | 18 + src/catch2/catch_get_random_seed.hpp | 18 + src/catch2/catch_message.cpp | 112 + src/catch2/catch_message.hpp | 146 + src/catch2/catch_registry_hub.cpp | 104 + src/catch2/catch_section_info.hpp | 42 + src/catch2/catch_session.cpp | 357 + src/catch2/catch_session.hpp | 62 + src/catch2/catch_tag_alias.hpp | 29 + src/catch2/catch_tag_alias_autoregistrar.cpp | 24 + src/catch2/catch_tag_alias_autoregistrar.hpp | 29 + src/catch2/catch_template_test_macros.hpp | 124 + src/catch2/catch_test_case_info.cpp | 247 + src/catch2/catch_test_case_info.hpp | 130 + src/catch2/catch_test_macros.hpp | 222 + src/catch2/catch_test_spec.cpp | 137 + src/catch2/catch_test_spec.hpp | 119 + src/catch2/catch_timer.cpp | 37 + src/catch2/catch_timer.hpp | 27 + src/catch2/catch_tostring.cpp | 254 + src/catch2/catch_tostring.hpp | 669 + src/catch2/catch_totals.cpp | 61 + src/catch2/catch_totals.hpp | 40 + src/catch2/catch_translate_exception.hpp | 84 + src/catch2/catch_user_config.hpp.in | 210 + src/catch2/catch_version.cpp | 43 + src/catch2/catch_version.hpp | 39 + src/catch2/catch_version_macros.hpp | 15 + .../generators/catch_generator_exception.cpp | 17 + .../generators/catch_generator_exception.hpp | 31 + src/catch2/generators/catch_generators.cpp | 35 + src/catch2/generators/catch_generators.hpp | 241 + .../generators/catch_generators_adapters.hpp | 241 + .../generators/catch_generators_all.hpp | 30 + .../generators/catch_generators_random.cpp | 13 + .../generators/catch_generators_random.hpp | 98 + .../generators/catch_generators_range.hpp | 110 + .../interfaces/catch_interfaces_all.hpp | 37 + .../interfaces/catch_interfaces_capture.cpp | 13 + .../interfaces/catch_interfaces_capture.hpp | 96 + .../interfaces/catch_interfaces_config.cpp | 13 + .../interfaces/catch_interfaces_config.hpp | 100 + .../catch_interfaces_enum_values_registry.hpp | 47 + .../interfaces/catch_interfaces_exception.cpp | 14 + .../interfaces/catch_interfaces_exception.hpp | 37 + .../catch_interfaces_generatortracker.cpp | 32 + .../catch_interfaces_generatortracker.hpp | 90 + .../catch_interfaces_registry_hub.cpp | 14 + .../catch_interfaces_registry_hub.hpp | 66 + .../interfaces/catch_interfaces_reporter.cpp | 104 + .../interfaces/catch_interfaces_reporter.hpp | 264 + .../catch_interfaces_reporter_factory.cpp | 14 + .../catch_interfaces_reporter_factory.hpp | 45 + .../catch_interfaces_reporter_registry.cpp | 13 + .../catch_interfaces_reporter_registry.hpp | 42 + .../catch_interfaces_tag_alias_registry.hpp | 29 + .../interfaces/catch_interfaces_testcase.cpp | 14 + .../interfaces/catch_interfaces_testcase.hpp | 43 + .../internal/catch_assertion_handler.cpp | 83 + .../internal/catch_assertion_handler.hpp | 71 + .../catch_case_insensitive_comparisons.cpp | 35 + .../catch_case_insensitive_comparisons.hpp | 30 + src/catch2/internal/catch_case_sensitive.hpp | 17 + src/catch2/internal/catch_clara.cpp | 448 + src/catch2/internal/catch_clara.hpp | 702 + src/catch2/internal/catch_commandline.cpp | 313 + src/catch2/internal/catch_commandline.hpp | 21 + src/catch2/internal/catch_compare_traits.hpp | 75 + .../internal/catch_compiler_capabilities.hpp | 413 + .../catch_config_android_logwrite.hpp | 33 + src/catch2/internal/catch_config_counter.hpp | 32 + .../catch_config_uncaught_exceptions.hpp | 44 + src/catch2/internal/catch_config_wchar.hpp | 33 + src/catch2/internal/catch_console_colour.cpp | 282 + src/catch2/internal/catch_console_colour.hpp | 140 + src/catch2/internal/catch_console_width.hpp | 19 + .../internal/catch_container_nonmembers.hpp | 73 + src/catch2/internal/catch_context.cpp | 63 + src/catch2/internal/catch_context.hpp | 58 + src/catch2/internal/catch_debug_console.cpp | 45 + src/catch2/internal/catch_debug_console.hpp | 17 + src/catch2/internal/catch_debugger.cpp | 120 + src/catch2/internal/catch_debugger.hpp | 64 + src/catch2/internal/catch_decomposer.cpp | 23 + src/catch2/internal/catch_decomposer.hpp | 340 + src/catch2/internal/catch_enforce.cpp | 41 + src/catch2/internal/catch_enforce.hpp | 54 + .../internal/catch_enum_values_registry.cpp | 73 + .../internal/catch_enum_values_registry.hpp | 36 + src/catch2/internal/catch_errno_guard.cpp | 16 + src/catch2/internal/catch_errno_guard.hpp | 27 + .../catch_exception_translator_registry.cpp | 80 + .../catch_exception_translator_registry.hpp | 31 + .../catch_fatal_condition_handler.cpp | 243 + .../catch_fatal_condition_handler.hpp | 69 + .../internal/catch_floating_point_helpers.cpp | 32 + .../internal/catch_floating_point_helpers.hpp | 103 + src/catch2/internal/catch_getenv.cpp | 37 + src/catch2/internal/catch_getenv.hpp | 20 + src/catch2/internal/catch_istream.cpp | 159 + src/catch2/internal/catch_istream.hpp | 54 + src/catch2/internal/catch_lazy_expr.cpp | 29 + src/catch2/internal/catch_lazy_expr.hpp | 40 + src/catch2/internal/catch_leak_detector.cpp | 38 + src/catch2/internal/catch_leak_detector.hpp | 19 + src/catch2/internal/catch_list.cpp | 123 + src/catch2/internal/catch_list.hpp | 43 + src/catch2/internal/catch_logical_traits.hpp | 44 + src/catch2/internal/catch_main.cpp | 39 + src/catch2/internal/catch_message_info.cpp | 25 + src/catch2/internal/catch_message_info.hpp | 42 + src/catch2/internal/catch_meta.hpp | 47 + .../internal/catch_move_and_forward.hpp | 19 + src/catch2/internal/catch_noncopyable.hpp | 28 + src/catch2/internal/catch_optional.hpp | 100 + src/catch2/internal/catch_output_redirect.cpp | 146 + src/catch2/internal/catch_output_redirect.hpp | 118 + src/catch2/internal/catch_parse_numbers.cpp | 49 + src/catch2/internal/catch_parse_numbers.hpp | 26 + src/catch2/internal/catch_platform.hpp | 37 + src/catch2/internal/catch_polyfills.cpp | 34 + src/catch2/internal/catch_polyfills.hpp | 16 + src/catch2/internal/catch_preprocessor.hpp | 237 + .../catch_preprocessor_remove_parens.hpp | 19 + .../catch_random_number_generator.cpp | 70 + .../catch_random_number_generator.hpp | 59 + .../internal/catch_random_seed_generation.cpp | 34 + .../internal/catch_random_seed_generation.hpp | 26 + .../internal/catch_reporter_registry.cpp | 65 + .../internal/catch_reporter_registry.hpp | 38 + .../internal/catch_reporter_spec_parser.cpp | 173 + .../internal/catch_reporter_spec_parser.hpp | 85 + src/catch2/internal/catch_result_type.cpp | 26 + src/catch2/internal/catch_result_type.hpp | 55 + .../internal/catch_reusable_string_stream.cpp | 62 + .../internal/catch_reusable_string_stream.hpp | 57 + src/catch2/internal/catch_run_context.cpp | 644 + src/catch2/internal/catch_run_context.hpp | 150 + src/catch2/internal/catch_section.cpp | 42 + src/catch2/internal/catch_section.hpp | 50 + src/catch2/internal/catch_sharding.hpp | 42 + src/catch2/internal/catch_singletons.cpp | 36 + src/catch2/internal/catch_singletons.hpp | 45 + .../internal/catch_source_line_info.cpp | 33 + .../internal/catch_source_line_info.hpp | 37 + .../catch_startup_exception_registry.cpp | 29 + .../catch_startup_exception_registry.hpp | 29 + src/catch2/internal/catch_stdstreams.cpp | 24 + src/catch2/internal/catch_stdstreams.hpp | 22 + src/catch2/internal/catch_stream_end_stop.hpp | 30 + src/catch2/internal/catch_string_manip.cpp | 104 + src/catch2/internal/catch_string_manip.hpp | 60 + src/catch2/internal/catch_stringref.cpp | 70 + src/catch2/internal/catch_stringref.hpp | 116 + .../internal/catch_tag_alias_registry.cpp | 55 + .../internal/catch_tag_alias_registry.hpp | 33 + .../internal/catch_template_test_registry.hpp | 337 + .../internal/catch_test_case_info_hasher.cpp | 39 + .../internal/catch_test_case_info_hasher.hpp | 29 + .../catch_test_case_registry_impl.cpp | 152 + .../catch_test_case_registry_impl.hpp | 72 + .../internal/catch_test_case_tracker.cpp | 250 + .../internal/catch_test_case_tracker.hpp | 197 + .../internal/catch_test_failure_exception.cpp | 23 + .../internal/catch_test_failure_exception.hpp | 25 + src/catch2/internal/catch_test_macro_impl.hpp | 159 + src/catch2/internal/catch_test_registry.cpp | 70 + src/catch2/internal/catch_test_registry.hpp | 122 + .../internal/catch_test_spec_parser.cpp | 241 + .../internal/catch_test_spec_parser.hpp | 81 + src/catch2/internal/catch_textflow.cpp | 255 + src/catch2/internal/catch_textflow.hpp | 169 + src/catch2/internal/catch_to_string.hpp | 29 + .../internal/catch_uncaught_exceptions.cpp | 26 + .../internal/catch_uncaught_exceptions.hpp | 15 + src/catch2/internal/catch_unique_name.hpp | 20 + src/catch2/internal/catch_unique_ptr.hpp | 118 + src/catch2/internal/catch_void_type.hpp | 25 + .../internal/catch_wildcard_pattern.cpp | 47 + .../internal/catch_wildcard_pattern.hpp | 38 + src/catch2/internal/catch_windows_h_proxy.hpp | 28 + src/catch2/internal/catch_xmlwriter.cpp | 347 + src/catch2/internal/catch_xmlwriter.hpp | 152 + src/catch2/matchers/catch_matchers.cpp | 25 + src/catch2/matchers/catch_matchers.hpp | 237 + src/catch2/matchers/catch_matchers_all.hpp | 35 + .../catch_matchers_container_properties.cpp | 34 + .../catch_matchers_container_properties.hpp | 90 + .../matchers/catch_matchers_contains.hpp | 104 + .../matchers/catch_matchers_exception.cpp | 26 + .../matchers/catch_matchers_exception.hpp | 35 + .../catch_matchers_floating_point.cpp | 229 + .../catch_matchers_floating_point.hpp | 78 + .../matchers/catch_matchers_predicate.cpp | 17 + .../matchers/catch_matchers_predicate.hpp | 59 + .../matchers/catch_matchers_quantifiers.cpp | 24 + .../matchers/catch_matchers_quantifiers.hpp | 165 + src/catch2/matchers/catch_matchers_string.cpp | 114 + src/catch2/matchers/catch_matchers_string.hpp | 85 + .../matchers/catch_matchers_templated.cpp | 41 + .../matchers/catch_matchers_templated.hpp | 296 + src/catch2/matchers/catch_matchers_vector.hpp | 195 + .../matchers/internal/catch_matchers_impl.cpp | 25 + .../matchers/internal/catch_matchers_impl.hpp | 83 + src/catch2/meson.build | 364 + .../reporters/catch_reporter_automake.cpp | 35 + .../reporters/catch_reporter_automake.hpp | 39 + .../reporters/catch_reporter_common_base.cpp | 49 + .../reporters/catch_reporter_common_base.hpp | 79 + .../reporters/catch_reporter_compact.cpp | 249 + .../reporters/catch_reporter_compact.hpp | 39 + .../reporters/catch_reporter_console.cpp | 637 + .../reporters/catch_reporter_console.hpp | 67 + .../catch_reporter_cumulative_base.cpp | 158 + .../catch_reporter_cumulative_base.hpp | 152 + .../catch_reporter_event_listener.cpp | 40 + .../catch_reporter_event_listener.hpp | 60 + .../reporters/catch_reporter_helpers.cpp | 336 + .../reporters/catch_reporter_helpers.hpp | 95 + src/catch2/reporters/catch_reporter_junit.cpp | 303 + src/catch2/reporters/catch_reporter_junit.hpp | 58 + src/catch2/reporters/catch_reporter_multi.cpp | 198 + src/catch2/reporters/catch_reporter_multi.hpp | 72 + .../reporters/catch_reporter_registrars.cpp | 30 + .../reporters/catch_reporter_registrars.hpp | 132 + .../reporters/catch_reporter_sonarqube.cpp | 161 + .../reporters/catch_reporter_sonarqube.hpp | 61 + .../catch_reporter_streaming_base.cpp | 23 + .../catch_reporter_streaming_base.hpp | 74 + src/catch2/reporters/catch_reporter_tap.cpp | 223 + src/catch2/reporters/catch_reporter_tap.hpp | 43 + .../reporters/catch_reporter_teamcity.cpp | 175 + .../reporters/catch_reporter_teamcity.hpp | 66 + src/catch2/reporters/catch_reporter_xml.cpp | 322 + src/catch2/reporters/catch_reporter_xml.hpp | 66 + src/catch2/reporters/catch_reporters_all.hpp | 40 + tests/CMakeLists.txt | 658 + tests/ExtraTests/CMakeLists.txt | 537 + tests/ExtraTests/ToDo.txt | 10 + tests/ExtraTests/X01-PrefixedMacros.cpp | 97 + tests/ExtraTests/X02-DisabledMacros.cpp | 65 + .../X03-DisabledExceptions-DefaultHandler.cpp | 39 + .../X04-DisabledExceptions-CustomHandler.cpp | 40 + tests/ExtraTests/X05-DeferredStaticChecks.cpp | 21 + tests/ExtraTests/X10-FallbackStringifier.cpp | 35 + .../ExtraTests/X11-DisableStringification.cpp | 27 + .../ExtraTests/X12-CustomDebugBreakMacro.cpp | 26 + .../ExtraTests/X21-PartialTestCaseEvents.cpp | 74 + .../X22-BenchmarksInCumulativeReporter.cpp | 79 + .../ExtraTests/X23-CasingInReporterNames.cpp | 41 + ...4-ListenerStdoutCaptureInMultireporter.cpp | 40 + .../X25-ListenerCanAskForCapturedStdout.cpp | 47 + ...erencesForPassingAssertionsIsRespected.cpp | 52 + .../X27-CapturedStdoutInTestCaseEvents.cpp | 82 + .../X28-ListenersGetEventsBeforeReporters.cpp | 99 + .../X29-CustomArgumentsForReporters.cpp | 59 + tests/ExtraTests/X30-BazelReporter.cpp | 17 + tests/ExtraTests/X31-DuplicatedTestCases.cpp | 16 + .../X32-DuplicatedTestCasesDifferentTags.cpp | 17 + .../X33-DuplicatedTestCaseMethods.cpp | 22 + ...icatedTestCaseMethodsDifferentFixtures.cpp | 27 + .../X35-DuplicatedReporterNames.cpp | 31 + .../ExtraTests/X90-WindowsHeaderInclusion.cpp | 21 + tests/ExtraTests/X91-AmalgamatedCatch.cpp | 38 + tests/ExtraTests/X92-NoTests.cpp | 11 + .../Baselines/automake.std.approved.txt | 168 + .../Baselines/automake.sw.approved.txt | 402 + .../Baselines/automake.sw.multi.approved.txt | 394 + .../Baselines/compact.sw.approved.txt | 2465 ++ .../Baselines/compact.sw.multi.approved.txt | 2457 ++ .../Baselines/console.std.approved.txt | 1399 ++ .../Baselines/console.sw.approved.txt | 17523 +++++++++++++ .../Baselines/console.sw.multi.approved.txt | 17515 +++++++++++++ .../Baselines/console.swa4.approved.txt | 946 + .../Baselines/default.sw.multi.approved.txt | 8 + .../SelfTest/Baselines/junit.sw.approved.txt | 1914 ++ .../Baselines/junit.sw.multi.approved.txt | 1913 ++ .../Baselines/sonarqube.sw.approved.txt | 1943 ++ .../Baselines/sonarqube.sw.multi.approved.txt | 1942 ++ tests/SelfTest/Baselines/tap.sw.approved.txt | 4326 ++++ .../Baselines/tap.sw.multi.approved.txt | 4318 ++++ .../Baselines/teamcity.sw.approved.txt | 951 + .../Baselines/teamcity.sw.multi.approved.txt | 950 + tests/SelfTest/Baselines/xml.sw.approved.txt | 20488 ++++++++++++++++ .../Baselines/xml.sw.multi.approved.txt | 20487 +++++++++++++++ .../IntrospectiveTests/Clara.tests.cpp | 73 + .../IntrospectiveTests/CmdLine.tests.cpp | 467 + .../CmdLineHelpers.tests.cpp | 111 + .../IntrospectiveTests/ColourImpl.tests.cpp | 64 + .../IntrospectiveTests/Details.tests.cpp | 131 + .../FloatingPoint.tests.cpp | 74 + .../GeneratorsImpl.tests.cpp | 536 + .../InternalBenchmark.tests.cpp | 447 + .../IntrospectiveTests/Parse.tests.cpp | 38 + .../IntrospectiveTests/PartTracker.tests.cpp | 254 + .../RandomNumberGeneration.tests.cpp | 62 + .../IntrospectiveTests/Reporters.tests.cpp | 329 + .../IntrospectiveTests/Sharding.tests.cpp | 45 + .../IntrospectiveTests/Stream.tests.cpp | 32 + .../IntrospectiveTests/String.tests.cpp | 212 + .../IntrospectiveTests/StringManip.tests.cpp | 83 + .../SelfTest/IntrospectiveTests/Tag.tests.cpp | 104 + .../TestCaseInfoHasher.tests.cpp | 72 + .../IntrospectiveTests/TestSpec.tests.cpp | 365 + .../TestSpecParser.tests.cpp | 55 + .../IntrospectiveTests/TextFlow.tests.cpp | 200 + .../IntrospectiveTests/ToString.tests.cpp | 97 + .../IntrospectiveTests/Traits.tests.cpp | 45 + .../IntrospectiveTests/UniquePtr.tests.cpp | 141 + .../SelfTest/IntrospectiveTests/Xml.tests.cpp | 183 + tests/SelfTest/Misc/invalid-test-names.input | 1 + tests/SelfTest/Misc/plain-old-tests.input | 2 + .../Misc/special-characters-in-file.input | 1 + tests/SelfTest/TestRegistrations.cpp | 181 + tests/SelfTest/TimingTests/Sleep.tests.cpp | 24 + tests/SelfTest/UsageTests/Approx.tests.cpp | 218 + tests/SelfTest/UsageTests/BDD.tests.cpp | 106 + tests/SelfTest/UsageTests/Benchmark.tests.cpp | 173 + tests/SelfTest/UsageTests/Class.tests.cpp | 133 + .../SelfTest/UsageTests/Compilation.tests.cpp | 355 + tests/SelfTest/UsageTests/Condition.tests.cpp | 334 + .../UsageTests/Decomposition.tests.cpp | 41 + .../UsageTests/EnumToString.tests.cpp | 108 + tests/SelfTest/UsageTests/Exception.tests.cpp | 204 + .../SelfTest/UsageTests/Generators.tests.cpp | 282 + tests/SelfTest/UsageTests/Matchers.tests.cpp | 1102 + .../UsageTests/MatchersRanges.tests.cpp | 834 + tests/SelfTest/UsageTests/Message.tests.cpp | 287 + tests/SelfTest/UsageTests/Misc.tests.cpp | 553 + .../UsageTests/ToStringByte.tests.cpp | 23 + .../UsageTests/ToStringChrono.tests.cpp | 51 + .../UsageTests/ToStringGeneral.tests.cpp | 211 + .../UsageTests/ToStringOptional.tests.cpp | 31 + .../UsageTests/ToStringPair.tests.cpp | 38 + .../UsageTests/ToStringTuple.tests.cpp | 54 + .../UsageTests/ToStringVariant.tests.cpp | 99 + .../UsageTests/ToStringVector.tests.cpp | 94 + .../UsageTests/ToStringWhich.tests.cpp | 186 + tests/SelfTest/UsageTests/Tricky.tests.cpp | 380 + .../UsageTests/VariadicMacros.tests.cpp | 29 + tests/SelfTest/helpers/parse_test_spec.cpp | 22 + tests/SelfTest/helpers/parse_test_spec.hpp | 20 + .../helpers/type_with_lit_0_comparisons.hpp | 44 + tests/TestScripts/ConfigureTestsCommon.py | 75 + tests/TestScripts/testBazelReporter.py | 104 + tests/TestScripts/testBazelSharding.py | 75 + .../testConfigureDefaultReporter.py | 41 + tests/TestScripts/testConfigureDisable.py | 48 + .../testConfigureDisableStringification.py | 44 + .../testConfigureExperimentalRedirect.py | 49 + tests/TestScripts/testPartialTestCaseEvent.py | 79 + tests/TestScripts/testRandomOrder.py | 77 + tests/TestScripts/testSharding.py | 165 + tests/meson.build | 75 + third_party/clara.hpp | 1267 + tools/misc/CMakeLists.txt | 11 + tools/misc/SelfTest.vcxproj.user | 23 + .../misc/appveyorBuildConfigurationScript.bat | 21 + tools/misc/appveyorMergeCoverageScript.py | 9 + tools/misc/appveyorTestRunScript.bat | 17 + tools/misc/coverage-helper.cpp | 142 + tools/misc/installOpenCppCoverage.ps1 | 19 + tools/scripts/approvalTests.py | 246 + tools/scripts/approve.py | 31 + tools/scripts/buildAndTest.cmd | 17 + tools/scripts/buildAndTest.sh | 19 + tools/scripts/checkConvenienceHeaders.py | 151 + tools/scripts/checkDuplicateFilenames.py | 14 + tools/scripts/checkLicense.py | 45 + tools/scripts/developBuild.py | 9 + .../extractFeaturesFromReleaseNotes.py | 92 + tools/scripts/fixWhitespace.py | 51 + tools/scripts/generateAmalgamatedFiles.py | 129 + tools/scripts/majorRelease.py | 9 + tools/scripts/minorRelease.py | 9 + tools/scripts/patchRelease.py | 9 + tools/scripts/releaseCommon.py | 143 + tools/scripts/scriptCommon.py | 4 + tools/scripts/updateDocumentSnippets.py | 23 + tools/scripts/updateDocumentToC.py | 447 + 521 files changed, 182737 insertions(+) create mode 100644 .bazelrc create mode 100644 .clang-format create mode 100644 .conan/build.py create mode 100644 .conan/test_package/CMakeLists.txt create mode 100644 .conan/test_package/conanfile.py create mode 100644 .conan/test_package/test_package.cpp create mode 100644 .gitattributes create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/linux-bazel-builds.yml create mode 100644 .github/workflows/linux-meson-builds.yml create mode 100644 .github/workflows/linux-other-builds.yml create mode 100644 .github/workflows/linux-simple-builds.yml create mode 100644 .github/workflows/mac-builds.yml create mode 100644 .github/workflows/validate-header-guards.yml create mode 100644 .gitignore create mode 100644 BUILD.bazel create mode 100644 CMake/Catch2Config.cmake.in create mode 100644 CMake/CatchConfigOptions.cmake create mode 100644 CMake/CatchMiscFunctions.cmake create mode 100644 CMake/FindGcov.cmake create mode 100644 CMake/FindLcov.cmake create mode 100644 CMake/Findcodecov.cmake create mode 100644 CMake/catch2-with-main.pc.in create mode 100644 CMake/catch2.pc.in create mode 100755 CMake/llvm-cov-wrapper create mode 100644 CMakeLists.txt create mode 100644 CMakePresets.json create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Doxyfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 WORKSPACE.bazel create mode 100644 appveyor.yml create mode 100644 codecov.yml create mode 100644 conanfile.py create mode 100644 data/artwork/catch2-c-logo.png create mode 100644 data/artwork/catch2-hand-logo.png create mode 100644 data/artwork/catch2-logo-small-with-background.png create mode 100644 data/artwork/catch2-logo-small.png create mode 100644 docs/Readme.md create mode 100644 docs/assertions.md create mode 100644 docs/benchmarks.md create mode 100644 docs/ci-and-misc.md create mode 100644 docs/cmake-integration.md create mode 100644 docs/command-line.md create mode 100644 docs/commercial-users.md create mode 100644 docs/comparing-floating-point-numbers.md create mode 100644 docs/configuration.md create mode 100644 docs/contributing.md create mode 100644 docs/deprecations.md create mode 100644 docs/event-listeners.md create mode 100644 docs/faq.md create mode 100644 docs/generators.md create mode 100644 docs/limitations.md create mode 100644 docs/list-of-examples.md create mode 100644 docs/logging.md create mode 100644 docs/matchers.md create mode 100644 docs/migrate-v2-to-v3.md create mode 100644 docs/opensource-users.md create mode 100644 docs/other-macros.md create mode 100644 docs/own-main.md create mode 100644 docs/release-notes.md create mode 100644 docs/release-process.md create mode 100644 docs/reporter-events.md create mode 100644 docs/reporters.md create mode 100644 docs/test-cases-and-sections.md create mode 100644 docs/test-fixtures.md create mode 100644 docs/tostring.md create mode 100644 docs/tutorial.md create mode 100644 docs/usage-tips.md create mode 100644 docs/why-catch.md create mode 100644 examples/010-TestCase.cpp create mode 100644 examples/020-TestCase-1.cpp create mode 100644 examples/020-TestCase-2.cpp create mode 100644 examples/030-Asn-Require-Check.cpp create mode 100644 examples/100-Fix-Section.cpp create mode 100644 examples/110-Fix-ClassFixture.cpp create mode 100644 examples/120-Bdd-ScenarioGivenWhenThen.cpp create mode 100644 examples/210-Evt-EventListeners.cpp create mode 100644 examples/231-Cfg-OutputStreams.cpp create mode 100644 examples/300-Gen-OwnGenerator.cpp create mode 100644 examples/301-Gen-MapTypeConversion.cpp create mode 100644 examples/302-Gen-Table.cpp create mode 100644 examples/310-Gen-VariablesInGenerators.cpp create mode 100644 examples/311-Gen-CustomCapture.cpp create mode 100644 examples/CMakeLists.txt create mode 100644 extras/Catch.cmake create mode 100644 extras/CatchAddTests.cmake create mode 100644 extras/CatchShardTests.cmake create mode 100644 extras/CatchShardTestsImpl.cmake create mode 100644 extras/ParseAndAddCatchTests.cmake create mode 100644 extras/catch_amalgamated.cpp create mode 100644 extras/catch_amalgamated.hpp create mode 100644 extras/gdbinit create mode 100644 extras/lldbinit create mode 100644 fuzzing/CMakeLists.txt create mode 100644 fuzzing/NullOStream.cpp create mode 100644 fuzzing/NullOStream.h create mode 100755 fuzzing/build_fuzzers.sh create mode 100644 fuzzing/fuzz_TestSpecParser.cpp create mode 100644 fuzzing/fuzz_XmlWriter.cpp create mode 100644 fuzzing/fuzz_textflow.cpp create mode 100644 mdsnippets.json create mode 100644 meson.build create mode 100644 src/CMakeLists.txt create mode 100644 src/catch2/benchmark/catch_benchmark.hpp create mode 100644 src/catch2/benchmark/catch_benchmark_all.hpp create mode 100644 src/catch2/benchmark/catch_chronometer.cpp create mode 100644 src/catch2/benchmark/catch_chronometer.hpp create mode 100644 src/catch2/benchmark/catch_clock.hpp create mode 100644 src/catch2/benchmark/catch_constructor.hpp create mode 100644 src/catch2/benchmark/catch_environment.hpp create mode 100644 src/catch2/benchmark/catch_estimate.hpp create mode 100644 src/catch2/benchmark/catch_execution_plan.hpp create mode 100644 src/catch2/benchmark/catch_optimizer.hpp create mode 100644 src/catch2/benchmark/catch_outlier_classification.hpp create mode 100644 src/catch2/benchmark/catch_sample_analysis.hpp create mode 100644 src/catch2/benchmark/detail/catch_analyse.hpp create mode 100644 src/catch2/benchmark/detail/catch_benchmark_function.cpp create mode 100644 src/catch2/benchmark/detail/catch_benchmark_function.hpp create mode 100644 src/catch2/benchmark/detail/catch_complete_invoke.hpp create mode 100644 src/catch2/benchmark/detail/catch_estimate_clock.hpp create mode 100644 src/catch2/benchmark/detail/catch_measure.hpp create mode 100644 src/catch2/benchmark/detail/catch_repeat.hpp create mode 100644 src/catch2/benchmark/detail/catch_run_for_at_least.cpp create mode 100644 src/catch2/benchmark/detail/catch_run_for_at_least.hpp create mode 100644 src/catch2/benchmark/detail/catch_stats.cpp create mode 100644 src/catch2/benchmark/detail/catch_stats.hpp create mode 100644 src/catch2/benchmark/detail/catch_timing.hpp create mode 100644 src/catch2/catch_all.hpp create mode 100644 src/catch2/catch_approx.cpp create mode 100644 src/catch2/catch_approx.hpp create mode 100644 src/catch2/catch_assertion_info.hpp create mode 100644 src/catch2/catch_assertion_result.cpp create mode 100644 src/catch2/catch_assertion_result.hpp create mode 100644 src/catch2/catch_config.cpp create mode 100644 src/catch2/catch_config.hpp create mode 100644 src/catch2/catch_get_random_seed.cpp create mode 100644 src/catch2/catch_get_random_seed.hpp create mode 100644 src/catch2/catch_message.cpp create mode 100644 src/catch2/catch_message.hpp create mode 100644 src/catch2/catch_registry_hub.cpp create mode 100644 src/catch2/catch_section_info.hpp create mode 100644 src/catch2/catch_session.cpp create mode 100644 src/catch2/catch_session.hpp create mode 100644 src/catch2/catch_tag_alias.hpp create mode 100644 src/catch2/catch_tag_alias_autoregistrar.cpp create mode 100644 src/catch2/catch_tag_alias_autoregistrar.hpp create mode 100644 src/catch2/catch_template_test_macros.hpp create mode 100644 src/catch2/catch_test_case_info.cpp create mode 100644 src/catch2/catch_test_case_info.hpp create mode 100644 src/catch2/catch_test_macros.hpp create mode 100644 src/catch2/catch_test_spec.cpp create mode 100644 src/catch2/catch_test_spec.hpp create mode 100644 src/catch2/catch_timer.cpp create mode 100644 src/catch2/catch_timer.hpp create mode 100644 src/catch2/catch_tostring.cpp create mode 100644 src/catch2/catch_tostring.hpp create mode 100644 src/catch2/catch_totals.cpp create mode 100644 src/catch2/catch_totals.hpp create mode 100644 src/catch2/catch_translate_exception.hpp create mode 100644 src/catch2/catch_user_config.hpp.in create mode 100644 src/catch2/catch_version.cpp create mode 100644 src/catch2/catch_version.hpp create mode 100644 src/catch2/catch_version_macros.hpp create mode 100644 src/catch2/generators/catch_generator_exception.cpp create mode 100644 src/catch2/generators/catch_generator_exception.hpp create mode 100644 src/catch2/generators/catch_generators.cpp create mode 100644 src/catch2/generators/catch_generators.hpp create mode 100644 src/catch2/generators/catch_generators_adapters.hpp create mode 100644 src/catch2/generators/catch_generators_all.hpp create mode 100644 src/catch2/generators/catch_generators_random.cpp create mode 100644 src/catch2/generators/catch_generators_random.hpp create mode 100644 src/catch2/generators/catch_generators_range.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_all.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_capture.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_capture.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_config.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_config.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_enum_values_registry.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_exception.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_exception.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_generatortracker.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_generatortracker.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_registry_hub.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_registry_hub.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter_factory.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter_factory.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter_registry.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_reporter_registry.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_tag_alias_registry.hpp create mode 100644 src/catch2/interfaces/catch_interfaces_testcase.cpp create mode 100644 src/catch2/interfaces/catch_interfaces_testcase.hpp create mode 100644 src/catch2/internal/catch_assertion_handler.cpp create mode 100644 src/catch2/internal/catch_assertion_handler.hpp create mode 100644 src/catch2/internal/catch_case_insensitive_comparisons.cpp create mode 100644 src/catch2/internal/catch_case_insensitive_comparisons.hpp create mode 100644 src/catch2/internal/catch_case_sensitive.hpp create mode 100644 src/catch2/internal/catch_clara.cpp create mode 100644 src/catch2/internal/catch_clara.hpp create mode 100644 src/catch2/internal/catch_commandline.cpp create mode 100644 src/catch2/internal/catch_commandline.hpp create mode 100644 src/catch2/internal/catch_compare_traits.hpp create mode 100644 src/catch2/internal/catch_compiler_capabilities.hpp create mode 100644 src/catch2/internal/catch_config_android_logwrite.hpp create mode 100644 src/catch2/internal/catch_config_counter.hpp create mode 100644 src/catch2/internal/catch_config_uncaught_exceptions.hpp create mode 100644 src/catch2/internal/catch_config_wchar.hpp create mode 100644 src/catch2/internal/catch_console_colour.cpp create mode 100644 src/catch2/internal/catch_console_colour.hpp create mode 100644 src/catch2/internal/catch_console_width.hpp create mode 100644 src/catch2/internal/catch_container_nonmembers.hpp create mode 100644 src/catch2/internal/catch_context.cpp create mode 100644 src/catch2/internal/catch_context.hpp create mode 100644 src/catch2/internal/catch_debug_console.cpp create mode 100644 src/catch2/internal/catch_debug_console.hpp create mode 100644 src/catch2/internal/catch_debugger.cpp create mode 100644 src/catch2/internal/catch_debugger.hpp create mode 100644 src/catch2/internal/catch_decomposer.cpp create mode 100644 src/catch2/internal/catch_decomposer.hpp create mode 100644 src/catch2/internal/catch_enforce.cpp create mode 100644 src/catch2/internal/catch_enforce.hpp create mode 100644 src/catch2/internal/catch_enum_values_registry.cpp create mode 100644 src/catch2/internal/catch_enum_values_registry.hpp create mode 100644 src/catch2/internal/catch_errno_guard.cpp create mode 100644 src/catch2/internal/catch_errno_guard.hpp create mode 100644 src/catch2/internal/catch_exception_translator_registry.cpp create mode 100644 src/catch2/internal/catch_exception_translator_registry.hpp create mode 100644 src/catch2/internal/catch_fatal_condition_handler.cpp create mode 100644 src/catch2/internal/catch_fatal_condition_handler.hpp create mode 100644 src/catch2/internal/catch_floating_point_helpers.cpp create mode 100644 src/catch2/internal/catch_floating_point_helpers.hpp create mode 100644 src/catch2/internal/catch_getenv.cpp create mode 100644 src/catch2/internal/catch_getenv.hpp create mode 100644 src/catch2/internal/catch_istream.cpp create mode 100644 src/catch2/internal/catch_istream.hpp create mode 100644 src/catch2/internal/catch_lazy_expr.cpp create mode 100644 src/catch2/internal/catch_lazy_expr.hpp create mode 100644 src/catch2/internal/catch_leak_detector.cpp create mode 100644 src/catch2/internal/catch_leak_detector.hpp create mode 100644 src/catch2/internal/catch_list.cpp create mode 100644 src/catch2/internal/catch_list.hpp create mode 100644 src/catch2/internal/catch_logical_traits.hpp create mode 100644 src/catch2/internal/catch_main.cpp create mode 100644 src/catch2/internal/catch_message_info.cpp create mode 100644 src/catch2/internal/catch_message_info.hpp create mode 100644 src/catch2/internal/catch_meta.hpp create mode 100644 src/catch2/internal/catch_move_and_forward.hpp create mode 100644 src/catch2/internal/catch_noncopyable.hpp create mode 100644 src/catch2/internal/catch_optional.hpp create mode 100644 src/catch2/internal/catch_output_redirect.cpp create mode 100644 src/catch2/internal/catch_output_redirect.hpp create mode 100644 src/catch2/internal/catch_parse_numbers.cpp create mode 100644 src/catch2/internal/catch_parse_numbers.hpp create mode 100644 src/catch2/internal/catch_platform.hpp create mode 100644 src/catch2/internal/catch_polyfills.cpp create mode 100644 src/catch2/internal/catch_polyfills.hpp create mode 100644 src/catch2/internal/catch_preprocessor.hpp create mode 100644 src/catch2/internal/catch_preprocessor_remove_parens.hpp create mode 100644 src/catch2/internal/catch_random_number_generator.cpp create mode 100644 src/catch2/internal/catch_random_number_generator.hpp create mode 100644 src/catch2/internal/catch_random_seed_generation.cpp create mode 100644 src/catch2/internal/catch_random_seed_generation.hpp create mode 100644 src/catch2/internal/catch_reporter_registry.cpp create mode 100644 src/catch2/internal/catch_reporter_registry.hpp create mode 100644 src/catch2/internal/catch_reporter_spec_parser.cpp create mode 100644 src/catch2/internal/catch_reporter_spec_parser.hpp create mode 100644 src/catch2/internal/catch_result_type.cpp create mode 100644 src/catch2/internal/catch_result_type.hpp create mode 100644 src/catch2/internal/catch_reusable_string_stream.cpp create mode 100644 src/catch2/internal/catch_reusable_string_stream.hpp create mode 100644 src/catch2/internal/catch_run_context.cpp create mode 100644 src/catch2/internal/catch_run_context.hpp create mode 100644 src/catch2/internal/catch_section.cpp create mode 100644 src/catch2/internal/catch_section.hpp create mode 100644 src/catch2/internal/catch_sharding.hpp create mode 100644 src/catch2/internal/catch_singletons.cpp create mode 100644 src/catch2/internal/catch_singletons.hpp create mode 100644 src/catch2/internal/catch_source_line_info.cpp create mode 100644 src/catch2/internal/catch_source_line_info.hpp create mode 100644 src/catch2/internal/catch_startup_exception_registry.cpp create mode 100644 src/catch2/internal/catch_startup_exception_registry.hpp create mode 100644 src/catch2/internal/catch_stdstreams.cpp create mode 100644 src/catch2/internal/catch_stdstreams.hpp create mode 100644 src/catch2/internal/catch_stream_end_stop.hpp create mode 100644 src/catch2/internal/catch_string_manip.cpp create mode 100644 src/catch2/internal/catch_string_manip.hpp create mode 100644 src/catch2/internal/catch_stringref.cpp create mode 100644 src/catch2/internal/catch_stringref.hpp create mode 100644 src/catch2/internal/catch_tag_alias_registry.cpp create mode 100644 src/catch2/internal/catch_tag_alias_registry.hpp create mode 100644 src/catch2/internal/catch_template_test_registry.hpp create mode 100644 src/catch2/internal/catch_test_case_info_hasher.cpp create mode 100644 src/catch2/internal/catch_test_case_info_hasher.hpp create mode 100644 src/catch2/internal/catch_test_case_registry_impl.cpp create mode 100644 src/catch2/internal/catch_test_case_registry_impl.hpp create mode 100644 src/catch2/internal/catch_test_case_tracker.cpp create mode 100644 src/catch2/internal/catch_test_case_tracker.hpp create mode 100644 src/catch2/internal/catch_test_failure_exception.cpp create mode 100644 src/catch2/internal/catch_test_failure_exception.hpp create mode 100644 src/catch2/internal/catch_test_macro_impl.hpp create mode 100644 src/catch2/internal/catch_test_registry.cpp create mode 100644 src/catch2/internal/catch_test_registry.hpp create mode 100644 src/catch2/internal/catch_test_spec_parser.cpp create mode 100644 src/catch2/internal/catch_test_spec_parser.hpp create mode 100644 src/catch2/internal/catch_textflow.cpp create mode 100644 src/catch2/internal/catch_textflow.hpp create mode 100644 src/catch2/internal/catch_to_string.hpp create mode 100644 src/catch2/internal/catch_uncaught_exceptions.cpp create mode 100644 src/catch2/internal/catch_uncaught_exceptions.hpp create mode 100644 src/catch2/internal/catch_unique_name.hpp create mode 100644 src/catch2/internal/catch_unique_ptr.hpp create mode 100644 src/catch2/internal/catch_void_type.hpp create mode 100644 src/catch2/internal/catch_wildcard_pattern.cpp create mode 100644 src/catch2/internal/catch_wildcard_pattern.hpp create mode 100644 src/catch2/internal/catch_windows_h_proxy.hpp create mode 100644 src/catch2/internal/catch_xmlwriter.cpp create mode 100644 src/catch2/internal/catch_xmlwriter.hpp create mode 100644 src/catch2/matchers/catch_matchers.cpp create mode 100644 src/catch2/matchers/catch_matchers.hpp create mode 100644 src/catch2/matchers/catch_matchers_all.hpp create mode 100644 src/catch2/matchers/catch_matchers_container_properties.cpp create mode 100644 src/catch2/matchers/catch_matchers_container_properties.hpp create mode 100644 src/catch2/matchers/catch_matchers_contains.hpp create mode 100644 src/catch2/matchers/catch_matchers_exception.cpp create mode 100644 src/catch2/matchers/catch_matchers_exception.hpp create mode 100644 src/catch2/matchers/catch_matchers_floating_point.cpp create mode 100644 src/catch2/matchers/catch_matchers_floating_point.hpp create mode 100644 src/catch2/matchers/catch_matchers_predicate.cpp create mode 100644 src/catch2/matchers/catch_matchers_predicate.hpp create mode 100644 src/catch2/matchers/catch_matchers_quantifiers.cpp create mode 100644 src/catch2/matchers/catch_matchers_quantifiers.hpp create mode 100644 src/catch2/matchers/catch_matchers_string.cpp create mode 100644 src/catch2/matchers/catch_matchers_string.hpp create mode 100644 src/catch2/matchers/catch_matchers_templated.cpp create mode 100644 src/catch2/matchers/catch_matchers_templated.hpp create mode 100644 src/catch2/matchers/catch_matchers_vector.hpp create mode 100644 src/catch2/matchers/internal/catch_matchers_impl.cpp create mode 100644 src/catch2/matchers/internal/catch_matchers_impl.hpp create mode 100644 src/catch2/meson.build create mode 100644 src/catch2/reporters/catch_reporter_automake.cpp create mode 100644 src/catch2/reporters/catch_reporter_automake.hpp create mode 100644 src/catch2/reporters/catch_reporter_common_base.cpp create mode 100644 src/catch2/reporters/catch_reporter_common_base.hpp create mode 100644 src/catch2/reporters/catch_reporter_compact.cpp create mode 100644 src/catch2/reporters/catch_reporter_compact.hpp create mode 100644 src/catch2/reporters/catch_reporter_console.cpp create mode 100644 src/catch2/reporters/catch_reporter_console.hpp create mode 100644 src/catch2/reporters/catch_reporter_cumulative_base.cpp create mode 100644 src/catch2/reporters/catch_reporter_cumulative_base.hpp create mode 100644 src/catch2/reporters/catch_reporter_event_listener.cpp create mode 100644 src/catch2/reporters/catch_reporter_event_listener.hpp create mode 100644 src/catch2/reporters/catch_reporter_helpers.cpp create mode 100644 src/catch2/reporters/catch_reporter_helpers.hpp create mode 100644 src/catch2/reporters/catch_reporter_junit.cpp create mode 100644 src/catch2/reporters/catch_reporter_junit.hpp create mode 100644 src/catch2/reporters/catch_reporter_multi.cpp create mode 100644 src/catch2/reporters/catch_reporter_multi.hpp create mode 100644 src/catch2/reporters/catch_reporter_registrars.cpp create mode 100644 src/catch2/reporters/catch_reporter_registrars.hpp create mode 100644 src/catch2/reporters/catch_reporter_sonarqube.cpp create mode 100644 src/catch2/reporters/catch_reporter_sonarqube.hpp create mode 100644 src/catch2/reporters/catch_reporter_streaming_base.cpp create mode 100644 src/catch2/reporters/catch_reporter_streaming_base.hpp create mode 100644 src/catch2/reporters/catch_reporter_tap.cpp create mode 100644 src/catch2/reporters/catch_reporter_tap.hpp create mode 100644 src/catch2/reporters/catch_reporter_teamcity.cpp create mode 100644 src/catch2/reporters/catch_reporter_teamcity.hpp create mode 100644 src/catch2/reporters/catch_reporter_xml.cpp create mode 100644 src/catch2/reporters/catch_reporter_xml.hpp create mode 100644 src/catch2/reporters/catch_reporters_all.hpp create mode 100644 tests/CMakeLists.txt create mode 100644 tests/ExtraTests/CMakeLists.txt create mode 100644 tests/ExtraTests/ToDo.txt create mode 100644 tests/ExtraTests/X01-PrefixedMacros.cpp create mode 100644 tests/ExtraTests/X02-DisabledMacros.cpp create mode 100644 tests/ExtraTests/X03-DisabledExceptions-DefaultHandler.cpp create mode 100644 tests/ExtraTests/X04-DisabledExceptions-CustomHandler.cpp create mode 100644 tests/ExtraTests/X05-DeferredStaticChecks.cpp create mode 100644 tests/ExtraTests/X10-FallbackStringifier.cpp create mode 100644 tests/ExtraTests/X11-DisableStringification.cpp create mode 100644 tests/ExtraTests/X12-CustomDebugBreakMacro.cpp create mode 100644 tests/ExtraTests/X21-PartialTestCaseEvents.cpp create mode 100644 tests/ExtraTests/X22-BenchmarksInCumulativeReporter.cpp create mode 100644 tests/ExtraTests/X23-CasingInReporterNames.cpp create mode 100644 tests/ExtraTests/X24-ListenerStdoutCaptureInMultireporter.cpp create mode 100644 tests/ExtraTests/X25-ListenerCanAskForCapturedStdout.cpp create mode 100644 tests/ExtraTests/X26-ReporterPreferencesForPassingAssertionsIsRespected.cpp create mode 100644 tests/ExtraTests/X27-CapturedStdoutInTestCaseEvents.cpp create mode 100644 tests/ExtraTests/X28-ListenersGetEventsBeforeReporters.cpp create mode 100644 tests/ExtraTests/X29-CustomArgumentsForReporters.cpp create mode 100644 tests/ExtraTests/X30-BazelReporter.cpp create mode 100644 tests/ExtraTests/X31-DuplicatedTestCases.cpp create mode 100644 tests/ExtraTests/X32-DuplicatedTestCasesDifferentTags.cpp create mode 100644 tests/ExtraTests/X33-DuplicatedTestCaseMethods.cpp create mode 100644 tests/ExtraTests/X34-DuplicatedTestCaseMethodsDifferentFixtures.cpp create mode 100644 tests/ExtraTests/X35-DuplicatedReporterNames.cpp create mode 100644 tests/ExtraTests/X90-WindowsHeaderInclusion.cpp create mode 100644 tests/ExtraTests/X91-AmalgamatedCatch.cpp create mode 100644 tests/ExtraTests/X92-NoTests.cpp create mode 100644 tests/SelfTest/Baselines/automake.std.approved.txt create mode 100644 tests/SelfTest/Baselines/automake.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/automake.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/compact.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/compact.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/console.std.approved.txt create mode 100644 tests/SelfTest/Baselines/console.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/console.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/console.swa4.approved.txt create mode 100644 tests/SelfTest/Baselines/default.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/junit.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/junit.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/sonarqube.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/sonarqube.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/tap.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/tap.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/teamcity.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/teamcity.sw.multi.approved.txt create mode 100644 tests/SelfTest/Baselines/xml.sw.approved.txt create mode 100644 tests/SelfTest/Baselines/xml.sw.multi.approved.txt create mode 100644 tests/SelfTest/IntrospectiveTests/Clara.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/CmdLineHelpers.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/ColourImpl.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Details.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/FloatingPoint.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/InternalBenchmark.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Parse.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/PartTracker.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/RandomNumberGeneration.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Reporters.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Sharding.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Stream.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/String.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/StringManip.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Tag.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/TestCaseInfoHasher.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/TestSpec.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/TestSpecParser.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/TextFlow.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/ToString.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Traits.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/UniquePtr.tests.cpp create mode 100644 tests/SelfTest/IntrospectiveTests/Xml.tests.cpp create mode 100644 tests/SelfTest/Misc/invalid-test-names.input create mode 100644 tests/SelfTest/Misc/plain-old-tests.input create mode 100644 tests/SelfTest/Misc/special-characters-in-file.input create mode 100644 tests/SelfTest/TestRegistrations.cpp create mode 100644 tests/SelfTest/TimingTests/Sleep.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Approx.tests.cpp create mode 100644 tests/SelfTest/UsageTests/BDD.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Benchmark.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Class.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Compilation.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Condition.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Decomposition.tests.cpp create mode 100644 tests/SelfTest/UsageTests/EnumToString.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Exception.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Generators.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Matchers.tests.cpp create mode 100644 tests/SelfTest/UsageTests/MatchersRanges.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Message.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Misc.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringByte.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringChrono.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringGeneral.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringOptional.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringPair.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringTuple.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringVariant.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringVector.tests.cpp create mode 100644 tests/SelfTest/UsageTests/ToStringWhich.tests.cpp create mode 100644 tests/SelfTest/UsageTests/Tricky.tests.cpp create mode 100644 tests/SelfTest/UsageTests/VariadicMacros.tests.cpp create mode 100644 tests/SelfTest/helpers/parse_test_spec.cpp create mode 100644 tests/SelfTest/helpers/parse_test_spec.hpp create mode 100644 tests/SelfTest/helpers/type_with_lit_0_comparisons.hpp create mode 100644 tests/TestScripts/ConfigureTestsCommon.py create mode 100644 tests/TestScripts/testBazelReporter.py create mode 100755 tests/TestScripts/testBazelSharding.py create mode 100644 tests/TestScripts/testConfigureDefaultReporter.py create mode 100644 tests/TestScripts/testConfigureDisable.py create mode 100644 tests/TestScripts/testConfigureDisableStringification.py create mode 100644 tests/TestScripts/testConfigureExperimentalRedirect.py create mode 100755 tests/TestScripts/testPartialTestCaseEvent.py create mode 100755 tests/TestScripts/testRandomOrder.py create mode 100755 tests/TestScripts/testSharding.py create mode 100644 tests/meson.build create mode 100644 third_party/clara.hpp create mode 100644 tools/misc/CMakeLists.txt create mode 100644 tools/misc/SelfTest.vcxproj.user create mode 100644 tools/misc/appveyorBuildConfigurationScript.bat create mode 100644 tools/misc/appveyorMergeCoverageScript.py create mode 100644 tools/misc/appveyorTestRunScript.bat create mode 100644 tools/misc/coverage-helper.cpp create mode 100644 tools/misc/installOpenCppCoverage.ps1 create mode 100755 tools/scripts/approvalTests.py create mode 100755 tools/scripts/approve.py create mode 100644 tools/scripts/buildAndTest.cmd create mode 100755 tools/scripts/buildAndTest.sh create mode 100755 tools/scripts/checkConvenienceHeaders.py create mode 100755 tools/scripts/checkDuplicateFilenames.py create mode 100755 tools/scripts/checkLicense.py create mode 100755 tools/scripts/developBuild.py create mode 100644 tools/scripts/extractFeaturesFromReleaseNotes.py create mode 100755 tools/scripts/fixWhitespace.py create mode 100755 tools/scripts/generateAmalgamatedFiles.py create mode 100755 tools/scripts/majorRelease.py create mode 100755 tools/scripts/minorRelease.py create mode 100755 tools/scripts/patchRelease.py create mode 100644 tools/scripts/releaseCommon.py create mode 100644 tools/scripts/scriptCommon.py create mode 100755 tools/scripts/updateDocumentSnippets.py create mode 100755 tools/scripts/updateDocumentToC.py diff --git a/.bazelrc b/.bazelrc new file mode 100644 index 00000000..c01cb39f --- /dev/null +++ b/.bazelrc @@ -0,0 +1,10 @@ +build --enable_platform_specific_config + +build:gcc9 --cxxopt=-std=c++2a +build:gcc11 --cxxopt=-std=c++2a +build:clang13 --cxxopt=-std=c++17 +build:vs2019 --cxxopt=/std:c++17 +build:vs2022 --cxxopt=/std:c++17 + +build:windows --config=vs2022 +build:linux --config=gcc11 diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..f67a5862 --- /dev/null +++ b/.clang-format @@ -0,0 +1,44 @@ +--- +Language: Cpp +Standard: c++14 + +# Note that we cannot use IncludeIsMainRegex functionality, because it +# does not support includes in angle brackets (<>) +SortIncludes: True +IncludeBlocks: Regroup +IncludeCategories: + - Regex: '' + Priority: 1 + - Regex: '<.*/.*\.hpp>' + Priority: 2 + - Regex: '<.*>' + Priority: 3 + + +AllowShortBlocksOnASingleLine: Always +AllowShortEnumsOnASingleLine: false +AllowShortFunctionsOnASingleLine: All +AllowShortIfStatementsOnASingleLine: WithoutElse +AllowShortLambdasOnASingleLine: Inline + +AccessModifierOffset: '-4' +AlignEscapedNewlines: Left +AllowAllConstructorInitializersOnNextLine: 'true' +BinPackArguments: 'false' +BinPackParameters: 'false' +BreakConstructorInitializers: AfterColon +ConstructorInitializerAllOnOneLineOrOnePerLine: 'true' +DerivePointerAlignment: 'false' +FixNamespaceComments: 'true' +IndentCaseLabels: 'false' +IndentPPDirectives: AfterHash +IndentWidth: '4' +NamespaceIndentation: All +PointerAlignment: Left +SpaceBeforeCtorInitializerColon: 'false' +SpaceInEmptyParentheses: 'false' +SpacesInParentheses: 'true' +TabWidth: '4' +UseTab: Never + +... diff --git a/.conan/build.py b/.conan/build.py new file mode 100644 index 00000000..e163d5f4 --- /dev/null +++ b/.conan/build.py @@ -0,0 +1,94 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +import os +import re +from cpt.packager import ConanMultiPackager +from cpt.ci_manager import CIManager +from cpt.printer import Printer + + +class BuilderSettings(object): + @property + def username(self): + """ Set catchorg as package's owner + """ + return os.getenv("CONAN_USERNAME", "catchorg") + + @property + def login_username(self): + """ Set Bintray login username + """ + return os.getenv("CONAN_LOGIN_USERNAME", "horenmar") + + @property + def upload(self): + """ Set Catch2 repository to be used on upload. + The upload server address could be customized by env var + CONAN_UPLOAD. If not defined, the method will check the branch name. + Only devel or CONAN_STABLE_BRANCH_PATTERN will be accepted. + The devel branch will be pushed to testing channel, because it does + not match the stable pattern. Otherwise it will upload to stable + channel. + """ + return os.getenv("CONAN_UPLOAD", "https://api.bintray.com/conan/catchorg/catch2") + + @property + def upload_only_when_stable(self): + """ Force to upload when running over tag branch + """ + return os.getenv("CONAN_UPLOAD_ONLY_WHEN_STABLE", "True").lower() in ["true", "1", "yes"] + + @property + def stable_branch_pattern(self): + """ Only upload the package the branch name is like a tag + """ + return os.getenv("CONAN_STABLE_BRANCH_PATTERN", r"v\d+\.\d+\.\d+") + + @property + def reference(self): + """ Read project version from branch create Conan reference + """ + return os.getenv("CONAN_REFERENCE", "catch2/{}".format(self._version)) + + @property + def channel(self): + """ Default Conan package channel when not stable + """ + return os.getenv("CONAN_CHANNEL", "testing") + + @property + def _version(self): + """ Get version name from cmake file + """ + pattern = re.compile(r"project\(Catch2 LANGUAGES CXX VERSION (\d+\.\d+\.\d+)\)") + version = "latest" + with open("CMakeLists.txt") as file: + for line in file: + result = pattern.search(line) + if result: + version = result.group(1) + return version + + @property + def _branch(self): + """ Get branch name from CI manager + """ + printer = Printer(None) + ci_manager = CIManager(printer) + return ci_manager.get_branch() + + +if __name__ == "__main__": + settings = BuilderSettings() + builder = ConanMultiPackager( + reference=settings.reference, + channel=settings.channel, + upload=settings.upload, + upload_only_when_stable=False, + stable_branch_pattern=settings.stable_branch_pattern, + login_username=settings.login_username, + username=settings.username, + test_folder=os.path.join(".conan", "test_package")) + builder.add() + builder.run() diff --git a/.conan/test_package/CMakeLists.txt b/.conan/test_package/CMakeLists.txt new file mode 100644 index 00000000..6ee069c0 --- /dev/null +++ b/.conan/test_package/CMakeLists.txt @@ -0,0 +1,12 @@ +cmake_minimum_required(VERSION 3.2.0) +project(test_package CXX) + +include("${CMAKE_BINARY_DIR}/conanbuildinfo.cmake") +conan_basic_setup() + +find_package(Catch2 REQUIRED CONFIG) + +add_executable(${PROJECT_NAME} test_package.cpp) + +target_link_libraries(${PROJECT_NAME} Catch2::Catch2WithMain) +set_target_properties(${PROJECT_NAME} PROPERTIES CXX_STANDARD 14) diff --git a/.conan/test_package/conanfile.py b/.conan/test_package/conanfile.py new file mode 100644 index 00000000..069ace61 --- /dev/null +++ b/.conan/test_package/conanfile.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +from conans import ConanFile, CMake +import os + + +class TestPackageConan(ConanFile): + settings = "os", "compiler", "build_type", "arch" + generators = "cmake_find_package_multi", "cmake" + + def build(self): + cmake = CMake(self) + cmake.configure() + cmake.build() + + def test(self): + assert os.path.isfile(os.path.join( + self.deps_cpp_info["catch2"].rootpath, "licenses", "LICENSE.txt")) + bin_path = os.path.join("bin", "test_package") + self.run("%s -s" % bin_path, run_environment=True) diff --git a/.conan/test_package/test_package.cpp b/.conan/test_package/test_package.cpp new file mode 100644 index 00000000..3c08090b --- /dev/null +++ b/.conan/test_package/test_package.cpp @@ -0,0 +1,13 @@ +#include + +int Factorial( int number ) { + return number <= 1 ? 1 : Factorial( number - 1 ) * number; +} + +TEST_CASE( "Factorial Tests", "[single-file]" ) { + REQUIRE( Factorial(0) == 1 ); + REQUIRE( Factorial(1) == 1 ); + REQUIRE( Factorial(2) == 2 ); + REQUIRE( Factorial(3) == 6 ); + REQUIRE( Factorial(10) == 3628800 ); +} \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..23f98fff --- /dev/null +++ b/.gitattributes @@ -0,0 +1,22 @@ +# This sets the default behaviour, overriding core.autocrlf +* text=auto + +# All source files should have unix line-endings in the repository, +# but convert to native line-endings on checkout +*.cpp text +*.h text +*.hpp text + +# Windows specific files should retain windows line-endings +*.sln text eol=crlf + +# Keep executable scripts with LFs so they can be run after being +# checked out on Windows +*.py text eol=lf + + +# Keep the single include header with LFs to make sure it is uploaded, +# hashed etc with LF +single_include/**/*.hpp eol=lf +# Also keep the LICENCE file with LFs for the same reason +LICENCE.txt eol=lf diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..9122aa8a --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: "horenmar" +custom: "https://www.paypal.me/horenmar" diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..dbeff115 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create an issue that documents a bug +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Reproduction steps** +Steps to reproduce the bug. + + + +**Platform information:** + + - OS: **Windows NT** + - Compiler+version: **GCC v2.9.5** + - Catch version: **v1.2.3** + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..be9b9eea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Create an issue that requests a feature or other improvement +title: '' +labels: '' +assignees: '' + +--- + +**Description** +Describe the feature/change you request and why do you want it. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..ea2b7bb5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ + + + +## Description + + +## GitHub Issues + diff --git a/.github/workflows/linux-bazel-builds.yml b/.github/workflows/linux-bazel-builds.yml new file mode 100644 index 00000000..9006652e --- /dev/null +++ b/.github/workflows/linux-bazel-builds.yml @@ -0,0 +1,24 @@ +name: Bazel build + +on: [push, pull_request] + +jobs: + build_and_test_ubuntu: + name: Linux Ubuntu 22.04 Bazel build + runs-on: ubuntu-22.04 + strategy: + matrix: + compilation_mode: [fastbuild, dbg, opt] + + steps: + - uses: actions/checkout@v3 + + - name: Mount bazel cache + uses: actions/cache@v3 + with: + path: "/home/runner/.cache/bazel" + key: bazel-ubuntu22-gcc11 + + - name: Build Catch2 + run: | + bazelisk build --compilation_mode=${{matrix.compilation_mode}} //... diff --git a/.github/workflows/linux-meson-builds.yml b/.github/workflows/linux-meson-builds.yml new file mode 100644 index 00000000..dec701b6 --- /dev/null +++ b/.github/workflows/linux-meson-builds.yml @@ -0,0 +1,43 @@ +name: Linux builds (meson) + +on: [push, pull_request] + +jobs: + build: + name: meson ${{matrix.cxx}}, C++${{matrix.std}}, ${{matrix.build_type}} + runs-on: ubuntu-22.04 + strategy: + matrix: + cxx: + - g++-11 + - clang++-11 + build_type: [debug, release] + std: [14, 17] + include: + - cxx: clang++-11 + other_pkgs: clang-11 + + steps: + - uses: actions/checkout@v2 + + - name: Prepare environment + run: sudo apt-get install -y meson ninja-build ${{matrix.other_pkgs}} + + - name: Configure build + env: + CXX: ${{matrix.cxx}} + CXXFLAGS: -std=c++${{matrix.std}} ${{matrix.cxxflags}} + # Note: $GITHUB_WORKSPACE is distinct from ${{runner.workspace}}. + # This is important + run: | + meson -Dbuildtype=${{matrix.build_type}} ${{runner.workspace}}/meson-build + + - name: Build tests + lib + working-directory: ${{runner.workspace}}/meson-build + run: ninja + + - name: Run tests + working-directory: ${{runner.workspace}}/meson-build + # Hardcode 2 cores we know are there + run: | + meson test --verbose diff --git a/.github/workflows/linux-other-builds.yml b/.github/workflows/linux-other-builds.yml new file mode 100644 index 00000000..cf4e2c06 --- /dev/null +++ b/.github/workflows/linux-other-builds.yml @@ -0,0 +1,104 @@ +# The builds in this file are more complex (e.g. they need custom CMake +# configuration) and thus are unsuitable to the simple build matrix +# approach used in simple-builds +name: Linux builds (complex) + +on: [push, pull_request] + +jobs: + build: + name: ${{matrix.build_description}}, ${{matrix.cxx}}, C++${{matrix.std}} ${{matrix.build_type}} + runs-on: ubuntu-20.04 + strategy: + matrix: + # We add builds one by one in this case, because there are no + # dimensions that are shared across the builds + include: + + # Single surrogate header build + - cxx: clang++-10 + build_description: Surrogates build + build_type: Debug + std: 14 + other_pkgs: clang-10 + cmake_configurations: -DCATCH_BUILD_SURROGATES=ON + + # Extras and examples with gcc-7 + - cxx: g++-7 + build_description: Extras + Examples + build_type: Debug + std: 14 + other_pkgs: g++-7 + cmake_configurations: -DCATCH_BUILD_EXTRA_TESTS=ON -DCATCH_BUILD_EXAMPLES=ON + - cxx: g++-7 + build_description: Extras + Examples + build_type: Release + std: 14 + other_pkgs: g++-7 + cmake_configurations: -DCATCH_BUILD_EXTRA_TESTS=ON -DCATCH_BUILD_EXAMPLES=ON + + # Extras and examples with Clang-10 + - cxx: clang++-10 + build_description: Extras + Examples + build_type: Debug + std: 17 + other_pkgs: clang-10 + cmake_configurations: -DCATCH_BUILD_EXTRA_TESTS=ON -DCATCH_BUILD_EXAMPLES=ON + - cxx: clang++-10 + build_description: Extras + Examples + build_type: Release + std: 17 + other_pkgs: clang-10 + cmake_configurations: -DCATCH_BUILD_EXTRA_TESTS=ON -DCATCH_BUILD_EXAMPLES=ON + + # Configure tests with Clang-10 + - cxx: clang++-10 + build_description: CMake configuration tests + build_type: Debug + std: 14 + other_pkgs: clang-10 + cmake_configurations: -DCATCH_ENABLE_CONFIGURE_TESTS=ON + + # Valgrind test Clang-10 + - cxx: clang++-10 + build_description: Valgrind tests + build_type: Debug + std: 14 + other_pkgs: clang-10 valgrind + cmake_configurations: -DMEMORYCHECK_COMMAND=`which valgrind` -DMEMORYCHECK_COMMAND_OPTIONS="-q --track-origins=yes --leak-check=full --num-callers=50 --show-leak-kinds=definite --error-exitcode=1" + other_ctest_args: -T memcheck -LE uses-python + + + steps: + - uses: actions/checkout@v2 + + - name: Prepare environment + run: sudo apt-get install -y ninja-build ${{matrix.other_pkgs}} + + - name: Configure build + working-directory: ${{runner.workspace}} + env: + CXX: ${{matrix.cxx}} + CXXFLAGS: ${{matrix.cxxflags}} + # Note: $GITHUB_WORKSPACE is distinct from ${{runner.workspace}}. + # This is important + run: | + cmake -Bbuild -H$GITHUB_WORKSPACE \ + -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \ + -DCMAKE_CXX_STANDARD=${{matrix.std}} \ + -DCMAKE_CXX_STANDARD_REQUIRED=ON \ + -DCMAKE_CXX_EXTENSIONS=OFF \ + -DCATCH_DEVELOPMENT_BUILD=ON \ + ${{matrix.cmake_configurations}} \ + -G Ninja + + - name: Build tests + lib + working-directory: ${{runner.workspace}}/build + run: ninja + + - name: Run tests + env: + CTEST_OUTPUT_ON_FAILURE: 1 + working-directory: ${{runner.workspace}}/build + # Hardcode 2 cores we know are there + run: ctest -C ${{matrix.build_type}} -j 2 ${{matrix.other_ctest_args}} diff --git a/.github/workflows/linux-simple-builds.yml b/.github/workflows/linux-simple-builds.yml new file mode 100644 index 00000000..989c4942 --- /dev/null +++ b/.github/workflows/linux-simple-builds.yml @@ -0,0 +1,122 @@ +name: Linux builds (basic) + +on: [push, pull_request] + +jobs: + build: + name: ${{matrix.cxx}}, C++${{matrix.std}}, ${{matrix.build_type}} + runs-on: ubuntu-20.04 + strategy: + matrix: + cxx: + - g++-5 + - g++-6 + - g++-7 + - g++-8 + - g++-9 + - g++-10 + - clang++-6.0 + - clang++-7 + - clang++-8 + - clang++-9 + - clang++-10 + build_type: [Debug, Release] + std: [14] + include: + - cxx: g++-5 + other_pkgs: g++-5 + - cxx: g++-6 + other_pkgs: g++-6 + - cxx: g++-7 + other_pkgs: g++-7 + - cxx: g++-8 + other_pkgs: g++-8 + - cxx: g++-9 + other_pkgs: g++-9 + - cxx: g++-10 + other_pkgs: g++-10 + - cxx: clang++-6.0 + other_pkgs: clang-6.0 + - cxx: clang++-7 + other_pkgs: clang-7 + - cxx: clang++-8 + other_pkgs: clang-8 + - cxx: clang++-9 + other_pkgs: clang-9 + - cxx: clang++-10 + other_pkgs: clang-10 + # Clang 6 + C++17 + # does not work with the default libstdc++ version thanks + # to a disagreement on variant implementation. + # - cxx: clang++-6.0 + # build_type: Debug + # std: 17 + # other_pkgs: clang-6.0 + # - cxx: clang++-6.0 + # build_type: Release + # std: 17 + # other_pkgs: clang-6.0 + # Clang 10 + C++17 + - cxx: clang++-10 + build_type: Debug + std: 17 + other_pkgs: clang-10 + - cxx: clang++-10 + build_type: Release + std: 17 + other_pkgs: clang-10 + - cxx: clang++-10 + build_type: Debug + std: 20 + other_pkgs: clang-10 + - cxx: clang++-10 + build_type: Release + std: 20 + other_pkgs: clang-10 + - cxx: g++-10 + build_type: Debug + std: 20 + other_pkgs: g++-10 + - cxx: g++-10 + build_type: Release + std: 20 + other_pkgs: g++-10 + + steps: + - uses: actions/checkout@v2 + + - name: Add repositories for older GCC + run: | + sudo apt-add-repository 'deb http://azure.archive.ubuntu.com/ubuntu/ bionic main' + sudo apt-add-repository 'deb http://azure.archive.ubuntu.com/ubuntu/ bionic universe' + if: ${{ matrix.cxx == 'g++-5' || matrix.cxx == 'g++-6' }} + + - name: Prepare environment + run: sudo apt-get install -y ninja-build ${{matrix.other_pkgs}} + + - name: Configure build + working-directory: ${{runner.workspace}} + env: + CXX: ${{matrix.cxx}} + CXXFLAGS: ${{matrix.cxxflags}} + # Note: $GITHUB_WORKSPACE is distinct from ${{runner.workspace}}. + # This is important + run: | + cmake -Bbuild -H$GITHUB_WORKSPACE \ + -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \ + -DCMAKE_CXX_STANDARD=${{matrix.std}} \ + -DCMAKE_CXX_STANDARD_REQUIRED=ON \ + -DCMAKE_CXX_EXTENSIONS=OFF \ + -DCATCH_DEVELOPMENT_BUILD=ON \ + -G Ninja + + - name: Build tests + lib + working-directory: ${{runner.workspace}}/build + run: ninja + + - name: Run tests + env: + CTEST_OUTPUT_ON_FAILURE: 1 + working-directory: ${{runner.workspace}}/build + # Hardcode 2 cores we know are there + run: ctest -C ${{matrix.build_type}} -j 2 diff --git a/.github/workflows/mac-builds.yml b/.github/workflows/mac-builds.yml new file mode 100644 index 00000000..955b81fc --- /dev/null +++ b/.github/workflows/mac-builds.yml @@ -0,0 +1,52 @@ +name: Mac builds + +on: [push, pull_request] + +jobs: + build: + # macos-12 updated to a toolchain that crashes when linking the + # test binary. This seems to be a known bug in that version, + # and will eventually get fixed in an update. After that, we can go + # back to newer macos images. + runs-on: macos-11 + strategy: + matrix: + cxx: + - g++-11 + - clang++ + build_type: [Debug, Release] + std: [14, 17] + include: + - build_type: Debug + examples: ON + extra_tests: ON + + steps: + - uses: actions/checkout@v2 + + - name: Configure build + working-directory: ${{runner.workspace}} + env: + CXX: ${{matrix.cxx}} + CXXFLAGS: ${{matrix.cxxflags}} + # Note: $GITHUB_WORKSPACE is distinct from ${{runner.workspace}}. + # This is important + run: | + cmake -Bbuild -H$GITHUB_WORKSPACE \ + -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \ + -DCMAKE_CXX_STANDARD=${{matrix.std}} \ + -DCMAKE_CXX_STANDARD_REQUIRED=ON \ + -DCATCH_DEVELOPMENT_BUILD=ON \ + -DCATCH_BUILD_EXAMPLES=${{matrix.examples}} \ + -DCATCH_BUILD_EXTRA_TESTS=${{matrix.examples}} + + - name: Build tests + lib + working-directory: ${{runner.workspace}}/build + run: make -j 2 + + - name: Run tests + env: + CTEST_OUTPUT_ON_FAILURE: 1 + working-directory: ${{runner.workspace}}/build + # Hardcode 2 cores we know are there + run: ctest -C ${{matrix.build_type}} -j 2 diff --git a/.github/workflows/validate-header-guards.yml b/.github/workflows/validate-header-guards.yml new file mode 100644 index 00000000..c02b5d49 --- /dev/null +++ b/.github/workflows/validate-header-guards.yml @@ -0,0 +1,36 @@ +name: Check header guards + +on: [push, pull_request] + +jobs: + build: + # Set the type of machine to run on + runs-on: ubuntu-20.04 + steps: + + - name: Checkout source code + uses: actions/checkout@v2 + + - name: Setup Dependencies + uses: actions/setup-python@v2 + with: + python-version: '3.7' + - name: Install checkguard + run: pip install guardonce + + - name: Check that include guards are properly named + run: | + wrong_files=$(checkguard -r src/catch2/ -p "name | append _INCLUDED | upper") + if [[ $wrong_files ]]; then + echo "Files with wrong header guard:" + echo $wrong_files + exit 1 + fi + + - name: Check that there are no duplicated filenames + run: | + ./tools/scripts/checkDuplicateFilenames.py + + - name: Check that all source files have the correct license header + run: | + ./tools/scripts/checkLicense.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..27f6bc0b --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +*.build +!meson.build +*.pbxuser +*.mode1v3 +*.ncb +*.suo +Debug +Release +*.user +*.xcuserstate +.DS_Store +xcuserdata +CatchSelfTest.xcscheme +Breakpoints.xcbkptlist +UpgradeLog.XML +Resources/DWARF +projects/Generated +*.pyc +DerivedData +*.xccheckout +Build +.idea +.vs +.vscode +cmake-build-* +benchmark-dir +.conan/test_package/build +bazel-* +build-fuzzers +debug-build +.vscode +msvc-sln* +# Currently we use Doxygen for dep graphs and the full docs are only slowly +# being filled in, so we definitely do not want git to deal with the docs. +docs/doxygen +*.cache +compile_commands.json diff --git a/BUILD.bazel b/BUILD.bazel new file mode 100644 index 00000000..3125e7c5 --- /dev/null +++ b/BUILD.bazel @@ -0,0 +1,92 @@ +load("@bazel_skylib//rules:expand_template.bzl", "expand_template") + +expand_template( + name = "catch_user_config", + out = "catch2/catch_user_config.hpp", + substitutions = { + "@CATCH_CONFIG_CONSOLE_WIDTH@": "80", + "@CATCH_CONFIG_DEFAULT_REPORTER@": "console", + "#cmakedefine CATCH_CONFIG_ANDROID_LOGWRITE": "", + "#cmakedefine CATCH_CONFIG_BAZEL_SUPPORT": "#define CATCH_CONFIG_BAZEL_SUPPORT", + "#cmakedefine CATCH_CONFIG_COLOUR_WIN32": "", + "#cmakedefine CATCH_CONFIG_COUNTER": "", + "#cmakedefine CATCH_CONFIG_CPP11_TO_STRING": "", + "#cmakedefine CATCH_CONFIG_CPP17_BYTE": "", + "#cmakedefine CATCH_CONFIG_CPP17_OPTIONAL": "", + "#cmakedefine CATCH_CONFIG_CPP17_STRING_VIEW": "", + "#cmakedefine CATCH_CONFIG_CPP17_UNCAUGHT_EXCEPTIONS": "", + "#cmakedefine CATCH_CONFIG_CPP17_VARIANT": "", + "#cmakedefine CATCH_CONFIG_DISABLE_EXCEPTIONS_CUSTOM_HANDLER": "", + "#cmakedefine CATCH_CONFIG_DISABLE_EXCEPTIONS": "", + "#cmakedefine CATCH_CONFIG_DISABLE_STRINGIFICATION": "", + "#cmakedefine CATCH_CONFIG_DISABLE": "", + "#cmakedefine CATCH_CONFIG_ENABLE_ALL_STRINGMAKERS": "", + "#cmakedefine CATCH_CONFIG_ENABLE_OPTIONAL_STRINGMAKER": "", + "#cmakedefine CATCH_CONFIG_ENABLE_PAIR_STRINGMAKER": "", + "#cmakedefine CATCH_CONFIG_ENABLE_TUPLE_STRINGMAKER": "", + "#cmakedefine CATCH_CONFIG_ENABLE_VARIANT_STRINGMAKER": "", + "#cmakedefine CATCH_CONFIG_EXPERIMENTAL_REDIRECT": "", + "#cmakedefine CATCH_CONFIG_FALLBACK_STRINGIFIER @CATCH_CONFIG_FALLBACK_STRINGIFIER@": "", + "#cmakedefine CATCH_CONFIG_FAST_COMPILE": "", + "#cmakedefine CATCH_CONFIG_GETENV": "", + "#cmakedefine CATCH_CONFIG_GLOBAL_NEXTAFTER": "", + "#cmakedefine CATCH_CONFIG_NO_ANDROID_LOGWRITE": "", + "#cmakedefine CATCH_CONFIG_NO_COLOUR_WIN32": "", + "#cmakedefine CATCH_CONFIG_NO_COUNTER": "", + "#cmakedefine CATCH_CONFIG_NO_CPP11_TO_STRING": "", + "#cmakedefine CATCH_CONFIG_NO_CPP17_BYTE": "", + "#cmakedefine CATCH_CONFIG_NO_CPP17_OPTIONAL": "", + "#cmakedefine CATCH_CONFIG_NO_CPP17_STRING_VIEW": "", + "#cmakedefine CATCH_CONFIG_NO_CPP17_UNCAUGHT_EXCEPTIONS": "", + "#cmakedefine CATCH_CONFIG_NO_CPP17_VARIANT": "", + "#cmakedefine CATCH_CONFIG_NO_GETENV": "", + "#cmakedefine CATCH_CONFIG_NO_GLOBAL_NEXTAFTER": "", + "#cmakedefine CATCH_CONFIG_NO_POSIX_SIGNALS": "", + "#cmakedefine CATCH_CONFIG_NO_USE_ASYNC": "", + "#cmakedefine CATCH_CONFIG_NO_WCHAR": "", + "#cmakedefine CATCH_CONFIG_NO_WINDOWS_SEH": "", + "#cmakedefine CATCH_CONFIG_NOSTDOUT": "", + "#cmakedefine CATCH_CONFIG_POSIX_SIGNALS": "", + "#cmakedefine CATCH_CONFIG_PREFIX_ALL": "", + "#cmakedefine CATCH_CONFIG_SHARED_LIBRARY": "", + "#cmakedefine CATCH_CONFIG_USE_ASYNC": "", + "#cmakedefine CATCH_CONFIG_WCHAR": "", + "#cmakedefine CATCH_CONFIG_WINDOWS_CRTDBG": "", + "#cmakedefine CATCH_CONFIG_WINDOWS_SEH": "", + }, + template = "src/catch2/catch_user_config.hpp.in", +) + +# Generated header library, modifies the include prefix to account for +# generation path so that we can include +# correctly. +cc_library( + name = "catch2_generated", + hdrs = ["catch2/catch_user_config.hpp"], + include_prefix = ".", # to manipulate -I of dependenices + visibility = ["//visibility:public"], +) + +# Static library, without main. +cc_library( + name = "catch2", + srcs = glob( + ["src/catch2/**/*.cpp"], + exclude = ["src/catch2/internal/catch_main.cpp"], + ), + hdrs = glob(["src/catch2/**/*.hpp"]), + includes = ["src/"], + linkstatic = True, + visibility = ["//visibility:public"], + deps = [":catch2_generated"], +) + +# Static library, with main. +cc_library( + name = "catch2_main", + srcs = ["src/catch2/internal/catch_main.cpp"], + includes = ["src/"], + linkstatic = True, + visibility = ["//visibility:public"], + deps = [":catch2"], +) diff --git a/CMake/Catch2Config.cmake.in b/CMake/Catch2Config.cmake.in new file mode 100644 index 00000000..c485219c --- /dev/null +++ b/CMake/Catch2Config.cmake.in @@ -0,0 +1,10 @@ +@PACKAGE_INIT@ + + +# Avoid repeatedly including the targets +if(NOT TARGET Catch2::Catch2) + # Provide path for scripts + list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}") + + include(${CMAKE_CURRENT_LIST_DIR}/Catch2Targets.cmake) +endif() diff --git a/CMake/CatchConfigOptions.cmake b/CMake/CatchConfigOptions.cmake new file mode 100644 index 00000000..733ec65e --- /dev/null +++ b/CMake/CatchConfigOptions.cmake @@ -0,0 +1,79 @@ + +# Copyright Catch2 Authors +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE.txt or copy at +# https://www.boost.org/LICENSE_1_0.txt) + +# SPDX-License-Identifier: BSL-1.0 + +## +# This file contains options that are materialized into the Catch2 +# compiled library. All of them default to OFF, as even the positive +# forms correspond to the user _forcing_ them to ON, while being OFF +# means that Catch2 can use its own autodetection. +# +# For detailed docs look into docs/configuration.md + + +macro(AddOverridableConfigOption OptionBaseName) + option(CATCH_CONFIG_${OptionBaseName} "Read docs/configuration.md for details" OFF) + option(CATCH_CONFIG_NO_${OptionBaseName} "Read docs/configuration.md for details" OFF) +endmacro() + +macro(AddConfigOption OptionBaseName) + option(CATCH_CONFIG_${OptionBaseName} "Read docs/configuration.md for details" OFF) +endmacro() + +set(_OverridableOptions + "ANDROID_LOGWRITE" + "BAZEL_SUPPORT" + "COLOUR_WIN32" + "COUNTER" + "CPP11_TO_STRING" + "CPP17_BYTE" + "CPP17_OPTIONAL" + "CPP17_STRING_VIEW" + "CPP17_UNCAUGHT_EXCEPTIONS" + "CPP17_VARIANT" + "GLOBAL_NEXTAFTER" + "POSIX_SIGNALS" + "USE_ASYNC" + "WCHAR" + "WINDOWS_SEH" + "GETENV" +) + +foreach(OptionName ${_OverridableOptions}) + AddOverridableConfigOption(${OptionName}) +endforeach() + +set(_OtherConfigOptions + "DISABLE_EXCEPTIONS" + "DISABLE_EXCEPTIONS_CUSTOM_HANDLER" + "DISABLE" + "DISABLE_STRINGIFICATION" + "ENABLE_ALL_STRINGMAKERS" + "ENABLE_OPTIONAL_STRINGMAKER" + "ENABLE_PAIR_STRINGMAKER" + "ENABLE_TUPLE_STRINGMAKER" + "ENABLE_VARIANT_STRINGMAKER" + "EXPERIMENTAL_REDIRECT" + "FAST_COMPILE" + "NOSTDOUT" + "PREFIX_ALL" + "WINDOWS_CRTDBG" +) + + +foreach(OptionName ${_OtherConfigOptions}) + AddConfigOption(${OptionName}) +endforeach() +set(CATCH_CONFIG_SHARED_LIBRARY ${BUILD_SHARED_LIBS}) + +set(CATCH_CONFIG_DEFAULT_REPORTER "console" CACHE STRING "Read docs/configuration.md for details. The name of the reporter should be without quotes.") +set(CATCH_CONFIG_CONSOLE_WIDTH "80" CACHE STRING "Read docs/configuration.md for details. Must form a valid integer literal.") + +# There is no good way to both turn this into a CMake cache variable, +# and keep reasonable default semantics inside the project. Thus we do +# not define it and users have to provide it as an outside variable. +#set(CATCH_CONFIG_FALLBACK_STRINGIFIER "" CACHE STRING "Read docs/configuration.md for details.") diff --git a/CMake/CatchMiscFunctions.cmake b/CMake/CatchMiscFunctions.cmake new file mode 100644 index 00000000..3758d956 --- /dev/null +++ b/CMake/CatchMiscFunctions.cmake @@ -0,0 +1,120 @@ + +# Copyright Catch2 Authors +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE.txt or copy at +# https://www.boost.org/LICENSE_1_0.txt) + +# SPDX-License-Identifier: BSL-1.0 + +include(CheckCXXCompilerFlag) +function(add_cxx_flag_if_supported_to_targets flagname targets) + string(MAKE_C_IDENTIFIER ${flagname} flag_identifier ) + check_cxx_compiler_flag("${flagname}" HAVE_FLAG_${flag_identifier}) + + if (HAVE_FLAG_${flag_identifier}) + foreach(target ${targets}) + target_compile_options(${target} PRIVATE ${flagname}) + endforeach() + endif() +endfunction() + +# Assumes that it is only called for development builds, where warnings +# and Werror is desired, so it also enables Werror. +function(add_warnings_to_targets targets) + LIST(LENGTH targets TARGETS_LEN) + # For now we just assume 2 possibilities: msvc and msvc-like compilers, + # and other. + if (MSVC) + foreach(target ${targets}) + # Force MSVC to consider everything as encoded in utf-8 + target_compile_options( ${target} PRIVATE /utf-8 ) + # Enable Werror equivalent + if (CATCH_ENABLE_WERROR) + target_compile_options( ${target} PRIVATE /WX ) + endif() + + # MSVC is currently handled specially + if ( CMAKE_CXX_COMPILER_ID MATCHES "MSVC" ) + STRING(REGEX REPLACE "/W[0-9]" "/W4" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS}) # override default warning level + target_compile_options( ${target} PRIVATE /w44265 /w44061 /w44062 /w45038 ) + endif() + endforeach() + + endif() + + if (NOT MSVC) + set(CHECKED_WARNING_FLAGS + "-Wabsolute-value" + "-Wall" + "-Wc++20-compat" + "-Wcall-to-pure-virtual-from-ctor-dtor" + "-Wcast-align" + "-Wcatch-value" + "-Wdangling" + "-Wdeprecated" + "-Wdeprecated-register" + "-Wexceptions" + "-Wexit-time-destructors" + "-Wextra" + "-Wextra-semi" + "-Wfloat-equal" + "-Wglobal-constructors" + "-Winit-self" + "-Wmisleading-indentation" + "-Wmismatched-new-delete" + "-Wmismatched-return-types" + "-Wmismatched-tags" + "-Wmissing-braces" + "-Wmissing-declarations" + "-Wmissing-noreturn" + "-Wmissing-prototypes" + "-Wmissing-variable-declarations" + "-Wnull-dereference" + "-Wold-style-cast" + "-Woverloaded-virtual" + "-Wparentheses" + "-Wpedantic" + "-Wreorder" + "-Wreturn-std-move" + "-Wshadow" + "-Wstrict-aliasing" + "-Wsuggest-destructor-override" + "-Wsuggest-override" + "-Wundef" + "-Wuninitialized" + "-Wunneeded-internal-declaration" + "-Wunreachable-code" + "-Wunused" + "-Wunused-function" + "-Wunused-parameter" + "-Wvla" + "-Wweak-vtables" + + # This is a useful warning, but our tests sometimes rely on + # functions being present, but not picked (e.g. various checks + # for stringification implementation ordering). + # Ergo, we should use it every now and then, but we cannot + # enable it by default. + # "-Wunused-member-function" + ) + foreach(warning ${CHECKED_WARNING_FLAGS}) + add_cxx_flag_if_supported_to_targets(${warning} "${targets}") + endforeach() + + if (CATCH_ENABLE_WERROR) + foreach(target ${targets}) + # Enable Werror equivalent + target_compile_options( ${target} PRIVATE -Werror ) + endforeach() + endif() + endif() +endfunction() + +# Adds flags required for reproducible build to the target +# Currently only supports GCC and Clang +function(add_build_reproducibility_settings target) + # Make the build reproducible on versions of g++ and clang that supports -ffile-prefix-map + if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU") OR (CMAKE_CXX_COMPILER_ID MATCHES "Clang")) + add_cxx_flag_if_supported_to_targets("-ffile-prefix-map=${CATCH_DIR}/=" "${target}") + endif() +endfunction() diff --git a/CMake/FindGcov.cmake b/CMake/FindGcov.cmake new file mode 100644 index 00000000..41417113 --- /dev/null +++ b/CMake/FindGcov.cmake @@ -0,0 +1,157 @@ +# This file is part of CMake-codecov. +# +# Copyright (c) +# 2015-2017 RWTH Aachen University, Federal Republic of Germany +# +# See the LICENSE file in the package base directory for details +# +# Written by Alexander Haase, alexander.haase@rwth-aachen.de +# + + +# include required Modules +include(FindPackageHandleStandardArgs) + + +# Search for gcov binary. +set(CMAKE_REQUIRED_QUIET_SAVE ${CMAKE_REQUIRED_QUIET}) +set(CMAKE_REQUIRED_QUIET ${codecov_FIND_QUIETLY}) + +get_property(ENABLED_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES) +foreach (LANG ${ENABLED_LANGUAGES}) + # Gcov evaluation is dependent on the used compiler. Check gcov support for + # each compiler that is used. If gcov binary was already found for this + # compiler, do not try to find it again. + if (NOT GCOV_${CMAKE_${LANG}_COMPILER_ID}_BIN) + get_filename_component(COMPILER_PATH "${CMAKE_${LANG}_COMPILER}" PATH) + + if ("${CMAKE_${LANG}_COMPILER_ID}" STREQUAL "GNU") + # Some distributions like OSX (homebrew) ship gcov with the compiler + # version appended as gcov-x. To find this binary we'll build the + # suggested binary name with the compiler version. + string(REGEX MATCH "^[0-9]+" GCC_VERSION + "${CMAKE_${LANG}_COMPILER_VERSION}") + + find_program(GCOV_BIN NAMES gcov-${GCC_VERSION} gcov + HINTS ${COMPILER_PATH}) + + elseif ("${CMAKE_${LANG}_COMPILER_ID}" STREQUAL "Clang") + # Some distributions like Debian ship llvm-cov with the compiler + # version appended as llvm-cov-x.y. To find this binary we'll build + # the suggested binary name with the compiler version. + string(REGEX MATCH "^[0-9]+.[0-9]+" LLVM_VERSION + "${CMAKE_${LANG}_COMPILER_VERSION}") + + # llvm-cov prior version 3.5 seems to be not working with coverage + # evaluation tools, but these versions are compatible with the gcc + # gcov tool. + if(LLVM_VERSION VERSION_GREATER 3.4) + find_program(LLVM_COV_BIN NAMES "llvm-cov-${LLVM_VERSION}" + "llvm-cov" HINTS ${COMPILER_PATH}) + mark_as_advanced(LLVM_COV_BIN) + + if (LLVM_COV_BIN) + find_program(LLVM_COV_WRAPPER "llvm-cov-wrapper" PATHS + ${CMAKE_MODULE_PATH}) + if (LLVM_COV_WRAPPER) + set(GCOV_BIN "${LLVM_COV_WRAPPER}" CACHE FILEPATH "") + + # set additional parameters + set(GCOV_${CMAKE_${LANG}_COMPILER_ID}_ENV + "LLVM_COV_BIN=${LLVM_COV_BIN}" CACHE STRING + "Environment variables for llvm-cov-wrapper.") + mark_as_advanced(GCOV_${CMAKE_${LANG}_COMPILER_ID}_ENV) + endif () + endif () + endif () + + if (NOT GCOV_BIN) + # Fall back to gcov binary if llvm-cov was not found or is + # incompatible. This is the default on OSX, but may crash on + # recent Linux versions. + find_program(GCOV_BIN gcov HINTS ${COMPILER_PATH}) + endif () + endif () + + + if (GCOV_BIN) + set(GCOV_${CMAKE_${LANG}_COMPILER_ID}_BIN "${GCOV_BIN}" CACHE STRING + "${LANG} gcov binary.") + + if (NOT CMAKE_REQUIRED_QUIET) + message("-- Found gcov evaluation for " + "${CMAKE_${LANG}_COMPILER_ID}: ${GCOV_BIN}") + endif() + + unset(GCOV_BIN CACHE) + endif () + endif () +endforeach () + + + + +# Add a new global target for all gcov targets. This target could be used to +# generate the gcov files for the whole project instead of calling -gcov +# for each target. +if (NOT TARGET gcov) + add_custom_target(gcov) +endif (NOT TARGET gcov) + + + +# This function will add gcov evaluation for target . Only sources of +# this target will be evaluated and no dependencies will be added. It will call +# Gcov on any source file of once and store the gcov file in the same +# directory. +function (add_gcov_target TNAME) + set(TDIR ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TNAME}.dir) + + # We don't have to check, if the target has support for coverage, thus this + # will be checked by add_coverage_target in Findcoverage.cmake. Instead we + # have to determine which gcov binary to use. + get_target_property(TSOURCES ${TNAME} SOURCES) + set(SOURCES "") + set(TCOMPILER "") + foreach (FILE ${TSOURCES}) + codecov_path_of_source(${FILE} FILE) + if (NOT "${FILE}" STREQUAL "") + codecov_lang_of_source(${FILE} LANG) + if (NOT "${LANG}" STREQUAL "") + list(APPEND SOURCES "${FILE}") + set(TCOMPILER ${CMAKE_${LANG}_COMPILER_ID}) + endif () + endif () + endforeach () + + # If no gcov binary was found, coverage data can't be evaluated. + if (NOT GCOV_${TCOMPILER}_BIN) + message(WARNING "No coverage evaluation binary found for ${TCOMPILER}.") + return() + endif () + + set(GCOV_BIN "${GCOV_${TCOMPILER}_BIN}") + set(GCOV_ENV "${GCOV_${TCOMPILER}_ENV}") + + + set(BUFFER "") + foreach(FILE ${SOURCES}) + get_filename_component(FILE_PATH "${TDIR}/${FILE}" PATH) + + # call gcov + add_custom_command(OUTPUT ${TDIR}/${FILE}.gcov + COMMAND ${GCOV_ENV} ${GCOV_BIN} ${TDIR}/${FILE}.gcno > /dev/null + DEPENDS ${TNAME} ${TDIR}/${FILE}.gcno + WORKING_DIRECTORY ${FILE_PATH} + ) + + list(APPEND BUFFER ${TDIR}/${FILE}.gcov) + endforeach() + + + # add target for gcov evaluation of + add_custom_target(${TNAME}-gcov DEPENDS ${BUFFER}) + + # add evaluation target to the global gcov target. + add_dependencies(gcov ${TNAME}-gcov) +endfunction (add_gcov_target) diff --git a/CMake/FindLcov.cmake b/CMake/FindLcov.cmake new file mode 100644 index 00000000..beb925ae --- /dev/null +++ b/CMake/FindLcov.cmake @@ -0,0 +1,354 @@ +# This file is part of CMake-codecov. +# +# Copyright (c) +# 2015-2017 RWTH Aachen University, Federal Republic of Germany +# +# See the LICENSE file in the package base directory for details +# +# Written by Alexander Haase, alexander.haase@rwth-aachen.de +# + + +# configuration +set(LCOV_DATA_PATH "${CMAKE_BINARY_DIR}/lcov/data") +set(LCOV_DATA_PATH_INIT "${LCOV_DATA_PATH}/init") +set(LCOV_DATA_PATH_CAPTURE "${LCOV_DATA_PATH}/capture") +set(LCOV_HTML_PATH "${CMAKE_BINARY_DIR}/lcov/html") + + + + +# Search for Gcov which is used by Lcov. +find_package(Gcov) + + + + +# This function will add lcov evaluation for target . Only sources of +# this target will be evaluated and no dependencies will be added. It will call +# geninfo on any source file of once and store the info file in the same +# directory. +# +# Note: This function is only a wrapper to define this function always, even if +# coverage is not supported by the compiler or disabled. This function must +# be defined here, because the module will be exited, if there is no coverage +# support by the compiler or it is disabled by the user. +function (add_lcov_target TNAME) + if (LCOV_FOUND) + # capture initial coverage data + lcov_capture_initial_tgt(${TNAME}) + + # capture coverage data after execution + lcov_capture_tgt(${TNAME}) + endif () +endfunction (add_lcov_target) + + + + +# include required Modules +include(FindPackageHandleStandardArgs) + +# Search for required lcov binaries. +find_program(LCOV_BIN lcov) +find_program(GENINFO_BIN geninfo) +find_program(GENHTML_BIN genhtml) +find_package_handle_standard_args(lcov + REQUIRED_VARS LCOV_BIN GENINFO_BIN GENHTML_BIN +) + +# enable genhtml C++ demangeling, if c++filt is found. +set(GENHTML_CPPFILT_FLAG "") +find_program(CPPFILT_BIN c++filt) +if (NOT CPPFILT_BIN STREQUAL "") + set(GENHTML_CPPFILT_FLAG "--demangle-cpp") +endif (NOT CPPFILT_BIN STREQUAL "") + +# enable no-external flag for lcov, if available. +if (GENINFO_BIN AND NOT DEFINED GENINFO_EXTERN_FLAG) + set(FLAG "") + execute_process(COMMAND ${GENINFO_BIN} --help OUTPUT_VARIABLE GENINFO_HELP) + string(REGEX MATCH "external" GENINFO_RES "${GENINFO_HELP}") + if (GENINFO_RES) + set(FLAG "--no-external") + endif () + + set(GENINFO_EXTERN_FLAG "${FLAG}" + CACHE STRING "Geninfo flag to exclude system sources.") +endif () + +# If Lcov was not found, exit module now. +if (NOT LCOV_FOUND) + return() +endif (NOT LCOV_FOUND) + + + + +# Create directories to be used. +file(MAKE_DIRECTORY ${LCOV_DATA_PATH_INIT}) +file(MAKE_DIRECTORY ${LCOV_DATA_PATH_CAPTURE}) + +set(LCOV_REMOVE_PATTERNS "") + +# This function will merge lcov files to a single target file. Additional lcov +# flags may be set with setting LCOV_EXTRA_FLAGS before calling this function. +function (lcov_merge_files OUTFILE ...) + # Remove ${OUTFILE} from ${ARGV} and generate lcov parameters with files. + list(REMOVE_AT ARGV 0) + + # Generate merged file. + string(REPLACE "${CMAKE_BINARY_DIR}/" "" FILE_REL "${OUTFILE}") + add_custom_command(OUTPUT "${OUTFILE}.raw" + COMMAND cat ${ARGV} > ${OUTFILE}.raw + DEPENDS ${ARGV} + COMMENT "Generating ${FILE_REL}" + ) + + add_custom_command(OUTPUT "${OUTFILE}" + COMMAND ${LCOV_BIN} --quiet -a ${OUTFILE}.raw --output-file ${OUTFILE} + --base-directory ${PROJECT_SOURCE_DIR} ${LCOV_EXTRA_FLAGS} + COMMAND ${LCOV_BIN} --quiet -r ${OUTFILE} ${LCOV_REMOVE_PATTERNS} + --output-file ${OUTFILE} ${LCOV_EXTRA_FLAGS} + DEPENDS ${OUTFILE}.raw + COMMENT "Post-processing ${FILE_REL}" + ) +endfunction () + + + + +# Add a new global target to generate initial coverage reports for all targets. +# This target will be used to generate the global initial info file, which is +# used to gather even empty report data. +if (NOT TARGET lcov-capture-init) + add_custom_target(lcov-capture-init) + set(LCOV_CAPTURE_INIT_FILES "" CACHE INTERNAL "") +endif (NOT TARGET lcov-capture-init) + + +# This function will add initial capture of coverage data for target , +# which is needed to get also data for objects, which were not loaded at +# execution time. It will call geninfo for every source file of once and +# store the info file in the same directory. +function (lcov_capture_initial_tgt TNAME) + # We don't have to check, if the target has support for coverage, thus this + # will be checked by add_coverage_target in Findcoverage.cmake. Instead we + # have to determine which gcov binary to use. + get_target_property(TSOURCES ${TNAME} SOURCES) + set(SOURCES "") + set(TCOMPILER "") + foreach (FILE ${TSOURCES}) + codecov_path_of_source(${FILE} FILE) + if (NOT "${FILE}" STREQUAL "") + codecov_lang_of_source(${FILE} LANG) + if (NOT "${LANG}" STREQUAL "") + list(APPEND SOURCES "${FILE}") + set(TCOMPILER ${CMAKE_${LANG}_COMPILER_ID}) + endif () + endif () + endforeach () + + # If no gcov binary was found, coverage data can't be evaluated. + if (NOT GCOV_${TCOMPILER}_BIN) + message(WARNING "No coverage evaluation binary found for ${TCOMPILER}.") + return() + endif () + + set(GCOV_BIN "${GCOV_${TCOMPILER}_BIN}") + set(GCOV_ENV "${GCOV_${TCOMPILER}_ENV}") + + + set(TDIR ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TNAME}.dir) + set(GENINFO_FILES "") + foreach(FILE ${SOURCES}) + # generate empty coverage files + set(OUTFILE "${TDIR}/${FILE}.info.init") + list(APPEND GENINFO_FILES ${OUTFILE}) + + add_custom_command(OUTPUT ${OUTFILE} COMMAND ${GCOV_ENV} ${GENINFO_BIN} + --quiet --base-directory ${PROJECT_SOURCE_DIR} --initial + --gcov-tool ${GCOV_BIN} --output-filename ${OUTFILE} + ${GENINFO_EXTERN_FLAG} ${TDIR}/${FILE}.gcno + DEPENDS ${TNAME} + COMMENT "Capturing initial coverage data for ${FILE}" + ) + endforeach() + + # Concatenate all files generated by geninfo to a single file per target. + set(OUTFILE "${LCOV_DATA_PATH_INIT}/${TNAME}.info") + set(LCOV_EXTRA_FLAGS "--initial") + lcov_merge_files("${OUTFILE}" ${GENINFO_FILES}) + add_custom_target(${TNAME}-capture-init ALL DEPENDS ${OUTFILE}) + + # add geninfo file generation to global lcov-geninfo target + add_dependencies(lcov-capture-init ${TNAME}-capture-init) + set(LCOV_CAPTURE_INIT_FILES "${LCOV_CAPTURE_INIT_FILES}" + "${OUTFILE}" CACHE INTERNAL "" + ) +endfunction (lcov_capture_initial_tgt) + + +# This function will generate the global info file for all targets. It has to be +# called after all other CMake functions in the root CMakeLists.txt file, to get +# a full list of all targets that generate coverage data. +function (lcov_capture_initial) + # Skip this function (and do not create the following targets), if there are + # no input files. + if ("${LCOV_CAPTURE_INIT_FILES}" STREQUAL "") + return() + endif () + + # Add a new target to merge the files of all targets. + set(OUTFILE "${LCOV_DATA_PATH_INIT}/all_targets.info") + lcov_merge_files("${OUTFILE}" ${LCOV_CAPTURE_INIT_FILES}) + add_custom_target(lcov-geninfo-init ALL DEPENDS ${OUTFILE} + lcov-capture-init + ) +endfunction (lcov_capture_initial) + + + + +# Add a new global target to generate coverage reports for all targets. This +# target will be used to generate the global info file. +if (NOT TARGET lcov-capture) + add_custom_target(lcov-capture) + set(LCOV_CAPTURE_FILES "" CACHE INTERNAL "") +endif (NOT TARGET lcov-capture) + + +# This function will add capture of coverage data for target , which is +# needed to get also data for objects, which were not loaded at execution time. +# It will call geninfo for every source file of once and store the info +# file in the same directory. +function (lcov_capture_tgt TNAME) + # We don't have to check, if the target has support for coverage, thus this + # will be checked by add_coverage_target in Findcoverage.cmake. Instead we + # have to determine which gcov binary to use. + get_target_property(TSOURCES ${TNAME} SOURCES) + set(SOURCES "") + set(TCOMPILER "") + foreach (FILE ${TSOURCES}) + codecov_path_of_source(${FILE} FILE) + if (NOT "${FILE}" STREQUAL "") + codecov_lang_of_source(${FILE} LANG) + if (NOT "${LANG}" STREQUAL "") + list(APPEND SOURCES "${FILE}") + set(TCOMPILER ${CMAKE_${LANG}_COMPILER_ID}) + endif () + endif () + endforeach () + + # If no gcov binary was found, coverage data can't be evaluated. + if (NOT GCOV_${TCOMPILER}_BIN) + message(WARNING "No coverage evaluation binary found for ${TCOMPILER}.") + return() + endif () + + set(GCOV_BIN "${GCOV_${TCOMPILER}_BIN}") + set(GCOV_ENV "${GCOV_${TCOMPILER}_ENV}") + + + set(TDIR ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TNAME}.dir) + set(GENINFO_FILES "") + foreach(FILE ${SOURCES}) + # Generate coverage files. If no .gcda file was generated during + # execution, the empty coverage file will be used instead. + set(OUTFILE "${TDIR}/${FILE}.info") + list(APPEND GENINFO_FILES ${OUTFILE}) + + add_custom_command(OUTPUT ${OUTFILE} + COMMAND test -f "${TDIR}/${FILE}.gcda" + && ${GCOV_ENV} ${GENINFO_BIN} --quiet --base-directory + ${PROJECT_SOURCE_DIR} --gcov-tool ${GCOV_BIN} + --output-filename ${OUTFILE} ${GENINFO_EXTERN_FLAG} + ${TDIR}/${FILE}.gcda + || cp ${OUTFILE}.init ${OUTFILE} + DEPENDS ${TNAME} ${TNAME}-capture-init + COMMENT "Capturing coverage data for ${FILE}" + ) + endforeach() + + # Concatenate all files generated by geninfo to a single file per target. + set(OUTFILE "${LCOV_DATA_PATH_CAPTURE}/${TNAME}.info") + lcov_merge_files("${OUTFILE}" ${GENINFO_FILES}) + add_custom_target(${TNAME}-geninfo DEPENDS ${OUTFILE}) + + # add geninfo file generation to global lcov-capture target + add_dependencies(lcov-capture ${TNAME}-geninfo) + set(LCOV_CAPTURE_FILES "${LCOV_CAPTURE_FILES}" "${OUTFILE}" CACHE INTERNAL + "" + ) + + # Add target for generating html output for this target only. + file(MAKE_DIRECTORY ${LCOV_HTML_PATH}/${TNAME}) + add_custom_target(${TNAME}-genhtml + COMMAND ${GENHTML_BIN} --quiet --sort --prefix ${PROJECT_SOURCE_DIR} + --baseline-file ${LCOV_DATA_PATH_INIT}/${TNAME}.info + --output-directory ${LCOV_HTML_PATH}/${TNAME} + --title "${CMAKE_PROJECT_NAME} - target ${TNAME}" + ${GENHTML_CPPFILT_FLAG} ${OUTFILE} + DEPENDS ${TNAME}-geninfo ${TNAME}-capture-init + ) +endfunction (lcov_capture_tgt) + + +# This function will generate the global info file for all targets. It has to be +# called after all other CMake functions in the root CMakeLists.txt file, to get +# a full list of all targets that generate coverage data. +function (lcov_capture) + # Skip this function (and do not create the following targets), if there are + # no input files. + if ("${LCOV_CAPTURE_FILES}" STREQUAL "") + return() + endif () + + # Add a new target to merge the files of all targets. + set(OUTFILE "${LCOV_DATA_PATH_CAPTURE}/all_targets.info") + lcov_merge_files("${OUTFILE}" ${LCOV_CAPTURE_FILES}) + add_custom_target(lcov-geninfo DEPENDS ${OUTFILE} lcov-capture) + + # Add a new global target for all lcov targets. This target could be used to + # generate the lcov html output for the whole project instead of calling + # -geninfo and -genhtml for each target. It will also be + # used to generate a html site for all project data together instead of one + # for each target. + if (NOT TARGET lcov) + file(MAKE_DIRECTORY ${LCOV_HTML_PATH}/all_targets) + add_custom_target(lcov + COMMAND ${GENHTML_BIN} --quiet --sort + --baseline-file ${LCOV_DATA_PATH_INIT}/all_targets.info + --output-directory ${LCOV_HTML_PATH}/all_targets + --title "${CMAKE_PROJECT_NAME}" --prefix "${PROJECT_SOURCE_DIR}" + ${GENHTML_CPPFILT_FLAG} ${OUTFILE} + DEPENDS lcov-geninfo-init lcov-geninfo + ) + endif () +endfunction (lcov_capture) + + + + +# Add a new global target to generate the lcov html report for the whole project +# instead of calling -genhtml for each target (to create an own report +# for each target). Instead of the lcov target it does not require geninfo for +# all targets, so you have to call -geninfo to generate the info files +# the targets you'd like to have in your report or lcov-geninfo for generating +# info files for all targets before calling lcov-genhtml. +file(MAKE_DIRECTORY ${LCOV_HTML_PATH}/selected_targets) +if (NOT TARGET lcov-genhtml) + add_custom_target(lcov-genhtml + COMMAND ${GENHTML_BIN} + --quiet + --output-directory ${LCOV_HTML_PATH}/selected_targets + --title \"${CMAKE_PROJECT_NAME} - targets `find + ${LCOV_DATA_PATH_CAPTURE} -name \"*.info\" ! -name + \"all_targets.info\" -exec basename {} .info \\\;`\" + --prefix ${PROJECT_SOURCE_DIR} + --sort + ${GENHTML_CPPFILT_FLAG} + `find ${LCOV_DATA_PATH_CAPTURE} -name \"*.info\" ! -name + \"all_targets.info\"` + ) +endif (NOT TARGET lcov-genhtml) diff --git a/CMake/Findcodecov.cmake b/CMake/Findcodecov.cmake new file mode 100644 index 00000000..2c0f2fee --- /dev/null +++ b/CMake/Findcodecov.cmake @@ -0,0 +1,258 @@ +# This file is part of CMake-codecov. +# +# Copyright (c) +# 2015-2017 RWTH Aachen University, Federal Republic of Germany +# +# See the LICENSE file in the package base directory for details +# +# Written by Alexander Haase, alexander.haase@rwth-aachen.de +# + + +# Add an option to choose, if coverage should be enabled or not. If enabled +# marked targets will be build with coverage support and appropriate targets +# will be added. If disabled coverage will be ignored for *ALL* targets. +option(ENABLE_COVERAGE "Enable coverage build." OFF) + +set(COVERAGE_FLAG_CANDIDATES + # gcc and clang + "-O0 -g -fprofile-arcs -ftest-coverage" + + # gcc and clang fallback + "-O0 -g --coverage" +) + + +# Add coverage support for target ${TNAME} and register target for coverage +# evaluation. If coverage is disabled or not supported, this function will +# simply do nothing. +# +# Note: This function is only a wrapper to define this function always, even if +# coverage is not supported by the compiler or disabled. This function must +# be defined here, because the module will be exited, if there is no coverage +# support by the compiler or it is disabled by the user. +function (add_coverage TNAME) + # only add coverage for target, if coverage is support and enabled. + if (ENABLE_COVERAGE) + foreach (TNAME ${ARGV}) + add_coverage_target(${TNAME}) + endforeach () + endif () +endfunction (add_coverage) + + +# Add global target to gather coverage information after all targets have been +# added. Other evaluation functions could be added here, after checks for the +# specific module have been passed. +# +# Note: This function is only a wrapper to define this function always, even if +# coverage is not supported by the compiler or disabled. This function must +# be defined here, because the module will be exited, if there is no coverage +# support by the compiler or it is disabled by the user. +function (coverage_evaluate) + # add lcov evaluation + if (LCOV_FOUND) + lcov_capture_initial() + lcov_capture() + endif (LCOV_FOUND) +endfunction () + + +# Exit this module, if coverage is disabled. add_coverage is defined before this +# return, so this module can be exited now safely without breaking any build- +# scripts. +if (NOT ENABLE_COVERAGE) + return() +endif () + + + + +# Find the reuired flags foreach language. +set(CMAKE_REQUIRED_QUIET_SAVE ${CMAKE_REQUIRED_QUIET}) +set(CMAKE_REQUIRED_QUIET ${codecov_FIND_QUIETLY}) + +get_property(ENABLED_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES) +foreach (LANG ${ENABLED_LANGUAGES}) + # Coverage flags are not dependent on language, but the used compiler. So + # instead of searching flags foreach language, search flags foreach compiler + # used. + set(COMPILER ${CMAKE_${LANG}_COMPILER_ID}) + if (NOT COVERAGE_${COMPILER}_FLAGS) + foreach (FLAG ${COVERAGE_FLAG_CANDIDATES}) + if(NOT CMAKE_REQUIRED_QUIET) + message(STATUS "Try ${COMPILER} code coverage flag = [${FLAG}]") + endif() + + set(CMAKE_REQUIRED_FLAGS "${FLAG}") + unset(COVERAGE_FLAG_DETECTED CACHE) + + if (${LANG} STREQUAL "C") + include(CheckCCompilerFlag) + check_c_compiler_flag("${FLAG}" COVERAGE_FLAG_DETECTED) + + elseif (${LANG} STREQUAL "CXX") + include(CheckCXXCompilerFlag) + check_cxx_compiler_flag("${FLAG}" COVERAGE_FLAG_DETECTED) + + elseif (${LANG} STREQUAL "Fortran") + # CheckFortranCompilerFlag was introduced in CMake 3.x. To be + # compatible with older Cmake versions, we will check if this + # module is present before we use it. Otherwise we will define + # Fortran coverage support as not available. + include(CheckFortranCompilerFlag OPTIONAL + RESULT_VARIABLE INCLUDED) + if (INCLUDED) + check_fortran_compiler_flag("${FLAG}" + COVERAGE_FLAG_DETECTED) + elseif (NOT CMAKE_REQUIRED_QUIET) + message("-- Performing Test COVERAGE_FLAG_DETECTED") + message("-- Performing Test COVERAGE_FLAG_DETECTED - Failed" + " (Check not supported)") + endif () + endif() + + if (COVERAGE_FLAG_DETECTED) + set(COVERAGE_${COMPILER}_FLAGS "${FLAG}" + CACHE STRING "${COMPILER} flags for code coverage.") + mark_as_advanced(COVERAGE_${COMPILER}_FLAGS) + break() + else () + message(WARNING "Code coverage is not available for ${COMPILER}" + " compiler. Targets using this compiler will be " + "compiled without it.") + endif () + endforeach () + endif () +endforeach () + +set(CMAKE_REQUIRED_QUIET ${CMAKE_REQUIRED_QUIET_SAVE}) + + + + +# Helper function to get the language of a source file. +function (codecov_lang_of_source FILE RETURN_VAR) + get_filename_component(FILE_EXT "${FILE}" EXT) + string(TOLOWER "${FILE_EXT}" FILE_EXT) + string(SUBSTRING "${FILE_EXT}" 1 -1 FILE_EXT) + + get_property(ENABLED_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES) + foreach (LANG ${ENABLED_LANGUAGES}) + list(FIND CMAKE_${LANG}_SOURCE_FILE_EXTENSIONS "${FILE_EXT}" TEMP) + if (NOT ${TEMP} EQUAL -1) + set(${RETURN_VAR} "${LANG}" PARENT_SCOPE) + return() + endif () + endforeach() + + set(${RETURN_VAR} "" PARENT_SCOPE) +endfunction () + + +# Helper function to get the relative path of the source file destination path. +# This path is needed by FindGcov and FindLcov cmake files to locate the +# captured data. +function (codecov_path_of_source FILE RETURN_VAR) + string(REGEX MATCH "TARGET_OBJECTS:([^ >]+)" _source ${FILE}) + + # If expression was found, SOURCEFILE is a generator-expression for an + # object library. Currently we found no way to call this function automatic + # for the referenced target, so it must be called in the directoryso of the + # object library definition. + if (NOT "${_source}" STREQUAL "") + set(${RETURN_VAR} "" PARENT_SCOPE) + return() + endif () + + + string(REPLACE "${CMAKE_CURRENT_BINARY_DIR}/" "" FILE "${FILE}") + if(IS_ABSOLUTE ${FILE}) + file(RELATIVE_PATH FILE ${CMAKE_CURRENT_SOURCE_DIR} ${FILE}) + endif() + + # get the right path for file + string(REPLACE ".." "__" PATH "${FILE}") + + set(${RETURN_VAR} "${PATH}" PARENT_SCOPE) +endfunction() + + + + +# Add coverage support for target ${TNAME} and register target for coverage +# evaluation. +function(add_coverage_target TNAME) + # Check if all sources for target use the same compiler. If a target uses + # e.g. C and Fortran mixed and uses different compilers (e.g. clang and + # gfortran) this can trigger huge problems, because different compilers may + # use different implementations for code coverage. + get_target_property(TSOURCES ${TNAME} SOURCES) + set(TARGET_COMPILER "") + set(ADDITIONAL_FILES "") + foreach (FILE ${TSOURCES}) + # If expression was found, FILE is a generator-expression for an object + # library. Object libraries will be ignored. + string(REGEX MATCH "TARGET_OBJECTS:([^ >]+)" _file ${FILE}) + if ("${_file}" STREQUAL "") + codecov_lang_of_source(${FILE} LANG) + if (LANG) + list(APPEND TARGET_COMPILER ${CMAKE_${LANG}_COMPILER_ID}) + + list(APPEND ADDITIONAL_FILES "${FILE}.gcno") + list(APPEND ADDITIONAL_FILES "${FILE}.gcda") + endif () + endif () + endforeach () + + list(REMOVE_DUPLICATES TARGET_COMPILER) + list(LENGTH TARGET_COMPILER NUM_COMPILERS) + + if (NUM_COMPILERS GREATER 1) + message(WARNING "Can't use code coverage for target ${TNAME}, because " + "it will be compiled by incompatible compilers. Target will be " + "compiled without code coverage.") + return() + + elseif (NUM_COMPILERS EQUAL 0) + message(WARNING "Can't use code coverage for target ${TNAME}, because " + "it uses an unknown compiler. Target will be compiled without " + "code coverage.") + return() + + elseif (NOT DEFINED "COVERAGE_${TARGET_COMPILER}_FLAGS") + # A warning has been printed before, so just return if flags for this + # compiler aren't available. + return() + endif() + + + # enable coverage for target + set_property(TARGET ${TNAME} APPEND_STRING + PROPERTY COMPILE_FLAGS " ${COVERAGE_${TARGET_COMPILER}_FLAGS}") + set_property(TARGET ${TNAME} APPEND_STRING + PROPERTY LINK_FLAGS " ${COVERAGE_${TARGET_COMPILER}_FLAGS}") + + + # Add gcov files generated by compiler to clean target. + set(CLEAN_FILES "") + foreach (FILE ${ADDITIONAL_FILES}) + codecov_path_of_source(${FILE} FILE) + list(APPEND CLEAN_FILES "CMakeFiles/${TNAME}.dir/${FILE}") + endforeach() + + set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES + "${CLEAN_FILES}") + + + add_gcov_target(${TNAME}) + add_lcov_target(${TNAME}) +endfunction(add_coverage_target) + + + + +# Include modules for parsing the collected data and output it in a readable +# format (like gcov and lcov). +find_package(Gcov) +find_package(Lcov) diff --git a/CMake/catch2-with-main.pc.in b/CMake/catch2-with-main.pc.in new file mode 100644 index 00000000..69a790bb --- /dev/null +++ b/CMake/catch2-with-main.pc.in @@ -0,0 +1,10 @@ +includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ +libdir=@CMAKE_INSTALL_FULL_LIBDIR@ +pkg_version=@Catch2_VERSION@ + +Name: Catch2-With-Main +Description: A modern, C++-native test framework for C++14 and above (links in default main) +Version: ${pkg_version} +Requires: catch2 = ${pkg_version} +Cflags: -I${includedir} +Libs: -L${libdir} -lCatch2Main diff --git a/CMake/catch2.pc.in b/CMake/catch2.pc.in new file mode 100644 index 00000000..bd1c95a1 --- /dev/null +++ b/CMake/catch2.pc.in @@ -0,0 +1,11 @@ +prefix=@CMAKE_INSTALL_PREFIX@ +exec_prefix=${prefix} +includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ +libdir=@CMAKE_INSTALL_FULL_LIBDIR@ + +Name: Catch2 +Description: A modern, C++-native, test framework for C++14 and above +URL: https://github.com/catchorg/Catch2 +Version: @Catch2_VERSION@ +Cflags: -I${includedir} +Libs: -L${libdir} -lCatch2 diff --git a/CMake/llvm-cov-wrapper b/CMake/llvm-cov-wrapper new file mode 100755 index 00000000..2ac33102 --- /dev/null +++ b/CMake/llvm-cov-wrapper @@ -0,0 +1,56 @@ +#!/bin/sh + +# This file is part of CMake-codecov. +# +# Copyright (c) +# 2015-2017 RWTH Aachen University, Federal Republic of Germany +# +# See the LICENSE file in the package base directory for details +# +# Written by Alexander Haase, alexander.haase@rwth-aachen.de +# + +if [ -z "$LLVM_COV_BIN" ] +then + echo "LLVM_COV_BIN not set!" >& 2 + exit 1 +fi + + +# Get LLVM version to find out. +LLVM_VERSION=$($LLVM_COV_BIN -version | grep -i "LLVM version" \ + | sed "s/^\([A-Za-z ]*\)\([0-9]\).\([0-9]\).*$/\2.\3/g") + +if [ "$1" = "-v" ] +then + echo "llvm-cov-wrapper $LLVM_VERSION" + exit 0 +fi + + +if [ -n "$LLVM_VERSION" ] +then + MAJOR=$(echo $LLVM_VERSION | cut -d'.' -f1) + MINOR=$(echo $LLVM_VERSION | cut -d'.' -f2) + + if [ $MAJOR -eq 3 ] && [ $MINOR -le 4 ] + then + if [ -f "$1" ] + then + filename=$(basename "$1") + extension="${filename##*.}" + + case "$extension" in + "gcno") exec $LLVM_COV_BIN --gcno="$1" ;; + "gcda") exec $LLVM_COV_BIN --gcda="$1" ;; + esac + fi + fi + + if [ $MAJOR -eq 3 ] && [ $MINOR -le 5 ] + then + exec $LLVM_COV_BIN $@ + fi +fi + +exec $LLVM_COV_BIN gcov $@ diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..d5a6b67a --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,199 @@ +cmake_minimum_required(VERSION 3.10) + +# detect if Catch is being bundled, +# disable testsuite in that case +if(NOT DEFINED PROJECT_NAME) + set(NOT_SUBPROJECT ON) +else() + set(NOT_SUBPROJECT OFF) +endif() + +option(CATCH_INSTALL_DOCS "Install documentation alongside library" ON) +option(CATCH_INSTALL_EXTRAS "Install extras (CMake scripts, debugger helpers) alongside library" ON) +option(CATCH_DEVELOPMENT_BUILD "Build tests, enable warnings, enable Werror, etc" OFF) + +include(CMakeDependentOption) +cmake_dependent_option(CATCH_BUILD_TESTING "Build the SelfTest project" ON "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_BUILD_EXAMPLES "Build code examples" OFF "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_BUILD_EXTRA_TESTS "Build extra tests" OFF "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_BUILD_FUZZERS "Build fuzzers" OFF "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_ENABLE_COVERAGE "Generate coverage for codecov.io" OFF "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_ENABLE_WERROR "Enables Werror during build" ON "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_BUILD_SURROGATES "Enable generating and building surrogate TUs for the main headers" OFF "CATCH_DEVELOPMENT_BUILD" OFF) +cmake_dependent_option(CATCH_ENABLE_CONFIGURE_TESTS "Enable CMake configuration tests. WARNING: VERY EXPENSIVE" OFF "CATCH_DEVELOPMENT_BUILD" OFF) + + +# Catch2's build breaks if done in-tree. You probably should not build +# things in tree anyway, but we can allow projects that include Catch2 +# as a subproject to build in-tree as long as it is not in our tree. +if (CMAKE_BINARY_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) + message(FATAL_ERROR "Building in-source is not supported! Create a build dir and remove ${CMAKE_SOURCE_DIR}/CMakeCache.txt") +endif() + +project(Catch2 + VERSION 3.2.1 # CML version placeholder, don't delete + LANGUAGES CXX + # HOMEPAGE_URL is not supported until CMake version 3.12, which + # we do not target yet. + # HOMEPAGE_URL "https://github.com/catchorg/Catch2" + DESCRIPTION "A modern, C++-native, unit test framework." +) + + +# Provide path for scripts. We first add path to the scripts we don't use, +# but projects including us might, and set the path up to parent scope. +# Then we also add path that we use to configure the project, but is of +# no use to top level projects. +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/extras") +if (NOT NOT_SUBPROJECT) + set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" PARENT_SCOPE) +endif() +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/CMake") + +include(GNUInstallDirs) +include(CMakePackageConfigHelpers) +include(CatchConfigOptions) +if(CATCH_DEVELOPMENT_BUILD) + include(CTest) +endif() + +# This variable is used in some subdirectories, so we need it here, rather +# than later in the install block +set(CATCH_CMAKE_CONFIG_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/Catch2") + +# We have some Windows builds that test `wmain` entry point, +# and we need this change to be present in all binaries that +# are built during these tests, so this is required here, before +# the subdirectories are added. +if(CATCH_TEST_USE_WMAIN) + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /ENTRY:wmainCRTStartup") +endif() + + +# Basic paths +set(CATCH_DIR ${CMAKE_CURRENT_SOURCE_DIR}) +set(SOURCES_DIR ${CATCH_DIR}/src/catch2) +set(SELF_TEST_DIR ${CATCH_DIR}/tests/SelfTest) +set(BENCHMARK_DIR ${CATCH_DIR}/tests/Benchmark) +set(EXAMPLES_DIR ${CATCH_DIR}/examples) + +# We need to bring-in the variables defined there to this scope +add_subdirectory(src) + +# Build tests only if requested +if (BUILD_TESTING AND CATCH_BUILD_TESTING AND NOT_SUBPROJECT) + find_package(PythonInterp 3 REQUIRED) + if (NOT PYTHONINTERP_FOUND) + message(FATAL_ERROR "Python not found, but required for tests") + endif() + add_subdirectory(tests) +endif() + +if(CATCH_BUILD_EXAMPLES) + add_subdirectory(examples) +endif() + +if(CATCH_BUILD_EXTRA_TESTS) + add_subdirectory(tests/ExtraTests) +endif() + +if(CATCH_BUILD_FUZZERS) + add_subdirectory(fuzzing) +endif() + +if (CATCH_DEVELOPMENT_BUILD) + add_warnings_to_targets("${CATCH_WARNING_TARGETS}") +endif() + +# Only perform the installation steps when Catch is not being used as +# a subproject via `add_subdirectory`, or the destinations will break, +# see https://github.com/catchorg/Catch2/issues/1373 +if (NOT_SUBPROJECT) + configure_package_config_file( + ${CMAKE_CURRENT_LIST_DIR}/CMake/Catch2Config.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/Catch2Config.cmake + INSTALL_DESTINATION + ${CATCH_CMAKE_CONFIG_DESTINATION} + ) + + write_basic_package_version_file( + "${CMAKE_CURRENT_BINARY_DIR}/Catch2ConfigVersion.cmake" + COMPATIBILITY + SameMajorVersion + ) + + install( + FILES + "${CMAKE_CURRENT_BINARY_DIR}/Catch2Config.cmake" + "${CMAKE_CURRENT_BINARY_DIR}/Catch2ConfigVersion.cmake" + DESTINATION + ${CATCH_CMAKE_CONFIG_DESTINATION} + ) + + # Install documentation + if(CATCH_INSTALL_DOCS) + install( + DIRECTORY + docs/ + DESTINATION + "${CMAKE_INSTALL_DOCDIR}" + PATTERN "doxygen" EXCLUDE + ) + endif() + + if(CATCH_INSTALL_EXTRAS) + # Install CMake scripts + install( + FILES + "extras/ParseAndAddCatchTests.cmake" + "extras/Catch.cmake" + "extras/CatchAddTests.cmake" + DESTINATION + ${CATCH_CMAKE_CONFIG_DESTINATION} + ) + + # Install debugger helpers + install( + FILES + "extras/gdbinit" + "extras/lldbinit" + DESTINATION + ${CMAKE_INSTALL_DATAROOTDIR}/Catch2 + ) + endif() + + ## Provide some pkg-config integration + set(PKGCONFIG_INSTALL_DIR + "${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig" + CACHE PATH "Path where catch2.pc is installed" + ) + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/CMake/catch2.pc.in + ${CMAKE_CURRENT_BINARY_DIR}/catch2.pc + @ONLY + ) + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/CMake/catch2-with-main.pc.in + ${CMAKE_CURRENT_BINARY_DIR}/catch2-with-main.pc + @ONLY + ) + install( + FILES + "${CMAKE_CURRENT_BINARY_DIR}/catch2.pc" + "${CMAKE_CURRENT_BINARY_DIR}/catch2-with-main.pc" + DESTINATION + ${PKGCONFIG_INSTALL_DIR} + ) + + # CPack/CMake started taking the package version from project version 3.12 + # So we need to set the version manually for older CMake versions + if(${CMAKE_VERSION} VERSION_LESS "3.12.0") + set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) + endif() + + set(CPACK_PACKAGE_CONTACT "https://github.com/catchorg/Catch2/") + + + include( CPack ) + +endif(NOT_SUBPROJECT) diff --git a/CMakePresets.json b/CMakePresets.json new file mode 100644 index 00000000..00f3a6d3 --- /dev/null +++ b/CMakePresets.json @@ -0,0 +1,25 @@ +{ + "version": 3, + "configurePresets": [ + { + "name": "basic-tests", + "displayName": "Basic development build", + "description": "Enables development build with basic tests that are cheap to build and run", + "cacheVariables": { + "CATCH_DEVELOPMENT_BUILD": "ON" + } + }, + { + "name": "all-tests", + "inherits": "basic-tests", + "displayName": "Full development build", + "description": "Enables development build with examples and ALL tests", + "cacheVariables": { + "CATCH_BUILD_EXAMPLES": "ON", + "CATCH_BUILD_EXTRA_TESTS": "ON", + "CATCH_BUILD_SURROGATES": "ON", + "CATCH_ENABLE_CONFIGURE_TESTS": "ON" + } + } + ] +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..be1a688e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at github@philnash.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 00000000..68318416 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2484 @@ +# Doxyfile 1.8.16 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Catch2" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Popular C++ unit testing framework" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs/doxygen + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = "complexity=@par Complexity:" \ + "noexcept=**Noexcept**" + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = YES + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = YES + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = doxygen.errors + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = "src/catch2" + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +# FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = */lib/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = NO + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = YES + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = TeX/AMSmath \ + TeX/AMSsymbols + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /