Commit 959262627d2508f490cf3bba850577040490d695

Authored by Leandro Cerencio
0 parents

first commit

CMakeLists.txt 0 → 100644
  1 +++ a/CMakeLists.txt
... ... @@ -0,0 +1,13 @@
  1 +cmake_minimum_required (VERSION 3.0)
  2 +project (socket CXX)
  3 +
  4 +include (CheckFunctionExists)
  5 +check_function_exists (usleep USE_POSIX)
  6 +
  7 +add_subdirectory (src)
  8 +add_subdirectory (test)
  9 +
  10 +# get_cmake_property(_variableNames VARIABLES)
  11 +# foreach (_variableName ${_variableNames})
  12 +# message(STATUS "${_variableName}=${${_variableName}}")
  13 +# endforeach()
... ...
README.md 0 → 100644
  1 +++ a/README.md
... ... @@ -0,0 +1 @@
  1 +# easy-socket
... ...
doc/socket.asta 0 → 100644
No preview for this file type
src/CMakeLists.txt 0 → 100644
  1 +++ a/src/CMakeLists.txt
... ... @@ -0,0 +1,19 @@
  1 +find_package (Threads REQUIRED)
  2 +
  3 +if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
  4 + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_WIN32_WINNT=0x0600 ")
  5 + option ("USE_WINSOCK" "Usa winsock" "ON")
  6 + if (${MINGW})
  7 + SET(BUILD_SHARED_LIBRARIES OFF)
  8 + SET(CMAKE_EXE_LINKER_FLAGS "-static")
  9 + endif()
  10 +endif()
  11 +
  12 +configure_file ("config/config.h.in" "${PROJECT_BINARY_DIR}/config.h")
  13 +
  14 +include_directories ("${PROJECT_BINARY_DIR}")
  15 +include_directories ("lib")
  16 +
  17 +add_subdirectory ("utils")
  18 +add_subdirectory ("lib")
  19 +
... ...
src/Doxygen 0 → 100644
  1 +++ a/src/Doxygen
