pax_global_header00006660000000000000000000000064137066244140014521gustar00rootroot0000000000000052 comment=f7d4fc7ac679e18ba385f64434f8015c3cea9cb5 actor-framework-0.17.6/000077500000000000000000000000001370662441400147175ustar00rootroot00000000000000actor-framework-0.17.6/.clang-format000066400000000000000000000035441370662441400173000ustar00rootroot00000000000000--- AccessModifierOffset: -2 AlignAfterOpenBracket: Align AlignEscapedNewlines: Right AlignOperands: true AllowAllParametersOfDeclarationOnNextLine: false AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: None AllowShortIfStatementsOnASingleLine: false AllowShortLoopsOnASingleLine: false AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: Yes BinPackArguments: true BinPackParameters: true BreakBeforeBinaryOperators: All BreakBeforeBraces: Attach BreakBeforeTernaryOperators: true BreakConstructorInitializers: BeforeColon BreakInheritanceList: BeforeColon CompactNamespaces: false ConstructorInitializerAllOnOneLineOrOnePerLine: true ConstructorInitializerIndentWidth: 2 ContinuationIndentWidth: 2 Cpp11BracedListStyle: true FixNamespaceComments: true IncludeBlocks: Preserve IndentCaseLabels: true IndentPPDirectives: AfterHash IndentWidth: 2 IndentWrappedFunctionNames: false KeepEmptyLinesAtTheStartOfBlocks: false Language: Cpp MacroBlockBegin: "^BEGIN_STATE$|CAF_BEGIN_TYPE_ID_BLOCK" MacroBlockEnd: "^END_STATE$|CAF_END_TYPE_ID_BLOCK" MaxEmptyLinesToKeep: 1 NamespaceIndentation: None PenaltyBreakAssignment: 25 PenaltyBreakBeforeFirstCallParameter: 30 PenaltyReturnTypeOnItsOwnLine: 25 PointerAlignment: Left ReflowComments: true SortIncludes: true SortUsingDeclarations: true SpaceAfterCStyleCast: true SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeCpp11BracedList: false SpaceBeforeCtorInitializerColon: true SpaceBeforeInheritanceColon: true SpaceBeforeParens: ControlStatements SpaceBeforeRangeBasedForLoopColon: true SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 1 SpacesInAngles: false SpacesInContainerLiterals: false SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Cpp11 UseTab: Never ... actor-framework-0.17.6/.clang-tidy000066400000000000000000000024171370662441400167570ustar00rootroot00000000000000--- Checks: 'clang-diagnostic-*,clang-analyzer-*,-clang-analyzer-alpha*,modernize-*,performance-*,readability-*,-readability-braces-around-statements,-readability-named-parameter' WarningsAsErrors: '' HeaderFilterRegex: '/caf/' AnalyzeTemporaryDtors: false CheckOptions: - key: cert-oop11-cpp.UseCERTSemantics value: '1' - key: google-readability-braces-around-statements.ShortStatementLines value: '1' - key: google-readability-function-size.StatementThreshold value: '800' - key: google-readability-namespace-comments.ShortNamespaceLines value: '10' - key: google-readability-namespace-comments.SpacesBeforeComments value: '2' - key: modernize-loop-convert.MaxCopySize value: '16' - key: modernize-loop-convert.MinConfidence value: reasonable - key: modernize-loop-convert.NamingStyle value: CamelCase - key: modernize-pass-by-value.IncludeStyle value: llvm - key: modernize-replace-auto-ptr.IncludeStyle value: llvm - key: modernize-use-nullptr.NullMacros value: 'NULL' ... actor-framework-0.17.6/.cppcheck-suppressions000066400000000000000000000051701370662441400212560ustar00rootroot00000000000000// having an explicit constructor for attachable would // make it harder to use and its a library internal anyways noExplicitConstructor:libcaf_core/caf/attachable.hpp // cppcheck complains about padding1 and padding2 not // being initialized, which is silly (never used anywhere) uninitMemberVar:libcaf_io/caf/io/basp/header.hpp // converting raw pointers to intrusive pointers is // a common operation (e.g. getting a smart pointer to self) noExplicitConstructor:libcaf_core/caf/intrusive_ptr.hpp noExplicitConstructor:libcaf_core/caf/weak_intrusive_ptr.hpp // cppcheck complains about `node_id(const invalid_node_id_t&)`, // which must not be explicit because `invalid_node_id_t` would // be completely useless otherwise, the same is true for // - `message_id(invalid_message_id_t)` noExplicitConstructor:libcaf_core/caf/node_id.hpp noExplicitConstructor:libcaf_core/caf/message_id.hpp // the ctor `duration(std::chrono::duration d)` // is not explicit on purpose noExplicitConstructor:libcaf_core/caf/duration.hpp // making this explicit only makes API worse noExplicitConstructor:libcaf_core/caf/detail/scope_guard.hpp // `operator=(const ref_counted&)` does not assign `rc_` // on purpose because this would corrupt reference counting operatorEqVarError:libcaf_core/src/ref_counted.cpp // cppcheck complains about not initializing the pad members uninitMemberVar:libcaf_core/caf/detail/double_ended_queue.hpp // making the policy functions static is technically possible, // but conceptionally questionable functionStatic:libcaf_core/caf/policy/work_stealing.hpp // 9 false positives *:libcaf_core/caf/optional.hpp // in theory always true, but the unit test still needs to check knownConditionTrueFalse:libcaf_core/test/optional.cpp // ignore warnings from any 3rd party module *:*/third_party/* // 6 false positives *:libcaf_core/caf/detail/limited_vector.hpp // `test_struct::test_value` is unused since this file tests `announce` unusedStructMember:libcaf_io/test/uniform_type.cpp // `exit_reason::as_string` is unused in this .cpp file, but part of the API, // same is true for other falsely reported unused functions unusedFunction:libcaf_core/src/exit_reason.cpp unusedFunction:libcaf_core/src/shared_spinlock.cpp unusedFunction:libcaf_io/src/interfaces.cpp unusedFunction:libcaf_io/src/max_msg_size.cpp // making only some overloads of `abstract_uniform_type_info::eq` // static fails on MSVC functionStatic:bcaf_core/caf/abstract_uniform_type_info.hpp // functions are used in a macro in opencl/smart_ptr.hpp unusedFunction:libcaf_opencl/src/global.cpp // suppress false positives unusedStructMember:libcaf_core/test/serialization.cpp actor-framework-0.17.6/.gitignore000066400000000000000000000003201370662441400167020ustar00rootroot00000000000000.make-release-steps.bash Doxyfile Makefile bin/* blog_release_note.md build/* github_release_note.md html/* manual/examples manual/html/* manual/libcaf_core manual/libcaf_io manual/libcaf_openssl release.txt actor-framework-0.17.6/.gitmodules000066400000000000000000000002061370662441400170720ustar00rootroot00000000000000[submodule "libcaf_python/third_party/pybind"] path = libcaf_python/third_party/pybind url = https://github.com/pybind/pybind11.git actor-framework-0.17.6/CMakeLists.txt000066400000000000000000000706631370662441400174730ustar00rootroot00000000000000cmake_minimum_required(VERSION 2.8.12) project(caf CXX) # Set default install paths. # See https://cmake.org/cmake/help/latest/module/GNUInstallDirs.html include(GNUInstallDirs) get_directory_property(_parent PARENT_DIRECTORY) if(_parent) set(caf_is_subproject ON) else() set(caf_is_subproject OFF) endif() unset(_parent) # Be nice to VIM users and Clang tools. set(CMAKE_EXPORT_COMPILE_COMMANDS 1) # Silence policy CMP0042 warning by enabling RPATH explicitly. if(APPLE AND NOT DEFINED CMAKE_MACOSX_RPATH) set(CMAKE_MACOSX_RPATH true) endif() # Shared libs are currently not supported on Windows. if(WIN32 AND NOT CAF_BUILD_STATIC_ONLY) message(STATUS "CAF currently only supports static-only builds on Windows") set(CAF_BUILD_STATIC_ONLY yes) endif() if(CAF_BUILD_STATIC_RUNTIME) set(flags_configs CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE CMAKE_CXX_FLAGS_RELWITHDEBINFO CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_C_FLAGS CMAKE_C_FLAGS_DEBUG CMAKE_C_FLAGS_RELEASE CMAKE_C_FLAGS_RELWITHDEBINFO CMAKE_C_FLAGS_MINSIZEREL ) foreach(flags ${flags_configs}) if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") if(NOT ${flags} MATCHES "-static-libstdc\\+\\+") set(${flags} "${${flags}} -static-libstdc++") endif() if(NOT ${flags} MATCHES "-static-libgcc") set(${flags} "${${flags}} -static-libgcc") endif() elseif(MSVC) if(${flags} MATCHES "/MD") string(REGEX REPLACE "/MD" "/MT" ${flags} "${${flags}}") endif() endif() endforeach() else() set(CAF_BUILD_STATIC_RUNTIME no) endif() # add helper target that simplifies re-running configure if(NOT caf_is_subproject) add_custom_target(configure COMMAND ${CMAKE_CURRENT_BINARY_DIR}/config.status) endif() ################################################################################ # utility functions # ################################################################################ # Appends `str` to the variable named `var` with a whitespace as separator. # Suppresses a leading whitespace if the variable is empty and does nothing if # `str` is empty. function(build_string var str) if(NOT str STREQUAL "") if("${${var}}" STREQUAL "") set("${var}" "${str}" PARENT_SCOPE) else() set("${var}" "${${var}} ${str}" PARENT_SCOPE) endif() endif() endfunction(build_string) # Forces `var` to 'no' if the content of the variables evaluates to false. function(pretty_no var) if(NOT "${${var}}") set("${var}" no PARENT_SCOPE) endif() endfunction(pretty_no) # Forces `var` to 'yes' if the content of the variables evaluates to false. function(pretty_yes var) if("${${var}}") set("${var}" yes PARENT_SCOPE) endif() endfunction(pretty_yes) add_executable(caf-generate-enum-strings EXCLUDE_FROM_ALL cmake/caf-generate-enum-strings.cpp) add_custom_target(consistency-check) add_custom_target(update-enum-strings) # adds a consistency check that verifies that `cpp_file` is still valid by # re-generating the file and comparing it to the existing file function(add_enum_consistency_check hpp_file cpp_file) set(input "${CMAKE_CURRENT_SOURCE_DIR}/${hpp_file}") set(file_under_test "${CMAKE_CURRENT_SOURCE_DIR}/${cpp_file}") set(output "${CMAKE_CURRENT_BINARY_DIR}/check/${cpp_file}") get_filename_component(output_dir "${output}" DIRECTORY) file(MAKE_DIRECTORY "${output_dir}") add_custom_command(OUTPUT "${output}" COMMAND caf-generate-enum-strings "${input}" "${output}" DEPENDS caf-generate-enum-strings "${input}") get_filename_component(target_name "${input}" NAME_WE) add_custom_target("${target_name}" COMMAND "${CMAKE_COMMAND}" "-Dfile_under_test=${file_under_test}" "-Dgenerated_file=${output}" -P "${PROJECT_SOURCE_DIR}/cmake/check-consistency.cmake" DEPENDS "${output}") add_dependencies(consistency-check "${target_name}") add_custom_target("${target_name}-update" COMMAND caf-generate-enum-strings "${input}" "${file_under_test}" DEPENDS caf-generate-enum-strings "${input}") add_dependencies(update-enum-strings "${target_name}-update") endfunction() ################################################################################ # set prefix paths if available # ################################################################################ build_string("CMAKE_PREFIX_PATH" "${CAF_QT_PREFIX_PATH}") ################################################################################ # enable ccache if required by user # ################################################################################ if(CAF_USE_CCACHE) find_program(CCACHE_PROGRAM ccache) if(CCACHE_PROGRAM) message(STATUS "Using ccache command: ${CCACHE_PROGRAM}") set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}") else() message(STATUS "Unable to find ccache") endif() endif(CAF_USE_CCACHE) ################################################################################ # make sure config parameters are printed with yes or no in summary # ################################################################################ pretty_yes("CAF_FORCE_NO_EXCEPTIONS") pretty_no("CAF_ENABLE_RUNTIME_CHECKS") pretty_no("CAF_NO_MEM_MANAGEMENT") pretty_no("CAF_NO_EXCEPTIONS") pretty_no("CAF_BUILD_STATIC_ONLY") pretty_no("CAF_BUILD_STATIC") pretty_no("CAF_NO_OPENCL") pretty_no("CAF_NO_OPENSSL") pretty_no("CAF_NO_PYTHON") pretty_no("CAF_NO_TOOLS") pretty_no("CAF_NO_SUMMARY") if(NOT CAF_NO_IO) set(CAF_NO_IO no) else() set(CAF_NO_TOOLS yes) set(CAF_NO_PYTHON yes) endif() ################################################################################ # get version of CAF # ################################################################################ # read content of config.hpp file(READ "libcaf_core/caf/config.hpp" CONFIG_HPP) # get line containing the version string(REGEX MATCH "#define CAF_VERSION [0-9]+" VERSION_LINE "${CONFIG_HPP}") # extract version number from line string(REGEX MATCH "[0-9]+" VERSION_INT "${VERSION_LINE}") # calculate major, minor, and patch version math(EXPR CAF_VERSION_MAJOR "${VERSION_INT} / 10000") math(EXPR CAF_VERSION_MINOR "( ${VERSION_INT} / 100) % 100") math(EXPR CAF_VERSION_PATCH "${VERSION_INT} % 100") # create full version string set(CAF_VERSION "${CAF_VERSION_MAJOR}.${CAF_VERSION_MINOR}.${CAF_VERSION_PATCH}") # set the library version for our shared library targets if(CMAKE_HOST_SYSTEM_NAME MATCHES "OpenBSD") set(CAF_LIB_VERSION "${CAF_VERSION_MAJOR}.${CAF_VERSION_MINOR}") else() set(CAF_LIB_VERSION "${CAF_VERSION}") endif() ################################################################################ # set output paths for binaries and libraries if not provided by the user # ################################################################################ # prohibit in-source builds if(CMAKE_CURRENT_SOURCE_DIR STREQUAL "${CMAKE_CURRENT_BINARY_DIR}") message(FATAL_ERROR "In-source builds are not allowed. Please use " "./configure to choose a build directory and " "initialize the build configuration.") endif() # set module path appropriately set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") # set binary output path if not defined by user if(NOT EXECUTABLE_OUTPUT_PATH) set(EXECUTABLE_OUTPUT_PATH "${CMAKE_CURRENT_BINARY_DIR}/bin") endif() # set library output path if not defined by user, but always set # library output path to binary output path for Xcode projects if(CMAKE_GENERATOR STREQUAL "Xcode") set(LIBRARY_OUTPUT_PATH "${EXECUTABLE_OUTPUT_PATH}") elseif(NOT LIBRARY_OUTPUT_PATH) set(LIBRARY_OUTPUT_PATH "${CMAKE_CURRENT_BINARY_DIR}/lib") endif() ################################################################################ # compiler setup # ################################################################################ # leave most compiler flags alone when building as subdirectory if (NOT caf_is_subproject) # check for g++ >= 4.8 or clang++ > = 3.2 if(NOT WIN32 AND NOT CAF_NO_COMPILER_CHECK AND NOT CMAKE_CROSSCOMPILING) try_run(ProgramResult CompilationSucceeded "${CMAKE_CURRENT_BINARY_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake/get_compiler_version.cpp" RUN_OUTPUT_VARIABLE CompilerVersion) if(NOT CompilationSucceeded OR NOT ProgramResult EQUAL 0) message(FATAL_ERROR "Cannot determine compiler version") elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") if(CompilerVersion VERSION_GREATER 4.7) message(STATUS "Found g++ version ${CompilerVersion}") else() message(FATAL_ERROR "g++ >= 4.8 required (found: ${CompilerVersion})") endif() elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") if(CompilerVersion VERSION_GREATER 3.1) message(STATUS "Found clang++ version ${CompilerVersion}") else() message(FATAL_ERROR "clang++ >= 3.2 required (found: ${CompilerVersion})") endif() else() message(FATAL_ERROR "Your C++ compiler does not support C++11 " "or is not supported") endif() endif() # set optional build flags # increase max. template depth on GCC and Clang if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU") build_string("EXTRA_FLAGS" "-ftemplate-depth=512 -ftemplate-backtrace-limit=0") endif() # explicitly disable obnoxious GCC warnings if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") build_string("EXTRA_FLAGS" "-Wno-missing-field-initializers") endif() # add "-Werror" flag if --pedantic-build is used if(CAF_CXX_WARNINGS_AS_ERRORS) build_string("EXTRA_FLAGS" "-Werror") endif() # set compiler flags for GCOV if requested if(CAF_ENABLE_GCOV) if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(NO_INLINE "-fno-inline") else() set(NO_INLINE "-fno-inline -fno-inline-small-functions -fno-default-inline") endif() build_string("EXTRA_FLAGS" "-fprofile-arcs -ftest-coverage ${NO_INLINE}") endif() # set -fno-exception if requested if(CAF_FORCE_NO_EXCEPTIONS) build_string("EXTRA_FLAGS" "-fno-exceptions") endif() # enable a ton of warnings if --more-clang-warnings is used if(CAF_MORE_WARNINGS) if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(WFLAGS "-Weverything -Wno-c++98-compat -Wno-padded " "-Wno-documentation-unknown-command -Wno-exit-time-destructors " "-Wno-global-constructors -Wno-missing-prototypes " "-Wno-c++98-compat-pedantic -Wno-unused-member-function " "-Wno-unused-const-variable -Wno-switch-enum " "-Wno-abstract-vbase-init -Wno-shadow " "-Wno-missing-noreturn -Wno-covered-switch-default") elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") set(WFLAGS "-Waddress -Wall -Warray-bounds " "-Wattributes -Wbuiltin-macro-redefined -Wcast-align " "-Wcast-qual -Wchar-subscripts -Wclobbered -Wcomment " "-Wconversion -Wconversion-null -Wcoverage-mismatch " "-Wcpp -Wdelete-non-virtual-dtor -Wdeprecated " "-Wdeprecated-declarations -Wdiv-by-zero -Wdouble-promotion " "-Wempty-body -Wendif-labels -Wenum-compare -Wextra " "-Wfloat-equal -Wformat -Wfree-nonheap-object " "-Wignored-qualifiers -Winit-self " "-Winline -Wint-to-pointer-cast -Winvalid-memory-model " "-Winvalid-offsetof -Wlogical-op -Wmain -Wmaybe-uninitialized " "-Wmissing-braces -Wmultichar " "-Wnarrowing -Wnoexcept -Wnon-template-friend " "-Wnon-virtual-dtor -Wnonnull -Woverflow " "-Woverlength-strings -Wparentheses " "-Wpmf-conversions -Wpointer-arith -Wreorder " "-Wreturn-type -Wsequence-point " "-Wsign-compare -Wswitch -Wtype-limits -Wundef " "-Wuninitialized -Wunused -Wvla -Wwrite-strings") endif() # convert CMake list to a single string, erasing the ";" separators string(REPLACE ";" "" WFLAGS_STR ${WFLAGS}) build_string("EXTRA_FLAGS" "${WFLAGS_STR}") endif() # allow enabling IPO on gcc/clang if(POLICY CMP0069) cmake_policy(SET CMP0069 NEW) else() if(CMAKE_INTERPROCEDURAL_OPTIMIZATION) if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") build_string("EXTRA_FLAGS" "-flto") elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") build_string("EXTRA_FLAGS" "-flto -fno-fat-lto-objects") endif() endif() endif() # add -stdlib=libc++ when using Clang if possible if(NOT CAF_NO_AUTO_LIBCPP AND CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(CXXFLAGS_BACKUP "${CMAKE_CXX_FLAGS}") if(NOT APPLE AND NOT WIN32) set(CMAKE_CXX_FLAGS "-std=c++11 -stdlib=libc++ -pthread") else() set(CMAKE_CXX_FLAGS "-std=c++11 -stdlib=libc++") endif() try_run(ProgramResult CompilationSucceeded "${CMAKE_CURRENT_BINARY_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake/get_compiler_version.cpp" RUN_OUTPUT_VARIABLE CompilerVersion) if(NOT CompilationSucceeded OR NOT ProgramResult EQUAL 0) message(STATUS "Use clang with GCC' libstdc++") else() message(STATUS "Automatically added '-stdlib=libc++' flag " "(CAF_NO_AUTO_LIBCPP not defined)") build_string("EXTRA_FLAGS" "-stdlib=libc++") endif() # restore CXX flags set(CMAKE_CXX_FLAGS "${CXXFLAGS_BACKUP}") endif() # enable address sanitizer if requested by the user if(CAF_ENABLE_ADDRESS_SANITIZER AND NOT WIN32) # check whether address sanitizer is available set(CXXFLAGS_BACKUP "${CMAKE_CXX_FLAGS}") set(CMAKE_CXX_FLAGS "-fsanitize=address -fno-omit-frame-pointer") try_run(ProgramResult CompilationSucceeded "${CMAKE_CURRENT_BINARY_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake/get_compiler_version.cpp") if(NOT CompilationSucceeded) message(WARNING "Address Sanitizer is not available on selected compiler") else() message(STATUS "Enable Address Sanitizer") build_string("EXTRA_FLAGS" "-fsanitize=address -fno-omit-frame-pointer") endif() # restore CXX flags set(CMAKE_CXX_FLAGS "${CXXFLAGS_BACKUP}") endif() # -pthread is ignored on MacOSX but required on other platforms if(NOT APPLE AND NOT WIN32) build_string("EXTRA_FLAGS" "-pthread") endif() if (WIN32) list(APPEND CAF_EXTRA_LDFLAGS ws2_32 iphlpapi) endif() # iOS support if(CAF_OSX_SYSROOT) set(CMAKE_OSX_SYSROOT "${CAF_OSX_SYSROOT}") endif() if(CAF_IOS_DEPLOYMENT_TARGET) if(CAF_OSX_SYSROOT STREQUAL "iphonesimulator") build_string("EXTRA_FLAGS" "-mios-simulator-version-min=${CAF_IOS_DEPLOYMENT_TARGET}") else() build_string("EXTRA_FLAGS" "-miphoneos-version-min=${CAF_IOS_DEPLOYMENT_TARGET}") endif() endif() # check if the user provided CXXFLAGS, set defaults otherwise if(NOT CMAKE_CXX_FLAGS) set(CMAKE_CXX_FLAGS "-std=c++11 -Wextra -Wall -pedantic") endif() if (NOT MSVC AND NOT "${CMAKE_CXX_FLAGS}" MATCHES "-std=") message(STATUS "Supplied CXXFLAGS do not contain a C++ standard, setting std to c++11") set(CMAKE_CXX_FLAGS "-std=c++11 ${CMAKE_CXX_FLAGS}") endif() if(NOT CMAKE_CXX_FLAGS_DEBUG) set(CMAKE_CXX_FLAGS_DEBUG "-O0 -g") endif() if(NOT CMAKE_CXX_FLAGS_MINSIZEREL) set(CMAKE_CXX_FLAGS_MINSIZEREL "-Os") endif() if(NOT CMAKE_CXX_FLAGS_RELEASE) set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG") endif() if(NOT CMAKE_CXX_FLAGS_RELWITHDEBINFO) set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g -fno-omit-frame-pointer") endif() # set build default build type to RelWithDebInfo if not set if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE RelWithDebInfo) endif() endif() # Make sure to link to platform-specific threading dependency (e.g. pthread). if (NOT TARGET Threads::Threads) find_package(Threads REQUIRED) endif () list(APPEND CAF_EXTRA_LDFLAGS Threads::Threads) # Have CMake set -fPIC when necessary. set(CMAKE_POSITION_INDEPENDENT_CODE ON) # Adjust setup for MinGW and Cygwin. if(MINGW) add_definitions(-D_WIN32_WINNT=0x0600) add_definitions(-DWIN32) include(GenerateExportHeader) list(APPEND CAF_EXTRA_LDFLAGS -lws2_32 -liphlpapi -lpsapi) # Build static to avoid runtime dependencies to GCC libraries. build_string("EXTRA_FLAGS" "-static") elseif(CYGWIN) build_string("EXTRA_FLAGS" "-U__STRICT_ANSI__") endif() # Add extra flags. if (NOT "${EXTRA_FLAGS}" STREQUAL "") build_string(CMAKE_CXX_FLAGS "${EXTRA_FLAGS}") endif() ################################################################################ # setup logging # ################################################################################ # make sure log level is defined and all-uppercase if(NOT CAF_LOG_LEVEL) set(CAF_LOG_LEVEL "QUIET") else() string(TOUPPER "${CAF_LOG_LEVEL}" CAF_LOG_LEVEL) endif() set(validLogLevels QUIET ERROR WARNING INFO DEBUG TRACE) list(FIND validLogLevels "${CAF_LOG_LEVEL}" logLevelIndex) if(logLevelIndex LESS 0) MESSAGE(FATAL_ERROR "Invalid log level: \"${CAF_LOG_LEVEL}\"") endif() ################################################################################ # setup for install target # ################################################################################ # install includes from test install(DIRECTORY libcaf_test/caf/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/caf FILES_MATCHING PATTERN "*.hpp") # process cmake_uninstall.cmake.in configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY) # add uninstall target if it does not exist yet if(NOT TARGET uninstall) add_custom_target(uninstall) endif() add_custom_target(caf_uninstall) add_custom_command(TARGET caf_uninstall PRE_BUILD COMMAND "${CMAKE_COMMAND}" -P "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake") add_dependencies(uninstall caf_uninstall) ################################################################################ # set inclue paths for subprojects # ################################################################################ # path to caf core & io headers set(CAF_INCLUDE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_core" "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_io" "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_openssl" "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_test") # path to caf opencl headers if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_opencl/CMakeLists.txt") set(CAF_INCLUDE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_opencl/" "${CAF_INCLUDE_DIRS}") endif() # enable tests if not disabled if(NOT CAF_NO_UNIT_TESTS) enable_testing() macro(add_unit_tests globstr) file(GLOB_RECURSE tests "${globstr}") set(CAF_ALL_UNIT_TESTS ${CAF_ALL_UNIT_TESTS} ${tests}) endmacro() else() macro(add_unit_tests globstr) # do nothing (unit tests disabled) endmacro() endif() # all projects need the headers of the core components include_directories("${CAF_INCLUDE_DIRS}") # -- unit tests setup ---------------------------------------------------------- if(NOT CAF_NO_UNIT_TESTS) enable_testing() function(caf_add_test_suites target) foreach(suiteName ${ARGN}) string(REPLACE "." "/" suitePath ${suiteName}) target_sources(${target} PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/test/${suitePath}.cpp") add_test(NAME ${suiteName} COMMAND ${target} -r300 -n -v5 -s"^${suiteName}$") endforeach() endfunction() endif() # -- add targets --------------------------------------------------------------- macro(add_caf_lib name) string(TOUPPER ${name} upper_name) set(full_name libcaf_${name}) set(shared_target ${full_name}_shared) set(static_target ${full_name}_static) add_subdirectory(${full_name}) set(lib_varname CAF_LIBRARY_${upper_name}) set(lib_varname_static ${lib_varname}_STATIC) if(NOT CAF_BUILD_STATIC_ONLY) set(${lib_varname} ${shared_target}) set(CAF_LIBRARIES ${CAF_LIBRARIES} ${shared_target}) else() set(${lib_varname} ${static_target}) set(CAF_LIBRARIES ${CAF_LIBRARIES} ${static_target}) endif() if(CAF_BUILD_STATIC_ONLY OR CAF_BUILD_STATIC) set(${lib_varname_static} ${static_target}) endif() add_unit_tests("${full_name}/test/*.cpp") # add headers to include directories so other subprojects can use them include_directories("${CMAKE_CURRENT_SOURCE_DIR}/libcaf_${name}") endmacro() macro(add_optional_caf_lib name) string(TOUPPER ${name} upper_name) set(flag_varname CAF_NO_${upper_name}) if(NOT ${flag_varname} AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_${name}/CMakeLists.txt") add_caf_lib(${name}) else() set(${flag_name} yes) endif() endmacro() macro(add_optional_caf_binaries name) string(TOUPPER ${name} upper_name) set(dependency_failed no) # check all aditional dependency flags foreach(flag_name ${ARGN}) if(${flag_name}) set(dependency_failed yes) endif() endforeach() if(NOT dependency_failed) if(NOT CAF_NO_${upper_name} AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${name}/CMakeLists.txt") add_subdirectory(${name}) else() # make sure variable is set for nicer build log set(CAF_NO_${upper_name} yes) endif() else() message(STATUS "Disable ${name}, one of the following flags was set: ${ARGN}") # make sure variable is set for nicer build log set(CAF_NO_${upper_name} yes) endif() endmacro() # build core and I/O library add_caf_lib(core) add_optional_caf_lib(io) # build SSL module if OpenSSL library is available or if a parent project # defined OPENSSL_LIBRARIES for us if(DEFINED OPENSSL_LIBRARIES) if (NOT OPENSSL_INCLUDE_DIR) message(FATAL_ERROR "got OPENSSL_LIBRARIES predefined but no OPENSSL_INCLUDE_DIR") endif() message(STATUS "use OPENSSL_LIBRARIES provided by parent: ${OPENSSL_LIBRARIES}") message(STATUS "use OPENSSL_INCLUDE_DIR provided by parent: ${OPENSSL_INCLUDE_DIR}") include_directories(BEFORE ${OPENSSL_INCLUDE_DIR}) add_optional_caf_lib(openssl) elseif(NOT CAF_NO_OPENSSL) find_package(OpenSSL) if(OPENSSL_FOUND) # Check OpenSSL version >= 1.0.1 if (OPENSSL_VERSION VERSION_LESS 1.0.1) message(STATUS "Disable OpenSSL. Required >= 1.0.1 due to TLSv1.2 support.") set(CAF_NO_OPENSSL yes) else() if(NOT CMAKE_CROSSCOMPILING) # Check if openssl headers and library versions match try_run(sslRunResult sslCompileResult "${CMAKE_CURRENT_BINARY_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake/openssl-check.cpp" CMAKE_FLAGS "-DINCLUDE_DIRECTORIES=${OPENSSL_INCLUDE_DIR}" LINK_LIBRARIES ${OPENSSL_LIBRARIES} OUTPUT_VARIABLE sslOutput) if (NOT sslCompileResult) message(FATAL_ERROR "failed to compile/link against OpenSSL") endif() if(NOT sslRunResult EQUAL 0) message(FATAL_ERROR "OpenSSL version does not match headers: ${sslOutput}") endif() endif() include_directories(BEFORE ${OPENSSL_INCLUDE_DIR}) add_optional_caf_lib(openssl) endif() else(OPENSSL_FOUND) set(CAF_NO_OPENSSL yes) endif(OPENSSL_FOUND) endif() # build opencl library if not told otherwise and OpenCL package was found if(NOT CAF_NO_OPENCL) if(${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} GREATER 3.0) find_package(OpenCL) if(OpenCL_FOUND) include_directories(BEFORE ${OpenCL_INCLUDE_DIRS}) add_optional_caf_lib(opencl) add_optional_caf_binaries(libcaf_opencl/examples) else() set(CAF_NO_OPENCL yes) endif() else() set(CAF_NO_OPENCL yes) message(STATUS "Could NOT find OpenCL, requires Cmake >= 3.1.") endif() endif() # build Python binding if not being told otherwise if(NOT CAF_NO_PYTHON AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/libcaf_python/CMakeLists.txt") add_subdirectory(libcaf_python) endif() # build examples if not being told otherwise add_optional_caf_binaries(examples) # build tools if not being told otherwise add_optional_caf_binaries(tools) # -- Setup for building manual and API documentation --------------------------- if(NOT caf_is_subproject) if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/release.txt") file(READ "${CMAKE_CURRENT_SOURCE_DIR}/release.txt" CAF_RELEASE) string(REGEX REPLACE "\n" "" CAF_RELEASE "${CAF_RELEASE}") else() set(CAF_RELEASE "${CAF_VERSION}") endif() message(STATUS "Set release version for all documentation to ${CAF_RELEASE}.") add_subdirectory(doc) endif() # -- Export important variables to the parent scope ---------------------------- if(caf_is_subproject) # Make sure parent projects can find build_config.hpp list(APPEND CAF_INCLUDE_DIRS "${CMAKE_CURRENT_BINARY_DIR}/libcaf_core") set(CAF_VERSION "${CAF_VERSION}" CACHE INTERNAL "CAF release version") set(CAF_LIBRARIES "${CAF_LIBRARIES}" CACHE INTERNAL "Library targets") set(CAF_INCLUDE_DIRS "${CAF_INCLUDE_DIRS}" CACHE INTERNAL "Path to CAF headers") endif() ################################################################################ # print summary # ################################################################################ # little helper macro to invert a boolean macro(invertYesNo in out) if(${in}) set(${out} no) else() set(${out} yes) endif() endmacro() # invert CAF_NO_* variables for nicer output invertYesNo(CAF_NO_IO CAF_BUILD_IO) invertYesNo(CAF_NO_EXAMPLES CAF_BUILD_EXAMPLES) invertYesNo(CAF_NO_TOOLS CAF_BUILD_TOOLS) invertYesNo(CAF_NO_UNIT_TESTS CAF_BUILD_UNIT_TESTS) invertYesNo(CAF_NO_EXCEPTIONS CAF_BUILD_WITH_EXCEPTIONS) invertYesNo(CAF_NO_MEM_MANAGEMENT CAF_BUILD_MEM_MANAGEMENT) invertYesNo(CAF_NO_OPENCL CAF_BUILD_OPENCL) invertYesNo(CAF_NO_OPENSSL CAF_BUILD_OPENSSL) invertYesNo(CAF_NO_PYTHON CAF_BUILD_PYTHON) # collect all compiler flags string(TOUPPER "${CMAKE_BUILD_TYPE}" UPPER_BUILD_TYPE) set(ALL_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${UPPER_BUILD_TYPE}}") set(ALL_LD_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${CAF_EXTRA_LDFLAGS}") string(STRIP "${ALL_LD_FLAGS}" ALL_LD_FLAGS) # done if(NOT CAF_NO_SUMMARY) message(STATUS "\n====================| Build Summary |====================" "\n" "\nCAF version: ${CAF_VERSION}" "\n" "\nBuild type: ${CMAKE_BUILD_TYPE}" "\nBuild static: ${CAF_BUILD_STATIC}" "\nBuild static only: ${CAF_BUILD_STATIC_ONLY}" "\nBuild static runtime: ${CAF_BUILD_STATIC_RUNTIME}" "\nRuntime checks: ${CAF_ENABLE_RUNTIME_CHECKS}" "\nLog level: ${CAF_LOG_LEVEL}" "\nWith mem. mgmt.: ${CAF_BUILD_MEM_MANAGEMENT}" "\nWith exceptions: ${CAF_BUILD_WITH_EXCEPTIONS}" "\n" "\nBuild I/O module: ${CAF_BUILD_IO}" "\nBuild tools: ${CAF_BUILD_TOOLS}" "\nBuild examples: ${CAF_BUILD_EXAMPLES}" "\nBuild unit tests: ${CAF_BUILD_UNIT_TESTS}" "\nBuild OpenCL: ${CAF_BUILD_OPENCL}" "\nBuild OpenSSL: ${CAF_BUILD_OPENSSL}" "\nBuild Python: ${CAF_BUILD_PYTHON}" "\n" "\nCXX: ${CMAKE_CXX_COMPILER}" "\nCXXFLAGS: ${ALL_CXX_FLAGS}" "\nLINKER_FLAGS (shared) ${ALL_LD_FLAGS}" "\n" "\nSource directory: ${CMAKE_CURRENT_SOURCE_DIR}" "\nBuild directory: ${CMAKE_CURRENT_BINARY_DIR}" "\nExecutable path: ${EXECUTABLE_OUTPUT_PATH}" "\nLibrary path: ${LIBRARY_OUTPUT_PATH}" "\nInstall prefix: ${CMAKE_INSTALL_PREFIX}" "\nGenerator: ${CMAKE_GENERATOR}" "\n" "\n===========================================================\n") endif() actor-framework-0.17.6/CONTRIBUTING.md000066400000000000000000000304231370662441400171520ustar00rootroot00000000000000This document specifies how to contribute code to CAF. Git Workflow ============ Please adhere to the following Git naming and commit message conventions. Having a consistent work flow and style reduces friction and makes organizing contributions a lot easier for all sides. Branches -------- - Our main branch is `master`. It reflects the latest development changes for the next release and should always compile. Nightly versions use the `master`. Users looking for a production-ready state are encouraged to use the latest release version instead. - Push trivial bugfixes (e.g. typos, missing includes, etc.) consisting of a single commit directly to `master`. Otherwise, implement your changes in a topic or bugfix branch and file a pull request on GitHub. - Implement new features and non-trivial changes in a *topic branch* with naming convention `topic/short-description`. - Implement fixes for existing issues in a *bugfix branch* with naming convention `issue/$num`, where `$num` is the issue ID on GitHub. - Simply use a fork of CAF if you are an external contributor. Pull Requests ------------- Check the following steps to prepare for a merge into `master` after completing work in a topic or bugfix branch (or fork). - Squash your commits into a single one if necessary. Each commit should represent a coherent set of changes. - Wait for a code review and the test results of our CI. - Address any review feedback and fix all issues reported by the CI. - A maintainer will merge the pull request when all issues are resolved. Commit Message Style -------------------- - Summarize the changes in no more than 50 characters in the first line. Capitalize and write in an imperative present tense, e.g., "Fix bug" as opposed to "Fixes bug" or "Fixed bug". - Suppress the dot at the end of the first line. Think of it as the header of the following description. - Leave the second line empty. - Optionally add a long description written in full sentences beginning on the third line. Indent at 72 characters per line. Coding Style ============ When contributing source code, please adhere to the following coding style, which is loosely based on the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) and the coding conventions used by the C++ Standard Library. Example for the Impatient ------------------------- ```c++ // libcaf_example/caf/example/my_class.hpp #pragma once #include // use "//" for regular comments and "///" for doxygen namespace caf { namespace example { /// This class is only being used as style guide example. class my_class { public: /// Brief description. More description. Note that CAF uses the /// "JavaDoc-style" autobrief option, i.e., everything up until the /// first dot is the brief description. my_class(); /// Destructs `my_class`. Please use Markdown in comments. ~my_class(); // suppress redundant @return if you start the brief description with "Returns" /// Returns the name of this instance. inline const std::string& name() const noexcept { return name_; } /// Sets the name of this instance. inline void name(const std::string& new_name) { name_ = new_name; } /// Prints the name to `std::cout`. void print_name() const; /// Does something (maybe). void do_something(); /// Does something else but is guaranteed to never throw. void do_something_else() noexcept; private: std::string name_; }; } // namespace example } // namespace caf ``` ```c++ // libcaf_example/src/example/my_class.cpp #include "caf/example/my_class.hpp" #include namespace caf { namespace example { namespace { constexpr const char default_name[] = "my object"; } // namespace my_class::my_class() : name_(default_name) { // nop } my_class::~my_class() { // nop } void my_class::print_name() const { std::cout << name() << std::endl; } void my_class::do_something() { if (name() == default_name) { std::cout << "You didn't gave me a proper name, so I " << "refuse to do something." << std::endl; } else { std::cout << "You gave me the name \"" << name() << "\"... Do you really think I'm willing to do something " "for you after insulting me like that?" << std::endl; } } void my_class::do_something_else() noexcept { // Do nothing if we don't have a name. if (name().empty()) return; switch (name.front()) { case 'a': // handle a break; case 'b': // handle b break; default: handle_default(); } } } // namespace example } // namespace caf ``` ```c++ // libcaf_example/test/example/my_class.cpp #define CAF_SUITE example.my_class // name of this test suite #include "caf/example/my_class.hpp" // header-under-test #include "caf/test/dsl.hpp" // caf::test includes #include // standard includes // ... // other CAF includes namespace { struct fixture {}; } // namespace CAF_TEST_FIXTURE_SCOPE(my_class_tests, fixture) // ... any number of CAF_TEST ... CAF_TEST_FIXTURE_SCOPE_END() ``` General ------- - Use 2 spaces per indentation level. - Use at most 80 characters per line. - Never use tabs. - Never use C-style casts. - Never declare more than one variable per line. - Only separate functions with vertical whitespaces and use comments to document logical blocks inside functions. - Use `.hpp` as suffix for header files and `.cpp` as suffix for implementation files. - Bind `*` and `&` to the *type*, e.g., `const std::string& arg`. - Never increase the indentation level for namespaces and access modifiers. - Use the order `public`, `protected`, and then `private` in classes. - Always use `auto` to declare a variable unless you cannot initialize it immediately or if you actually want a type conversion. In the latter case, provide a comment why this conversion is necessary. - Never use unwrapped, manual resource management such as `new` and `delete`. - Prefer `using T = X` over `typedef X T`. - Insert a whitespaces after keywords: `if (...)`, `template <...>`, `while (...)`, etc. - Put opening braces on the same line: ```c++ void foo() { // ... } ``` - Use standard order for readability: C standard libraries, C++ standard libraries, OS-specific headers (usually guarded by `ifdef`), other libraries, and finally (your) CAF headers. Include `caf/config.hpp` before the standard headers if you need to include platform-dependent headers. Use angle brackets for system includes and doublequotes otherwise. ```c++ // example.hpp #include #include #include "3rd/party.h" #include "caf/fwd.hpp" ``` Put the implemented header always first in a `.cpp` file. ```c++ // example.cpp #include "caf/example.hpp" // header for this .cpp file #include "caf/config.hpp" // needed for #ifdef guards #include #ifdef CAF_WINDOWS #include #else #include #endif #include "some/other/library.h" #include "caf/actor.hpp" ``` - Put output parameters in functions before input parameters if unavoidable. This follows the parameter order from the STL. - Protect single-argument constructors with `explicit` to avoid implicit conversions. - Use `noexcept` whenever it makes sense and as long as it does not limit future design space. Move construction and assignment are natural candidates for `noexcept`. Naming ------ - All names except macros and template parameters should be lower case and delimited by underscores. - Template parameter names should be written in CamelCase. - Types and variables should be nouns, while functions performing an action should be "command" verbs. Classes used to implement metaprogramming functions also should use verbs, e.g., `remove_const`. - Private and protected member variables use the suffix `_` while getter *and* setter functions use the name without suffix: ```c++ class person { public: person(std::string name) : name_(std::move(name)) { // nop } const std::string& name() const { return name_ } void name(const std::string& new_name) { name_ = new_name; } private: std::string name_; }; ``` - Use `T` for generic, unconstrained template parameters and `x` for generic function arguments. Suffix both with `s` for template parameter packs and lists: ```c++ template void print(const Ts&... xs) { // ... } void print(const std::vector& xs) { // ... } ``` Headers ------- - Each `.cpp` file has an associated `.hpp` file. Exceptions to this rule are unit tests and `main.cpp` files. - Each class has its own pair of header and implementation files and the relative path for the files are derived from the full class name. For example, the header file for `caf::example::my_class` of `libcaf_example` is located at `libcaf_example/caf/example/my_class.hpp` and the source file at `libcaf_example/src/example/my_class.cpp`. - All header files use `#pragma once` to prevent multiple inclusion. - Do not `#include` when a forward declaration suffices. - Each library component must provide a `fwd.hpp` header providing forward declarations for all types used in the user API. - Each library component should provide an `all.hpp` header that contains the main page for the documentation and includes all headers for the user API. - Use `inline` for small functions (rule of thumb: 10 lines or less). Breaking Statements ------------------- - Break constructor initializers after the comma, use two spaces for indentation, and place each initializer on its own line (unless you don't need to break at all): ```c++ my_class::my_class() : my_base_class(some_function()), greeting_("Hello there! This is my_class!"), some_bool_flag_(false) { // ok } other_class::other_class() : name_("tommy"), buddy_("michael") { // ok } ``` - Break function arguments after the comma for both declaration and invocation: ```c++ intptr_t channel::compare(const abstract_channel* lhs, const abstract_channel* rhs) { // ... } ``` - Break before tenary operators and before binary operators: ```c++ if (today_is_a_sunny_day() && it_is_not_too_hot_to_go_swimming()) { // ... } ``` Template Metaprogramming ------------------------ Despite its power, template metaprogramming came to the language pretty much by accident. Templates were never meant to be used for compile-time algorithms and type transformations. This is why C++ punishes metaprogramming with an insane amount of syntax noise. In CAF, we make excessive use of templates. To keep the code readable despite all the syntax noise, we have some extra rules for formatting metaprogramming code. - Break `using name = ...` statements always directly after `=` if it does not fit in one line. - Consider the *semantics* of a metaprogramming function. For example, `std::conditional` is an if-then-else construct. Hence, place the if-clause on its own line and do the same for the two cases. - Use one level of indentation per "open" template and place the closing `>`, `>::type` or `>::value` on its own line. For example: ```c++ using optional_result_type = typename std::conditional< std::is_same::value, bool, optional >::type; // think of it as the following (not valid C++): auto optional_result_type = conditional { if result_type == void then bool else optional }; ``` - Note that this is not necessary when simply defining a type alias. When dealing with "ordinary" templates, indenting based on the position of the opening `<` is ok, e.g.: ```c++ using response_handle_type = response_handle; ``` Preprocessor Macros ------------------- - Use macros if and only if you can't get the same result by using inline functions or proper constants. - Macro names use the form `CAF__`. Comments -------- - Start Doxygen comments with `///`. - Use Markdown instead of Doxygen formatters. - Use `@cmd` rather than `\cmd`. - Use `//` to define basic comments that should not be processed by Doxygen. actor-framework-0.17.6/Jenkinsfile000066400000000000000000000144471370662441400171150ustar00rootroot00000000000000#!/usr/bin/env groovy @Library('caf-continuous-integration') _ // Default CMake flags for release builds. defaultReleaseBuildFlags = [ 'CAF_ENABLE_RUNTIME_CHECKS:BOOL=yes', 'CAF_NO_OPENCL:BOOL=yes', 'CAF_INSTALL_UNIT_TESTS:BOOL=yes', 'CAF_ENABLE_TYPE_ID_CHECKS:BOOL=yes', ] // Default CMake flags for debug builds. defaultDebugBuildFlags = defaultReleaseBuildFlags + [ 'CAF_ENABLE_ADDRESS_SANITIZER:BOOL=yes', 'CAF_LOG_LEVEL:STRING=TRACE', 'CAF_ENABLE_ACTOR_PROFILER:BOOL=yes', 'CAF_ENABLE_TYPE_ID_CHECKS:BOOL=yes', ] // Configures the behavior of our stages. config = [ // GitHub path to repository. repository: 'actor-framework/actor-framework', // List of enabled checks for email notifications. checks: [ 'build', 'style', 'tests', ], // Our build matrix. Keys are the operating system labels and values are build configurations. buildMatrix: [ ['Linux', [ builds: ['debug'], tools: ['gcc7'], ]], ['Linux', [ builds: ['debug'], tools: ['gcc8'], ]], ['Linux', [ builds: ['debug'], tools: ['gcc8'], extraFlags: ['EXTRA_FLAGS=-std=c++17'] ]], ['Linux', [ builds: ['release'], tools: ['gcc8'], ]], ['macOS', [ builds: ['debug', 'release'], tools: ['clang'], ]], ['FreeBSD', [ builds: ['debug', 'release'], tools: ['clang'], ]], ['Windows', [ // TODO: debug build currently broken //builds: ['debug', 'release'], builds: ['release'], tools: ['msvc'], ]], ], // Platform-specific environment settings. buildEnvironments: [ nop: [], // Dummy value for getting the proper types. ], // Default CMake flags by build type. defaultBuildFlags: [ debug: defaultDebugBuildFlags, release: defaultReleaseBuildFlags, ], // CMake flags by OS and build type to override defaults for individual builds. buildFlags: [ macOS: [ debug: defaultDebugBuildFlags + [ 'OPENSSL_ROOT_DIR=/usr/local/opt/openssl', 'OPENSSL_INCLUDE_DIR=/usr/local/opt/openssl/include', ], release: defaultReleaseBuildFlags + [ 'OPENSSL_ROOT_DIR=/usr/local/opt/openssl', 'OPENSSL_INCLUDE_DIR=/usr/local/opt/openssl/include', ], ], Windows: [ debug: defaultDebugBuildFlags + [ 'CAF_BUILD_STATIC_ONLY:BOOL=yes', ], release: defaultReleaseBuildFlags + [ 'CAF_BUILD_STATIC_ONLY:BOOL=yes', ], ], ], ] // Declarative pipeline for triggering all stages. pipeline { options { // Store no more than 50 logs and 10 artifacts. buildDiscarder(logRotator(numToKeepStr: '50', artifactNumToKeepStr: '3')) } agent { label 'master' } environment { PrettyJobBaseName = env.JOB_BASE_NAME.replace('%2F', '/') PrettyJobName = "CAF/$PrettyJobBaseName #${env.BUILD_NUMBER}" ASAN_OPTIONS = 'detect_leaks=0' } stages { stage('Checkout') { steps { getSources(config) } } stage('Lint') { agent { label 'clang-format' } steps { runClangFormat(config) } } stage('Check Consistency') { agent { label 'unix' } steps { deleteDir() unstash('sources') dir('sources') { cmakeBuild([ buildDir: 'build', installation: 'cmake in search path', sourceDir: '.', steps: [[ args: '--target consistency-check', withCmake: true, ]], ]) } } } stage('Build') { steps { buildParallel(config, PrettyJobBaseName) } } // TODO: generate PDF from reStructuredText // stage('Documentation') { // agent { label 'pandoc' } // steps { // deleteDir() // unstash('sources') // dir('sources') { // // Configure and build. // cmakeBuild([ // buildDir: 'build', // installation: 'cmake in search path', // sourceDir: '.', // cmakeArgs: '-DCAF_BUILD_TEX_MANUAL=yes', // steps: [[ // args: '--target doc', // withCmake: true, // ]], // ]) // sshagent(['84d71a75-cbb6-489a-8f4c-d0e2793201e9']) { // sh """ // if [ "${env.GIT_BRANCH}" = "master" ]; then // rsync -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" -r -z --delete build/doc/html/ www.inet.haw-hamburg.de:/users/www/www.actor-framework.org/html/doc // scp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null build/doc/manual.pdf www.inet.haw-hamburg.de:/users/www/www.actor-framework.org/html/pdf/manual.pdf // fi // """ // } // } // } // } stage('Notify') { steps { collectResults(config, PrettyJobName) } } } post { failure { emailext( subject: "$PrettyJobName: " + config['checks'].collect{ "⛔️ ${it}" }.join(', '), recipientProviders: [culprits(), developers(), requestor(), upstreamDevelopers()], attachLog: true, compressLog: true, body: "Check console output at ${env.BUILD_URL} or see attached log.\n", ) notifyAllChecks(config, 'failure', 'Failed due to earlier error') } } } actor-framework-0.17.6/LICENSE000066400000000000000000000027561370662441400157360ustar00rootroot00000000000000Copyright (c) 2011-2014, Dominik Charousset All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. actor-framework-0.17.6/LICENSE_ALTERNATIVE000066400000000000000000000024721370662441400175670ustar00rootroot00000000000000Boost Software License - Version 1.0 - August 17th, 2003 Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following: The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor. 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. actor-framework-0.17.6/README.md000066400000000000000000000127301370662441400162010ustar00rootroot00000000000000# CAF: C++ Actor Framework CAF is an open source C++11 actor model implementation featuring lightweight & fast actor implementations, pattern matching for messages, network transparent messaging, and more. [![Gitter][gitter-badge]](https://gitter.im/actor-framework/chat) [![Jenkins][jenkins-badge]](https://jenkins.inet.haw-hamburg.de/job/CAF/job/actor-framework/job/master) [![Documentation Status][docs-badge]](http://actor-framework.readthedocs.io/en/latest/?badge=latest) [![Coverity][coverity-badge]](https://scan.coverity.com/projects/5555) ## Online Resources * __Homepage__: http://www.actor-framework.org * __Developer Blog__: http://blog.actor-framework.org * __Doxygen__: http://www.actor-framework.org/doc * __HTML Manual__: https://actor-framework.readthedocs.io * __PDF Manual__: http://www.actor-framework.org/pdf/manual.pdf ## Report Bugs / Get Help * __Open Issues on GitHub__: https://github.com/actor-framework/actor-framework/issues/new * __Ask Questions on StackOverflow__: https://stackoverflow.com/questions/ask?tags=c%2b%2b-actor-framework ## Community * __Chat__: https://gitter.im/actor-framework/chat * __Twitter__: https://twitter.com/actor_framework * __User Mailing List__: https://groups.google.com/d/forum/actor-framework * __Developer Mailing List__: https://groups.google.com/d/forum/caf-devel * __Feature Proposals__: https://github.com/actor-framework/evolution ## Get CAF ### FreeBSD Ports We maintain a port for CAF, which you can install as follows: ```sh pkg install caf ``` Alternatively, you can go to `/usr/ports/devel/caf` and tweak a few configuration options before installing the port: ```sh make config make install clean ``` ### Homebrew You can install the latest stable release with: ```sh brew install caf ``` Alternatively, you can use the current development version by using: ```sh brew install caf --HEAD ``` ### Conan A [Conan](https://conan.io/) recipe for CAF along with pre-built libraries for most platforms are available at [bincrafters/caf](https://bintray.com/bincrafters/public-conan/caf%3Abincrafters). ## Get the Sources * git clone https://github.com/actor-framework/actor-framework.git * cd actor-framework ## Build CAF from Source The easiest way to build CAF is to use the `configure` script. Other available options are using [CMake](http://www.cmake.org/) directly or [SNocs](https://github.com/airutech/snocs). ### Using the `configure` Script The script is a convenient frontend for `CMake`. See `configure -h` for a list of available options or read the [online documentation](https://github.com/actor-framework/actor-framework/wiki/Configure-Options). ```sh ./configure make make test make install [as root, optional] ``` ### Using CMake All available CMake variables are available [online](https://github.com/actor-framework/actor-framework/wiki/CMake-Options). CAF also can be included as CMake submodule or added as dependency to other CMake-based projects using the file `cmake/FindCAF.cmake`. ### Using SNocs A SNocs workspace is provided by GitHub user [osblinnikov](https://github.com/osblinnikov) and documented [online](https://github.com/actor-framework/actor-framework/wiki/Using-SNocs). ## Dependencies * CMake * Pthread (until C++11 compilers support the new `thread_local` keyword) ## Supported Compilers * GCC >= 4.8.3 * Clang >= 3.2 * MSVC >= 2015, update 3 ## Supported Operating Systems * Linux * Mac OS X * FreeBSD 10 * Windows >= 7 (currently static builds only) ## Optional Dependencies * Doxygen (for the `doxygen` target) * LaTeX (for the `manual` target) * Pandoc and Python with pandocfilters (for the `rst` target) ## Build the Manual CAF uses [Sphinx](https://www.sphinx-doc.org): ```sh cd manual sphinx-build . html ``` ## Scientific Use If you use CAF in a scientific context, please use one of the following citations: ```latex @inproceedings{cshw-nassp-13, author = {Dominik Charousset and Thomas C. Schmidt and Raphael Hiesgen and Matthias W{\"a}hlisch}, title = {{Native Actors -- A Scalable Software Platform for Distributed, Heterogeneous Environments}}, booktitle = {Proc. of the 4rd ACM SIGPLAN Conference on Systems, Programming, and Applications (SPLASH '13), Workshop AGERE!}, pages = {87--96}, month = {Oct.}, year = {2013}, publisher = {ACM}, address = {New York, NY, USA} } @article{chs-rapc-16, author = {Dominik Charousset and Raphael Hiesgen and Thomas C. Schmidt}, title = {{Revisiting Actor Programming in C++}}, journal = {Computer Languages, Systems \& Structures}, volume = {45}, year = {2016}, month = "April", pages = {105--131}, publisher = {Elsevier} } ``` You can find the papers online at http://dx.doi.org/10.1145/2541329.2541336 and http://dx.doi.org/10.1016/j.cl.2016.01.002. [obs]: https://software.opensuse.org/download.html?project=devel%3Alibraries%3Acaf&package=caf [obs-nightly]: https://software.opensuse.org/download.html?project=devel%3Alibraries%3Acaf%3Anightly&package=caf [obs-dev]: https://software.opensuse.org/download.html?project=devel%3Alibraries%3Acaf&package=caf-devel [obs-dev-nightly]: https://software.opensuse.org/download.html?project=devel%3Alibraries%3Acaf%3Anightly&package=caf-devel [jenkins-badge]: https://jenkins.inet.haw-hamburg.de/buildStatus/icon?job=CAF/actor-framework/master [docs-badge]: https://readthedocs.org/projects/actor-framework/badge/?version=latest [coverity-badge]: https://scan.coverity.com/projects/5555/badge.svg?flat=1 [gitter-badge]: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg actor-framework-0.17.6/cmake/000077500000000000000000000000001370662441400157775ustar00rootroot00000000000000actor-framework-0.17.6/cmake/FindCAF.cmake000066400000000000000000000126041370662441400201760ustar00rootroot00000000000000# Try to find CAF headers and libraries. # # Use this module as follows: # # find_package(CAF [COMPONENTS *] [REQUIRED]) # # Variables used by this module (they can change the default behaviour and need # to be set before calling find_package): # # CAF_ROOT_DIR Set this variable either to an installation prefix or to wa # CAF build directory where to look for the CAF libraries. # # Variables defined by this module: # # CAF_FOUND System has CAF headers and library # CAF_VERSION Found CAF release number # CAF_LIBRARIES List of library files for all components # CAF_INCLUDE_DIRS List of include paths for all components if(CAF_FIND_COMPONENTS STREQUAL "") message(FATAL_ERROR "FindCAF requires at least one COMPONENT.") endif() # iterate over user-defined components foreach (comp ${CAF_FIND_COMPONENTS}) # we use uppercase letters only for variable names string(TOUPPER "${comp}" UPPERCOMP) if ("${comp}" STREQUAL "core") set(HDRNAME "caf/all.hpp") elseif ("${comp}" STREQUAL "test") set(HDRNAME "caf/test/unit_test.hpp") else () set(HDRNAME "caf/${comp}/all.hpp") endif () if (CAF_ROOT_DIR) set(header_hints "${CAF_ROOT_DIR}/include" "${CAF_ROOT_DIR}/libcaf_${comp}" "${CAF_ROOT_DIR}/../libcaf_${comp}" "${CAF_ROOT_DIR}/../../libcaf_${comp}") endif () find_path(CAF_INCLUDE_DIR_${UPPERCOMP} NAMES ${HDRNAME} HINTS ${header_hints} /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INSTALL_PREFIX}/include ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}) mark_as_advanced(CAF_INCLUDE_DIR_${UPPERCOMP}) if (NOT "${CAF_INCLUDE_DIR_${UPPERCOMP}}" STREQUAL "CAF_INCLUDE_DIR_${UPPERCOMP}-NOTFOUND") # mark as found (set back to false when missing library or build header) set(CAF_${comp}_FOUND true) # check for CMake-generated build header for the core component if ("${comp}" STREQUAL "core") find_path(caf_build_header_path NAMES caf/detail/build_config.hpp HINTS ${header_hints} /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INSTALL_PREFIX}/include ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}) if ("${caf_build_header_path}" STREQUAL "caf_build_header_path-NOTFOUND") message(WARNING "Found all.hpp for CAF core, but not build_config.hpp") set(CAF_${comp}_FOUND false) else() list(APPEND CAF_INCLUDE_DIRS "${caf_build_header_path}") endif() endif() list(APPEND CAF_INCLUDE_DIRS "${CAF_INCLUDE_DIR_${UPPERCOMP}}") # look for (.dll|.so|.dylib) file, again giving hints for non-installed CAFs # skip probe_event as it is header only if (NOT ${comp} STREQUAL "probe_event" AND NOT ${comp} STREQUAL "test") if (CAF_ROOT_DIR) set(library_hints "${CAF_ROOT_DIR}/lib") endif () find_library(CAF_LIBRARY_${UPPERCOMP} NAMES "caf_${comp}" "caf_${comp}_static" HINTS ${library_hints} /usr/lib /usr/local/lib /opt/local/lib /sw/lib ${CMAKE_INSTALL_PREFIX}/lib ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR} ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/${CMAKE_BUILD_TYPE}) mark_as_advanced(CAF_LIBRARY_${UPPERCOMP}) if ("${CAF_LIBRARY_${UPPERCOMP}}" STREQUAL "CAF_LIBRARY_${UPPERCOMP}-NOTFOUND") set(CAF_${comp}_FOUND false) else () set(CAF_LIBRARIES ${CAF_LIBRARIES} ${CAF_LIBRARY_${UPPERCOMP}}) endif () endif () endif () endforeach () if (DEFINED CAF_INCLUDE_DIRS) list(REMOVE_DUPLICATES CAF_INCLUDE_DIRS) endif() if (NOT CAF_INCLUDE_DIR_CORE STREQUAL "CAF_INCLUDE_DIR_CORE-NOTFOUND") # read content of config.hpp file(READ "${CAF_INCLUDE_DIR_CORE}/caf/config.hpp" CONFIG_HPP) # get line containing the version string(REGEX MATCH "#define CAF_VERSION [0-9]+" VERSION_LINE "${CONFIG_HPP}") # extract version number from line string(REGEX MATCH "[0-9]+" VERSION_INT "${VERSION_LINE}") # calculate major, minor, and patch version math(EXPR CAF_VERSION_MAJOR "${VERSION_INT} / 10000") math(EXPR CAF_VERSION_MINOR "( ${VERSION_INT} / 100) % 100") math(EXPR CAF_VERSION_PATCH "${VERSION_INT} % 100") # create full version string set(CAF_VERSION "${CAF_VERSION_MAJOR}.${CAF_VERSION_MINOR}.${CAF_VERSION_PATCH}") if (NOT CAF_VERSION) unset(CAF_VERSION) message(WARNING "Unable to determine CAF version") endif () endif () # let CMake check whether all requested components have been found include(FindPackageHandleStandardArgs) find_package_handle_standard_args(CAF FOUND_VAR CAF_FOUND REQUIRED_VARS CAF_VERSION CAF_LIBRARIES CAF_INCLUDE_DIRS HANDLE_COMPONENTS) # final step to tell CMake we're done mark_as_advanced(CAF_ROOT_DIR CAF_VERSION CAF_LIBRARIES CAF_INCLUDE_DIRS) actor-framework-0.17.6/cmake/MSVC_v140_clang_c2.cmake000066400000000000000000000007451370662441400220610ustar00rootroot00000000000000## FLAGS FOR MSVC v140_clang_c2 set(CMAKE_CXX_FLAGS_DEBUG_INIT "/D_DEBUG /MTd /GR -Od -g2 -gdwarf-2 -std=c++1z -fms-extensions -fexceptions") set(CMAKE_CXX_FLAGS_MINSIZEREL_INIT "/MT /GR -O1 /D NDEBUG -std=c++1z -fms-extensions -fexceptions") set(CMAKE_CXX_FLAGS_RELEASE_INIT "/MT /GR -O3 /D NDEBUG -std=c++1z -fms-extensions -fexceptions") set(CMAKE_CXX_FLAGS_RELWITHDEBINFO_INIT "/MT /GR -O2 /D NDEBUG -gline-tables-only -std=c++1z -fms-extensions -fexceptions") actor-framework-0.17.6/cmake/build_config.hpp.in000066400000000000000000000033601370662441400215430ustar00rootroot00000000000000/****************************************************************************** * ____ _ _____ * * / ___| / \ | ___| C++ * * | | / _ \ | |_ Actor * * | |___ / ___ \| _| Framework * * \____/_/ \_|_| * * * * Copyright (C) 2011 - 2016 * * Dominik Charousset * * * * Distributed under the terms and conditions of the BSD 3-Clause License or * * (at your option) under the terms and conditions of the Boost Software * * License 1.0. See accompanying files LICENSE and LICENSE_ALTERNATIVE. * * * * If you did not receive a copy of the license files, see * * http://opensource.org/licenses/BSD-3-Clause and * * http://www.boost.org/LICENSE_1_0.txt. * ******************************************************************************/ #pragma once #include "caf/detail/log_level.hpp" // this header is auto-generated by CMake #define CAF_LOG_LEVEL CAF_LOG_LEVEL_@CAF_LOG_LEVEL@ #cmakedefine CAF_NO_MEM_MANAGEMENT #cmakedefine CAF_ENABLE_RUNTIME_CHECKS #cmakedefine CAF_NO_EXCEPTIONS #cmakedefine CAF_ENABLE_ACTOR_PROFILER #cmakedefine CAF_ENABLE_TYPE_ID_CHECKS actor-framework-0.17.6/cmake/caf-generate-enum-strings.cpp000066400000000000000000000074121370662441400234610ustar00rootroot00000000000000#include #include #include #include #include #include using std::cerr; using std::find; using std::find_if; using std::string; using std::vector; void trim(string& str) { auto not_space = [](char c) { return isspace(c) == 0; }; str.erase(str.begin(), find_if(str.begin(), str.end(), not_space)); str.erase(find_if(str.rbegin(), str.rend(), not_space).base(), str.end()); } template bool starts_with(const string& str, const char (&prefix)[N]) { return str.compare(0, N - 1, prefix) == 0; } template void drop_prefix(string& str, const char (&prefix)[N]) { if (str.compare(0, N - 1, prefix) == 0) str.erase(str.begin(), str.begin() + (N - 1)); } void keep_alnum(string& str) { auto not_alnum = [](char c) { return isalnum(c) == 0 && c != '_'; }; str.erase(find_if(str.begin(), str.end(), not_alnum), str.end()); } int main(int argc, char** argv) { if (argc != 3) { cerr << "wrong number of arguments.\n" << "usage: " << argv[0] << " input-file output-file\n"; return EXIT_FAILURE; } std::ifstream in{argv[1]}; if (!in) { cerr << "unable to open input file: " << argv[1] << '\n'; return EXIT_FAILURE; } vector namespaces; string enum_name; string line; bool is_enum_class = false; // Locate the beginning of the enum. for (;;) { if (!getline(in, line)) { cerr << "unable to locate enum in file: " << argv[1] << '\n'; return EXIT_FAILURE; } trim(line); if (starts_with(line, "enum ")) { drop_prefix(line, "enum "); if (starts_with(line, "class ")) { is_enum_class = true; drop_prefix(line, "class "); } trim(line); keep_alnum(line); enum_name = line; break; } if (starts_with(line, "namespace ")) { if (line.back() == '{') line.pop_back(); line.erase(line.begin(), find(line.begin(), line.end(), ' ')); trim(line); namespaces.emplace_back(line); } } // Sanity checking. if (namespaces.empty()) { cerr << "enum found outside of a namespace\n"; return EXIT_FAILURE; } if (enum_name.empty()) { cerr << "empty enum name found\n"; return EXIT_FAILURE; } std::ofstream out{argv[2]}; if (!out) { cerr << "unable to open output file: " << argv[2] << '\n'; return EXIT_FAILURE; } // Print file header. out << "// clang-format off\n" << "// DO NOT EDIT: " "this file is auto-generated by caf-generate-enum-strings.\n" "// Run the target update-enum-strings if this file is out of sync.\n" << "#include \"" << namespaces[0]; for (size_t i = 1; i < namespaces.size(); ++i) out << '/' << namespaces[i]; out << '/' << enum_name << ".hpp\"\n\n" << "#include \n\n" << "namespace " << namespaces[0] << " {\n"; for (size_t i = 1; i < namespaces.size(); ++i) out << "namespace " << namespaces[i] << " {\n"; out << "\nstd::string to_string(" << enum_name << " x) {\n" << " switch(x) {\n" << " default:\n" << " return \"???\";\n"; // Read until hitting the closing '}'. std::string case_label_prefix; if (is_enum_class) case_label_prefix = enum_name + "::"; for (;;) { if (!getline(in, line)) { cerr << "unable to read enum values\n"; return EXIT_FAILURE; } trim(line); if (line.empty()) continue; if (line[0] == '}') break; if (line[0] != '/') { keep_alnum(line); out << " case " << case_label_prefix << line << ":\n" << " return \"" << line << "\";\n"; } } // Done. Print file footer and exit. out << " };\n" << "}\n\n"; for (auto i = namespaces.rbegin(); i != namespaces.rend(); ++i) out << "} // namespace " << *i << '\n'; } actor-framework-0.17.6/cmake/check-consistency.cmake000066400000000000000000000005411370662441400224150ustar00rootroot00000000000000execute_process(COMMAND ${CMAKE_COMMAND} -E compare_files "${file_under_test}" "${generated_file}" RESULT_VARIABLE result) if(result EQUAL 0) # files still in sync else() message(SEND_ERROR "${file_under_test} is out of sync! Run target " "'update-enum-strings' to update automatically") endif() actor-framework-0.17.6/cmake/cmake_uninstall.cmake.in000066400000000000000000000017631370662441400225660ustar00rootroot00000000000000if (NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") message(FATAL_ERROR "Cannot find install manifest: \"@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt\"") endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) string(REGEX REPLACE "\n" ";" files "${files}") list(REVERSE files) foreach (file ${files}) message(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"") if (EXISTS "$ENV{DESTDIR}${file}") execute_process( COMMAND @CMAKE_COMMAND@ -E remove "$ENV{DESTDIR}${file}" OUTPUT_VARIABLE rm_out RESULT_VARIABLE rm_retval ) if(NOT ${rm_retval} EQUAL 0) message(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"") endif (NOT ${rm_retval} EQUAL 0) else (EXISTS "$ENV{DESTDIR}${file}") message(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.") endif (EXISTS "$ENV{DESTDIR}${file}") endforeach(file) actor-framework-0.17.6/cmake/get_compiler_version.cpp000066400000000000000000000004461370662441400227250ustar00rootroot00000000000000#include using namespace std; int main() { # ifdef __clang__ cout << __clang_major__ << "." << __clang_minor__; # elif defined(__GNUC__) cout << __GNUC__ << "." << __GNUC_MINOR__; # else cout << "0.0"; # endif return 0; } actor-framework-0.17.6/cmake/openssl-check.cpp000066400000000000000000000004501370662441400212400ustar00rootroot00000000000000#include #include #include #include int main() { long have = SSLeay(); long want = OPENSSL_VERSION_NUMBER; printf("have OpenSSL %lx, want %lx\n", have, want); if (have == want) return EXIT_SUCCESS; return EXIT_FAILURE; } actor-framework-0.17.6/configure000077500000000000000000000375701370662441400166420ustar00rootroot00000000000000#!/bin/sh # Convenience wrapper for easily viewing/setting options that # the project's CMake scripts will recognize. # check for `cmake` command type cmake > /dev/null 2>&1 || { echo "\ This package requires CMake, please install it first, then you may use this configure script to access CMake equivalent functionality.\ " >&2; exit 1; } command="$0 $*" dirname_0=`dirname $0` sourcedir=`cd $dirname_0 && pwd` usage="\ Usage: $0 [OPTION]... [VAR=VALUE]... Build Options: --generator=GENERATOR set CMake generator (see cmake --help) --build-type=TYPE set CMake build type [RelWithDebInfo]: - Debug: debugging flags enabled - MinSizeRel: minimal output size - Release: optimizations on, debugging off - RelWithDebInfo: release flags plus debugging --extra-flags=STRING additional compiler flags --build-dir=DIR place build files in directory [build] --bin-dir=DIR executable directory [build/bin] --lib-dir=DIR library directory [build/lib] --with-clang=FILE path to clang++ executable --with-gcc=FILE path to g++ executable --with-qt-prefix=PATH prefix path for Qt5 cmake modules --with-openssl=PATH path to OpenSSL library and headers --dual-build build using both gcc and clang --build-static build as static and shared library --build-static-only build as static library only --static-runtime build with static C++ runtime --more-warnings enables most warnings --no-compiler-check disable compiler version check --no-auto-libc++ do not automatically enable libc++ for Clang --no-exceptions do not catch exceptions in CAF --force-no-exceptions build CAF with '-fno-exceptions' --warnings-as-errors build with '-Werror' --with-ccache use ccache to improve build performance Opt-in Features: --enable-type-id-checks raise errors when sending types without type IDs Optional Targets: --with-qt-examples build Qt example(s) --with-protobuf-examples build Google Protobuf example(s) Installation Directories: --prefix=PREFIX installation directory [/usr/local] Remove Standard Features (even if all dependencies are available): --no-memory-management build without memory management --no-examples build without examples --no-curl-examples build without libcurl examples --no-unit-tests build without unit tests --no-opencl build without OpenCL module --no-openssl build without OpenSSL module --no-tools build without CAF tools such as caf-run --no-io build without I/O module --no-python build without python binding --no-summary do not print configuration before building --libs-only sets no-examples, no-tools, no-python, and no-unit-tests --core-only same as libs-only but also adds sets no-opencl, no-openssl, and no-io Debugging: --with-runtime-checks build with requirement checks at runtime --with-log-level=LVL build with debugging output, possible values: - ERROR - WARNING - INFO - DEBUG - TRACE --with-address-sanitizer build with address sanitizer if available --with-asan alias for --with-address-sanitier --enable-asan alias for --with-address-sanitier --with-gcov build with gcov coverage enabled --with-actor-profiler enables the (experimental) actor_profiler API Convenience options: --dev-mode sets --build-type=debug, --no-examples, --no-tools, --with-runtime-checks, --log-level=trace, --enable-asan, and --enable-type-id-checks Influential Environment Variables (only on first invocation): CXX C++ compiler command CXXFLAGS C++ compiler flags (overrides defaults) LDFLAGS Additional linker flags CMAKE_GENERATOR Selects a custom generator Python Build Options: --with-python-config=FILE Use python-conf binary to determine includes and libs iOS Build Options (should be used with XCode generator): --sysroot=DIR set system root for Clang - iphoneos: for iOS device - iphonesimulator: for iOS simulator --ios-min-ver=VERSION set the ios deployment target version " # Appends a CMake cache entry definition to the CMakeCacheEntries variable. # $1 is the cache entry variable name # $2 is the cache entry variable type # $3 is the cache entry variable value append_cache_entry () { case "$3" in *\ * ) # string contains whitespace CMakeCacheEntries="$CMakeCacheEntries -D \"$1:$2=$3\"" ;; *) # string contains whitespace CMakeCacheEntries="$CMakeCacheEntries -D $1:$2=$3" ;; esac } # Creates a build directory via CMake. # $1 is the path to a compiler executable. # $2 is the suffix of the build directory. # $3 is the executable output path. # $4 is the library output path. # $5 is the CMake generator. configure () { CMakeCacheEntries=$CMakeDefaultCache if [ -n "$1" ]; then append_cache_entry CMAKE_CXX_COMPILER FILEPATH $1 fi case "$builddir" in /*) #absolute path given absolute_builddir="$builddir" ;; *) # relative path given; convert to absolute path absolute_builddir="$PWD/$builddir" ;; esac if [ -n "$2" ]; then workdir="$absolute_builddir-$2" else workdir="$absolute_builddir" fi workdirs="$workdirs $workdir" if [ -n "$3" ]; then append_cache_entry EXECUTABLE_OUTPUT_PATH PATH "$3" else append_cache_entry EXECUTABLE_OUTPUT_PATH PATH "$workdir/bin" fi if [ -n "$4" ]; then append_cache_entry LIBRARY_OUTPUT_PATH PATH "$4" else append_cache_entry LIBRARY_OUTPUT_PATH PATH "$workdir/lib" fi if [ -d "$workdir" ]; then # If a build directory exists, check if it has a CMake cache. if [ -f "$workdir/CMakeCache.txt" ]; then # If the CMake cache exists, delete it so that this configuration # is not tainted by a previous one. rm -f "$workdir/CMakeCache.txt" fi else mkdir -p "$workdir" fi cd "$workdir" if [ -n "$5" ]; then cmake -G "$5" $CMakeCacheEntries "$sourcedir" else cmake $CMakeCacheEntries "$sourcedir" fi printf "#!/bin/sh\n\n" > config.status printf "# Switch to the source of this build directory.\n" >> config.status printf "cd \"$sourcedir\"\n\n" >> config.status printf "# Invoke the command to configure this build.\n" >> config.status if [ -n "$CC" ]; then printf "CC=\"%s\"\n" "$CC" >> config.status fi if [ -n "$CXX" ]; then printf "CXX=\"%s\"\n" "$CXX" >> config.status fi if [ -n "$CXXFLAGS" ]; then printf "CXXFLAGS=\"%s\"\n" "$CXXFLAGS" >> config.status fi if [ -n "$LDFLAGS" ]; then printf "LDFLAGS=\"%s\"\n" "$LDFLAGS" >> config.status fi echo $command >> config.status chmod u+x config.status } # Set defaults. builddir="$sourcedir/build" CMakeCacheEntries="" append_cache_entry CMAKE_INSTALL_PREFIX PATH /usr/local append_cache_entry CAF_ENABLE_RUNTIME_CHECKS BOOL false # parse custom environment variable to initialize CMakeGenerator if [ -n "$CMAKE_GENERATOR" ]; then CMakeGenerator="$CMAKE_GENERATOR" fi # Parse arguments. while [ $# -ne 0 ]; do case "$1" in -*=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;; *) optarg= ;; esac case "$1" in --help|-h) echo "${usage}" 1>&2 exit 1 ;; --generator=*) CMakeGenerator="$optarg" ;; --prefix=*) append_cache_entry CMAKE_INSTALL_PREFIX PATH "$optarg" ;; --with-runtime-checks) append_cache_entry CAF_ENABLE_RUNTIME_CHECKS BOOL yes ;; --with-address-sanitizer) append_cache_entry CAF_ENABLE_ADDRESS_SANITIZER BOOL yes ;; --with-asan) append_cache_entry CAF_ENABLE_ADDRESS_SANITIZER BOOL yes ;; --enable-asan) append_cache_entry CAF_ENABLE_ADDRESS_SANITIZER BOOL yes ;; --enable-type-id-checks) append_cache_entry CAF_ENABLE_TYPE_ID_CHECKS BOOL yes ;; --with-gcov) append_cache_entry CAF_ENABLE_GCOV BOOL yes ;; --with-actor-profiler) append_cache_entry CAF_ENABLE_ACTOR_PROFILER BOOL yes ;; --no-memory-management) append_cache_entry CAF_NO_MEM_MANAGEMENT BOOL yes ;; --more-warnings) append_cache_entry CAF_MORE_WARNINGS BOOL yes ;; --no-compiler-check) append_cache_entry CAF_NO_COMPILER_CHECK BOOL yes ;; --no-auto-libc++) append_cache_entry CAF_NO_AUTO_LIBCPP BOOL yes ;; --no-exceptions) append_cache_entry CAF_NO_EXCEPTIONS BOOL yes ;; --force-no-exceptions) append_cache_entry CAF_NO_EXCEPTIONS BOOL yes append_cache_entry CAF_FORCE_NO_EXCEPTIONS BOOL yes ;; --warnings-as-errors) append_cache_entry CAF_CXX_WARNINGS_AS_ERRORS BOOL yes ;; --with-ccache) append_cache_entry CAF_USE_CCACHE BOOL yes ;; --sysroot=*) append_cache_entry CAF_OSX_SYSROOT PATH "$optarg" ;; --ios-min-ver=*) append_cache_entry CMAKE_OSX_ARCHITECTURES STRING "\$(ARCHS_STANDARD_32_64_BIT)" append_cache_entry CAF_IOS_DEPLOYMENT_TARGET STRING "$optarg" ;; --with-log-level=*) append_cache_entry CAF_LOG_LEVEL STRING "$optarg" ;; --with-clang=*) clang="$optarg" ;; --with-gcc=*) gcc="$optarg" ;; --with-qt-prefix=*) append_cache_entry CAF_QT_PREFIX_PATH STRING "$optarg" ;; --with-openssl=*) append_cache_entry OPENSSL_ROOT_DIR PATH "$optarg" ;; --build-type=*) append_cache_entry CMAKE_BUILD_TYPE STRING "$optarg" ;; --extra-flags=*) append_cache_entry EXTRA_FLAGS STRING "$optarg" ;; --build-dir=*) builddir="$optarg" ;; --bin-dir=*) bindir="$optarg" ;; --lib-dir=*) libdir="$optarg" ;; --dual-build) dualbuild=1 ;; --no-examples) append_cache_entry CAF_NO_EXAMPLES BOOL yes ;; --with-qt-examples) append_cache_entry CAF_BUILD_QT_EXAMPLES BOOL yes ;; --with-protobuf-examples) append_cache_entry CAF_BUILD_PROTOBUF_EXAMPLES BOOL yes ;; --no-curl-examples) append_cache_entry CAF_NO_CURL_EXAMPLES BOOL yes ;; --no-unit-tests) append_cache_entry CAF_NO_UNIT_TESTS BOOL yes ;; --no-opencl) append_cache_entry CAF_NO_OPENCL BOOL yes ;; --no-openssl) append_cache_entry CAF_NO_OPENSSL BOOL yes ;; --build-static) append_cache_entry CAF_BUILD_STATIC BOOL yes ;; --build-static-only) append_cache_entry CAF_BUILD_STATIC_ONLY BOOL yes ;; --static-runtime) append_cache_entry CAF_BUILD_STATIC_RUNTIME BOOL yes ;; --with-python-config=*) append_cache_entry CAF_PYTHON_CONFIG_BIN FILEPATH "$optarg" ;; --no-tools) append_cache_entry CAF_NO_TOOLS BOOL yes ;; --no-io) append_cache_entry CAF_NO_IO BOOL yes ;; --no-python) append_cache_entry CAF_NO_PYTHON BOOL yes ;; --no-summary) append_cache_entry CAF_NO_SUMMARY BOOL yes ;; --libs-only) for var in CAF_NO_TOOLS CAF_NO_PYTHON CAF_NO_EXAMPLES CAF_NO_UNIT_TESTS; do append_cache_entry $var BOOL yes done ;; --core-only) for var in CAF_NO_TOOLS CAF_NO_PYTHON CAF_NO_EXAMPLES CAF_NO_UNIT_TESTS CAF_NO_IO CAF_NO_OPENCL CAF_NO_OPENSSL ; do append_cache_entry $var BOOL yes done ;; --dev-mode) append_cache_entry CMAKE_BUILD_TYPE STRING Debug append_cache_entry CAF_NO_EXAMPLES BOOL yes append_cache_entry CAF_NO_TOOLS BOOL yes append_cache_entry CAF_LOG_LEVEL STRING TRACE append_cache_entry CAF_ENABLE_RUNTIME_CHECKS BOOL yes append_cache_entry CAF_ENABLE_ADDRESS_SANITIZER BOOL yes append_cache_entry CAF_ENABLE_TYPE_ID_CHECKS BOOL yes ;; # "overloads" for forward compatibility with new 0.18 disable-* syntax --disable-memory-management) append_cache_entry CAF_NO_MEM_MANAGEMENT BOOL yes ;; --disable-compiler-check) append_cache_entry CAF_NO_COMPILER_CHECK BOOL yes ;; --disable-auto-libc++) append_cache_entry CAF_NO_AUTO_LIBCPP BOOL yes ;; --disable-exceptions) append_cache_entry CAF_NO_EXCEPTIONS BOOL yes ;; --disable-examples) append_cache_entry CAF_NO_EXAMPLES BOOL yes ;; --disable-curl-examples) append_cache_entry CAF_NO_CURL_EXAMPLES BOOL yes ;; --disable-testing) append_cache_entry CAF_NO_UNIT_TESTS BOOL yes ;; --disable-opencl) append_cache_entry CAF_NO_OPENCL BOOL yes ;; --disable-openssl) append_cache_entry CAF_NO_OPENSSL BOOL yes ;; --disable-tools) append_cache_entry CAF_NO_TOOLS BOOL yes ;; --disable-io) append_cache_entry CAF_NO_IO BOOL yes ;; --disable-python) append_cache_entry CAF_NO_PYTHON BOOL yes ;; --disable-summary) append_cache_entry CAF_NO_SUMMARY BOOL yes ;; *) echo "Invalid option '$1'. Try $0 --help to see available options." exit 1 ;; esac shift done # At this point we save the global CMake variables so that configure() can # later use them. CMakeDefaultCache=$CMakeCacheEntries if [ -n "$dualbuild" ]; then # Use what we got in $PATH if --with-clang or --with-gcc is not specified. if [ -z "$clang" ]; then clang=clang++ fi if [ -z "$gcc" ]; then gcc=g++ fi for i in gcc clang; do eval "compiler=\$$i" configure $compiler $i "" "" $CMakeGenerator done else # Prefer Clang to GCC. if [ -n "$clang" ]; then compiler=$clang elif [ -n "$gcc" ]; then compiler=$gcc fi configure "$compiler" "" "$bindir" "$libdir" "$CMakeGenerator" fi actor-framework-0.17.6/doc/000077500000000000000000000000001370662441400154645ustar00rootroot00000000000000actor-framework-0.17.6/doc/CMakeLists.txt000066400000000000000000000014331370662441400202250ustar00rootroot00000000000000add_custom_target(doc) # -- process .in files --------------------------------------------------------- configure_file("cmake/Doxyfile.in" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" @ONLY) # -- Doxygen setup ------------------------------------------------------------- find_package(Doxygen) if(NOT DOXYGEN_FOUND) message(STATUS "Doxygen not found, skip building API documentation.") else() message(STATUS "Add optional target: doxygen.") add_custom_target(doxygen "${DOXYGEN_EXECUTABLE}" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" COMMENT "Generating API documentation with Doxygen" VERBATIM) add_dependencies(doc doxygen) endif() actor-framework-0.17.6/doc/cmake/000077500000000000000000000000001370662441400165445ustar00rootroot00000000000000actor-framework-0.17.6/doc/cmake/Doxyfile.in000066400000000000000000003247671370662441400207020ustar00rootroot00000000000000# Doxyfile 1.8.16 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = CAF # 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 = @CAF_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 = # 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 = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = 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 # 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 = 2 # 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 = "experimental=@attention This feature is **experimental**." # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is # Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = C++ # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = NO # 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 #--------------------------------------------------------------------------- # 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 = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = 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 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 = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = NO # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = 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 = YES # 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 = YES # 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 = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = YES # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # 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 = "@CMAKE_HOME_DIRECTORY@/libcaf_core/caf" \ "@CMAKE_HOME_DIRECTORY@/libcaf_io/caf" # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = "*.[hc]pp" # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = "@CMAKE_HOME_DIRECTORY@/examples" # 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 = "*.cpp" # 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 = YES # 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 = "@CMAKE_HOME_DIRECTORY@/doc/png/" # 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 = NO #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via Javascript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have Javascript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 1 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = 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/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # 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/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 # , /