summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Jamroot.jam8
-rw-r--r--libadhocutil/Doxyfile2191
-rw-r--r--libadhocutil/buffer.cpp12
-rw-r--r--libadhocutil/buffer.h61
-rw-r--r--libadhocutil/c++11Helpers.h34
-rw-r--r--libadhocutil/cache.h43
-rw-r--r--libadhocutil/cache.impl.h14
-rw-r--r--libadhocutil/compileTimeFormatter.h146
-rw-r--r--libadhocutil/ctf-impl/printf-compat.h14
-rw-r--r--libadhocutil/curlHandle.cpp5
-rw-r--r--libadhocutil/curlHandle.h8
-rw-r--r--libadhocutil/curlMultiHandle.cpp8
-rw-r--r--libadhocutil/curlMultiHandle.h14
-rw-r--r--libadhocutil/curlStream.cpp5
-rw-r--r--libadhocutil/curlStream.h9
-rw-r--r--libadhocutil/factory.h8
-rw-r--r--libadhocutil/fileUtils.cpp250
-rw-r--r--libadhocutil/fileUtils.h50
-rw-r--r--libadhocutil/handle.h88
-rw-r--r--libadhocutil/lazyPointer.h33
-rw-r--r--libadhocutil/lexer-regex.cpp131
-rw-r--r--libadhocutil/lexer.cpp3
-rw-r--r--libadhocutil/lexer.h34
-rw-r--r--libadhocutil/memstream.cpp25
-rw-r--r--libadhocutil/memstream.h25
-rw-r--r--libadhocutil/nagios.cpp4
-rw-r--r--libadhocutil/nvpParse.h11
-rw-r--r--libadhocutil/nvpParse.ll2
-rw-r--r--libadhocutil/plugins.h45
-rw-r--r--libadhocutil/plugins.impl.h4
-rw-r--r--libadhocutil/processPipes.cpp147
-rw-r--r--libadhocutil/processPipes.h37
-rw-r--r--libadhocutil/resourcePool.h49
-rw-r--r--libadhocutil/resourcePool.impl.h75
-rw-r--r--libadhocutil/runtimeContext.cpp11
-rw-r--r--libadhocutil/runtimeContext.h17
-rw-r--r--libadhocutil/safeMapFind.h21
-rw-r--r--libadhocutil/scopeExit.h11
-rw-r--r--libadhocutil/semaphore.h4
-rw-r--r--libadhocutil/unittests/Jamfile.jam27
-rw-r--r--libadhocutil/unittests/testBuffer.cpp6
-rw-r--r--libadhocutil/unittests/testCache.cpp2
-rw-r--r--libadhocutil/unittests/testCompileTimeFormatter.cpp101
-rw-r--r--libadhocutil/unittests/testCurl.cpp12
-rw-r--r--libadhocutil/unittests/testException.cpp2
-rw-r--r--libadhocutil/unittests/testFileUtils.cpp1
-rw-r--r--libadhocutil/unittests/testHandle.cpp60
-rw-r--r--libadhocutil/unittests/testLazyPointer.cpp28
-rw-r--r--libadhocutil/unittests/testNagios.cpp2
-rw-r--r--libadhocutil/unittests/testNvpParse.cpp2
-rw-r--r--libadhocutil/unittests/testOptionals.cpp2
-rw-r--r--libadhocutil/unittests/testPlugins.cpp4
-rw-r--r--libadhocutil/unittests/testPluginsRuntime.cpp4
-rw-r--r--libadhocutil/unittests/testProcessPipes.cpp24
-rw-r--r--libadhocutil/unittests/testResourcePool.cpp15
55 files changed, 3242 insertions, 707 deletions
diff --git a/Jamroot.jam b/Jamroot.jam
index 46fe187..69b3aca 100644
--- a/Jamroot.jam
+++ b/Jamroot.jam
@@ -1,5 +1,6 @@
import os ;
import slice ;
+import testing ;
using gcc : : [ os.environ CXX ] ;
using pkg-config ;
@@ -20,16 +21,21 @@ project
<variant>debug:<warnings>extra
<variant>debug:<warnings-as-errors>on
<variant>coverage:<coverage>on
+ <toolset>tidy:<exclude>bin/sys.h
+ <toolset>tidy:<exclude>bin/net.h
+ <toolset>tidy:<exclude>unittests/bin/lorem-ipsum.h
<toolset>tidy:<checkxx>boost-*
<toolset>tidy:<checkxx>bugprone-*
+ <toolset>tidy:<xcheckxx>bugprone-macro-parentheses
<toolset>tidy:<checkxx>clang-*
<toolset>tidy:<checkxx>misc-*
+ <toolset>tidy:<xcheckxx>misc-non-private-member-variables-in-classes
<toolset>tidy:<checkxx>modernize-*
<toolset>tidy:<xcheckxx>modernize-use-trailing-return-type
-#<toolset>tidy:<checkxx>cppcoreguidelines-*
<toolset>tidy:<checkxx>hicpp-*
<toolset>tidy:<xcheckxx>hicpp-vararg
<toolset>tidy:<xcheckxx>hicpp-signed-bitwise
+ <toolset>tidy:<xcheckxx>hicpp-no-array-decay
<toolset>tidy:<checkxx>performance-*
;
diff --git a/libadhocutil/Doxyfile b/libadhocutil/Doxyfile
index 27c7298..bd19b2a 100644
--- a/libadhocutil/Doxyfile
+++ b/libadhocutil/Doxyfile
@@ -1,20 +1,131 @@
-# Doxyfile 1.8.15
+# Doxyfile 1.8.16
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the configuration
+# file that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
+# The default value is: UTF-8.
+
DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
PROJECT_NAME = libadhocutil
+
+# 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 = 0.1
+
+# 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 = "Ad-hoc collection of utility classes and functions."
+
+# 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 = bin
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
OUTPUT_LANGUAGE = English
+
+# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all generated output in the proper direction.
+# Possible values are: None, LTR, RTL and Context.
+# The default value is: None.
+
OUTPUT_TEXT_DIRECTION = None
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
@@ -26,316 +137,2390 @@ ABBREVIATE_BRIEF = "The $name class" \
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 = 0
+
+# 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 = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
EXTRACT_LOCAL_CLASSES = NO
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# (including Cygwin) ands Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
HIDE_SCOPE_NAMES = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
SORT_BRIEF_DOCS = 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 = YES
+
+# 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 = .
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
+
FILE_PATTERNS = *.h
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
EXCLUDE = bin \
unittests
+
+# 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 = NO
+
+# 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 = NO
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_TIMESTAMP = NO
+
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via Javascript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have Javascript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_DYNAMIC_MENUS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: https://developer.apple.com/xcode/), introduced with OSX
+# 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
USE_MATHJAX = 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 = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
MATHJAX_EXTENSIONS =
+
+# 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 = NO
+
+# 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 = latex
+
+# 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 = YES
+
+# 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 = YES
+
+# 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 = YES
+
+# 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 = DLL_PRIVATE= \
DLL_PUBLIC= \
__cpp_lib_string_view
+
+# 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
-PERL_PATH = /usr/bin/perl
+
#---------------------------------------------------------------------------
# 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
-MSCGEN_PATH =
+
+# 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 = YES
+
+# 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 = svg
+
+# 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 = YES
+
+# 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
diff --git a/libadhocutil/buffer.cpp b/libadhocutil/buffer.cpp
index cb071a2..00c2b45 100644
--- a/libadhocutil/buffer.cpp
+++ b/libadhocutil/buffer.cpp
@@ -4,8 +4,6 @@
namespace AdHoc {
-Buffer::FragmentBase::~FragmentBase() = default;
-
//
// CString Fragment
//
@@ -107,8 +105,6 @@ Buffer::StringFragment::operator[](size_t x) const
// Buffer :)
//
-Buffer::Buffer() = default;
-
Buffer::Buffer(const char * src, CStringHandling h)
{
append(src, h);
@@ -124,8 +120,6 @@ Buffer::Buffer(const std::string & str)
append(str);
}
-Buffer::~Buffer() = default;
-
Buffer &
Buffer::append(const char * str, CStringHandling h)
{
@@ -167,11 +161,8 @@ Buffer &
Buffer::appendf(const char * fmt, ...)
{
va_list v;
- // NOLINTNEXTLINE(hicpp-no-array-decay)
va_start(v, fmt);
- // NOLINTNEXTLINE(hicpp-no-array-decay)
vappendf(fmt, v);
- // NOLINTNEXTLINE(hicpp-no-array-decay)
va_end(v);
return *this;
}
@@ -291,9 +282,6 @@ Buffer::operator=(const std::string & str)
return *this;
}
-Buffer &
-Buffer::operator=(const Buffer & buf) = default;
-
Buffer::operator bool() const
{
return !content.empty();
diff --git a/libadhocutil/buffer.h b/libadhocutil/buffer.h
index ca02bbb..62c8e38 100644
--- a/libadhocutil/buffer.h
+++ b/libadhocutil/buffer.h
@@ -3,9 +3,10 @@
#include <string>
#include <vector>
-#include <stdarg.h>
+#include <cstdarg>
#include <boost/format.hpp>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
class DLL_PUBLIC Buffer;
@@ -31,19 +32,22 @@ class DLL_PUBLIC Buffer {
};
/// Pointer typedef.
- typedef std::shared_ptr<Buffer> Ptr;
+ using Ptr = std::shared_ptr<Buffer>;
/// Const pointer typedef.
- typedef std::shared_ptr<const Buffer> CPtr;
+ using CPtr = std::shared_ptr<const Buffer>;
/** Create an empty buffer */
- Buffer();
+ Buffer() = default;
+ ~Buffer() = default;
/** Create a buffer containing a single element from the given char * */
Buffer(const char * src, CStringHandling);
/** Create a buffer containing a single element from the given char * */
Buffer(char * src, CStringHandling);
/** Create a buffer containing a single element from the given std::string */
- Buffer(const std::string &);
- ~Buffer();
+ explicit Buffer(const std::string &);
+
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT(Buffer);
/** Append the given char * (will copy) */
Buffer & operator+=(const char * str);
@@ -53,15 +57,15 @@ class DLL_PUBLIC Buffer {
Buffer & operator=(const char * str);
/** Replace all current content with the given std::string */
Buffer & operator=(const std::string & str);
- /** Replace all current content with the given Buffer's elements. Shallow copy as all elements are immutable. */
- Buffer & operator=(const Buffer & str);
/** true if the buffer contains no elements (empty) */
bool operator!() const;
/** true if the buffer contains no elements (non-empty) */
- operator bool() const;
+ explicit operator bool() const;
/** Converts all elements into a single flattened std::string */
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
operator std::string() const;
/** Converts all elements into a single flattened char * */
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
operator const char *() const;
/**
@@ -116,12 +120,14 @@ class DLL_PUBLIC Buffer {
class DLL_PRIVATE FragmentBase {
public:
- virtual ~FragmentBase() = 0;
-
- virtual size_t length() const = 0;
- virtual char operator[](size_t) const = 0;
- virtual const char * c_str() const = 0;
- virtual std::string str() const = 0;
+ FragmentBase() = default;
+ virtual ~FragmentBase() = default;
+ SPECIAL_MEMBERS_DEFAULT(FragmentBase);
+
+ [[nodiscard]] virtual size_t length() const = 0;
+ [[nodiscard]] virtual char operator[](size_t) const = 0;
+ [[nodiscard]] virtual const char * c_str() const = 0;
+ [[nodiscard]] virtual std::string str() const = 0;
};
class DLL_PRIVATE CStringFragment : public FragmentBase {
@@ -130,12 +136,13 @@ class DLL_PUBLIC Buffer {
CStringFragment(const char *, CStringHandling, size_t);
CStringFragment(char *, CStringHandling);
CStringFragment(char *, CStringHandling, size_t);
- ~CStringFragment();
+ SPECIAL_MEMBERS_DELETE(CStringFragment);
+ ~CStringFragment() override;
- size_t length() const;
- char operator[](size_t) const;
- const char * c_str() const;
- std::string str() const;
+ [[nodiscard]] size_t length() const override;
+ [[nodiscard]] char operator[](size_t) const override;
+ [[nodiscard]] const char * c_str() const override;
+ [[nodiscard]] std::string str() const override;
private:
const size_t len; // Excluding NULL term
@@ -145,19 +152,19 @@ class DLL_PUBLIC Buffer {
class DLL_PRIVATE StringFragment : public FragmentBase {
public:
- StringFragment(std::string);
+ explicit StringFragment(std::string);
- size_t length() const;
- char operator[](size_t) const;
- const char * c_str() const;
- std::string str() const;
+ [[nodiscard]] size_t length() const override;
+ [[nodiscard]] char operator[](size_t) const override;
+ [[nodiscard]] const char * c_str() const override;
+ [[nodiscard]] std::string str() const override;
private:
const std::string buf;
};
- typedef std::shared_ptr<FragmentBase> FragmentPtr;
- typedef std::vector<FragmentPtr> Content;
+ using FragmentPtr = std::shared_ptr<FragmentBase>;
+ using Content = std::vector<FragmentPtr>;
mutable Content content;
};
diff --git a/libadhocutil/c++11Helpers.h b/libadhocutil/c++11Helpers.h
new file mode 100644
index 0000000..9826189
--- /dev/null
+++ b/libadhocutil/c++11Helpers.h
@@ -0,0 +1,34 @@
+#ifndef ADHOCUTIL_CPP11_HELPERS
+#define ADHOCUTIL_CPP11_HELPERS
+
+#define SPECIAL_MEMBERS_CONS(T, type) \
+ T(const T &) = type; \
+ T(T &&) noexcept = type
+#define SPECIAL_MEMBERS_ASSIGN(T, type) \
+ T & operator=(const T &) = type; \
+ T & operator=(T &&) noexcept = type
+#define SPECIAL_MEMBERS_MOVE(T, type) \
+ T(T &&) noexcept = type; \
+ T & operator=(T &&) noexcept = type
+#define SPECIAL_MEMBERS_MOVE_RO(T) \
+ T(const T &) = delete; \
+ T(T &&) noexcept = default; \
+ SPECIAL_MEMBERS_ASSIGN(T, delete)
+#define SPECIAL_MEMBERS_COPY(T, type) \
+ T(const T &) = type; \
+ T & operator=(const T &) = type
+#define SPECIAL_MEMBERS_COPY_RO(T) \
+ SPECIAL_MEMBERS_CONS(T, default); \
+ SPECIAL_MEMBERS_ASSIGN(T, delete)
+#define SPECIAL_MEMBERS_DEFAULT(T) \
+ SPECIAL_MEMBERS_COPY(T, default); \
+ SPECIAL_MEMBERS_MOVE(T, default)
+#define SPECIAL_MEMBERS_DELETE(T) \
+ SPECIAL_MEMBERS_COPY(T, delete); \
+ SPECIAL_MEMBERS_MOVE(T, delete)
+#define SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(T) \
+ SPECIAL_MEMBERS_COPY(T, delete); \
+ SPECIAL_MEMBERS_MOVE(T, default)
+
+#endif
+
diff --git a/libadhocutil/cache.h b/libadhocutil/cache.h
index 933c8ff..20ef52e 100644
--- a/libadhocutil/cache.h
+++ b/libadhocutil/cache.h
@@ -1,7 +1,7 @@
#ifndef ADHOCUTIL_CACHE_H
#define ADHOCUTIL_CACHE_H
-#include <time.h>
+#include <ctime>
#include <memory>
#include <functional>
#include <boost/multi_index_container.hpp>
@@ -10,6 +10,7 @@
#include <shared_mutex>
#include <variant>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
@@ -17,29 +18,25 @@ namespace AdHoc {
template <typename T, typename K>
class DLL_PUBLIC Cacheable {
public:
- typedef const std::shared_ptr<const T> Value;
- Cacheable(const K & k, time_t validUntil);
- Cacheable(const Cacheable &) = delete;
- Cacheable(Cacheable &&) = default;
+ using Value = const std::shared_ptr<const T>;
+ Cacheable(K k, time_t validUntil);
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(Cacheable);
virtual ~Cacheable() = default;
- void operator=(const Cacheable &) = delete;
- void operator=(Cacheable &&) = delete;
-
const K key;
const time_t validUntil;
- virtual Value item() const = 0;
+ [[nodiscard]] virtual Value item() const = 0;
};
template <typename T, typename K>
class DLL_PUBLIC ObjectCacheable : public Cacheable<T, K> {
public:
ObjectCacheable(const T & t, const K & k, time_t validUtil);
- ObjectCacheable(typename Cacheable<T, K>::Value & t, const K & k, time_t validUtil);
+ ObjectCacheable(typename Cacheable<T, K>::Value t, const K & k, time_t validUtil);
- virtual typename Cacheable<T, K>::Value item() const override;
+ [[nodiscard]] typename Cacheable<T, K>::Value item() const override;
private:
typename Cacheable<T, K>::Value value;
@@ -48,10 +45,10 @@ class DLL_PUBLIC ObjectCacheable : public Cacheable<T, K> {
template <typename T, typename K>
class DLL_PUBLIC CallCacheable : public Cacheable<T, K> {
public:
- typedef std::function<T()> Factory;
+ using Factory = std::function<T()>;
CallCacheable(const Factory & t, const K & k, time_t validUtil);
- virtual typename Cacheable<T, K>::Value item() const override;
+ [[nodiscard]] typename Cacheable<T, K>::Value item() const override;
private:
mutable std::variant<std::shared_ptr<const T>, Factory> value;
@@ -61,10 +58,10 @@ class DLL_PUBLIC CallCacheable : public Cacheable<T, K> {
template <typename T, typename K>
class DLL_PUBLIC PointerCallCacheable : public Cacheable<T, K> {
public:
- typedef std::function<typename Cacheable<T, K>::Value()> Factory;
+ using Factory = std::function<typename Cacheable<T, K>::Value()>;
PointerCallCacheable(const Factory & t, const K & k, time_t validUtil);
- virtual typename Cacheable<T, K>::Value item() const override;
+ [[nodiscard]] typename Cacheable<T, K>::Value item() const override;
private:
mutable std::variant<std::shared_ptr<const T>, Factory> value;
@@ -80,12 +77,12 @@ template <typename T, typename K>
class DLL_PUBLIC Cache {
public:
/// @cond
- typedef K Key;
- typedef const std::shared_ptr<const T> Value;
- typedef std::function<T()> Factory;
- typedef std::function<Value()> PointerFactory;
- typedef Cacheable<T, K> Item;
- typedef std::shared_ptr<Item> Element;
+ using Key = K;
+ using Value = const std::shared_ptr<const T>;
+ using Factory = std::function<T()>;
+ using PointerFactory = std::function<Value()>;
+ using Item = Cacheable<T, K>;
+ using Element = std::shared_ptr<Item>;
/// @endcond
/** Construct a default empty cache. */
@@ -142,13 +139,13 @@ class DLL_PUBLIC Cache {
mutable std::shared_mutex lock;
- typedef boost::multi_index::multi_index_container<Element,
+ using Cached = boost::multi_index::multi_index_container<Element,
boost::multi_index::indexed_by<
boost::multi_index::ordered_unique<
boost::multi_index::tag<byKey>, BOOST_MULTI_INDEX_MEMBER(Item, const K, key)>,
boost::multi_index::ordered_non_unique<
boost::multi_index::tag<byValidity>, BOOST_MULTI_INDEX_MEMBER(Item, const time_t, validUntil)>
- > > Cached;
+ > >;
mutable Cached cached;
};
diff --git a/libadhocutil/cache.impl.h b/libadhocutil/cache.impl.h
index d1929a9..10c66a3 100644
--- a/libadhocutil/cache.impl.h
+++ b/libadhocutil/cache.impl.h
@@ -10,8 +10,8 @@ namespace AdHoc {
/// @cond
template<typename T, typename K>
-Cacheable<T, K>::Cacheable(const K & k, time_t vu) :
- key(k),
+Cacheable<T, K>::Cacheable(K k, time_t vu) :
+ key(std::move(k)),
validUntil(vu)
{
}
@@ -24,9 +24,9 @@ ObjectCacheable<T, K>::ObjectCacheable(const T & t, const K & k, time_t vu) :
}
template<typename T, typename K>
-ObjectCacheable<T, K>::ObjectCacheable(typename Cacheable<T, K>::Value & t, const K & k, time_t vu) :
+ObjectCacheable<T, K>::ObjectCacheable(typename Cacheable<T, K>::Value t, const K & k, time_t vu) :
Cacheable<T, K>(k, vu),
- value(t)
+ value(std::move(t))
{
}
@@ -81,7 +81,7 @@ PointerCallCacheable<T, K>::item() const
template<typename T, typename K>
Cache<T, K>::Cache() :
- lastPruneTime(time(NULL))
+ lastPruneTime(time(nullptr))
{
}
@@ -128,7 +128,7 @@ Cache<T, K>::getItem(const K & k) const
if (i == collection.end()) {
return Element();
}
- if ((*i)->validUntil > time(NULL)) {
+ if ((*i)->validUntil > time(nullptr)) {
return (*i);
}
}
@@ -174,7 +174,7 @@ template<typename T, typename K>
void
Cache<T, K>::prune() const
{
- auto now = time(NULL);
+ auto now = time(nullptr);
if (lastPruneTime < now) {
Lock(lock);
auto & collection = cached.template get<byValidity>();
diff --git a/libadhocutil/compileTimeFormatter.h b/libadhocutil/compileTimeFormatter.h
index 9d73868..d13492a 100644
--- a/libadhocutil/compileTimeFormatter.h
+++ b/libadhocutil/compileTimeFormatter.h
@@ -3,10 +3,20 @@
#include <sstream>
#include <cstring>
+#include <optional>
+#include <array>
#include <boost/preprocessor/variadic/size.hpp>
-#include "unique.h"
namespace AdHoc {
+#ifdef __cpp_nontype_template_parameter_class
+#define USE_FIXED_STRING
+#endif
+
+#ifdef USE_FIXED_STRING
+#define CtfString const auto
+#else
+#define CtfString const auto &
+#endif
// Template char utils
template<typename char_type>
constexpr bool isdigit(const char_type & ch)
@@ -21,25 +31,35 @@ namespace AdHoc {
}
// Template string utils
- template<const auto & S>
+ template<CtfString S>
static constexpr auto strlen()
{
- auto off = 0;
+ auto off = 0U;
+ while (S[off]) { ++off; }
+ return off;
+ }
+
+ template<typename char_type>
+ static constexpr auto strlen(const char_type * S)
+ {
+ auto off = 0U;
while (S[off]) { ++off; }
return off;
}
- template<const auto & S, auto n, auto start = 0, auto L = strlen<S>()>
- static constexpr auto strchr()
+ template<CtfString S, auto n, auto start = 0U, auto L = strlen<S>()>
+ static constexpr std::optional<decltype(start)> strchr()
{
static_assert(start <= L);
decltype(start) off = start;
while (off < L && S[off] != n) { ++off; }
- if (off == L) return -1;
+ if (off == L) {
+ return {};
+ }
return off;
}
- template<const auto & S, auto n, auto start = 0, auto L = strlen<S>()>
+ template<CtfString S, auto n, auto start = 0U, auto L = strlen<S>()>
static constexpr decltype(L) strchrnul()
{
decltype(start) off = start;
@@ -47,10 +67,10 @@ namespace AdHoc {
return off;
}
- template <const auto & S, decltype(strlen<S>())> class Formatter;
+ template<CtfString S, const auto L> class FormatterDetail;
/// Template used to apply parameters to a stream.
- template<const auto & S, auto L, auto pos, typename stream, typename, auto ...>
+ template<CtfString S, auto L, auto pos, typename stream, typename, auto ...>
struct StreamWriter {
/// Write parameters to stream.
template<typename ... Pn>
@@ -61,23 +81,23 @@ namespace AdHoc {
};
/// Helper to simplify implementations of StreamWriter.
- template<const auto & S, auto L, auto pos, typename stream>
+ template<CtfString S, auto L, auto pos, typename stream>
struct StreamWriterBase {
/// Continue processing parameters.
template<typename ... Pn>
static inline void next(stream & s, const Pn & ... pn)
{
- Formatter<S, L>::template Parser<stream, pos + 1, Pn...>::run(s, pn...);
+ FormatterDetail<S, L>::template Parser<stream, pos + 1, Pn...>::run(s, pn...);
}
};
#define StreamWriterT(C...) \
- template<const auto & S, auto L, auto pos, typename stream, auto ... sn> \
+ template<CtfString S, auto L, auto pos, typename stream, auto ... sn> \
struct StreamWriter<S, L, pos, stream, void, '%', C, sn...> : \
public StreamWriterBase<S, L, BOOST_PP_VARIADIC_SIZE(C) + pos, stream>
#define StreamWriterTP(P, C...) \
- template<const auto & S, auto L, auto pos, typename stream, auto P, auto ... sn> \
+ template<CtfString S, auto L, auto pos, typename stream, auto P, auto ... sn> \
struct StreamWriter<S, L, pos, stream, void, '%', C, sn...> : \
public StreamWriterBase<S, L, BOOST_PP_VARIADIC_SIZE(C) + pos, stream>
@@ -117,15 +137,15 @@ namespace AdHoc {
* Compile time string formatter.
* @param S the format string.
*/
- template <const auto & S, decltype(strlen<S>()) L = strlen<S>()>
- class Formatter {
+ template <CtfString S, const auto L>
+ class FormatterDetail {
private:
using strlen_t = decltype(strlen<S>());
- template<const auto &, auto, auto, typename> friend struct StreamWriterBase;
+ template<CtfString, auto, auto, typename> friend struct StreamWriterBase;
public:
/// The derived charater type of the format string.
- using char_type = typename std::decay<decltype(*S)>::type;
+ using char_type = typename std::decay<decltype(S[0])>::type;
/**
* Get a string containing the result of formatting.
* @param pn the format arguments.
@@ -157,7 +177,7 @@ namespace AdHoc {
template<typename stream, typename ... Pn>
static inline stream & write(stream & s, const Pn & ... pn)
{
- return Parser<stream, 0, Pn...>::run(s, pn...);
+ return Parser<stream, 0U, Pn...>::run(s, pn...);
}
/**
* Write the result of formatting to the given stream.
@@ -180,21 +200,18 @@ namespace AdHoc {
{
if (pos != L) {
constexpr auto ph = strchrnul<S, '%', pos, L>();
- // NOLINTNEXTLINE(hicpp-braces-around-statements,bugprone-suspicious-semicolon)
if constexpr (ph != pos) {
- appendStream(s, (S + pos), ph - pos);
+ appendStream(s, &S[pos], ph - pos);
}
- // NOLINTNEXTLINE(hicpp-braces-around-statements,bugprone-suspicious-semicolon)
if constexpr (ph != L) {
packAndWrite<ph>(s, pn...);
}
}
return s;
}
- template<strlen_t ph, strlen_t off = 0, auto ... Pck>
+ template<strlen_t ph, strlen_t off = 0U, auto ... Pck>
static inline void packAndWrite(stream & s, const Pn & ... pn)
{
- // NOLINTNEXTLINE(hicpp-braces-around-statements)
if constexpr (ph + off == L || sizeof...(Pck) == 32) {
StreamWriter<S, L, ph, stream, void, Pck...>::write(s, pn...);
}
@@ -205,7 +222,80 @@ namespace AdHoc {
};
};
+#ifdef USE_FIXED_STRING
+ // New C++20 implementation
+ namespace support {
+ template<typename CharT, std::size_t N>
+ class basic_fixed_string : public std::array<CharT, N> {
+ public:
+ constexpr basic_fixed_string(const CharT (&str)[N + 1])
+ {
+ for (decltype(N) x = 0; x < N; x++) {
+ this->at(x) = str[x];
+ }
+ }
+ constexpr basic_fixed_string(const CharT * str, decltype(N) len)
+ {
+ for (decltype(N) x = 0; x < len; x++) {
+ this->at(x) = str[x];
+ }
+ }
+ };
+
+ template<typename CharT, std::size_t N>
+ basic_fixed_string(const CharT (&str)[N]) -> basic_fixed_string<CharT, N - 1>;
+ }
+
+ template<const support::basic_fixed_string Str>
+ class LiteralFormatter : public FormatterDetail<Str, Str.size()> { };
+
+ template <const auto & S, decltype(strlen(S)) L = strlen(S)>
+ class Formatter : public FormatterDetail<support::basic_fixed_string<
+ typename std::decay<decltype(S[0])>::type, L>(S, L), L> { };
+
+#define AdHocFormatter(name, str) \
+ using name = LiteralFormatter<str>
+
+ template<const support::basic_fixed_string Str, typename ... Pn>
+ inline auto scprintf(const Pn & ... pn)
+ {
+ return FormatterDetail<Str, Str.size()>::get(pn...);
+ }
+
+ template<const support::basic_fixed_string Str, typename stream, typename ... Pn>
+ inline auto & scprintf(stream & strm, const Pn & ... pn)
+ {
+ return FormatterDetail<Str, Str.size()>::write(strm, pn...);
+ }
+
+ template<const support::basic_fixed_string Str, typename ... Pn>
+ inline auto & cprintf(const Pn & ... pn)
+ {
+ return scprintf<Str>(std::cout, pn...);
+ }
+
+#else
+ // Classic pre-C++20 implementation
+#include "unique.h"
+ template <const auto & S, decltype(strlen<S>()) L = strlen<S>()>
+ class Formatter : public FormatterDetail<S, L> { };
+
+#define AdHocFormatterTypedef(name, str, id) \
+ inline constexpr auto id = str; \
+ using name = ::AdHoc::Formatter<id>
+#define AdHocFormatter(name, str) \
+ AdHocFormatterTypedef(name, str, MAKE_UNIQUE(name))
+
+#endif
+
namespace literals {
+#ifdef USE_FIXED_STRING
+ template<const support::basic_fixed_string Str>
+ constexpr inline auto operator""_fmt() noexcept
+ {
+ return AdHoc::FormatterDetail<Str, Str.size()>();
+ }
+#else
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wgnu-string-literal-operator-template"
@@ -214,23 +304,19 @@ namespace AdHoc {
template<typename T, T ... t> struct FMT
{
/// CTF format string
+ // NOLINTNEXTLINE(hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
static constexpr char __FMT[] = {t...};
};
template<typename T, T ... t> inline auto operator""_fmt() noexcept
{
- return AdHoc::Formatter<FMT<T, t...>::__FMT, sizeof...(t)>();
+ return AdHoc::FormatterDetail<FMT<T, t...>::__FMT, sizeof...(t)>();
}
+#endif
#ifdef __clang__
#pragma clang diagnostic pop
#endif
}
}
-#define AdHocFormatterTypedef(name, str, id) \
- inline constexpr auto id = str; \
- typedef ::AdHoc::Formatter<id> name
-#define AdHocFormatter(name, str) \
- AdHocFormatterTypedef(name, str, MAKE_UNIQUE(name))
-
#endif
diff --git a/libadhocutil/ctf-impl/printf-compat.h b/libadhocutil/ctf-impl/printf-compat.h
index 3367b4a..4f93d4f 100644
--- a/libadhocutil/ctf-impl/printf-compat.h
+++ b/libadhocutil/ctf-impl/printf-compat.h
@@ -18,7 +18,7 @@ namespace AdHoc {
static inline void write(stream & s, const PARAMTYPE & p, const Pn & ... pn) \
{ \
OP; \
- s.copyfmt(std::ios(NULL)); \
+ s.copyfmt(std::ios(nullptr)); \
StreamWriter::next(s, pn...); \
} \
}
@@ -72,7 +72,7 @@ namespace AdHoc {
static inline void write(stream & s, Obj * const ptr, const Pn & ... pn)
{
s << std::showbase << std::hex << (long unsigned int)ptr;
- s.copyfmt(std::ios(NULL));
+ s.copyfmt(std::ios(nullptr));
StreamWriter::next(s, pn...);
}
template<typename Ptr, typename ... Pn>
@@ -87,7 +87,7 @@ namespace AdHoc {
static inline void write(stream & s, const Pn & ... pn)
{
s << strerror(errno);
- s.copyfmt(std::ios(NULL));
+ s.copyfmt(std::ios(nullptr));
StreamWriter::next(s, pn...);
}
};
@@ -97,7 +97,7 @@ namespace AdHoc {
{
BOOST_ASSERT_MSG(n, "%n conversion requires non-null parameter");
*n = streamLength(s);
- s.copyfmt(std::ios(NULL));
+ s.copyfmt(std::ios(nullptr));
StreamWriter::next(s, pn...);
}
};
@@ -118,7 +118,7 @@ namespace AdHoc {
#define NS(z, n, data) BOOST_PP_COMMA_IF(n) BOOST_PP_CAT(data, n)
#define ISDIGIT(z, n, data) && isdigit(BOOST_PP_CAT(data, BOOST_PP_ADD(n, 1)))
#define FMTWIDTH(unused, d, data) \
- template<const auto & S, auto L, auto pos, typename stream, BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), AUTON, n), auto nn, auto ... sn> \
+ template<CtfString S, auto L, auto pos, typename stream, BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), AUTON, n), auto nn, auto ... sn> \
struct StreamWriter<S, L, pos, stream, typename std::enable_if<ispositivedigit(n0) BOOST_PP_REPEAT(d, ISDIGIT, n) && !isdigit(nn)>::type, '%', BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), NS, n), nn, sn...> { \
template<typename ... Pn> \
static inline void write(stream & s, const Pn & ... pn) { \
@@ -129,7 +129,7 @@ namespace AdHoc {
};
BOOST_PP_REPEAT(6, FMTWIDTH, void);
#define FMTPRECISION(unused, d, data) \
- template<const auto & S, auto L, auto pos, typename stream, BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), AUTON, n), auto nn, auto ... sn> \
+ template<CtfString S, auto L, auto pos, typename stream, BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), AUTON, n), auto nn, auto ... sn> \
struct StreamWriter<S, L, pos, stream, typename std::enable_if<isdigit(n0) BOOST_PP_REPEAT(d, ISDIGIT, n) && !isdigit(nn)>::type, '%', '.', BOOST_PP_REPEAT(BOOST_PP_ADD(d, 1), NS, n), nn, sn...> { \
template<typename ... Pn> \
static inline void write(stream & s, const Pn & ... pn) { \
@@ -157,7 +157,7 @@ namespace AdHoc {
static inline void write(stream & s, int l, const std::string_view & p, const Pn & ... pn)
{
s << p.substr(0, l);
- s.copyfmt(std::ios(NULL));
+ s.copyfmt(std::ios(nullptr));
StreamWriter::next(s, pn...);
}
};
diff --git a/libadhocutil/curlHandle.cpp b/libadhocutil/curlHandle.cpp
index 7009ee5..a976410 100644
--- a/libadhocutil/curlHandle.cpp
+++ b/libadhocutil/curlHandle.cpp
@@ -3,9 +3,7 @@
#include <boost/numeric/conversion/cast.hpp>
#include "compileTimeFormatter.h"
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
-namespace Net {
+namespace AdHoc::Net {
static void cleanup() __attribute__((destructor));
static void cleanup()
@@ -136,5 +134,4 @@ CurlException::ice_print(std::ostream & s) const
}
}
-}
diff --git a/libadhocutil/curlHandle.h b/libadhocutil/curlHandle.h
index dc33e40..c9e8f58 100644
--- a/libadhocutil/curlHandle.h
+++ b/libadhocutil/curlHandle.h
@@ -4,6 +4,7 @@
#include <curl/curl.h>
#include <memory>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
namespace Net {
@@ -16,7 +17,9 @@ class DLL_PUBLIC CurlHandle {
* Create a new CurlHandle.
* @param url Set the required CURLOPT_URL property to the given url.
*/
- CurlHandle(const std::string & url);
+ explicit CurlHandle(const std::string & url);
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(CurlHandle);
virtual ~CurlHandle();
/** Set option wrapper. */
@@ -38,6 +41,7 @@ class DLL_PUBLIC CurlHandle {
void perform();
/** Get the underlying CURL * handle. @warning Make changes at your own risk. */
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
operator CURL *() const;
protected:
@@ -49,7 +53,7 @@ class DLL_PUBLIC CurlHandle {
curl_httppost * postS, * postE;
/// @endcond
};
-typedef std::shared_ptr<CurlHandle> CurlHandlePtr;
+using CurlHandlePtr = std::shared_ptr<CurlHandle>;
/// @cond
template <>
diff --git a/libadhocutil/curlMultiHandle.cpp b/libadhocutil/curlMultiHandle.cpp
index 65e9464..5db8c3f 100644
--- a/libadhocutil/curlMultiHandle.cpp
+++ b/libadhocutil/curlMultiHandle.cpp
@@ -4,9 +4,7 @@
#include "runtimeContext.h"
#include "curlStream.h"
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
-namespace Net {
+namespace AdHoc::Net {
class RunningCurl : public CurlStreamSource {
public:
@@ -57,10 +55,9 @@ CurlMultiHandle::performAll()
while (!curls.empty() && running.size() < 5) {
addRunner(curlm, running, curls);
}
- CURLMcode code;
int act = running.size();
while (act) {
- while ((code = curl_multi_perform(curlm, &act)) == CURLM_CALL_MULTI_PERFORM) {}
+ while (curl_multi_perform(curlm, &act) == CURLM_CALL_MULTI_PERFORM) {}
// Has anything finished
CURLMsg * msg;
int msgs = 0;
@@ -95,5 +92,4 @@ CurlMultiHandle::performAll()
}
}
-}
diff --git a/libadhocutil/curlMultiHandle.h b/libadhocutil/curlMultiHandle.h
index 2ceee46..5308fb3 100644
--- a/libadhocutil/curlMultiHandle.h
+++ b/libadhocutil/curlMultiHandle.h
@@ -7,36 +7,40 @@
#include <memory>
#include "visibility.h"
#include "curlHandle.h"
+#include "c++11Helpers.h"
namespace AdHoc {
namespace Net {
class RunningCurl;
-typedef std::shared_ptr<RunningCurl> RunningCurlPtr;
+using RunningCurlPtr = std::shared_ptr<RunningCurl>;
/// Perform multiple CURL operations at once.
class DLL_PUBLIC CurlMultiHandle {
public:
/** A function that should consume the inbound byte stream. */
- typedef std::function<void(std::istream &)> Consumer;
+ using Consumer = std::function<void(std::istream &)>;
CurlMultiHandle();
~CurlMultiHandle();
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(CurlMultiHandle);
+
/** Adds a new consumer for the given URL to the set of operations to perform. */
CurlHandlePtr addCurl(const std::string &, const Consumer &);
/** Perform all queued operations. */
void performAll();
private:
- typedef std::set<RunningCurlPtr> CURLs;
- typedef std::map<CURL *, RunningCurlPtr> Running;
+ using CURLs = std::set<RunningCurlPtr>;
+ using Running = std::map<CURL *, RunningCurlPtr>;
DLL_PRIVATE void addRunner(CURLM * curlm, Running & running, CURLs & curls);
CURLs curls;
};
-typedef std::shared_ptr<CurlMultiHandle> CurlMultiHandlePtr;
+using CurlMultiHandlePtr = std::shared_ptr<CurlMultiHandle>;
}
}
diff --git a/libadhocutil/curlStream.cpp b/libadhocutil/curlStream.cpp
index 3fb441f..6784675 100644
--- a/libadhocutil/curlStream.cpp
+++ b/libadhocutil/curlStream.cpp
@@ -1,8 +1,6 @@
#include "curlStream.h"
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
-namespace Net {
+namespace AdHoc::Net {
CurlStreamSource::CurlStreamSource(const std::string & url) :
CurlHandle(url),
@@ -58,5 +56,4 @@ CurlStreamSource::recv(void * data, size_t datalen)
}
}
-}
diff --git a/libadhocutil/curlStream.h b/libadhocutil/curlStream.h
index c6b3beb..9361fd8 100644
--- a/libadhocutil/curlStream.h
+++ b/libadhocutil/curlStream.h
@@ -7,6 +7,7 @@
#include <curl/curl.h>
#include "visibility.h"
#include "curlHandle.h"
+#include "c++11Helpers.h"
namespace AdHoc {
namespace Net {
@@ -15,8 +16,10 @@ namespace Net {
class DLL_PUBLIC CurlStreamSource : public boost::iostreams::source, public CurlHandle, ::AdHoc::System::RuntimeContext {
public:
/** Construct a new stream source for the given URL. */
- CurlStreamSource(const std::string & url);
- virtual ~CurlStreamSource();
+ explicit CurlStreamSource(const std::string & url);
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(CurlStreamSource);
+ ~CurlStreamSource() override;
/** Required member function for reading of the stream source by boost::iostreams::stream. */
std::streamsize read(char * target, std::streamsize targetSize);
@@ -33,7 +36,7 @@ class DLL_PUBLIC CurlStreamSource : public boost::iostreams::source, public Curl
CURLcode res;
};
-typedef boost::iostreams::stream<boost::reference_wrapper<CurlStreamSource>> CurlStream;
+using CurlStream = boost::iostreams::stream<boost::reference_wrapper<CurlStreamSource>>;
}
}
diff --git a/libadhocutil/factory.h b/libadhocutil/factory.h
index 2cd2844..3bd3f19 100644
--- a/libadhocutil/factory.h
+++ b/libadhocutil/factory.h
@@ -15,7 +15,7 @@ namespace AdHoc {
* Create a new instance of Base, overridden in a subclass to construct a new specific class.
* @param p The parameters passed to Impl constructor.
*/
- virtual std::shared_ptr<Base> create(const Params & ... p) const = 0;
+ [[nodiscard]] virtual std::shared_ptr<Base> create(const Params & ... p) const = 0;
/**
* A factory for a concrete implementation of Base
@@ -28,7 +28,7 @@ namespace AdHoc {
* Create a new instance of Base implemented in Impl.
* @param p The parameters passed to Impl constructor.
*/
- std::shared_ptr<Base> create(const Params & ... p) const override
+ [[nodiscard]] std::shared_ptr<Base> create(const Params & ... p) const override
{
return std::make_shared<Impl>(p...);
}
@@ -38,13 +38,13 @@ namespace AdHoc {
* Helper to get the factory for a specific implementation.
* @param name The name of the implementation.
*/
- static std::shared_ptr<const Factory> get(const std::string_view & name);
+ [[nodiscard]] static std::shared_ptr<const Factory> get(const std::string_view & name);
/**
* Helper to create a new instance from a specific factory.
* @param name The name of the implementation.
* @param p The parameters to pass to the constructor.
*/
- static std::shared_ptr<Base> createNew(const std::string_view & name, const Params & ... p);
+ [[nodiscard]] static std::shared_ptr<Base> createNew(const std::string_view & name, const Params & ... p);
};
}
diff --git a/libadhocutil/fileUtils.cpp b/libadhocutil/fileUtils.cpp
index f54189f..b4d39b4 100644
--- a/libadhocutil/fileUtils.cpp
+++ b/libadhocutil/fileUtils.cpp
@@ -5,156 +5,160 @@
#include <sys/mman.h>
#include <boost/assert.hpp>
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
- namespace FileUtils {
- AdHocFormatter(FD, "FD %?");
-
- std::filesystem::path operator/(const std::filesystem::path & p, unsigned int n)
- {
- auto pp = p.begin();
- while (n--) {
- ++pp;
- }
- return *pp;
- }
+namespace AdHoc::FileUtils {
+ AdHocFormatter(FD, "FD %?");
- FileHandle::FileHandle(int d) noexcept :
- fh(d)
- {
+ std::filesystem::path operator/(const std::filesystem::path & p, unsigned int n)
+ {
+ auto pp = p.begin();
+ while (n--) {
+ ++pp;
}
+ return *pp;
+ }
- FileHandle::FileHandle(FileHandle && o) noexcept :
- fh(o.fh)
- {
- const_cast<int &>(o.fh) = -1;
- }
+ FileHandle::FileHandle(int d) noexcept :
+ fh(d)
+ {
+ }
- FileHandle::FileHandle(const std::filesystem::path & path, int flags) :
- fh(open(path.c_str(), flags))
- {
- if (fh < 0) {
- throw SystemExceptionOn("open(2) failed", strerror(errno), errno, path);
- }
- }
+ FileHandle::FileHandle(FileHandle && o) noexcept :
+ fh(o.fh)
+ {
+ const_cast<int &>(o.fh) = -1;
+ }
- FileHandle::FileHandle(const std::filesystem::path & path, int flags, int mode) :
- fh(open(path.c_str(), flags, mode))
- {
- if (fh < 0) {
- throw SystemExceptionOn("open(2) failed", strerror(errno), errno, path);
- }
- }
+ FileHandle &
+ FileHandle::operator=(FileHandle && o) noexcept
+ {
+ const_cast<int &>(fh) = o.fh;
+ const_cast<int &>(o.fh) = -1;
+ return *this;
+ }
- FileHandle::~FileHandle() noexcept
- {
- if (fh >= 0) {
- // NOLINTNEXTLINE(hicpp-no-array-decay)
- BOOST_VERIFY(close(fh) == 0);
- }
+ FileHandle::FileHandle(const std::filesystem::path & path, int flags) :
+ fh(open(path.c_str(), flags))
+ {
+ if (fh < 0) {
+ throw SystemExceptionOn("open(2) failed", strerror(errno), errno, path);
}
+ }
- FileHandle::operator int() const noexcept
- {
- return fh;
+ FileHandle::FileHandle(const std::filesystem::path & path, int flags, int mode) :
+ fh(open(path.c_str(), flags, mode))
+ {
+ if (fh < 0) {
+ throw SystemExceptionOn("open(2) failed", strerror(errno), errno, path);
}
+ }
- FileHandleStat::FileHandleStat(int fd) :
- FileHandle(fd),
- st({})
- {
- refreshStat();
+ FileHandle::~FileHandle() noexcept
+ {
+ if (fh >= 0) {
+ BOOST_VERIFY(close(fh) == 0);
}
+ }
- FileHandleStat::FileHandleStat(const std::filesystem::path & path, int flags) :
- FileHandle(path, flags),
- st({})
- {
- refreshStat(path);
- }
+ FileHandle::operator int() const noexcept
+ {
+ return fh;
+ }
- FileHandleStat::FileHandleStat(const std::filesystem::path & path, int flags, int mode) :
- FileHandle(path, flags, mode),
- st({})
- {
- refreshStat(path);
- }
+ FileHandleStat::FileHandleStat(int fd) :
+ FileHandle(fd),
+ st({})
+ {
+ refreshStat();
+ }
- const struct stat &
- FileHandleStat::getStat() const noexcept
- {
- return st;
- }
+ FileHandleStat::FileHandleStat(const std::filesystem::path & path, int flags) :
+ FileHandle(path, flags),
+ st({})
+ {
+ refreshStat(path);
+ }
- const struct stat &
- FileHandleStat::refreshStat()
- {
- if (fstat(fh, &st)) {
- // LCOV_EXCL_START can't think of a way to test open succeeding and fstat failing
- throw SystemExceptionOn("fstat(2) failed", strerror(errno), errno, FD::get(fh));
- // LCOV_EXCL_STOP
- }
- return st;
- }
+ FileHandleStat::FileHandleStat(const std::filesystem::path & path, int flags, int mode) :
+ FileHandle(path, flags, mode),
+ st({})
+ {
+ refreshStat(path);
+ }
- void
- FileHandleStat::refreshStat(const std::filesystem::path & path)
- {
- if (fstat(fh, &st)) {
- // LCOV_EXCL_START can't think of a way to test open succeeding and fstat failing
- throw SystemExceptionOn("fstat(2) failed", strerror(errno), errno, path);
- // LCOV_EXCL_STOP
- }
- }
+ const struct stat &
+ FileHandleStat::getStat() const noexcept
+ {
+ return st;
+ }
- MemMap::MemMap(int d, int flags) :
- FileHandleStat(d),
- data(setupMap(flags))
- {
+ const struct stat &
+ FileHandleStat::refreshStat()
+ {
+ if (fstat(fh, &st)) {
+ // LCOV_EXCL_START can't think of a way to test open succeeding and fstat failing
+ throw SystemExceptionOn("fstat(2) failed", strerror(errno), errno, FD::get(fh));
+ // LCOV_EXCL_STOP
}
+ return st;
+ }
- MemMap::MemMap(const std::filesystem::path & path, int flags) :
- FileHandleStat(path, flags),
- data(setupMap(path, flags))
- {
+ void
+ FileHandleStat::refreshStat(const std::filesystem::path & path)
+ {
+ if (fstat(fh, &st)) {
+ // LCOV_EXCL_START can't think of a way to test open succeeding and fstat failing
+ throw SystemExceptionOn("fstat(2) failed", strerror(errno), errno, path);
+ // LCOV_EXCL_STOP
}
+ }
- MemMap::MemMap(const std::filesystem::path & path, int flags, int mode) :
- FileHandleStat(path, flags, mode),
- data(setupMap(path, flags))
- {
- }
+ MemMap::MemMap(int d, int flags) :
+ FileHandleStat(d),
+ data(setupMap(flags))
+ {
+ }
- MemMap::~MemMap()
- {
- munmap(data, st.st_size);
- }
+ MemMap::MemMap(const std::filesystem::path & path, int flags) :
+ FileHandleStat(path, flags),
+ data(setupMap(path, flags))
+ {
+ }
- void *
- MemMap::setupMapInt(int flags) const
- {
- return mmap(nullptr, st.st_size, flags & (O_WRONLY | O_RDWR) ? PROT_WRITE : PROT_READ, MAP_SHARED, fh, 0);
- }
+ MemMap::MemMap(const std::filesystem::path & path, int flags, int mode) :
+ FileHandleStat(path, flags, mode),
+ data(setupMap(path, flags))
+ {
+ }
+
+ MemMap::~MemMap()
+ {
+ munmap(const_cast<void *>(data), st.st_size);
+ }
+
+ void *
+ MemMap::setupMapInt(int flags) const
+ {
+ return mmap(nullptr, st.st_size, flags & (O_WRONLY | O_RDWR) ? PROT_WRITE : PROT_READ, MAP_SHARED, fh, 0);
+ }
- void *
- MemMap::setupMap(int flags) const
- {
- auto data = setupMapInt(flags);
- if (data == (void*)-1) {
- throw SystemExceptionOn("mmap(2) failed", strerror(errno), errno, FD::get(fh));
- }
- return data;
+ void *
+ MemMap::setupMap(int flags) const
+ {
+ auto data = setupMapInt(flags);
+ if (data == reinterpret_cast<void *>(-1)) {
+ throw SystemExceptionOn("mmap(2) failed", strerror(errno), errno, FD::get(fh));
}
+ return data;
+ }
- void *
- MemMap::setupMap(const std::filesystem::path & path, int flags) const
- {
- auto data = setupMapInt(flags);
- if (data == (void*)-1) {
- throw SystemExceptionOn("mmap(2) failed", strerror(errno), errno, path);
- }
- return data;
+ void *
+ MemMap::setupMap(const std::filesystem::path & path, int flags) const
+ {
+ auto data = setupMapInt(flags);
+ if (data == reinterpret_cast<void *>(-1)) {
+ throw SystemExceptionOn("mmap(2) failed", strerror(errno), errno, path);
}
+ return data;
}
}
diff --git a/libadhocutil/fileUtils.h b/libadhocutil/fileUtils.h
index c922bb9..26093e5 100644
--- a/libadhocutil/fileUtils.h
+++ b/libadhocutil/fileUtils.h
@@ -6,6 +6,7 @@
#include <fcntl.h>
#include <string_view>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
namespace FileUtils {
@@ -31,14 +32,14 @@ namespace AdHoc {
* Construct from an existing file descriptor.
* @param fd An open file descriptor.
*/
- FileHandle(int fd) noexcept;
+ explicit FileHandle(int fd) noexcept;
/**
* Open a new file handle.
* @param path Path of file to open.
* @param flags File handle flags
*/
- FileHandle(const std::filesystem::path & path, int flags = O_RDONLY);
+ explicit FileHandle(const std::filesystem::path & path, int flags = O_RDONLY);
/**
* Open a new file handle.
@@ -50,13 +51,17 @@ namespace AdHoc {
virtual ~FileHandle() noexcept;
- FileHandle(const FileHandle &) = delete;
- void operator=(const FileHandle &) = delete;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_COPY(FileHandle, delete);
+
+ /// Standard move/copy support
+ FileHandle & operator=(FileHandle &&) noexcept;
/**
* Implicit conversion back to raw Unix file descriptor.
* @return The container file descriptor.
*/
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
operator int() const noexcept;
/// The file handle.
@@ -68,23 +73,20 @@ namespace AdHoc {
*/
class DLL_PUBLIC FileHandleStat : public FileHandle {
public:
- /**
- * Move constructor.
- */
- FileHandleStat(FileHandleStat &&) = default;
+ ~FileHandleStat() override = default;
/**
* Construct from an existing file descriptor.
* @param fd An open file descriptor.
*/
- FileHandleStat(int fd);
+ explicit FileHandleStat(int fd);
/**
* Open a new file handle (with the default flags).
* @param path Path of file to open.
* @param flags File handle flags
*/
- FileHandleStat(const std::filesystem::path & path, int flags = O_RDONLY);
+ explicit FileHandleStat(const std::filesystem::path & path, int flags = O_RDONLY);
/**
* Open a new file handle.
@@ -94,11 +96,14 @@ namespace AdHoc {
*/
FileHandleStat(const std::filesystem::path & path, int flags, int mode);
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(FileHandleStat);
+
/**
* Get the stat structure.
* @return The stat structure.
*/
- const struct stat & getStat() const noexcept;
+ [[nodiscard]] const struct stat & getStat() const noexcept;
/**
* Refresh and return the stat structure.
@@ -122,21 +127,21 @@ namespace AdHoc {
/**
* Move constructor.
*/
- MemMap(MemMap &&) = default;
+ MemMap(MemMap &&) noexcept = default;
/**
* Construct from an existing file descriptor.
* @param fd An open file descriptor.
* @param flags File handle flags
*/
- MemMap(int fd, int flags = O_RDONLY);
+ explicit MemMap(int fd, int flags = O_RDONLY);
/**
* Open a new file handle (with the default flags).
* @param path Path of file to open.
* @param flags File handle flags
*/
- MemMap(const std::filesystem::path & path, int flags = O_RDONLY);
+ explicit MemMap(const std::filesystem::path & path, int flags = O_RDONLY);
/**
* Open a new file handle.
@@ -146,26 +151,31 @@ namespace AdHoc {
*/
MemMap(const std::filesystem::path & path, int flags, int mode);
- ~MemMap();
+ ~MemMap() override;
+
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_COPY(MemMap, delete);
+
+ MemMap & operator=(MemMap &&) = delete;
/// The file data.
- void * const data;
+ const void * const data;
#ifdef __cpp_lib_string_view
/**
* Create a std::string_view of the mapped data.
*/
template<typename T = char>
- auto sv() const
+ [[nodiscard]] auto sv() const
{
return std::basic_string_view<T>((const T *)data, st.st_size / sizeof(T));
}
#endif
private:
- DLL_PRIVATE void * setupMapInt(int flags) const;
- DLL_PRIVATE void * setupMap(int flags) const;
- DLL_PRIVATE void * setupMap(const std::filesystem::path & path, int flags) const;
+ [[nodiscard]] DLL_PRIVATE void * setupMapInt(int flags) const;
+ [[nodiscard]] DLL_PRIVATE void * setupMap(int flags) const;
+ [[nodiscard]] DLL_PRIVATE void * setupMap(const std::filesystem::path & path, int flags) const;
};
}
}
diff --git a/libadhocutil/handle.h b/libadhocutil/handle.h
new file mode 100644
index 0000000..7363183
--- /dev/null
+++ b/libadhocutil/handle.h
@@ -0,0 +1,88 @@
+#ifndef ADHOCUTIL_HANDLE_H
+#define ADHOCUTIL_HANDLE_H
+
+#include <utility>
+#include "c++11Helpers.h"
+
+namespace AdHoc {
+ /// A unique_ptr like construct for non-pointer objects.
+ /// Implements RAII.
+ template<typename T, typename D>
+ class Handle {
+ public:
+ /// Constructs a Handle that owns t, to be tidied with d
+ Handle(T t, D d) noexcept :
+ inst(std::move(t)),
+ deleter(std::move(d)),
+ owning(true)
+ {
+ }
+
+ /// Constructs a Handle that takes over ownership of h
+ Handle(Handle && h) noexcept :
+ inst(std::move(h.inst)),
+ deleter(std::move(h.deleter)),
+ owning(h.owning)
+ {
+ h.owning = false;
+ }
+
+ ~Handle()
+ {
+ if (owning) {
+ deleter(inst);
+ }
+ }
+
+ /// Standard special members
+ SPECIAL_MEMBERS_COPY(Handle, delete);
+
+ /// Takes over ownership of h
+ Handle & operator=(Handle && h) noexcept
+ {
+ if (owning) {
+ deleter(inst);
+ }
+ inst = std::move(h.inst);
+ deleter = std::move(h.deleter);
+ owning = h.owning;
+ h.owning = false;
+ }
+
+ /// Returns a reference to the managed object.
+ [[nodiscard]] T & get() noexcept { return inst; }
+ /// Returns a const reference to the managed object.
+ [[nodiscard]] const T & get() const noexcept { return inst; }
+
+ /// Returns a pointer to the managed object.
+ [[nodiscard]] T * operator->() noexcept { return inst; }
+ /// Returns a const pointer to the managed object.
+ [[nodiscard]] const T * operator->() const noexcept { return inst; }
+
+ /// Returns a reference to the managed object.
+ [[nodiscard]] T & operator*() noexcept { return inst; }
+ /// Returns a const reference to the managed object.
+ [[nodiscard]] const T & operator*() const noexcept { return inst; }
+
+ /// Returns a reference to the managed object.
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ operator T &() noexcept { return inst; }
+ /// Returns a const reference to the managed object.
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ operator const T &() const noexcept { return inst; }
+
+ private:
+ T inst;
+ D deleter;
+ bool owning;
+ };
+
+ template<typename T, typename D, typename... Args>
+ Handle<T, D> make_handle(D && d, Args && ... args)
+ {
+ return { T(std::forward<Args>(args)...), std::forward<D>(d) };
+ }
+}
+
+#endif
+
diff --git a/libadhocutil/lazyPointer.h b/libadhocutil/lazyPointer.h
index 71ad29a..9188d24 100644
--- a/libadhocutil/lazyPointer.h
+++ b/libadhocutil/lazyPointer.h
@@ -19,31 +19,26 @@ template <typename T, typename P = std::shared_ptr<T>>
class LazyPointer {
public:
/// @cond
- typedef T element_type;
- typedef P pointer_type;
- typedef std::function<P()> Factory;
- typedef std::variant<P, Factory> Source;
+ using element_type = T;
+ using pointer_type = P;
+ using Factory = std::function<P()>;
+ using Source = std::variant<P, Factory>;
/// @endcond
/** Construct pointer with a factory function. */
- LazyPointer(const Factory & f) :
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ LazyPointer(Factory f) :
source(f)
{
}
/** Construct pointer with an instance value. */
- LazyPointer(const P & p) :
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ LazyPointer(P p) :
source(p)
{
}
- /** Construct pointer with an instance value. */
- template <typename TT = T>
- LazyPointer(T * p, typename std::enable_if<!std::is_same<TT *, P>::value>::type * = NULL) :
- source(P(p))
- {
- }
-
/** Construct pointer with no factory or value. */
LazyPointer() :
source(P(NULL))
@@ -52,22 +47,22 @@ class LazyPointer {
// Getters
/// @cond
- operator P() const
+ explicit operator P() const
{
return deref();
}
- T * operator->() const
+ [[nodiscard]] T * operator->() const
{
return get();
}
- T & operator*() const
+ [[nodiscard]] T & operator*() const
{
return *get();
}
- T * get() const
+ [[nodiscard]] T * get() const
{
if constexpr (std::is_pointer<P>::value) {
return deref();
@@ -77,7 +72,7 @@ class LazyPointer {
}
}
- P deref() const
+ [[nodiscard]] P deref() const
{
if (Factory * f = std::get_if<Factory>(&source)) {
P p = (*f)();
@@ -94,7 +89,7 @@ class LazyPointer {
return get() == nullptr;
}
- operator bool() const
+ explicit operator bool() const
{
return get() != nullptr;
}
diff --git a/libadhocutil/lexer-regex.cpp b/libadhocutil/lexer-regex.cpp
index 271d62a..669bd16 100644
--- a/libadhocutil/lexer-regex.cpp
+++ b/libadhocutil/lexer-regex.cpp
@@ -1,86 +1,79 @@
#include "lexer-regex.h"
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
- namespace LexerMatchers {
- class Regex : public Lexer::Pattern {
- public:
- Regex(const Glib::ustring & pattern, GRegexCompileFlags compile, GRegexMatchFlags match) :
- err(nullptr),
- regex(g_regex_new(pattern.c_str(), compile, match, &err)),
- info(nullptr),
- str(nullptr)
- {
- if (!regex) {
- auto msg = std::string("Failed to create GRegex: ") + err->message;
- g_error_free(err);
- throw std::runtime_error(msg);
- }
+namespace AdHoc::LexerMatchers {
+ class Regex : public Lexer::Pattern {
+ public:
+ Regex(const Glib::ustring & pattern, GRegexCompileFlags compile, GRegexMatchFlags match) :
+ err(nullptr),
+ regex(g_regex_new(pattern.c_str(), compile, match, &err)),
+ info(nullptr),
+ str(nullptr)
+ {
+ if (!regex) {
+ auto msg = std::string("Failed to create GRegex: ") + err->message;
+ g_error_free(err);
+ throw std::runtime_error(msg);
}
+ }
- Regex(const Regex &) = delete;
- Regex(const Regex &&) = delete;
+ SPECIAL_MEMBERS_DELETE(Regex);
- ~Regex() override
- {
- if (err) {
- g_error_free(err);
- }
- if (info) {
- g_match_info_free(info);
- }
- g_regex_unref(regex);
+ ~Regex() override
+ {
+ if (err) {
+ g_error_free(err);
}
-
- void operator=(const Regex &) = delete;
- void operator=(const Regex &&) = delete;
-
- bool matches(const gchar * string, size_t length, size_t position) const override
- {
- if (info) {
- g_match_info_free(info);
- }
- g_regex_match_full(regex, string, length, position, G_REGEX_MATCH_ANCHORED, &info, &err);
- if (err) {
- auto msg = std::string("Failed to create GRegex: ") + err->message;
- g_error_free(err);
- throw std::runtime_error(msg);
- }
- str = string;
- return g_match_info_matches(info);
+ if (info) {
+ g_match_info_free(info);
}
+ g_regex_unref(regex);
+ }
- size_t matchedLength() const override
- {
- gint start, end;
- g_match_info_fetch_pos(info, 0, &start, &end);
- return end - start;
+ bool matches(const gchar * string, size_t length, size_t position) const override
+ {
+ if (info) {
+ g_match_info_free(info);
}
+ g_regex_match_full(regex, string, length, position, G_REGEX_MATCH_ANCHORED, &info, &err);
+ if (err) {
+ auto msg = std::string("Failed to create GRegex: ") + err->message;
+ g_error_free(err);
+ throw std::runtime_error(msg);
+ }
+ str = string;
+ return g_match_info_matches(info);
+ }
+
+ size_t matchedLength() const override
+ {
+ gint start, end;
+ g_match_info_fetch_pos(info, 0, &start, &end);
+ return end - start;
+ }
- std::optional<Glib::ustring> match(int n) const override
- {
- gint start, end;
- if (g_match_info_fetch_pos(info, n, &start, &end)) {
- if (start == -1 && end == -1) {
- return {};
- }
- return Glib::ustring(str + start, str + end);
+ std::optional<Glib::ustring> match(int n) const override
+ {
+ gint start, end;
+ if (g_match_info_fetch_pos(info, n, &start, &end)) {
+ if (start == -1 && end == -1) {
+ return {};
}
- return {};
+ return Glib::ustring(str + start, str + end);
}
+ return {};
+ }
- private:
- mutable GError * err;
- GRegex * regex;
- mutable GMatchInfo * info;
- mutable const gchar * str;
- };
+ private:
+ mutable GError * err;
+ GRegex * regex;
+ mutable GMatchInfo * info;
+ mutable const gchar * str;
+ };
- Lexer::PatternPtr
- regex(const Glib::ustring & pattern, GRegexCompileFlags compile, GRegexMatchFlags match)
- {
- return std::make_shared<Regex>(pattern, compile, match);
- }
+ Lexer::PatternPtr
+ regex(const Glib::ustring & pattern, GRegexCompileFlags compile, GRegexMatchFlags match)
+ {
+ return std::make_shared<Regex>(pattern, compile, match);
}
}
diff --git a/libadhocutil/lexer.cpp b/libadhocutil/lexer.cpp
index af339eb..542a55f 100644
--- a/libadhocutil/lexer.cpp
+++ b/libadhocutil/lexer.cpp
@@ -38,8 +38,7 @@ namespace AdHoc {
}
}
- Lexer::ExecuteState::ExecuteState() :
- pos(0)
+ Lexer::ExecuteState::ExecuteState()
{
stateStack.push_back(InitialState);
}
diff --git a/libadhocutil/lexer.h b/libadhocutil/lexer.h
index 379904d..a32f3b1 100644
--- a/libadhocutil/lexer.h
+++ b/libadhocutil/lexer.h
@@ -9,6 +9,7 @@
#include <memory>
#include <optional>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
/// An extensible lexer.
@@ -17,21 +18,24 @@ namespace AdHoc {
/// Pattern matcher interface.
class Pattern {
public:
+ Pattern() = default;
virtual ~Pattern() = default;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT(Pattern);
/// Test the pattern against the given input.
- virtual bool matches(const gchar *, size_t, size_t) const = 0;
+ [[nodiscard]] virtual bool matches(const gchar *, size_t, size_t) const = 0;
/// Get the total amount of input matched.
- virtual size_t matchedLength() const = 0;
+ [[nodiscard]] virtual size_t matchedLength() const = 0;
/// Get an extracted value from the pattern.
- virtual std::optional<Glib::ustring> match(int) const = 0;
+ [[nodiscard]] virtual std::optional<Glib::ustring> match(int) const = 0;
};
/// Smart pointer to Pattern.
- typedef std::shared_ptr<Pattern> PatternPtr;
+ using PatternPtr = std::shared_ptr<Pattern>;
/// Lexer state identifiers.
- typedef std::string State;
+ using State = std::string;
/// Collection of States.
- typedef std::set<State> States;
+ using States = std::set<State>;
/// Class representing the runtime execution of the lexer.
class ExecuteState {
@@ -46,39 +50,39 @@ namespace AdHoc {
/// Replace the current top of the state stack.
void setState(const State &);
/// Get the current state.
- const State & getState() const;
+ [[nodiscard]] const State & getState() const;
/// Get the state stack depth.
- size_t depth() const;
+ [[nodiscard]] size_t depth() const;
/// Get the current position.
- size_t position() const;
+ [[nodiscard]] size_t position() const;
/// Get the currently matched pattern.
- PatternPtr pattern() const;
+ [[nodiscard]] PatternPtr pattern() const;
private:
friend class Lexer;
- size_t pos;
+ size_t pos { 0 };
PatternPtr pat;
std::vector<State> stateStack;
};
/// Callback for handling matched patterns.
- typedef std::function<void(ExecuteState *)> Handler;
+ using Handler = std::function<void(ExecuteState *)>;
/**
* Rule definition:
* States: in which states should the rule be considered?
* Pattern: the pattern matcher to test against the input.
* Handler: the callback to execute when a match succeeds.
*/
- typedef std::tuple<States, PatternPtr, Handler> Rule;
+ using Rule = std::tuple<States, PatternPtr, Handler>;
/// Collection of Rules that make up the lexer configuration.
- typedef std::vector<Rule> Rules;
+ using Rules = std::vector<Rule>;
/// The initial state of applied to the lexer.
static const State InitialState;
/// Default constructor (empty rule set)
Lexer();
/// Construct with an initial set of rules.
- Lexer(Rules);
+ explicit Lexer(Rules);
/// The lexer's current rule set.
Rules rules;
diff --git a/libadhocutil/memstream.cpp b/libadhocutil/memstream.cpp
index ec4b1bb..4c83c14 100644
--- a/libadhocutil/memstream.cpp
+++ b/libadhocutil/memstream.cpp
@@ -6,8 +6,6 @@
namespace AdHoc {
MemStream::MemStream() :
- buf(nullptr),
- len(0),
strm(open_memstream(&buf, &len))
{
if (!strm) {
@@ -55,34 +53,33 @@ namespace AdHoc {
return *this;
}
- MemStream::operator FILE * ()
+ MemStream::operator FILE * () noexcept
{
return strm;
}
- MemStream::operator const char * () const
+ MemStream::operator const char * () const noexcept
{
- fflush(strm);
- return buf;
+ return buffer();
}
- MemStream::operator std::string_view() const
+ MemStream::operator std::string_view() const noexcept
{
- fflush(strm);
- return { buf, len };
+ return { buffer(), len };
}
- const char * MemStream::buffer() const
+ const char * MemStream::buffer() const noexcept
{
- return *this;
+ fflush(strm);
+ return buf;
}
- std::string_view MemStream::sv() const
+ std::string_view MemStream::sv() const noexcept
{
- return *this;
+ return { buffer(), len };
}
- size_t MemStream::length() const
+ size_t MemStream::length() const noexcept
{
fflush(strm);
return len;
diff --git a/libadhocutil/memstream.h b/libadhocutil/memstream.h
index ba5f1fc..4f9d280 100644
--- a/libadhocutil/memstream.h
+++ b/libadhocutil/memstream.h
@@ -4,6 +4,7 @@
#include <visibility.h>
#include <cstdio>
#include <string_view>
+#include "c++11Helpers.h"
namespace AdHoc {
/**
@@ -14,31 +15,35 @@ namespace AdHoc {
MemStream();
~MemStream();
- MemStream(const MemStream &) = delete;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_COPY(MemStream, delete);
+
/// Standard move constructor
MemStream(MemStream &&) noexcept;
- void operator=(const MemStream &) = delete;
/// Standard move assignment
MemStream & operator=(MemStream &&) noexcept;
/// Implicit conversion to use as FILE* for writes
- operator FILE * ();
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ operator FILE * () noexcept;
/// Implicit conversion to use as const char * for reads
- operator const char * () const;
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ operator const char * () const noexcept;
/// Implicit conversion to use as std::string_view for reads
- operator std::string_view () const;
+ // NOLINTNEXTLINE(hicpp-explicit-conversions)
+ operator std::string_view () const noexcept;
/// Get buffer contents
- const char * buffer() const;
+ [[nodiscard]] const char * buffer() const noexcept;
/// Get buffer contents view
- std::string_view sv() const;
+ [[nodiscard]] std::string_view sv() const noexcept;
/// Get buffer length
- size_t length() const;
+ [[nodiscard]] size_t length() const noexcept;
private:
- char * buf;
- size_t len;
+ char * buf { nullptr };
+ size_t len { 0 };
FILE * strm;
};
}
diff --git a/libadhocutil/nagios.cpp b/libadhocutil/nagios.cpp
index 8bd7f62..749e118 100644
--- a/libadhocutil/nagios.cpp
+++ b/libadhocutil/nagios.cpp
@@ -7,19 +7,21 @@ namespace AdHoc {
// [<timestamp>] PROCESS_SERVICE_CHECK_RESULT;<host_name>;<svc_description>;<return_code>;<plugin_output>
AdHocFormatter(NagiosPassiveServiceCheck, "[%?] PROCESS_SERVICE_CHECK_RESULT;%?;%?;%d;%?\n");
+ /// LCOV_EXCL_START (calls real Nagios)
bool
submitNagiosPassiveServiceCheck(const std::string_view & svc, NagiosStatusCode code, const std::string_view & output)
{
std::ofstream command_file("/var/nagios/rw/nagios.cmd");
return submitNagiosPassiveServiceCheck(command_file, svc, code, output);
}
+ /// LCOV_EXCL_STOP
bool
submitNagiosPassiveServiceCheck(std::ostream & command_file, const std::string_view & svc,
NagiosStatusCode code, const std::string_view & output)
{
if (command_file.good()) {
- struct utsname buf;
+ struct utsname buf {};
uname(&buf);
NagiosPassiveServiceCheck::write(command_file, time(nullptr), buf.nodename, svc, (uint8_t)code, output);
command_file.flush();
diff --git a/libadhocutil/nvpParse.h b/libadhocutil/nvpParse.h
index df3982d..bc06fbe 100644
--- a/libadhocutil/nvpParse.h
+++ b/libadhocutil/nvpParse.h
@@ -11,7 +11,8 @@
#define yyFlexLexer nvpBaseFlexLexer
#include <FlexLexer.h>
#endif
-#include <visibility.h>
+#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
@@ -26,7 +27,7 @@ class NvpParse : public yyFlexLexer {
/// Thrown in the event of the input referring to a member that doesn't exist.
class ValueNotFound : public std::runtime_error {
public:
- ValueNotFound(const std::string &);
+ explicit ValueNotFound(const std::string &);
};
using AssignFunc = std::function<void(const std::string &)>;
@@ -35,14 +36,16 @@ class NvpParse : public yyFlexLexer {
template <typename T>
class TargetBase {
public:
+ TargetBase() = default;
virtual ~TargetBase() = default;
virtual AssignFunc assign(T *) const = 0;
+ SPECIAL_MEMBERS_DEFAULT(TargetBase);
};
template <typename T, typename V>
class Target : public TargetBase<T> {
public:
- Target(V T::*t) :
+ explicit Target(V T::*t) :
target(t)
{
}
@@ -59,7 +62,6 @@ class NvpParse : public yyFlexLexer {
};
/// @endcond
- // NOLINTNEXTLINE(bugprone-macro-parentheses)
#define NvpTarget(T) std::map<std::string, std::shared_ptr<::AdHoc::NvpParse::TargetBase<T>>>
#define NvpValue(c, m) { #m, std::make_shared<::AdHoc::NvpParse::Target<c, decltype(c::m)>>(&c::m) }
@@ -85,7 +87,6 @@ class NvpParse : public yyFlexLexer {
private:
NvpParse(std::istream & in, const AssignMap &);
- ~NvpParse() override;
int yylex() override;
void LexerError(const char * msg) override;
diff --git a/libadhocutil/nvpParse.ll b/libadhocutil/nvpParse.ll
index d7b88b2..cc3a0e8 100644
--- a/libadhocutil/nvpParse.ll
+++ b/libadhocutil/nvpParse.ll
@@ -68,8 +68,6 @@ NvpParse::NvpParse(std::istream & in, const AssignMap & v) :
{
}
-NvpParse::~NvpParse() = default;
-
void
NvpParse::process(const std::string & value) const
{
diff --git a/libadhocutil/plugins.h b/libadhocutil/plugins.h
index db40d1f..f8b1e8c 100644
--- a/libadhocutil/plugins.h
+++ b/libadhocutil/plugins.h
@@ -11,6 +11,7 @@
#include <stdexcept>
#include "visibility.h"
#include "unique.h"
+#include "c++11Helpers.h"
namespace std {
DLL_PUBLIC
@@ -29,7 +30,10 @@ namespace AdHoc {
/// Base class for all plugin implementations.
class DLL_PUBLIC AbstractPluginImplementation {
public:
+ AbstractPluginImplementation() = default;
virtual ~AbstractPluginImplementation() = 0;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT(AbstractPluginImplementation);
};
/// Base class for untyped plugins.
@@ -37,13 +41,15 @@ namespace AdHoc {
public:
/// Constructor taking name, filename and line of install.
Plugin(const std::string_view &, const std::string_view &, int);
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DELETE(Plugin);
virtual ~Plugin() = default;
/// Get the plugin type from the subclass.
- virtual const std::type_info & type() const = 0;
+ [[nodiscard]] virtual const std::type_info & type() const = 0;
/// Get the abstract base plugin implementation.
- virtual std::shared_ptr<AbstractPluginImplementation> instance() const = 0;
+ [[nodiscard]] virtual std::shared_ptr<AbstractPluginImplementation> instance() const = 0;
/// The name the plugin was installed with.
const std::string name;
@@ -52,7 +58,7 @@ namespace AdHoc {
/// The line of file the plugin was installed in.
const int lineno;
};
- typedef std::shared_ptr<const Plugin> PluginPtr;
+ using PluginPtr = std::shared_ptr<const Plugin>;
/// Thrown when a plugin with the same name and base is loaded into a manager.
class DuplicatePluginException : public std::runtime_error {
@@ -65,7 +71,7 @@ namespace AdHoc {
class DuplicateResolverException : public std::runtime_error {
public:
/// Constuctor taking resolver type.
- DuplicateResolverException(const std::type_info &);
+ explicit DuplicateResolverException(const std::type_info &);
};
/// Thrown when an attempt to load a library fails.
@@ -80,17 +86,17 @@ namespace AdHoc {
class DLL_PUBLIC PluginOf : public Plugin {
public:
/// Constructor taking an instance and name, filename and line of install for Plugin.
- PluginOf(const std::shared_ptr<T> & t, const std::string_view & n, const std::string_view & f, int l);
+ PluginOf(std::shared_ptr<T> t, const std::string_view & n, const std::string_view & f, int l);
/// Get the type of this plugin.
- const std::type_info & type() const override;
+ [[nodiscard]] const std::type_info & type() const override;
/// Get the implementation of this plugin.
- std::shared_ptr<T> implementation() const;
+ [[nodiscard]] std::shared_ptr<T> implementation() const;
- std::shared_ptr<AbstractPluginImplementation> instance() const override;
+ [[nodiscard]] std::shared_ptr<AbstractPluginImplementation> instance() const override;
private:
- std::shared_ptr<T> impl;
+ const std::shared_ptr<T> impl;
};
/// Container for loaded plugins.
@@ -98,21 +104,24 @@ namespace AdHoc {
public:
/// Callback definition to resolve a plugin type and name to a potential library
/// containing an implementation.
- typedef std::function<std::optional<std::string> (const std::type_info &, const std::string_view &)> PluginResolver;
+ using PluginResolver = std::function<std::optional<std::string> (const std::type_info &, const std::string_view &)>;
PluginManager();
virtual ~PluginManager();
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DELETE(PluginManager);
+
/// Install a plugin.
void add(const PluginPtr &);
/// Uninstall a plugin.
void remove(const std::string_view &, const std::type_info &);
/// Get a specific plugin.
- PluginPtr get(const std::string_view &, const std::type_info &) const;
+ [[nodiscard]] PluginPtr get(const std::string_view &, const std::type_info &) const;
/// Get all plugins.
- std::set<PluginPtr> getAll() const;
+ [[nodiscard]] std::set<PluginPtr> getAll() const;
/// Get all plugins of a specific type.
- std::set<PluginPtr> getAll(const std::type_info &) const;
+ [[nodiscard]] std::set<PluginPtr> getAll(const std::type_info &) const;
/**
* Install a plugin.
@@ -148,23 +157,23 @@ namespace AdHoc {
* Get a specific plugin.
* @param n Name of plugin.
*/
- template<typename T> std::shared_ptr<const PluginOf<T>> get(const std::string_view & n) const;
+ template<typename T> [[nodiscard]] std::shared_ptr<const PluginOf<T>> get(const std::string_view & n) const;
/**
* Get the implementation from specific plugin.
* @param n Name of plugin.
*/
- template<typename T> std::shared_ptr<T> getImplementation(const std::string_view & n) const;
+ template<typename T> [[nodiscard]] std::shared_ptr<T> getImplementation(const std::string_view & n) const;
/**
* Get all plugins of a given time.
*/
- template<typename T> std::set<std::shared_ptr<const PluginOf<T>>> getAll() const;
+ template<typename T> [[nodiscard]] std::set<std::shared_ptr<const PluginOf<T>>> getAll() const;
/**
* The number of installed plugins.
*/
- size_t count() const;
+ [[nodiscard]] size_t count() const;
/**
* Add a type plugin resolver function.
@@ -193,7 +202,7 @@ namespace AdHoc {
/**
* The number of installed plugins.
*/
- size_t countResolvers() const;
+ [[nodiscard]] size_t countResolvers() const;
/**
* Get the default plugin manager instance.
diff --git a/libadhocutil/plugins.impl.h b/libadhocutil/plugins.impl.h
index 7d70e8d..e4b48d1 100644
--- a/libadhocutil/plugins.impl.h
+++ b/libadhocutil/plugins.impl.h
@@ -5,9 +5,9 @@
namespace AdHoc {
template <typename T>
- PluginOf<T>::PluginOf(const std::shared_ptr<T> & t, const std::string_view & n, const std::string_view & f, int l) :
+ PluginOf<T>::PluginOf(std::shared_ptr<T> t, const std::string_view & n, const std::string_view & f, int l) :
Plugin(n, f, l),
- impl(t)
+ impl(std::move(t))
{
}
diff --git a/libadhocutil/processPipes.cpp b/libadhocutil/processPipes.cpp
index 90e6d14..efdcc88 100644
--- a/libadhocutil/processPipes.cpp
+++ b/libadhocutil/processPipes.cpp
@@ -5,75 +5,73 @@
#include <sys/resource.h>
#include <stdexcept>
#include <sys.h>
-#include "scopeExit.h"
+#include "c++11Helpers.h"
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
-namespace System {
-
-using PipePair = std::array<int, 2>;
-static
-void
-pipe(PipePair & pipes, ScopeExit & tidyUp)
+namespace AdHoc::System {
+ProcessPipes::InitPipe
+ProcessPipes::pipeSetup(bool setup, bool swap)
{
- if (::pipe(pipes.data())) {
- throw SystemException("pipe(2) failed", strerror(errno), errno);
+ if (setup) {
+ PipePair pair;
+ if (::pipe(&pair.first)) {
+ throw SystemException("pipe(2) failed", strerror(errno), errno);
+ }
+ if (swap) {
+ std::swap(pair.first, pair.second);
+ }
+ return pair;
}
- tidyUp.onFailure.emplace_back([pipes] {
- close(pipes[0]);
- close(pipes[1]);
- });
+ return {};
}
-ProcessPipes::ProcessPipes(const std::vector<std::string> & args, bool i, bool o, bool e) :
- in(-1),
- out(-1),
- error(-1)
+void ProcessPipes::closeChild(const InitPipe & pipe) noexcept
{
- if (args.empty()) {
- throw std::invalid_argument("args is empty");
- }
- PipePair ipipes { -1, -1 }, opipes { -1, -1 }, epipes { -1, -1 };
- ScopeExit tidyUp;
- if (i) {
- pipe(ipipes, tidyUp);
+ if (pipe) {
+ close(pipe->second);
}
- if (o) {
- pipe(opipes, tidyUp);
- }
- if (e) {
- pipe(epipes, tidyUp);
+}
+
+void ProcessPipes::dupChild(int fd, const InitPipe & pipe) noexcept
+{
+ if (pipe) {
+ close(pipe->first);
+ dup2(pipe->second, fd);
}
- switch (child = fork()) {
- case -1: // fail
- throw SystemException("fork(2) failed", strerror(errno), errno);
+}
+
+ProcessPipes::ProcessPipes(const std::vector<std::string> & args, bool i, bool o, bool e) :
+ ProcessPipes([&args](){
+ if (args.empty()) {
+ throw std::invalid_argument("args is empty");
+ }
+ return args;
+ }(), pipeSetup(i, true), pipeSetup(o, false), pipeSetup(e, false))
+{
+}
+
+ProcessPipes::ProcessPipes(const std::vector<std::string> & args, InitPipe && ipp, InitPipe && opp, InitPipe && epp) :
+ child([]() {
+ if (pid_t p = fork(); p != -1) {
+ return p;
+ }
+ /// LCOV_EXCL_START (fork won't fail)
+ throw SystemException("fork(2) failed", strerror(errno), errno);
+ /// LCOV_EXCL_STOP
+ }()),
+ in(ipp ? std::make_optional<FHandle>(ipp->first, &close) : OFHandle()),
+ out(opp ? std::make_optional<FHandle>(opp->first, &close) : OFHandle()),
+ error(epp ? std::make_optional<FHandle>(epp->first, &close) : OFHandle())
+{
+ switch (child) {
default: // parent
- if (i) {
- close(ipipes[0]);
- in = ipipes[1];
- }
- if (o) {
- close(opipes[1]);
- out = opipes[0];
- }
- if (e) {
- close(epipes[1]);
- error = epipes[0];
- }
+ closeChild(ipp);
+ closeChild(opp);
+ closeChild(epp);
break;
case 0: // in child
- if (i) {
- close(ipipes[1]);
- dup2(ipipes[0], 0);
- }
- if (o) {
- close(opipes[0]);
- dup2(opipes[1], 1);
- }
- if (e) {
- close(epipes[0]);
- dup2(epipes[1], 2);
- }
+ dupChild(STDIN_FILENO, ipp);
+ dupChild(STDOUT_FILENO, opp);
+ dupChild(STDERR_FILENO, epp);
closeAllOpenFiles();
std::vector<char *> buf(args.size() + 1);
auto w = buf.begin();
@@ -89,45 +87,42 @@ ProcessPipes::ProcessPipes(const std::vector<std::string> & args, bool i, bool o
}
}
-ProcessPipes::~ProcessPipes()
+int
+ProcessPipes::closeIn()
{
- if (in >= 0) {
- close(in);
- }
- if (out >= 0) {
- close(out);
- }
- if (error >= 0) {
- close(error);
+ if (in) {
+ in.reset();
+ return 0;
}
+ return EBADF;
}
int
-ProcessPipes::fdIn() const
+ProcessPipes::fdIn() const noexcept
{
- return in;
+ return in ? *in : -1;
}
int
-ProcessPipes::fdOut() const
+ProcessPipes::fdOut() const noexcept
{
- return out;
+ return out ? *out : -1;
}
int
-ProcessPipes::fdError() const
+ProcessPipes::fdError() const noexcept
{
- return error;
+ return error ? *error : -1;
}
pid_t
-ProcessPipes::pid() const
+ProcessPipes::pid() const noexcept
{
return child;
}
void
-ProcessPipes::closeAllOpenFiles()
+ProcessPipes::closeAllOpenFiles() noexcept
{
rlimit lim { };
getrlimit(RLIMIT_NOFILE, &lim);
@@ -143,7 +138,5 @@ ProcessPipes::closeAllOpenFiles()
}
}
}
-
-}
}
diff --git a/libadhocutil/processPipes.h b/libadhocutil/processPipes.h
index bbf7508..1b1a8fa 100644
--- a/libadhocutil/processPipes.h
+++ b/libadhocutil/processPipes.h
@@ -3,9 +3,13 @@
#include <vector>
#include <string>
+#include <optional>
#include "visibility.h"
+#include "c++11Helpers.h"
+#include "handle.h"
namespace AdHoc {
+
namespace System {
/// Spawn a process and attach to its IO handles.
@@ -20,26 +24,35 @@ class DLL_PUBLIC ProcessPipes {
* @param err Attach to stderr?
*/
ProcessPipes(const std::vector<std::string> & args, bool in, bool out, bool err);
- ~ProcessPipes();
+
+ /// Close input pipe to process
+ int closeIn();
/** FD handle to child's stdin. */
- int fdIn() const;
+ [[nodiscard]] int fdIn() const noexcept;
/** FD handle to child's stdout. */
- int fdOut() const;
+ [[nodiscard]] int fdOut() const noexcept;
/** FD handle to child's stderr. */
- int fdError() const;
+ [[nodiscard]] int fdError() const noexcept;
/** Process id of child. */
- pid_t pid() const;
-
- /** Close all open file handles as determined by rlimit and poll. */
- static void closeAllOpenFiles();
+ [[nodiscard]] pid_t pid() const noexcept;
private:
- ProcessPipes(const ProcessPipes &) = delete;
- void operator=(const ProcessPipes &) = delete;
+ using PipePair = std::pair<int, int>;
+ using InitPipe = std::optional<PipePair>;
+
+ ProcessPipes(const std::vector<std::string> & args, InitPipe &&, InitPipe &&, InitPipe &&);
+
+ static InitPipe pipeSetup(bool setup, bool swap);
+ static void closeChild(const InitPipe & child) noexcept;
+ static void dupChild(int, const InitPipe & child) noexcept;
+ static void closeAllOpenFiles() noexcept;
- int in, out, error;
- pid_t child;
+ using FHandle = ::AdHoc::Handle<int, int(*)(int)>;
+ using OFHandle = std::optional<FHandle>;
+ const pid_t child;
+ OFHandle in;
+ const OFHandle out, error;
};
}
diff --git a/libadhocutil/resourcePool.h b/libadhocutil/resourcePool.h
index 1321201..923565e 100644
--- a/libadhocutil/resourcePool.h
+++ b/libadhocutil/resourcePool.h
@@ -10,6 +10,7 @@
#include "semaphore.h"
#include "exception.h"
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
template <typename Resource>
@@ -20,34 +21,32 @@ namespace AdHoc {
class DLL_PUBLIC ResourceHandle {
public:
/// Handle to an allocated resource, the pool it belongs to and a count of active references.
- typedef std::tuple<std::shared_ptr<Resource>, ResourcePool<Resource> *> Object;
+ using Object = std::tuple<std::shared_ptr<Resource>, ResourcePool<Resource> *>;
/// Create a reference to a new resource.
- ResourceHandle(const std::shared_ptr<Object> &);
- /// Create a reference to an existing resource.
- ResourceHandle(const ResourceHandle &);
- /// Move reference to an existing resource.
- ResourceHandle(ResourceHandle &&);
- ~ResourceHandle();
+ explicit ResourceHandle(std::shared_ptr<Object>) noexcept;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_CONS(ResourceHandle, default);
+ ~ResourceHandle() noexcept;
/// Reference to an existing resource.
- void operator=(const ResourceHandle &);
+ ResourceHandle & operator=(const ResourceHandle &) noexcept;
/// Move reference to an existing resource.
- void operator=(ResourceHandle &&);
+ ResourceHandle & operator=(ResourceHandle &&) noexcept;
/// Access to the resource.
- Resource * operator->() const;
+ Resource * operator->() const noexcept;
/// Access to the resource.
- Resource * get() const;
+ Resource * get() const noexcept;
/// Release the resource back to the pool.
- void release();
+ void release() noexcept;
/// Cast to bool.
- operator bool() const;
+ explicit operator bool() const noexcept;
/// Get number of handles to this resource.
- unsigned int handleCount() const;
+ [[nodiscard]] unsigned int handleCount() const;
private:
- DLL_PRIVATE void decRef();
+ DLL_PRIVATE void decRef() noexcept;
std::shared_ptr<Object> resource;
};
@@ -64,12 +63,8 @@ namespace AdHoc {
ResourcePool(unsigned int maxSize, unsigned int keep);
virtual ~ResourcePool();
- ResourcePool() = delete;
- ResourcePool(const ResourcePool &) = delete;
- ResourcePool(ResourcePool &&) = delete;
-
- void operator=(const ResourcePool &) = delete;
- void operator=(ResourcePool &&) = delete;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(ResourcePool);
/// Get a resource from the pool (maybe cached, maybe constructed afresh)
ResourceHandle<Resource> get();
@@ -97,8 +92,8 @@ namespace AdHoc {
virtual void returnTestResource(Resource const *) const;
private:
- typedef std::list<std::shared_ptr<Resource>> Available;
- typedef std::multimap<std::thread::id, std::shared_ptr<typename ResourceHandle<Resource>::Object>> InUse;
+ using Available = std::list<std::shared_ptr<Resource>>;
+ using InUse = std::multimap<std::thread::id, std::shared_ptr<typename ResourceHandle<Resource>::Object>>;
void putBack(const std::shared_ptr<Resource> &);
void discard(const std::shared_ptr<Resource> &);
@@ -117,9 +112,9 @@ namespace AdHoc {
class DLL_PUBLIC TimeOutOnResourcePool : public AdHoc::StdException {
public:
/// Constrcut a new timeout exception for the given resource type.
- TimeOutOnResourcePool(const char * const type);
+ explicit TimeOutOnResourcePool(const char * const type);
- std::string message() const throw() override;
+ std::string message() const noexcept override;
private:
const char * const name;
@@ -139,7 +134,7 @@ namespace AdHoc {
/// Construct for a specific thread and resource type.
NoCurrentResource(const std::thread::id &, const char * const type);
- std::string message() const throw() override;
+ std::string message() const noexcept override;
private:
const std::thread::id threadId;
@@ -152,7 +147,7 @@ namespace AdHoc {
class DLL_PUBLIC NoCurrentResourceT : public NoCurrentResource {
public:
/// Construct for a specific thread and resource type R.
- NoCurrentResourceT(const std::thread::id &);
+ explicit NoCurrentResourceT(const std::thread::id &);
};
}
diff --git a/libadhocutil/resourcePool.impl.h b/libadhocutil/resourcePool.impl.h
index a565ae1..a58de87 100644
--- a/libadhocutil/resourcePool.impl.h
+++ b/libadhocutil/resourcePool.impl.h
@@ -1,38 +1,24 @@
#ifndef ADHOCUTIL_RESOURCEPOOL_IMPL_H
#define ADHOCUTIL_RESOURCEPOOL_IMPL_H
+#include <boost/assert.hpp>
#include "resourcePool.h"
#include "lockHelpers.h"
#include "safeMapFind.h"
-#define ASSERT(expr) if(!expr) throw std::runtime_error(#expr)
-
namespace AdHoc {
//
// ResourceHandle
//
template <typename R>
- ResourceHandle<R>::ResourceHandle(const std::shared_ptr<Object> & o) :
- resource(o)
- {
- }
-
- template <typename R>
- ResourceHandle<R>::ResourceHandle(const ResourceHandle & rh) :
- resource(rh.resource)
- {
- }
-
- template <typename R>
- ResourceHandle<R>::ResourceHandle(ResourceHandle && rh) :
- resource(rh.resource)
+ ResourceHandle<R>::ResourceHandle(std::shared_ptr<Object> o) noexcept :
+ resource(std::move(o))
{
- rh.decRef();
}
template <typename R>
- ResourceHandle<R>::~ResourceHandle()
+ ResourceHandle<R>::~ResourceHandle() noexcept
{
if (resource) {
decRef();
@@ -43,66 +29,71 @@ namespace AdHoc {
unsigned int
ResourceHandle<R>::handleCount() const
{
- ASSERT(resource);
+ BOOST_ASSERT(resource);
// InUse has one, we don't count that
return resource.use_count() - 1;
}
template <typename R>
R *
- ResourceHandle<R>::get() const
+ ResourceHandle<R>::get() const noexcept
{
- ASSERT(resource);
+ BOOST_ASSERT(resource);
return std::get<0>(*resource).get();
}
template <typename R>
void
- ResourceHandle<R>::release()
+ ResourceHandle<R>::release() noexcept
{
decRef();
}
template <typename R>
- ResourceHandle<R>::operator bool() const
+ ResourceHandle<R>::operator bool() const noexcept
{
return (bool)resource;
}
template <typename R>
R *
- ResourceHandle<R>::operator->() const
+ ResourceHandle<R>::operator->() const noexcept
{
- ASSERT(resource);
+ BOOST_ASSERT(resource);
return std::get<0>(*resource).get();
}
template <typename R>
- void
- ResourceHandle<R>::operator=(const ResourceHandle & rh)
+ ResourceHandle<R> &
+ ResourceHandle<R>::operator=(const ResourceHandle & rh) noexcept
{
- if (resource) {
- decRef();
+ if (&rh != this) {
+ if (resource) {
+ decRef();
+ }
+ resource = rh.resource;
}
- resource = rh.resource;
+ return *this;
}
template <typename R>
- void
- ResourceHandle<R>::operator=(ResourceHandle && rh)
+ ResourceHandle<R> &
+ ResourceHandle<R>::operator=(ResourceHandle && rh) noexcept
{
- if (resource) {
- decRef();
+ if (&rh != this) {
+ if (resource) {
+ decRef();
+ }
+ resource = std::move(rh.resource);
}
- resource = rh.resource;
- rh.decRef();
+ return *this;
}
template <typename R>
void
- ResourceHandle<R>::decRef()
+ ResourceHandle<R>::decRef() noexcept
{
- ASSERT(resource);
+ BOOST_ASSERT(resource);
// InUse has one, we don't count that
if (resource.use_count() == 2) {
if (auto pool = std::get<1>(*resource)) {
@@ -177,7 +168,7 @@ namespace AdHoc {
ResourcePool<R>::getMine()
{
Lock(lock);
- return safeMapLookup<NoCurrentResourceT<R>>(inUse, std::this_thread::get_id());
+ return ResourceHandle(safeMapLookup<NoCurrentResourceT<R>>(inUse, std::this_thread::get_id()));
}
template <typename R>
@@ -194,7 +185,7 @@ namespace AdHoc {
{
poolSize.wait();
try {
- return getOne();
+ return ResourceHandle(getOne());
}
catch(...) {
poolSize.notify();
@@ -230,7 +221,7 @@ namespace AdHoc {
auto ro = std::make_shared<typename ResourceHandle<R>::Object>(r, this);
available.pop_front();
inUse.insert({ std::this_thread::get_id(), ro });
- return ro;
+ return ResourceHandle(ro);
}
catch (...) {
available.pop_front();
@@ -238,7 +229,7 @@ namespace AdHoc {
}
auto ro = std::make_shared<typename ResourceHandle<R>::Object>(createResource(), this);
inUse.insert({ std::this_thread::get_id(), ro });
- return ro;
+ return ResourceHandle(ro);
}
template <typename R>
diff --git a/libadhocutil/runtimeContext.cpp b/libadhocutil/runtimeContext.cpp
index 6b31743..ba3e2f9 100644
--- a/libadhocutil/runtimeContext.cpp
+++ b/libadhocutil/runtimeContext.cpp
@@ -3,16 +3,10 @@
#include <cstring>
#include <sys.h>
-// NOLINTNEXTLINE(modernize-concat-nested-namespaces)
-namespace AdHoc {
-namespace System {
+namespace AdHoc::System {
RuntimeContext::RuntimeContext(size_t stacksize) :
- stack(stacksize),
- ctxInitial({}),
- ctxCallback({}),
- completed(false),
- swapped(false)
+ stack(stacksize)
{
if (getcontext(&ctxCallback) == -1) {
throw SystemException("getcontext(3) failed", strerror(errno), errno);
@@ -51,5 +45,4 @@ RuntimeContext::callbackWrapper(RuntimeContext * rc)
}
}
-}
diff --git a/libadhocutil/runtimeContext.h b/libadhocutil/runtimeContext.h
index f7c04cf..4a0fada 100644
--- a/libadhocutil/runtimeContext.h
+++ b/libadhocutil/runtimeContext.h
@@ -1,9 +1,10 @@
#ifndef ADHOCUTIL_RUNTIMECONTEXT_H
#define ADHOCUTIL_RUNTIMECONTEXT_H
-#include <stdlib.h>
+#include <cstdlib>
#include <ucontext.h>
#include "visibility.h"
+#include "c++11Helpers.h"
#include <vector>
namespace AdHoc {
@@ -19,14 +20,16 @@ class DLL_PUBLIC RuntimeContext {
* Create a new RuntimeContent
* @param stacksize The size in bytes of the new stack.
*/
- RuntimeContext(size_t stacksize = 16384);
+ explicit RuntimeContext(size_t stacksize = 16384);
virtual ~RuntimeContext() = default;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(RuntimeContext);
/** Swap to/from the contained stack. */
void swapContext();
/** Has the callback on the contained stack run to completion? */
- bool hasCompleted() const;
+ [[nodiscard]] bool hasCompleted() const;
protected:
/** Overridden in a sub-class to implement functionality in the alternate stack */
@@ -36,10 +39,10 @@ class DLL_PUBLIC RuntimeContext {
DLL_PRIVATE static void callbackWrapper(RuntimeContext * rc);
std::vector<char> stack;
- ucontext_t ctxInitial;
- ucontext_t ctxCallback;
- bool completed;
- bool swapped;
+ ucontext_t ctxInitial {};
+ ucontext_t ctxCallback {};
+ bool completed { false };
+ bool swapped { false};
};
}
diff --git a/libadhocutil/safeMapFind.h b/libadhocutil/safeMapFind.h
index 7c36367..980c9b3 100644
--- a/libadhocutil/safeMapFind.h
+++ b/libadhocutil/safeMapFind.h
@@ -13,11 +13,10 @@ template <class Ex, class Map>
typename Map::const_iterator
safeMapFind(const Map & map, const typename Map::key_type & key)
{
- typename Map::const_iterator i = map.find(key);
- if (i == map.end()) {
- throw Ex(key);
+ if (auto i = map.find(key); i != map.end()) {
+ return i;
}
- return i;
+ throw Ex(key);
}
/*
@@ -28,11 +27,10 @@ template <class Map>
typename Map::mapped_type
defaultMapLookup(const Map & map, const typename Map::key_type & key, const typename Map::mapped_type & def = typename Map::mapped_type())
{
- typename Map::const_iterator i = map.find(key);
- if (i == map.end()) {
- return def;
+ if (auto i = map.find(key); i != map.end()) {
+ return i->second;
}
- return i->second;
+ return def;
}
/*
@@ -43,11 +41,10 @@ template <class Ex, class Map>
const typename Map::mapped_type &
safeMapLookup(const Map & map, const typename Map::key_type & key)
{
- typename Map::const_iterator i = map.find(key);
- if (i == map.end()) {
- throw Ex(key);
+ if (auto i = map.find(key); i != map.end()) {
+ return i->second;
}
- return i->second;
+ throw Ex(key);
}
/*
diff --git a/libadhocutil/scopeExit.h b/libadhocutil/scopeExit.h
index af9a645..9a632d4 100644
--- a/libadhocutil/scopeExit.h
+++ b/libadhocutil/scopeExit.h
@@ -4,6 +4,7 @@
#include <functional>
#include <vector>
#include "visibility.h"
+#include "c++11Helpers.h"
namespace AdHoc {
@@ -11,7 +12,7 @@ namespace AdHoc {
class DLL_PUBLIC ScopeExit {
public:
/** Callback for code to be run. */
- typedef std::function<void()> Event;
+ using Event = std::function<void()>;
/**
* Construct an empty trigger for running code yet to be determined at scope exit
@@ -23,13 +24,11 @@ class DLL_PUBLIC ScopeExit {
* @param failure Only run this if the scope is exitted because of an uncaught exception.
* @param post Run this code (unconditionally) last.
*/
- ScopeExit(const Event & pre, const Event & success = Event(), const Event & failure = Event(), const Event & post = Event());
+ explicit ScopeExit(const Event & pre, const Event & success = Event(), const Event & failure = Event(), const Event & post = Event());
~ScopeExit();
- /// Copying construction is disabled
- ScopeExit(const ScopeExit &) = delete;
- /// Assignment is disabled
- void operator=(const ScopeExit &) = delete;
+ /// Standard move/copy support
+ SPECIAL_MEMBERS_DEFAULT_MOVE_NO_COPY(ScopeExit);
/// @cond
std::vector<Event> onExitPre;
diff --git a/libadhocutil/semaphore.h b/libadhocutil/semaphore.h
index 5c7bbea..bb20324 100644
--- a/libadhocutil/semaphore.h
+++ b/libadhocutil/semaphore.h
@@ -13,7 +13,7 @@ namespace AdHoc {
class DLL_PUBLIC Semaphore {
public:
/// Construct a new semaphore with optional initial count.
- Semaphore(unsigned int initial = 0);
+ explicit Semaphore(unsigned int initial = 0);
/// Notify one waiting thread.
void notify();
@@ -23,7 +23,7 @@ namespace AdHoc {
/// @param ms Timeout in milliseconds.
bool wait(unsigned int ms);
/// Free
- unsigned int freeCount() const;
+ [[nodiscard]] unsigned int freeCount() const;
private:
std::mutex mutex;
diff --git a/libadhocutil/unittests/Jamfile.jam b/libadhocutil/unittests/Jamfile.jam
index 7dd62fb..8b1c3c1 100644
--- a/libadhocutil/unittests/Jamfile.jam
+++ b/libadhocutil/unittests/Jamfile.jam
@@ -1,4 +1,3 @@
-import testing ;
import type ;
import generators ;
@@ -21,7 +20,8 @@ lib dl ;
project
: requirements
- <toolset>tidy:<xcheckxx>misc-non-private-member-variables-in-classes
+ <toolset>tidy:<xcheckxx>bugprone-use-after-move
+ <toolset>tidy:<xcheckxx>hicpp-invalid-access-moved
;
h lorem-ipsum : lorem-ipsum.txt ;
@@ -38,6 +38,21 @@ run
;
run
+ testCompileTimeFormatter.cpp
+ : : :
+ <define>ROOT=\"$(me)\"
+ <define>BOOST_TEST_DYN_LINK
+ <library>..//adhocutil
+ <library>stdc++fs
+ <library>boost_utf
+ -<cxxstd>17
+ <cxxstd>2a
+ <implicit-dependency>lorem-ipsum
+ :
+ testCompileTimeFormatter20
+ ;
+
+run
testUriParse.cpp
: : :
<define>ROOT=\"$(me)\"
@@ -303,3 +318,11 @@ run
<library>boost_utf
;
+run
+ testHandle.cpp
+ : : :
+ <define>BOOST_TEST_DYN_LINK
+ <library>..//adhocutil
+ <library>boost_utf
+ ;
+
diff --git a/libadhocutil/unittests/testBuffer.cpp b/libadhocutil/unittests/testBuffer.cpp
index d3a3dcf..f9f7726 100644
--- a/libadhocutil/unittests/testBuffer.cpp
+++ b/libadhocutil/unittests/testBuffer.cpp
@@ -13,13 +13,11 @@ BOOST_AUTO_TEST_CASE ( create )
Buffer use(nonconst, Buffer::Use);
Buffer fre(nonconst, Buffer::Free);
- BOOST_REQUIRE_EQUAL(false, empty);
- BOOST_REQUIRE_EQUAL(true, !empty);
+ BOOST_REQUIRE(!empty);
BOOST_REQUIRE_EQUAL(0, empty.length());
BOOST_REQUIRE_EQUAL("", empty.str());
- BOOST_REQUIRE_EQUAL(true, copy);
- BOOST_REQUIRE_EQUAL(false, !copy);
+ BOOST_REQUIRE(copy);
BOOST_REQUIRE_EQUAL(5, copy.length());
BOOST_REQUIRE_EQUAL("const", copy.str());
diff --git a/libadhocutil/unittests/testCache.cpp b/libadhocutil/unittests/testCache.cpp
index b19f587..8fba9cf 100644
--- a/libadhocutil/unittests/testCache.cpp
+++ b/libadhocutil/unittests/testCache.cpp
@@ -24,10 +24,12 @@ operator==(const int & i, const Obj & o)
}
namespace std {
+ /// LCOV_EXCL_START (diagnostics)
ostream & operator<<(ostream & s, const Obj & o)
{
return s << o.v;
}
+ /// LCOV_EXCL_STOP
}
namespace AdHoc {
diff --git a/libadhocutil/unittests/testCompileTimeFormatter.cpp b/libadhocutil/unittests/testCompileTimeFormatter.cpp
index 39a996b..2109e01 100644
--- a/libadhocutil/unittests/testCompileTimeFormatter.cpp
+++ b/libadhocutil/unittests/testCompileTimeFormatter.cpp
@@ -4,6 +4,7 @@
#include <compileTimeFormatter.h>
#include <fileUtils.h>
#include <definedDirs.h>
+#include "memstream.h"
#include <filesystem>
@@ -35,7 +36,6 @@ namespace AdHoc {
template<typename P, typename ... Pn>
static void write(stream & s, const P & p, const Pn & ... pn)
{
- // NOLINTNEXTLINE(hicpp-no-array-decay)
s << "-( " << p << " )-";
StreamWriter::next(s, pn...);
}
@@ -46,7 +46,6 @@ namespace AdHoc {
template<typename P, typename ... Pn>
static void write(stream & s, const P & p, const Pn & ... pn)
{
- // NOLINTNEXTLINE(hicpp-no-array-decay)
s << "---( " << p << " )---";
StreamWriter::next(s, pn...);
}
@@ -59,7 +58,6 @@ namespace AdHoc {
{
// NOLINTNEXTLINE(bugprone-string-constructor)
std::string d(dashes, '-');
- // NOLINTNEXTLINE(hicpp-no-array-decay)
s << d << "( " << p << " )" << d;
StreamWriter::next(s, pn...);
}
@@ -71,7 +69,6 @@ namespace AdHoc {
static void write(stream & s, int width, const P & p, const Pn & ... pn)
{
std::stringstream buf;
- // NOLINTNEXTLINE(hicpp-no-array-decay)
buf << p;
std::string spaces(width - buf.str().length(), ' ');
s << spaces << buf.str();
@@ -80,6 +77,7 @@ namespace AdHoc {
};
}
+#ifndef __cpp_nontype_template_parameter_class
// Compile string util assertions
static_assert(strlen<formatEdgeCaseEmpty>() == 0);
static_assert(strlen<formatEdgeCaseSingle>() == 1);
@@ -87,16 +85,16 @@ static_assert(strlen<formatEdgeCaseFormatLonely>() == 2);
static_assert(strlen<formatStringLiteral>() == 7);
static_assert(strlen<formatStringLong>() == 246);
-static_assert(strchr<formatEdgeCaseEmpty, 't'>() == -1);
-static_assert(strchr<formatEdgeCaseSingle, 't'>() == -1);
-static_assert(strchr<formatEdgeCaseSingle, '1'>() == 0);
-static_assert(strchr<formatEdgeCaseFormatLonely, '%'>() == 0);
-static_assert(strchr<formatEdgeCaseFormatLonely, '?'>() == 1);
-static_assert(strchr<formatStringLiteral, 'e'>() == 3);
-static_assert(strchr<formatStringLiteral, 'f'>() == -1);
-static_assert(strchr<formatStringLiteral, 'e', 3>() == 3);
-static_assert(strchr<formatStringLiteral, 'e', 4>() == -1);
-static_assert(strchr<formatStringLiteral, 'f', 3>() == -1);
+static_assert(!strchr<formatEdgeCaseEmpty, 't'>());
+static_assert(!strchr<formatEdgeCaseSingle, 't'>());
+static_assert(*strchr<formatEdgeCaseSingle, '1'>() == 0);
+static_assert(*strchr<formatEdgeCaseFormatLonely, '%'>() == 0);
+static_assert(*strchr<formatEdgeCaseFormatLonely, '?'>() == 1);
+static_assert(*strchr<formatStringLiteral, 'e'>() == 3);
+static_assert(!strchr<formatStringLiteral, 'f'>());
+static_assert(*strchr<formatStringLiteral, 'e', 3U>() == 3);
+static_assert(!strchr<formatStringLiteral, 'e', 4U>());
+static_assert(!strchr<formatStringLiteral, 'f', 3U>());
static_assert(strchrnul<formatEdgeCaseEmpty, 't'>() == 0);
static_assert(strchrnul<formatEdgeCaseSingle, 't'>() == 1);
@@ -105,9 +103,9 @@ static_assert(strchrnul<formatEdgeCaseFormatLonely, '%'>() == 0);
static_assert(strchrnul<formatEdgeCaseFormatLonely, '?'>() == 1);
static_assert(strchrnul<formatStringLiteral, 'e'>() == 3);
static_assert(strchrnul<formatStringLiteral, 'f'>() == 7);
-static_assert(strchrnul<formatStringLiteral, 'e', 3>() == 3);
-static_assert(strchrnul<formatStringLiteral, 'e', 4>() == 7);
-static_assert(strchrnul<formatStringLiteral, 'f', 3>() == 7);
+static_assert(strchrnul<formatStringLiteral, 'e', 3U>() == 3);
+static_assert(strchrnul<formatStringLiteral, 'e', 4U>() == 7);
+static_assert(strchrnul<formatStringLiteral, 'f', 3U>() == 7);
static_assert(strchrnul<formatEdgeCaseEmpty, 't'>() == 0);
static_assert(strchrnul<formatEdgeCaseSingle, 't'>() == 1);
@@ -116,6 +114,7 @@ static_assert(strchrnul<formatEdgeCaseFormatLonely, '%'>() == 0);
static_assert(strchrnul<formatEdgeCaseFormatLonely, '?'>() == 1);
static_assert(strchrnul<formatStringLiteral, 'e'>() == 3);
static_assert(strchrnul<formatStringLiteral, 'f'>() == 7);
+#endif
BOOST_FIXTURE_TEST_SUITE( TestStreamWrite, std::stringstream )
@@ -289,7 +288,6 @@ namespace AdHoc {
template<>
inline void appendStream(FILE & strm, const char * const p, size_t n)
{
- // NOLINTNEXTLINE(hicpp-no-array-decay)
BOOST_VERIFY(fwrite(p, n, 1, &strm) == 1);
}
}
@@ -303,17 +301,11 @@ operator<<(FILE & strm, const char * const p)
BOOST_AUTO_TEST_CASE( filestar )
{
- char * buf = nullptr;
- size_t len = 0;
- FILE * strm = open_memstream(&buf, &len);
- BOOST_REQUIRE(strm);
+ MemStream strm;
// NOLINTNEXTLINE(misc-non-copyable-objects)
- Formatter<formatStringMulti>::write(*strm, "file", "star");
- fclose(strm);
- BOOST_CHECK_EQUAL(len, 22);
- BOOST_CHECK_EQUAL(buf, "First file, then star.");
- // NOLINTNEXTLINE(hicpp-no-malloc)
- free(buf);
+ Formatter<formatStringMulti>::write(*strm.operator FILE *(), "file", "star");
+ BOOST_CHECK_EQUAL(strm.length(), 22);
+ BOOST_CHECK_EQUAL(strm.sv(), "First file, then star.");
}
#include "ctf-impl/printf-compat.h"
@@ -454,15 +446,52 @@ BOOST_AUTO_TEST_CASE(smartptr)
smartptr_fmt::get(shrd);
}
-// This tests scprintf macro, which in turn requires compiler support
-#ifdef scprintf
-BOOST_AUTO_TEST_CASE(scprintf)
+#ifdef __cpp_nontype_template_parameter_class
+BOOST_AUTO_TEST_CASE(literal_format_string)
+{
+ std::stringstream str;
+ LiteralFormatter<"literal format string %?.">::write(str, 42);
+ BOOST_CHECK_EQUAL("literal format string 42.", str.str());
+}
+
+BOOST_AUTO_TEST_CASE(cprintf_args)
+{
+ auto & strret = cprintf<"Some literal format string (%d, %c).">(0, 'f');
+ BOOST_CHECK_EQUAL(&std::cout, &strret);
+}
+
+BOOST_AUTO_TEST_CASE(scprintf_strm_args)
+{
+ std::stringstream str;
+ auto & strret = scprintf<"Some literal format string (%d, %c).">(str, 0, 'f');
+ BOOST_CHECK_EQUAL(&str, &strret);
+ BOOST_CHECK_EQUAL(str.str(), "Some literal format string (0, f).");
+}
+
+BOOST_AUTO_TEST_CASE(scprintf_get_args)
+{
+ auto stng = scprintf<"Some literal format string (%d, %c).">(0, 'f');
+ BOOST_CHECK_EQUAL(stng, "Some literal format string (0, f).");
+}
+
+BOOST_AUTO_TEST_CASE(cprintf_no_args)
+{
+ auto & strret = cprintf<"Some literal format string.">();
+ BOOST_CHECK_EQUAL(&std::cout, &strret);
+}
+
+BOOST_AUTO_TEST_CASE(scprintf_strm_no_args)
+{
+ std::stringstream str;
+ auto & strret = scprintf<"Some literal format string.">(str);
+ BOOST_CHECK_EQUAL(&str, &strret);
+ BOOST_CHECK_EQUAL(str.str(), "Some literal format string.");
+}
+
+BOOST_AUTO_TEST_CASE(scprintf_get_no_args)
{
- auto str = std::make_unique<std::stringstream>();
- auto & strret = scprintf(*str, "Some literal format string (%d, %c).", 0, 'f');
- BOOST_CHECK_EQUAL(str.get(), &strret); // We got back our original stream
- BOOST_CHECK_EQUAL(str->str(), "Some literal format string (0, f).");
- scprintf(*str, "Some literal format string, no args.");
+ auto stng = scprintf<"Some literal format string.">();
+ BOOST_CHECK_EQUAL(stng, "Some literal format string.");
}
#endif
diff --git a/libadhocutil/unittests/testCurl.cpp b/libadhocutil/unittests/testCurl.cpp
index 6435224..977bbfd 100644
--- a/libadhocutil/unittests/testCurl.cpp
+++ b/libadhocutil/unittests/testCurl.cpp
@@ -20,7 +20,9 @@ discard(void *, size_t sz, size_t nm, void *)
}
AdHocFormatter(FileUrl, "file://%?/%?");
-const auto urlGen = std::bind((std::string(*)(const std::string &, const std::string_view &))&FileUrl::get, rootDir, std::placeholders::_1);
+const auto urlGen = [](const std::string_view & url) {
+ return FileUrl::get(rootDir.string(), url);
+};
BOOST_AUTO_TEST_CASE( fetch_file )
{
@@ -125,11 +127,11 @@ BOOST_AUTO_TEST_CASE( fetch_multi )
CurlMultiHandle cmh;
std::map<std::string, std::string> files;
cmh.addCurl(urlGen("/testBuffer.cpp"),
- std::bind(&mapFileToName, std::ref(files), "testBuffer.cpp", _1));
+ [&files](auto && PH1) { return mapFileToName(files, "testBuffer.cpp", PH1); });
cmh.addCurl(urlGen("/testCurl.cpp"),
- std::bind(&mapFileToName, std::ref(files), "testCurl.cpp", _1));
+ [&files](auto && PH1) { return mapFileToName(files, "testCurl.cpp", PH1); });
cmh.addCurl(urlGen("/testLocks.cpp"),
- std::bind(&mapFileToName, std::ref(files), "testLocks.cpp", _1));
+ [&files](auto && PH1) { return mapFileToName(files, "testLocks.cpp", PH1); });
cmh.performAll();
BOOST_REQUIRE_EQUAL(3, files.size());
BOOST_REQUIRE_EQUAL("Locks", files["testLocks.cpp"]);
@@ -151,7 +153,9 @@ BOOST_AUTO_TEST_CASE( fetch_multi_fail )
}
s >> tok;
}
+ /// LCOV_EXCL_START (should not occur)
finished = true;
+ /// LCOV_EXCL_STOP
});
cmh.performAll();
BOOST_REQUIRE(!finished);
diff --git a/libadhocutil/unittests/testException.cpp b/libadhocutil/unittests/testException.cpp
index 2533301..63fc2a3 100644
--- a/libadhocutil/unittests/testException.cpp
+++ b/libadhocutil/unittests/testException.cpp
@@ -49,13 +49,11 @@ class Ex3 : public AdHoc::StdException {
void failing1()
{
- // NOLINTNEXTLINE(hicpp-no-array-decay)
throw Ex1(__PRETTY_FUNCTION__, 1);
}
void failing2()
{
- // NOLINTNEXTLINE(hicpp-no-array-decay)
throw Ex2(__PRETTY_FUNCTION__, 2);
}
diff --git a/libadhocutil/unittests/testFileUtils.cpp b/libadhocutil/unittests/testFileUtils.cpp
index 7cd220c..f92d03e 100644
--- a/libadhocutil/unittests/testFileUtils.cpp
+++ b/libadhocutil/unittests/testFileUtils.cpp
@@ -63,7 +63,6 @@ BOOST_AUTO_TEST_CASE( movePassThrough )
auto y = std::make_unique<Sub>(std::move(f));
BOOST_REQUIRE_EQUAL(y->fh, ffd);
REQUIRE_VALID_FH(y->fh);
- // NOLINTNEXTLINE(bugprone-use-after-move,hicpp-invalid-access-moved)
BOOST_REQUIRE_EQUAL(f.fh, -1);
REQUIRE_INVALID_FH(f.fh);
y.reset();
diff --git a/libadhocutil/unittests/testHandle.cpp b/libadhocutil/unittests/testHandle.cpp
new file mode 100644
index 0000000..e7f52af
--- /dev/null
+++ b/libadhocutil/unittests/testHandle.cpp
@@ -0,0 +1,60 @@
+#define BOOST_TEST_MODULE Handle
+#include <boost/test/unit_test.hpp>
+
+#include <type_traits>
+#include <fcntl.h>
+#include "handle.h"
+
+// Test case base on a file handle
+using T = decltype(STDIN_FILENO);
+using D = decltype(&close);
+static_assert(std::is_trivially_move_constructible_v<T>);
+static_assert(std::is_trivially_move_constructible_v<D>);
+
+using TestHandle = AdHoc::Handle<T, D>;
+
+static_assert(std::is_nothrow_move_constructible_v<TestHandle>);
+static_assert(std::is_nothrow_move_assignable_v<TestHandle>);
+static_assert(!std::is_copy_constructible_v<TestHandle>);
+static_assert(!std::is_copy_assignable_v<TestHandle>);
+
+BOOST_AUTO_TEST_CASE(values)
+{
+ TestHandle th { open("/dev/null", O_RDWR), &close };
+ static_assert(std::is_same_v<T, std::remove_reference_t<decltype(th.get())>>);
+ static_assert(std::is_same_v<T, std::remove_reference_t<decltype(*th)>>);
+ BOOST_REQUIRE_EQUAL(1, write(th, "1", 1));
+}
+
+BOOST_AUTO_TEST_CASE(values_const)
+{
+ const TestHandle cth { open("/dev/null", O_RDWR), &close };
+ static_assert(std::is_same_v<const T, std::remove_reference_t<decltype(cth.get())>>);
+ static_assert(std::is_same_v<const T, std::remove_reference_t<decltype(*cth)>>);
+ BOOST_REQUIRE_EQUAL(1, write(cth, "1", 1));
+}
+
+BOOST_AUTO_TEST_CASE(make)
+{
+ bool closed = false;
+ int fd = -2;
+ const auto doClose = [&](T lfd) {
+ BOOST_CHECK(!closed);
+ BOOST_CHECK_EQUAL(lfd, fd);
+ closed = true;
+ return close(lfd);
+ };
+ {
+ auto th = AdHoc::make_handle<T>(doClose, open("/dev/null", O_RDWR));
+ BOOST_REQUIRE(!closed);
+ BOOST_REQUIRE_EQUAL(1, write(th, "1", 1));
+ auto th2 = std::move(th);
+ BOOST_REQUIRE(!closed);
+ BOOST_REQUIRE_EQUAL(1, write(th2, "1", 1));
+ fd = th2;
+ }
+ BOOST_REQUIRE(closed);
+ BOOST_REQUIRE_EQUAL(-1, write(fd, "1", 1));
+ BOOST_REQUIRE_EQUAL(errno, EBADF);
+}
+
diff --git a/libadhocutil/unittests/testLazyPointer.cpp b/libadhocutil/unittests/testLazyPointer.cpp
index 52e5c79..31b92a5 100644
--- a/libadhocutil/unittests/testLazyPointer.cpp
+++ b/libadhocutil/unittests/testLazyPointer.cpp
@@ -17,6 +17,11 @@ class Test {
using TestLazyPointer = LazyPointer<Test>;
using RawLazyPointer = LazyPointer<int, int *>;
+/// LCOV_EXCL_START (diagnostics)
+BOOST_TEST_DONT_PRINT_LOG_VALUE(TestLazyPointer);
+BOOST_TEST_DONT_PRINT_LOG_VALUE(RawLazyPointer);
+/// LCOV_EXCL_STOP
+
static
TestLazyPointer::pointer_type
factory()
@@ -33,12 +38,11 @@ paramFactory(const std::string & str)
BOOST_AUTO_TEST_CASE ( islazy )
{
- TestLazyPointer p(std::bind(&factory));
+ TestLazyPointer p([]{ return factory(); });
BOOST_REQUIRE_EQUAL(false, p.hasValue());
Test * t = p.get();
BOOST_REQUIRE(t);
- bool pbool = p;
- BOOST_REQUIRE(pbool);
+ BOOST_REQUIRE(p);
BOOST_REQUIRE_EQUAL(true, p.hasValue());
BOOST_REQUIRE_EQUAL(p, t);
BOOST_REQUIRE_EQUAL(3, t->val);
@@ -48,7 +52,7 @@ BOOST_AUTO_TEST_CASE ( islazy )
BOOST_AUTO_TEST_CASE ( preinit )
{
Test * t = new Test(4);
- TestLazyPointer p(t);
+ TestLazyPointer p(TestLazyPointer::pointer_type{ t });
BOOST_REQUIRE_EQUAL(true, p.hasValue());
BOOST_REQUIRE_EQUAL(p, t);
BOOST_REQUIRE_EQUAL(4, p->val);
@@ -57,22 +61,22 @@ BOOST_AUTO_TEST_CASE ( preinit )
BOOST_AUTO_TEST_CASE ( reset )
{
Test * t = new Test(4);
- TestLazyPointer p(t);
+ TestLazyPointer p(TestLazyPointer::pointer_type{ t });
BOOST_REQUIRE_EQUAL(true, p.hasValue());
BOOST_REQUIRE_EQUAL(4, p->val);
p = nullptr;
BOOST_REQUIRE_EQUAL(true, p.hasValue());
BOOST_REQUIRE_EQUAL(true, !p);
- p = std::bind(&factory);
+ p = []{ return factory(); };
BOOST_REQUIRE_EQUAL(false, p.hasValue());
- p.get();
+ BOOST_REQUIRE(p.get());
BOOST_REQUIRE_EQUAL(true, p.hasValue());
BOOST_REQUIRE_EQUAL(3, p->val);
}
BOOST_AUTO_TEST_CASE ( nondefault )
{
- TestLazyPointer p(std::bind(&paramFactory, "some string"));
+ TestLazyPointer p([]{ return paramFactory("some string"); });
BOOST_REQUIRE_EQUAL(false, p.hasValue());
BOOST_REQUIRE_EQUAL(11, (*p).val);
BOOST_REQUIRE_EQUAL(true, p.hasValue());
@@ -93,9 +97,9 @@ BOOST_AUTO_TEST_CASE( rawPointerNonNull )
BOOST_REQUIRE(value);
BOOST_REQUIRE(value.get());
BOOST_REQUIRE_EQUAL(*value, 3);
- int * x = value;
+ int * x = (int *)value;
BOOST_REQUIRE_EQUAL(*x, 3);
- delete value;
+ delete x;
}
int *
@@ -106,10 +110,10 @@ rawFactory(const std::string & s)
BOOST_AUTO_TEST_CASE( rawPointerFactory )
{
- RawLazyPointer value(std::bind(&rawFactory, std::string("four")));
+ RawLazyPointer value([]{ return rawFactory(std::string("four")); });
BOOST_REQUIRE(!value.hasValue());
BOOST_REQUIRE_EQUAL(*value, 4);
BOOST_REQUIRE(value.hasValue());
- delete value;
+ delete (int *)value;
}
diff --git a/libadhocutil/unittests/testNagios.cpp b/libadhocutil/unittests/testNagios.cpp
index 7ef64dc..8e8e025 100644
--- a/libadhocutil/unittests/testNagios.cpp
+++ b/libadhocutil/unittests/testNagios.cpp
@@ -3,10 +3,12 @@
#include <boost/test/unit_test.hpp>
#include <nagios.h>
+/// LCOV_EXCL_START (calls real Nagios)
BOOST_AUTO_TEST_CASE(test_write_cmd, * boost::unit_test::disabled())
{
BOOST_REQUIRE(AdHoc::submitNagiosPassiveServiceCheck("some service", AdHoc::NagiosStatusCode::OK, "bar"));
}
+/// LCOV_EXCL_STOP
BOOST_AUTO_TEST_CASE(test_fmtrite_cmd)
{
diff --git a/libadhocutil/unittests/testNvpParse.cpp b/libadhocutil/unittests/testNvpParse.cpp
index 619123a..678f468 100644
--- a/libadhocutil/unittests/testNvpParse.cpp
+++ b/libadhocutil/unittests/testNvpParse.cpp
@@ -20,7 +20,9 @@ NvpTarget(TestTarget) TestTargetMap {
NvpValue(TestTarget, d),
};
+/// LCOV_EXCL_START (diagnostics)
BOOST_TEST_DONT_PRINT_LOG_VALUE(decltype(TestTargetMap.find("")));
+/// LCOV_EXCL_STOP
BOOST_AUTO_TEST_CASE ( targetmap )
{
diff --git a/libadhocutil/unittests/testOptionals.cpp b/libadhocutil/unittests/testOptionals.cpp
index 90e247b..f6dc371 100644
--- a/libadhocutil/unittests/testOptionals.cpp
+++ b/libadhocutil/unittests/testOptionals.cpp
@@ -15,7 +15,7 @@ BOOST_AUTO_TEST_CASE ( general )
Ice::optional<float> ix;
Ice::optional<short> iy = 4;
std::string * p = nullptr;
- std::string * q = new std::string("str");
+ auto * q = new std::string("str");
std::optional<std::string> r;
Ice::optional<std::string> s;
diff --git a/libadhocutil/unittests/testPlugins.cpp b/libadhocutil/unittests/testPlugins.cpp
index bdcfe6d..9a6cc7e 100644
--- a/libadhocutil/unittests/testPlugins.cpp
+++ b/libadhocutil/unittests/testPlugins.cpp
@@ -68,12 +68,12 @@ BOOST_AUTO_TEST_CASE( removeManual )
BOOST_REQUIRE_EQUAL(3, PluginManager::getDefault()->count());
PluginManager::getDefault()->remove<BaseThing>("custom1");
BOOST_REQUIRE_EQUAL(2, PluginManager::getDefault()->count());
- BOOST_REQUIRE_THROW(PluginManager::getDefault()->get<BaseThing>("custom1"), NoSuchPluginException);
+ BOOST_REQUIRE_THROW((void)PluginManager::getDefault()->get<BaseThing>("custom1"), NoSuchPluginException);
BOOST_REQUIRE(PluginManager::getDefault()->get<BaseThing>("custom2"));
BOOST_REQUIRE(PluginManager::getDefault()->get<BaseThing>("ImplOfThing"));
PluginManager::getDefault()->remove<BaseThing>("custom2");
BOOST_REQUIRE_EQUAL(1, PluginManager::getDefault()->count());
- BOOST_REQUIRE_THROW(PluginManager::getDefault()->get<BaseThing>("custom2"), NoSuchPluginException);
+ BOOST_REQUIRE_THROW((void)PluginManager::getDefault()->get<BaseThing>("custom2"), NoSuchPluginException);
BOOST_REQUIRE(PluginManager::getDefault()->get<BaseThing>("ImplOfThing"));
}
diff --git a/libadhocutil/unittests/testPluginsRuntime.cpp b/libadhocutil/unittests/testPluginsRuntime.cpp
index 9f8f3e6..c3ecf34 100644
--- a/libadhocutil/unittests/testPluginsRuntime.cpp
+++ b/libadhocutil/unittests/testPluginsRuntime.cpp
@@ -79,7 +79,7 @@ BOOST_AUTO_TEST_CASE( null )
{
auto pm = AdHoc::PluginManager::getDefault();
pm->addResolver<BaseThing>(nullResolver);
- BOOST_REQUIRE_THROW(pm->get<BaseThing>("ImplOfThing"), AdHoc::NoSuchPluginException);
+ BOOST_REQUIRE_THROW((void)pm->get<BaseThing>("ImplOfThing"), AdHoc::NoSuchPluginException);
pm->removeResolver<BaseThing>();
}
@@ -87,7 +87,7 @@ BOOST_AUTO_TEST_CASE( bad )
{
auto pm = AdHoc::PluginManager::getDefault();
pm->addResolver<BaseThing>(badResolver);
- BOOST_REQUIRE_THROW(pm->get<BaseThing>("ImplOfThing"), AdHoc::LoadLibraryException);
+ BOOST_REQUIRE_THROW((void)pm->get<BaseThing>("ImplOfThing"), AdHoc::LoadLibraryException);
pm->removeResolver<BaseThing>();
}
diff --git a/libadhocutil/unittests/testProcessPipes.cpp b/libadhocutil/unittests/testProcessPipes.cpp
index b568984..968ac2a 100644
--- a/libadhocutil/unittests/testProcessPipes.cpp
+++ b/libadhocutil/unittests/testProcessPipes.cpp
@@ -7,7 +7,7 @@
using namespace AdHoc::System;
-BOOST_AUTO_TEST_CASE ( readfind )
+BOOST_AUTO_TEST_CASE( readfind )
{
ProcessPipes pp({"/usr/bin/find", rootDir, "-maxdepth", "1"}, false, true, true);
BOOST_REQUIRE_EQUAL(pp.fdIn(), -1);
@@ -23,3 +23,25 @@ BOOST_AUTO_TEST_CASE ( readfind )
waitpid(pp.pid(), &status, 0);
}
+BOOST_AUTO_TEST_CASE( readwrite )
+{
+ ProcessPipes pp({"/usr/bin/md5sum"}, true, true, false);
+ BOOST_REQUIRE_NE(pp.fdIn(), -1);
+ BOOST_REQUIRE_NE(pp.fdOut(), -1);
+ BOOST_REQUIRE_EQUAL(pp.fdError(), -1);
+ BOOST_REQUIRE_EQUAL(11, write(pp.fdIn(), "some string", 11));
+ BOOST_REQUIRE_EQUAL(0, pp.closeIn());
+ std::string out(32, ' ');
+ BOOST_REQUIRE_EQUAL(32, read(pp.fdOut(), out.data(), 32));
+ BOOST_CHECK_EQUAL(out, "5ac749fbeec93607fc28d666be85e73a");
+ int status;
+ waitpid(pp.pid(), &status, 0);
+}
+
+BOOST_AUTO_TEST_CASE( noargs )
+{
+ BOOST_CHECK_THROW({
+ ProcessPipes({}, false, false, false);
+ }, std::invalid_argument);
+}
+
diff --git a/libadhocutil/unittests/testResourcePool.cpp b/libadhocutil/unittests/testResourcePool.cpp
index ec8bd71..4fd1f72 100644
--- a/libadhocutil/unittests/testResourcePool.cpp
+++ b/libadhocutil/unittests/testResourcePool.cpp
@@ -8,10 +8,7 @@ class MockResource {
MockResource() : id(ids++) { count += 1; }
~MockResource() { count -= 1; }
- MockResource(const MockResource &) = delete;
- MockResource(MockResource &&) = delete;
- void operator=(const MockResource &) = delete;
- void operator=(MockResource &&) = delete;
+ SPECIAL_MEMBERS_DELETE(MockResource);
[[ nodiscard ]] bool valid() const { return true; }
@@ -98,7 +95,6 @@ BOOST_AUTO_TEST_CASE ( get )
BOOST_REQUIRE(true);
}
BOOST_REQUIRE(!r1a);
- BOOST_REQUIRE_THROW(r1a.get(), std::runtime_error);
r1a = r2;
BOOST_REQUIRE(r1a);
BOOST_REQUIRE_EQUAL(r2.get(), r1a.get());
@@ -159,14 +155,12 @@ BOOST_AUTO_TEST_CASE( move )
{
auto r2(std::move(r1));
BOOST_CHECK_EQUAL(pool.inUseCount(), 1);
- // NOLINTNEXTLINE(bugprone-use-after-move,hicpp-invalid-access-moved)
BOOST_CHECK(!r1);
BOOST_CHECK(r2);
r1 = std::move(r2);
BOOST_CHECK_EQUAL(pool.inUseCount(), 1);
BOOST_CHECK(r1);
- // NOLINTNEXTLINE(bugprone-use-after-move,hicpp-invalid-access-moved)
BOOST_CHECK(!r2);
r2 = pool.get();
@@ -176,7 +170,6 @@ BOOST_AUTO_TEST_CASE( move )
r1 = std::move(r2);
BOOST_CHECK_EQUAL(pool.inUseCount(), 1);
BOOST_CHECK(r1);
- // NOLINTNEXTLINE(bugprone-use-after-move,hicpp-invalid-access-moved)
BOOST_CHECK(!r2);
}
BOOST_CHECK_EQUAL(pool.inUseCount(), 1);
@@ -403,3 +396,9 @@ BOOST_AUTO_TEST_CASE( returnFail )
BOOST_REQUIRE_EQUAL(3, pool.freeCount());
}
+BOOST_AUTO_TEST_CASE( exception_msgs )
+{
+ BOOST_CHECK_NO_THROW(AdHoc::TimeOutOnResourcePool("foo").message());
+ BOOST_CHECK_NO_THROW(AdHoc::NoCurrentResource(std::this_thread::get_id(), "foo").message());
+}
+