... ... @@ -0,0 +1,2479 @@
  1 +# Doxyfile 1.8.11
  2 +
  3 +# This file describes the settings to be used by the documentation system
  4 +# doxygen (www.doxygen.org) for a project.
  5 +#
  6 +# All text after a double hash (##) is considered a comment and is placed in
  7 +# front of the TAG it is preceding.
  8 +#
  9 +# All text after a single hash (#) is considered a comment and will be ignored.
  10 +# The format is:
  11 +# TAG = value [value, ...]
  12 +# For lists, items can also be appended using:
  13 +# TAG += value [value, ...]
  14 +# Values that contain spaces should be placed between quotes (\" \").
  15 +
  16 +#---------------------------------------------------------------------------
  17 +# Project related configuration options
  18 +#---------------------------------------------------------------------------
  19 +
  20 +# This tag specifies the encoding used for all characters in the config file
  21 +# that follow. The default is UTF-8 which is also the encoding used for all text
  22 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  23 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  24 +# for the list of possible encodings.
  25 +# The default value is: UTF-8.
  26 +
  27 +DOXYFILE_ENCODING = UTF-8
  28 +
  29 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  30 +# double-quotes, unless you are using Doxywizard) that should identify the
  31 +# project for which the documentation is generated. This name is used in the
  32 +# title of most generated pages and in a few other places.
  33 +# The default value is: My Project.
  34 +
  35 +PROJECT_NAME = socket
  36 +
  37 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  38 +# could be handy for archiving the generated documentation or if some version
  39 +# control system is used.
  40 +
  41 +PROJECT_NUMBER = 1.0
  42 +
  43 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
  44 +# for a project that appears at the top of each page and should give viewer a
  45 +# quick idea about the purpose of the project. Keep the description short.
  46 +
  47 +PROJECT_BRIEF =
  48 +
  49 +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  50 +# in the documentation. The maximum height of the logo should not exceed 55
  51 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  52 +# the logo to the output directory.
  53 +
  54 +PROJECT_LOGO =
  55 +
  56 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  57 +# into which the generated documentation will be written. If a relative path is
  58 +# entered, it will be relative to the location where doxygen was started. If
  59 +# left blank the current directory will be used.
  60 +
  61 +OUTPUT_DIRECTORY = /home/leandro/workspaces/cpp/socket/doc
  62 +
  63 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  64 +# directories (in 2 levels) under the output directory of each output format and
  65 +# will distribute the generated files over these directories. Enabling this
  66 +# option can be useful when feeding doxygen a huge amount of source files, where
  67 +# putting all generated files in the same directory would otherwise causes
  68 +# performance problems for the file system.
  69 +# The default value is: NO.
  70 +
  71 +CREATE_SUBDIRS = NO
  72 +
  73 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  74 +# characters to appear in the names of generated files. If set to NO, non-ASCII
  75 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  76 +# U+3044.
  77 +# The default value is: NO.
  78 +
  79 +ALLOW_UNICODE_NAMES = NO
  80 +
  81 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
  82 +# documentation generated by doxygen is written. Doxygen will use this
  83 +# information to generate all constant output in the proper language.
  84 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  85 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  86 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  87 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  88 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  89 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  90 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  91 +# Ukrainian and Vietnamese.
  92 +# The default value is: English.
  93 +
  94 +OUTPUT_LANGUAGE = English
  95 +
  96 +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  97 +# descriptions after the members that are listed in the file and class
  98 +# documentation (similar to Javadoc). Set to NO to disable this.
  99 +# The default value is: YES.
  100 +
  101 +BRIEF_MEMBER_DESC = YES
  102 +
  103 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  104 +# description of a member or function before the detailed description
  105 +#
  106 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  107 +# brief descriptions will be completely suppressed.
  108 +# The default value is: YES.
  109 +
  110 +REPEAT_BRIEF = YES
  111 +
  112 +# This tag implements a quasi-intelligent brief description abbreviator that is
  113 +# used to form the text in various listings. Each string in this list, if found
  114 +# as the leading text of the brief description, will be stripped from the text
  115 +# and the result, after processing the whole list, is used as the annotated
  116 +# text. Otherwise, the brief description is used as-is. If left blank, the
  117 +# following values are used ($name is automatically replaced with the name of
  118 +# the entity):The $name class, The $name widget, The $name file, is, provides,
  119 +# specifies, contains, represents, a, an and the.
  120 +
  121 +ABBREVIATE_BRIEF = "The $name class" \
  122 + "The $name widget" \
  123 + "The $name file" \
  124 + is \
  125 + provides \
  126 + specifies \
  127 + contains \
  128 + represents \
  129 + a \
  130 + an \
  131 + the
  132 +
  133 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  134 +# doxygen will generate a detailed section even if there is only a brief
  135 +# description.
  136 +# The default value is: NO.
  137 +
  138 +ALWAYS_DETAILED_SEC = NO
  139 +
  140 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  141 +# inherited members of a class in the documentation of that class as if those
  142 +# members were ordinary class members. Constructors, destructors and assignment
  143 +# operators of the base classes will not be shown.
  144 +# The default value is: NO.
  145 +
  146 +INLINE_INHERITED_MEMB = NO
  147 +
  148 +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  149 +# before files name in the file list and in the header files. If set to NO the
  150 +# shortest path that makes the file name unique will be used
  151 +# The default value is: YES.
  152 +
  153 +FULL_PATH_NAMES = YES
  154 +
  155 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  156 +# Stripping is only done if one of the specified strings matches the left-hand
  157 +# part of the path. The tag can be used to show relative paths in the file list.
  158 +# If left blank the directory from which doxygen is run is used as the path to
  159 +# strip.
  160 +#
  161 +# Note that you can specify absolute paths here, but also relative paths, which
  162 +# will be relative from the directory where doxygen is started.
  163 +# This tag requires that the tag FULL_PATH_NAMES is set to YES.
  164 +
  165 +STRIP_FROM_PATH =
  166 +
  167 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  168 +# path mentioned in the documentation of a class, which tells the reader which
  169 +# header file to include in order to use a class. If left blank only the name of
  170 +# the header file containing the class definition is used. Otherwise one should
  171 +# specify the list of include paths that are normally passed to the compiler
  172 +# using the -I flag.
  173 +
  174 +STRIP_FROM_INC_PATH =
  175 +
  176 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  177 +# less readable) file names. This can be useful is your file systems doesn't
  178 +# support long names like on DOS, Mac, or CD-ROM.
  179 +# The default value is: NO.
  180 +
  181 +SHORT_NAMES = NO
  182 +
  183 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  184 +# first line (until the first dot) of a Javadoc-style comment as the brief
  185 +# description. If set to NO, the Javadoc-style will behave just like regular Qt-
  186 +# style comments (thus requiring an explicit @brief command for a brief
  187 +# description.)
  188 +# The default value is: NO.
  189 +
  190 +JAVADOC_AUTOBRIEF = NO
  191 +
  192 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  193 +# line (until the first dot) of a Qt-style comment as the brief description. If
  194 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  195 +# requiring an explicit \brief command for a brief description.)
  196 +# The default value is: NO.
  197 +
  198 +QT_AUTOBRIEF = NO
  199 +
  200 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  201 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  202 +# a brief description. This used to be the default behavior. The new default is
  203 +# to treat a multi-line C++ comment block as a detailed description. Set this
  204 +# tag to YES if you prefer the old behavior instead.
  205 +#
  206 +# Note that setting this tag to YES also means that rational rose comments are
  207 +# not recognized any more.
  208 +# The default value is: NO.
  209 +
  210 +MULTILINE_CPP_IS_BRIEF = NO
  211 +
  212 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  213 +# documentation from any documented member that it re-implements.
  214 +# The default value is: YES.
  215 +
  216 +INHERIT_DOCS = YES
  217 +
  218 +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  219 +# page for each member. If set to NO, the documentation of a member will be part
  220 +# of the file/class/namespace that contains it.
  221 +# The default value is: NO.
  222 +
  223 +SEPARATE_MEMBER_PAGES = NO
  224 +
  225 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  226 +# uses this value to replace tabs by spaces in code fragments.
  227 +# Minimum value: 1, maximum value: 16, default value: 4.
  228 +
  229 +TAB_SIZE = 4
  230 +
  231 +# This tag can be used to specify a number of aliases that act as commands in
  232 +# the documentation. An alias has the form:
  233 +# name=value
  234 +# For example adding
  235 +# "sideeffect=@par Side Effects:\n"
  236 +# will allow you to put the command \sideeffect (or @sideeffect) in the
  237 +# documentation, which will result in a user-defined paragraph with heading
  238 +# "Side Effects:". You can put \n's in the value part of an alias to insert
  239 +# newlines.
  240 +
  241 +ALIASES =
  242 +
  243 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
  244 +# A mapping has the form "name=value". For example adding "class=itcl::class"
  245 +# will allow you to use the command class in the itcl::class meaning.
  246 +
  247 +TCL_SUBST =
  248 +
  249 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  250 +# only. Doxygen will then generate output that is more tailored for C. For
  251 +# instance, some of the names that are used will be different. The list of all
  252 +# members will be omitted, etc.
  253 +# The default value is: NO.
  254 +
  255 +OPTIMIZE_OUTPUT_FOR_C = NO
  256 +
  257 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  258 +# Python sources only. Doxygen will then generate output that is more tailored
  259 +# for that language. For instance, namespaces will be presented as packages,
  260 +# qualified scopes will look different, etc.
  261 +# The default value is: NO.
  262 +
  263 +OPTIMIZE_OUTPUT_JAVA = NO
  264 +
  265 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  266 +# sources. Doxygen will then generate output that is tailored for Fortran.
  267 +# The default value is: NO.
  268 +
  269 +OPTIMIZE_FOR_FORTRAN = NO
  270 +
  271 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  272 +# sources. Doxygen will then generate output that is tailored for VHDL.
  273 +# The default value is: NO.
  274 +
  275 +OPTIMIZE_OUTPUT_VHDL = NO
  276 +
  277 +# Doxygen selects the parser to use depending on the extension of the files it
  278 +# parses. With this tag you can assign which parser to use for a given
  279 +# extension. Doxygen has a built-in mapping, but you can override or extend it
  280 +# using this tag. The format is ext=language, where ext is a file extension, and
  281 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  282 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  283 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  284 +# Fortran. In the later case the parser tries to guess whether the code is fixed
  285 +# or free formatted code, this is the default for Fortran type files), VHDL. For
  286 +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
  287 +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
  288 +#
  289 +# Note: For files without extension you can use no_extension as a placeholder.
  290 +#
  291 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  292 +# the files are not read by doxygen.
  293 +
  294 +EXTENSION_MAPPING =
  295 +
  296 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  297 +# according to the Markdown format, which allows for more readable
  298 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
  299 +# The output of markdown processing is further processed by doxygen, so you can
  300 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  301 +# case of backward compatibilities issues.
  302 +# The default value is: YES.
  303 +
  304 +MARKDOWN_SUPPORT = YES
  305 +
  306 +# When enabled doxygen tries to link words that correspond to documented
  307 +# classes, or namespaces to their corresponding documentation. Such a link can
  308 +# be prevented in individual cases by putting a % sign in front of the word or
  309 +# globally by setting AUTOLINK_SUPPORT to NO.
  310 +# The default value is: YES.
  311 +
  312 +AUTOLINK_SUPPORT = YES
  313 +
  314 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  315 +# to include (a tag file for) the STL sources as input, then you should set this
  316 +# tag to YES in order to let doxygen match functions declarations and
  317 +# definitions whose arguments contain STL classes (e.g. func(std::string);
  318 +# versus func(std::string) {}). This also make the inheritance and collaboration
  319 +# diagrams that involve STL classes more complete and accurate.
  320 +# The default value is: NO.
  321 +
  322 +BUILTIN_STL_SUPPORT = NO
  323 +
  324 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
  325 +# enable parsing support.
  326 +# The default value is: NO.
  327 +
  328 +CPP_CLI_SUPPORT = NO
  329 +
  330 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  331 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  332 +# will parse them like normal C++ but will assume all classes use public instead
  333 +# of private inheritance when no explicit protection keyword is present.
  334 +# The default value is: NO.
  335 +
  336 +SIP_SUPPORT = NO
  337 +
  338 +# For Microsoft's IDL there are propget and propput attributes to indicate
  339 +# getter and setter methods for a property. Setting this option to YES will make
  340 +# doxygen to replace the get and set methods by a property in the documentation.
  341 +# This will only work if the methods are indeed getting or setting a simple
  342 +# type. If this is not the case, or you want to show the methods anyway, you
  343 +# should set this option to NO.
  344 +# The default value is: YES.
  345 +
  346 +IDL_PROPERTY_SUPPORT = YES
  347 +
  348 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  349 +# tag is set to YES then doxygen will reuse the documentation of the first
  350 +# member in the group (if any) for the other members of the group. By default
  351 +# all members of a group must be documented explicitly.
  352 +# The default value is: NO.
  353 +
  354 +DISTRIBUTE_GROUP_DOC = NO
  355 +
  356 +# If one adds a struct or class to a group and this option is enabled, then also
  357 +# any nested class or struct is added to the same group. By default this option
  358 +# is disabled and one has to add nested compounds explicitly via \ingroup.
  359 +# The default value is: NO.
  360 +
  361 +GROUP_NESTED_COMPOUNDS = NO
  362 +
  363 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type
  364 +# (for instance a group of public functions) to be put as a subgroup of that
  365 +# type (e.g. under the Public Functions section). Set it to NO to prevent
  366 +# subgrouping. Alternatively, this can be done per class using the
  367 +# \nosubgrouping command.
  368 +# The default value is: YES.
  369 +
  370 +SUBGROUPING = YES
  371 +
  372 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  373 +# are shown inside the group in which they are included (e.g. using \ingroup)
  374 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  375 +# and RTF).
  376 +#
  377 +# Note that this feature does not work in combination with
  378 +# SEPARATE_MEMBER_PAGES.
  379 +# The default value is: NO.
  380 +
  381 +INLINE_GROUPED_CLASSES = NO
  382 +
  383 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  384 +# with only public data fields or simple typedef fields will be shown inline in
  385 +# the documentation of the scope in which they are defined (i.e. file,
  386 +# namespace, or group documentation), provided this scope is documented. If set
  387 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and
  388 +# Man pages) or section (for LaTeX and RTF).
  389 +# The default value is: NO.
  390 +
  391 +INLINE_SIMPLE_STRUCTS = NO
  392 +
  393 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  394 +# enum is documented as struct, union, or enum with the name of the typedef. So
  395 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  396 +# with name TypeT. When disabled the typedef will appear as a member of a file,
  397 +# namespace, or class. And the struct will be named TypeS. This can typically be
  398 +# useful for C code in case the coding convention dictates that all compound
  399 +# types are typedef'ed and only the typedef is referenced, never the tag name.
  400 +# The default value is: NO.
  401 +
  402 +TYPEDEF_HIDES_STRUCT = NO
  403 +
  404 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  405 +# cache is used to resolve symbols given their name and scope. Since this can be
  406 +# an expensive process and often the same symbol appears multiple times in the
  407 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  408 +# doxygen will become slower. If the cache is too large, memory is wasted. The
  409 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  410 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  411 +# symbols. At the end of a run doxygen will report the cache usage and suggest
  412 +# the optimal cache size from a speed point of view.
  413 +# Minimum value: 0, maximum value: 9, default value: 0.
  414 +
  415 +LOOKUP_CACHE_SIZE = 0
  416 +
  417 +#---------------------------------------------------------------------------
  418 +# Build related configuration options
  419 +#---------------------------------------------------------------------------
  420 +
  421 +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  422 +# documentation are documented, even if no documentation was available. Private
  423 +# class members and static file members will be hidden unless the
  424 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  425 +# Note: This will also disable the warnings about undocumented members that are
  426 +# normally produced when WARNINGS is set to YES.
  427 +# The default value is: NO.
  428 +
  429 +EXTRACT_ALL = NO
  430 +
  431 +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  432 +# be included in the documentation.
  433 +# The default value is: NO.
  434 +
  435 +EXTRACT_PRIVATE = NO
  436 +
  437 +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  438 +# scope will be included in the documentation.
  439 +# The default value is: NO.
  440 +
  441 +EXTRACT_PACKAGE = NO
  442 +
  443 +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  444 +# included in the documentation.
  445 +# The default value is: NO.
  446 +
  447 +EXTRACT_STATIC = NO
  448 +
  449 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  450 +# locally in source files will be included in the documentation. If set to NO,
  451 +# only classes defined in header files are included. Does not have any effect
  452 +# for Java sources.
  453 +# The default value is: YES.
  454 +
  455 +EXTRACT_LOCAL_CLASSES = YES
  456 +
  457 +# This flag is only useful for Objective-C code. If set to YES, local methods,
  458 +# which are defined in the implementation section but not in the interface are
  459 +# included in the documentation. If set to NO, only methods in the interface are
  460 +# included.
  461 +# The default value is: NO.
  462 +
  463 +EXTRACT_LOCAL_METHODS = NO
  464 +
  465 +# If this flag is set to YES, the members of anonymous namespaces will be
  466 +# extracted and appear in the documentation as a namespace called
  467 +# 'anonymous_namespace{file}', where file will be replaced with the base name of
  468 +# the file that contains the anonymous namespace. By default anonymous namespace
  469 +# are hidden.
  470 +# The default value is: NO.
  471 +
  472 +EXTRACT_ANON_NSPACES = NO
  473 +
  474 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  475 +# undocumented members inside documented classes or files. If set to NO these
  476 +# members will be included in the various overviews, but no documentation
  477 +# section is generated. This option has no effect if EXTRACT_ALL is enabled.
  478 +# The default value is: NO.
  479 +
  480 +HIDE_UNDOC_MEMBERS = NO
  481 +
  482 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  483 +# undocumented classes that are normally visible in the class hierarchy. If set
  484 +# to NO, these classes will be included in the various overviews. This option
  485 +# has no effect if EXTRACT_ALL is enabled.
  486 +# The default value is: NO.
  487 +
  488 +HIDE_UNDOC_CLASSES = NO
  489 +
  490 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  491 +# (class|struct|union) declarations. If set to NO, these declarations will be
  492 +# included in the documentation.
  493 +# The default value is: NO.
  494 +
  495 +HIDE_FRIEND_COMPOUNDS = NO
  496 +
  497 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  498 +# documentation blocks found inside the body of a function. If set to NO, these
  499 +# blocks will be appended to the function's detailed documentation block.
  500 +# The default value is: NO.
  501 +
  502 +HIDE_IN_BODY_DOCS = NO
  503 +
  504 +# The INTERNAL_DOCS tag determines if documentation that is typed after a
  505 +# \internal command is included. If the tag is set to NO then the documentation
  506 +# will be excluded. Set it to YES to include the internal documentation.
  507 +# The default value is: NO.
  508 +
  509 +INTERNAL_DOCS = NO
  510 +
  511 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  512 +# names in lower-case letters. If set to YES, upper-case letters are also
  513 +# allowed. This is useful if you have classes or files whose names only differ
  514 +# in case and if your file system supports case sensitive file names. Windows
  515 +# and Mac users are advised to set this option to NO.
  516 +# The default value is: system dependent.
  517 +
  518 +CASE_SENSE_NAMES = NO
  519 +
  520 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  521 +# their full class and namespace scopes in the documentation. If set to YES, the
  522 +# scope will be hidden.
  523 +# The default value is: NO.
  524 +
  525 +HIDE_SCOPE_NAMES = NO
  526 +
  527 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  528 +# append additional text to a page's title, such as Class Reference. If set to
  529 +# YES the compound reference will be hidden.
  530 +# The default value is: NO.
  531 +
  532 +HIDE_COMPOUND_REFERENCE= NO
  533 +
  534 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  535 +# the files that are included by a file in the documentation of that file.
  536 +# The default value is: YES.
  537 +
  538 +SHOW_INCLUDE_FILES = YES
  539 +
  540 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  541 +# grouped member an include statement to the documentation, telling the reader
  542 +# which file to include in order to use the member.
  543 +# The default value is: NO.
  544 +
  545 +SHOW_GROUPED_MEMB_INC = NO
  546 +
  547 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  548 +# files with double quotes in the documentation rather than with sharp brackets.
  549 +# The default value is: NO.
  550 +
  551 +FORCE_LOCAL_INCLUDES = NO
  552 +
  553 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  554 +# documentation for inline members.
  555 +# The default value is: YES.
  556 +
  557 +INLINE_INFO = YES
  558 +
  559 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  560 +# (detailed) documentation of file and class members alphabetically by member
  561 +# name. If set to NO, the members will appear in declaration order.
  562 +# The default value is: YES.
  563 +
  564 +SORT_MEMBER_DOCS = YES
  565 +
  566 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  567 +# descriptions of file, namespace and class members alphabetically by member
  568 +# name. If set to NO, the members will appear in declaration order. Note that
  569 +# this will also influence the order of the classes in the class list.
  570 +# The default value is: NO.
  571 +
  572 +SORT_BRIEF_DOCS = NO
  573 +
  574 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  575 +# (brief and detailed) documentation of class members so that constructors and
  576 +# destructors are listed first. If set to NO the constructors will appear in the
  577 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  578 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  579 +# member documentation.
  580 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  581 +# detailed member documentation.
  582 +# The default value is: NO.
  583 +
  584 +SORT_MEMBERS_CTORS_1ST = NO
  585 +
  586 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  587 +# of group names into alphabetical order. If set to NO the group names will
  588 +# appear in their defined order.
  589 +# The default value is: NO.
  590 +
  591 +SORT_GROUP_NAMES = NO
  592 +
  593 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  594 +# fully-qualified names, including namespaces. If set to NO, the class list will
  595 +# be sorted only by class name, not including the namespace part.
  596 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  597 +# Note: This option applies only to the class list, not to the alphabetical
  598 +# list.
  599 +# The default value is: NO.
  600 +
  601 +SORT_BY_SCOPE_NAME = NO
  602 +
  603 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  604 +# type resolution of all parameters of a function it will reject a match between
  605 +# the prototype and the implementation of a member function even if there is
  606 +# only one candidate or it is obvious which candidate to choose by doing a
  607 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  608 +# accept a match between prototype and implementation in such cases.
  609 +# The default value is: NO.
  610 +
  611 +STRICT_PROTO_MATCHING = NO
  612 +
  613 +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  614 +# list. This list is created by putting \todo commands in the documentation.
  615 +# The default value is: YES.
  616 +
  617 +GENERATE_TODOLIST = YES
  618 +
  619 +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  620 +# list. This list is created by putting \test commands in the documentation.
  621 +# The default value is: YES.
  622 +
  623 +GENERATE_TESTLIST = YES
  624 +
  625 +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  626 +# list. This list is created by putting \bug commands in the documentation.
  627 +# The default value is: YES.
  628 +
  629 +GENERATE_BUGLIST = YES
  630 +
  631 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  632 +# the deprecated list. This list is created by putting \deprecated commands in
  633 +# the documentation.
  634 +# The default value is: YES.
  635 +
  636 +GENERATE_DEPRECATEDLIST= YES
  637 +
  638 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation
  639 +# sections, marked by \if <section_label> ... \endif and \cond <section_label>
  640 +# ... \endcond blocks.
  641 +
  642 +ENABLED_SECTIONS =
  643 +
  644 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  645 +# initial value of a variable or macro / define can have for it to appear in the
  646 +# documentation. If the initializer consists of more lines than specified here
  647 +# it will be hidden. Use a value of 0 to hide initializers completely. The
  648 +# appearance of the value of individual variables and macros / defines can be
  649 +# controlled using \showinitializer or \hideinitializer command in the
  650 +# documentation regardless of this setting.
  651 +# Minimum value: 0, maximum value: 10000, default value: 30.
  652 +
  653 +MAX_INITIALIZER_LINES = 30
  654 +
  655 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  656 +# the bottom of the documentation of classes and structs. If set to YES, the
  657 +# list will mention the files that were used to generate the documentation.
  658 +# The default value is: YES.
  659 +
  660 +SHOW_USED_FILES = YES
  661 +
  662 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  663 +# will remove the Files entry from the Quick Index and from the Folder Tree View
  664 +# (if specified).
  665 +# The default value is: YES.
  666 +
  667 +SHOW_FILES = YES
  668 +
  669 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  670 +# page. This will remove the Namespaces entry from the Quick Index and from the
  671 +# Folder Tree View (if specified).
  672 +# The default value is: YES.
  673 +
  674 +SHOW_NAMESPACES = YES
  675 +
  676 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
  677 +# doxygen should invoke to get the current version for each file (typically from
  678 +# the version control system). Doxygen will invoke the program by executing (via
  679 +# popen()) the command command input-file, where command is the value of the
  680 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  681 +# by doxygen. Whatever the program writes to standard output is used as the file
  682 +# version. For an example see the documentation.
  683 +
  684 +FILE_VERSION_FILTER =
  685 +
  686 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  687 +# by doxygen. The layout file controls the global structure of the generated
  688 +# output files in an output format independent way. To create the layout file
  689 +# that represents doxygen's defaults, run doxygen with the -l option. You can
  690 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml
  691 +# will be used as the name of the layout file.
  692 +#
  693 +# Note that if you run doxygen from a directory containing a file called
  694 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  695 +# tag is left empty.
  696 +
  697 +LAYOUT_FILE =
  698 +
  699 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  700 +# the reference definitions. This must be a list of .bib files. The .bib
  701 +# extension is automatically appended if omitted. This requires the bibtex tool
  702 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  703 +# For LaTeX the style of the bibliography can be controlled using
  704 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  705 +# search path. See also \cite for info how to create references.
  706 +
  707 +CITE_BIB_FILES =
  708 +
  709 +#---------------------------------------------------------------------------
  710 +# Configuration options related to warning and progress messages
  711 +#---------------------------------------------------------------------------
  712 +
  713 +# The QUIET tag can be used to turn on/off the messages that are generated to
  714 +# standard output by doxygen. If QUIET is set to YES this implies that the
  715 +# messages are off.
  716 +# The default value is: NO.
  717 +
  718 +QUIET = NO
  719 +
  720 +# The WARNINGS tag can be used to turn on/off the warning messages that are
  721 +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  722 +# this implies that the warnings are on.
  723 +#
  724 +# Tip: Turn warnings on while writing the documentation.
  725 +# The default value is: YES.
  726 +
  727 +WARNINGS = YES
  728 +
  729 +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  730 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  731 +# will automatically be disabled.
  732 +# The default value is: YES.
  733 +
  734 +WARN_IF_UNDOCUMENTED = YES
  735 +
  736 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  737 +# potential errors in the documentation, such as not documenting some parameters
  738 +# in a documented function, or documenting parameters that don't exist or using
  739 +# markup commands wrongly.
  740 +# The default value is: YES.
  741 +
  742 +WARN_IF_DOC_ERROR = YES
  743 +
  744 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  745 +# are documented, but have no documentation for their parameters or return
  746 +# value. If set to NO, doxygen will only warn about wrong or incomplete
  747 +# parameter documentation, but not about the absence of documentation.
  748 +# The default value is: NO.
  749 +
  750 +WARN_NO_PARAMDOC = NO
  751 +
  752 +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
  753 +# a warning is encountered.
  754 +# The default value is: NO.
  755 +
  756 +WARN_AS_ERROR = NO
  757 +
  758 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen
  759 +# can produce. The string should contain the $file, $line, and $text tags, which
  760 +# will be replaced by the file and line number from which the warning originated
  761 +# and the warning text. Optionally the format may contain $version, which will
  762 +# be replaced by the version of the file (if it could be obtained via
  763 +# FILE_VERSION_FILTER)
  764 +# The default value is: $file:$line: $text.
  765 +
  766 +WARN_FORMAT = "$file:$line: $text"
  767 +
  768 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error
  769 +# messages should be written. If left blank the output is written to standard
  770 +# error (stderr).
  771 +
  772 +WARN_LOGFILE =
  773 +
  774 +#---------------------------------------------------------------------------
  775 +# Configuration options related to the input files
  776 +#---------------------------------------------------------------------------
  777 +
  778 +# The INPUT tag is used to specify the files and/or directories that contain
  779 +# documented source files. You may enter file names like myfile.cpp or
  780 +# directories like /usr/src/myproject. Separate the files or directories with
  781 +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
  782 +# Note: If this tag is empty the current directory is searched.
  783 +
  784 +INPUT = /home/leandro/workspaces/cpp/socket/src
  785 +
  786 +# This tag can be used to specify the character encoding of the source files
  787 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  788 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  789 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of
  790 +# possible encodings.
  791 +# The default value is: UTF-8.
  792 +
  793 +INPUT_ENCODING = UTF-8
  794 +
  795 +# If the value of the INPUT tag contains directories, you can use the
  796 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  797 +# *.h) to filter out the source-files in the directories.
  798 +#
  799 +# Note that for custom extensions or not directly supported extensions you also
  800 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
  801 +# read by doxygen.
  802 +#
  803 +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
  804 +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
  805 +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
  806 +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
  807 +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
  808 +
  809 +FILE_PATTERNS = *.c \
  810 + *.cc \
  811 + *.cxx \
  812 + *.cpp \
  813 + *.c++ \
  814 + *.java \
  815 + *.ii \
  816 + *.ixx \
  817 + *.ipp \
  818 + *.i++ \
  819 + *.inl \
  820 + *.idl \
  821 + *.ddl \
  822 + *.odl \
  823 + *.h \
  824 + *.hh \
  825 + *.hxx \
  826 + *.hpp \
  827 + *.h++ \
  828 + *.cs \
  829 + *.d \
  830 + *.php \
  831 + *.php4 \
  832 + *.php5 \
  833 + *.phtml \
  834 + *.inc \
  835 + *.m \
  836 + *.markdown \
  837 + *.md \
  838 + *.mm \
  839 + *.dox \
  840 + *.py \
  841 + *.pyw \
  842 + *.f90 \
  843 + *.f \
  844 + *.for \
  845 + *.tcl \
  846 + *.vhd \
  847 + *.vhdl \
  848 + *.ucf \
  849 + *.qsf \
  850 + *.as \
  851 + *.js
  852 +
  853 +# The RECURSIVE tag can be used to specify whether or not subdirectories should
  854 +# be searched for input files as well.
  855 +# The default value is: NO.
  856 +
  857 +RECURSIVE = YES
  858 +
  859 +# The EXCLUDE tag can be used to specify files and/or directories that should be
  860 +# excluded from the INPUT source files. This way you can easily exclude a
  861 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
  862 +#
  863 +# Note that relative paths are relative to the directory from which doxygen is
  864 +# run.
  865 +
  866 +EXCLUDE =
  867 +
  868 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  869 +# directories that are symbolic links (a Unix file system feature) are excluded
  870 +# from the input.
  871 +# The default value is: NO.
  872 +
  873 +EXCLUDE_SYMLINKS = NO
  874 +
  875 +# If the value of the INPUT tag contains directories, you can use the
  876 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  877 +# certain files from those directories.
  878 +#
  879 +# Note that the wildcards are matched against the file with absolute path, so to
  880 +# exclude all test directories for example use the pattern */test/*
  881 +
  882 +EXCLUDE_PATTERNS =
  883 +
  884 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  885 +# (namespaces, classes, functions, etc.) that should be excluded from the
  886 +# output. The symbol name can be a fully qualified name, a word, or if the
  887 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
  888 +# AClass::ANamespace, ANamespace::*Test
  889 +#
  890 +# Note that the wildcards are matched against the file with absolute path, so to
  891 +# exclude all test directories use the pattern */test/*
  892 +
  893 +EXCLUDE_SYMBOLS =
  894 +
  895 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories
  896 +# that contain example code fragments that are included (see the \include
  897 +# command).
  898 +
  899 +EXAMPLE_PATH =
  900 +
  901 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
  902 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  903 +# *.h) to filter out the source-files in the directories. If left blank all
  904 +# files are included.
  905 +
  906 +EXAMPLE_PATTERNS = *
  907 +
  908 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  909 +# searched for input files to be used with the \include or \dontinclude commands
  910 +# irrespective of the value of the RECURSIVE tag.
  911 +# The default value is: NO.
  912 +
  913 +EXAMPLE_RECURSIVE = NO
  914 +
  915 +# The IMAGE_PATH tag can be used to specify one or more files or directories
  916 +# that contain images that are to be included in the documentation (see the
  917 +# \image command).
  918 +
  919 +IMAGE_PATH =
  920 +
  921 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
  922 +# invoke to filter for each input file. Doxygen will invoke the filter program
  923 +# by executing (via popen()) the command:
  924 +#
  925 +# <filter> <input-file>
  926 +#
  927 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  928 +# name of an input file. Doxygen will then use the output that the filter
  929 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag
  930 +# will be ignored.
  931 +#
  932 +# Note that the filter must not add or remove lines; it is applied before the
  933 +# code is scanned, but not when the output code is generated. If lines are added
  934 +# or removed, the anchors will not be placed correctly.
  935 +#
  936 +# Note that for custom extensions or not directly supported extensions you also
  937 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
  938 +# properly processed by doxygen.
  939 +
  940 +INPUT_FILTER =
  941 +
  942 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  943 +# basis. Doxygen will compare the file name with each pattern and apply the
  944 +# filter if there is a match. The filters are a list of the form: pattern=filter
  945 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  946 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  947 +# patterns match the file name, INPUT_FILTER is applied.
  948 +#
  949 +# Note that for custom extensions or not directly supported extensions you also
  950 +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
  951 +# properly processed by doxygen.
  952 +
  953 +FILTER_PATTERNS =
  954 +
  955 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  956 +# INPUT_FILTER) will also be used to filter the input files that are used for
  957 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  958 +# The default value is: NO.
  959 +
  960 +FILTER_SOURCE_FILES = NO
  961 +
  962 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  963 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  964 +# it is also possible to disable source filtering for a specific pattern using
  965 +# *.ext= (so without naming a filter).
  966 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  967 +
  968 +FILTER_SOURCE_PATTERNS =
  969 +
  970 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  971 +# is part of the input, its contents will be placed on the main page
  972 +# (index.html). This can be useful if you have a project on for instance GitHub
  973 +# and want to reuse the introduction page also for the doxygen output.
  974 +
  975 +USE_MDFILE_AS_MAINPAGE =
  976 +
  977 +#---------------------------------------------------------------------------
  978 +# Configuration options related to source browsing
  979 +#---------------------------------------------------------------------------
  980 +
  981 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  982 +# generated. Documented entities will be cross-referenced with these sources.
  983 +#
  984 +# Note: To get rid of all source code in the generated output, make sure that
  985 +# also VERBATIM_HEADERS is set to NO.
  986 +# The default value is: NO.
  987 +
  988 +SOURCE_BROWSER = NO
  989 +
  990 +# Setting the INLINE_SOURCES tag to YES will include the body of functions,
  991 +# classes and enums directly into the documentation.
  992 +# The default value is: NO.
  993 +
  994 +INLINE_SOURCES = NO
  995 +
  996 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  997 +# special comment blocks from generated source code fragments. Normal C, C++ and
  998 +# Fortran comments will always remain visible.
  999 +# The default value is: YES.
  1000 +
  1001 +STRIP_CODE_COMMENTS = YES
  1002 +
  1003 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  1004 +# function all documented functions referencing it will be listed.
  1005 +# The default value is: NO.
  1006 +
  1007 +REFERENCED_BY_RELATION = NO
  1008 +
  1009 +# If the REFERENCES_RELATION tag is set to YES then for each documented function
  1010 +# all documented entities called/used by that function will be listed.
  1011 +# The default value is: NO.
  1012 +
  1013 +REFERENCES_RELATION = NO
  1014 +
  1015 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  1016 +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
  1017 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  1018 +# link to the documentation.
  1019 +# The default value is: YES.
  1020 +
  1021 +REFERENCES_LINK_SOURCE = YES
  1022 +
  1023 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  1024 +# source code will show a tooltip with additional information such as prototype,
  1025 +# brief description and links to the definition and documentation. Since this
  1026 +# will make the HTML file larger and loading of large files a bit slower, you
  1027 +# can opt to disable this feature.
  1028 +# The default value is: YES.
  1029 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
  1030 +
  1031 +SOURCE_TOOLTIPS = YES
  1032 +
  1033 +# If the USE_HTAGS tag is set to YES then the references to source code will
  1034 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in
  1035 +# source browser. The htags tool is part of GNU's global source tagging system
  1036 +# (see http://www.gnu.org/software/global/global.html). You will need version
  1037 +# 4.8.6 or higher.
  1038 +#
  1039 +# To use it do the following:
  1040 +# - Install the latest version of global
  1041 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  1042 +# - Make sure the INPUT points to the root of the source tree
  1043 +# - Run doxygen as normal
  1044 +#
  1045 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these
  1046 +# tools must be available from the command line (i.e. in the search path).
  1047 +#
  1048 +# The result: instead of the source browser generated by doxygen, the links to
  1049 +# source code will now point to the output of htags.
  1050 +# The default value is: NO.
  1051 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
  1052 +
  1053 +USE_HTAGS = NO
  1054 +
  1055 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  1056 +# verbatim copy of the header file for each class for which an include is
  1057 +# specified. Set to NO to disable this.
  1058 +# See also: Section \class.
  1059 +# The default value is: YES.
  1060 +
  1061 +VERBATIM_HEADERS = YES
  1062 +
  1063 +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  1064 +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
  1065 +# cost of reduced performance. This can be particularly helpful with template
  1066 +# rich C++ code for which doxygen's built-in parser lacks the necessary type
  1067 +# information.
  1068 +# Note: The availability of this option depends on whether or not doxygen was
  1069 +# generated with the -Duse-libclang=ON option for CMake.
  1070 +# The default value is: NO.
  1071 +
  1072 +CLANG_ASSISTED_PARSING = NO
  1073 +
  1074 +# If clang assisted parsing is enabled you can provide the compiler with command
  1075 +# line options that you would normally use when invoking the compiler. Note that
  1076 +# the include paths will already be set by doxygen for the files and directories
  1077 +# specified with INPUT and INCLUDE_PATH.
  1078 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  1079 +
  1080 +CLANG_OPTIONS =
  1081 +
  1082 +#---------------------------------------------------------------------------
  1083 +# Configuration options related to the alphabetical class index
  1084 +#---------------------------------------------------------------------------
  1085 +
  1086 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  1087 +# compounds will be generated. Enable this if the project contains a lot of
  1088 +# classes, structs, unions or interfaces.
  1089 +# The default value is: YES.
  1090 +
  1091 +ALPHABETICAL_INDEX = YES
  1092 +
  1093 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  1094 +# which the alphabetical index list will be split.
  1095 +# Minimum value: 1, maximum value: 20, default value: 5.
  1096 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  1097 +
  1098 +COLS_IN_ALPHA_INDEX = 5
  1099 +
  1100 +# In case all classes in a project start with a common prefix, all classes will
  1101 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  1102 +# can be used to specify a prefix (or a list of prefixes) that should be ignored
  1103 +# while generating the index headers.
  1104 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  1105 +
  1106 +IGNORE_PREFIX =
  1107 +
  1108 +#---------------------------------------------------------------------------
  1109 +# Configuration options related to the HTML output
  1110 +#---------------------------------------------------------------------------
  1111 +
  1112 +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  1113 +# The default value is: YES.
  1114 +
  1115 +GENERATE_HTML = YES
  1116 +
  1117 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  1118 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1119 +# it.
  1120 +# The default directory is: html.
  1121 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1122 +
  1123 +HTML_OUTPUT = html
  1124 +
  1125 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  1126 +# generated HTML page (for example: .htm, .php, .asp).
  1127 +# The default value is: .html.
  1128 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1129 +
  1130 +HTML_FILE_EXTENSION = .html
  1131 +
  1132 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  1133 +# each generated HTML page. If the tag is left blank doxygen will generate a
  1134 +# standard header.
  1135 +#
  1136 +# To get valid HTML the header file that includes any scripts and style sheets
  1137 +# that doxygen needs, which is dependent on the configuration options used (e.g.
  1138 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  1139 +# default header using
  1140 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css
  1141 +# YourConfigFile
  1142 +# and then modify the file new_header.html. See also section "Doxygen usage"
  1143 +# for information on how to generate the default header that doxygen normally
  1144 +# uses.
  1145 +# Note: The header is subject to change so you typically have to regenerate the
  1146 +# default header when upgrading to a newer version of doxygen. For a description
  1147 +# of the possible markers and block names see the documentation.
  1148 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1149 +
  1150 +HTML_HEADER =
  1151 +
  1152 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  1153 +# generated HTML page. If the tag is left blank doxygen will generate a standard
  1154 +# footer. See HTML_HEADER for more information on how to generate a default
  1155 +# footer and what special commands can be used inside the footer. See also
  1156 +# section "Doxygen usage" for information on how to generate the default footer
  1157 +# that doxygen normally uses.
  1158 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1159 +
  1160 +HTML_FOOTER =
  1161 +
  1162 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  1163 +# sheet that is used by each HTML page. It can be used to fine-tune the look of
  1164 +# the HTML output. If left blank doxygen will generate a default style sheet.
  1165 +# See also section "Doxygen usage" for information on how to generate the style
  1166 +# sheet that doxygen normally uses.
  1167 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  1168 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become
  1169 +# obsolete.
  1170 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1171 +
  1172 +HTML_STYLESHEET =
  1173 +
  1174 +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1175 +# cascading style sheets that are included after the standard style sheets
  1176 +# created by doxygen. Using this option one can overrule certain style aspects.
  1177 +# This is preferred over using HTML_STYLESHEET since it does not replace the
  1178 +# standard style sheet and is therefore more robust against future updates.
  1179 +# Doxygen will copy the style sheet files to the output directory.
  1180 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1181 +# style sheet in the list overrules the setting of the previous ones in the
  1182 +# list). For an example see the documentation.
  1183 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1184 +
  1185 +HTML_EXTRA_STYLESHEET =
  1186 +
  1187 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  1188 +# other source files which should be copied to the HTML output directory. Note
  1189 +# that these files will be copied to the base HTML output directory. Use the
  1190 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  1191 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  1192 +# files will be copied as-is; there are no commands or markers available.
  1193 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1194 +
  1195 +HTML_EXTRA_FILES =
  1196 +
  1197 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  1198 +# will adjust the colors in the style sheet and background images according to
  1199 +# this color. Hue is specified as an angle on a colorwheel, see
  1200 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  1201 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  1202 +# purple, and 360 is red again.
  1203 +# Minimum value: 0, maximum value: 359, default value: 220.
  1204 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1205 +
  1206 +HTML_COLORSTYLE_HUE = 220
  1207 +
  1208 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  1209 +# in the HTML output. For a value of 0 the output will use grayscales only. A
  1210 +# value of 255 will produce the most vivid colors.
  1211 +# Minimum value: 0, maximum value: 255, default value: 100.
  1212 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1213 +
  1214 +HTML_COLORSTYLE_SAT = 100
  1215 +
  1216 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  1217 +# luminance component of the colors in the HTML output. Values below 100
  1218 +# gradually make the output lighter, whereas values above 100 make the output
  1219 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents
  1220 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  1221 +# change the gamma.
  1222 +# Minimum value: 40, maximum value: 240, default value: 80.
  1223 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1224 +
  1225 +HTML_COLORSTYLE_GAMMA = 80
  1226 +
  1227 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  1228 +# page will contain the date and time when the page was generated. Setting this
  1229 +# to YES can help to show when doxygen was last run and thus if the
  1230 +# documentation is up to date.
  1231 +# The default value is: NO.
  1232 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1233 +
  1234 +HTML_TIMESTAMP = NO
  1235 +
  1236 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  1237 +# documentation will contain sections that can be hidden and shown after the
  1238 +# page has loaded.
  1239 +# The default value is: NO.
  1240 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1241 +
  1242 +HTML_DYNAMIC_SECTIONS = NO
  1243 +
  1244 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1245 +# shown in the various tree structured indices initially; the user can expand
  1246 +# and collapse entries dynamically later on. Doxygen will expand the tree to
  1247 +# such a level that at most the specified number of entries are visible (unless
  1248 +# a fully collapsed tree already exceeds this amount). So setting the number of
  1249 +# entries 1 will produce a full collapsed tree by default. 0 is a special value
  1250 +# representing an infinite number of entries and will result in a full expanded
  1251 +# tree by default.
  1252 +# Minimum value: 0, maximum value: 9999, default value: 100.
  1253 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1254 +
  1255 +HTML_INDEX_NUM_ENTRIES = 100
  1256 +
  1257 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1258 +# generated that can be used as input for Apple's Xcode 3 integrated development
  1259 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with
  1260 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  1261 +# Makefile in the HTML output directory. Running make will produce the docset in
  1262 +# that directory and running make install will install the docset in
  1263 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1264 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  1265 +# for more information.
  1266 +# The default value is: NO.
  1267 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1268 +
  1269 +GENERATE_DOCSET = NO
  1270 +
  1271 +# This tag determines the name of the docset feed. A documentation feed provides
  1272 +# an umbrella under which multiple documentation sets from a single provider
  1273 +# (such as a company or product suite) can be grouped.
  1274 +# The default value is: Doxygen generated docs.
  1275 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1276 +
  1277 +DOCSET_FEEDNAME = "Doxygen generated docs"
  1278 +
  1279 +# This tag specifies a string that should uniquely identify the documentation
  1280 +# set bundle. This should be a reverse domain-name style string, e.g.
  1281 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1282 +# The default value is: org.doxygen.Project.
  1283 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1284 +
  1285 +DOCSET_BUNDLE_ID = org.doxygen.Project
  1286 +
  1287 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1288 +# the documentation publisher. This should be a reverse domain-name style
  1289 +# string, e.g. com.mycompany.MyDocSet.documentation.
  1290 +# The default value is: org.doxygen.Publisher.
  1291 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1292 +
  1293 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  1294 +
  1295 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1296 +# The default value is: Publisher.
  1297 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1298 +
  1299 +DOCSET_PUBLISHER_NAME = Publisher
  1300 +
  1301 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1302 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1303 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1304 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1305 +# Windows.
  1306 +#
  1307 +# The HTML Help Workshop contains a compiler that can convert all HTML output
  1308 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1309 +# files are now used as the Windows 98 help format, and will replace the old
  1310 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1311 +# HTML files also contain an index, a table of contents, and you can search for
  1312 +# words in the documentation. The HTML workshop also contains a viewer for
  1313 +# compressed HTML files.
  1314 +# The default value is: NO.
  1315 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1316 +
  1317 +GENERATE_HTMLHELP = NO
  1318 +
  1319 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1320 +# file. You can add a path in front of the file if the result should not be
  1321 +# written to the html output directory.
  1322 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1323 +
  1324 +CHM_FILE =
  1325 +
  1326 +# The HHC_LOCATION tag can be used to specify the location (absolute path
  1327 +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1328 +# doxygen will try to run the HTML help compiler on the generated index.hhp.
  1329 +# The file has to be specified with full path.
  1330 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1331 +
  1332 +HHC_LOCATION =
  1333 +
  1334 +# The GENERATE_CHI flag controls if a separate .chi index file is generated
  1335 +# (YES) or that it should be included in the master .chm file (NO).
  1336 +# The default value is: NO.
  1337 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1338 +
  1339 +GENERATE_CHI = NO
  1340 +
  1341 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1342 +# and project file content.
  1343 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1344 +
  1345 +CHM_INDEX_ENCODING =
  1346 +
  1347 +# The BINARY_TOC flag controls whether a binary table of contents is generated
  1348 +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1349 +# enables the Previous and Next buttons.
  1350 +# The default value is: NO.
  1351 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1352 +
  1353 +BINARY_TOC = NO
  1354 +
  1355 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1356 +# the table of contents of the HTML help documentation and to the tree view.
  1357 +# The default value is: NO.
  1358 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1359 +
  1360 +TOC_EXPAND = NO
  1361 +
  1362 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1363 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1364 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1365 +# (.qch) of the generated HTML documentation.
  1366 +# The default value is: NO.
  1367 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1368 +
  1369 +GENERATE_QHP = NO
  1370 +
  1371 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1372 +# the file name of the resulting .qch file. The path specified is relative to
  1373 +# the HTML output folder.
  1374 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1375 +
  1376 +QCH_FILE =
  1377 +
  1378 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1379 +# Project output. For more information please see Qt Help Project / Namespace
  1380 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1381 +# The default value is: org.doxygen.Project.
  1382 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1383 +
  1384 +QHP_NAMESPACE = org.doxygen.Project
  1385 +
  1386 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1387 +# Help Project output. For more information please see Qt Help Project / Virtual
  1388 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1389 +# folders).
  1390 +# The default value is: doc.
  1391 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1392 +
  1393 +QHP_VIRTUAL_FOLDER = doc
  1394 +
  1395 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1396 +# filter to add. For more information please see Qt Help Project / Custom
  1397 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1398 +# filters).
  1399 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1400 +
  1401 +QHP_CUST_FILTER_NAME =
  1402 +
  1403 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1404 +# custom filter to add. For more information please see Qt Help Project / Custom
  1405 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1406 +# filters).
  1407 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1408 +
  1409 +QHP_CUST_FILTER_ATTRS =
  1410 +
  1411 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1412 +# project's filter section matches. Qt Help Project / Filter Attributes (see:
  1413 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1414 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1415 +
  1416 +QHP_SECT_FILTER_ATTRS =
  1417 +
  1418 +# The QHG_LOCATION tag can be used to specify the location of Qt's
  1419 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1420 +# generated .qhp file.
  1421 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1422 +
  1423 +QHG_LOCATION =
  1424 +
  1425 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1426 +# generated, together with the HTML files, they form an Eclipse help plugin. To
  1427 +# install this plugin and make it available under the help contents menu in
  1428 +# Eclipse, the contents of the directory containing the HTML and XML files needs
  1429 +# to be copied into the plugins directory of eclipse. The name of the directory
  1430 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1431 +# After copying Eclipse needs to be restarted before the help appears.
  1432 +# The default value is: NO.
  1433 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1434 +
  1435 +GENERATE_ECLIPSEHELP = NO
  1436 +
  1437 +# A unique identifier for the Eclipse help plugin. When installing the plugin
  1438 +# the directory name containing the HTML and XML files should also have this
  1439 +# name. Each documentation set should have its own identifier.
  1440 +# The default value is: org.doxygen.Project.
  1441 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1442 +
  1443 +ECLIPSE_DOC_ID = org.doxygen.Project
  1444 +
  1445 +# If you want full control over the layout of the generated HTML pages it might
  1446 +# be necessary to disable the index and replace it with your own. The
  1447 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1448 +# of each HTML page. A value of NO enables the index and the value YES disables
  1449 +# it. Since the tabs in the index contain the same information as the navigation
  1450 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1451 +# The default value is: NO.
  1452 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1453 +
  1454 +DISABLE_INDEX = NO
  1455 +
  1456 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1457 +# structure should be generated to display hierarchical information. If the tag
  1458 +# value is set to YES, a side panel will be generated containing a tree-like
  1459 +# index structure (just like the one that is generated for HTML Help). For this
  1460 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1461 +# (i.e. any modern browser). Windows users are probably better off using the
  1462 +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1463 +# further fine-tune the look of the index. As an example, the default style
  1464 +# sheet generated by doxygen has an example that shows how to put an image at
  1465 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1466 +# the same information as the tab index, you could consider setting
  1467 +# DISABLE_INDEX to YES when enabling this option.
  1468 +# The default value is: NO.
  1469 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1470 +
  1471 +GENERATE_TREEVIEW = NO
  1472 +
  1473 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1474 +# doxygen will group on one line in the generated HTML documentation.
  1475 +#
  1476 +# Note that a value of 0 will completely suppress the enum values from appearing
  1477 +# in the overview section.
  1478 +# Minimum value: 0, maximum value: 20, default value: 4.
  1479 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1480 +
  1481 +ENUM_VALUES_PER_LINE = 4
  1482 +
  1483 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1484 +# to set the initial width (in pixels) of the frame in which the tree is shown.
  1485 +# Minimum value: 0, maximum value: 1500, default value: 250.
  1486 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1487 +
  1488 +TREEVIEW_WIDTH = 250
  1489 +
  1490 +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1491 +# external symbols imported via tag files in a separate window.
  1492 +# The default value is: NO.
  1493 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1494 +
  1495 +EXT_LINKS_IN_WINDOW = NO
  1496 +
  1497 +# Use this tag to change the font size of LaTeX formulas included as images in
  1498 +# the HTML documentation. When you change the font size after a successful
  1499 +# doxygen run you need to manually remove any form_*.png images from the HTML
  1500 +# output directory to force them to be regenerated.
  1501 +# Minimum value: 8, maximum value: 50, default value: 10.
  1502 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1503 +
  1504 +FORMULA_FONTSIZE = 10
  1505 +
  1506 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1507 +# generated for formulas are transparent PNGs. Transparent PNGs are not
  1508 +# supported properly for IE 6.0, but are supported on all modern browsers.
  1509 +#
  1510 +# Note that when changing this option you need to delete any form_*.png files in
  1511 +# the HTML output directory before the changes have effect.
  1512 +# The default value is: YES.
  1513 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1514 +
  1515 +FORMULA_TRANSPARENT = YES
  1516 +
  1517 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1518 +# http://www.mathjax.org) which uses client side Javascript for the rendering
  1519 +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1520 +# installed or if you want to formulas look prettier in the HTML output. When
  1521 +# enabled you may also need to install MathJax separately and configure the path
  1522 +# to it using the MATHJAX_RELPATH option.
  1523 +# The default value is: NO.
  1524 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1525 +
  1526 +USE_MATHJAX = NO
  1527 +
  1528 +# When MathJax is enabled you can set the default output format to be used for
  1529 +# the MathJax output. See the MathJax site (see:
  1530 +# http://docs.mathjax.org/en/latest/output.html) for more details.
  1531 +# Possible values are: HTML-CSS (which is slower, but has the best
  1532 +# compatibility), NativeMML (i.e. MathML) and SVG.
  1533 +# The default value is: HTML-CSS.
  1534 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1535 +
  1536 +MATHJAX_FORMAT = HTML-CSS
  1537 +
  1538 +# When MathJax is enabled you need to specify the location relative to the HTML
  1539 +# output directory using the MATHJAX_RELPATH option. The destination directory
  1540 +# should contain the MathJax.js script. For instance, if the mathjax directory
  1541 +# is located at the same level as the HTML output directory, then
  1542 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1543 +# Content Delivery Network so you can quickly see the result without installing
  1544 +# MathJax. However, it is strongly recommended to install a local copy of
  1545 +# MathJax from http://www.mathjax.org before deployment.
  1546 +# The default value is: http://cdn.mathjax.org/mathjax/latest.
  1547 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1548 +
  1549 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1550 +
  1551 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1552 +# extension names that should be enabled during MathJax rendering. For example
  1553 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1554 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1555 +
  1556 +MATHJAX_EXTENSIONS =
  1557 +
  1558 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1559 +# of code that will be used on startup of the MathJax code. See the MathJax site
  1560 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1561 +# example see the documentation.
  1562 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1563 +
  1564 +MATHJAX_CODEFILE =
  1565 +
  1566 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1567 +# the HTML output. The underlying search engine uses javascript and DHTML and
  1568 +# should work on any modern browser. Note that when using HTML help
  1569 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1570 +# there is already a search function so this one should typically be disabled.
  1571 +# For large projects the javascript based search engine can be slow, then
  1572 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1573 +# search using the keyboard; to jump to the search box use <access key> + S
  1574 +# (what the <access key> is depends on the OS and browser, but it is typically
  1575 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1576 +# key> to jump into the search results window, the results can be navigated
  1577 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1578 +# the search. The filter options can be selected when the cursor is inside the
  1579 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1580 +# to select a filter and <Enter> or <escape> to activate or cancel the filter
  1581 +# option.
  1582 +# The default value is: YES.
  1583 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1584 +
  1585 +SEARCHENGINE = YES
  1586 +
  1587 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1588 +# implemented using a web server instead of a web client using Javascript. There
  1589 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1590 +# setting. When disabled, doxygen will generate a PHP script for searching and
  1591 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1592 +# and searching needs to be provided by external tools. See the section
  1593 +# "External Indexing and Searching" for details.
  1594 +# The default value is: NO.
  1595 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1596 +
  1597 +SERVER_BASED_SEARCH = NO
  1598 +
  1599 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1600 +# script for searching. Instead the search results are written to an XML file
  1601 +# which needs to be processed by an external indexer. Doxygen will invoke an
  1602 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1603 +# search results.
  1604 +#
  1605 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1606 +# (doxysearch.cgi) which are based on the open source search engine library
  1607 +# Xapian (see: http://xapian.org/).
  1608 +#
  1609 +# See the section "External Indexing and Searching" for details.
  1610 +# The default value is: NO.
  1611 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1612 +
  1613 +EXTERNAL_SEARCH = NO
  1614 +
  1615 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1616 +# which will return the search results when EXTERNAL_SEARCH is enabled.
  1617 +#
  1618 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1619 +# (doxysearch.cgi) which are based on the open source search engine library
  1620 +# Xapian (see: http://xapian.org/). See the section "External Indexing and
  1621 +# Searching" for details.
  1622 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1623 +
  1624 +SEARCHENGINE_URL =
  1625 +
  1626 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1627 +# search data is written to a file for indexing by an external tool. With the
  1628 +# SEARCHDATA_FILE tag the name of this file can be specified.
  1629 +# The default file is: searchdata.xml.
  1630 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1631 +
  1632 +SEARCHDATA_FILE = searchdata.xml
  1633 +
  1634 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1635 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1636 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1637 +# projects and redirect the results back to the right project.
  1638 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1639 +
  1640 +EXTERNAL_SEARCH_ID =
  1641 +
  1642 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1643 +# projects other than the one defined by this configuration file, but that are
  1644 +# all added to the same external search index. Each project needs to have a
  1645 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1646 +# to a relative location where the documentation can be found. The format is:
  1647 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1648 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1649 +
  1650 +EXTRA_SEARCH_MAPPINGS =
  1651 +
  1652 +#---------------------------------------------------------------------------
  1653 +# Configuration options related to the LaTeX output
  1654 +#---------------------------------------------------------------------------
  1655 +
  1656 +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1657 +# The default value is: YES.
  1658 +
  1659 +GENERATE_LATEX = YES
  1660 +
  1661 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1662 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1663 +# it.
  1664 +# The default directory is: latex.
  1665 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1666 +
  1667 +LATEX_OUTPUT = latex
  1668 +
  1669 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1670 +# invoked.
  1671 +#
  1672 +# Note that when enabling USE_PDFLATEX this option is only used for generating
  1673 +# bitmaps for formulas in the HTML output, but not in the Makefile that is
  1674 +# written to the output directory.
  1675 +# The default file is: latex.
  1676 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1677 +
  1678 +LATEX_CMD_NAME = latex
  1679 +
  1680 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1681 +# index for LaTeX.
  1682 +# The default file is: makeindex.
  1683 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1684 +
  1685 +MAKEINDEX_CMD_NAME = makeindex
  1686 +
  1687 +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1688 +# documents. This may be useful for small projects and may help to save some
  1689 +# trees in general.
  1690 +# The default value is: NO.
  1691 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1692 +
  1693 +COMPACT_LATEX = NO
  1694 +
  1695 +# The PAPER_TYPE tag can be used to set the paper type that is used by the
  1696 +# printer.
  1697 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1698 +# 14 inches) and executive (7.25 x 10.5 inches).
  1699 +# The default value is: a4.
  1700 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1701 +
  1702 +PAPER_TYPE = a4
  1703 +
  1704 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1705 +# that should be included in the LaTeX output. The package can be specified just
  1706 +# by its name or with the correct syntax as to be used with the LaTeX
  1707 +# \usepackage command. To get the times font for instance you can specify :
  1708 +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  1709 +# To use the option intlimits with the amsmath package you can specify:
  1710 +# EXTRA_PACKAGES=[intlimits]{amsmath}
  1711 +# If left blank no extra packages will be included.
  1712 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1713 +
  1714 +EXTRA_PACKAGES =
  1715 +
  1716 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1717 +# generated LaTeX document. The header should contain everything until the first
  1718 +# chapter. If it is left blank doxygen will generate a standard header. See
  1719 +# section "Doxygen usage" for information on how to let doxygen write the
  1720 +# default header to a separate file.
  1721 +#
  1722 +# Note: Only use a user-defined header if you know what you are doing! The
  1723 +# following commands have a special meaning inside the header: $title,
  1724 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1725 +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1726 +# string, for the replacement values of the other commands the user is referred
  1727 +# to HTML_HEADER.
  1728 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1729 +
  1730 +LATEX_HEADER =
  1731 +
  1732 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1733 +# generated LaTeX document. The footer should contain everything after the last
  1734 +# chapter. If it is left blank doxygen will generate a standard footer. See
  1735 +# LATEX_HEADER for more information on how to generate a default footer and what
  1736 +# special commands can be used inside the footer.
  1737 +#
  1738 +# Note: Only use a user-defined footer if you know what you are doing!
  1739 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1740 +
  1741 +LATEX_FOOTER =
  1742 +
  1743 +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1744 +# LaTeX style sheets that are included after the standard style sheets created
  1745 +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1746 +# will copy the style sheet files to the output directory.
  1747 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1748 +# style sheet in the list overrules the setting of the previous ones in the
  1749 +# list).
  1750 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1751 +
  1752 +LATEX_EXTRA_STYLESHEET =
  1753 +
  1754 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1755 +# other source files which should be copied to the LATEX_OUTPUT output
  1756 +# directory. Note that the files will be copied as-is; there are no commands or
  1757 +# markers available.
  1758 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1759 +
  1760 +LATEX_EXTRA_FILES =
  1761 +
  1762 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1763 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1764 +# contain links (just like the HTML output) instead of page references. This
  1765 +# makes the output suitable for online browsing using a PDF viewer.
  1766 +# The default value is: YES.
  1767 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1768 +
  1769 +PDF_HYPERLINKS = YES
  1770 +
  1771 +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1772 +# the PDF file directly from the LaTeX files. Set this option to YES, to get a
  1773 +# higher quality PDF documentation.
  1774 +# The default value is: YES.
  1775 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1776 +
  1777 +USE_PDFLATEX = YES
  1778 +
  1779 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1780 +# command to the generated LaTeX files. This will instruct LaTeX to keep running
  1781 +# if errors occur, instead of asking the user for help. This option is also used
  1782 +# when generating formulas in HTML.
  1783 +# The default value is: NO.
  1784 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1785 +
  1786 +LATEX_BATCHMODE = NO
  1787 +
  1788 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1789 +# index chapters (such as File Index, Compound Index, etc.) in the output.
  1790 +# The default value is: NO.
  1791 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1792 +
  1793 +LATEX_HIDE_INDICES = NO
  1794 +
  1795 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1796 +# code with syntax highlighting in the LaTeX output.
  1797 +#
  1798 +# Note that which sources are shown also depends on other settings such as
  1799 +# SOURCE_BROWSER.
  1800 +# The default value is: NO.
  1801 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1802 +
  1803 +LATEX_SOURCE_CODE = NO
  1804 +
  1805 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1806 +# bibliography, e.g. plainnat, or ieeetr. See
  1807 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1808 +# The default value is: plain.
  1809 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1810 +
  1811 +LATEX_BIB_STYLE = plain
  1812 +
  1813 +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  1814 +# page will contain the date and time when the page was generated. Setting this
  1815 +# to NO can help when comparing the output of multiple runs.
  1816 +# The default value is: NO.
  1817 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1818 +
  1819 +LATEX_TIMESTAMP = NO
  1820 +
  1821 +#---------------------------------------------------------------------------
  1822 +# Configuration options related to the RTF output
  1823 +#---------------------------------------------------------------------------
  1824 +
  1825 +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1826 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1827 +# readers/editors.
  1828 +# The default value is: NO.
  1829 +
  1830 +GENERATE_RTF = NO
  1831 +
  1832 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1833 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1834 +# it.
  1835 +# The default directory is: rtf.
  1836 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1837 +
  1838 +RTF_OUTPUT = rtf
  1839 +
  1840 +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1841 +# documents. This may be useful for small projects and may help to save some
  1842 +# trees in general.
  1843 +# The default value is: NO.
  1844 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1845 +
  1846 +COMPACT_RTF = NO
  1847 +
  1848 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1849 +# contain hyperlink fields. The RTF file will contain links (just like the HTML
  1850 +# output) instead of page references. This makes the output suitable for online
  1851 +# browsing using Word or some other Word compatible readers that support those
  1852 +# fields.
  1853 +#
  1854 +# Note: WordPad (write) and others do not support links.
  1855 +# The default value is: NO.
  1856 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1857 +
  1858 +RTF_HYPERLINKS = NO
  1859 +
  1860 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1861 +# file, i.e. a series of assignments. You only have to provide replacements,
  1862 +# missing definitions are set to their default value.
  1863 +#
  1864 +# See also section "Doxygen usage" for information on how to generate the
  1865 +# default style sheet that doxygen normally uses.
  1866 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1867 +
  1868 +RTF_STYLESHEET_FILE =
  1869 +
  1870 +# Set optional variables used in the generation of an RTF document. Syntax is
  1871 +# similar to doxygen's config file. A template extensions file can be generated
  1872 +# using doxygen -e rtf extensionFile.
  1873 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1874 +
  1875 +RTF_EXTENSIONS_FILE =
  1876 +
  1877 +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1878 +# with syntax highlighting in the RTF output.
  1879 +#
  1880 +# Note that which sources are shown also depends on other settings such as
  1881 +# SOURCE_BROWSER.
  1882 +# The default value is: NO.
  1883 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1884 +
  1885 +RTF_SOURCE_CODE = NO
  1886 +
  1887 +#---------------------------------------------------------------------------
  1888 +# Configuration options related to the man page output
  1889 +#---------------------------------------------------------------------------
  1890 +
  1891 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1892 +# classes and files.
  1893 +# The default value is: NO.
  1894 +
  1895 +GENERATE_MAN = NO
  1896 +
  1897 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1898 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1899 +# it. A directory man3 will be created inside the directory specified by
  1900 +# MAN_OUTPUT.
  1901 +# The default directory is: man.
  1902 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1903 +
  1904 +MAN_OUTPUT = man
  1905 +
  1906 +# The MAN_EXTENSION tag determines the extension that is added to the generated
  1907 +# man pages. In case the manual section does not start with a number, the number
  1908 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1909 +# optional.
  1910 +# The default value is: .3.
  1911 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1912 +
  1913 +MAN_EXTENSION = .3
  1914 +
  1915 +# The MAN_SUBDIR tag determines the name of the directory created within
  1916 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1917 +# MAN_EXTENSION with the initial . removed.
  1918 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1919 +
  1920 +MAN_SUBDIR =
  1921 +
  1922 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1923 +# will generate one additional man file for each entity documented in the real
  1924 +# man page(s). These additional files only source the real man page, but without
  1925 +# them the man command would be unable to find the correct page.
  1926 +# The default value is: NO.
  1927 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1928 +
  1929 +MAN_LINKS = NO
  1930 +
  1931 +#---------------------------------------------------------------------------
  1932 +# Configuration options related to the XML output
  1933 +#---------------------------------------------------------------------------
  1934 +
  1935 +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1936 +# captures the structure of the code including all documentation.
  1937 +# The default value is: NO.
  1938 +
  1939 +GENERATE_XML = NO
  1940 +
  1941 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1942 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1943 +# it.
  1944 +# The default directory is: xml.
  1945 +# This tag requires that the tag GENERATE_XML is set to YES.
  1946 +
  1947 +XML_OUTPUT = xml
  1948 +
  1949 +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1950 +# listings (including syntax highlighting and cross-referencing information) to
  1951 +# the XML output. Note that enabling this will significantly increase the size
  1952 +# of the XML output.
  1953 +# The default value is: YES.
  1954 +# This tag requires that the tag GENERATE_XML is set to YES.
  1955 +
  1956 +XML_PROGRAMLISTING = YES
  1957 +
  1958 +#---------------------------------------------------------------------------
  1959 +# Configuration options related to the DOCBOOK output
  1960 +#---------------------------------------------------------------------------
  1961 +
  1962 +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1963 +# that can be used to generate PDF.
  1964 +# The default value is: NO.
  1965 +
  1966 +GENERATE_DOCBOOK = NO
  1967 +
  1968 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1969 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1970 +# front of it.
  1971 +# The default directory is: docbook.
  1972 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1973 +
  1974 +DOCBOOK_OUTPUT = docbook
  1975 +
  1976 +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1977 +# program listings (including syntax highlighting and cross-referencing
  1978 +# information) to the DOCBOOK output. Note that enabling this will significantly
  1979 +# increase the size of the DOCBOOK output.
  1980 +# The default value is: NO.
  1981 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1982 +
  1983 +DOCBOOK_PROGRAMLISTING = NO
  1984 +
  1985 +#---------------------------------------------------------------------------
  1986 +# Configuration options for the AutoGen Definitions output
  1987 +#---------------------------------------------------------------------------
  1988 +
  1989 +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1990 +# AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1991 +# structure of the code including all documentation. Note that this feature is
  1992 +# still experimental and incomplete at the moment.
  1993 +# The default value is: NO.
  1994 +
  1995 +GENERATE_AUTOGEN_DEF = NO
  1996 +
  1997 +#---------------------------------------------------------------------------
  1998 +# Configuration options related to the Perl module output
  1999 +#---------------------------------------------------------------------------
  2000 +
  2001 +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  2002 +# file that captures the structure of the code including all documentation.
  2003 +#
  2004 +# Note that this feature is still experimental and incomplete at the moment.
  2005 +# The default value is: NO.
  2006 +
  2007 +GENERATE_PERLMOD = NO
  2008 +
  2009 +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  2010 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  2011 +# output from the Perl module output.
  2012 +# The default value is: NO.
  2013 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  2014 +
  2015 +PERLMOD_LATEX = NO
  2016 +
  2017 +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  2018 +# formatted so it can be parsed by a human reader. This is useful if you want to
  2019 +# understand what is going on. On the other hand, if this tag is set to NO, the
  2020 +# size of the Perl module output will be much smaller and Perl will parse it
  2021 +# just the same.
  2022 +# The default value is: YES.
  2023 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  2024 +
  2025 +PERLMOD_PRETTY = YES
  2026 +
  2027 +# The names of the make variables in the generated doxyrules.make file are
  2028 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  2029 +# so different doxyrules.make files included by the same Makefile don't
  2030 +# overwrite each other's variables.
  2031 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  2032 +
  2033 +PERLMOD_MAKEVAR_PREFIX =
  2034 +
  2035 +#---------------------------------------------------------------------------
  2036 +# Configuration options related to the preprocessor
  2037 +#---------------------------------------------------------------------------
  2038 +
  2039 +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  2040 +# C-preprocessor directives found in the sources and include files.
  2041 +# The default value is: YES.
  2042 +
  2043 +ENABLE_PREPROCESSING = YES
  2044 +
  2045 +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  2046 +# in the source code. If set to NO, only conditional compilation will be
  2047 +# performed. Macro expansion can be done in a controlled way by setting
  2048 +# EXPAND_ONLY_PREDEF to YES.
  2049 +# The default value is: NO.
  2050 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2051 +
  2052 +MACRO_EXPANSION = NO
  2053 +
  2054 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  2055 +# the macro expansion is limited to the macros specified with the PREDEFINED and
  2056 +# EXPAND_AS_DEFINED tags.
  2057 +# The default value is: NO.
  2058 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2059 +
  2060 +EXPAND_ONLY_PREDEF = NO
  2061 +
  2062 +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
  2063 +# INCLUDE_PATH will be searched if a #include is found.
  2064 +# The default value is: YES.
  2065 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2066 +
  2067 +SEARCH_INCLUDES = YES
  2068 +
  2069 +# The INCLUDE_PATH tag can be used to specify one or more directories that
  2070 +# contain include files that are not input files but should be processed by the
  2071 +# preprocessor.
  2072 +# This tag requires that the tag SEARCH_INCLUDES is set to YES.
  2073 +
  2074 +INCLUDE_PATH =
  2075 +
  2076 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  2077 +# patterns (like *.h and *.hpp) to filter out the header-files in the
  2078 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be
  2079 +# used.
  2080 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2081 +
  2082 +INCLUDE_FILE_PATTERNS =
  2083 +
  2084 +# The PREDEFINED tag can be used to specify one or more macro names that are
  2085 +# defined before the preprocessor is started (similar to the -D option of e.g.
  2086 +# gcc). The argument of the tag is a list of macros of the form: name or
  2087 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  2088 +# is assumed. To prevent a macro definition from being undefined via #undef or
  2089 +# recursively expanded use the := operator instead of the = operator.
  2090 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2091 +
  2092 +PREDEFINED =
  2093 +
  2094 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  2095 +# tag can be used to specify a list of macro names that should be expanded. The
  2096 +# macro definition that is found in the sources will be used. Use the PREDEFINED
  2097 +# tag if you want to use a different macro definition that overrules the
  2098 +# definition found in the source code.
  2099 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2100 +
  2101 +EXPAND_AS_DEFINED =
  2102 +
  2103 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  2104 +# remove all references to function-like macros that are alone on a line, have
  2105 +# an all uppercase name, and do not end with a semicolon. Such function macros
  2106 +# are typically used for boiler-plate code, and will confuse the parser if not
  2107 +# removed.
  2108 +# The default value is: YES.
  2109 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2110 +
  2111 +SKIP_FUNCTION_MACROS = YES
  2112 +
  2113 +#---------------------------------------------------------------------------
  2114 +# Configuration options related to external references
  2115 +#---------------------------------------------------------------------------
  2116 +
  2117 +# The TAGFILES tag can be used to specify one or more tag files. For each tag
  2118 +# file the location of the external documentation should be added. The format of
  2119 +# a tag file without this location is as follows:
  2120 +# TAGFILES = file1 file2 ...
  2121 +# Adding location for the tag files is done as follows:
  2122 +# TAGFILES = file1=loc1 "file2 = loc2" ...
  2123 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the
  2124 +# section "Linking to external documentation" for more information about the use
  2125 +# of tag files.
  2126 +# Note: Each tag file must have a unique name (where the name does NOT include
  2127 +# the path). If a tag file is not located in the directory in which doxygen is
  2128 +# run, you must also specify the path to the tagfile here.
  2129 +
  2130 +TAGFILES =
  2131 +
  2132 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  2133 +# tag file that is based on the input files it reads. See section "Linking to
  2134 +# external documentation" for more information about the usage of tag files.
  2135 +
  2136 +GENERATE_TAGFILE =
  2137 +
  2138 +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  2139 +# the class index. If set to NO, only the inherited external classes will be
  2140 +# listed.
  2141 +# The default value is: NO.
  2142 +
  2143 +ALLEXTERNALS = NO
  2144 +
  2145 +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  2146 +# in the modules index. If set to NO, only the current project's groups will be
  2147 +# listed.
  2148 +# The default value is: YES.
  2149 +
  2150 +EXTERNAL_GROUPS = YES
  2151 +
  2152 +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  2153 +# the related pages index. If set to NO, only the current project's pages will
  2154 +# be listed.
  2155 +# The default value is: YES.
  2156 +
  2157 +EXTERNAL_PAGES = YES
  2158 +
  2159 +# The PERL_PATH should be the absolute path and name of the perl script
  2160 +# interpreter (i.e. the result of 'which perl').
  2161 +# The default file (with absolute path) is: /usr/bin/perl.
  2162 +
  2163 +PERL_PATH = /usr/bin/perl
  2164 +
  2165 +#---------------------------------------------------------------------------
  2166 +# Configuration options related to the dot tool
  2167 +#---------------------------------------------------------------------------
  2168 +
  2169 +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  2170 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  2171 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT
  2172 +# disabled, but it is recommended to install and use dot, since it yields more
  2173 +# powerful graphs.
  2174 +# The default value is: YES.
  2175 +
  2176 +CLASS_DIAGRAMS = YES
  2177 +
  2178 +# You can define message sequence charts within doxygen comments using the \msc
  2179 +# command. Doxygen will then run the mscgen tool (see:
  2180 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  2181 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
  2182 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
  2183 +# default search path.
  2184 +
  2185 +MSCGEN_PATH =
  2186 +
  2187 +# You can include diagrams made with dia in doxygen documentation. Doxygen will
  2188 +# then run dia to produce the diagram and insert it in the documentation. The
  2189 +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
  2190 +# If left empty dia is assumed to be found in the default search path.
  2191 +
  2192 +DIA_PATH =
  2193 +
  2194 +# If set to YES the inheritance and collaboration graphs will hide inheritance
  2195 +# and usage relations if the target is undocumented or is not a class.
  2196 +# The default value is: YES.
  2197 +
  2198 +HIDE_UNDOC_RELATIONS = YES
  2199 +
  2200 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  2201 +# available from the path. This tool is part of Graphviz (see:
  2202 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2203 +# Bell Labs. The other options in this section have no effect if this option is
  2204 +# set to NO
  2205 +# The default value is: YES.
  2206 +
  2207 +HAVE_DOT = YES
  2208 +
  2209 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  2210 +# to run in parallel. When set to 0 doxygen will base this on the number of
  2211 +# processors available in the system. You can set it explicitly to a value
  2212 +# larger than 0 to get control over the balance between CPU load and processing
  2213 +# speed.
  2214 +# Minimum value: 0, maximum value: 32, default value: 0.
  2215 +# This tag requires that the tag HAVE_DOT is set to YES.
  2216 +
  2217 +DOT_NUM_THREADS = 0
  2218 +
  2219 +# When you want a differently looking font in the dot files that doxygen
  2220 +# generates you can specify the font name using DOT_FONTNAME. You need to make
  2221 +# sure dot is able to find the font, which can be done by putting it in a
  2222 +# standard location or by setting the DOTFONTPATH environment variable or by
  2223 +# setting DOT_FONTPATH to the directory containing the font.
  2224 +# The default value is: Helvetica.
  2225 +# This tag requires that the tag HAVE_DOT is set to YES.
  2226 +
  2227 +DOT_FONTNAME = Helvetica
  2228 +
  2229 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2230 +# dot graphs.
  2231 +# Minimum value: 4, maximum value: 24, default value: 10.
  2232 +# This tag requires that the tag HAVE_DOT is set to YES.
  2233 +
  2234 +DOT_FONTSIZE = 10
  2235 +
  2236 +# By default doxygen will tell dot to use the default font as specified with
  2237 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2238 +# the path where dot can find it using this tag.
  2239 +# This tag requires that the tag HAVE_DOT is set to YES.
  2240 +
  2241 +DOT_FONTPATH =
  2242 +
  2243 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2244 +# each documented class showing the direct and indirect inheritance relations.
  2245 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2246 +# The default value is: YES.
  2247 +# This tag requires that the tag HAVE_DOT is set to YES.
  2248 +
  2249 +CLASS_GRAPH = YES
  2250 +
  2251 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  2252 +# graph for each documented class showing the direct and indirect implementation
  2253 +# dependencies (inheritance, containment, and class references variables) of the
  2254 +# class with other documented classes.
  2255 +# The default value is: YES.
  2256 +# This tag requires that the tag HAVE_DOT is set to YES.
  2257 +
  2258 +COLLABORATION_GRAPH = YES
  2259 +
  2260 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2261 +# groups, showing the direct groups dependencies.
  2262 +# The default value is: YES.
  2263 +# This tag requires that the tag HAVE_DOT is set to YES.
  2264 +
  2265 +GROUP_GRAPHS = YES
  2266 +
  2267 +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  2268 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
  2269 +# Language.
  2270 +# The default value is: NO.
  2271 +# This tag requires that the tag HAVE_DOT is set to YES.
  2272 +
  2273 +UML_LOOK = NO
  2274 +
  2275 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  2276 +# class node. If there are many fields or methods and many nodes the graph may
  2277 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  2278 +# number of items for each type to make the size more manageable. Set this to 0
  2279 +# for no limit. Note that the threshold may be exceeded by 50% before the limit
  2280 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  2281 +# but if the number exceeds 15, the total amount of fields shown is limited to
  2282 +# 10.
  2283 +# Minimum value: 0, maximum value: 100, default value: 10.
  2284 +# This tag requires that the tag HAVE_DOT is set to YES.
  2285 +
  2286 +UML_LIMIT_NUM_FIELDS = 10
  2287 +
  2288 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2289 +# collaboration graphs will show the relations between templates and their
  2290 +# instances.
  2291 +# The default value is: NO.
  2292 +# This tag requires that the tag HAVE_DOT is set to YES.
  2293 +
  2294 +TEMPLATE_RELATIONS = NO
  2295 +
  2296 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  2297 +# YES then doxygen will generate a graph for each documented file showing the
  2298 +# direct and indirect include dependencies of the file with other documented
  2299 +# files.
  2300 +# The default value is: YES.
  2301 +# This tag requires that the tag HAVE_DOT is set to YES.
  2302 +
  2303 +INCLUDE_GRAPH = YES
  2304 +
  2305 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  2306 +# set to YES then doxygen will generate a graph for each documented file showing
  2307 +# the direct and indirect include dependencies of the file with other documented
  2308 +# files.
  2309 +# The default value is: YES.
  2310 +# This tag requires that the tag HAVE_DOT is set to YES.
  2311 +
  2312 +INCLUDED_BY_GRAPH = YES
  2313 +
  2314 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  2315 +# dependency graph for every global function or class method.
  2316 +#
  2317 +# Note that enabling this option will significantly increase the time of a run.
  2318 +# So in most cases it will be better to enable call graphs for selected
  2319 +# functions only using the \callgraph command. Disabling a call graph can be
  2320 +# accomplished by means of the command \hidecallgraph.
  2321 +# The default value is: NO.
  2322 +# This tag requires that the tag HAVE_DOT is set to YES.
  2323 +
  2324 +CALL_GRAPH = NO
  2325 +
  2326 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  2327 +# dependency graph for every global function or class method.
  2328 +#
  2329 +# Note that enabling this option will significantly increase the time of a run.
  2330 +# So in most cases it will be better to enable caller graphs for selected
  2331 +# functions only using the \callergraph command. Disabling a caller graph can be
  2332 +# accomplished by means of the command \hidecallergraph.
  2333 +# The default value is: NO.
  2334 +# This tag requires that the tag HAVE_DOT is set to YES.
  2335 +
  2336 +CALLER_GRAPH = NO
  2337 +
  2338 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  2339 +# hierarchy of all classes instead of a textual one.
  2340 +# The default value is: YES.
  2341 +# This tag requires that the tag HAVE_DOT is set to YES.
  2342 +
  2343 +GRAPHICAL_HIERARCHY = YES
  2344 +
  2345 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  2346 +# dependencies a directory has on other directories in a graphical way. The
  2347 +# dependency relations are determined by the #include relations between the
  2348 +# files in the directories.
  2349 +# The default value is: YES.
  2350 +# This tag requires that the tag HAVE_DOT is set to YES.
  2351 +
  2352 +DIRECTORY_GRAPH = YES
  2353 +
  2354 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  2355 +# generated by dot. For an explanation of the image formats see the section
  2356 +# output formats in the documentation of the dot tool (Graphviz (see:
  2357 +# http://www.graphviz.org/)).
  2358 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2359 +# to make the SVG files visible in IE 9+ (other browsers do not have this
  2360 +# requirement).
  2361 +# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  2362 +# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  2363 +# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
  2364 +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  2365 +# png:gdiplus:gdiplus.
  2366 +# The default value is: png.
  2367 +# This tag requires that the tag HAVE_DOT is set to YES.
  2368 +
  2369 +DOT_IMAGE_FORMAT = png
  2370 +
  2371 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  2372 +# enable generation of interactive SVG images that allow zooming and panning.
  2373 +#
  2374 +# Note that this requires a modern browser other than Internet Explorer. Tested
  2375 +# and working are Firefox, Chrome, Safari, and Opera.
  2376 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  2377 +# the SVG files visible. Older versions of IE do not have SVG support.
  2378 +# The default value is: NO.
  2379 +# This tag requires that the tag HAVE_DOT is set to YES.
  2380 +
  2381 +INTERACTIVE_SVG = NO
  2382 +
  2383 +# The DOT_PATH tag can be used to specify the path where the dot tool can be
  2384 +# found. If left blank, it is assumed the dot tool can be found in the path.
  2385 +# This tag requires that the tag HAVE_DOT is set to YES.
  2386 +
  2387 +DOT_PATH =
  2388 +
  2389 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
  2390 +# contain dot files that are included in the documentation (see the \dotfile
  2391 +# command).
  2392 +# This tag requires that the tag HAVE_DOT is set to YES.
  2393 +
  2394 +DOTFILE_DIRS =
  2395 +
  2396 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
  2397 +# contain msc files that are included in the documentation (see the \mscfile
  2398 +# command).
  2399 +
  2400 +MSCFILE_DIRS =
  2401 +
  2402 +# The DIAFILE_DIRS tag can be used to specify one or more directories that
  2403 +# contain dia files that are included in the documentation (see the \diafile
  2404 +# command).
  2405 +
  2406 +DIAFILE_DIRS =
  2407 +
  2408 +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  2409 +# path where java can find the plantuml.jar file. If left blank, it is assumed
  2410 +# PlantUML is not used or called during a preprocessing step. Doxygen will
  2411 +# generate a warning when it encounters a \startuml command in this case and
  2412 +# will not generate output for the diagram.
  2413 +
  2414 +PLANTUML_JAR_PATH =
  2415 +
  2416 +# When using plantuml, the specified paths are searched for files specified by
  2417 +# the !include statement in a plantuml block.
  2418 +
  2419 +PLANTUML_INCLUDE_PATH =
  2420 +
  2421 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2422 +# that will be shown in the graph. If the number of nodes in a graph becomes
  2423 +# larger than this value, doxygen will truncate the graph, which is visualized
  2424 +# by representing a node as a red box. Note that doxygen if the number of direct
  2425 +# children of the root node in a graph is already larger than
  2426 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  2427 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2428 +# Minimum value: 0, maximum value: 10000, default value: 50.
  2429 +# This tag requires that the tag HAVE_DOT is set to YES.
  2430 +
  2431 +DOT_GRAPH_MAX_NODES = 50
  2432 +
  2433 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  2434 +# generated by dot. A depth value of 3 means that only nodes reachable from the
  2435 +# root by following a path via at most 3 edges will be shown. Nodes that lay
  2436 +# further from the root node will be omitted. Note that setting this option to 1
  2437 +# or 2 may greatly reduce the computation time needed for large code bases. Also
  2438 +# note that the size of a graph can be further restricted by
  2439 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  2440 +# Minimum value: 0, maximum value: 1000, default value: 0.
  2441 +# This tag requires that the tag HAVE_DOT is set to YES.
  2442 +
  2443 +MAX_DOT_GRAPH_DEPTH = 0
  2444 +
  2445 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2446 +# background. This is disabled by default, because dot on Windows does not seem
  2447 +# to support this out of the box.
  2448 +#
  2449 +# Warning: Depending on the platform used, enabling this option may lead to
  2450 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2451 +# read).
  2452 +# The default value is: NO.
  2453 +# This tag requires that the tag HAVE_DOT is set to YES.
  2454 +
  2455 +DOT_TRANSPARENT = NO
  2456 +
  2457 +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  2458 +# files in one run (i.e. multiple -o and -T options on the command line). This
  2459 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2460 +# this, this feature is disabled by default.
  2461 +# The default value is: NO.
  2462 +# This tag requires that the tag HAVE_DOT is set to YES.
  2463 +
  2464 +DOT_MULTI_TARGETS = NO
  2465 +
  2466 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2467 +# explaining the meaning of the various boxes and arrows in the dot generated
  2468 +# graphs.
  2469 +# The default value is: YES.
  2470 +# This tag requires that the tag HAVE_DOT is set to YES.
  2471 +
  2472 +GENERATE_LEGEND = YES
  2473 +
  2474 +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  2475 +# files that are used to generate the various graphs.
  2476 +# The default value is: YES.
  2477 +# This tag requires that the tag HAVE_DOT is set to YES.
  2478 +
  2479 +DOT_CLEANUP = YES
