Showing preview only (502K chars total). Download the full file or copy to clipboard to get everything.
Repository: tearshark/librf
Branch: master
Commit: 52c11affc41c
Files: 95
Total size: 450.3 KB
Directory structure:
gitextract_aarctyfv/
├── .github/
│ └── workflows/
│ └── cmake.yml
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── Config.cmake.in
├── Doxyfile
├── LICENSE
├── README.md
├── asio/
│ ├── asio_task.h
│ ├── asio_task_1.10.0.inl
│ ├── asio_task_1.12.0.inl
│ └── asio_task_1.12.2.inl
├── benchmark/
│ ├── CMakeLists.txt
│ ├── benchmark_asio_echo.cpp
│ ├── benchmark_async_mem.cpp
│ └── benchmark_channel_passing_next.cpp
├── cmake/
│ ├── SelectDynamicLibrary.cmake
│ └── install.cmake
├── config.h.in
├── gcc_bugs.cpp
├── include/
│ └── librf/
│ ├── librf.h
│ ├── librf_macro.h
│ └── src/
│ ├── _awaker.h
│ ├── awaitable.h
│ ├── channel.h
│ ├── channel_v2.h
│ ├── channel_v2.inl
│ ├── config.h
│ ├── counted_ptr.h
│ ├── current_scheduler.h
│ ├── def.h
│ ├── event.h
│ ├── event_v2.h
│ ├── event_v2.inl
│ ├── exception.inl
│ ├── future.h
│ ├── generator.h
│ ├── intrusive_link_queue.h
│ ├── macro_def.inl
│ ├── mutex.h
│ ├── mutex_v2.h
│ ├── mutex_v2.inl
│ ├── promise.h
│ ├── promise.inl
│ ├── rf_task.h
│ ├── ring_queue.h
│ ├── scheduler.h
│ ├── sleep.h
│ ├── spinlock.h
│ ├── state.h
│ ├── state.inl
│ ├── stop_token.h
│ ├── switch_scheduler.h
│ ├── timer.h
│ ├── type_concept.inl
│ ├── type_traits.inl
│ ├── unix/
│ │ ├── clang_builtin.h
│ │ ├── coroutine.h
│ │ └── gcc_builtin.h
│ ├── when.h
│ ├── when_v2.h
│ ├── without_deadlock_assemble.inl
│ └── yield.h
├── source/
│ ├── event_v2.cpp
│ ├── mutex_v2.cpp
│ ├── rf_task.cpp
│ ├── scheduler.cpp
│ ├── sleep.cpp
│ ├── state.cpp
│ ├── timer.cpp
│ └── when_v2.cpp
├── test_librf.cpp
└── tutorial/
├── CMakeLists.txt
├── test_async_cb.cpp
├── test_async_channel.cpp
├── test_async_channel_mult_thread.cpp
├── test_async_dynamic_go.cpp
├── test_async_event.cpp
├── test_async_event_timeout.cpp
├── test_async_event_v2.cpp
├── test_async_exception.cpp
├── test_async_memory_layout.cpp
├── test_async_modern_cb.cpp
├── test_async_multi_thread.cpp
├── test_async_mutex.cpp
├── test_async_resumable.cpp
├── test_async_routine.cpp
├── test_async_sleep.cpp
├── test_async_stop_token.cpp
├── test_async_suspend_always.cpp
├── test_async_switch_scheduler.cpp
├── test_async_timer.cpp
├── test_async_when_all.cpp
├── test_async_yield_return.cpp
└── test_memory_leak.cpp
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/workflows/cmake.yml
================================================
name: CMake
on: [push]
env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Release
jobs:
build:
# The CMake configure and build commands are platform agnostic and should work equally
# well on Windows or Mac. You can convert this to a matrix build if you need
# cross-platform coverage.
# See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Create Build Environment
# Some projects don't allow in-source building, so create a separate build directory
# We'll use this as our working directory for all subsequent commands
run: cmake -E make_directory ${{github.workspace}}/build
- name: Configure CMake
# Use a bash shell so we can use the same syntax for environment variable
# access regardless of the host operating system
shell: bash
working-directory: ${{github.workspace}}/build
# Note the current convention is to use the -S and -B options here to specify source
# and build directories, but this is only available with CMake 3.13 and higher.
# The CMake binaries on the Github Actions machines are (as of this writing) 3.12
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
- name: Build
working-directory: ${{github.workspace}}/build
shell: bash
# Execute the build. You can specify a specific target with "--target <NAME>"
run: cmake --build . --config $BUILD_TYPE
#- name: Test
# working-directory: ${{github.workspace}}/build
# shell: bash
# Execute tests defined by the CMake configuration.
# See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
# run: ctest -C $BUILD_TYPE
================================================
FILE: .gitignore
================================================
################################################################################
# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
################################################################################
/vs_proj/x64
/vs_proj/.vs
/vs_proj/librf.vcxproj.user
/.vs
/vs_proj/Release
/vs_proj/Debug
private
bin
out
/CMakeSettings.json
install
lib
================================================
FILE: .gitmodules
================================================
[submodule "modern_cb"]
path = modern_cb
url = https://github.com/tearshark/modern_cb.git
================================================
FILE: CMakeLists.txt
================================================
cmake_minimum_required(VERSION 3.10)
project(librf VERSION 3.0)
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED true)
set(LIBRF_COMPILER_SETTING )
if(WIN32)
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
set(LIBRF_COMPILER_SETTING "clang_on_msvc")
elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
set(LIBRF_COMPILER_SETTING "msvc")
else()
set(LIBRF_COMPILER_SETTING "gcc")
endif()
elseif(APPLE)
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "AppleClang")
set(LIBRF_COMPILER_SETTING "clang")
else()
set(LIBRF_COMPILER_SETTING "gcc")
endif()
elseif(UNIX)
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
set(LIBRF_COMPILER_SETTING "clang")
else()
set(LIBRF_COMPILER_SETTING "gcc")
endif()
else()
set(LIBRF_COMPILER_SETTING "clang")
endif()
message(STATUS "LIBRF_COMPILER_SETTING=${LIBRF_COMPILER_SETTING}")
message(STATUS "CMAKE_CXX_COMPILER_VERSION=${CMAKE_CXX_COMPILER_VERSION}")
if(${LIBRF_COMPILER_SETTING} STREQUAL "msvc")
if (${CMAKE_CXX_COMPILER_VERSION} VERSION_GREATER_EQUAL "19.30.0.0")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++20 /EHsc") #VS2022
else()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++latest /EHsc /await") #VS2019
endif()
elseif ("${LIBRF_COMPILER_SETTING}" STREQUAL "clang_on_msvc")
if (${CMAKE_CXX_COMPILER_VERSION} VERSION_GREATER_EQUAL "12.0.0")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++20 /EHsc -Wno-unused-private-field") #VS2022
else()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++latest /EHsc -Wno-unused-private-field") #VS2019
endif()
elseif ("${LIBRF_COMPILER_SETTING}" STREQUAL "clang")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++2a -fcoroutines-ts -stdlib=libstdc++")
elseif ("${LIBRF_COMPILER_SETTING}" STREQUAL "gcc")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++2a -fcoroutines -fconcepts-diagnostics-depth=8")
endif()
option(LIBRF_DEBUG_COUNTER "Debug objects count" OFF)
option(LIBRF_KEEP_REAL_SIZE "Keep real size in queue" OFF)
option(LIBRF_DISABLE_MULT_THREAD "Disable multi-threaded scheduler" OFF)
option(LIBRF_USE_MIMALLOC "Use mimalloc" OFF)
option(LIBRF_DYNAMIC_LIBRARY "Use shared library" ON)
option(CMAKE_ENABLE_UNIT_TEST "Enable unit test" OFF)
if (UNIX)
if(LIBRF_USE_MIMALLOC)
find_package(mimalloc 1.4 REQUIRED)
endif()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC -pthread")
endif()
if(${LIBRF_COMPILER_SETTING} STREQUAL "msvc")
set(CMAKE_CXX_FLAGS_MINSIZEREL "/W3 /WX /MP /GS- /Gm- /Ox /Ob2 /Oy /Oi /Os /GT /EHsc /Zc:inline")
set(CMAKE_CXX_FLAGS_RELEASE "/W3 /WX /MP /GS- /Gm- /Ox /Ob2 /Oy /Oi /Os /GT /EHsc /Zc:inline")
elseif ("${LIBRF_COMPILER_SETTING}" STREQUAL "clang_on_msvc")
set(CMAKE_CXX_FLAGS_MINSIZEREL "/W3 /GS- /Ox /Ob2 /Oy /Oi /Os /EHsc /Zc:inline")
set(CMAKE_CXX_FLAGS_RELEASE "/W3 /GS- /Ox /Ob2 /Oy /Oi /Os /EHsc /Zc:inline")
elseif()
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -ggdb")
else()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -DNDEBUG")
endif()
endif()
message(STATUS "C++ flags: ${CMAKE_CXX_FLAGS}")
#set(RESUMEF_USE_CUSTOM_SPINLOCK "std::mutex")
if(LIBRF_DEBUG_COUNTER)
set(RESUMEF_DEBUG_COUNTER 1)
endif()
if(LIBRF_KEEP_REAL_SIZE)
set(_WITH_LOCK_FREE_Q_KEEP_REAL_SIZE 1)
endif()
if(LIBRF_DISABLE_MULT_THREAD)
set(RESUMEF_DISABLE_MULT_THREAD 1)
endif()
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/config.h.in
${CMAKE_CURRENT_SOURCE_DIR}/include/librf/src/config.h
)
file(GLOB_RECURSE HEADER_FILES ${CMAKE_CURRENT_SOURCE_DIR}/include/*.*)
file(GLOB_RECURSE SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/source/*.*)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
if(LIBRF_DYNAMIC_LIBRARY)
add_library(${PROJECT_NAME} SHARED
${HEADER_FILES}
${SOURCE_FILES}
)
target_compile_definitions(${PROJECT_NAME}
PRIVATE LIBRF_DYNAMIC_EXPORTS=1
)
else()
add_library(${PROJECT_NAME} STATIC
${HEADER_FILES}
${SOURCE_FILES}
)
target_compile_definitions(${PROJECT_NAME}
PRIVATE LIBRF_USE_STATIC_LIBRARY=1
)
endif()
target_include_directories(${PROJECT_NAME}
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/modern_cb
)
if(UNIX)
set_target_properties(${PROJECT_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN/")
endif(UNIX)
if(LIBRF_USE_MIMALLOC)
set(LIB_MIMALLOC, "mimalloc")
else()
set(LIB_MIMALLOC, "")
endif()
if(CMAKE_ENABLE_UNIT_TEST)
add_subdirectory(tutorial)
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/tutorial ALL_TUTORIAL_FILES)
add_executable(test_librf
${CMAKE_CURRENT_SOURCE_DIR}/test_librf.cpp
${CMAKE_CURRENT_SOURCE_DIR}/benchmark/benchmark_async_mem.cpp
${CMAKE_CURRENT_SOURCE_DIR}/benchmark/benchmark_channel_passing_next.cpp
${ALL_TUTORIAL_FILES})
target_link_libraries(test_librf PUBLIC librf)
if(UNIX)
set_target_properties(test_librf PROPERTIES INSTALL_RPATH "$ORIGIN/")
endif(UNIX)
add_subdirectory(benchmark)
endif()
include(${CMAKE_SOURCE_DIR}/cmake/install.cmake)
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/librf DESTINATION include)
================================================
FILE: Config.cmake.in
================================================
include(${CMAKE_CURRENT_LIST_DIR}/SelectDynamicLibrary.cmake)
select_dynamic_library(librf librf/librf.h)
================================================
FILE: Doxyfile
================================================
# Doxyfile 1.8.17
# 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 = librf
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# 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 = .\doxygen
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = Chinese
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all generated output in the proper direction.
# Possible values are: None, LTR, RTL and Context.
# The default value is: None.
OUTPUT_TEXT_DIRECTION = None
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = 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 = NO
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
# /***************
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
# Javadoc-style will behave just like regular comments and it will not be
# interpreted by doxygen.
# The default value is: NO.
JAVADOC_BANNER = 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 = 4
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines (in the resulting output). You can put ^^ in the value part of an
# alias to insert a newline as if a physical newline was in the original file.
# When you need a literal { or } or , in the value part of an alias you have to
# escape them by means of a backslash (\), this can lead to conflicts with the
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
# sources only. Doxygen will then generate output that is more tailored for that
# language. For instance, namespaces will be presented as modules, types will be
# separated into more groups, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_SLICE = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is
# Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See https://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 5
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = 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 = YES
# 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 = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = YES
# 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
# declarations. If set to NO, these declarations will be included in the
# documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = YES
# 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 = NO
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation. If
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# 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 = .\librf\src
# 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 (to be provided as doxygen C comment),
# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd,
# *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.java \
*.idl \
*.ddl \
*.odl \
*.h \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.doc \
*.txt \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f \
*.for \
*.tcl \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.ice \
*.inl
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = channel_v1.h \
event_v1.h \
mutex_v1.h \
ring_queue.h \
ring_queue_lockfree.h \
ring_queue_spinlock.h \
intrusive_link_queue.h
# 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 =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see https://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
# were built. This is equivalent to specifying the "-p" option to a clang tool,
# such as clang-check. These options will then be passed to the parser.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via JavaScript. If disabled, the navigation index will
# consists of multiple levels of tabs that are statically embedded in every HTML
# page. Disable this option to support browsers that do not have JavaScript,
# like the Qt help browser.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_MENUS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: https://developer.apple.com/xcode/), introduced with OSX
# 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
# genXcode/_index.html for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
# to create new LaTeX commands to be used in formulas as building blocks. See
# the section "Including formulas" for details.
FORMULA_MACROFILE =
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# https://www.mathjax.org) which uses client side JavaScript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/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 <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using JavaScript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. 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).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
# with syntax highlighting in the RTF output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages 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: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = DOXYGEN_SKIP_PROPERTY
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be
# listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.
PLANTUML_JAR_PATH =
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2017 lanzhengpeng
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
# librf 2.9.10
### librf - 协程库
* librf是一个基于C++20 coroutines编写的无栈协程库。
支持以下平台和编译器:
Windows: 使用VS2017/VS2019编译(clang在兼容msvc模式下不支持异常，不再支持clang)
Android: 使用NDK 20.1 自带的clang编译
Mac: 使用XCode 11.2.1 自带的apple-clang编译
Ubuntu: 使用GCC 11.2/clang 14 编译（2020-04-18：mutex ranged lock failed）
注意：GCC 10.0.1在C++ Coroutines上依然存在很多BUG。
当前阶段不推荐使用GCC(version 11.2以下)。
<br>
* 性能测试
本来无意搞性能测试的，因为librf的初衷和设计目标，就不是为了性能。然而，随着C++ Coroutines进入C++ 20标准，类似的协程库也越来越多。得益于C++ Coroutines的优良设计，他们的这些协程库都把性能放在首要位置进行宣传。裹挟着我也不得不进行一番性能调优，以及测试。
以下数据全是平局每个操作的时间开销。
| 编译器 | 操作系统 | [mimalloc](https://github.com/microsoft/mimalloc) | 多线程 | 创建*1 | 切换*1 | 创建*1000 | 切换*1000 | 创建*30000 | 切换*30000 |
| :----: | :----------- | :-----------------------------------------------: | :----: | :----: | :----: | :-------: | :-------: | :--------: | :--------: |
| clang | Windows10 | ON | OFF | 500 ns | 17 ns | 101 ns | **11 ns** | 90 ns | 12 ns |
| clang | Windows10 | **ON** | **ON** | 500 ns | 37 ns | 116 ns | **18 ns** | 103 ns | 20 ns |
| clang | Windows10 | OFF | OFF | 800 ns | 16 ns | 208 ns | **11 ns** | 186 ns | 15 ns |
| clang | Windows10 | OFF | ON | 900 ns | 37 ns | 240 ns | **18 ns** | 203 ns | 23 ns |
| clang | Ubuntu 20.04 | ON | OFF | 400 ns | 15 ns | 112 ns | **11 ns** | 108 ns | 12 ns |
| clang | Ubuntu 20.04 | **ON** | **ON** | 500 ns | 31 ns | 111 ns | **16 ns** | 109 ns | 17 ns |
| clang | Ubuntu 20.04 | OFF | OFF | 400 ns | 15 ns | 133 ns | **13 ns** | 149 ns | 15 ns |
| clang | Ubuntu 20.04 | OFF | ON | 500 ns | 30 ns | 140 ns | **17 ns** | 141 ns | 19 ns |
(测试环境：I7 8700K OC 4.3GHz，频率由于酷睿原因不是特别稳定)
多线程：调度器是否开启多线程支持。由于调度器里频繁用到自旋锁，导致在这种测试中数据较为难看。
创建*1：创建 1 个协程的平均开销；
切换*1：在只有 1 个协程的时候，切换 3000000 次的平均开销；
创建*1000：创建 1000 个协程的平均开销；
切换*1000：在具有 1000 个协程的时候，切换 3000000 次的平均开销；
创建*30000：创建 30000 个协程的平均开销；
切换*30000：在具有 30000 个协程的时候，切换 3000000 次的平均开销；
加粗的字，表示那一项应该是常规状态下的状态，具有较大参考价值。
<br>
* librf有以下特点：
```
1.基于C++20提案'Stackless Resumable Functions'编写的非对称stackless协程库，可以以同步的方式编写简单的代码，同时获得异步的性能
2.理论上支持海量协程, 创建 **10,000,000** 个协程只需使用 **2.2G** 物理内存(使用clang编译)
3.拥有极小的协程调度开销，在I7 8100 3.6GHz的CPU上，**1000** 个协程的平均切换开销是 **27** 纳秒(使用clang编译)
4.提供协程锁(mutex), 定时器, channel, event等特性, 帮助用户更加容易地编写程序
5.可以很好的跟asio, libuv等库结合，能跟现有的callback范式的异步/延迟代码很好的结合
6.目前已处于较为完善状态，已经小规模在生产项目中使用。不出意外，2.8以上版本就是C++20 Coroutines对应的版本
```
<br>
* 如果你发现了任何bug、有好的建议、或使用上有不明之处，可以提交到issue，也可以直接联系作者:
email: tearshark@163.net
QQ交流群: 296561497
<br>
* 更新日志：
2020-06-20 更新：
```
性能调优和测试数据
```
2020-03-31 更新：
使用Doxygen自动生成文档，并完善文档内容。
支持cmake。(目前仅VS2019测试通过)。
2020-03-26 更新：
兼容xcode 11.2.1。
2020-03-18 更新：
更新event/mutex/when_all/when_any实现。至此，2.x版本完整恢复1.x版本的所有功能。
版本号提升至 2.8.0。
3.0之前，只打算做修复BUG相关的工作。
3.0的目标，是根据executor的设计，重写scheduler代码。
2020-03-08 更新：
更新channel实现，效率提高了近三倍。
channel的新的实现方法，为event/mutex指明了新的修改方向。
2020-02-16 更新：
更新调度器算法，深入应用Coroutines的特性，以期获得更高调度性能。
不再支持C++14。
* 注一：doc目录下有作者搜集的一些关于C++协程的资料
* 注二：tutorial目录下有针对每个特性的范例代码，让用户可以循序渐进的了解librf库的特性
================================================
FILE: asio/asio_task.h
================================================
#pragma once
#if ASIO_VERSION >= 101202
#include "asio_task_1.12.2.inl"
#elif ASIO_VERSION >= 101200
#include "asio_task_1.12.0.inl"
#else
#include "asio_task_1.10.0.inl"
#endif
================================================
FILE: asio/asio_task_1.10.0.inl
================================================
#include <memory>
#include "asio/detail/push_options.hpp"
namespace asio {
template<typename Allocator = std::allocator<int> >
class rf_task_t
{
public:
typedef Allocator allocator_type;
constexpr rf_task_t() {}
explicit rf_task_t(const Allocator& allocator) : allocator_(allocator) {}
template<typename OtherAllocator>
rf_task_t<OtherAllocator> operator[](const OtherAllocator& allocator) const {
return rf_task_t<OtherAllocator>(allocator);
}
allocator_type get_allocator() const { return allocator_; }
private:
Allocator allocator_;
};
constexpr rf_task_t<> rf_task;
namespace detail {
template<typename T>
class promise_handler
{
public:
using result_type_t = T;
using state_type = librf::state_t<result_type_t>;
template<typename Allocator>
promise_handler(const rf_task_t<Allocator> &)
: state_(state_type::typename _Alloc_state<state_type>(true))
{
}
void operator()(T t) const
{
state_->set_value(std::move(t));
}
void operator()(const asio::error_code& ec, T t) const
{
if (!ec)
{
state_->set_value(std::move(t));
}
else
{
state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
}
librf::counted_ptr<state_type> state_;
};
template<>
class promise_handler<void>
{
public:
using result_type_t = void;
using state_type = librf::state_t<result_type_t>;
template<typename Allocator>
promise_handler(const rf_task_t<Allocator> &)
: state_(state_type::typename _Alloc_state<state_type>(true))
{
}
void operator()() const
{
state_->set_value();
}
void operator()(const asio::error_code& ec) const
{
if (!ec)
{
state_->set_value();
}
else
{
state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
}
librf::counted_ptr<state_type> state_;
};
} // namespace detail
template<typename T>
class async_result<detail::promise_handler<T> >
{
public:
typedef librf::future_t<T> type;
explicit async_result(detail::promise_handler<T> & h)
: task_(std::move(h.state_))
{ }
librf::future_t<T> get() { return std::move(task_); }
private:
librf::future_t<T> task_;
};
// Handler type specialisation for zero arg.
template<typename Allocator, typename ReturnType>
struct handler_type<rf_task_t<Allocator>, ReturnType()> {
typedef detail::promise_handler<void> type;
};
// Handler type specialisation for one arg.
template<typename Allocator, typename ReturnType, typename Arg1>
struct handler_type<rf_task_t<Allocator>, ReturnType(Arg1)> {
typedef detail::promise_handler<Arg1> type;
};
// Handler type specialisation for two arg.
template<typename Allocator, typename ReturnType, typename Arg2>
struct handler_type<rf_task_t<Allocator>, ReturnType(asio::error_code, Arg2)> {
typedef detail::promise_handler<Arg2> type;
};
template<typename Allocator, typename ReturnType>
struct handler_type<rf_task_t<Allocator>, ReturnType(asio::error_code)> {
typedef detail::promise_handler<void> type;
};
} // namespace asio
#include "asio/detail/pop_options.hpp"
================================================
FILE: asio/asio_task_1.12.0.inl
================================================
#include <memory>
#include "asio/detail/push_options.hpp"
namespace asio {
/**
* @brief 用于指示asio相关异步函数，返回librf::future_t<>的类型，从而变成支持 librf 的协程函数。
*/
template <typename Executor = executor>
struct rf_task_t
{
ASIO_CONSTEXPR rf_task_t() {}
};
/**
* @brief 用于指示asio相关异步函数，返回librf::future_t<>的常量，从而变成支持 librf 的协程函数。
*/
constexpr rf_task_t<> rf_task;
namespace librf {
template <typename Executor, typename T>
struct promise_handler_base
{
public:
typedef T result_type;
typedef librf::state_t<result_type> state_type;
promise_handler_base()
: state_(librf::state_future_t::_Alloc_state<state_type>(true))
{
}
librf::counted_ptr<state_type> state_;
promise_handler_base(promise_handler_base &&) = default;
promise_handler_base(const promise_handler_base &) = default;
promise_handler_base & operator = (promise_handler_base &&) = default;
promise_handler_base & operator = (const promise_handler_base &) = default;
};
template <typename, typename...>
struct promise_handler;
template <typename Executor>
struct promise_handler<Executor, void> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()() const
{
this->state_->set_value();
}
};
template <typename Executor>
struct promise_handler<Executor, asio::error_code> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()(const asio::error_code& ec) const
{
if (!ec)
this->state_->set_value();
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor>
struct promise_handler<Executor, std::exception_ptr> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()(std::exception_ptr ex) const
{
if (!ex)
this->state_->set_value();
else
this->state_->set_exception(ex);
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(Arg&& arg) const
{
this->state_->set_value(std::forward<Arg>(arg));
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, asio::error_code, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(const asio::error_code& ec, Arg&& arg) const
{
if (!ec)
this->state_->set_value(std::forward<Arg>(arg));
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, std::exception_ptr, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(std::exception_ptr ex, Arg&& arg) const
{
if (!ex)
this->state_->set_value(std::forward<Arg>(arg));
else
this->state_->set_exception(ex);
}
};
template <typename Executor, typename... Ts>
struct promise_handler : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(Args&&... args) const
{
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
}
};
template <typename Executor, typename... Ts>
struct promise_handler<Executor, asio::error_code, Ts...> : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(const asio::error_code& ec, Args&&... args) const
{
if (!ec)
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor, typename... Ts>
struct promise_handler<Executor, std::exception_ptr, Ts...> : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(std::exception_ptr ex, Args&&... args) const
{
if (!ex)
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
else
this->state_->set_exception(ex);
}
};
} // namespace librf
template <typename Executor, typename R, typename... Args>
class async_result<rf_task_t<Executor>, R(Args...)>
{
public:
typedef librf::promise_handler<Executor, Args...> handler_type;
typedef typename handler_type::result_type result_type;
typedef librf::future_t<result_type> return_type;
template <typename Initiation, typename... InitArgs>
static return_type initiate(ASIO_MOVE_ARG(Initiation) initiation,
rf_task_t<Executor>, ASIO_MOVE_ARG(InitArgs)... args)
{
handler_type handler{};
return_type future{ handler.state_ };
std::move(initiation)(std::move(handler), std::move(args)...);
return std::move(future);
}
};
} // namespace asio
#include "asio/detail/pop_options.hpp"
================================================
FILE: asio/asio_task_1.12.2.inl
================================================
#include <memory>
#include "asio/detail/push_options.hpp"
namespace asio {
/**
* @brief 用于指示asio相关异步函数，返回librf::future_t<>的类型，从而变成支持 librf 的协程函数。
*/
template <typename Executor = executor>
struct rf_task_t
{
ASIO_CONSTEXPR rf_task_t() {}
};
/**
* @brief 用于指示asio相关异步函数，返回librf::future_t<>的常量，从而变成支持 librf 的协程函数。
*/
constexpr rf_task_t<> rf_task;
namespace librf {
template <typename Executor, typename _Result>
struct promise_handler_base
{
public:
typedef _Result result_type;
typedef ::librf::state_t<result_type> state_type;
promise_handler_base(const rf_task_t<Executor>&)
: state_(::librf::state_future_t::_Alloc_state<state_type>(true))
{
}
::librf::counted_ptr<state_type> state_;
promise_handler_base(promise_handler_base &&) = default;
promise_handler_base(const promise_handler_base &) = default;
promise_handler_base & operator = (promise_handler_base &&) = default;
promise_handler_base & operator = (const promise_handler_base &) = default;
};
template <typename, typename...>
struct promise_handler;
template <typename Executor>
struct promise_handler<Executor, void> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()() const
{
this->state_->set_value();
}
};
template <typename Executor>
struct promise_handler<Executor, asio::error_code> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()(const asio::error_code& ec) const
{
if (!ec)
this->state_->set_value();
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor>
struct promise_handler<Executor, std::exception_ptr> : public promise_handler_base<Executor, void>
{
using promise_handler_base<Executor, void>::promise_handler_base;
void operator()(std::exception_ptr ex) const
{
if (!ex)
this->state_->set_value();
else
this->state_->set_exception(ex);
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(Arg&& arg) const
{
this->state_->set_value(std::forward<Arg>(arg));
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, asio::error_code, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(const asio::error_code& ec, Arg&& arg) const
{
if (!ec)
this->state_->set_value(std::forward<Arg>(arg));
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor, typename T>
struct promise_handler<Executor, std::exception_ptr, T> : public promise_handler_base<Executor, T>
{
using promise_handler_base<Executor, T>::promise_handler_base;
template <typename Arg>
void operator()(std::exception_ptr ex, Arg&& arg) const
{
if (!ex)
this->state_->set_value(std::forward<Arg>(arg));
else
this->state_->set_exception(ex);
}
};
template <typename Executor, typename... Ts>
struct promise_handler : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(Args&&... args) const
{
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
}
};
template <typename Executor, typename... Ts>
struct promise_handler<Executor, asio::error_code, Ts...> : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(const asio::error_code& ec, Args&&... args) const
{
if (!ec)
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
else
this->state_->set_exception(std::make_exception_ptr(asio::system_error(ec)));
}
};
template <typename Executor, typename... Ts>
struct promise_handler<Executor, std::exception_ptr, Ts...> : public promise_handler_base<Executor, std::tuple<Ts...>>
{
using promise_handler_base<Executor, std::tuple<Ts...>>::promise_handler_base;
template <typename... Args>
void operator()(std::exception_ptr ex, Args&&... args) const
{
if (!ex)
this->state_->set_value(std::make_tuple(std::forward<Args>(args)...));
else
this->state_->set_exception(ex);
}
};
} // namespace librf
template <typename Executor, typename R, typename... Args>
class async_result<rf_task_t<Executor>, R(Args...)>
{
public:
typedef librf::promise_handler<Executor, Args...> completion_handler_type;
typedef typename completion_handler_type::result_type result_type;
typedef ::librf::state_t<result_type> state_type;
typedef ::librf::future_t<result_type> return_type;
async_result(completion_handler_type& hander)
: state_(hander.state_)
{}
return_type get() const noexcept
{
return this->state_;
}
private:
::librf::counted_ptr<state_type> state_;
};
} // namespace asio
#include "asio/detail/pop_options.hpp"
================================================
FILE: benchmark/CMakeLists.txt
================================================
set(BENCHMARK_FILES "")
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR} BENCHMARK_FILES)
find_package(asio REQUIRED)
foreach(BENCHMARK_FILE_PATH ${BENCHMARK_FILES})
string(REGEX REPLACE ".+[/\]([^/\.]+)\\.cpp" "\\1" BENCHMARK_FILE_NAME ${BENCHMARK_FILE_PATH})
message(STATUS "Generating benchmark target: ${BENCHMARK_FILE_NAME}")
add_executable(${BENCHMARK_FILE_NAME} ${BENCHMARK_FILE_PATH})
target_link_libraries(${BENCHMARK_FILE_NAME} PUBLIC librf asio asio::asio)
target_compile_definitions(${BENCHMARK_FILE_NAME}
PRIVATE LIBRF_TUTORIAL_STAND_ALONE=1 ASIO_STANDALONE
)
endforeach(BENCHMARK_FILE_PATH)
================================================
FILE: benchmark/benchmark_asio_echo.cpp
================================================
#include <iostream>
#include "librf/librf.h"
#include <asio.hpp>
#include "../asio/asio_task.h"
#pragma warning(disable : 4834)
using namespace asio::ip;
using namespace librf;
template<class _Ty, size_t _Size>
union uarray
{
std::array<_Ty, _Size> c;
template<class... Args>
uarray(Args&... args)
{
for (auto & v : c)
new(&v) _Ty(args...);
}
~uarray()
{
for (auto & v : c)
v.~_Ty();
}
};
#define BUF_SIZE 1024
std::atomic<intptr_t> g_echo_count = 0;
future_t<> RunEchoSession(tcp::socket socket)
{
std::size_t bytes_transferred = 0;
std::array<char, BUF_SIZE> buffer;
for(;;)
{
try
{
bytes_transferred += co_await socket.async_read_some(
asio::buffer(buffer.data() + bytes_transferred, buffer.size() - bytes_transferred), asio::rf_task);
if (bytes_transferred >= buffer.size())
{
co_await asio::async_write(socket, asio::buffer(buffer, buffer.size()), asio::rf_task);
bytes_transferred = 0;
g_echo_count.fetch_add(1, std::memory_order_release);
}
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
break;
}
}
}
template<size_t _N>
void AcceptConnections(tcp::acceptor & acceptor, uarray<tcp::socket, _N> & socketes)
{
try
{
for (size_t idx = 0; idx < socketes.c.size(); ++idx)
{
go[&, idx]() -> future_t<>
{
for (;;)
{
try
{
co_await acceptor.async_accept(socketes.c[idx], asio::rf_task);
go RunEchoSession(std::move(socketes.c[idx]));
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
}
};
}
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
}
void StartPrintEchoCount()
{
using namespace std::literals;
GO
{
for (;;)
{
g_echo_count.exchange(0, std::memory_order_release);
co_await 1s;
std::cout << g_echo_count.load(std::memory_order_acquire) << std::endl;
}
};
}
void RunOneBenchmark(bool bMain)
{
librf::local_scheduler_t ls;
asio::io_service io_service;
tcp::acceptor acceptor(io_service, tcp::endpoint(tcp::v4(), 3456));
uarray<tcp::socket, 16> socketes(io_service);
AcceptConnections(acceptor, socketes);
if (bMain) StartPrintEchoCount();
for (;;)
{
io_service.poll();
this_scheduler()->run_one_batch();
}
}
void resumable_main_benchmark_asio_server()
{
std::array<std::thread, 2> thds;
for (size_t i = 0; i < thds.size(); ++i)
{
thds[i] = std::thread(&RunOneBenchmark, i == 0);
}
for (auto & t : thds)
t.join();
}
//----------------------------------------------------------------------------------------------------------------------
future_t<> RunPipelineEchoClient(asio::io_service & ios, tcp::resolver::iterator ep)
{
std::shared_ptr<tcp::socket> sptr = std::make_shared<tcp::socket>(ios);
try
{
co_await asio::async_connect(*sptr, ep, asio::rf_task);
GO
{
std::array<char, BUF_SIZE> write_buff_;
for (auto & c : write_buff_)
c = 'A' + rand() % 52;
try
{
for (;;)
{
co_await asio::async_write(*sptr, asio::buffer(write_buff_), asio::rf_task);
}
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
};
GO
{
try
{
std::array<char, BUF_SIZE> read_buff_;
for (;;)
{
co_await sptr->async_read_some(asio::buffer(read_buff_), asio::rf_task);
}
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
};
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
}
#if _HAS_CXX17
future_t<> RunPingPongEchoClient(asio::io_service & ios, tcp::resolver::iterator ep)
{
tcp::socket socket_{ ios };
std::array<char, BUF_SIZE> read_buff_;
std::array<char, BUF_SIZE> write_buff_;
try
{
co_await asio::async_connect(socket_, ep, asio::rf_task);
for (auto & c : write_buff_)
c = 'A' + rand() % 52;
for (;;)
{
co_await when_all(
asio::async_write(socket_, asio::buffer(write_buff_), asio::rf_task),
socket_.async_read_some(asio::buffer(read_buff_), asio::rf_task)
);
}
}
catch (std::exception & e)
{
std::cerr << e.what() << std::endl;
}
}
void resumable_main_benchmark_asio_client_with_rf(intptr_t nNum)
{
nNum = std::max((intptr_t)1, nNum);
try
{
asio::io_service ios;
asio::ip::tcp::resolver resolver_(ios);
asio::ip::tcp::resolver::query query_("localhost", "3456");
tcp::resolver::iterator iter = resolver_.resolve(query_);
for (intptr_t i = 0; i < nNum; ++i)
{
go RunPingPongEchoClient(ios, iter);
}
for (;;)
{
ios.poll();
this_scheduler()->run_one_batch();
}
}
catch (std::exception & e)
{
std::cout << e.what() << std::endl;
}
}
#endif
class chat_session : public std::enable_shared_from_this<chat_session>
{
public:
chat_session(asio::io_service & ios, tcp::resolver::iterator ep)
: socket_(ios)
, endpoint_(ep)
{
}
void start()
{
do_connect();
}
private:
void do_connect()
{
auto self = this->shared_from_this();
asio::async_connect(socket_, endpoint_,
[this, self](std::error_code ec, tcp::resolver::iterator )
{
if (!ec)
{
for (auto & c : write_buff_)
c = 'A' + rand() % 52;
do_write();
}
else
{
std::cerr << ec.message() << std::endl;
}
});
}
void do_read()
{
auto self(shared_from_this());
socket_.async_read_some(asio::buffer(read_buff_),
[this, self](const asio::error_code& ec, std::size_t )
{
if (!ec)
{
do_write();
}
else
{
std::cerr << ec.message() << std::endl;
}
});
}
void do_write()
{
auto self(shared_from_this());
asio::async_write(socket_,
asio::buffer(write_buff_),
[this, self](std::error_code ec, std::size_t)
{
if (!ec)
{
do_read();
}
else
{
std::cerr << ec.message() << std::endl;
}
});
}
tcp::socket socket_;
tcp::resolver::iterator endpoint_;
std::array<char, BUF_SIZE> read_buff_;
std::array<char, BUF_SIZE> write_buff_;
};
void resumable_main_benchmark_asio_client_with_callback(intptr_t nNum)
{
nNum = std::max((intptr_t)1, nNum);
try
{
asio::io_service ios;
asio::ip::tcp::resolver resolver_(ios);
asio::ip::tcp::resolver::query query_("127.0.0.1", "3456");
tcp::resolver::iterator iter = resolver_.resolve(query_);
for (intptr_t i = 0; i < nNum; ++i)
{
auto chat = std::make_shared<chat_session>(ios, iter);
chat->start();
}
ios.run();
}
catch (std::exception & e)
{
std::cout << "Exception: " << e.what() << "\n";
}
}
void resumable_main_benchmark_asio_client(intptr_t nNum)
{
resumable_main_benchmark_asio_client_with_callback(nNum);
}
#if LIBRF_TUTORIAL_STAND_ALONE
int main(int argc, const char* argv[])
{
if (argc > 1)
resumable_main_benchmark_asio_client(atoi(argv[1]));
else
resumable_main_benchmark_asio_server();
return 0;
}
#endif
================================================
FILE: benchmark/benchmark_async_mem.cpp
================================================
#include <chrono>
#include <iostream>
#include <string>
#include <thread>
#include "librf/librf.h"
const size_t N = 10'000'000;
const size_t LOOP_COUNT = 50;
std::atomic<size_t> globalValue{0};
void resumable_main_benchmark_mem(bool wait_key)
{
using namespace std::chrono;
for (size_t i = 0; i < N; ++i)
{
go[=]()->librf::generator_t<size_t>
{
for (size_t k = 0; k < LOOP_COUNT; ++k)
{
globalValue += i * k;
co_yield k;
}
co_return 0;
};
}
librf::this_scheduler()->run_until_notask();
if (wait_key)
{
std::cout << "press any key to continue." << std::endl;
(void)getchar();
}
}
//clang :
// x64: 平均 256 字节, operator new: size = 48, state size = 32
// x86: 平均 121 字节, operator new: size = 40, state size = 16
//msvc : 平均 304 字节(vs2022,17.7.4)
// x64: 平均 304 字节, operator new: size = 144, state size = 32
// x86: 平均 153 字节, operator new: size = 72, state size = 16
#if LIBRF_TUTORIAL_STAND_ALONE
int main()
{
resumable_main_benchmark_mem(false);
return 0;
}
#endif
================================================
FILE: benchmark/benchmark_channel_passing_next.cpp
================================================
#include <chrono>
#include <iostream>
#include <string>
#include <thread>
#include <deque>
#include <mutex>
#include "librf/librf.h"
using namespace librf;
using namespace std::chrono;
using namespace std::literals;
const static auto MaxNum = 100000;
const static auto LoopCount = 100;
using int_channel_ptr = std::shared_ptr<channel_t<intptr_t>>;
static future_t<> passing_next(channel_t<intptr_t> rd, channel_t<intptr_t> wr)
{
for (int i = 0; i < LoopCount; ++i)
{
intptr_t value = co_await rd;
co_await wr.write(value + 1);
}
}
#if defined(__GNUC__)
static future_t<> passing_loop_all(channel_t<intptr_t> head, channel_t<intptr_t> tail)
{
for (int i = 0; i < LoopCount; ++i)
{
auto tstart = high_resolution_clock::now();
co_await(head << 0);
intptr_t value = co_await tail;
auto dt = duration_cast<duration<double>>(high_resolution_clock::now() - tstart).count();
std::cout << value << " cost time " << dt << "s" << std::endl;
}
}
#endif
void benchmark_main_channel_passing_next()
{
channel_t<intptr_t> head{1};
channel_t<intptr_t> in = head;
channel_t<intptr_t> tail{0};
for (int i = 0; i < MaxNum; ++i)
{
tail = channel_t<intptr_t>{ 1 };
go passing_next(in, tail);
in = tail;
}
#if defined(__GNUC__)
go passing_loop_all(head, tail);
#else
GO
{
for (int i = 0; i < LoopCount; ++i)
{
auto tstart = high_resolution_clock::now();
co_await (head << 0);
intptr_t value = co_await tail;
auto dt = duration_cast<duration<double>>(high_resolution_clock::now() - tstart).count();
std::cout << value << " cost time " << dt << "s" << std::endl;
}
};
#endif
this_scheduler()->run_until_notask();
}
#if LIBRF_TUTORIAL_STAND_ALONE
int main()
{
benchmark_main_channel_passing_next();
return 0;
}
#endif
================================================
FILE: cmake/SelectDynamicLibrary.cmake
================================================
include(SelectLibraryConfigurations)
if(NOT DEFINED CMAKE_PROCESSOR_ALIAS)
MESSAGE(STATUS "operation system is ${CMAKE_CXX_PLATFORM_ID}")
MESSAGE(STATUS "processor is ${CMAKE_HOST_SYSTEM_PROCESSOR}")
if((${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "i386") OR (${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "AMD64") OR (${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "x86_64"))
if(CMAKE_SIZEOF_VOID_P EQUAL 4)
set(CMAKE_PROCESSOR_ALIAS "x86" CACHE STRING "Alias of processor")
elseif(CMAKE_SIZEOF_VOID_P EQUAL 8)
set(CMAKE_PROCESSOR_ALIAS "x64" CACHE STRING "Alias of processor")
else()
message(FATAL_ERROR "Unknown processor")
endif()
elseif(${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "aarch64")
if(CMAKE_SIZEOF_VOID_P EQUAL 4)
set(CMAKE_PROCESSOR_ALIAS "arm" CACHE STRING "Alias of processor")
elseif(CMAKE_SIZEOF_VOID_P EQUAL 8)
set(CMAKE_PROCESSOR_ALIAS "arm64" CACHE STRING "Alias of processor")
else()
message(FATAL_ERROR "Unknown processor")
endif()
else()
message(FATAL_ERROR "Unknown processor")
endif()
message(STATUS "CMAKE_PROCESSOR_ALIAS=${CMAKE_PROCESSOR_ALIAS}")
endif()
macro(_acl_copy_dynamic_library_build_type basename build_type)
if(${build_type} STREQUAL "Debug")
set(_acl_build_type_dir "Debug")
set(_acl_runtime_output_dir ${CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG})
elseif(${build_type} STREQUAL "Release")
set(_acl_build_type_dir "Release")
set(_acl_runtime_output_dir ${CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE})
elseif(${build_type} STREQUAL "MinSizeRel")
set(_acl_build_type_dir "Release")
set(_acl_runtime_output_dir ${CMAKE_RUNTIME_OUTPUT_DIRECTORY_MINSIZEREL})
elseif(${build_type} STREQUAL "RelWithDebInfo")
set(_acl_build_type_dir "Release")
set(_acl_runtime_output_dir ${CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO})
endif()
#message(STATUS "_acl_build_type_dir=${CMAKE_CURRENT_LIST_DIR}/../lib/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-${_acl_build_type_dir}")
#message(STATUS "_acl_runtime_output_dir=${_acl_runtime_output_dir}")
find_file(_acl_${basename}_dynamic_binary
NAMES "Acl.${basename}.dll" "Acl.${basename}.so"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../bin/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-${_acl_build_type_dir}
NO_DEFAULT_PATH
)
if(NOT _acl_${basename}_dynamic_binary)
find_file(_acl_${basename}_dynamic_binary
NAMES "${basename}.dll" "${basename}.so"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../bin/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-${_acl_build_type_dir}
NO_DEFAULT_PATH
)
endif()
#message(STATUS "_acl_runtime_dynamic_binary=${_acl_runtime_dynamic_binary}")
if(_acl_${basename}_dynamic_binary)
file(INSTALL ${_acl_${basename}_dynamic_binary} DESTINATION ${_acl_runtime_output_dir})
endif()
unset(_acl_build_type_dir)
unset(_acl_runtime_output_dir)
unset(_acl_${basename}_dynamic_binary CACHE)
endmacro(_acl_copy_dynamic_library_build_type)
macro(_acl_copy_dynamic_library basename)
if(DEFINED CMAKE_CONFIGURATION_TYPES)
foreach(build_type ${CMAKE_CONFIGURATION_TYPES})
_acl_copy_dynamic_library_build_type(${basename} ${build_type})
endforeach(build_type)
elseif(DEFINED CMAKE_BUILD_TYPE)
_acl_copy_dynamic_library_build_type(${basename} ${CMAKE_BUILD_TYPE})
else()
_acl_copy_dynamic_library_build_type(${basename} "Release")
endif()
endmacro(_acl_copy_dynamic_library)
macro(select_dynamic_library basename header)
#message(STATUS "basename=${basename}")
#message(STATUS "header=${header}")
# Ѿҵ basename ָģ飬ֻʱĶ̬Ĺ
#message(STATUS "${basename}_FOUND=${${basename}_FOUND}")
if(${basename}_FOUND)
_acl_copy_dynamic_library(${basename})
return()
endif()
# ͷļڵ·
find_path(${basename}_INCLUDE_DIR ${header}
${CMAKE_CURRENT_LIST_DIR}/../include
NO_DEFAULT_PATH
)
# ҵ汾Ŀļ·
find_library("${basename}_LIBRARY_DEBUG"
NAMES "Acl.${basename}"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../lib/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-Debug
NO_DEFAULT_PATH
)
if(NOT ${basename}_LIBRARY_DEBUG)
find_library("${basename}_LIBRARY_DEBUG"
NAMES "${basename}"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../lib/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-Debug
NO_DEFAULT_PATH
)
endif()
# ҷа汾Ŀļ·
find_library("${basename}_LIBRARY_RELEASE"
NAMES "Acl.${basename}"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../lib/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-Release
NO_DEFAULT_PATH
)
if(NOT ${basename}_LIBRARY_RELEASE)
find_library("${basename}_LIBRARY_RELEASE"
NAMES "${basename}"
PATHS
${CMAKE_CURRENT_LIST_DIR}/../lib/${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}-Release
NO_DEFAULT_PATH
)
endif()
# ʹcmakeõ select_library_configurations ${basename}_LIBRARY ֶ
select_library_configurations(${basename})
set(${basename}_FOUND FALSE)
if(${basename}_LIBRARY AND ${basename}_INCLUDE_DIR)
set(${basename}_FOUND TRUE)
if(NOT ${basename}_DIR)
set(${basename}_DIR ${CMAKE_CURRENT_LIST_DIR})
endif()
# ʱĶ̬ĿĿ¼
_acl_copy_dynamic_library(${basename})
# basename ָĵӿģ
if(NOT TARGET Acl::${basename})
add_library(Acl::${basename} UNKNOWN IMPORTED)
set_target_properties(Acl::${basename} PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES "${${basename}_INCLUDE_DIR}")
set_property(TARGET Acl::${basename} APPEND PROPERTY
IMPORTED_CONFIGURATIONS RELEASE)
set_target_properties(Acl::${basename} PROPERTIES
IMPORTED_LOCATION_RELEASE "${${basename}_LIBRARY_RELEASE}")
set_property(TARGET Acl::${basename} APPEND PROPERTY
IMPORTED_CONFIGURATIONS DEBUG)
set_target_properties(Acl::${basename} PROPERTIES
IMPORTED_LOCATION_DEBUG "${${basename}_LIBRARY_DEBUG}")
endif()
endif()
mark_as_advanced(${basename}_DIR)
mark_as_advanced(${basename}_LIBRARY)
mark_as_advanced(${basename}_INCLUDE_DIR)
#message(STATUS "${basename}_DIR=${${basename}_DIR}")
#message(STATUS "${basename}_LIBRARY=${${basename}_LIBRARY}")
#message(STATUS "${basename}_LIBRARY_DEBUG=${${basename}_LIBRARY_DEBUG}")
#message(STATUS "${basename}_LIBRARY_RELEASE=${${basename}_LIBRARY_RELEASE}")
#message(STATUS "${basename}_INCLUDE_DIR=${${basename}_INCLUDE_DIR}")
endmacro(select_dynamic_library)
================================================
FILE: cmake/install.cmake
================================================
# Configuration
# Used by cmake to find_package(xxx)
set(PROJECT_CONFIG "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake")
# Add definitions for targets
# Values:
# * Debug: -Dxxx_DEBUG=1
# * Release: -Dxxx_DEBUG=0
# * other: -Dxxx_DEBUG=0
target_compile_definitions(${PROJECT_NAME} PUBLIC ${PROJECT_NAME}_DEBUG=$<CONFIG:Debug>)
# Include module with function 'write_basic_package_version_file'
# Configure 'xxxConfigVersion.cmake'
include(CMakePackageConfigHelpers)
write_basic_package_version_file(${VERSION_CONFIG} VERSION ${PACKAGE_VERSION}
COMPATIBILITY SameMajorVersion)
# Configure 'xxxConfig.cmake'
configure_package_config_file(Config.cmake.in ${PROJECT_CONFIG}
INSTALL_DESTINATION cmake/${PROJECT_NAME})
# Targets:
# * <prefix>/lib/Windows/x64-Debug/xxx.lib
# * <prefix>/bin/Windows/x64-Debug/xxx.dll
set(INSTALL_TARGET_PREFIX "${CMAKE_CXX_PLATFORM_ID}/${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}")
install(TARGETS ${PROJECT_NAME}
CONFIGURATIONS Debug
LIBRARY DESTINATION "lib/${INSTALL_TARGET_PREFIX}-Debug"
ARCHIVE DESTINATION "lib/${INSTALL_TARGET_PREFIX}-Debug"
RUNTIME DESTINATION "bin/${INSTALL_TARGET_PREFIX}-Debug"
)
# * <prefix>/lib/Windows/x64-Release/xxx.lib
# * <prefix>/bin/Windows/x64-Release/xxx.dll
install(TARGETS ${PROJECT_NAME}
CONFIGURATIONS Release RelWithDebInfo MinSizeRel
LIBRARY DESTINATION "lib/${INSTALL_TARGET_PREFIX}-Release"
ARCHIVE DESTINATION "lib/${INSTALL_TARGET_PREFIX}-Release"
RUNTIME DESTINATION "bin/${INSTALL_TARGET_PREFIX}-Release"
)
# Config
# * <prefix>/cmake/xxxConfig.cmake
# * <prefix>/cmake/xxxConfigVersion.cmake
install(FILES ${PROJECT_CONFIG} DESTINATION cmake)
================================================
FILE: config.h.in
================================================
#pragma once
#ifndef RESUMEF_DEBUG_COUNTER
#cmakedefine RESUMEF_DEBUG_COUNTER @RESUMEF_DEBUG_COUNTER@
#endif //RESUMEF_DEBUG_COUNTER
#ifndef _WITH_LOCK_FREE_Q_KEEP_REAL_SIZE
#cmakedefine _WITH_LOCK_FREE_Q_KEEP_REAL_SIZE @_WITH_LOCK_FREE_Q_KEEP_REAL_SIZE@
#endif //_WITH_LOCK_FREE_Q_KEEP_REAL_SIZE
#ifndef RESUMEF_DISABLE_MULT_THREAD
#cmakedefine RESUMEF_DISABLE_MULT_THREAD @RESUMEF_DISABLE_MULT_THREAD@
#endif //RESUMEF_DISABLE_MULT_THREAD
#cmakedefine RESUMEF_USE_CUSTOM_SPINLOCK @RESUMEF_USE_CUSTOM_SPINLOCK@
#cmakedefine RESUMEF_USE_SHARD_LIBRARY @RESUMEF_USE_SHARD_LIBRARY@
================================================
FILE: gcc_bugs.cpp
================================================
/*
g++ --version:
g++ (Ubuntu 10 - 20200416 - 0ubuntu1~18.04) 10.0.1 20200416 (experimental)[master revision 3c3f12e2a76:dcee354ce56:44b326839d864fc10c459916abcc97f35a9ac3de]
Copyright(C) 2020 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
#include <iostream>
#include "librf.h"
using namespace librf;
#define GCC_FIX_BUGS 1
static future_t<> gcc_bugs_if_await(event_t e)
{
#if GCC_FIX_BUGS
auto result = co_await e.wait();
if (result == false)
#else
if (co_await e.wait() == false) //internal compiler error: in fold_convert_loc, at fold-const.c:2435
#endif
std::cout << "time out!" << std::endl;
else
std::cout << "event signal!" << std::endl;
}
static future_t<> gcc_bugs_while_await(mutex_t lock)
{
#if GCC_FIX_BUGS
for (;;)
{
auto result = co_await lock.try_lock();
if (result) break;
}
#else
while (!co_await lock.try_lock()); //internal compiler error: in fold_convert_loc, at fold-const.c:2435
#endif
std::cout << "OK." << std::endl;
}
#if GCC_FIX_BUGS
static future_t<> gcc_bugs_lambda_coroutines_fixed(std::thread& other, channel_t<bool> c_done)
{
co_await c_done;
std::cout << "other thread = " << other.get_id();
co_await c_done;
}
#endif
static void gcc_bugs_lambda_coroutines()
{
channel_t<bool> c_done{ 1 };
std::thread other;
#if GCC_FIX_BUGS
go gcc_bugs_lambda_coroutines_fixed(other, c_done);
#else
go[&other, c_done]()->future_t<>
{
co_await c_done;
std::cout << "other thread = " << other.get_id();
co_await c_done;
}; //internal compiler error: in captures_temporary, at cp/coroutines.cc:2716
#endif
}
#if GCC_FIX_BUGS
static future_t<> gcc_bugs_lambda_coroutines2_fixed(channel_t<intptr_t> head, channel_t<intptr_t> tail)
{
for (int i = 0; i < 100; ++i)
{
co_await(head << 0);
co_await tail;
}
}
#endif
static void gcc_bugs_lambda_coroutines2()
{
channel_t<intptr_t> head{ 1 };
channel_t<intptr_t> tail{ 0 };
#if GCC_FIX_BUGS
go gcc_bugs_lambda_coroutines2_fixed(head, tail);
#else
GO
{
for (int i = 0; i < 100; ++i)
{
co_await(head << 0);
intptr_t value = co_await tail;
(void)value;
}
}; //internal compiler error: in captures_temporary, at cp/coroutines.cc:2716
#endif
}
template<class... _Mtxs>
static future_t<> gcc_bugs_nameless_args(adopt_manual_unlock_t
#if GCC_FIX_BUGS
nameless
#endif
, _Mtxs&... mtxs)
{
#if GCC_FIX_BUGS
(void)nameless;
#endif
co_await mutex_t::lock(adopt_manual_unlock, mtxs...);
} //internal compiler error: Segmentation fault
void gcc_bugs()
{
event_t e;
go gcc_bugs_if_await(e);
mutex_t mtx;
go gcc_bugs_while_await(mtx);
mutex_t a, b, c;
go gcc_bugs_nameless_args(adopt_manual_unlock, a, b, c);
}
================================================
FILE: include/librf/librf.h
================================================
/*
*Copyright 2017~2020 lanzhengpeng
*
*Licensed under the Apache License, Version 2.0 (the "License");
*you may not use this file except in compliance with the License.
*You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*Unless required by applicable law or agreed to in writing, software
*distributed under the License is distributed on an "AS IS" BASIS,
*WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*See the License for the specific language governing permissions and
*limitations under the License.
*/
#pragma once
#include <cstdint>
#include <cstddef>
#include <type_traits>
#include <atomic>
#include <chrono>
#include <array>
#include <vector>
#include <deque>
#include <mutex>
#include <map>
#include <list>
#include <any>
#include <unordered_map>
#include <functional>
#include <optional>
#include <thread>
#include <cassert>
#include <utility>
#if __cpp_impl_coroutine
#include <coroutine>
#ifdef _MSC_VER
#ifndef __clang__
extern "C" size_t _coro_frame_size();
extern "C" void* _coro_frame_ptr();
extern "C" void _coro_init_block();
extern "C" void* _coro_resume_addr();
extern "C" void _coro_init_frame(void*);
extern "C" void _coro_save(size_t);
extern "C" void _coro_suspend(size_t);
extern "C" void _coro_cancel();
extern "C" void _coro_resume_block();
#pragma intrinsic(_coro_frame_size)
#pragma intrinsic(_coro_frame_ptr)
#pragma intrinsic(_coro_init_block)
#pragma intrinsic(_coro_resume_addr)
#pragma intrinsic(_coro_init_frame)
#pragma intrinsic(_coro_save)
#pragma intrinsic(_coro_suspend)
#pragma intrinsic(_coro_cancel)
#pragma intrinsic(_coro_resume_block)
#else
#include "src/unix/clang_builtin.h"
#endif
#endif
#elif defined(__clang__)
#include "src/unix/coroutine.h"
#elif __has_include(<experimental/coroutine>)
#include <experimental/coroutine>
#else
#include "src/unix/coroutine.h"
#endif
#include "src/stop_token.h"
#include "src/config.h"
#if RESUMEF_DEBUG_COUNTER
#include <iostream>
#endif
#include "src/def.h"
#include "src/macro_def.inl"
#include "src/exception.inl"
#include "src/counted_ptr.h"
#include "src/type_traits.inl"
#include "src/type_concept.inl"
#include "src/spinlock.h"
#include "src/state.h"
#include "src/future.h"
#include "src/promise.h"
#include "src/awaitable.h"
#include "src/generator.h"
#include "src/rf_task.h"
#include "src/timer.h"
#include "src/scheduler.h"
#include "src/promise.inl"
#include "src/state.inl"
#include "src/switch_scheduler.h"
#include "src/current_scheduler.h"
#include "src/yield.h"
#include "src/sleep.h"
#include "src/when.h"
#include "src/_awaker.h"
#include "src/ring_queue.h"
#include "src/intrusive_link_queue.h"
#include "src/channel.h"
#include "src/event.h"
#include "src/mutex.h"
namespace resumef = librf;
================================================
FILE: include/librf/librf_macro.h
================================================
#include "src/macro_def.inl"
================================================
FILE: include/librf/src/_awaker.h
================================================
#pragma once
#ifndef DOXYGEN_SKIP_PROPERTY
namespace librf
{
namespace detail
{
template<class _Ety, class... _Types>
struct _awaker
{
//如果超时
// e 始终为nullptr
// 不关心返回值
//如果不是超时，
// e 指向当前触发的事件，用于实现wait_any
// 返回true表示成功触发了事件，event内部减小一次事件计数，并删除此awaker
// 返回false表示此事件已经无效，event内部只删除此awaker
typedef std::function<bool(_Ety * e, _Types...)> callee_type;
private:
typedef spinlock lock_type;
//typedef std::recursive_mutex lock_type;
lock_type _lock;
callee_type _callee;
std::atomic<intptr_t> _counter;
public:
_awaker(callee_type && callee_, intptr_t init_count_ = 0)
: _callee(std::forward<callee_type>(callee_))
, _counter(init_count_)
{
}
//调用一次后，_callee就被置nullptr，下次再调用，必然返回false
//第一次调用，返回调用_callee的返回值
//超时通过传入nullptr来调用
bool awake(_Ety * e, intptr_t count_, const _Types&... args)
{
assert(count_ > 0);
scoped_lock<lock_type> lock_(this->_lock);
if ((this->_counter.fetch_sub(count_) - count_) <= 0)
{
if (this->_callee)
{
callee_type callee_ = std::move(this->_callee);
return callee_(e, args...);
}
return false;
}
return true;
}
private:
_awaker(const _awaker &) = delete;
_awaker(_awaker &&) = delete;
_awaker & operator = (const _awaker &) = delete;
_awaker & operator = (_awaker &&) = delete;
};
}
}
#endif //DOXYGEN_SKIP_PROPERTY
================================================
FILE: include/librf/src/awaitable.h
================================================
#pragma once
namespace librf
{
/**
* @brief awaitable_t<>的公共实现部分，用于减少awaitable_t<>的重复代码。
* @param _Ty 可等待函数(awaitable function)的返回类型。
* @see 参见awaitable_t<>类的说明。
*/
template<class _Ty>
struct awaitable_impl_t
{
using value_type = _Ty;
using state_type = state_t<value_type>;
using future_type = future_t<value_type>;
using lock_type = typename state_type::lock_type;
using _Alloc_char = typename state_type::_Alloc_char;
awaitable_impl_t() noexcept = default;
awaitable_impl_t(const awaitable_impl_t&) noexcept = default;
awaitable_impl_t(awaitable_impl_t&&) noexcept = default;
awaitable_impl_t& operator = (const awaitable_impl_t&) noexcept = default;
awaitable_impl_t& operator = (awaitable_impl_t&&) = default;
/**
* @brief 发生了异常后，设置异常。
* @attention 与set_value()互斥。调用了set_exception(e)后，不能再调用set_value()。
*/
void set_exception(std::exception_ptr e) const
{
counted_ptr<state_type> cp(std::move(this->_state));
cp->set_exception(std::move(e));
}
/**
* @brief 在协程内部，重新抛出之前设置的异常。
*/
template<class _Exp>
void throw_exception(_Exp e) const
{
set_exception(std::make_exception_ptr(std::move(e)));
}
/**
* @brief 获得与之关联的future_t<>对象，作为可等待函数(awaitable function)的返回值。
*/
future_type get_future() const noexcept
{
return future_type{ this->_state };
}
explicit operator bool() const noexcept
{
return _state.get() != nullptr;
}
/**
* @brief 管理的state_t<>对象。
*/
mutable counted_ptr<state_type> _state = state_future_t::_Alloc_state<state_type>(true);
};
/**
* @brief 用于包装‘异步函数’为‘可等待函数(awaitable function)’。
* @details 通过返回一个‘可等待对象(awaitor)’，符合C++ coroutines的co_await所需的接口，来达成‘可等待函数(awaitable function)’。\n
* 这是扩展异步函数支持协程的重要手段。\n
* \n
* 典型用法是申明一个 awaitable_t<>局部变量 awaitable，\n
* 在已经获得结果的情况下，直接调用 awaitable.set_value(value)设置返回值，使得可等待函数立即获得结果。\n
* 在不能立即获得结果的情况下，通过在异步的回调lambda里，捕获awaitable局部变量，\n
* 根据异步结果，要么调用 awaitable.set_value(value)设置结果值，要么调用 awaitable.set_exception(e)设置异常。\n
* 在设置值或者异常后，调用可等待函数的协程将得以继续执行。\n
* 此可等待函数通过 awaitable.get_future()返回与之关联的 future_t<>对象，作为协程的可等待对象。\n
* \n
* @param _Ty 可等待函数(awaitable function)的返回类型。\n
* 要求至少支持移动构造和移动赋值。\n
* _Ty 支持特化为 _Ty&，以及 void。
*/
template<class _Ty>
struct [[nodiscard]] awaitable_t : public awaitable_impl_t<_Ty>
{
using typename awaitable_impl_t<_Ty>::value_type;
using typename awaitable_impl_t<_Ty>::state_type;
using awaitable_impl_t<_Ty>::awaitable_impl_t;
/**
* @brief 设置可等待函数的返回值。
* @details _Ty的void特化版本，则是不带参数的set_value()函数。
* @param value 返回值。必须支持通过value构造出_Ty类型。
* @attention 与set_exception()互斥。调用了set_value(value)后，不能再调用set_exception(e)。
*/
template<class U>
void set_value(U&& value) const
{
counted_ptr<state_type> cp(std::move(this->_state));
cp->set_value(std::forward<U>(value));
}
};
#ifndef DOXYGEN_SKIP_PROPERTY
template<class _Ty>
struct [[nodiscard]] awaitable_t<_Ty&> : public awaitable_impl_t<_Ty&>
{
using typename awaitable_impl_t<_Ty&>::value_type;
using typename awaitable_impl_t<_Ty&>::state_type;
using awaitable_impl_t<_Ty&>::awaitable_impl_t;
void set_value(_Ty& value) const
{
counted_ptr<state_type> cp(std::move(this->_state));
cp->set_value(value);
}
};
template<>
struct [[nodiscard]] awaitable_t<void> : public awaitable_impl_t<void>
{
using awaitable_impl_t<void>::state_type;
using awaitable_impl_t<void>::awaitable_impl_t;
void set_value() const
{
counted_ptr<state_type> cp(std::move(this->_state));
cp->set_value();
}
};
#endif //DOXYGEN_SKIP_PROPERTY
}
================================================
FILE: include/librf/src/channel.h
================================================
#pragma once
#include "channel_v2.h"
#include "channel_v2.inl"
================================================
FILE: include/librf/src/channel_v2.h
================================================
#pragma once
namespace librf
{
#ifndef DOXYGEN_SKIP_PROPERTY
namespace detail
{
template<class _Ty, bool _Optional, bool _OptimizationThread>
struct channel_impl_v2;
} //namespace detail
#endif //DOXYGEN_SKIP_PROPERTY
/**
* @brief 可传递数据的模板信号量。
* @remarks 不支持数据类型为void的特例化。
* @param _Ty 传递的数据类型。要求此类型至少支持移动构造和移动赋值。
* @param _Optional 内部是否采用std::optional<>来存数据。\n
* 默认不是POD类型则采用std::optional<>。如果channel缓存的元素不能凭空产生，或者产生代价较大，则推荐将此参数设置为true，从而减小不必要的开销。
* @param _OptimizationThread 针对多线程优化。目前此算法提升效率不稳定，需要自行根据实际情况决定。
*/
template<class _Ty = bool, bool _Optional = !std::is_trivial_v<_Ty>, bool _OptimizationThread = false>
struct channel_t
{
static_assert((std::is_copy_constructible_v<_Ty>&& std::is_copy_assignable_v<_Ty>) ||
(std::is_move_constructible_v<_Ty> && std::is_move_assignable_v<_Ty>));
struct [[nodiscard]] read_awaiter;
struct [[nodiscard]] write_awaiter;
/**
* @brief 构造函数。
* @param cache_size 缓存的数量。0 表示内部无缓存。
*/
channel_t(size_t cache_size = 1);
/**
* @brief 获得缓存数量。
*/
size_t capacity() const noexcept;
/**
* @brief 在协程中从channel_t里读取一个数据。
* @see 参考read()函数
* @return [co_await] value_type
*/
read_awaiter operator co_await() const noexcept;
/**
* @brief 在协程中从channel_t里读取一个数据
* @details 如果没有写入数据，则会阻塞协程。
* @remarks 无缓冲的时候，先读后写，不再抛channel_exception异常。这是跟channel_v1的区别。\n
* 在非协程中也可以使用。如果不能立即读取成功，则会阻塞线程。\n
* 但如此用法并不能获得读取的结果，仅仅用作同步手段。
* @return [co_await] value_type
*/
read_awaiter read() const noexcept;
/**
* @brief 在协程中向channel_t里写入一个数据。
* @see 参考write()函数
*/
template<class U>
requires(std::is_constructible_v<_Ty, U&&>)
write_awaiter operator << (U&& val) const noexcept(std::is_nothrow_move_constructible_v<U>);
/**
* @brief 在协程中向channel_t里写入一个数据。
* @details 在没有读操作等待时，且数据缓冲区满的情况下，则会阻塞协程。
* @remarks 在非协程中也可以使用。如果不能立即写入成功，则会阻塞线程。
* @param val 写入的数据。必须是可以成功构造_Ty(val)的类型。
* @return [co_await] void
*/
template<class U>
requires(std::is_constructible_v<_Ty, U&&>)
write_awaiter write(U&& val) const noexcept(std::is_nothrow_move_constructible_v<U>);
/**
* @brief 构造一个无效的信号量。
* @details 如果用于后续保存另外一个信号量，则应当使用此构造函数，便于节省一次不必要的内部初始化。
*/
channel_t(std::adopt_lock_t);
/**
* @brief 判断是不是一个无效的信号量。
*/
bool valid() const noexcept;
#ifndef DOXYGEN_SKIP_PROPERTY
using value_type = _Ty;
static constexpr bool use_optional = _Optional;
static constexpr bool optimization_for_multithreading = _OptimizationThread;
using optional_type = std::conditional_t<use_optional, std::optional<value_type>, value_type>;
using channel_type = detail::channel_impl_v2<value_type, use_optional, optimization_for_multithreading>;
using lock_type = typename channel_type::lock_type;
channel_t(const channel_t&) = default;
channel_t(channel_t&&) = default;
channel_t& operator = (const channel_t&) = default;
channel_t& operator = (channel_t&&) = default;
private:
std::shared_ptr<channel_type> _chan;
#endif //DOXYGEN_SKIP_PROPERTY
};
#ifndef DOXYGEN_SKIP_PROPERTY
//不支持channel_t<void>
template<bool _Option, bool _OptimizationThread>
struct channel_t<void, _Option, _OptimizationThread>
{
};
#endif //DOXYGEN_SKIP_PROPERTY
/**
* @brief 利用channel_t重定义的信号量。
*/
using semaphore_t = channel_t<bool, false, true>;
} //namespace librf
================================================
FILE: include/librf/src/channel_v2.inl
================================================
#pragma once
namespace librf
{
namespace detail
{
template<class _Ty, class _Chty>
struct state_channel_t : public state_base_t
, public intrusive_link_node<state_channel_t<_Ty, _Chty>>
{
using value_type = _Ty;
state_channel_t(std::shared_ptr<_Chty> ch, value_type& val) noexcept
: _channel(std::move(ch))
, _value(std::addressof(val))
{
}
virtual void resume() override
{
coroutine_handle<> handler = _coro;
if (handler)
{
_coro = nullptr;
_scheduler->del_final(this);
handler.resume();
}
}
virtual bool has_handler() const noexcept override
{
return (bool)_coro;
}
void on_notify()
{
assert(this->_scheduler != nullptr);
if (this->_coro)
this->_scheduler->add_generator(this);
}
void on_cancel() noexcept
{
this->_coro = nullptr;
}
template<class _PromiseT> requires(traits::is_promise_v<_PromiseT>)
void on_await_suspend(coroutine_handle<_PromiseT> handler) noexcept
{
_PromiseT& promise = handler.promise();
auto* parent_state = promise.get_state();
scheduler_t* sch = parent_state->get_scheduler();
this->_scheduler = sch;
this->_coro = handler;
}
friend _Chty;
protected:
//co_await产生的临时awaitor会引用state，管理state的生命周期
//state再引用channel
//从而在co_await channel.xxx()这条语句内，awaitor/state/channel均处于正确的生命周期
std::shared_ptr<_Chty> _channel;
protected:
value_type* _value;
};
//-----------------------------------------------------------------------------------------------------------------------------------------
template<class _Ty, bool _Optional, bool _OptimizationThread>
struct channel_impl_v2 : public std::enable_shared_from_this<channel_impl_v2<_Ty, _Optional, _OptimizationThread>>
{
using value_type = _Ty;
using optional_type = std::conditional_t<_Optional, std::optional<value_type>, value_type>;
using this_type = channel_impl_v2<value_type, _Optional, _OptimizationThread>;
using state_read_t = state_channel_t<optional_type, this_type>;
using state_write_t = state_channel_t<value_type, this_type>;
channel_impl_v2(size_t cache_size);
bool try_read(optional_type& val);
bool try_read_nolock(optional_type& val);
void add_read_list_nolock(state_read_t* state);
bool try_write(value_type& val);
bool try_write_nolock(value_type& val);
void add_write_list_nolock(state_write_t* state);
size_t capacity() const noexcept
{
return _max_counter;
}
private:
auto try_pop_reader_()->state_read_t*;
auto try_pop_writer_()->state_write_t*;
void awake_one_reader_();
bool awake_one_reader_(value_type& val);
void awake_one_writer_();
bool awake_one_writer_(optional_type& val);
channel_impl_v2(const channel_impl_v2&) = delete;
channel_impl_v2(channel_impl_v2&&) = delete;
channel_impl_v2& operator = (const channel_impl_v2&) = delete;
channel_impl_v2& operator = (channel_impl_v2&&) = delete;
static constexpr bool USE_SPINLOCK = !_OptimizationThread;
static constexpr bool USE_RING_QUEUE = true;
static constexpr bool USE_LINK_QUEUE = true;
using queue_type = std::conditional_t<USE_RING_QUEUE, ring_queue<value_type, _Optional, uint32_t>, std::deque<value_type>>;
using read_queue_type = std::conditional_t<USE_LINK_QUEUE, intrusive_link_queue<state_read_t>, std::list<state_read_t*>>;
using write_queue_type = std::conditional_t<USE_LINK_QUEUE, intrusive_link_queue<state_write_t>, std::list<state_write_t*>>;
const size_t _max_counter; //数据队列的容量上限
public:
using lock_type = std::conditional_t<USE_SPINLOCK, spinlock, std::mutex>;
lock_type _lock; //保证访问本对象是线程安全的
private:
queue_type _values; //数据队列
read_queue_type _read_awakes; //读队列
write_queue_type _write_awakes; //写队列
};
//-----------------------------------------------------------------------------------------------------------------------------------------
template<class _Ty, bool _Optional, bool _OptimizationThread>
channel_impl_v2<_Ty, _Optional, _OptimizationThread>::channel_impl_v2(size_t cache_size)
: _max_counter(cache_size)
, _values(USE_RING_QUEUE ? cache_size : 0)
{
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
inline bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_read(optional_type& val)
{
scoped_lock<lock_type> lock_(this->_lock);
return try_read_nolock(val);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_read_nolock(optional_type& val)
{
if constexpr (USE_RING_QUEUE)
{
if (_values.try_pop(val))
{
awake_one_writer_();
return true;
}
}
else
{
if (_values.size() > 0)
{
val = std::move(_values.front());
_values.pop_front();
awake_one_writer_();
return true;
}
}
return awake_one_writer_(val);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
inline void channel_impl_v2<_Ty, _Optional, _OptimizationThread>::add_read_list_nolock(state_read_t* state)
{
assert(state != nullptr);
_read_awakes.push_back(state);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
inline bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_write(value_type& val)
{
scoped_lock<lock_type> lock_(this->_lock);
return try_write_nolock(val);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_write_nolock(value_type& val)
{
if constexpr (USE_RING_QUEUE)
{
if (_values.try_push(std::move(val)))
{
awake_one_reader_();
return true;
}
}
else
{
if (_values.size() < _max_counter)
{
_values.push_back(std::move(val));
awake_one_reader_();
return true;
}
}
return awake_one_reader_(val);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
inline void channel_impl_v2<_Ty, _Optional, _OptimizationThread>::add_write_list_nolock(state_write_t* state)
{
assert(state != nullptr);
_write_awakes.push_back(state);
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
auto channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_pop_reader_()->state_read_t*
{
if constexpr (USE_LINK_QUEUE)
{
return _read_awakes.try_pop();
}
else
{
if (!_read_awakes.empty())
{
state_read_t* state = _read_awakes.front();
_read_awakes.pop_front();
return state;
}
return nullptr;
}
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
auto channel_impl_v2<_Ty, _Optional, _OptimizationThread>::try_pop_writer_()->state_write_t*
{
if constexpr (USE_LINK_QUEUE)
{
return _write_awakes.try_pop();
}
else
{
if (!_write_awakes.empty())
{
state_write_t* state = _write_awakes.front();
_write_awakes.pop_front();
return state;
}
return nullptr;
}
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
void channel_impl_v2<_Ty, _Optional, _OptimizationThread>::awake_one_reader_()
{
state_read_t* state = try_pop_reader_();
if (state != nullptr)
{
assert(!_values.empty());
if constexpr (USE_RING_QUEUE)
{
_values.try_pop(*state->_value);
}
else
{
*state->_value = std::move(_values.front());
_values.pop_front();
}
state->on_notify();
}
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::awake_one_reader_(value_type& val)
{
state_read_t* state = try_pop_reader_();
if (state != nullptr)
{
*state->_value = std::move(val);
state->on_notify();
return true;
}
return false;
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
void channel_impl_v2<_Ty, _Optional, _OptimizationThread>::awake_one_writer_()
{
state_write_t* state = try_pop_writer_();
if (state != nullptr)
{
if constexpr (USE_RING_QUEUE)
{
bool ret = _values.try_push(std::move(*state->_value));
(void)ret;
assert(ret);
}
else
{
assert(_values.size() < _max_counter);
_values.push_back(std::move(*state->_value));
}
state->on_notify();
}
}
template<class _Ty, bool _Optional, bool _OptimizationThread>
bool channel_impl_v2<_Ty, _Optional, _OptimizationThread>::awake_one_writer_(optional_type& val)
{
state_write_t* writer = try_pop_writer_();
if (writer != nullptr)
{
val = std::move(*writer->_value);
writer->on_notify();
return true;
}
return false;
}
} //namespace detail
//-----------------------------------------------------------------------------------------------------------------------------------------
template<class _Ty, bool _Optional, bool _OptimizationThread>
struct [[nodiscard]] channel_t<_Ty, _Optional, _OptimizationThread>::read_awaiter
{
using state_type = typename channel_type::state_read_t;
read_awaiter(std::shared_ptr<channel_type> ch) noexcept
: _channel(std::move(ch))
, _value()
{}
read_awaiter(const read_awaiter&) = delete;
read_awaiter(read_awaiter&&) = default;
read_awaiter& operator=(const read_awaiter&) = delete;
read_awaiter& operator=(read_awaiter&&) = default;
~read_awaiter()
{//为了不在协程中也能正常使用
if (_channel != nullptr)
{
while(!_channel->try_read(_value));
}
}
bool await_ready()
{
//在多线程竞争较为多的时候，先检查是否可用，可以稍微提高点效率
if constexpr (optimization_for_multithreading)
{
scoped_lock<lock_type> lock_(_channel->_lock);
if (_channel->try_read_nolock(_value))
{
_channel = nullptr;
return true;
}
}
return false;
}
template<class _PromiseT> requires(traits::is_promise_v<_PromiseT>)
bool await_suspend(coroutine_handle<_PromiseT> handler)
{
scoped_lock<lock_type> lock_(_channel->_lock);
if (_channel->try_read_nolock(_value))
{
_channel = nullptr;
return false;
}
_state = new state_type(_channel, _value);
_state->on_await_suspend(handler);
_channel->add_read_list_nolock(_state.get());
_channel = nullptr;
return true;
}
value_type await_resume()
{
if constexpr (use_optional)
return std::move(_value).value();
else
return std::move(_value);
}
private:
std::shared_ptr<channel_type> _channel;
counted_ptr<state_type> _state; //延迟到await_suspend()里创建，减小不必要的内存申请
mutable optional_type _value;
};
template<class _Ty, bool _Optional, bool _OptimizationThread>
struct [[nodiscard]] channel_t<_Ty, _Optional, _OptimizationThread>::write_awaiter
{
using state_type = typename channel_type::state_write_t;
template<class U>
write_awaiter(std::shared_ptr<channel_type> ch, U&& val) noexcept(std::is_move_constructible_v<value_type>)
: _channel(std::move(ch))
, _value(std::forward<U>(val))
{}
write_awaite
gitextract_aarctyfv/
├── .github/
│ └── workflows/
│ └── cmake.yml
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── Config.cmake.in
├── Doxyfile
├── LICENSE
├── README.md
├── asio/
│ ├── asio_task.h
│ ├── asio_task_1.10.0.inl
│ ├── asio_task_1.12.0.inl
│ └── asio_task_1.12.2.inl
├── benchmark/
│ ├── CMakeLists.txt
│ ├── benchmark_asio_echo.cpp
│ ├── benchmark_async_mem.cpp
│ └── benchmark_channel_passing_next.cpp
├── cmake/
│ ├── SelectDynamicLibrary.cmake
│ └── install.cmake
├── config.h.in
├── gcc_bugs.cpp
├── include/
│ └── librf/
│ ├── librf.h
│ ├── librf_macro.h
│ └── src/
│ ├── _awaker.h
│ ├── awaitable.h
│ ├── channel.h
│ ├── channel_v2.h
│ ├── channel_v2.inl
│ ├── config.h
│ ├── counted_ptr.h
│ ├── current_scheduler.h
│ ├── def.h
│ ├── event.h
│ ├── event_v2.h
│ ├── event_v2.inl
│ ├── exception.inl
│ ├── future.h
│ ├── generator.h
│ ├── intrusive_link_queue.h
│ ├── macro_def.inl
│ ├── mutex.h
│ ├── mutex_v2.h
│ ├── mutex_v2.inl
│ ├── promise.h
│ ├── promise.inl
│ ├── rf_task.h
│ ├── ring_queue.h
│ ├── scheduler.h
│ ├── sleep.h
│ ├── spinlock.h
│ ├── state.h
│ ├── state.inl
│ ├── stop_token.h
│ ├── switch_scheduler.h
│ ├── timer.h
│ ├── type_concept.inl
│ ├── type_traits.inl
│ ├── unix/
│ │ ├── clang_builtin.h
│ │ ├── coroutine.h
│ │ └── gcc_builtin.h
│ ├── when.h
│ ├── when_v2.h
│ ├── without_deadlock_assemble.inl
│ └── yield.h
├── source/
│ ├── event_v2.cpp
│ ├── mutex_v2.cpp
│ ├── rf_task.cpp
│ ├── scheduler.cpp
│ ├── sleep.cpp
│ ├── state.cpp
│ ├── timer.cpp
│ └── when_v2.cpp
├── test_librf.cpp
└── tutorial/
├── CMakeLists.txt
├── test_async_cb.cpp
├── test_async_channel.cpp
├── test_async_channel_mult_thread.cpp
├── test_async_dynamic_go.cpp
├── test_async_event.cpp
├── test_async_event_timeout.cpp
├── test_async_event_v2.cpp
├── test_async_exception.cpp
├── test_async_memory_layout.cpp
├── test_async_modern_cb.cpp
├── test_async_multi_thread.cpp
├── test_async_mutex.cpp
├── test_async_resumable.cpp
├── test_async_routine.cpp
├── test_async_sleep.cpp
├── test_async_stop_token.cpp
├── test_async_suspend_always.cpp
├── test_async_switch_scheduler.cpp
├── test_async_timer.cpp
├── test_async_when_all.cpp
├── test_async_yield_return.cpp
└── test_memory_leak.cpp
SYMBOL INDEX (367 symbols across 59 files)
FILE: benchmark/benchmark_asio_echo.cpp
function uarray (line 19) | uarray(Args&... args)
function RunEchoSession (line 35) | future_t<> RunEchoSession(tcp::socket socket)
function AcceptConnections (line 62) | void AcceptConnections(tcp::acceptor & acceptor, uarray<tcp::socket, _N>...
function StartPrintEchoCount (line 91) | void StartPrintEchoCount()
function RunOneBenchmark (line 106) | void RunOneBenchmark(bool bMain)
function resumable_main_benchmark_asio_server (line 124) | void resumable_main_benchmark_asio_server()
function RunPipelineEchoClient (line 138) | future_t<> RunPipelineEchoClient(asio::io_service & ios, tcp::resolver::...
function catch (line 181) | catch (std::exception & e)
function RunPingPongEchoClient (line 189) | future_t<> RunPingPongEchoClient(asio::io_service & ios, tcp::resolver::...
function resumable_main_benchmark_asio_client_with_rf (line 217) | void resumable_main_benchmark_asio_client_with_rf(intptr_t nNum)
class chat_session (line 247) | class chat_session : public std::enable_shared_from_this<chat_session>
method chat_session (line 250) | chat_session(asio::io_service & ios, tcp::resolver::iterator ep)
method start (line 256) | void start()
method do_connect (line 262) | void do_connect()
method do_read (line 282) | void do_read()
method do_write (line 299) | void do_write()
function resumable_main_benchmark_asio_client_with_callback (line 324) | void resumable_main_benchmark_asio_client_with_callback(intptr_t nNum)
function resumable_main_benchmark_asio_client (line 350) | void resumable_main_benchmark_asio_client(intptr_t nNum)
function main (line 356) | int main(int argc, const char* argv[])
FILE: benchmark/benchmark_async_mem.cpp
function resumable_main_benchmark_mem (line 14) | void resumable_main_benchmark_mem(bool wait_key)
function main (line 47) | int main()
FILE: benchmark/benchmark_channel_passing_next.cpp
function passing_next (line 20) | static future_t<> passing_next(channel_t<intptr_t> rd, channel_t<intptr_...
function passing_loop_all (line 30) | static future_t<> passing_loop_all(channel_t<intptr_t> head, channel_t<i...
function benchmark_main_channel_passing_next (line 45) | void benchmark_main_channel_passing_next()
function main (line 80) | int main()
FILE: gcc_bugs.cpp
function gcc_bugs_while_await (line 29) | static future_t<> gcc_bugs_while_await(mutex_t lock)
function gcc_bugs_lambda_coroutines_fixed (line 46) | static future_t<> gcc_bugs_lambda_coroutines_fixed(std::thread& other, c...
function gcc_bugs_lambda_coroutines (line 53) | static void gcc_bugs_lambda_coroutines()
function gcc_bugs_lambda_coroutines2_fixed (line 73) | static future_t<> gcc_bugs_lambda_coroutines2_fixed(channel_t<intptr_t> ...
function gcc_bugs_lambda_coroutines2 (line 82) | static void gcc_bugs_lambda_coroutines2()
function gcc_bugs_nameless_args (line 105) | static future_t<> gcc_bugs_nameless_args(adopt_manual_unlock_t
function gcc_bugs (line 120) | void gcc_bugs()
FILE: include/librf/src/_awaker.h
function namespace (line 5) | namespace librf
FILE: include/librf/src/awaitable.h
function namespace (line 3) | namespace librf
function set_value (line 110) | void set_value(_Ty& value) const
FILE: include/librf/src/channel_v2.h
function namespace (line 6) | namespace detail
FILE: include/librf/src/counted_ptr.h
function namespace (line 3) | namespace librf
FILE: include/librf/src/current_scheduler.h
function namespace (line 3) | namespace librf
function get_current_scheduler_awaitor (line 59) | inline get_current_scheduler_awaitor get_current_scheduler() noexcept
function requires (line 68) | struct get_root_state_awaitor
function state_base_t (line 85) | state_base_t* await_resume() const noexcept
function get_root_state_awaitor (line 119) | inline get_root_state_awaitor get_root_state() noexcept
function requires (line 127) | struct get_current_task_awaitor
function task_t (line 147) | task_t* await_resume() const noexcept
function get_current_task_awaitor (line 181) | inline get_current_task_awaitor get_current_task() noexcept
FILE: include/librf/src/def.h
function namespace (line 6) | namespace std
function namespace (line 16) | namespace librf
function namespace (line 68) | namespace librf
FILE: include/librf/src/event_v2.h
function namespace (line 6) | namespace detail
FILE: include/librf/src/future.h
function namespace (line 4) | namespace librf
FILE: include/librf/src/generator.h
type difference_type (line 23) | typedef ptrdiff_t difference_type;
function _Coro (line 31) | _Coro(_CoroArg)
function right_ (line 51) | bool operator==(generator_iterator const& right_) const
function right_ (line 56) | bool operator!=(generator_iterator const& right_) const
type promise_type (line 109) | struct promise_type
function generator_t (line 126) | generator_t get_return_object()
function suspend_always (line 131) | suspend_always initial_suspend() noexcept
function suspend_always (line 136) | suspend_always final_suspend() noexcept
function suspend_always (line 141) | suspend_always yield_value(_Ty const& _Value) noexcept
function return_value (line 148) | void return_value(_Ty const& _Value) noexcept
function return_value (line 153) | void return_value() noexcept
function set_exception (line 158) | void set_exception(std::exception_ptr e)
function unhandled_exception (line 165) | void unhandled_exception()
function state_type (line 180) | state_type* get_state() noexcept
function state_type (line 188) | state_type* ref_state() noexcept
function delete (line 212) | void operator delete(void* _Ptr, size_t _Size)
function iterator (line 224) | iterator begin()
function iterator (line 235) | iterator end()
function explicit (line 240) | explicit generator_t(promise_type& _Prom)
function state_type (line 272) | state_type* detach_state()
FILE: include/librf/src/intrusive_link_queue.h
function namespace (line 3) | namespace librf
FILE: include/librf/src/mutex_v2.h
function namespace (line 3) | namespace librf
FILE: include/librf/src/promise.h
function namespace (line 7) | namespace librf
function requires (line 33) | struct suspend_on_final
function await_resume (line 46) | inline void await_resume() noexcept
function get_state (line 65) | auto get_state() noexcept->state_type*;
function suspend_on_initial (line 76) | suspend_on_initial initial_suspend() noexcept
function suspend_on_final (line 81) | suspend_on_final final_suspend() noexcept
function unhandled_exception (line 97) | void unhandled_exception() //If the coroutine ends with an uncaught exc...
function cancellation_requested (line 102) | void cancellation_requested() noexcept
function return_value (line 140) | void return_value(_Ty& val) //co_return val
function suspend_always (line 145) | suspend_always yield_value(_Ty& val)
type promise_t (line 153) | struct promise_t
function return_void (line 157) | void return_void() //co_return;
function suspend_always (line 162) | suspend_always yield_value()
FILE: include/librf/src/rf_task.h
function namespace (line 3) | namespace librf
FILE: include/librf/src/ring_queue.h
function namespace (line 3) | namespace librf
FILE: include/librf/src/scheduler.h
function namespace (line 3) | namespace librf
type local_scheduler_t (line 129) | struct local_scheduler_t
function add_generator (line 154) | inline void scheduler_t::add_generator(state_base_t* sptr)
function del_final (line 164) | inline void scheduler_t::del_final(state_base_t* sptr)
function add_switch (line 172) | inline void scheduler_t::add_switch(std::unique_ptr<task_t> task)
function task_t (line 182) | inline task_t* scheduler_t::find_task(state_base_t* sptr) const noexcept
FILE: include/librf/src/sleep.h
function namespace (line 7) | namespace librf
FILE: include/librf/src/spinlock.h
function namespace (line 5) | namespace librf
FILE: include/librf/src/state.h
function namespace (line 3) | namespace librf
function state_base_t (line 70) | struct state_generator_t : public state_base_t
type state_future_t (line 92) | struct state_future_t
type struct (line 94) | enum struct
function result_type (line 100) | enum struct result_type : uint8_t
FILE: include/librf/src/stop_token.h
function namespace (line 11) | namespace milk
type nostopstate_t (line 292) | struct nostopstate_t { explicit nostopstate_t() = default; }
function nostopstate_t (line 293) | inline constexpr nostopstate_t nostopstate{}
function explicit (line 308) | explicit stop_token(details::stop_state* state) noexcept
function state_ (line 323) | stop_token(const stop_token& other) noexcept
function stop_token (line 349) | stop_token tmp{other};
function stop_token (line 357) | stop_token tmp{std::move(other)};
function swap (line 362) | void swap(stop_token& other) noexcept
function noexcept (line 379) | [[nodiscard]]
function noexcept (line 385) | [[nodiscard]]
function class (line 393) | class stop_source
FILE: include/librf/src/switch_scheduler.h
function namespace (line 3) | namespace librf
function switch_scheduler_awaitor (line 91) | inline switch_scheduler_awaitor via(scheduler_t& sch) noexcept
function switch_scheduler_awaitor (line 100) | inline switch_scheduler_awaitor via(scheduler_t* sch) noexcept
FILE: include/librf/src/timer.h
function namespace (line 4) | namespace librf
FILE: include/librf/src/unix/coroutine.h
function namespace (line 34) | namespace std {
function coroutine_handle (line 168) | static constexpr coroutine_handle from_address(nullptr_t) noexcept {
function coroutine_handle (line 173) | coroutine_handle from_address(_Tp*) {
function coroutine_handle (line 186) | static coroutine_handle from_promise(_Promise& __promise) noexcept {
type noop_coroutine_promise (line 198) | struct noop_coroutine_promise {}
function noexcept (line 207) | const noexcept {
type suspend_never (line 240) | struct suspend_never {
function await_suspend (line 247) | constexpr void await_suspend(coroutine_handle<>) const noexcept {}
function await_resume (line 248) | constexpr void await_resume() const noexcept {}
FILE: include/librf/src/when_v2.h
function namespace (line 3) | namespace librf
function namespace (line 15) | namespace librf
FILE: include/librf/src/yield.h
function namespace (line 3) | namespace librf
function yield_awaitor (line 46) | inline yield_awaitor yield() noexcept
FILE: source/event_v2.cpp
type librf (line 3) | namespace librf
type detail (line 5) | namespace detail
function LIBRF_API (line 8) | LIBRF_API void state_event_t::on_cancel() noexcept
function LIBRF_API (line 20) | LIBRF_API bool state_event_t::on_notify(event_v2_impl* eptr)
function LIBRF_API (line 37) | LIBRF_API bool state_event_t::on_timeout()
function LIBRF_API (line 60) | LIBRF_API void state_event_all_t::on_cancel(intptr_t idx)
function LIBRF_API (line 79) | LIBRF_API bool state_event_all_t::on_notify(event_v2_impl*, intptr_t...
function LIBRF_API (line 111) | LIBRF_API bool state_event_all_t::on_timeout()
function try_pop_list (line 148) | static auto try_pop_list(intrusive_link_queue<_Ty, _Ptr>& list)
function _Ptr (line 153) | static _Ptr try_pop_list(std::list<_Ptr>& list)
function clear_list (line 164) | static void clear_list(intrusive_link_queue<_Ty, _Ptr>& list)
function clear_list (line 169) | static void clear_list(std::list<_Ptr>& list)
function LIBRF_API (line 174) | LIBRF_API event_v2_impl::~event_v2_impl()
function LIBRF_API (line 179) | LIBRF_API void event_v2_impl::signal_all() noexcept
function LIBRF_API (line 190) | LIBRF_API void event_v2_impl::signal() noexcept
function LIBRF_API (line 204) | LIBRF_API void event_v2_impl::reset() noexcept
function LIBRF_API (line 209) | LIBRF_API void event_v2_impl::add_wait_list(state_event_base_t* state)
function LIBRF_API (line 215) | LIBRF_API void event_v2_impl::remove_wait_list(state_event_base_t* s...
function LIBRF_API (line 224) | LIBRF_API event_t::event_t(bool initially)
function LIBRF_API (line 229) | LIBRF_API event_t::event_t(std::adopt_lock_t)
function LIBRF_API (line 233) | LIBRF_API event_t::~event_t()
FILE: source/mutex_v2.cpp
type librf (line 3) | namespace librf
type detail (line 5) | namespace detail
function LIBRF_API (line 7) | LIBRF_API void state_mutex_t::resume()
function LIBRF_API (line 18) | LIBRF_API bool state_mutex_t::has_handler() const noexcept
function LIBRF_API (line 23) | LIBRF_API state_base_t* state_mutex_t::get_parent() const noexcept
function LIBRF_API (line 29) | LIBRF_API void state_mutex_t::on_cancel() noexcept
function LIBRF_API (line 41) | LIBRF_API bool state_mutex_t::on_notify(mutex_v2_impl* eptr)
function LIBRF_API (line 60) | LIBRF_API bool state_mutex_t::on_timeout()
function LIBRF_API (line 77) | LIBRF_API void state_mutex_t::add_timeout_timer(std::chrono::system_...
function LIBRF_API (line 89) | LIBRF_API void mutex_v2_impl::lock_until_succeed(void* sch)
function LIBRF_API (line 101) | LIBRF_API bool mutex_v2_impl::try_lock(void* sch)
function LIBRF_API (line 109) | LIBRF_API bool mutex_v2_impl::try_lock_until(clock_type::time_point ...
function LIBRF_API (line 122) | LIBRF_API bool mutex_v2_impl::try_lock_lockless(void* sch) noexcept
function LIBRF_API (line 141) | LIBRF_API bool mutex_v2_impl::unlock(void* sch)
function LIBRF_API (line 178) | LIBRF_API void mutex_v2_impl::add_wait_list_lockless(state_mutex_t* ...
function LIBRF_API (line 186) | LIBRF_API mutex_t::mutex_t()
function LIBRF_API (line 191) | LIBRF_API mutex_t::mutex_t(std::adopt_lock_t) noexcept
function LIBRF_API (line 195) | LIBRF_API mutex_t::~mutex_t() noexcept
FILE: source/rf_task.cpp
type librf (line 3) | namespace librf
function LIBRF_API (line 5) | LIBRF_API task_t::task_t() noexcept
function LIBRF_API (line 10) | LIBRF_API task_t::~task_t()
function LIBRF_API (line 14) | LIBRF_API const stop_source & task_t::get_stop_source()
FILE: source/scheduler.cpp
type librf (line 11) | namespace librf
function LIBRF_API (line 27) | LIBRF_API const char * get_error_string(error_code fe, const char * cl...
function LIBRF_API (line 43) | LIBRF_API scheduler_t * this_scheduler()
function LIBRF_API (line 48) | LIBRF_API local_scheduler_t::local_scheduler_t()
function LIBRF_API (line 61) | LIBRF_API local_scheduler_t::local_scheduler_t(scheduler_t& sch) noexcept
function LIBRF_API (line 71) | LIBRF_API local_scheduler_t::~local_scheduler_t()
function LIBRF_API (line 78) | LIBRF_API scheduler_t::scheduler_t()
function LIBRF_API (line 88) | LIBRF_API scheduler_t::~scheduler_t()
function LIBRF_API (line 95) | LIBRF_API task_t* scheduler_t::new_task(task_t * task)
function LIBRF_API (line 116) | LIBRF_API std::unique_ptr<task_t> scheduler_t::del_switch(state_base_t...
function LIBRF_API (line 134) | LIBRF_API void scheduler_t::request_stop_all_if_possible()
function LIBRF_API (line 160) | LIBRF_API bool scheduler_t::run_one_batch()
function LIBRF_API (line 181) | LIBRF_API void scheduler_t::run_until_notask()
FILE: source/sleep.cpp
type librf (line 3) | namespace librf
function LIBRF_API (line 5) | LIBRF_API future_t<> sleep_until_(std::chrono::system_clock::time_poin...
FILE: source/state.cpp
type librf (line 3) | namespace librf
function LIBRF_API (line 5) | LIBRF_API state_base_t::~state_base_t()
function LIBRF_API (line 9) | LIBRF_API void state_base_t::destroy_deallocate()
function LIBRF_API (line 14) | LIBRF_API void state_base_t::resume()
function LIBRF_API (line 25) | LIBRF_API bool state_base_t::has_handler() const noexcept
function LIBRF_API (line 30) | LIBRF_API state_base_t* state_base_t::get_parent() const noexcept
function LIBRF_API (line 35) | LIBRF_API void state_future_t::destroy_deallocate()
function LIBRF_API (line 47) | LIBRF_API state_generator_t* state_generator_t::_Alloc_state()
function LIBRF_API (line 58) | LIBRF_API void state_generator_t::destroy_deallocate()
function LIBRF_API (line 70) | LIBRF_API void state_generator_t::resume()
function LIBRF_API (line 90) | LIBRF_API bool state_generator_t::has_handler() const noexcept
function LIBRF_API (line 95) | LIBRF_API bool state_generator_t::switch_scheduler_await_suspend(sched...
function LIBRF_API (line 117) | LIBRF_API state_base_t* state_future_t::get_parent() const noexcept
function LIBRF_API (line 122) | LIBRF_API void state_future_t::resume()
function LIBRF_API (line 161) | LIBRF_API bool state_future_t::has_handler() const noexcept
function LIBRF_API (line 167) | LIBRF_API bool state_future_t::switch_scheduler_await_suspend(schedule...
function LIBRF_API (line 193) | LIBRF_API void state_t<void>::future_await_resume()
function LIBRF_API (line 203) | LIBRF_API void state_t<void>::set_value()
function LIBRF_API (line 218) | LIBRF_API void state_t<void>::set_exception(std::exception_ptr e)
FILE: source/timer.cpp
type librf (line 3) | namespace librf
function LIBRF_API (line 5) | LIBRF_API timer_manager::timer_manager()
function LIBRF_API (line 10) | LIBRF_API timer_manager::~timer_manager()
function LIBRF_API (line 15) | LIBRF_API void timer_manager::call_target_(const timer_target_ptr & sp...
function LIBRF_API (line 26) | LIBRF_API void timer_manager::clear()
function LIBRF_API (line 44) | LIBRF_API detail::timer_target_ptr timer_manager::add_(const timer_tar...
function LIBRF_API (line 63) | LIBRF_API bool timer_manager::stop(const timer_target_ptr & sptr)
function LIBRF_API (line 75) | LIBRF_API void timer_manager::update()
FILE: source/when_v2.cpp
type librf (line 3) | namespace librf
type detail (line 5) | namespace detail
function LIBRF_API (line 7) | LIBRF_API state_when_t::state_when_t(intptr_t counter_)
function LIBRF_API (line 12) | LIBRF_API void state_when_t::resume()
function LIBRF_API (line 23) | LIBRF_API bool state_when_t::has_handler() const noexcept
function LIBRF_API (line 28) | LIBRF_API void state_when_t::on_cancel() noexcept
function LIBRF_API (line 36) | LIBRF_API bool state_when_t::on_notify_one()
function LIBRF_API (line 51) | LIBRF_API bool state_when_t::on_timeout()
FILE: test_librf.cpp
function main (line 34) | int main(int argc, const char* argv[])
FILE: tutorial/test_async_cb.cpp
function callback_get_long (line 11) | static void callback_get_long(int64_t val, _Ctype&& cb)
function async_get_long (line 22) | static future_t<int64_t> async_get_long(int64_t val)
function wait_get_long (line 32) | static future_t<int64_t> wait_get_long(int64_t val)
function resumable_get_long (line 39) | static future_t<int64_t> resumable_get_long(int64_t val)
function loop_get_long (line 51) | static future_t<int64_t> loop_get_long(int64_t val)
function async_get_string (line 62) | static future_t<std::string&> async_get_string(std::string & ref_string)
function resumable_get_string (line 73) | static future_t<std::string&> resumable_get_string(std::string& val)
function resumable_main_cb (line 85) | void resumable_main_cb()
function main (line 109) | int main()
FILE: tutorial/test_async_channel.cpp
type move_only_type (line 17) | struct move_only_type
method move_only_type (line 21) | move_only_type() = default;
method move_only_type (line 22) | explicit move_only_type(const _Ty& val) : value(val) {}
method move_only_type (line 23) | explicit move_only_type(_Ty&& val) : value(std::forward<_Ty>(val)) {}
method move_only_type (line 25) | move_only_type(const move_only_type&) = delete;
method move_only_type (line 26) | move_only_type& operator =(const move_only_type&) = delete;
method move_only_type (line 28) | move_only_type(move_only_type&&) = default;
method move_only_type (line 29) | move_only_type& operator =(move_only_type&&) = default;
function test_channel_read (line 36) | future_t<> test_channel_read(string_channel_t c)
function test_channel_write (line 60) | future_t<> test_channel_write(string_channel_t c)
function test_channel_read_first (line 74) | void test_channel_read_first()
function test_channel_write_first (line 84) | void test_channel_write_first()
function test_channel_performance_single_thread (line 96) | void test_channel_performance_single_thread(size_t buff_size)
function test_channel_performance_double_thread (line 126) | void test_channel_performance_double_thread(size_t buff_size)
FILE: tutorial/test_async_channel_mult_thread.cpp
function test_channel_consumer (line 20) | future_t<> test_channel_consumer(channel_t<std::string> c, size_t cnt)
function test_channel_producer (line 48) | future_t<> test_channel_producer(channel_t<std::string> c, size_t cnt)
function resumable_main_channel_mult_thread (line 67) | void resumable_main_channel_mult_thread()
function main (line 117) | int main()
FILE: tutorial/test_async_dynamic_go.cpp
function test_dynamic_go (line 14) | void test_dynamic_go()
function resumable_main_dynamic_go (line 58) | void resumable_main_dynamic_go()
function main (line 64) | int main()
FILE: tutorial/test_async_event.cpp
function async_set_event (line 11) | static std::thread async_set_event(const event_t & e, std::chrono::milli...
function resumable_wait_event (line 21) | static future_t<> resumable_wait_event(const event_t & e)
function test_wait_one (line 32) | static void test_wait_one()
function test_wait_three (line 65) | static void test_wait_three()
function test_wait_any (line 94) | static void test_wait_any()
function test_wait_all (line 124) | static void test_wait_all()
function test_wait_all_timeout (line 153) | static void test_wait_all_timeout()
function resumable_main_event (line 182) | void resumable_main_event()
function main (line 201) | int main()
FILE: tutorial/test_async_event_timeout.cpp
function resumalbe_set_event (line 10) | future_t<> resumalbe_set_event(const event_t & e, std::chrono::milliseco...
function async_set_event (line 17) | void async_set_event(const event_t & e, std::chrono::milliseconds dt)
function test_wait_timeout_one (line 26) | void test_wait_timeout_one()
function test_wait_timeout_any_invalid (line 54) | void test_wait_timeout_any_invalid()
function test_wait_timeout_any (line 73) | void test_wait_timeout_any()
function test_wait_timeout_all_invalid (line 112) | void test_wait_timeout_all_invalid()
function test_wait_timeout_all (line 131) | void test_wait_timeout_all()
function resumable_main_event_timeout (line 168) | void resumable_main_event_timeout()
function main (line 191) | int main()
FILE: tutorial/test_async_event_v2.cpp
function async_set_event_all (line 12) | static std::thread async_set_event_all(const event_t & e, std::chrono::m...
function async_set_event_one (line 21) | static std::thread async_set_event_one(event_t e, std::chrono::milliseco...
function resumable_wait_event (line 30) | static future_t<> resumable_wait_event(event_t e, int idx)
function resumable_wait_timeout (line 39) | static future_t<> resumable_wait_timeout(event_t e, milliseconds dt, int...
function test_notify_all (line 48) | static void test_notify_all()
function test_notify_one (line 61) | static void test_notify_one()
function test_wait_all_timeout (line 82) | static void test_wait_all_timeout()
function resumable_main_event_v2 (line 103) | void resumable_main_event_v2()
function main (line 116) | int main()
FILE: tutorial/test_async_exception.cpp
function async_signal_exception (line 11) | auto async_signal_exception(const intptr_t dividend)
function async_signal_exception2 (line 34) | auto async_signal_exception2(const intptr_t dividend)
function test_signal_exception (line 50) | future_t<> test_signal_exception()
function test_bomb_exception (line 70) | future_t<> test_bomb_exception()
function resumable_main_exception (line 79) | void resumable_main_exception(bool bomb)
function main (line 94) | int main()
FILE: tutorial/test_async_memory_layout.cpp
function callback_get_long (line 13) | static void callback_get_long(int64_t a, int64_t b, _Ctype&& cb)
function awaitable_get_long (line 31) | future_t<int64_t> awaitable_get_long(int64_t a, int64_t b)
function resumeable_get_long (line 48) | future_t<int64_t> resumeable_get_long(int64_t x, int64_t y)
function resumable_get_long_2 (line 85) | future_t<> resumable_get_long_2(int64_t a, int64_t b, int64_t c)
function resumable_main_layout (line 132) | void resumable_main_layout()
function main (line 145) | int main()
FILE: tutorial/test_async_modern_cb.cpp
function tostring_async_originalism (line 12) | void tostring_async_originalism(_Input_t&& value, _Callable_t&& token)
function tostring_async_originalism2 (line 19) | void tostring_async_originalism2(int value, std::function<void(std::stri...
function tostring_async_originalism_future (line 29) | auto tostring_async_originalism_future(_Input_t&& value)
function tostring_async (line 46) | auto tostring_async(_Input_t&& value, _Callable_t&& token)
function add_async (line 60) | auto add_async(_Ty1&& val1, _Ty2&& val2, _Callable_t&& token)
function muldiv_async (line 76) | auto muldiv_async(_Ty1&& val1, _Ty2&& val2, _Callable_t&& token)
function example_future (line 101) | static void example_future()
function example_librf (line 136) | static void example_librf()
function catch (line 162) | catch (...)
function resumable_main_modern_cb (line 171) | void resumable_main_modern_cb()
function main (line 179) | int main()
FILE: tutorial/test_async_multi_thread.cpp
function async_heavy_computing_tasks (line 12) | auto async_heavy_computing_tasks(int64_t val)
function heavy_computing_sequential (line 27) | future_t<> heavy_computing_sequential(int64_t val)
function test_use_single_thread (line 43) | void test_use_single_thread(int64_t val)
function test_use_multi_thread (line 64) | void test_use_multi_thread()
function resumable_main_multi_thread (line 76) | void resumable_main_multi_thread()
function main (line 91) | int main()
FILE: tutorial/test_async_mutex.cpp
function test_mutex_pop (line 19) | static future_t<> test_mutex_pop(size_t idx)
function test_mutex_push (line 44) | static future_t<> test_mutex_push(size_t idx)
function test_mutex_try_push (line 60) | static future_t<> test_mutex_try_push(size_t idx)
function test_mutex_timeout_push (line 83) | static future_t<> test_mutex_timeout_push(size_t idx)
function test_mutex_async_push (line 107) | static std::thread test_mutex_async_push(size_t idx)
function resumable_mutex_synch (line 130) | static void resumable_mutex_synch()
function resumable_mutex_async (line 140) | static void resumable_mutex_async()
function resumable_mutex_range_push (line 152) | static future_t<> resumable_mutex_range_push(size_t idx, mutex_t a, mute...
function resumable_mutex_range_pop (line 167) | static future_t<> resumable_mutex_range_pop(size_t idx, mutex_t a, mutex...
function resumable_mutex_lock_range (line 182) | static void resumable_mutex_lock_range()
function resumable_main_mutex (line 206) | void resumable_main_mutex()
function main (line 221) | int main()
FILE: tutorial/test_async_resumable.cpp
function dump (line 12) | void dump(size_t idx, std::string name, T start, T end, intptr_t count)
function yield_switch (line 29) | auto yield_switch(intptr_t coro) -> librf::generator_t<intptr_t>
function resumable_switch (line 36) | void resumable_switch(intptr_t coro, size_t idx)
function resumable_main_resumable (line 55) | void resumable_main_resumable()
function main (line 82) | int main()
FILE: tutorial/test_async_routine.cpp
function test_routine_use_timer (line 12) | future_t<> test_routine_use_timer()
function test_routine_use_timer_2 (line 24) | future_t<> test_routine_use_timer_2()
function resumable_main_routine (line 37) | void resumable_main_routine()
function main (line 48) | int main()
FILE: tutorial/test_async_sleep.cpp
function test_sleep_use_timer (line 11) | future_t<> test_sleep_use_timer()
function test_wait_all_events_with_signal_by_sleep (line 33) | void test_wait_all_events_with_signal_by_sleep()
function resumable_main_sleep (line 67) | void resumable_main_sleep()
function main (line 78) | int main()
FILE: tutorial/test_async_stop_token.cpp
function callback_get_long_with_stop (line 13) | static void callback_get_long_with_stop(stop_token token, int64_t val, _...
function async_get_long_with_stop (line 35) | static future_t<int64_t> async_get_long_with_stop(stop_token token, int6...
function async_get_long_with_stop (line 54) | static future_t<int64_t> async_get_long_with_stop(int64_t val)
function test_get_long_with_stop (line 61) | static void test_get_long_with_stop(int64_t val)
function resumable_main_stop_token (line 90) | void resumable_main_stop_token()
function main (line 100) | int main()
FILE: tutorial/test_async_suspend_always.cpp
function test_loop_sleep (line 11) | future_t<> test_loop_sleep(size_t _N, const char * ch)
function test_recursive_await (line 23) | future_t<> test_recursive_await()
function test_recursive_go (line 37) | future_t<> test_recursive_go()
function resumable_main_suspend_always (line 51) | void resumable_main_suspend_always()
function main (line 97) | int main()
FILE: tutorial/test_async_switch_scheduler.cpp
function run_in_thread (line 13) | void run_in_thread(channel_t<bool> c_done)
function callback_get_long_switch_scheduler (line 32) | static void callback_get_long_switch_scheduler(int64_t val, _Ctype&& cb)
function async_get_long_switch_scheduler (line 43) | static future_t<int64_t> async_get_long_switch_scheduler(int64_t val)
function resumable_get_long_switch_scheduler (line 54) | static future_t<> resumable_get_long_switch_scheduler(int64_t val, chann...
function resumable_main_switch_scheduler_fix_gcc_bugs (line 92) | static future_t<> resumable_main_switch_scheduler_fix_gcc_bugs(std::thre...
function resumable_main_switch_scheduler (line 105) | void resumable_main_switch_scheduler()
function main (line 139) | int main()
FILE: tutorial/test_async_timer.cpp
function resumable_main_timer (line 11) | void resumable_main_timer()
function main (line 38) | int main()
FILE: tutorial/test_async_when_all.cpp
function test_when_any (line 13) | void test_when_any()
function test_when_all (line 70) | void test_when_all()
function test_when_any_mix (line 142) | void test_when_any_mix()
function test_when_select (line 178) | void test_when_select()
function resumable_main_when_all (line 224) | void resumable_main_when_all()
function main (line 244) | int main()
FILE: tutorial/test_async_yield_return.cpp
function test_yield_int (line 11) | generator_t<int> test_yield_int()
function test_yield_void (line 44) | auto test_yield_void() -> generator_t<>
function test_yield_future (line 59) | auto test_yield_future() -> future_t<int64_t>
function resumable_main_yield_return (line 74) | void resumable_main_yield_return()
function main (line 93) | int main()
FILE: tutorial/test_memory_leak.cpp
function test_memory_leak_event_wait_for (line 12) | void test_memory_leak_event_wait_for()
function test_memory_leak_event_wait_all_for (line 35) | void test_memory_leak_event_wait_all_for()
function main (line 59) | int main()
Condensed preview — 95 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (532K chars).
[
{
"path": ".github/workflows/cmake.yml",
"chars": 1887,
"preview": "name: CMake\n\non: [push]\n\nenv:\n # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)\n BUILD_TYP"
},
{
"path": ".gitignore",
"chars": 399,
"preview": "################################################################################\r\n# This .gitignore file was automatica"
},
{
"path": ".gitmodules",
"chars": 92,
"preview": "[submodule \"modern_cb\"]\n\tpath = modern_cb\n\turl = https://github.com/tearshark/modern_cb.git\n"
},
{
"path": "CMakeLists.txt",
"chars": 5266,
"preview": "cmake_minimum_required(VERSION 3.10)\r\nproject(librf VERSION 3.0)\r\n\r\nset(CMAKE_CXX_STANDARD 20)\r\nset(CMAKE_CXX_STANDARD_"
},
{
"path": "Config.cmake.in",
"chars": 106,
"preview": "include(${CMAKE_CURRENT_LIST_DIR}/SelectDynamicLibrary.cmake)\nselect_dynamic_library(librf librf/librf.h)\n"
},
{
"path": "Doxyfile",
"chars": 114880,
"preview": "# Doxyfile 1.8.17\r\n\r\n# This file describes the settings to be used by the documentation system\r\n# doxygen (www.doxygen.o"
},
{
"path": "LICENSE",
"chars": 11342,
"preview": " Apache License\n Version 2.0, January 2004\n "
},
{
"path": "README.md",
"chars": 3535,
"preview": "# librf 2.9.10\n\n### librf - 协程库\n * librf是一个基于C++20 coroutines编写的无栈协程库。\n\n支持以下平台和编译器:\n\n\tWindows: 使用VS2017/VS2019编译(clang在"
},
{
"path": "asio/asio_task.h",
"chars": 180,
"preview": "#pragma once\n\n#if ASIO_VERSION >= 101202\n#include \"asio_task_1.12.2.inl\"\n#elif ASIO_VERSION >= 101200\n#include \"asio_ta"
},
{
"path": "asio/asio_task_1.10.0.inl",
"chars": 3156,
"preview": "#include <memory>\n\n#include \"asio/detail/push_options.hpp\"\n\nnamespace asio {\n\n\ttemplate<typename Allocator = std::alloc"
},
{
"path": "asio/asio_task_1.12.0.inl",
"chars": 5503,
"preview": "#include <memory>\n\n#include \"asio/detail/push_options.hpp\"\n\nnamespace asio {\n\n\t/**\n\t * @brief 用于指示asio相关异步函数，返回librf::f"
},
{
"path": "asio/asio_task_1.12.2.inl",
"chars": 5473,
"preview": "#include <memory>\n\n#include \"asio/detail/push_options.hpp\"\n\nnamespace asio {\n\n\t/**\n\t * @brief 用于指示asio相关异步函数，返回librf::f"
},
{
"path": "benchmark/CMakeLists.txt",
"chars": 641,
"preview": "set(BENCHMARK_FILES \"\")\naux_source_directory(${CMAKE_CURRENT_SOURCE_DIR} BENCHMARK_FILES)\n\nfind_package(asio REQUIRED)\n"
},
{
"path": "benchmark/benchmark_asio_echo.cpp",
"chars": 7187,
"preview": "\r\n#include <iostream>\r\n\r\n#include \"librf/librf.h\"\r\n#include <asio.hpp>\r\n#include \"../asio/asio_task.h\"\r\n\r\n#pragma warni"
},
{
"path": "benchmark/benchmark_async_mem.cpp",
"chars": 1068,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nconst siz"
},
{
"path": "benchmark/benchmark_channel_passing_next.cpp",
"chars": 1769,
"preview": "\n#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n#include <deque>\n#include <mutex>\n\n#include "
},
{
"path": "cmake/SelectDynamicLibrary.cmake",
"chars": 6919,
"preview": "include(SelectLibraryConfigurations)\n\nif(NOT DEFINED CMAKE_PROCESSOR_ALIAS)\n MESSAGE(STATUS \"operation system is ${CM"
},
{
"path": "cmake/install.cmake",
"chars": 1745,
"preview": "\n# Configuration\n# Used by cmake to find_package(xxx)\nset(PROJECT_CONFIG \"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Co"
},
{
"path": "config.h.in",
"chars": 601,
"preview": "#pragma once\r\n\r\n#ifndef RESUMEF_DEBUG_COUNTER\r\n#cmakedefine RESUMEF_DEBUG_COUNTER @RESUMEF_DEBUG_COUNTER@\r\n#endif\t//RESU"
},
{
"path": "gcc_bugs.cpp",
"chars": 2781,
"preview": "/*\ng++ --version:\n\ng++ (Ubuntu 10 - 20200416 - 0ubuntu1~18.04) 10.0.1 20200416 (experimental)[master revision 3c3f12e2a"
},
{
"path": "include/librf/librf.h",
"chars": 2800,
"preview": "/*\n *Copyright 2017~2020 lanzhengpeng\n *\n *Licensed under the Apache License, Version 2.0 (the \"License\");\n *you may no"
},
{
"path": "include/librf/librf_macro.h",
"chars": 29,
"preview": "#include \"src/macro_def.inl\""
},
{
"path": "include/librf/src/_awaker.h",
"chars": 1416,
"preview": "#pragma once\n\n#ifndef DOXYGEN_SKIP_PROPERTY\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\t\ttemplate<class _Ety, class... _Ty"
},
{
"path": "include/librf/src/awaitable.h",
"chars": 3585,
"preview": "#pragma once\n\nnamespace librf\n{\n\n\t/**\n\t * @brief awaitable_t<>的公共实现部分，用于减少awaitable_t<>的重复代码。\n\t * @param _Ty 可等待函数(awai"
},
{
"path": "include/librf/src/channel.h",
"chars": 65,
"preview": "#pragma once\n\n#include \"channel_v2.h\"\n#include \"channel_v2.inl\"\n"
},
{
"path": "include/librf/src/channel_v2.h",
"chars": 3334,
"preview": "#pragma once\n\nnamespace librf\n{\n#ifndef DOXYGEN_SKIP_PROPERTY\nnamespace detail\n{\n\ttemplate<class _Ty, bool _Optional, b"
},
{
"path": "include/librf/src/channel_v2.inl",
"chars": 13978,
"preview": "#pragma once\n\nnamespace librf\n{\nnamespace detail\n{\n\ttemplate<class _Ty, class _Chty>\n\tstruct state_channel_t : public s"
},
{
"path": "include/librf/src/config.h",
"chars": 437,
"preview": "#pragma once\n\n#ifndef RESUMEF_DEBUG_COUNTER\n/* #undef RESUMEF_DEBUG_COUNTER */\n#endif\t//RESUMEF_DEBUG_COUNTER\n\n#ifndef _"
},
{
"path": "include/librf/src/counted_ptr.h",
"chars": 2517,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief 专用于state的智能计数指针，通过管理state内嵌的引用计数来管理state的生存期。\n\t */\n\ttemplate <typename "
},
{
"path": "include/librf/src/current_scheduler.h",
"chars": 4399,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief 获得本协程绑定的调度器的可等待对象。\n\t */\n\tstruct get_current_scheduler_awaitor\n\t{\n\t\tbool"
},
{
"path": "include/librf/src/def.h",
"chars": 2508,
"preview": "#pragma once\n\n#define LIB_RESUMEF_VERSION 30000 // 3.0.0\n\n#ifndef __cpp_impl_coroutine\nnamespace std\n{\n\tusing experimen"
},
{
"path": "include/librf/src/event.h",
"chars": 61,
"preview": "#pragma once\n\n#include \"event_v2.h\"\n#include \"event_v2.inl\"\n"
},
{
"path": "include/librf/src/event_v2.h",
"chars": 5513,
"preview": "#pragma once\n\nnamespace librf\n{\n#ifndef DOXYGEN_SKIP_PROPERTY\n\tnamespace detail\n\t{\n\t\tstruct event_v2_impl;\n\t}\n#endif\t//"
},
{
"path": "include/librf/src/event_v2.inl",
"chars": 14800,
"preview": "#pragma once\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\t\tstruct state_event_base_t;\n\n\t\tstruct event_v2_impl : public std:"
},
{
"path": "include/librf/src/exception.inl",
"chars": 1505,
"preview": "#pragma once\n\nnamespace librf\n{\n\n\t/**\n\t * @brief 错误码。\n\t */\n\tenum struct error_code\n\t{\n\t\tnone,\n\t\tnot_ready,\t\t\t///< get_v"
},
{
"path": "include/librf/src/future.h",
"chars": 1188,
"preview": "\n#pragma once\n\nnamespace librf\n{\n\n\t/**\n\t * @brief 用于librf协程的返回值。\n\t * @details 由于coroutines的限制，协程的返回值必须明确申明，而不能通过auto推导。"
},
{
"path": "include/librf/src/generator.h",
"chars": 6684,
"preview": "/*\n* Modify from <experimental/generator_t.h>\n* Purpose: Library support of coroutines. generator_t class\n* http://open"
},
{
"path": "include/librf/src/intrusive_link_queue.h",
"chars": 3631,
"preview": "#pragma once\n\nnamespace librf\n{\n\ttemplate<class _Node, class _Nextptr = _Node*>\n\tstruct intrusive_link_node\n\t{\n\tprivate"
},
{
"path": "include/librf/src/macro_def.inl",
"chars": 1418,
"preview": "#pragma once\n\n#ifndef _offset_of\n#define _offset_of(c, m) reinterpret_cast<size_t>(&static_cast<c *>(0)->m)\n#endif\n\n#de"
},
{
"path": "include/librf/src/mutex.h",
"chars": 61,
"preview": "#pragma once\n\n#include \"mutex_v2.h\"\n#include \"mutex_v2.inl\"\n"
},
{
"path": "include/librf/src/mutex_v2.h",
"chars": 5769,
"preview": "#pragma once\n\nnamespace librf\n{\n#ifndef DOXYGEN_SKIP_PROPERTY\n\tnamespace detail\n\t{\n\t\tstruct mutex_v2_impl;\n\t}\n#endif\t//"
},
{
"path": "include/librf/src/mutex_v2.inl",
"chars": 14658,
"preview": "#pragma once\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\t\tstruct state_mutex_t : public state_base_t\n\t\t{\n\t\t\tstate_mutex_t("
},
{
"path": "include/librf/src/promise.h",
"chars": 4118,
"preview": "#pragma once\n\n#pragma push_macro(\"new\")\n#undef new\n\n#ifndef DOXYGEN_SKIP_PROPERTY\nnamespace librf\n{\n\t/*\n\tNote: the awai"
},
{
"path": "include/librf/src/promise.inl",
"chars": 1355,
"preview": "\nnamespace librf\n{\n\n/*\n\ttemplate<typename _Ty>\n\ttemplate<typename _Uty>\n\t_Uty&& promise_impl_t<_Ty>::await_transform(_U"
},
{
"path": "include/librf/src/rf_task.h",
"chars": 2774,
"preview": "#pragma once\n\nnamespace librf\n{\n#ifndef DOXYGEN_SKIP_PROPERTY\n\t/**\n\t * @brief 协程任务类。\n\t * @details 每启动一个新的协程，则对应一个协程任务类。"
},
{
"path": "include/librf/src/ring_queue.h",
"chars": 4215,
"preview": "#pragma once\n\nnamespace librf\n{\n\t//使用自旋锁完成的线程安全的环形队列。\n\t//支持多个线程同时push和pop。\n\t//_Option : 如果队列保存的数据不支持拷贝只支持移动，则需要设置为true；"
},
{
"path": "include/librf/src/scheduler.h",
"chars": 4883,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief 获得当前线程下的调度器。\n\t */\n\tLIBRF_API scheduler_t* this_scheduler();\n\n\t/**\n\t * @"
},
{
"path": "include/librf/src/sleep.h",
"chars": 2844,
"preview": "//协程的定时器\n//如果定时器被取消了，则会抛 timer_canceled_exception 异常\n//不使用co_await而单独sleep_for/sleep_until，是错误的用法，并不能达到等待的目的。而仅仅是添加了一个无"
},
{
"path": "include/librf/src/spinlock.h",
"chars": 5783,
"preview": "//用于内部实现的循环锁\n\n#pragma once\n\nnamespace librf\n{\n#if defined(RESUMEF_USE_CUSTOM_SPINLOCK)\n\tusing spinlock = RESUMEF_USE_CU"
},
{
"path": "include/librf/src/state.h",
"chars": 8199,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief state基类，state用于在协程的promise和future之间共享数据。\n\t */\n\tstruct state_base_t\n\t{\n\t"
},
{
"path": "include/librf/src/state.inl",
"chars": 7380,
"preview": "\nnamespace librf\n{\n\ttemplate<class _PromiseT> requires(traits::is_promise_v<_PromiseT>)\n\tvoid state_future_t::promise_i"
},
{
"path": "include/librf/src/stop_token.h",
"chars": 14312,
"preview": "/************************************************\n* @ Bright Dream Robotics-Fundamental Research\n* @ Author BIP:zhangwe"
},
{
"path": "include/librf/src/switch_scheduler.h",
"chars": 2807,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief 切换协程的可等待对象。\n\t */\n\tstruct switch_scheduler_awaitor\n\t{\n\t\tusing value_type"
},
{
"path": "include/librf/src/timer.h",
"chars": 5437,
"preview": "#pragma once\n#include <memory>\n\nnamespace librf\n{\n\tstruct timer_manager;\n\ttypedef std::shared_ptr<timer_manager> timer_"
},
{
"path": "include/librf/src/type_concept.inl",
"chars": 2221,
"preview": "#pragma once\n\n#include <concepts>\n\nnamespace librf\n{\n\ttemplate<typename T>\n\tconcept _ValidAwaitSuspendReturnT = std::sa"
},
{
"path": "include/librf/src/type_traits.inl",
"chars": 8649,
"preview": "#pragma once\n\nnamespace librf\n{\n\tnamespace traits\n\t{\n\t\t//is_coroutine_handle<T>\n\t\t//is_coroutine_handle_v<T>\n\t\t//判断是不是c"
},
{
"path": "include/librf/src/unix/clang_builtin.h",
"chars": 2130,
"preview": "#pragma once\n\n//BUILTIN(__builtin_coro_resume, \"vv*\", \"\")\n//BUILTIN(__builtin_coro_destroy, \"vv*\", \"\")\n//BUILTIN(__built"
},
{
"path": "include/librf/src/unix/coroutine.h",
"chars": 7993,
"preview": "//===----------------------------- coroutine -----------------------------===//\n//\n// Part of the LLVM Project, under th"
},
{
"path": "include/librf/src/unix/gcc_builtin.h",
"chars": 455,
"preview": "#pragma once\n\n#if 0\n\nextern \"C\" void __builtin_coro_resume(void* addr);\nextern \"C\" void __builtin_coro_destroy(void* a"
},
{
"path": "include/librf/src/when.h",
"chars": 59,
"preview": "#pragma once\n\n//#include \"when_v1.h\"\n#include \"when_v2.h\"\n"
},
{
"path": "include/librf/src/when_v2.h",
"chars": 14496,
"preview": "#pragma once\n\nnamespace librf\n{\n\tusing any_t = std::any;\n\tusing std::any_cast;\n}\n\n//纠结过when_any的返回值，是选用index + std::any"
},
{
"path": "include/librf/src/without_deadlock_assemble.inl",
"chars": 3629,
"preview": "\nstruct LOCK_ASSEMBLE_NAME(lock_impl)\n{\n\t// FUNCTION TEMPLATE _Unlock_locks\n\ttemplate<_LockAssembleT _LA>\n\tstatic void "
},
{
"path": "include/librf/src/yield.h",
"chars": 1051,
"preview": "#pragma once\n\nnamespace librf\n{\n\t/**\n\t * @brief 将本协程让渡出一次调用的可等待对象。\n\t */\n\tstruct yield_awaitor\n\t{\n\t\tusing value_type = v"
},
{
"path": "source/event_v2.cpp",
"chars": 4939,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\n\t\tLIBRF_API void state_event_t::on_cancel() noexcept\n"
},
{
"path": "source/mutex_v2.cpp",
"chars": 4260,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\t\tLIBRF_API void state_mutex_t::resume()\n\t\t{\n\t\t\tcorout"
},
{
"path": "source/rf_task.cpp",
"chars": 259,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tLIBRF_API task_t::task_t() noexcept\n\t\t: _stop(nostopstate)\n\t{\n\t}\n\n\tLIBRF_A"
},
{
"path": "source/scheduler.cpp",
"chars": 4261,
"preview": "#include \"librf/librf.h\"\n\n#if RESUMEF_DEBUG_COUNTER\nstd::mutex g_resumef_cout_mutex;\nstd::atomic<intptr_t> g_resumef_st"
},
{
"path": "source/sleep.cpp",
"chars": 462,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tLIBRF_API future_t<> sleep_until_(std::chrono::system_clock::time_point tp"
},
{
"path": "source/state.cpp",
"chars": 4737,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tLIBRF_API state_base_t::~state_base_t()\n\t{\n\t}\n\t\n\tLIBRF_API void state_base"
},
{
"path": "source/timer.cpp",
"chars": 2536,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tLIBRF_API timer_manager::timer_manager()\n\t{\n\t\t_added_timers.reserve(128);\n"
},
{
"path": "source/when_v2.cpp",
"chars": 1014,
"preview": "#include \"librf/librf.h\"\n\nnamespace librf\n{\n\tnamespace detail\n\t{\n\t\tLIBRF_API state_when_t::state_when_t(intptr_t counte"
},
{
"path": "test_librf.cpp",
"chars": 2179,
"preview": "\n#include \"librf/librf.h\"\n#include <iostream>\n\nextern void resumable_main_yield_return();\nextern void resumable_main_tim"
},
{
"path": "tutorial/CMakeLists.txt",
"chars": 681,
"preview": "set(TUTORIAL_FILES \"\")\naux_source_directory(${CMAKE_CURRENT_SOURCE_DIR} TUTORIAL_FILES)\n\nforeach(TUTORIAL_FILE_PATH ${T"
},
{
"path": "tutorial/test_async_cb.cpp",
"chars": 2726,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing names"
},
{
"path": "tutorial/test_async_channel.cpp",
"chars": 6403,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n#include <deque>\r\n#include <mutex>\r\n\r\n#in"
},
{
"path": "tutorial/test_async_channel_mult_thread.cpp",
"chars": 2627,
"preview": "//验证channel是否线程安全\r\n\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n#include <deque>\r\n#i"
},
{
"path": "tutorial/test_async_dynamic_go.cpp",
"chars": 1157,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n\r\n#include \"librf/librf.h\"\r\n\r\n\r\nstatic const int M = 10;\r\n"
},
{
"path": "tutorial/test_async_event.cpp",
"chars": 4027,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing names"
},
{
"path": "tutorial/test_async_event_timeout.cpp",
"chars": 3739,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing names"
},
{
"path": "tutorial/test_async_event_v2.cpp",
"chars": 2371,
"preview": "#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n\n#include \"librf/librf.h\"\n\nusing namespace li"
},
{
"path": "tutorial/test_async_exception.cpp",
"chars": 2019,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing names"
},
{
"path": "tutorial/test_async_memory_layout.cpp",
"chars": 5830,
"preview": "#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n\n#include \"librf/librf.h\"\n\nusing namespace li"
},
{
"path": "tutorial/test_async_modern_cb.cpp",
"chars": 4657,
"preview": "//依赖 https://github.com/tearshark/modern_cb 项目\n//依赖 https://github.com/tearshark/librf 项目\n\n#include <future>\n#include <"
},
{
"path": "tutorial/test_async_multi_thread.cpp",
"chars": 2248,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing names"
},
{
"path": "tutorial/test_async_mutex.cpp",
"chars": 4812,
"preview": "#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n#include <deque>\r\n\r\n#include \"librf/librf"
},
{
"path": "tutorial/test_async_resumable.cpp",
"chars": 1998,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n\r\n#include \"librf/librf.h\"\r\n\r\n\r\nstatic std::mutex lock_con"
},
{
"path": "tutorial/test_async_routine.cpp",
"chars": 1257,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing nam"
},
{
"path": "tutorial/test_async_sleep.cpp",
"chars": 1644,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing nam"
},
{
"path": "tutorial/test_async_stop_token.cpp",
"chars": 2406,
"preview": "#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n\n#include \"librf/librf.h\"\n\nusing namespace li"
},
{
"path": "tutorial/test_async_suspend_always.cpp",
"chars": 2490,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing nam"
},
{
"path": "tutorial/test_async_switch_scheduler.cpp",
"chars": 4145,
"preview": "#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n\n#include \"librf/librf.h\"\n\nusing namespace li"
},
{
"path": "tutorial/test_async_timer.cpp",
"chars": 769,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing nam"
},
{
"path": "tutorial/test_async_when_all.cpp",
"chars": 5563,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n#include <inttypes.h>\r\n\r\n#include \"libr"
},
{
"path": "tutorial/test_async_yield_return.cpp",
"chars": 2199,
"preview": "\r\n#include <chrono>\r\n#include <iostream>\r\n#include <string>\r\n#include <thread>\r\n\r\n#include \"librf/librf.h\"\r\n\r\nusing nam"
},
{
"path": "tutorial/test_memory_leak.cpp",
"chars": 977,
"preview": "\n#include <chrono>\n#include <iostream>\n#include <string>\n#include <thread>\n\n#include \"librf/librf.h\"\n\nusing namespace li"
}
]
About this extraction
This page contains the full source code of the tearshark/librf GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 95 files (450.3 KB), approximately 132.9k tokens, and a symbol index with 367 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.