From 8618e39486dde855d671e1e7ecc3f50b43aee257 Mon Sep 17 00:00:00 2001 From: ThePhD Date: Sat, 6 Mar 2021 01:03:23 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=9B=A0=20Prepare=20for=20the=20a=20sol4?= =?UTF-8?q?=20release...?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 🎨 Refactor the CMake a whle bunch --- .clang-format | 2 +- .dockerignore | 2 +- .gitignore | 2 +- .travis.yml | 2 +- CMakeLists.txt | 22 +- LICENSE.txt | 2 +- appveyor.yml | 2 +- cmake/Modules/Common/Core.cmake | 2 +- cmake/Modules/FindCatch.cmake | 84 - cmake/Modules/FindKaguyaBuild.cmake | 2 +- cmake/Modules/FindLua/set_version_vars.cmake | 2 +- cmake/Modules/FindLuaBridgeBuild.cmake | 2 +- cmake/Modules/FindLuaBuild.cmake | 2 +- cmake/Modules/FindLuaBuild/LuaJIT.cmake | 8 +- cmake/Modules/FindLuaBuild/LuaVanilla.cmake | 16 +- cmake/Modules/FindLuwraBuild.cmake | 2 +- cmake/Modules/FindSphinx.cmake | 68 + cmake/Modules/FindToLuappBuild.cmake | 7 +- cmake/sol2-config.cmake.in | 2 +- docs/CMakeLists.txt | 46 - documentation/.clang-format | 110 + documentation/CMakeLists.txt | 104 + documentation/Doxyfile.in | 2678 +++++++++++++++++ {docs => documentation}/Makefile | 0 {docs => documentation}/make.bat | 0 ...4 - ThePhD - No Overhead C Abstraction.pdf | Bin ...11.08 - ThePhD - Wrapping Lua C in C++.pdf | Bin ....06 - ThePhD - Biting the CMake Bullet.pdf | Bin ...ompile Fast, Run Faster, Scale Forever.pdf | Bin ...hD - Scripting at the Speed of Thought.pdf | Bin ...- Compile-Time Extension Points in C++.pdf | Bin documentation/requirements.txt | 3 + .../source/_themes/sol2/layout.html | 0 .../_themes/sol2/static/search-fix.js_t | 0 .../source/_themes/sol2/static/sol2.css_t | 0 .../source/_themes/sol2/theme.conf | 0 .../source/api/api-top.rst | 0 .../source/api/as_args.rst | 0 .../source/api/as_container.rst | 0 .../source/api/as_function.rst | 0 .../source/api/as_returns.rst | 0 .../source/api/as_table.rst | 0 {docs => documentation}/source/api/c_call.rst | 0 .../source/api/compatibility.rst | 0 .../source/api/coroutine.rst | 0 .../source/api/environment.rst | 0 {docs => documentation}/source/api/error.rst | 0 .../source/api/function.rst | 0 .../source/api/lua_value.rst | 0 .../source/api/make_reference.rst | 0 .../source/api/metatable_key.rst | 0 {docs => documentation}/source/api/nested.rst | 0 .../source/api/new_table.rst | 0 {docs => documentation}/source/api/object.rst | 0 .../source/api/optional.rst | 0 .../source/api/overload.rst | 0 .../source/api/policies.rst | 0 .../source/api/property.rst | 0 .../source/api/protect.rst | 0 .../source/api/protected_function.rst | 3 +- {docs => documentation}/source/api/proxy.rst | 0 .../source/api/readonly.rst | 0 .../source/api/reference.rst | 0 .../source/api/resolve.rst | 0 {docs => documentation}/source/api/stack.rst | 0 .../source/api/stack_reference.rst | 2 +- {docs => documentation}/source/api/state.rst | 0 {docs => documentation}/source/api/table.rst | 0 .../source/api/table_traversal_keys.rst | 0 .../source/api/this_environment.rst | 0 .../source/api/this_state.rst | 0 {docs => documentation}/source/api/thread.rst | 0 {docs => documentation}/source/api/tie.rst | 0 {docs => documentation}/source/api/types.rst | 0 .../source/api/unique_usertype_traits.rst | 0 {docs => documentation}/source/api/user.rst | 0 .../source/api/userdata.rst | 0 .../source/api/usertype.rst | 0 .../source/api/usertype_memory.rst | 0 {docs => documentation}/source/api/var.rst | 0 .../source/api/variadic_args.rst | 0 .../source/api/variadic_results.rst | 0 .../source/api/yielding.rst | 0 {docs => documentation}/source/benchmarks.rst | 0 {docs => documentation}/source/build.rst | 0 {docs => documentation}/source/codecvt.rst | 0 .../source/compilation.rst | 0 {docs => documentation}/source/conf.py | 91 +- {docs => documentation}/source/containers.rst | 0 {docs => documentation}/source/errors.rst | 0 {docs => documentation}/source/exceptions.rst | 0 {docs => documentation}/source/features.rst | 2 +- {docs => documentation}/source/functions.rst | 0 {docs => documentation}/source/index.rst | 0 {docs => documentation}/source/licenses.rst | 0 .../source/media/Ko-fi_Blue.png | Bin .../source/media/become_a_patron_button.png | Bin .../source/media/bench/base_derived.png | Bin .../source/media/bench/c_function.png | Bin .../bench/c_function_through_lua_in_c.png | Bin .../media/bench/implicit_inheritance.png | Bin .../media/bench/lua_bindings_shootout.json | 0 .../source/media/bench/lua_function_in_c.png | Bin .../media/bench/member_function_call.png | Bin .../source/media/bench/multi_return.png | Bin .../source/media/bench/multi_return_lua.png | Bin .../source/media/bench/optional_failure.png | Bin .../media/bench/optional_half_failure.png | Bin .../source/media/bench/optional_success.png | Bin .../source/media/bench/return_userdata.png | Bin .../media/bench/stateful_function_object.png | Bin .../source/media/bench/table_chained_get.png | Bin .../source/media/bench/table_chained_set.png | Bin .../source/media/bench/table_get.png | Bin .../media/bench/table_global_string_get.png | Bin .../media/bench/table_global_string_set.png | Bin .../source/media/bench/table_set.png | Bin .../media/bench/userdata_variable_access.png | Bin .../bench/userdata_variable_access_large.png | Bin .../bench/userdata_variable_access_last.png | Bin .../source/media/discord_logo_wordmark.png | Bin .../source/media/eevee_code_after.jpg | Bin .../source/media/eevee_code_before.jpg | Bin .../source/media/github_logo.png | Bin .../source/media/github_sponsors_logo.png | Bin .../source/media/liberapay_logo.png | Bin .../source/media/pp_cc_mark_111x69.jpg | Bin {docs => documentation}/source/media/sol.png | Bin {docs => documentation}/source/media/sol.psd | Bin {docs => documentation}/source/mentions.rst | 0 {docs => documentation}/source/origin.rst | 0 .../source/performance.rst | 0 {docs => documentation}/source/rtti.rst | 0 {docs => documentation}/source/safety.rst | 0 {docs => documentation}/source/threading.rst | 0 {docs => documentation}/source/traits.rst | 0 .../source/tutorial/all-the-things.rst | 2 +- .../source/tutorial/customization.rst | 0 .../source/tutorial/cxx-in-lua.rst | 0 .../source/tutorial/existing.rst | 0 .../source/tutorial/functions.rst | 174 +- .../source/tutorial/getting-started.rst | 0 .../source/tutorial/ownership.rst | 0 .../source/tutorial/tutorial-top.rst | 0 .../source/tutorial/variables.rst | 0 {docs => documentation}/source/usertypes.rst | 0 examples/CMakeLists.txt | 51 +- examples/customization/CMakeLists.txt | 6 +- .../customization/source/lua_zm_interop.cpp | 2 +- examples/customization/source/main.cpp | 2 +- examples/include/assert.hpp | 41 - examples/interop/LuaBridge/CMakeLists.txt | 12 +- .../interop/LuaBridge/source/LuaBridge.cpp | 43 +- examples/interop/kaguya/CMakeLists.txt | 12 +- examples/interop/kaguya/source/kaguya.cpp | 11 +- examples/interop/luwra/CMakeLists.txt | 12 +- examples/interop/luwra/source/luwra.cpp | 30 +- examples/interop/tolua/CMakeLists.txt | 14 +- examples/interop/tolua/source/tolua.cpp | 30 +- examples/require_dll_example/CMakeLists.txt | 26 +- .../include/my_object/my_object.hpp | 9 +- .../include/my_object/my_object_api.hpp | 28 +- .../require_dll_example/source/my_object.cpp | 6 +- .../source/require_from_dll.cpp | 5 +- examples/source/any_return.cpp | 9 +- examples/source/args_from_container.cpp | 8 +- examples/source/as_returns.cpp | 15 +- examples/source/basic.cpp | 13 +- examples/source/c_array.cpp | 20 +- examples/source/c_call.cpp | 21 +- examples/source/config.cpp | 23 +- .../container_usertype_as_container.cpp | 50 +- examples/source/container_with_pairs.cpp | 5 +- examples/source/containers.cpp | 8 +- examples/source/containers_as_table.cpp | 21 +- examples/source/coroutine.cpp | 14 +- examples/source/coroutine_multiple_stacks.cpp | 10 +- examples/source/coroutine_state.cpp | 3 +- examples/source/custom_reader.cpp | 24 +- .../source/customization_convert_on_get.cpp | 12 +- ...tomization_global_transparent_argument.cpp | 4 +- examples/source/customization_multiple.cpp | 5 +- examples/source/docs/as_function.cpp | 8 +- .../as_function_usertype_member_variable.cpp | 15 +- examples/source/docs/as_table_ipairs.cpp | 6 +- examples/source/docs/inheritance.cpp | 28 +- examples/source/docs/my_panic.cpp | 4 +- .../source/docs/preparing_environments.cpp | 8 +- .../source/docs/references_in_lambdas.cpp | 13 +- examples/source/docs/runtime_extension.cpp | 10 +- examples/source/docs/simple_functions.cpp | 7 +- examples/source/docs/simple_structs.cpp | 22 +- examples/source/docs/state_script_safe.cpp | 8 +- examples/source/docs/state_transfer.cpp | 11 +- examples/source/dump.cpp | 7 +- examples/source/dynamic_object.cpp | 3 +- examples/source/environment_snooping.cpp | 7 +- examples/source/environment_state.cpp | 6 +- examples/source/environment_state_2.cpp | 2 +- examples/source/environments_on_functions.cpp | 58 +- examples/source/exception_handler.cpp | 3 +- examples/source/functions.cpp | 23 +- examples/source/functions_empty_arguments.cpp | 1 - .../source/index_and_newindex_usertype.cpp | 27 +- examples/source/indirect_function_calls.cpp | 7 +- examples/source/lua_value.cpp | 9 +- examples/source/metatable_key_low_level.cpp | 15 +- examples/source/multi_results.cpp | 29 +- examples/source/optional_with_iteration.cpp | 12 +- examples/source/overloading.cpp | 7 +- examples/source/overloading_with_fallback.cpp | 12 +- examples/source/overloading_with_members.cpp | 38 +- .../source/overridable_function_members.cpp | 5 +- examples/source/pairs.cpp | 21 +- examples/source/pairs_with_raw_functions.cpp | 14 +- examples/source/property.cpp | 13 +- examples/source/protect.cpp | 7 +- examples/source/protected_functions.cpp | 2 +- examples/source/read_only.cpp | 50 +- examples/source/require.cpp | 11 +- examples/source/require_override_behavior.cpp | 15 +- examples/source/runtime_additions.cpp | 9 +- examples/source/script_error_handling.cpp | 9 +- examples/source/self_from_lua.cpp | 5 +- examples/source/shared_ptr.cpp | 25 +- examples/source/shared_ptr_inheritance.cpp | 5 +- .../source/shared_ptr_modify_in_place.cpp | 16 +- examples/source/singleton.cpp | 15 +- examples/source/stack_aligned_function.cpp | 7 +- .../stack_aligned_stack_handler_function.cpp | 7 +- examples/source/static_variables.cpp | 17 +- examples/source/table_as_container.cpp | 9 +- examples/source/table_create_if_nil.cpp | 5 +- examples/source/table_proxy.cpp | 5 +- examples/source/tables.cpp | 23 +- examples/source/this_state.cpp | 17 +- examples/source/tie.cpp | 19 +- examples/source/tutorials/multiple_return.cpp | 22 + examples/source/tutorials/object_lifetime.cpp | 2 +- .../quick_n_dirty/arguments_to_scripts.cpp | 5 +- .../tutorials/quick_n_dirty/functions_all.cpp | 7 +- .../quick_n_dirty/functions_easy.cpp | 11 +- .../tutorials/quick_n_dirty/make_tables.cpp | 20 +- .../multiple_returns_from_lua.cpp | 9 +- .../quick_n_dirty/multiple_returns_to_lua.cpp | 13 +- .../tutorials/quick_n_dirty/namespacing.cpp | 13 +- .../quick_n_dirty/opening_a_state.cpp | 1 - .../quick_n_dirty/running_lua_code.cpp | 15 +- .../running_lua_code_low_level.cpp | 13 +- .../quick_n_dirty/running_lua_code_safely.cpp | 19 +- .../quick_n_dirty/set_and_get_variables.cpp | 21 +- .../set_and_get_variables_exists.cpp | 5 +- .../quick_n_dirty/tables_and_nesting.cpp | 17 +- .../tutorials/quick_n_dirty/userdata.cpp | 28 +- .../userdata_memory_reference.cpp | 20 +- .../tutorials/quick_n_dirty/usertypes.cpp | 14 +- .../source/tutorials/reading_functions.cpp | 29 + examples/source/tutorials/variables_demo.cpp | 13 +- .../source/tutorials/write_variables_demo.cpp | 9 +- .../source/tutorials/writing_functions.cpp | 28 + .../tutorials/writing_member_functions.cpp | 50 + .../writing_overloaded_template_functions.cpp | 24 + .../tutorials/writing_template_functions.cpp | 28 + examples/source/unique_ptr.cpp | 23 +- examples/source/usertype.cpp | 158 +- examples/source/usertype_advanced.cpp | 20 +- .../source/usertype_automatic_operators.cpp | 18 +- examples/source/usertype_basics.cpp | 35 +- examples/source/usertype_bitfields.cpp | 29 +- examples/source/usertype_call_from_c++.cpp | 20 +- examples/source/usertype_dynamic_get_set.cpp | 37 +- examples/source/usertype_initializers.cpp | 27 +- .../source/usertype_special_functions.cpp | 36 +- examples/source/usertype_var.cpp | 21 +- examples/source/variables.cpp | 44 +- examples/source/variadic_args_shifted.cpp | 10 +- examples/source/variadic_args_storage.cpp | 10 +- examples/source/wip/lua_inheritance.cpp | 3 +- include/sol/as_args.hpp | 2 +- include/sol/as_returns.hpp | 2 +- include/sol/assert.hpp | 99 + include/sol/base_traits.hpp | 2 +- include/sol/bind_traits.hpp | 2 +- include/sol/bytecode.hpp | 2 +- include/sol/call.hpp | 4 +- include/sol/compatibility.hpp | 2 +- include/sol/compatibility/lua_version.hpp | 2 +- include/sol/config.hpp | 2 +- include/sol/coroutine.hpp | 2 +- include/sol/debug.hpp | 2 +- include/sol/demangle.hpp | 2 +- include/sol/deprecate.hpp | 2 +- include/sol/dump_handler.hpp | 2 +- include/sol/ebco.hpp | 12 +- include/sol/environment.hpp | 6 +- include/sol/error.hpp | 2 +- include/sol/error_handler.hpp | 2 +- include/sol/forward.hpp | 2 +- include/sol/forward_detail.hpp | 2 +- include/sol/function.hpp | 2 +- include/sol/function_result.hpp | 2 +- include/sol/function_types.hpp | 2 +- include/sol/function_types_core.hpp | 2 +- include/sol/function_types_overloaded.hpp | 2 +- include/sol/function_types_stateful.hpp | 2 +- include/sol/function_types_stateless.hpp | 2 +- include/sol/function_types_templated.hpp | 2 +- include/sol/in_place.hpp | 2 +- include/sol/inheritance.hpp | 2 +- include/sol/load_result.hpp | 2 +- include/sol/lua_table.hpp | 2 +- include/sol/lua_value.hpp | 2 +- include/sol/make_reference.hpp | 2 +- include/sol/metatable.hpp | 2 +- include/sol/object.hpp | 2 +- include/sol/object_base.hpp | 2 +- include/sol/optional.hpp | 2 +- include/sol/optional_implementation.hpp | 5 +- include/sol/overload.hpp | 2 +- include/sol/packaged_coroutine.hpp | 2 +- include/sol/pairs_iterator.hpp | 2 +- include/sol/pointer_like.hpp | 2 +- include/sol/policies.hpp | 2 +- include/sol/property.hpp | 2 +- include/sol/protect.hpp | 2 +- include/sol/protected_function.hpp | 2 +- include/sol/protected_function_result.hpp | 2 +- include/sol/protected_handler.hpp | 2 +- include/sol/proxy_base.hpp | 2 +- include/sol/raii.hpp | 2 +- include/sol/reference.hpp | 2 +- include/sol/resolve.hpp | 6 +- include/sol/sol.hpp | 3 +- include/sol/stack.hpp | 14 +- include/sol/stack_check.hpp | 2 +- include/sol/stack_check_get.hpp | 2 +- include/sol/stack_check_get_qualified.hpp | 2 +- include/sol/stack_check_get_unqualified.hpp | 2 +- include/sol/stack_check_qualified.hpp | 2 +- include/sol/stack_check_unqualified.hpp | 2 +- include/sol/stack_core.hpp | 2 +- include/sol/stack_field.hpp | 2 +- include/sol/stack_get.hpp | 2 +- include/sol/stack_get_qualified.hpp | 2 +- include/sol/stack_get_unqualified.hpp | 2 +- include/sol/stack_guard.hpp | 2 +- include/sol/stack_iterator.hpp | 2 +- include/sol/stack_pop.hpp | 2 +- include/sol/stack_probe.hpp | 2 +- include/sol/stack_proxy.hpp | 2 +- include/sol/stack_proxy_base.hpp | 2 +- include/sol/stack_push.hpp | 2 +- include/sol/stack_reference.hpp | 2 +- include/sol/state.hpp | 2 +- include/sol/state_handling.hpp | 2 +- include/sol/state_view.hpp | 2 +- include/sol/string_view.hpp | 2 +- include/sol/table.hpp | 2 +- include/sol/table_core.hpp | 2 +- include/sol/table_iterator.hpp | 2 +- include/sol/table_proxy.hpp | 2 +- include/sol/thread.hpp | 2 +- include/sol/tie.hpp | 2 +- include/sol/traits.hpp | 2 +- include/sol/trampoline.hpp | 2 +- include/sol/tuple.hpp | 2 +- include/sol/types.hpp | 2 +- include/sol/unicode.hpp | 6 +- include/sol/unique_usertype_traits.hpp | 8 +- include/sol/unsafe_function.hpp | 2 +- include/sol/unsafe_function_result.hpp | 2 +- include/sol/userdata.hpp | 2 +- include/sol/usertype.hpp | 2 +- include/sol/usertype_container.hpp | 2 +- include/sol/usertype_container_launch.hpp | 2 +- include/sol/usertype_core.hpp | 2 +- include/sol/usertype_proxy.hpp | 2 +- include/sol/usertype_storage.hpp | 2 +- include/sol/usertype_traits.hpp | 2 +- include/sol/variadic_args.hpp | 2 +- include/sol/variadic_results.hpp | 2 +- include/sol/version.hpp | 24 +- include/sol/wrapper.hpp | 2 +- scripts/build.linux.sh | 2 +- scripts/preparation.linux.sh | 2 +- scripts/preparation.osx.sh | 2 +- scripts/push.linux.sh | 2 +- scripts/run.linux.sh | 2 +- scripts/run.osx.sh | 2 +- single/include/sol/config.hpp | 4 +- single/include/sol/forward.hpp | 26 +- single/include/sol/sol.hpp | 135 +- sol2.natvis | 8 +- tests/CMakeLists.txt | 10 +- tests/config_tests/CMakeLists.txt | 2 +- .../function_pointers/CMakeLists.txt | 13 +- .../function_pointers/source/main.cpp | 13 +- tests/header_tests/CMakeLists.txt | 14 +- tests/header_tests/source/as_args.cpp | 2 +- tests/header_tests/source/as_returns.cpp | 2 +- tests/header_tests/source/base_traits.cpp | 2 +- tests/header_tests/source/bind_traits.cpp | 2 +- tests/header_tests/source/bytecode.cpp | 2 +- tests/header_tests/source/call.cpp | 2 +- tests/header_tests/source/compatibility.cpp | 2 +- .../source/compatibility/compat-5.3.cpp | 2 +- .../source/compatibility/lua_version.cpp | 2 +- tests/header_tests/source/config.cpp | 2 +- tests/header_tests/source/coroutine.cpp | 2 +- tests/header_tests/source/debug.cpp | 2 +- tests/header_tests/source/demangle.cpp | 2 +- tests/header_tests/source/deprecate.cpp | 2 +- tests/header_tests/source/ebco.cpp | 2 +- tests/header_tests/source/environment.cpp | 2 +- tests/header_tests/source/error_handler.cpp | 2 +- tests/header_tests/source/forward.cpp | 2 +- tests/header_tests/source/forward_detail.cpp | 2 +- tests/header_tests/source/function.cpp | 2 +- tests/header_tests/source/function_result.cpp | 2 +- tests/header_tests/source/function_types.cpp | 2 +- .../source/function_types_core.cpp | 2 +- .../source/function_types_overloaded.cpp | 2 +- .../source/function_types_stateful.cpp | 2 +- .../source/function_types_stateless.cpp | 2 +- .../source/function_types_templated.cpp | 2 +- tests/header_tests/source/in_place.cpp | 2 +- tests/header_tests/source/inheritance.cpp | 2 +- tests/header_tests/source/load_result.cpp | 2 +- tests/header_tests/source/lua_table.cpp | 2 +- tests/header_tests/source/lua_value.cpp | 2 +- tests/header_tests/source/main.cpp | 4 +- tests/header_tests/source/make_reference.cpp | 2 +- tests/header_tests/source/metatable.cpp | 2 +- tests/header_tests/source/object.cpp | 2 +- tests/header_tests/source/object_base.cpp | 2 +- tests/header_tests/source/optional.cpp | 2 +- .../source/optional_implementation.cpp | 2 +- tests/header_tests/source/overload.cpp | 2 +- .../source/packaged_coroutine.cpp | 2 +- tests/header_tests/source/pairs_iterator.cpp | 2 +- tests/header_tests/source/pointer_like.cpp | 2 +- tests/header_tests/source/policies.cpp | 2 +- tests/header_tests/source/property.cpp | 2 +- tests/header_tests/source/protect.cpp | 2 +- .../source/protected_function.cpp | 2 +- .../source/protected_function_result.cpp | 2 +- .../header_tests/source/protected_handler.cpp | 2 +- tests/header_tests/source/proxy.cpp | 2 +- tests/header_tests/source/proxy_base.cpp | 2 +- tests/header_tests/source/raii.cpp | 2 +- tests/header_tests/source/reference.cpp | 2 +- tests/header_tests/source/resolve.cpp | 2 +- tests/header_tests/source/sol.cpp | 2 +- tests/header_tests/source/sol_defines.hpp | 2 +- tests/header_tests/source/stack.cpp | 2 +- tests/header_tests/source/stack_check.cpp | 2 +- tests/header_tests/source/stack_check_get.cpp | 2 +- .../source/stack_check_get_qualified.cpp | 2 +- .../source/stack_check_get_unqualified.cpp | 2 +- .../source/stack_check_qualified.cpp | 2 +- .../source/stack_check_unqualified.cpp | 2 +- tests/header_tests/source/stack_core.cpp | 2 +- tests/header_tests/source/stack_field.cpp | 2 +- tests/header_tests/source/stack_get.cpp | 2 +- .../source/stack_get_qualified.cpp | 2 +- .../source/stack_get_unqualified.cpp | 2 +- tests/header_tests/source/stack_guard.cpp | 2 +- tests/header_tests/source/stack_iterator.cpp | 2 +- tests/header_tests/source/stack_pop.cpp | 2 +- tests/header_tests/source/stack_probe.cpp | 2 +- tests/header_tests/source/stack_proxy.cpp | 2 +- .../header_tests/source/stack_proxy_base.cpp | 2 +- tests/header_tests/source/stack_push.cpp | 2 +- tests/header_tests/source/stack_reference.cpp | 2 +- tests/header_tests/source/state_handling.cpp | 2 +- tests/header_tests/source/string_view.cpp | 2 +- tests/header_tests/source/table.cpp | 2 +- tests/header_tests/source/table_core.cpp | 2 +- tests/header_tests/source/table_iterator.cpp | 2 +- tests/header_tests/source/thread.cpp | 2 +- tests/header_tests/source/tie.cpp | 2 +- tests/header_tests/source/traits.cpp | 2 +- tests/header_tests/source/trampoline.cpp | 2 +- tests/header_tests/source/tuple.cpp | 2 +- tests/header_tests/source/types.cpp | 2 +- tests/header_tests/source/unicode.cpp | 2 +- .../source/unique_usertype_traits.cpp | 2 +- tests/header_tests/source/unsafe_function.cpp | 2 +- .../source/unsafe_function_result.cpp | 2 +- tests/header_tests/source/userdata.cpp | 2 +- tests/header_tests/source/usertype.cpp | 2 +- .../source/usertype_container.cpp | 2 +- .../source/usertype_container_launch.cpp | 2 +- tests/header_tests/source/usertype_core.cpp | 2 +- tests/header_tests/source/usertype_proxy.cpp | 2 +- .../header_tests/source/usertype_storage.cpp | 2 +- tests/header_tests/source/usertype_traits.cpp | 2 +- tests/header_tests/source/variadic_args.cpp | 2 +- .../header_tests/source/variadic_results.cpp | 2 +- tests/header_tests/source/version.cpp | 2 +- tests/header_tests/source/wrapper.cpp | 2 +- tests/regression_tests/1011/CMakeLists.txt | 13 +- tests/regression_tests/CMakeLists.txt | 2 +- tests/regression_tests/simple/CMakeLists.txt | 13 +- tests/runtime_tests/CMakeLists.txt | 25 +- tests/runtime_tests/source/basic.cpp | 4 +- tests/runtime_tests/source/common_classes.hpp | 4 +- .../source/container.usertype_check.cpp | 4 +- .../source/container_semantics.cpp | 4 +- .../source/container_semantics.custom.cpp | 4 +- .../source/container_semantics.ordered.cpp | 18 +- .../source/container_semantics.unordered.cpp | 16 +- .../runtime_tests/source/container_shims.cpp | 4 +- .../runtime_tests/source/container_table.cpp | 4 +- tests/runtime_tests/source/containers.cpp | 4 +- .../source/containers.roundtrip.cpp | 24 +- .../runtime_tests/source/containers.table.cpp | 25 +- tests/runtime_tests/source/coroutines.cpp | 4 +- tests/runtime_tests/source/customizations.cpp | 4 +- .../source/customizations_private.cpp | 18 +- tests/runtime_tests/source/dump.cpp | 4 +- tests/runtime_tests/source/environments.cpp | 4 +- tests/runtime_tests/source/functions.cpp | 4 +- tests/runtime_tests/source/functions.std.cpp | 4 +- tests/runtime_tests/source/gc.cpp | 4 +- tests/runtime_tests/source/large_integer.cpp | 4 +- tests/runtime_tests/source/lua_value.cpp | 4 +- tests/runtime_tests/source/main.cpp | 2 +- tests/runtime_tests/source/operators.cpp | 4 +- tests/runtime_tests/source/overflow.cpp | 6 +- tests/runtime_tests/source/plain_types.cpp | 4 +- tests/runtime_tests/source/policies.cpp | 4 +- tests/runtime_tests/source/proxies.cpp | 10 +- tests/runtime_tests/source/sol_test.hpp | 2 +- tests/runtime_tests/source/state.cpp | 4 +- tests/runtime_tests/source/storage.cpp | 6 +- tests/runtime_tests/source/strings.cpp | 4 +- tests/runtime_tests/source/tables.checks.cpp | 10 +- tests/runtime_tests/source/tables.clear.cpp | 4 +- tests/runtime_tests/source/tables.cpp | 9 +- tests/runtime_tests/source/tables.enums.cpp | 21 +- .../runtime_tests/source/tables.indexing.cpp | 5 +- .../runtime_tests/source/tables.insertion.cpp | 4 +- .../runtime_tests/source/tables.traversal.cpp | 4 +- .../source/usertypes.auxiliary_keys.cpp | 4 +- .../runtime_tests/source/usertypes.basic.cpp | 8 +- .../source/usertypes.constructors.cpp | 4 +- tests/runtime_tests/source/usertypes.cpp | 4 +- .../source/usertypes.inheritance.cpp | 51 +- .../source/usertypes.inheritance.multi.cpp | 4 +- .../source/usertypes.member_variables.cpp | 4 +- .../source/usertypes.overload.cpp | 4 +- .../source/usertypes.properties.cpp | 4 +- .../source/usertypes.runtime.cpp | 4 +- .../runtime_tests/source/usertypes.unique.cpp | 4 +- .../source/usertypes.unregister.cpp | 4 +- tests/runtime_tests/source/utility.cpp | 6 +- tests/runtime_tests/source/variadics.cpp | 4 +- 558 files changed, 4991 insertions(+), 1978 deletions(-) delete mode 100644 cmake/Modules/FindCatch.cmake create mode 100644 cmake/Modules/FindSphinx.cmake delete mode 100644 docs/CMakeLists.txt create mode 100644 documentation/.clang-format create mode 100644 documentation/CMakeLists.txt create mode 100644 documentation/Doxyfile.in rename {docs => documentation}/Makefile (100%) rename {docs => documentation}/make.bat (100%) rename {docs => documentation}/presentations/2016.10.14 - ThePhD - No Overhead C Abstraction.pdf (100%) rename {docs => documentation}/presentations/2017.11.08 - ThePhD - Wrapping Lua C in C++.pdf (100%) rename {docs => documentation}/presentations/2018.02.06 - ThePhD - Biting the CMake Bullet.pdf (100%) rename {docs => documentation}/presentations/2018.05.10 - ThePhD - Compile Fast, Run Faster, Scale Forever.pdf (100%) rename {docs => documentation}/presentations/2018.09.28 - ThePhD - Scripting at the Speed of Thought.pdf (100%) rename {docs => documentation}/presentations/2019.05.10 - ThePhD - The Plan for Tomorrow - Compile-Time Extension Points in C++.pdf (100%) create mode 100644 documentation/requirements.txt rename {docs => documentation}/source/_themes/sol2/layout.html (100%) rename {docs => documentation}/source/_themes/sol2/static/search-fix.js_t (100%) rename {docs => documentation}/source/_themes/sol2/static/sol2.css_t (100%) rename {docs => documentation}/source/_themes/sol2/theme.conf (100%) rename {docs => documentation}/source/api/api-top.rst (100%) rename {docs => documentation}/source/api/as_args.rst (100%) rename {docs => documentation}/source/api/as_container.rst (100%) rename {docs => documentation}/source/api/as_function.rst (100%) rename {docs => documentation}/source/api/as_returns.rst (100%) rename {docs => documentation}/source/api/as_table.rst (100%) rename {docs => documentation}/source/api/c_call.rst (100%) rename {docs => documentation}/source/api/compatibility.rst (100%) rename {docs => documentation}/source/api/coroutine.rst (100%) rename {docs => documentation}/source/api/environment.rst (100%) rename {docs => documentation}/source/api/error.rst (100%) rename {docs => documentation}/source/api/function.rst (100%) rename {docs => documentation}/source/api/lua_value.rst (100%) rename {docs => documentation}/source/api/make_reference.rst (100%) rename {docs => documentation}/source/api/metatable_key.rst (100%) rename {docs => documentation}/source/api/nested.rst (100%) rename {docs => documentation}/source/api/new_table.rst (100%) rename {docs => documentation}/source/api/object.rst (100%) rename {docs => documentation}/source/api/optional.rst (100%) rename {docs => documentation}/source/api/overload.rst (100%) rename {docs => documentation}/source/api/policies.rst (100%) rename {docs => documentation}/source/api/property.rst (100%) rename {docs => documentation}/source/api/protect.rst (100%) rename {docs => documentation}/source/api/protected_function.rst (98%) rename {docs => documentation}/source/api/proxy.rst (100%) rename {docs => documentation}/source/api/readonly.rst (100%) rename {docs => documentation}/source/api/reference.rst (100%) rename {docs => documentation}/source/api/resolve.rst (100%) rename {docs => documentation}/source/api/stack.rst (100%) rename {docs => documentation}/source/api/stack_reference.rst (82%) rename {docs => documentation}/source/api/state.rst (100%) rename {docs => documentation}/source/api/table.rst (100%) rename {docs => documentation}/source/api/table_traversal_keys.rst (100%) rename {docs => documentation}/source/api/this_environment.rst (100%) rename {docs => documentation}/source/api/this_state.rst (100%) rename {docs => documentation}/source/api/thread.rst (100%) rename {docs => documentation}/source/api/tie.rst (100%) rename {docs => documentation}/source/api/types.rst (100%) rename {docs => documentation}/source/api/unique_usertype_traits.rst (100%) rename {docs => documentation}/source/api/user.rst (100%) rename {docs => documentation}/source/api/userdata.rst (100%) rename {docs => documentation}/source/api/usertype.rst (100%) rename {docs => documentation}/source/api/usertype_memory.rst (100%) rename {docs => documentation}/source/api/var.rst (100%) rename {docs => documentation}/source/api/variadic_args.rst (100%) rename {docs => documentation}/source/api/variadic_results.rst (100%) rename {docs => documentation}/source/api/yielding.rst (100%) rename {docs => documentation}/source/benchmarks.rst (100%) rename {docs => documentation}/source/build.rst (100%) rename {docs => documentation}/source/codecvt.rst (100%) rename {docs => documentation}/source/compilation.rst (100%) rename {docs => documentation}/source/conf.py (81%) rename {docs => documentation}/source/containers.rst (100%) rename {docs => documentation}/source/errors.rst (100%) rename {docs => documentation}/source/exceptions.rst (100%) rename {docs => documentation}/source/features.rst (99%) rename {docs => documentation}/source/functions.rst (100%) rename {docs => documentation}/source/index.rst (100%) rename {docs => documentation}/source/licenses.rst (100%) rename {docs => documentation}/source/media/Ko-fi_Blue.png (100%) rename {docs => documentation}/source/media/become_a_patron_button.png (100%) rename {docs => documentation}/source/media/bench/base_derived.png (100%) rename {docs => documentation}/source/media/bench/c_function.png (100%) rename {docs => documentation}/source/media/bench/c_function_through_lua_in_c.png (100%) rename {docs => documentation}/source/media/bench/implicit_inheritance.png (100%) rename {docs => documentation}/source/media/bench/lua_bindings_shootout.json (100%) rename {docs => documentation}/source/media/bench/lua_function_in_c.png (100%) rename {docs => documentation}/source/media/bench/member_function_call.png (100%) rename {docs => documentation}/source/media/bench/multi_return.png (100%) rename {docs => documentation}/source/media/bench/multi_return_lua.png (100%) rename {docs => documentation}/source/media/bench/optional_failure.png (100%) rename {docs => documentation}/source/media/bench/optional_half_failure.png (100%) rename {docs => documentation}/source/media/bench/optional_success.png (100%) rename {docs => documentation}/source/media/bench/return_userdata.png (100%) rename {docs => documentation}/source/media/bench/stateful_function_object.png (100%) rename {docs => documentation}/source/media/bench/table_chained_get.png (100%) rename {docs => documentation}/source/media/bench/table_chained_set.png (100%) rename {docs => documentation}/source/media/bench/table_get.png (100%) rename {docs => documentation}/source/media/bench/table_global_string_get.png (100%) rename {docs => documentation}/source/media/bench/table_global_string_set.png (100%) rename {docs => documentation}/source/media/bench/table_set.png (100%) rename {docs => documentation}/source/media/bench/userdata_variable_access.png (100%) rename {docs => documentation}/source/media/bench/userdata_variable_access_large.png (100%) rename {docs => documentation}/source/media/bench/userdata_variable_access_last.png (100%) rename {docs => documentation}/source/media/discord_logo_wordmark.png (100%) rename {docs => documentation}/source/media/eevee_code_after.jpg (100%) rename {docs => documentation}/source/media/eevee_code_before.jpg (100%) rename {docs => documentation}/source/media/github_logo.png (100%) rename {docs => documentation}/source/media/github_sponsors_logo.png (100%) rename {docs => documentation}/source/media/liberapay_logo.png (100%) rename {docs => documentation}/source/media/pp_cc_mark_111x69.jpg (100%) rename {docs => documentation}/source/media/sol.png (100%) rename {docs => documentation}/source/media/sol.psd (100%) rename {docs => documentation}/source/mentions.rst (100%) rename {docs => documentation}/source/origin.rst (100%) rename {docs => documentation}/source/performance.rst (100%) rename {docs => documentation}/source/rtti.rst (100%) rename {docs => documentation}/source/safety.rst (100%) rename {docs => documentation}/source/threading.rst (100%) rename {docs => documentation}/source/traits.rst (100%) rename {docs => documentation}/source/tutorial/all-the-things.rst (99%) rename {docs => documentation}/source/tutorial/customization.rst (100%) rename {docs => documentation}/source/tutorial/cxx-in-lua.rst (100%) rename {docs => documentation}/source/tutorial/existing.rst (100%) rename {docs => documentation}/source/tutorial/functions.rst (62%) rename {docs => documentation}/source/tutorial/getting-started.rst (100%) rename {docs => documentation}/source/tutorial/ownership.rst (100%) rename {docs => documentation}/source/tutorial/tutorial-top.rst (100%) rename {docs => documentation}/source/tutorial/variables.rst (100%) rename {docs => documentation}/source/usertypes.rst (100%) delete mode 100644 examples/include/assert.hpp create mode 100644 examples/source/tutorials/multiple_return.cpp create mode 100644 examples/source/tutorials/reading_functions.cpp create mode 100644 examples/source/tutorials/writing_functions.cpp create mode 100644 examples/source/tutorials/writing_member_functions.cpp create mode 100644 examples/source/tutorials/writing_overloaded_template_functions.cpp create mode 100644 examples/source/tutorials/writing_template_functions.cpp create mode 100644 include/sol/assert.hpp diff --git a/.clang-format b/.clang-format index 3b5097fc..00287c34 100644 --- a/.clang-format +++ b/.clang-format @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/.dockerignore b/.dockerignore index 575447fa..66da40ea 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/.gitignore b/.gitignore index f48ba75e..62319697 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/.travis.yml b/.travis.yml index 1e72a32e..0859e587 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/CMakeLists.txt b/CMakeLists.txt index 21f3fb6c..07a5dc7b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in @@ -22,10 +22,10 @@ # # # # sol3 # # # Required minimum version statement -cmake_minimum_required(VERSION 3.5.0) +cmake_minimum_required(VERSION 3.15.0) # # # project declaration -project(sol2 VERSION 3.2.3 LANGUAGES CXX C) +project(sol2 VERSION 3.2.5 LANGUAGES CXX C) include(GNUInstallDirs) @@ -36,13 +36,15 @@ include(GNUInstallDirs) set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules" "${CMAKE_MODULE_PATH}") # Include standard modules -include(CMakeDependentOption) include(CMakePackageConfigHelpers) - +include(CheckCXXCompilerFlag) +include(CMakeDependentOption) +include(GNUInstallDirs) +include(FetchContent) # # # Configuration # # Cached defines, strings, paths and options -set(SOL2_LUA_VERSION "5.3.5" CACHE STRING "The version of Lua needed. Can be 5.1, 5.2, 5.3, 5.4, LuaJIT, or a more specific 3-part version number for a specifc Lua (e.g., 5.3.4 or luajit-2.0.5)") +set(SOL2_LUA_VERSION "5.3.5" CACHE STRING "The version of Lua needed. Can be 5.1, 5.2, 5.3, 5.4, LuaJIT, or a more specific 3-part version number for a specifc Lua (e.g., 5.3.5 or luajit-2.0.5)") set(SOL2_BUILD_LUA TRUE CACHE BOOL "Always build Lua, do not search for it in the system") set(SOL2_PLATFORM "x64" CACHE STRING "Target platform to compile for when building binaries (x86, x64)") option(SOL2_CI "Whether or not we are in continguous integration mode" OFF) @@ -161,7 +163,7 @@ endif() # Generates the docs if (SOL2_DOCS) message(STATUS "sol2 adding docs...") - add_subdirectory(docs) + add_subdirectory(documentation) endif() if(SOL2_ENABLE_INSTALL) @@ -277,13 +279,9 @@ if (SOL2_IS_TOP_LEVEL AND (SOL2_DO_TESTS OR SOL2_DO_EXAMPLES)) set_target_properties(${lualib} PROPERTIES INTERFACE_INCLUDE_DIRECTORIES ${LUA_INCLUDE_DIR} - INTERFACE_LINK_LIBRARIES ${LUA_SEARCH_DEPENDENCY_LIBS} + INTERFACE_LINK_LIBRARIES ${LUA_SEARCH_DEPENDENCY_LIBS} ${CMAKE_DL_LIBS} IMPORTED_LINK_INTERFACE_LANGUAGES C IMPORTED_LOCATION ${lualiblocation}) - if (CMAKE_DL_LIBS) - set_property(TARGET ${lualib} - APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${CMAKE_DL_LIBS}) - endif() set(LUA_LIBRARIES ${lualib}) endif() diff --git a/LICENSE.txt b/LICENSE.txt index 6cfdd03b..633ce75b 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/appveyor.yml b/appveyor.yml index 9087cb2b..b852b6b0 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/Common/Core.cmake b/cmake/Modules/Common/Core.cmake index ab7d5119..7bead144 100644 --- a/cmake/Modules/Common/Core.cmake +++ b/cmake/Modules/Common/Core.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindCatch.cmake b/cmake/Modules/FindCatch.cmake deleted file mode 100644 index 4d227439..00000000 --- a/cmake/Modules/FindCatch.cmake +++ /dev/null @@ -1,84 +0,0 @@ -# # # # sol3 -# The MIT License (MIT) -# -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors -# -# Permission is hereby granted, free of charge, to any person obtaining a copy of -# this software and associated documentation files (the "Software"), to deal in -# the Software without restriction, including without limitation the rights to -# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -# the Software, and to permit persons to whom the Software is furnished to do so, -# subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -include(ExternalProject) -include(FindPackageHandleStandardArgs) -include(Common/Core) - -# # Base variables -if (Catch_FIND_VERSION) - set(catch_version ${Catch_FIND_VERSION}) -else() - set(catch_version 2.11.1) -endif() - -set(catch_lib catch_lib_${catch_version}) - -# # Useful locations -set(catch_build_toplevel "${CMAKE_BINARY_DIR}/vendor/catch_${catch_version}") -set(catch_include_dirs "${catch_build_toplevel}") - -# # catch library sources -set(catch_sources catch.hpp) -prepend(catch_sources "${catch_build_toplevel}/" ${catch_sources}) - -# # !! CMake 3.5 does not have DOWNLOAD_NO_EXTRACT e.e -# # Now I know why people don't like CMake that much: the earlier versions were kind of garbage -# # External project to get sources -#ExternalProject_Add(CATCH_BUILD_SOURCE -# BUILD_IN_SOURCE TRUE -# BUILD_ALWAYS FALSE -# DOWNLOAD_NO_EXTRACT TRUE -# URL https://github.com/catchorg/Catch2/releases/download/v${catch_version}/catch.hpp -# TLS_VERIFY TRUE -# PREFIX ${catch_build_toplevel} -# SOURCE_DIR ${catch_build_toplevel} -# DOWNLOAD_DIR ${catch_build_toplevel} -# TMP_DIR "${catch_build_toplevel}-tmp" -# STAMP_DIR "${catch_build_toplevel}-stamp" -# INSTALL_DIR "${catch_build_toplevel}/local" -# CONFIGURE_COMMAND "" -# BUILD_COMMAND "" -# INSTALL_COMMAND "" -# TEST_COMMAND "" -# BUILD_BYPRODUCTS "${catch_sources}") - -file(MAKE_DIRECTORY "${catch_build_toplevel}") -file(DOWNLOAD https://github.com/catchorg/Catch2/releases/download/v${catch_version}/catch.hpp ${catch_sources}) - -add_library(${catch_lib} INTERFACE) -# add_dependencies(${catch_lib} CATCH_BUILD_SOURCE) -target_include_directories(${catch_lib} INTERFACE ${catch_include_dirs}) - -if (MSVC) - target_compile_definitions(${catch_lib} INTERFACE - _SILENCE_CXX17_UNCAUGHT_EXCEPTION_DEPRECATION_WARNING) -endif() - -set(CATCH_FOUND TRUE) -set(CATCH_LIBRARIES ${catch_lib}) -set(CATCH_INCLUDE_DIRS ${catch_include_dirs}) - -FIND_PACKAGE_HANDLE_STANDARD_ARGS(Catch - FOUND_VAR CATCH_FOUND - REQUIRED_VARS CATCH_LIBRARIES CATCH_INCLUDE_DIRS - VERSION_VAR catch_version) diff --git a/cmake/Modules/FindKaguyaBuild.cmake b/cmake/Modules/FindKaguyaBuild.cmake index 6d2e0410..bcf10cae 100644 --- a/cmake/Modules/FindKaguyaBuild.cmake +++ b/cmake/Modules/FindKaguyaBuild.cmake @@ -2,7 +2,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindLua/set_version_vars.cmake b/cmake/Modules/FindLua/set_version_vars.cmake index d42194f7..0907212f 100644 --- a/cmake/Modules/FindLua/set_version_vars.cmake +++ b/cmake/Modules/FindLua/set_version_vars.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindLuaBridgeBuild.cmake b/cmake/Modules/FindLuaBridgeBuild.cmake index ae7e7acd..10d155e5 100644 --- a/cmake/Modules/FindLuaBridgeBuild.cmake +++ b/cmake/Modules/FindLuaBridgeBuild.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindLuaBuild.cmake b/cmake/Modules/FindLuaBuild.cmake index 0e2d6579..353a4c7b 100644 --- a/cmake/Modules/FindLuaBuild.cmake +++ b/cmake/Modules/FindLuaBuild.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindLuaBuild/LuaJIT.cmake b/cmake/Modules/FindLuaBuild/LuaJIT.cmake index 24812740..80598b80 100644 --- a/cmake/Modules/FindLuaBuild/LuaJIT.cmake +++ b/cmake/Modules/FindLuaBuild/LuaJIT.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in @@ -415,6 +415,8 @@ add_library(${lualib} INTERFACE) add_dependencies(${lualib} LUA_JIT-move) target_include_directories(${lualib} INTERFACE "${LUA_JIT_SOURCE_DIR}") +target_link_libraries(${lualib} + INTERFACE ${CMAKE_DL_LIBS}) if (BUILD_LUA_AS_DLL) if (MSVC) target_link_libraries(${lualib} @@ -428,10 +430,6 @@ else() INTERFACE "${LUA_JIT_DESTINATION_LUA_LIB}") endif() -if (CMAKE_DL_LIBS) - target_link_libraries(${lualib} - INTERFACE ${CMAKE_DL_LIBS}) -endif() if (XCODE) target_compile_options(${lualib} INTERFACE -pagezero_size 10000 -image_base 100000000) diff --git a/cmake/Modules/FindLuaBuild/LuaVanilla.cmake b/cmake/Modules/FindLuaBuild/LuaVanilla.cmake index 131c12ed..8ba8be52 100644 --- a/cmake/Modules/FindLuaBuild/LuaVanilla.cmake +++ b/cmake/Modules/FindLuaBuild/LuaVanilla.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in @@ -360,9 +360,7 @@ endif() target_compile_options(${liblua} PRIVATE ${LUA_VANILLA_LUALIB_COMPILER_OPTIONS}) add_dependencies(${liblua} LUA_VANILLA) -if (CMAKE_DL_LIBS) - target_link_libraries(${liblua} PRIVATE ${CMAKE_DL_LIBS}) -endif() +target_link_libraries(${liblua} PRIVATE ${CMAKE_DL_LIBS}) if (UNIX) target_link_libraries(${liblua} PRIVATE m) endif() @@ -399,10 +397,7 @@ if (LUA_BUILD_LUA_INTERPRETER) target_compile_definitions(${luainterpreter} PRIVATE LUA_USE_LINUX) endif() - target_link_libraries(${luainterpreter} PRIVATE ${liblua}) - if (CMAKE_DL_LIBS) - target_link_libraries(${luainterpreter} PRIVATE ${CMAKE_DL_LIBS}) - endif() + target_link_libraries(${luainterpreter} PRIVATE ${liblua} ${CMAKE_DL_LIBS}) if (UNIX) target_link_libraries(${luainterpreter} PRIVATE m readline) endif() @@ -437,10 +432,7 @@ if (LUA_BUILD_LUA_COMPILER) target_compile_definitions(${luacompiler} PRIVATE LUA_USE_LINUX) endif() - target_link_libraries(${luacompiler} PRIVATE ${liblua}) - if (CMAKE_DL_LIBS) - target_link_libraries(${luacompiler} PRIVATE ${CMAKE_DL_LIBS}) - endif() + target_link_libraries(${luacompiler} PRIVATE ${liblua} ${CMAKE_DL_LIBS}) if (UNIX) # TODO: make readline optional? target_link_libraries(${luacompiler} PRIVATE m readline) diff --git a/cmake/Modules/FindLuwraBuild.cmake b/cmake/Modules/FindLuwraBuild.cmake index c0bd2773..6bb64149 100644 --- a/cmake/Modules/FindLuwraBuild.cmake +++ b/cmake/Modules/FindLuwraBuild.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/cmake/Modules/FindSphinx.cmake b/cmake/Modules/FindSphinx.cmake new file mode 100644 index 00000000..6d3ae928 --- /dev/null +++ b/cmake/Modules/FindSphinx.cmake @@ -0,0 +1,68 @@ +# # # # sol3 +# The MIT License (MIT) +# +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors +# +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +include(FindPackageHandleStandardArgs) +include(FeatureSummary) + +find_program(Sphinx_Build_EXECUTABLE NAMES sphinx-build DOC "Path to sphinx-build executable") + +if (Sphinx_Build_EXECUTABLE) + set(Sphinx_Build_FOUND YES) +endif() + +if (Sphinx_Build_FOUND) + execute_process( + COMMAND ${Sphinx_Build_EXECUTABLE} --version + OUTPUT_VARIABLE Sphinx_Build_VERSION_OUTPUT + OUTPUT_STRIP_TRAILING_WHITESPACE + ENCODING UTF-8) + if (Sphinx_Build_VERSION_OUTPUT) + string(REGEX + MATCH "[^0-9]*([0-9]+)[.]([0-9]+)?[.]?([0-9]+)?[.]?([0-9]+)?.*" + Sphinx_Build_VERSION_CHECK ${Sphinx_Build_VERSION_OUTPUT}) + endif() + if (Sphinx_Build_VERSION_CHECK) + string(JOIN "." Sphinx_Build_VERSION + ${CMAKE_MATCH_1} + ${CMAKE_MATCH_2} + ${CMAKE_MATCH_3} + ${CMAKE_MATCH_4}) + set(Sphinx_Build_VERSION "${Sphinx_Build_VERSION}" CACHE STRING "sphinx-build version" FORCE) + endif() +endif() + +find_package_handle_standard_args(Sphinx + REQUIRED_VARS Sphinx_Build_EXECUTABLE + VERSION_VAR Sphinx_Build_VERSION + HANDLE_COMPONENTS) + +set_package_properties(Sphinx + PROPERTIES + DESCRIPTION "Sphinx Documentation Generator" + URL "https://sphinx-doc.org") + +if (Sphinx_Build_FOUND AND NOT TARGET Sphinx::Build) + add_executable(Sphinx::Build IMPORTED) + set_property(TARGET Sphinx::Build PROPERTY IMPORTED_LOCATION ${Sphinx_Build_EXECUTABLE}) + set_property(TARGET Sphinx::Build PROPERTY VERSION ${Sphinx_Build_VERSION}) + mark_as_advanced(Sphinx_Build_EXECUTABLE Sphinx_Build_VERSION) +endif() \ No newline at end of file diff --git a/cmake/Modules/FindToLuappBuild.cmake b/cmake/Modules/FindToLuappBuild.cmake index d1ba7d83..fc6a8b7f 100644 --- a/cmake/Modules/FindToLuappBuild.cmake +++ b/cmake/Modules/FindToLuappBuild.cmake @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in @@ -65,7 +65,7 @@ set_target_properties(${toluapp_lib} PROPERTIES POSITION_INDEPENDENT_CODE TRUE) target_include_directories(${toluapp_lib} PUBLIC ${toluapp_include_dirs}) -target_link_libraries(${toluapp_lib} PRIVATE ${LUA_LIBRARIES}) +target_link_libraries(${toluapp_lib} PRIVATE ${LUA_LIBRARIES} ${CMAKE_DL_LIBS}) if (MSVC) target_compile_options(${toluapp_lib} PRIVATE /W1) @@ -77,9 +77,6 @@ else() INTERFACE -Wno-noexcept-type PUBLIC -Wno-ignored-qualifiers -Wno-unused-parameter) endif() -if (CMAKE_DL_LIBS) - target_link_libraries(${toluapp_lib} PRIVATE ${CMAKE_DL_LIBS}) -endif() # add compatibility define target_compile_definitions(${toluapp_lib} PRIVATE COMPAT53_PREFIX=toluapp_compat53) diff --git a/cmake/sol2-config.cmake.in b/cmake/sol2-config.cmake.in index ab5a5fc1..e36f3c5b 100644 --- a/cmake/sol2-config.cmake.in +++ b/cmake/sol2-config.cmake.in @@ -1,7 +1,7 @@ # # # # sol3 # The MIT License (MIT) # -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors # # Permission is hereby granted, free of charge, to any person obtaining a copy of # this software and associated documentation files (the "Software"), to deal in diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt deleted file mode 100644 index 2ebb85cf..00000000 --- a/docs/CMakeLists.txt +++ /dev/null @@ -1,46 +0,0 @@ -# # # # sol3 -# The MIT License (MIT) -# -# Copyright (c) 2013-2020 Rapptz, ThePhD, and contributors -# -# Permission is hereby granted, free of charge, to any person obtaining a copy of -# this software and associated documentation files (the "Software"), to deal in -# the Software without restriction, including without limitation the rights to -# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -# the Software, and to permit persons to whom the Software is furnished to do so, -# subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -# # # # sol3, documentation generation -# # # Required minimum version statement -cmake_minimum_required(VERSION 3.5.0) - -find_package(Python3 COMPONENTS Interpreter) - -if (NOT Python3_FOUND AND NOT Python3_Interpreter_FOUND) - message(FATAL_ERROR "sol2 documentation cannot be generated as python 3 has not been found: install or set the python 3 interpreter for the docs to find it and be sure to pip install sphinx") -endif() - -find_program(sol2_make_executable make make.exe mingw32-make mingw32-make.exe) -if(NOT sol2_make_executable) - message(FATAL_ERROR "could not find a suitable make executable to build Sphinx documentation") -endif() - -add_custom_command(OUTPUT docs_invisible_file_always_generate - USES_TERMINAL - COMMAND "${sol2_make_executable}" -C "${CMAKE_CURRENT_SOURCE_DIR}" html "BUILDDIR=${CMAKE_CURRENT_BINARY_DIR}") -add_custom_target(docs - DEPENDS docs_invisible_file_always_generate) - -if(SOL2_ENABLE_INSTALL) - install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/docs/html" DESTINATION "${CMAKE_INSTALL_DOCDIR}") -endif() diff --git a/documentation/.clang-format b/documentation/.clang-format new file mode 100644 index 00000000..991a73da --- /dev/null +++ b/documentation/.clang-format @@ -0,0 +1,110 @@ +# # # # sol3 +# The MIT License (MIT) +# +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors +# +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +--- +BasedOnStyle: WebKit +IndentWidth: 5 +TabWidth: 5 +ContinuationIndentWidth: 5 +UseTab: ForIndentation + +# Namespaces +NamespaceIndentation: All +CompactNamespaces: true +FixNamespaceComments: true + +# Overall Alignment +ColumnLimit: 75 +AlignAfterOpenBracket: DontAlign # uses ContinuationIndentWidth for this instead +AccessModifierOffset: -5 # do not push public: or private: around +#AlignConsecutiveAssignments: true # affects more than what's expected: do not use +#AlignConsecutiveDeclarations: true # affects more than what's expected: do not use + +# Type Alignment +DerivePointerAlignment: false +PointerAlignment: Left +AlwaysBreakTemplateDeclarations: true +AlwaysBreakBeforeMultilineStrings: true + +# Comments +AlignTrailingComments: true +ReflowComments: true + +# Macros +AlignEscapedNewlines: Left +#IndentPPDirectives: None + +# Functions +AllowShortFunctionsOnASingleLine: None +AlwaysBreakAfterReturnType: None +BreakConstructorInitializers: BeforeComma +ConstructorInitializerIndentWidth: 0 +ConstructorInitializerAllOnOneLineOrOnePerLine: true +BinPackArguments: false +BinPackParameters: true + +# Classes +BreakBeforeInheritanceComma: false + +# Braces +Cpp11BracedListStyle: false +BreakBeforeBraces: Custom +BraceWrapping: + AfterEnum: false + AfterStruct: false + AfterControlStatement: false + AfterClass: false + AfterNamespace: false + AfterStruct: false + AfterUnion: false + BeforeElse: true + BeforeCatch: true + IndentBraces: false + SplitEmptyFunction: false + SplitEmptyRecord: false + SplitEmptyNamespace: true + +# Control Statements +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +IndentCaseLabels: false + +# Spaces +SpaceAfterCStyleCast: false +SpacesInCStyleCastParentheses: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesInAngles: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +MaxEmptyLinesToKeep: 3 + +# OCD +SortUsingDeclarations: true +SortIncludes: false + +--- +Language: Cpp +Standard: Cpp11 diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt new file mode 100644 index 00000000..91230e37 --- /dev/null +++ b/documentation/CMakeLists.txt @@ -0,0 +1,104 @@ +# # # # sol3 +# The MIT License (MIT) +# +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors +# +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +# # # # sol3, documentation generation +# # # Required minimum version statement +cmake_minimum_required(VERSION 3.15.0) + +find_package(Doxygen REQUIRED) +find_package(Python3 REQUIRED) +find_package(Sphinx REQUIRED) + +# Find all the public headers +file(GLOB_RECURSE sol2_public_headers + LIST_DIRECTORIES NO + CONFIGURE_DEPENDS ${PROJECT_SOURCE_DIR}/include/**.*) +# make a list copy for use with dependency tracking later down below +set(sol2_doxygen_public_headers ${sol2_public_headers}) +# Remove every single public header +list(FILTER sol2_doxygen_public_headers EXCLUDE REGEX /detail/.*) +# separate text with spaces and surround them with quotes for Doxygen to understand them all +list(TRANSFORM sol2_doxygen_public_headers REPLACE "(.+)" [["\1"]]) +list(JOIN sol2_doxygen_public_headers " " sol2_doxygen_public_headers) + +set(SOL2_DOXYGEN_PROJECT_DESCRIPTION ${PROJECT_DESCRIPTION}) +set(SOL2_DOXYGEN_PROJECT_VERSION ${PROJECT_VERSION}) +set(SOL2_DOXYGEN_PROJECT_NAME ${PROJECT_NAME}) +set(SOL2_DOXYGEN_INPUT ${sol2_doxygen_public_headers}) +set(SOL2_DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) +set(SOL2_DOXYGEN_XML_OUTPUT_DIR ${SOL2_DOXYGEN_OUTPUT_DIR}/xml) +set(SOL2_DOXYGEN_HTML_OUTPUT_DIR ${SOL2_DOXYGEN_OUTPUT_DIR}/html) +set(SOL2_DOXYGEN_INDEX_FILE ${SOL2_DOXYGEN_XML_OUTPUT_DIR}/index.xml) +set(SOL2_DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) +set(SOL2_DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) +set(SOL2_SPHINX_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source) +set(SOL2_SPHINX_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx) + +# Get all Sphinx source files +file(GLOB_RECURSE sol2_sphinx_sources + LIST_DIRECTORIES NO + CONFIGURE_DEPENDS ${SOL2_SPHINX_SOURCE_DIR}/**.*) + +#Replace variables inside @@ with the current values +configure_file(${SOL2_DOXYFILE_IN} ${SOL2_DOXYFILE_OUT} @ONLY) + +# Ensure Doxygen/Sphinx won't crash because it doesn't create directories for us +file(MAKE_DIRECTORY ${SOL2_DOXYGEN_OUTPUT_DIR}) +file(MAKE_DIRECTORY ${SOL2_DOXYGEN_XML_OUTPUT_DIR}) +file(MAKE_DIRECTORY ${SOL2_DOXYGEN_HTML_OUTPUT_DIR}) +file(MAKE_DIRECTORY ${SOL2_SPHINX_BUILD_DIR}) + +set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_CLEAN_FILES + ${SOL2_DOXYGEN_XML_OUTPUT_DIR} + ${SOL2_DOXYGEN_HTML_OUTPUT_DIR} + ${SOL2_DOXYGEN_OUTPUT_DIR} + ${SOL2_SPHINX_BUILD_DIR}) + +add_custom_command(OUTPUT ${SOL2_DOXYGEN_INDEX_FILE} + COMMAND ${DOXYGEN_EXECUTABLE} ${SOL2_DOXYFILE_OUT} + MAIN_DEPENDENCY ${SOL2_DOXYFILE_IN} ${SOL2_DOXYFILE_OUT} + DEPENDS ${sol2_public_headers} + COMMENT "[sol2/documentation] Generating Doxygen XML..." +) +add_custom_target(sol2.documentation.doxygen ALL DEPENDS ${SOL2_DOXYGEN_INDEX_FILE}) + +if (NOT SOL2_DOCUMENTATION_NO_SPHINX) + add_custom_target(sol2.documentation.sphinx ALL + COMMAND Sphinx::Build + -b html + -Dbreathe_projects.sol2=${SOL2_DOXYGEN_XML_OUTPUT_DIR} + ${SOL2_SPHINX_SOURCE_DIR} + ${SOL2_SPHINX_BUILD_DIR} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + DEPENDS ${SOL2_DOXYGEN_INDEX_FILE} ${sol2_sphinx_sources} + COMMENT "[sol2/documentation] Generating Sphinx documentation..." + COMMAND_EXPAND_LISTS + VERBATIM) + + add_dependencies(sol2.documentation.sphinx sol2.documentation.doxygen) +endif() + +# For the install target +include(GNUInstallDirs) +install(DIRECTORY ${SOL2_SPHINX_BUILD_DIR} + DESTINATION ${CMAKE_INSTALL_DOCDIR} +) \ No newline at end of file diff --git a/documentation/Doxyfile.in b/documentation/Doxyfile.in new file mode 100644 index 00000000..30a5d03f --- /dev/null +++ b/documentation/Doxyfile.in @@ -0,0 +1,2678 @@ +# # # # sol3 +# The MIT License (MIT) +# +# Copyright (c) 2013-2021 Rapptz, ThePhD, and contributors +# +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +# Doxyfile 1.9.1 + +# 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 = "@SOL2_DOXYGEN_PROJECT_NAME@" + +# 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 = "@SOL2_DOXYGEN_PROJECT_VERSION@" + +# 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 = "@SOL2_PROJECT_DESCRIPTION@" + +# 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. + +PROJECT_LOGO = + +# 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 = "@SOL2_DOXYGEN_OUTPUT_DIR@" + +# 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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# 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 = YES + +# 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 = NO + +# 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 = YES + +# 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 = NO + +# 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 + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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 = 5 + +# 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 = "group=@ingroup" "synopsis=@par Synopsis:@n" "effects=@par Effects:@n" "exclude=@if SOL2_EXCLUDED_ELEMENT @endif" "requires=@par Requires:@n" + +# 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, VHDL, +# 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +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 = NO + +# 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 = NO + +# 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 = NO + +# 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 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = YES + +# 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 this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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 +# 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 + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# 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 = YES + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# 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 = + +#--------------------------------------------------------------------------- +# 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 = @SOL2_DOXYGEN_INPUT@ + +# 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. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# 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 (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.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 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# 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 = NO + +# 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 = "*/detail/*" "*/vendor/*" + +# 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 = "sol::*detail*" "_M_*" "std" + +# 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. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 = YES + +# 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 + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# 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 + +# 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 = "@SOL2_DOXYGEN_THML_OUTPUT_DIR@" + +# 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 main .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 (absolute path +# including file name) 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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# 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 = NO + +# 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/v2.7-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://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# 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 = + +# 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/v2.7-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 +# , /