... ...
src/config/config.h.in 0 → 100644
  1 +++ a/src/config/config.h.in
... ... @@ -0,0 +1,43 @@
  1 +#ifndef __CONFIG_H__
  2 +#define __CONFIG_H__
  3 +
  4 +#include <string>
  5 +
  6 +#cmakedefine USE_WINSOCK
  7 +
  8 +#ifdef USE_WINSOCK
  9 +#include <ws2tcpip.h>
  10 +#include <windows.h>
  11 +
  12 +#ifdef __MINGW32__
  13 +#include <basetsd.h>
  14 +#else
  15 +#include <BaseTsd.h>
  16 +typedef SSIZE_T ssize_t;
  17 +#endif
  18 +
  19 +
  20 +#ifndef WIN32_LEAN_AND_MEAN
  21 +#define WIN32_LEAN_AND_MEAN
  22 +
  23 +#endif
  24 +
  25 +#ifdef USE_POSIX
  26 +#include <mingw.thread.h>
  27 +#endif
  28 +
  29 +#else // POSIX
  30 +
  31 +#include <unistd.h>
  32 +#include <arpa/inet.h>
  33 +#include <sys/types.h>
  34 +#include <sys/socket.h>
  35 +#include <netinet/in.h>
  36 +
  37 +#endif
  38 +
  39 +#include "arch.h"
  40 +
  41 +static std::string ARCH_MODEL = "@CMAKE_LIBRARY_ARCHITECTURE@";
  42 +
  43 +#endif
... ...
src/lib/CMakeLists.txt 0 → 100644
  1 +++ a/src/lib/CMakeLists.txt
... ... @@ -0,0 +1,11 @@
  1 +if (WIN32)
  2 + set (PLATFORM_LIBRARY "arch/win32.cpp")
  3 +else ()
  4 + set (PLATFORM_LIBRARY "arch/posix.cpp")
  5 +endif()
  6 +
  7 +add_library (socket socket.cpp ${PLATFORM_LIBRARY})
  8 +if (WIN32)
  9 + target_link_libraries (socket wsock32 ws2_32)
  10 +endif()
  11 +set_property (TARGET socket PROPERTY CXX_STANDARD 11)
... ...
src/lib/arch.h 0 → 100644
  1 +++ a/src/lib/arch.h
... ... @@ -0,0 +1,18 @@
  1 +#ifndef __ARCH_H__
  2 +#define __ARCH_H__
  3 +
  4 +#include <string>
  5 +
  6 +namespace lemoce
  7 +{
  8 +
  9 + void initializeSocketAPI();
  10 + bool isClosed(int);
  11 + int closeSocket(int);
  12 + void treatSocketError(bool);
  13 + std::string getMessageError(int);
  14 +
  15 +}
  16 +
  17 +#endif /* ARCH_H */
  18 +
... ...
src/lib/arch/posix.cpp 0 → 100644
  1 +++ a/src/lib/arch/posix.cpp
... ... @@ -0,0 +1,36 @@
  1 +
  2 +#include <string>
  3 +#include <memory>
  4 +
  5 +#include <errno.h>
  6 +#include <string.h>
  7 +
  8 +#include <fcntl.h>
  9 +
  10 +#include "socket.h"
  11 +#include "config.h"
  12 +
  13 +#include <iostream>
  14 +
  15 +void lemoce::initializeSocketAPI() { }
  16 +
  17 +bool lemoce::isClosed(int fd)
  18 +{
  19 + return (fcntl(fd, F_GETFL) < 0 && errno == EBADF);
  20 +}
  21 +
  22 +int lemoce::closeSocket(int fd)
  23 +{
  24 + return ::close(fd);
  25 +}
  26 +
  27 +void lemoce::treatSocketError(bool cleanup)
  28 +{
  29 + throw SocketException{errno};
  30 +}
  31 +
  32 +std::string lemoce::getMessageError(int error)
  33 +{
  34 + std::string tmp{::strerror(error)};
  35 + return tmp;
  36 +}
... ...
src/lib/arch/win32.cpp 0 → 100644
  1 +++ a/src/lib/arch/win32.cpp
... ... @@ -0,0 +1,81 @@
  1 +
  2 +#include "socket.h"
  3 +#include "config.h"
  4 +#include <sstream>
  5 +#include <iostream>
  6 +
  7 +void lemoce::initializeSocketAPI() {
  8 + // so precisa ser chamado 1 vez em toda execuçao do programa
  9 + // mas pode ser chamado varias vezes sem problemas
  10 + // desde que sejam chamado no mesmo numero de vezes WSACleanup
  11 + WSADATA wsaData;
  12 +
  13 + int result = ::WSAStartup(MAKEWORD(2,2), &wsaData);
  14 + if (result < 0) {
  15 + {
  16 + treatSocketError(true);
  17 + }
  18 + }
  19 +}
  20 +
  21 +bool lemoce::isClosed(int fd)
  22 +{
  23 + struct timeval tv = {0, 0};
  24 + fd_set fds;
  25 +
  26 + FD_ZERO(&fds);
  27 + FD_SET(fd, &fds);
  28 +
  29 + int rc = ::select(0, &fds, nullptr, nullptr, &tv);
  30 + if (!FD_ISSET(fd, &fds))
  31 + {
  32 + return false;
  33 + }
  34 + u_long n = 0;
  35 +
  36 + ioctlsocket(fd, FIONREAD, &n);
  37 + return n == 0;
  38 +}
  39 +
  40 +int lemoce::closeSocket(int fd)
  41 +{
  42 +
  43 + // nao ha necessidade de se chamar o shutdown pois usamos blocking read
  44 + int result = ::closesocket(fd);
  45 + ::WSACleanup();
  46 +
  47 + return result;
  48 +}
  49 +
  50 +void lemoce::treatSocketError(bool cleanup)
  51 +{
  52 + int error;
  53 + error = ::WSAGetLastError();
  54 +
  55 + if (cleanup)
  56 + {
  57 + ::WSACleanup();
  58 + }
  59 + throw SocketException{error};
  60 +}
  61 +
  62 +std::string lemoce::getMessageError(int error)
  63 +{
  64 +
  65 + char *buffer;
  66 + ::FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
  67 + nullptr,
  68 + error,
  69 + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
  70 + (LPTSTR)&buffer,
  71 + 1024,
  72 + nullptr);
  73 +
  74 + std::ostringstream oss;
  75 +
  76 + oss << buffer;
  77 +
  78 + ::LocalFree(buffer);
  79 +
  80 + return oss.str();
  81 +}
... ...
src/lib/socket.cpp 0 → 100644
  1 +++ a/src/lib/socket.cpp
... ... @@ -0,0 +1,299 @@
  1 +#include <string.h>
  2 +#include <errno.h>
  3 +
  4 +#include <iostream>
  5 +
  6 +#include <string>
  7 +#include <sstream>
  8 +#include <memory>
  9 +
  10 +#include "config.h"
  11 +#include "socket.h"
  12 +
  13 +// TODO Remover Message Buffer
  14 +const int lemoce::ClientSocket::MESSAGE_BUFFER = 8192;
  15 +int lemoce::ServerSocket::BACKLOG = 512;
  16 +
  17 +lemoce::Socket::Socket()
  18 +{
  19 +
  20 + initializeSocketAPI();
  21 +
  22 + this->fd = ::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
  23 + if (this->fd < 0)
  24 + {
  25 + treatSocketError(true);
  26 + }
  27 +}
  28 +
  29 +int lemoce::Socket::getFd() const
  30 +{
  31 + return fd;
  32 +}
  33 +
  34 +void lemoce::Socket::setFd(int fdToSet)
  35 +{
  36 + fd = fdToSet;
  37 +}
  38 +
  39 +bool lemoce::Socket::isClosed()
  40 +{
  41 + return lemoce::isClosed(fd);
  42 +}
  43 +
  44 +void lemoce::Socket::close()
  45 +{
  46 + if(closeSocket(fd) < 0)
  47 + {
  48 + throw SocketException{errno};
  49 + }
  50 +}
  51 +
  52 +
  53 +lemoce::ClientSocket::ClientSocket() { }
  54 +
  55 +
  56 +lemoce::ClientSocket::ClientSocket(std::string remote, int port):
  57 + lemoce::Socket{}, remotePort(port), remoteHost{remote} { }
  58 +
  59 +
  60 +void lemoce::ClientSocket::connect()
  61 +{
  62 +
  63 + struct sockaddr_in serveraddr;
  64 +
  65 + ::memset(&serveraddr, 0, sizeof(struct sockaddr_in));
  66 + serveraddr.sin_family = AF_INET;
  67 + serveraddr.sin_port = ::htons(remotePort);
  68 + if (::inet_pton(AF_INET, remoteHost.c_str(), &serveraddr.sin_addr) < 0)
  69 + {
  70 + treatSocketError(false);
  71 + }
  72 +
  73 + if (::connect(getFd(), reinterpret_cast<struct sockaddr *>(&serveraddr), sizeof(serveraddr)) < 0)
  74 + {
  75 + treatSocketError(false);
  76 + }
  77 +
  78 + struct sockaddr_in clientaddr;
  79 + socklen_t clientlen = sizeof(clientaddr);
  80 + if (::getsockname(getFd(), reinterpret_cast<struct sockaddr *>(&clientaddr), &clientlen) < 0)
  81 + {
  82 + treatSocketError(false);
  83 + }
  84 +
  85 + std::string lHost{::inet_ntoa(clientaddr.sin_addr)};
  86 + int lPort = ::ntohs(clientaddr.sin_port);
  87 + localHost = lHost;
  88 + localPort = lPort;
  89 +}
  90 +
  91 +// TODO deletar essa ou de baixo
  92 +std::unique_ptr<std::string> lemoce::ClientSocket::read()
  93 +{
  94 + char chararray[MESSAGE_BUFFER + 1];
  95 + std::ostringstream buffer;
  96 + int nread;
  97 +
  98 + while (((nread = ::recv(getFd(), chararray, MESSAGE_BUFFER, 0)) < 0))
  99 + {
  100 + if (errno == EINTR)
  101 + {
  102 + continue;
  103 + }
  104 + else
  105 + {
  106 + throw new SocketException{errno};
  107 + }
  108 + }
  109 +
  110 + if (nread < MESSAGE_BUFFER)
  111 + {
  112 + chararray[nread] = '\0';
  113 + }
  114 +
  115 + buffer << chararray;
  116 +
  117 + std::unique_ptr<std::string> result{new std::string{buffer.str()}};
  118 +
  119 + return result;
  120 +}
  121 +
  122 +// TODO Modificar para aceitar array de bytes
  123 +std::unique_ptr<std::string> lemoce::ClientSocket::read(const size_t n)
  124 +{
  125 + std::ostringstream buffer;
  126 +
  127 + ssize_t nread;
  128 +
  129 + size_t left = n;
  130 + char chararray[n];
  131 + char * ptr = chararray;
  132 +
  133 + while (left > 0)
  134 + {
  135 + if ((nread = ::recv(getFd(), ptr, n, 0)) < 0)
  136 + {
  137 + if (errno == EINTR)
  138 + nread = 0;
  139 + else
  140 + throw new SocketException{errno};
  141 + }
  142 + else if (nread == 0)
  143 + break;
  144 +
  145 + left -= nread;
  146 + ptr = ptr + nread;
  147 + }
  148 +
  149 + buffer << chararray;
  150 +
  151 + std::unique_ptr<std::string> result{new std::string{buffer.str()}};
  152 +
  153 + return std::move(result);
  154 +}
  155 +
  156 +
  157 +// TODO Modificar para array de bytes
  158 +void lemoce::ClientSocket::write(const std::string& message)
  159 +{
  160 +
  161 + size_t nleft = message.size();
  162 + const char * ptr = message.c_str();
  163 +
  164 + ssize_t nwritten = nleft;
  165 +
  166 + while (nleft > 0)
  167 + {
  168 + if ((nwritten = ::send(getFd(), ptr, nleft, 0)) <= 0)
  169 + {
  170 + if (nwritten < 0 && errno == EINTR)
  171 + nwritten = 0;
  172 + else
  173 + throw new SocketException{errno};
  174 + }
  175 + nleft -= nwritten;
  176 + ptr += nwritten;
  177 + }
  178 +}
  179 +
  180 +void lemoce::ClientSocket::setRemoteHost(std::string rHost)
  181 +{
  182 + remoteHost = rHost;
  183 +}
  184 +
  185 +std::string lemoce::ClientSocket::getRemoteHost() const
  186 +{
  187 + return remoteHost;
  188 +}
  189 +
  190 +void lemoce::ClientSocket::setRemotePort(int rPort)
  191 +{
  192 + remotePort = rPort;
  193 +}
  194 +
  195 +int lemoce::ClientSocket::getRemotePort() const
  196 +{
  197 + return remotePort;
  198 +}
  199 +
  200 +void lemoce::ClientSocket::setLocalHost(std::string lHost)
  201 +{
  202 + localHost = lHost;
  203 +}
  204 +
  205 +std::string lemoce::ClientSocket::getLocalHost() const
  206 +{
  207 + return localHost;
  208 +}
  209 +
  210 +void lemoce::ClientSocket::setLocalPort(int lPort)
  211 +{
  212 + localPort = lPort;
  213 +}
  214 +
  215 +int lemoce::ClientSocket::getLocalPort() const
  216 +{
  217 + return localPort;
  218 +}
  219 +
  220 +lemoce::ServerSocket::ServerSocket(int lPort):
  221 + lemoce::Socket{}, localPort(lPort) { }
  222 +
  223 +void lemoce::ServerSocket::listen()
  224 +{
  225 + struct sockaddr_in serveraddr;
  226 +
  227 + ::memset(&serveraddr, 0, sizeof(struct sockaddr_in));
  228 + serveraddr.sin_family = AF_INET;
  229 + serveraddr.sin_addr.s_addr = ::htonl(INADDR_ANY);
  230 + serveraddr.sin_port = ::htons(localPort);
  231 +
  232 + if (::bind(getFd(), reinterpret_cast<struct sockaddr *>(&serveraddr), sizeof(serveraddr)) < 0)
  233 + {
  234 + throw SocketException(errno);
  235 + }
  236 +
  237 + if (::listen(getFd(), 5) < 0)
  238 + {
  239 + throw SocketException(errno);
  240 + }
  241 +
  242 +}
  243 +
  244 +void lemoce::ServerSocket::accept(lemoce::ClientSocket & client)
  245 +{
  246 +
  247 + struct sockaddr_in clientaddr;
  248 + socklen_t clientaddr_len = sizeof(clientaddr);
  249 +
  250 + int client_fd = ::accept(getFd(), reinterpret_cast<struct sockaddr *>(&clientaddr), &clientaddr_len);
  251 + if (client_fd < 0)
  252 + {
  253 + throw SocketException{errno};
  254 + }
  255 +
  256 + client.setFd(client_fd);
  257 +
  258 + std::string localHost{::inet_ntoa(clientaddr.sin_addr)};
  259 + int localPort = ::ntohs(clientaddr.sin_port);
  260 + client.setLocalHost(localHost);
  261 + client.setLocalPort(localPort);
  262 +
  263 + struct sockaddr_in serveraddr;
  264 + socklen_t serveraddr_len;
  265 + if (::getsockname(getFd(), reinterpret_cast<struct sockaddr *>(&serveraddr), &serveraddr_len) >= 0)
  266 + {
  267 + std::string serverHost{::inet_ntoa(serveraddr.sin_addr)};
  268 + client.setRemoteHost(serverHost);
  269 +
  270 + int serverPort = ::ntohs(serveraddr.sin_port);
  271 + client.setRemotePort(serverPort);
  272 + }
  273 + else
  274 + {
  275 + client.setRemotePort(localPort);
  276 + }
  277 +}
  278 +
  279 +
  280 +
  281 +lemoce::SocketException::SocketException(int no): error{no}
  282 +{
  283 + message = getMessageError(error);
  284 +}
  285 +
  286 +std::string lemoce::SocketException::getMessage() const
  287 +{
  288 + return message;
  289 +}
  290 +
  291 +const char * lemoce::SocketException::what() const throw()
  292 +{
  293 + return message.c_str();
  294 +}
  295 +
  296 +int lemoce::SocketException::getErrno() const
  297 +{
  298 + return error;
  299 +}
... ...
src/lib/socket.h 0 → 100644
  1 +++ a/src/lib/socket.h
... ... @@ -0,0 +1,101 @@
  1 +#ifndef __SOCKET_H__
  2 +#define __SOCKET_H__
  3 +
  4 +#include <string>
  5 +#include <memory>
  6 +#include <exception>
  7 +
  8 +namespace lemoce {
  9 +
  10 + ///
  11 + /// Brief Classe base que contem apenas o File Descriptor do socket.
  12 + ///
  13 + class Socket
  14 + {
  15 + public:
  16 + Socket();
  17 +
  18 + int getFd() const;
  19 + void setFd(int fd);
  20 +
  21 + bool isClosed();
  22 + void close();
  23 +
  24 + protected:
  25 +
  26 + int fd; //!< Brief File Descriptor do socket
  27 + };
  28 +
  29 + ///
  30 + /// Brief Classe que abstrai as operações de recv e send do TCP/IP.
  31 + ///
  32 + class ClientSocket : public Socket {
  33 + public:
  34 + ClientSocket();
  35 + ClientSocket(std::string remote, int port);
  36 +
  37 + void setRemoteHost(std::string);
  38 + std::string getRemoteHost() const;
  39 + void setRemotePort(int port);
  40 + int getRemotePort() const;
  41 + void setLocalHost(std::string);
  42 + std::string getLocalHost() const;
  43 + void setLocalPort(int);
  44 + int getLocalPort() const;
  45 +
  46 + void connect();
  47 + std::unique_ptr<std::string> read();
  48 + std::unique_ptr<std::string> read(const size_t n);
  49 + void write(const std::string& message);
  50 +
  51 + private:
  52 +
  53 + static const int MESSAGE_BUFFER;
  54 + void fillLocalHostPort();
  55 +
  56 + std::string remoteHost; //!< Brief host do servidor
  57 + int remotePort; //!< Brief porta do servidor
  58 +
  59 + std::string localHost; //!< Brief host do client
  60 + int localPort; //!< Brief porta do client
  61 +
  62 +
  63 +
  64 + };
  65 +
  66 + ///
  67 + /// Brief Classe que abstrai as operações de accept
  68 + ///
  69 + class ServerSocket : public Socket
  70 + {
  71 + public:
  72 + ServerSocket(int port);
  73 +
  74 + void listen();
  75 + void accept(ClientSocket & client);
  76 +
  77 + private:
  78 + static int BACKLOG; //!< Brief numero de backlog possíveis
  79 +
  80 + int localPort; //!< Brief porta local do servidor
  81 + };
  82 +
  83 +
  84 + ///
  85 + /// Brief Class embarca o código de erro
  86 + ///
  87 + class SocketException : public std::exception
  88 + {
  89 + public:
  90 + SocketException(int err_number);
  91 + std::string getMessage() const;
  92 + virtual const char * what() const throw();
  93 + int getErrno() const;
  94 + private:
  95 + std::string message;
  96 + int error;
  97 + };
  98 +
  99 +}
  100 +
  101 +#endif /* __SOCKET_H__ */
... ...
src/utils/CMakeLists.txt 0 → 100644
  1 +++ a/src/utils/CMakeLists.txt
... ... @@ -0,0 +1,23 @@
  1 +include_directories ("${PROJECT_SOURCE_DIR}/src/lib")
  2 +
  3 +add_executable(arch arch.cpp)
  4 +
  5 +add_executable(http_get http_get.cpp)
  6 +target_link_libraries(http_get socket)
  7 +set_property(TARGET http_get PROPERTY CXX_STANDARD 11)
  8 +
  9 +add_executable(daytime_server daytime_server.cpp)
  10 +target_link_libraries(daytime_server socket)
  11 +set_property(TARGET daytime_server PROPERTY CXX_STANDARD 11)
  12 +
  13 +add_executable(echo_server echo_server.cpp)
  14 +target_link_libraries(echo_server socket ${CMAKE_THREAD_LIBS_INIT})
  15 +set_property(TARGET echo_server PROPERTY CXX_STANDARD 11)
  16 +
  17 +add_executable(echo_client echo_client.cpp)
  18 +target_link_libraries(echo_client socket)
  19 +set_property(TARGET echo_client PROPERTY CXX_STANDARD 11)
  20 +
  21 +add_executable(tcptunnel tcptunnel.cpp)
  22 +target_link_libraries(tcptunnel socket ${CMAKE_THREAD_LIBS_INIT})
  23 +set_property(TARGET tcptunnel PROPERTY CXX_STANDARD 11)
... ...
src/utils/arch.cpp 0 → 100644
  1 +++ a/src/utils/arch.cpp
... ... @@ -0,0 +1,8 @@
  1 +#include <iostream>
  2 +#include "config.h"
  3 +
  4 +int main()
  5 +{
  6 + std::cout << ARCH_MODEL << std::endl;
  7 + return 0;
  8 +}
... ...
src/utils/daytime_server.cpp 0 → 100644
  1 +++ a/src/utils/daytime_server.cpp
... ... @@ -0,0 +1,42 @@
  1 +#include <string.h>
  2 +#include <time.h>
  3 +
  4 +#include "socket.h"
  5 +
  6 +#include <iostream>
  7 +#include <sstream>
  8 +#include <string>
  9 +
  10 +int main(int argc, char *argv[])
  11 +{
  12 +
  13 + const int MAX_BUFFER = 8192;
  14 + int porta = 13;
  15 +
  16 + try
  17 + {
  18 + lemoce::ServerSocket s{porta};
  19 + s.listen();
  20 + for(;;)
  21 + {
  22 + lemoce::ClientSocket client;
  23 + s.accept(client);
  24 +
  25 + time_t ticks = time(nullptr);
  26 + char buff[MAX_BUFFER];
  27 + snprintf(buff, sizeof(buff), "%.24s\r\n", ctime(&ticks));
  28 + client.write(std::string{buff});
  29 +
  30 + std::cout << "mensagem enviada para " << client.getLocalHost() << ":" << client.getLocalPort() << std::endl;
  31 +
  32 + client.close();
  33 + }
  34 + }
  35 + catch (lemoce::SocketException& ex)
  36 + {
  37 + std::cout << ex.getMessage() << std::endl;
  38 + }
  39 +
  40 +
  41 + return 0;
  42 +}
... ...
src/utils/echo_client.cpp 0 → 100644
  1 +++ a/src/utils/echo_client.cpp
... ... @@ -0,0 +1,63 @@
  1 +#include "socket.h"
  2 +#include "config.h"
  3 +
  4 +#include <memory>
  5 +#include <errno.h>
  6 +#include <iostream>
  7 +#include <sstream>
  8 +#include <string>
  9 +
  10 +void str_echo(std::istream& in, lemoce::ClientSocket & client)
  11 +{
  12 +
  13 + std::string payload;
  14 +
  15 + while(std::getline(in, payload))
  16 + {
  17 + try
  18 + {
  19 + std::cout << "li pelo teclado " << payload << std::endl;
  20 + client.write(payload);
  21 + std::unique_ptr<std::string> ptrRead = client.read();
  22 + std::cout << "recebi do servidor " << *ptrRead << std::endl;
  23 + }
  24 + catch(lemoce::SocketException& ex)
  25 + {
  26 + if (ex.getErrno() != EINTR)
  27 + throw ex;
  28 + }
  29 + }
  30 +}
  31 +
  32 +int main(int argc, char *argv[])
  33 +{
  34 + int MAX_BUFFER = 8192;
  35 + std::string host = "localhost";
  36 + int port = 7;
  37 +
  38 + //std::cin.exceptions(std::ios_base::failbit | std::ios_base::eofbit);
  39 +
  40 + if (argc == 3)
  41 + {
  42 + std::istringstream issHost{argv[1]};
  43 + issHost >> host;
  44 +
  45 + std::istringstream issPort{argv[2]};
  46 + issPort >> port;
  47 + }
  48 +
  49 + try
  50 + {
  51 + lemoce::ClientSocket client(host, port);
  52 + client.connect();
  53 +
  54 + str_echo(std::cin, client);
  55 +
  56 + client.close();
  57 + }
  58 + catch (lemoce::SocketException& ex)
  59 + {
  60 + std::cout << ex.getMessage() << std::endl;
  61 + }
  62 + return 0;
  63 +}
... ...
src/utils/echo_server.cpp 0 → 100644
  1 +++ a/src/utils/echo_server.cpp
... ... @@ -0,0 +1,141 @@
  1 +
  2 +#include <chrono>
  3 +#include <future>
  4 +#include <iostream>
  5 +#include <list>
  6 +#include <memory>
  7 +#include <sstream>
  8 +#include <string.h>
  9 +#include <thread>
  10 +#include <utility>
  11 +
  12 +#include "socket.h"
  13 +#include "config.h"
  14 +
  15 +
  16 +void threadManager(std::list<std::pair<std::shared_ptr<std::atomic<bool>>, std::unique_ptr<std::thread>>> & threads)
  17 +{
  18 + std::cout << "iniciei gerenciador de threads" << std::endl;
  19 + while(true)
  20 + {
  21 + std::this_thread::sleep_for(std::chrono::seconds(30));
  22 + std::cout << "realizando limpeza das threads (size = " << threads.size() << ")" << std::endl;
  23 + int i = 0;
  24 + std::list<std::pair<std::shared_ptr<std::atomic<bool>>, std::unique_ptr<std::thread>>>::iterator it;
  25 + for(it = threads.begin(); it != threads.end(); ++i)
  26 + {
  27 + if ((*(it->first)))
  28 + {
  29 + (it->first).reset();
  30 + (it->second)->join();
  31 + (it->second).reset();
  32 + it = threads.erase(it);
  33 + std::cout << "removi thread inutilizada " << (i+1) << std::endl;
  34 + }
  35 + else
  36 + {
  37 + ++it;
  38 + }
  39 + }
  40 + }
  41 +}
  42 +
  43 +
  44 +void echoServerTask(std::unique_ptr<lemoce::ClientSocket> client_ptr,
  45 + std::shared_ptr<std::atomic<bool>> done)
  46 +{
  47 + lemoce::ClientSocket client = *client_ptr;
  48 + std::thread::id threadId = std::this_thread::get_id();
  49 +
  50 + try
  51 + {
  52 + while(!client.isClosed())
  53 + {
  54 + std::unique_ptr<std::string> message_ptr = client.read();
  55 + if ((*message_ptr).size() == 0)
  56 + {
  57 + client.close();
  58 + break;
  59 + }
  60 + std::string * message = message_ptr.get();
  61 + client.write(*message);
  62 + std::cout << "enviada mensagem para filho " << threadId <<
  63 + " (" << client.getLocalHost() << ", " <<
  64 + client.getLocalPort() << ")" << std::endl;
  65 + }
  66 + }
  67 + catch (lemoce::SocketException & ex)
  68 + {
  69 + client.close();
  70 + }
  71 +
  72 + std::cout << "terminei a thread" << std::endl;
  73 + (*done) = true;
  74 +}
  75 +
  76 +
  77 +int main(int argc, char *argv[])
  78 +{
  79 + int MAX_BUFFER = 8192;
  80 + int port = 7;
  81 +
  82 + if (argc == 2)
  83 + {
  84 + std::istringstream iss{argv[1]};
  85 + iss >> port;
  86 + }
  87 +
  88 + try
  89 + {
  90 + lemoce::ServerSocket server{port};
  91 +
  92 + server.listen();
  93 +
  94 + std::list<
  95 + std::pair<std::shared_ptr<std::atomic<bool>>,
  96 + std::unique_ptr<std::thread>>> threads;
  97 + std::thread manager{threadManager, std::ref(threads)};
  98 +
  99 +
  100 + for(;;)
  101 + {
  102 +
  103 + std::unique_ptr<lemoce::ClientSocket> client_ptr{new lemoce::ClientSocket{}};
  104 +
  105 + try
  106 + {
  107 + server.accept((*client_ptr));
  108 + }
  109 + catch (lemoce::SocketException & ex)
  110 + {
  111 + if (ex.getErrno() == EINTR)
  112 + {
  113 + (*client_ptr).close();
  114 + std::cout << "fechei conexao pela excecao de interrupcao" << std::endl;
  115 + continue;
  116 + }
  117 + else
  118 + {
  119 + throw ex;
  120 + }
  121 + }
  122 +
  123 + std::shared_ptr<std::atomic<bool>> done{new std::atomic<bool>(false)};
  124 + std::unique_ptr<std::thread> thread{new std::thread
  125 + {
  126 + echoServerTask,
  127 + std::move(client_ptr),
  128 + done
  129 + }};
  130 +
  131 + threads.push_back(std::make_pair(done, std::move(thread)));
  132 +
  133 + }
  134 + }
  135 + catch (lemoce::SocketException& ex)
  136 + {
  137 + std::cout << ex.getMessage() << std::endl;
  138 + }
  139 +
  140 + return 0;
  141 +}
... ...
src/utils/http_get.cpp 0 → 100644
  1 +++ a/src/utils/http_get.cpp
... ... @@ -0,0 +1,52 @@
  1 +#include <string.h>
  2 +
  3 +#include "socket.h"
  4 +
  5 +#include <iostream>
  6 +#include <sstream>
  7 +#include <string>
  8 +#include <memory>
  9 +
  10 +int main(int argc, char *argv[])
  11 +{
  12 +
  13 + int MAX_BUFFER = 8192;
  14 +
  15 + if (argc != 3)
  16 + {
  17 + std::cerr << "usage: http_get <ip> <porta>" << std::endl;
  18 + return -1;
  19 + }
  20 +
  21 + int porta;
  22 + std::istringstream iss{std::string{argv[2]}};
  23 + iss >> porta;
  24 +
  25 + lemoce::ClientSocket client{std::string{argv[1]}, porta};
  26 +
  27 + std::cout << client.getRemoteHost() << std::endl;
  28 + std::cout << client.getRemotePort() << std::endl;
  29 +
  30 + try
  31 + {
  32 + client.connect();
  33 + client.write("GET / HTTP/1.0\r\n\r\n");
  34 +
  35 + std::unique_ptr<std::string> response = client.read();
  36 + std::cout << *response << std::endl;
  37 + client.close();
  38 + }
  39 + catch(lemoce::SocketException& e)
  40 + {
  41 + std::cout << e.getErrno() << std::endl;
  42 + std::cout << e.getMessage() << std::endl;
  43 + try
  44 + {
  45 + client.close();
  46 + }
  47 + catch(std::exception& ex)
  48 + { }
  49 + }
  50 +
  51 + return 0;
  52 +}
... ...
src/utils/tcptunnel.cpp 0 → 100644
  1 +++ a/src/utils/tcptunnel.cpp
... ... @@ -0,0 +1,170 @@
  1 +
  2 +#include <string.h>
  3 +#include <sstream>
  4 +#include <iostream>
  5 +#include <thread>
  6 +#include <list>
  7 +#include <chrono>
  8 +#include <future>
  9 +#include <memory>
  10 +#include <utility>
  11 +
  12 +#include "config.h"
  13 +#include "socket.h"
  14 +
  15 +
  16 +void threadManager(std::list<std::pair<std::shared_ptr<std::atomic<bool>>, std::unique_ptr<std::thread>>> & threads)
  17 +{
  18 + std::cout << "iniciei gerenciador de threads" << std::endl;
  19 + while(true)
  20 + {
  21 + std::this_thread::sleep_for(std::chrono::seconds(30));
  22 + std::cout << "realizando limpeza das threads (size = " << threads.size() << ")" << std::endl;
  23 + int i = 0;
  24 + std::list<std::pair<std::shared_ptr<std::atomic<bool>>, std::unique_ptr<std::thread>>>::iterator it;
  25 + for(it = threads.begin(); it != threads.end(); ++i)
  26 + {
  27 + if ((*(it->first)))
  28 + {
  29 + (it->first).reset();
  30 + (it->second)->join();
  31 + (it->second).reset();
  32 + it = threads.erase(it);
  33 + std::cout << "removi thread inutilizada " << (i+1) << std::endl;
  34 + }
  35 + else
  36 + {
  37 + ++it;
  38 + }
  39 + }
  40 + }
  41 +
  42 +}
  43 +
  44 +void tunnelingTask(std::unique_ptr<lemoce::ClientSocket> server_ptr,
  45 + std::unique_ptr<lemoce::ClientSocket> client_ptr,
  46 + std::shared_ptr<std::atomic<bool>> done)
  47 +{
  48 +
  49 + lemoce::ClientSocket server = *server_ptr;
  50 + lemoce::ClientSocket client = *client_ptr;
  51 +
  52 + try
  53 + {
  54 + std::cout << "iniciei thread de tunneling" << std::endl;
  55 + while(!server.isClosed())
  56 + {
  57 +
  58 + std::unique_ptr<std::string> incomingMessage = client.read();
  59 + if ((*incomingMessage).size() == 0)
  60 + {
  61 + server.close();
  62 + client.close();
  63 + break;
  64 + }
  65 + std::cout << " ==> " << (*incomingMessage) << std::endl;
  66 +
  67 + std::string * tmpMessage = incomingMessage.get();
  68 +
  69 + server.write((*tmpMessage));
  70 + std::cout << (*tmpMessage) << " ==>" << std::endl;
  71 + std::unique_ptr<std::string> responseMessage = server.read();
  72 + if ((*responseMessage).size() == 0)
  73 + {
  74 + server.close();
  75 + client.close();
  76 + break;
  77 + }
  78 + std::cout << (*responseMessage) << " <==" << std::endl;
  79 +
  80 + tmpMessage = responseMessage.get();
  81 + client.write((*tmpMessage));
  82 + std::cout << " <== " << (*tmpMessage) << std::endl;
  83 + }
  84 + }
  85 + catch (lemoce::SocketException & ex)
  86 + {
  87 + server.close();
  88 + client.close();
  89 + }
  90 + std::cout << "terminei a thread" << std::endl;
  91 + (*done) = true;
  92 +}
  93 +
  94 +
  95 +int main(int argc, char *argv[])
  96 +{
  97 +
  98 + if (argc != 4)
  99 + {
  100 + std::cout << "uso errado" << std::endl;
  101 + return -1;
  102 + }
  103 +
  104 + std::istringstream listenPortStream{argv[1]};
  105 + std::istringstream connectPortStream{argv[3]};
  106 +
  107 + int MAX_BUFFER = 8192;
  108 + int listeningPort, remotePort;
  109 +
  110 + listenPortStream >> listeningPort;
  111 + connectPortStream >> remotePort;
  112 +
  113 + std::string remoteHost{argv[2]};
  114 +
  115 + try
  116 + {
  117 + lemoce::ServerSocket server{listeningPort};
  118 + server.listen();
  119 +
  120 + std::list<
  121 + std::pair<std::shared_ptr<std::atomic<bool>>,
  122 + std::unique_ptr<std::thread>>> threads;
  123 + std::thread manager{threadManager, std::ref(threads)};
  124 +
  125 + for (;;)
  126 + {
  127 +
  128 + std::unique_ptr<lemoce::ClientSocket> client_ptr{new lemoce::ClientSocket{}};
  129 + std::unique_ptr<lemoce::ClientSocket> remoteClient_ptr;
  130 +
  131 + try
  132 + {
  133 + server.accept((*client_ptr));
  134 + remoteClient_ptr.reset(new lemoce::ClientSocket{remoteHost, remotePort});
  135 + (*remoteClient_ptr).connect();
  136 + std::cout << "conectei com o servidor remoto" << std::endl;
  137 + }
  138 + catch (lemoce::SocketException & ex)
  139 + {
  140 + if (ex.getErrno() == EINTR)
  141 + {
  142 + (*remoteClient_ptr).close();
  143 + std::cout << "fechei conexao pela excecao de interrupcao" << std::endl;
  144 + continue;
  145 + }
  146 + else
  147 + {
  148 + throw ex;
  149 + }
  150 + }
  151 +
  152 + std::shared_ptr<std::atomic<bool>> done{new std::atomic<bool>(false)};
  153 + std::unique_ptr<std::thread> thread{new std::thread
  154 + {
  155 + tunnelingTask, std::move(remoteClient_ptr),
  156 + std::move(client_ptr),
  157 + done
  158 + }};
  159 +
  160 + threads.push_back(std::make_pair(done, std::move(thread)));
  161 + }
  162 + }
  163 + catch (lemoce::SocketException & ex)
  164 + {
  165 + std::cout << ex.getMessage() << std::endl;
  166 + }
  167 +
  168 +
  169 + return 0;
  170 +}
... ...
test/CMakeLists.txt 0 → 100644
  1 +++ a/test/CMakeLists.txt
... ... @@ -0,0 +1,7 @@
  1 +find_package (Catch REQUIRED)
  2 +
  3 +include_directories (${CATCH_INCLUDE_DIRS})
  4 +
  5 +add_executable (main main.cpp)
  6 +set_property(TARGET main PROPERTY CXX_STANDARD 11)
  7 +
... ...
test/main.cpp 0 → 100644
  1 +++ a/test/main.cpp
... ... @@ -0,0 +1,8 @@
  1 +#define CATCH_CONFIG_MAIN
  2 +#include <catch.hpp>
  3 +
  4 +TEST_CASE("test")
  5 +{
  6 + REQUIRE(true);
  7 +}
  8 +
... ...