SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

20.10.2013 - Modified PIObject - virtual debugName() for macro piCoutObj, improved timer measurements and timers on Windows

Browse Source
This commit is contained in:
peri4
2013-10-20 17:41:55 +04:00
parent 0f1b528ac6
commit ec5530053a
32 changed files with 2196 additions and 1331 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CMakeLists.txt
View File

@@ -68,7 +68,10 @@ else ()
add_definitions("-ftemplate-depth-32") add_definitions("-ftemplate-depth-32")
add_library(pip STATIC ${CPPS}) add_library(pip STATIC ${CPPS})
else () else ()
list(APPEND LIBS pthread rt) list(APPEND LIBS pthread)
if (NOT APPLE)
list(APPEND LIBS rt)
endif()
add_definitions("-Wall -g3") add_definitions("-Wall -g3")
add_library(pip SHARED ${CPPS}) add_library(pip SHARED ${CPPS})
endif () endif ()

2530
Doxyfile
View File

@@ -1,104 +1,112 @@
# Doxyfile 1.8.3.1 # Doxyfile 1.8.5
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project.
# #
# All text after a hash (#) is considered a comment and will be ignored # All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is: # The format is:
# TAG = value [value, ...] # TAG = value [value, ...]
# For lists items can also be appended using: # For lists, items can also be appended using:
# TAG += value [value, ...] # TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ") # Values that contain spaces should be placed between quotes (\" \").
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Project related configuration options # Project related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file # This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all # that follow. The default is UTF-8 which is also the encoding used for all text
# text before the first occurrence of this tag. Doxygen uses libiconv (or the # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# iconv built into libc) for the transcoding. See # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# http://www.gnu.org/software/libiconv for the list of possible encodings. # for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8 DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or sequence of words) that should # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# identify the project. Note that if you do not use Doxywizard you need # double-quotes, unless you are using Doxywizard) that should identify the
# to put quotes around the project name if it contains spaces. # project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = PIP PROJECT_NAME = PIP
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# This could be handy for archiving the generated documentation or # could be handy for archiving the generated documentation or if some version
# if some version control system is used. # control system is used.
PROJECT_NUMBER = 0.3.6 PROJECT_NUMBER = 0.3.6
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer # for a project that appears at the top of each page and should give viewer a
# a quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Platform-Independent Primitives" PROJECT_BRIEF = "Platform-Independent Primitives"
# With the PROJECT_LOGO tag one can specify an logo or icon that is # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# included in the documentation. The maximum height of the logo should not # the documentation. The maximum height of the logo should not exceed 55 pixels
# exceed 55 pixels and the maximum width should not exceed 200 pixels. # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# Doxygen will copy the logo to the output directory. # to the output directory.
PROJECT_LOGO = PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# base path where the generated documentation will be put. # into which the generated documentation will be written. If a relative path is
# If a relative path is entered, it will be relative to the location # entered, it will be relative to the location where doxygen was started. If
# where doxygen was started. If left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = doc OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# 4096 sub-directories (in 2 levels) under the output directory of each output # directories (in 2 levels) under the output directory of each output format and
# format and will distribute the generated files over these directories. # will distribute the generated files over these directories. Enabling this
# Enabling this option can be useful when feeding doxygen a huge amount of # option can be useful when feeding doxygen a huge amount of source files, where
# source files, where putting all generated files in the same directory would # putting all generated files in the same directory would otherwise causes
# otherwise cause performance problems for the file system. # performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all # The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this # documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language. # information to generate all constant output in the proper language.
# The default language is English, other supported languages are: # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, # Turkish, Ukrainian and Vietnamese.
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. # The default value is: English.
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
# include brief member descriptions after the members that are listed in # descriptions after the members that are listed in the file and class
# the file and class documentation (similar to JavaDoc). # documentation (similar to Javadoc). Set to NO to disable this.
# Set to NO to disable this. # The default value is: YES.
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# the brief description of a member or function before the detailed description. # description of a member or function before the detailed description
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the #
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed. # brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator # This tag implements a quasi-intelligent brief description abbreviator that is
# that is used to form the text in various listings. Each string # used to form the text in various listings. Each string in this list, if found
# in this list, if found as the leading text of the brief description, will be # as the leading text of the brief description, will be stripped from the text
# stripped from the text and the result after processing the whole list, is # and the result, after processing the whole list, is used as the annotated
# used as the annotated text. Otherwise, the brief description is used as-is. # text. Otherwise, the brief description is used as-is. If left blank, the
# If left blank, the following values are used ("$name" is automatically # following values are used ($name is automatically replaced with the name of
# replaced with the name of the entity): "The $name class" "The $name widget" # the entity):The $name class, The $name widget, The $name file, is, provides,
# "The $name file" "is" "provides" "specifies" "contains" # specifies, contains, represents, a, an and the.
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = "The $name class" \ ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \ "The $name widget" \
@@ -112,259 +120,279 @@ ABBREVIATE_BRIEF = "The $name class" \
an \ an \
the the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief # doxygen will generate a detailed section even if there is only a brief
# description. # description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those # inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment # members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown. # operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
# path before files name in the file list and in the header files. If set # before files name in the file list and in the header files. If set to NO the
# to NO the shortest path that makes the file name unique will be used. # shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# can be used to strip a user-defined part of the path. Stripping is # Stripping is only done if one of the specified strings matches the left-hand
# only done if one of the specified strings matches the left-hand part of # part of the path. The tag can be used to show relative paths in the file list.
# the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to
# If left blank the directory from which doxygen is run is used as the # strip.
# path to strip. Note that you specify absolute paths here, but also #
# relative paths, which will be relative from the directory where doxygen is # Note that you can specify absolute paths here, but also relative paths, which
# started. # will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH = STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# the path mentioned in the documentation of a class, which tells # path mentioned in the documentation of a class, which tells the reader which
# the reader which header file to include in order to use a class. # header file to include in order to use a class. If left blank only the name of
# If left blank only the name of the header file containing the class # the header file containing the class definition is used. Otherwise one should
# definition is used. Otherwise one should specify the include paths that # specify the list of include paths that are normally passed to the compiler
# are normally passed to the compiler using the -I flag. # using the -I flag.
STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# (but less readable) file names. This can be useful if your file system # less readable) file names. This can be useful is your file systems doesn't
# doesn't support long names like on DOS, Mac, or CD-ROM. # support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# will interpret the first line (until the first dot) of a JavaDoc-style # first line (until the first dot) of a Javadoc-style comment as the brief
# comment as the brief description. If set to NO, the JavaDoc # description. If set to NO, the Javadoc-style will behave just like regular Qt-
# comments will behave just like regular Qt-style comments # style comments (thus requiring an explicit @brief command for a brief
# (thus requiring an explicit @brief command for a brief description.) # description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# interpret the first line (until the first dot) of a Qt-style # line (until the first dot) of a Qt-style comment as the brief description. If
# comment as the brief description. If set to NO, the comments # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# will behave just like regular Qt-style comments (thus requiring # requiring an explicit \brief command for a brief description.)
# an explicit \brief command for a brief description.) # The default value is: NO.
QT_AUTOBRIEF = NO QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# treat a multi-line C++ special comment block (i.e. a block of //! or /// # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# comments) as a brief description. This used to be the default behaviour. # a brief description. This used to be the default behavior. The new default is
# The new default is to treat a multi-line C++ comment block as a detailed # to treat a multi-line C++ comment block as a detailed description. Set this
# description. Set this tag to YES if you prefer the old behaviour instead. # tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# member inherits the documentation from any documented member that it # documentation from any documented member that it re-implements.
# re-implements. # The default value is: YES.
INHERIT_DOCS = YES INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
# a new page for each member. If set to NO, the documentation of a member will # new page for each member. If set to NO, the documentation of a member will be
# be part of the file/class/namespace that contains it. # part of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# Doxygen uses this value to replace tabs by spaces in code fragments. # uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4 TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts # This tag can be used to specify a number of aliases that act as commands in
# as commands in the documentation. An alias has the form "name=value". # the documentation. An alias has the form:
# For example adding "sideeffect=\par Side Effects:\n" will allow you to # name=value
# put the command \sideeffect (or @sideeffect) in the documentation, which # For example adding
# will result in a user-defined paragraph with heading "Side Effects:". # "sideeffect=@par Side Effects:\n"
# You can put \n's in the value part of an alias to insert newlines. # will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = "handlers=\name Handlers" \ ALIASES = "handlers=\name Handlers" \
"vhandlers=\name Virtual handlers" \ "vhandlers=\name Virtual handlers" \
"events=\name Events" "events=\name Events"
# This tag can be used to specify a number of word-keyword mappings (TCL only). # This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding # A mapping has the form "name=value". For example adding "class=itcl::class"
# "class=itcl::class" will allow you to use the command class in the # will allow you to use the command class in the itcl::class meaning.
# itcl::class meaning.
TCL_SUBST = TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# sources only. Doxygen will then generate output that is more tailored for C. # only. Doxygen will then generate output that is more tailored for C. For
# For instance, some of the names that are used will be different. The list # instance, some of the names that are used will be different. The list of all
# of all members will be omitted, etc. # members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# sources only. Doxygen will then generate output that is more tailored for # Python sources only. Doxygen will then generate output that is more tailored
# Java. For instance, namespaces will be presented as packages, qualified # for that language. For instance, namespaces will be presented as packages,
# scopes will look different, etc. # qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for # sources. Doxygen will then generate output that is tailored for Fortran.
# Fortran. # The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for # sources. Doxygen will then generate output that is tailored for VHDL.
# VHDL. # The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it # Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given # parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it # extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, # using this tag. The format is ext=language, where ext is a file extension, and
# and language is one of the parsers supported by doxygen: IDL, Java, # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
# C++. For instance to make doxygen treat .inc files as Fortran files (default # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note # (default is Fortran), use: inc=Fortran f=C.
# that for custom extensions you also need to set FILE_PATTERNS otherwise the #
# files are not read by doxygen. # Note For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING = EXTENSION_MAPPING =
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# comments according to the Markdown format, which allows for more readable # according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details. # documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you # The output of markdown processing is further processed by doxygen, so you can
# can mix doxygen, HTML, and XML commands with Markdown formatting. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# Disable only in case of backward compatibilities issues. # case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented classes, # When enabled doxygen tries to link words that correspond to documented
# or namespaces to their corresponding documentation. Such a link can be # classes, or namespaces to their corresponding documentation. Such a link can
# prevented in individual cases by by putting a % sign in front of the word or # be prevented in individual cases by by putting a % sign in front of the word
# globally by setting AUTOLINK_SUPPORT to NO. # or globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should # to include (a tag file for) the STL sources as input, then you should set this
# set this tag to YES in order to let doxygen match functions declarations and # tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # definitions whose arguments contain STL classes (e.g. func(std::string);
# func(std::string) {}). This also makes the inheritance and collaboration # versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate. # diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to # If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support. # enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# Doxygen will parse them like normal C++ but will assume all classes use public # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# instead of private inheritance when no explicit protection keyword is present. # will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate # For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES (the # getter and setter methods for a property. Setting this option to YES will make
# default) will make doxygen replace the get and set methods by a property in # doxygen to replace the get and set methods by a property in the documentation.
# the documentation. This will only work if the methods are indeed getting or # This will only work if the methods are indeed getting or setting a simple
# setting a simple type. If this is not the case, or you want to show the # type. If this is not the case, or you want to show the methods anyway, you
# methods anyway, you should set this option to NO. # should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = NO IDL_PROPERTY_SUPPORT = NO
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first # tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default # member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly. # all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of # Set the SUBGROUPING tag to YES to allow class member groups of the same type
# the same type (for instance a group of public functions) to be put as a # (for instance a group of public functions) to be put as a subgroup of that
# subgroup of that type (e.g. under the Public Functions section). Set it to # type (e.g. under the Public Functions section). Set it to NO to prevent
# NO to prevent subgrouping. Alternatively, this can be done per class using # subgrouping. Alternatively, this can be done per class using the
# the \nosubgrouping command. # \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = NO SUBGROUPING = NO
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# unions are shown inside the group in which they are included (e.g. using # are shown inside the group in which they are included (e.g. using \ingroup)
# @ingroup) instead of on a separate page (for HTML and Man pages) or # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# section (for LaTeX and RTF). # and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# unions with only public data fields will be shown inline in the documentation # with only public data fields or simple typedef fields will be shown inline in
# of the scope in which they are defined (i.e. file, namespace, or group # the documentation of the scope in which they are defined (i.e. file,
# documentation), provided this scope is documented. If set to NO (the default), # namespace, or group documentation), provided this scope is documented. If set
# structs, classes, and unions are shown on a separate page (for HTML and Man # to NO, structs, classes, and unions are shown on a separate page (for HTML and
# pages) or section (for LaTeX and RTF). # Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# is documented as struct, union, or enum with the name of the typedef. So # enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file, # with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically # namespace, or class. And the struct will be named TypeS. This can typically be
# be useful for C code in case the coding convention dictates that all compound # useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name. # types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# determine which symbols to keep in memory and which to flush to disk. # cache is used to resolve symbols given their name and scope. Since this can be
# When the cache is full, less often used symbols will be written to disk. # an expensive process and often the same symbol appears multiple times in the
# For small to medium size projects (<1000 input files) the default value is # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# probably good enough. For larger projects a too small cache size can cause # doxygen will become slower. If the cache is too large, memory is wasted. The
# doxygen to be busy swapping symbols to and from disk most of the time # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# causing a significant performance penalty. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# If the system has enough physical memory increasing the cache will improve the # symbols. At the end of a run doxygen will report the cache usage and suggest
# performance by keeping more symbols in memory. Note that the value works on # the optimal cache size from a speed point of view.
# a logarithmic scale so increasing the size by one will roughly double the # Minimum value: 0, maximum value: 9, default value: 0.
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
# their name and scope. Since this can be an expensive process and often the
# same symbol appear multiple times in the code, doxygen keeps a cache of
# pre-resolved symbols. If the cache is too small doxygen will become slower.
# If the cache is too large, memory is wasted. The cache size is given by this
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols.
LOOKUP_CACHE_SIZE = 0 LOOKUP_CACHE_SIZE = 0
@@ -372,330 +400,370 @@ LOOKUP_CACHE_SIZE = 0
# Build related configuration options # Build related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. # documentation are documented, even if no documentation was available. Private
# Private class members and static file members will be hidden unless # class members and static file members will be hidden unless the
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
# will be included in the documentation. # be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation. # scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# will be included in the documentation. # included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = NO EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# defined locally in source files will be included in the documentation. # locally in source files will be included in the documentation. If set to NO
# If set to NO only classes defined in header files are included. # only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. When set to YES local # This flag is only useful for Objective-C code. When set to YES local methods,
# methods, which are defined in the implementation section but not in # which are defined in the implementation section but not in the interface are
# the interface are included in the documentation. # included in the documentation. If set to NO only methods in the interface are
# If set to NO (the default) only methods in the interface are included. # included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = YES EXTRACT_LOCAL_METHODS = YES
# If this flag is set to YES, the members of anonymous namespaces will be # If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called # extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base # 'anonymous_namespace{file}', where file will be replaced with the base name of
# name of the file that contains the anonymous namespace. By default # the file that contains the anonymous namespace. By default anonymous namespace
# anonymous namespaces are hidden. # are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members of documented classes, files or namespaces. # undocumented members inside documented classes or files. If set to NO these
# If set to NO (the default) these members will be included in the # members will be included in the various overviews, but no documentation
# various overviews, but no documentation section is generated. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
# This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO.
HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. # undocumented classes that are normally visible in the class hierarchy. If set
# If set to NO (the default) these classes will be included in the various # to NO these classes will be included in the various overviews. This option has
# overviews. This option has no effect if EXTRACT_ALL is enabled. # no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = YES HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# friend (class|struct|union) declarations. # (class|struct|union) declarations. If set to NO these declarations will be
# If set to NO (the default) these declarations will be included in the # included in the documentation.
# documentation. # The default value is: NO.
HIDE_FRIEND_COMPOUNDS = YES HIDE_FRIEND_COMPOUNDS = YES
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. # documentation blocks found inside the body of a function. If set to NO these
# If set to NO (the default) these blocks will be appended to the # blocks will be appended to the function's detailed documentation block.
# function's detailed documentation block. # The default value is: NO.
HIDE_IN_BODY_DOCS = NO HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation # The INTERNAL_DOCS tag determines if documentation that is typed after a
# that is typed after a \internal command is included. If the tag is set # \internal command is included. If the tag is set to NO then the documentation
# to NO (the default) then the documentation will be excluded. # will be excluded. Set it to YES to include the internal documentation.
# Set it to YES to include the internal documentation. # The default value is: NO.
INTERNAL_DOCS = NO INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# file names in lower-case letters. If set to YES upper-case letters are also # names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ # allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows # in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO. # and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = NO CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# will show members with their full class and namespace scopes in the # their full class and namespace scopes in the documentation. If set to YES the
# documentation. If set to YES the scope will be hidden. # scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# will put a list of the files that are included by a file in the documentation # the files that are included by a file in the documentation of that file.
# of that file. # The default value is: YES.
SHOW_INCLUDE_FILES = NO SHOW_INCLUDE_FILES = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# will list include files with double quotes in the documentation # files with double quotes in the documentation rather than with sharp brackets.
# rather than with sharp brackets. # The default value is: NO.
FORCE_LOCAL_INCLUDES = NO FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# is inserted in the documentation for inline members. # documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# will sort the (detailed) documentation of file and class members # (detailed) documentation of file and class members alphabetically by member
# alphabetically by member name. If set to NO the members will appear in # name. If set to NO the members will appear in declaration order.
# declaration order. # The default value is: YES.
SORT_MEMBER_DOCS = NO SORT_MEMBER_DOCS = NO
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# brief documentation of file, namespace and class members alphabetically # descriptions of file, namespace and class members alphabetically by member
# by member name. If set to NO (the default) the members will appear in # name. If set to NO the members will appear in declaration order.
# declaration order. # The default value is: NO.
SORT_BRIEF_DOCS = NO SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# will sort the (brief and detailed) documentation of class members so that # (brief and detailed) documentation of class members so that constructors and
# constructors and destructors are listed first. If set to NO (the default) # destructors are listed first. If set to NO the constructors will appear in the
# the constructors will appear in the respective orders defined by # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO # member documentation.
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# hierarchy of group names into alphabetical order. If set to NO (the default) # of group names into alphabetical order. If set to NO the group names will
# the group names will appear in their defined order. # appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# sorted by fully-qualified names, including namespaces. If set to # fully-qualified names, including namespaces. If set to NO, the class list will
# NO (the default), the class list will be sorted only by class name, # be sorted only by class name, not including the namespace part.
# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical
# Note: This option applies only to the class list, not to the # list.
# alphabetical list. # The default value is: NO.
SORT_BY_SCOPE_NAME = NO SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# do proper type resolution of all parameters of a function it will reject a # type resolution of all parameters of a function it will reject a match between
# match between the prototype and the implementation of a member function even # the prototype and the implementation of a member function even if there is
# if there is only one candidate or it is obvious which candidate to choose # only one candidate or it is obvious which candidate to choose by doing a
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# will still accept a match between prototype and implementation in such cases. # accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
# disable (NO) the todo list. This list is created by putting \todo # todo list. This list is created by putting \todo commands in the
# commands in the documentation. # documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
# disable (NO) the test list. This list is created by putting \test # test list. This list is created by putting \test commands in the
# commands in the documentation. # documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
# disable (NO) the bug list. This list is created by putting \bug # list. This list is created by putting \bug commands in the documentation.
# commands in the documentation. # The default value is: YES.
GENERATE_BUGLIST = YES GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
# disable (NO) the deprecated list. This list is created by putting # the deprecated list. This list is created by putting \deprecated commands in
# \deprecated commands in the documentation. # the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional # The ENABLED_SECTIONS tag can be used to enable conditional documentation
# documentation sections, marked by \if section-label ... \endif # sections, marked by \if <section_label> ... \endif and \cond <section_label>
# and \cond section-label ... \endcond blocks. # ... \endcond blocks.
ENABLED_SECTIONS = ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# the initial value of a variable or macro consists of for it to appear in # initial value of a variable or macro / define can have for it to appear in the
# the documentation. If the initializer consists of more lines than specified # documentation. If the initializer consists of more lines than specified here
# here it will be hidden. Use a value of 0 to hide initializers completely. # it will be hidden. Use a value of 0 to hide initializers completely. The
# The appearance of the initializer of individual variables and macros in the # appearance of the value of individual variables and macros / defines can be
# documentation can be controlled using \showinitializer or \hideinitializer # controlled using \showinitializer or \hideinitializer command in the
# command in the documentation regardless of this setting. # documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30 MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# at the bottom of the documentation of classes and structs. If set to YES the # the bottom of the documentation of classes and structs. If set to YES the list
# list will mention the files that were used to generate the documentation. # will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = NO SHOW_USED_FILES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# This will remove the Files entry from the Quick Index and from the # will remove the Files entry from the Quick Index and from the Folder Tree View
# Folder Tree View (if specified). The default is YES. # (if specified).
# The default value is: YES.
SHOW_FILES = YES SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# Namespaces page. This will remove the Namespaces entry from the Quick Index # page. This will remove the Namespaces entry from the Quick Index and from the
# and from the Folder Tree View (if specified). The default is YES. # Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that # The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from # doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via # the version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of # popen()) the command command input-file, where command is the value of the
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# provided by doxygen. Whatever the program writes to standard output # by doxygen. Whatever the program writes to standard output is used as the file
# is used as the file version. See the manual for examples. # version. For an example see the documentation.
FILE_VERSION_FILTER = FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated # by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file # output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. # that represents doxygen's defaults, run doxygen with the -l option. You can
# You can optionally specify a file name after the option, if omitted # optionally specify a file name after the option, if omitted DoxygenLayout.xml
# DoxygenLayout.xml will be used as the name of the layout file. # will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE = LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# containing the references data. This must be a list of .bib files. The # the reference definitions. This must be a list of .bib files. The .bib
# .bib extension is automatically appended if omitted. Using this command # extension is automatically appended if omitted. This requires the bibtex tool
# requires the bibtex tool to be installed. See also # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style # For LaTeX the style of the bibliography can be controlled using
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# feature you need bibtex and perl available in the search path. Do not use # search path. Do not use file names with spaces, bibtex cannot handle them. See
# file names with spaces, bibtex cannot handle them. # also \cite for info how to create references.
CITE_BIB_FILES = CITE_BIB_FILES =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to warning and progress messages # Configuration options related to warning and progress messages
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated # The QUIET tag can be used to turn on/off the messages that are generated to
# by doxygen. Possible values are YES and NO. If left blank NO is used. # standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are # The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# NO is used. # this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# automatically be disabled. # will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some # potential errors in the documentation, such as not documenting some parameters
# parameters in a documented function, or documenting parameters that # in a documented function, or documenting parameters that don't exist or using
# don't exist or using markup commands wrongly. # markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = YES
# The WARN_NO_PARAMDOC option can be enabled to get warnings for # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# functions that are documented, but have no documentation for their parameters # are documented, but have no documentation for their parameters or return
# or return value. If set to NO (the default) doxygen will only warn about # value. If set to NO doxygen will only warn about wrong or incomplete parameter
# wrong or incomplete parameter documentation, but not about the absence of # documentation, but not about the absence of documentation.
# documentation. # The default value is: NO.
WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that # The WARN_FORMAT tag determines the format of the warning messages that doxygen
# doxygen can produce. The string should contain the $file, $line, and $text # can produce. The string should contain the $file, $line, and $text tags, which
# tags, which will be replaced by the file and line number from which the # will be replaced by the file and line number from which the warning originated
# warning originated and the warning text. Optionally the format may contain # and the warning text. Optionally the format may contain $version, which will
# $version, which will be replaced by the version of the file (if it could # be replaced by the version of the file (if it could be obtained via
# be obtained via FILE_VERSION_FILTER) # FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning # The WARN_LOGFILE tag can be used to specify a file to which warning and error
# and error messages should be written. If left blank the output is written # messages should be written. If left blank the output is written to standard
# to stderr. # error (stderr).
WARN_LOGFILE = WARN_LOGFILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # Configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain # The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or # documented source files. You may enter file names like myfile.cpp or
# directories like "/usr/src/myproject". Separate the files or directories # directories like /usr/src/myproject. Separate the files or directories with
# with spaces. # spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = . INPUT = .
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# also the default input encoding. Doxygen uses libiconv (or the iconv built # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # documentation (see: http://www.gnu.org/software/libiconv) for the list of
# the list of possible encodings. # possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# and *.h) to filter out the source-files in the directories. If left # *.h) to filter out the source-files in the directories. If left blank the
# blank the following patterns are tested: # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.f90 *.f *.for *.vhd *.vhdl # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.c \
*.cc \ *.cc \
@@ -732,845 +800,1135 @@ FILE_PATTERNS = *.c \
*.vhd \ *.vhd \
*.vhdl *.vhdl
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # The RECURSIVE tag can be used to specify whether or not subdirectories should
# should be searched for input files as well. Possible values are YES and NO. # be searched for input files as well.
# If left blank NO is used. # The default value is: NO.
RECURSIVE = NO RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should be # The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
# Note that relative paths are relative to the directory from which doxygen is #
# Note that relative paths are relative to the directory from which doxygen is
# run. # run.
EXCLUDE = EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded # directories that are symbolic links (a Unix file system feature) are excluded
# from the input. # from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched # certain files from those directories.
# against the file with absolute path, so to exclude all test directories #
# for example use the pattern */test/* # Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the # (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the # output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass, # wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test # AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS = EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or # The EXAMPLE_PATH tag can be used to specify one or more files or directories
# directories that contain example code fragments that are included (see # that contain example code fragments that are included (see the \include
# the \include command). # command).
EXAMPLE_PATH = doc/examples EXAMPLE_PATH = doc/examples
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# and *.h) to filter out the source-files in the directories. If left # *.h) to filter out the source-files in the directories. If left blank all
# blank all files are included. # files are included.
EXAMPLE_PATTERNS = * EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude # searched for input files to be used with the \include or \dontinclude commands
# commands irrespective of the value of the RECURSIVE tag. # irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used. # The default value is: NO.
EXAMPLE_RECURSIVE = NO EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or # The IMAGE_PATH tag can be used to specify one or more files or directories
# directories that contain image that are included in the documentation (see # that contain images that are to be included in the documentation (see the
# the \image command). # \image command).
IMAGE_PATH = IMAGE_PATH = doc/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should # The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program # invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter> # by executing (via popen()) the command:
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an #
# input file. Doxygen will then use the output that the filter program writes # <filter> <input-file>
# to standard output. If FILTER_PATTERNS is specified, this tag will be #
# ignored. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
INPUT_FILTER = INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the # basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: # filter if there is a match. The filters are a list of the form: pattern=filter
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# info on how filters are used. If FILTER_PATTERNS is empty or if # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# non of the patterns match the file name, INPUT_FILTER is applied. # patterns match the file name, INPUT_FILTER is applied.
FILTER_PATTERNS = FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source # INPUT_FILTER ) will also be used to filter the input files that are used for
# files to browse (i.e. when SOURCE_BROWSER is set to YES). # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# and it is also possible to disable source filtering for a specific pattern # it is also possible to disable source filtering for a specific pattern using
# using *.ext= (so without naming a filter). This option only has effect when # *.ext= (so without naming a filter).
# FILTER_SOURCE_FILES is enabled. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS = FILTER_SOURCE_PATTERNS =
# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page (index.html). # is part of the input, its contents will be placed on the main page
# This can be useful if you have a project on for instance GitHub and want reuse # (index.html). This can be useful if you have a project on for instance GitHub
# the introduction page also for the doxygen output. # and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = USE_MDFILE_AS_MAINPAGE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to source browsing # Configuration options related to source browsing
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# be generated. Documented entities will be cross-referenced with these sources. # generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also #
# VERBATIM_HEADERS is set to NO. # Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body # Setting the INLINE_SOURCES tag to YES will include the body of functions,
# of functions and classes directly in the documentation. # classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# doxygen to hide any special comment blocks from generated source code # special comment blocks from generated source code fragments. Normal C, C++ and
# fragments. Normal C, C++ and Fortran comments will always remain visible. # Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# then for each documented function all documented # function all documented functions referencing it will be listed.
# functions referencing it will be listed. # The default value is: NO.
REFERENCED_BY_RELATION = NO REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES # If the REFERENCES_RELATION tag is set to YES then for each documented function
# then for each documented function all documented entities # all documented entities called/used by that function will be listed.
# called/used by that function will be listed. # The default value is: NO.
REFERENCES_RELATION = NO REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the source code. Otherwise they will link to the documentation. # link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# will point to the HTML generated by the htags(1) tool instead of doxygen # source code will show a tooltip with additional information such as prototype,
# built-in source browser. The htags tool is part of GNU's global source # brief description and links to the definition and documentation. Since this
# tagging system (see http://www.gnu.org/software/global/global.html). You # will make the HTML file larger and loading of large files a bit slower, you
# will need version 4.8.6 or higher. # can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# will generate a verbatim copy of the header file for each class for # verbatim copy of the header file for each class for which an include is
# which an include is specified. Set to NO to disable this. # specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = NO VERBATIM_HEADERS = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# compiled with the --with-libclang option.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the alphabetical class index # Configuration options related to the alphabetical class index
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# of all compounds will be generated. Enable this if the project # compounds will be generated. Enable this if the project contains a lot of
# contains a lot of classes, structs, unions or interfaces. # classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES ALPHABETICAL_INDEX = YES
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # which the alphabetical index list will be split.
# in which this list will be split (can be a number in the range [1..20]) # Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5 COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all # In case all classes in a project start with a common prefix, all classes will
# classes will be put under the same header in the alphabetical index. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # can be used to specify a prefix (or a list of prefixes) that should be ignored
# should be ignored while generating the index headers. # while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX = IGNORE_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the HTML output # Configuration options related to the HTML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# generate HTML output. # The default value is: YES.
GENERATE_HTML = YES GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# If a relative path is entered the value of OUTPUT_DIRECTORY will be # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# put in front of it. If left blank `html' will be used as the default path. # it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # generated HTML page (for example: .htm, .php, .asp).
# doxygen will generate files with .html extension. # The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If it is left blank doxygen will generate a # each generated HTML page. If the tag is left blank doxygen will generate a
# standard header. Note that when using a custom header you are responsible # standard header.
# for the proper inclusion of any scripts and style sheets that doxygen #
# needs, which is dependent on the configuration options used. # To get valid HTML the header file that includes any scripts and style sheets
# It is advised to generate a default header using "doxygen -w html # that doxygen needs, which is dependent on the configuration options used (e.g.
# header.html footer.html stylesheet.css YourConfigFile" and then modify # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# that header. Note that the header is subject to change so you typically # default header using
# have to redo this when upgrading to a newer version of doxygen or when # doxygen -w html new_header.html new_footer.html new_stylesheet.css
# changing the value of configuration settings such as GENERATE_TREEVIEW! # YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# each generated HTML page. If it is left blank doxygen will generate a # generated HTML page. If the tag is left blank doxygen will generate a standard
# standard footer. # footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# style sheet that is used by each HTML page. It can be used to # sheet that is used by each HTML page. It can be used to fine-tune the look of
# fine-tune the look of the HTML output. If left blank doxygen will # the HTML output. If left blank doxygen will generate a default style sheet.
# generate a default style sheet. Note that it is recommended to use # See also section "Doxygen usage" for information on how to generate the style
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this # sheet that doxygen normally uses.
# tag will in the future become obsolete. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
# user-defined cascading style sheet that is included after the standard # defined cascading style sheet that is included after the standard style sheets
# style sheets created by doxygen. Using this option one can overrule # created by doxygen. Using this option one can overrule certain style aspects.
# certain style aspects. This is preferred over using HTML_STYLESHEET # This is preferred over using HTML_STYLESHEET since it does not replace the
# since it does not replace the standard style sheet and is therefor more # standard style sheet and is therefor more robust against future updates.
# robust against future updates. Doxygen will copy the style sheet file to # Doxygen will copy the style sheet file to the output directory. For an example
# the output directory. # see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note # other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the # that these files will be copied to the base HTML output directory. Use the
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# the files will be copied as-is; there are no commands or markers available. # files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES = HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# Doxygen will adjust the colors in the style sheet and background images # will adjust the colors in the stylesheet and background images according to
# according to this color. Hue is specified as an angle on a colorwheel, # this color. Hue is specified as an angle on a colorwheel, see
# see http://en.wikipedia.org/wiki/Hue for more information. # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# For instance the value 0 represents red, 60 is yellow, 120 is green, # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. # purple, and 360 is red again.
# The allowed range is 0 to 359. # Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 246 HTML_COLORSTYLE_HUE = 246
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# the colors in the HTML output. For a value of 0 the output will use # in the HTML output. For a value of 0 the output will use grayscales only. A
# grayscales only. A value of 255 will produce the most vivid colors. # value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 79 HTML_COLORSTYLE_SAT = 79
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# the luminance component of the colors in the HTML output. Values below # luminance component of the colors in the HTML output. Values below 100
# 100 gradually make the output lighter, whereas values above 100 make # gradually make the output lighter, whereas values above 100 make the output
# the output darker. The value divided by 100 is the actual gamma applied, # darker. The value divided by 100 is the actual gamma applied, so 80 represents
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# and 100 does not change the gamma. # change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 75 HTML_COLORSTYLE_GAMMA = 75
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting # page will contain the date and time when the page was generated. Setting this
# this to NO can help when comparing the output of multiple runs. # to NO can help when comparing the output of multiple runs.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the # documentation will contain sections that can be hidden and shown after the
# page has loaded. # page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = YES HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# entries shown in the various tree structured indices initially; the user # shown in the various tree structured indices initially; the user can expand
# can expand and collapse entries dynamically later on. Doxygen will expand # and collapse entries dynamically later on. Doxygen will expand the tree to
# the tree to such a level that at most the specified number of entries are # such a level that at most the specified number of entries are visible (unless
# visible (unless a fully collapsed tree already exceeds this amount). # a fully collapsed tree already exceeds this amount). So setting the number of
# So setting the number of entries 1 will produce a full collapsed tree by # entries 1 will produce a full collapsed tree by default. 0 is a special value
# default. 0 is a special value representing an infinite number of entries # representing an infinite number of entries and will result in a full expanded
# and will result in a full expanded tree by default. # tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100 HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files # If the GENERATE_DOCSET tag is set to YES, additional index files will be
# will be generated that can be used as input for Apple's Xcode 3 # generated that can be used as input for Apple's Xcode 3 integrated development
# integrated development environment, introduced with OSX 10.5 (Leopard). # environment (see: http://developer.apple.com/tools/xcode/), introduced with
# To create a documentation set, doxygen will generate a Makefile in the # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# HTML output directory. Running make will produce the docset in that # Makefile in the HTML output directory. Running make will produce the docset in
# directory and running "make install" will install the docset in # that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# it at startup. # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information. # for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # This tag determines the name of the docset feed. A documentation feed provides
# feed. A documentation feed provides an umbrella under which multiple # an umbrella under which multiple documentation sets from a single provider
# documentation sets from a single provider (such as a company or product suite) # (such as a company or product suite) can be grouped.
# can be grouped. # The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # This tag specifies a string that should uniquely identify the documentation
# should uniquely identify the documentation set bundle. This should be a # set bundle. This should be a reverse domain-name style string, e.g.
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# will append .docset to the name. # The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project DOCSET_BUNDLE_ID = org.doxygen.Project
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# identify the documentation publisher. This should be a reverse domain-name # the documentation publisher. This should be a reverse domain-name style
# style string, e.g. com.mycompany.MyDocSet.documentation. # string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES, additional index files # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# will be generated that can be used as input for tools like the # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# of the generated HTML documentation. # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # The CHM_FILE tag can be used to specify the file name of the resulting .chm
# be used to specify the file name of the resulting .chm file. You # file. You can add a path in front of the file if the result should not be
# can add a path in front of the file if the result should not be
# written to the html output directory. # written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE = CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # The HHC_LOCATION tag can be used to specify the location (absolute path
# be used to specify the location (absolute path including file name) of # including file name) of the HTML help compiler ( hhc.exe). If non-empty
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # doxygen will try to run the HTML help compiler on the generated index.hhp.
# the HTML help compiler on the generated index.hhp. # The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION = HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # The GENERATE_CHI flag controls if a separate .chi index file is generated (
# controls if a separate .chi index file is generated (YES) or that # YES) or that it should be included in the master .chm file ( NO).
# it should be included in the master .chm file (NO). # The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
# is used to encode HtmlHelp index (hhk), content (hhc) and project file # and project file content.
# content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING = CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # The BINARY_TOC flag controls whether a binary table of contents is generated (
# controls whether a binary table of contents is generated (YES) or a # YES) or a normal table of contents ( NO) in the .chm file.
# normal table of contents (NO) in the .chm file. # The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members # The TOC_EXPAND flag can be set to YES to add extra items for group members to
# to the contents of the HTML help documentation and to the tree view. # the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# that can be used as input for Qt's qhelpgenerator to generate a # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# Qt Compressed Help (.qch) of the generated HTML documentation. # (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = YES GENERATE_QHP = YES
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# be used to specify the file name of the resulting .qch file. # the file name of the resulting .qch file. The path specified is relative to
# The path specified is relative to the HTML output folder. # the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE = pip.qhp QCH_FILE = pip.qhp
# The QHP_NAMESPACE tag specifies the namespace to use when generating # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Qt Help Project output. For more information please see # Project output. For more information please see Qt Help Project / Namespace
# http://doc.trolltech.com/qthelpproject.html#namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = PIP QHP_NAMESPACE = PIP
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Qt Help Project output. For more information please see # Help Project output. For more information please see Qt Help Project / Virtual
# http://doc.trolltech.com/qthelpproject.html#virtual-folders # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# add. For more information please see # filter to add. For more information please see Qt Help Project / Custom
# http://doc.trolltech.com/qthelpproject.html#custom-filters # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see # custom filter to add. For more information please see Qt Help Project / Custom
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# Qt Help Project / Custom Filters</a>. # filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS = QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's # project's filter section matches. Qt Help Project / Filter Attributes (see:
# filter section matches. # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> # This tag requires that the tag GENERATE_QHP is set to YES.
# Qt Help Project / Filter Attributes</a>.
QHP_SECT_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # The QHG_LOCATION tag can be used to specify the location of Qt's
# be used to specify the location of Qt's qhelpgenerator. # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# If non-empty doxygen will try to run qhelpgenerator on the generated # generated .qhp file.
# .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION = QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# will be generated, which together with the HTML files, form an Eclipse help # generated, together with the HTML files, they form an Eclipse help plugin. To
# plugin. To install this plugin and make it available under the help contents # install this plugin and make it available under the help contents menu in
# menu in Eclipse, the contents of the directory containing the HTML and XML # Eclipse, the contents of the directory containing the HTML and XML files needs
# files needs to be copied into the plugins directory of eclipse. The name of # to be copied into the plugins directory of eclipse. The name of the directory
# the directory within the plugins directory should be the same as # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before # After copying Eclipse needs to be restarted before the help appears.
# the help appears. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO GENERATE_ECLIPSEHELP = NO
# A unique identifier for the eclipse help plugin. When installing the plugin # A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have # the directory name containing the HTML and XML files should also have this
# this name. # name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) # If you want full control over the layout of the generated HTML pages it might
# at top of each HTML page. The value NO (the default) enables the index and # be necessary to disable the index and replace it with your own. The
# the value YES disables it. Since the tabs have the same information as the # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# navigation tree you can set this option to NO if you already set # of each HTML page. A value of NO enables the index and the value YES disables
# GENERATE_TREEVIEW to YES. # it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. # structure should be generated to display hierarchical information. If the tag
# If the tag value is set to YES, a side panel will be generated # value is set to YES, a side panel will be generated containing a tree-like
# containing a tree-like index structure (just like the one that # index structure (just like the one that is generated for HTML Help). For this
# is generated for HTML Help). For this to work a browser that supports # to work a browser that supports JavaScript, DHTML, CSS and frames is required
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # (i.e. any modern browser). Windows users are probably better off using the
# Windows users are probably better off using the HTML help feature. # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# Since the tree basically has the same information as the tab index you # further fine-tune the look of the index. As an example, the default style
# could consider to set DISABLE_INDEX to NO when enabling this option. # sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# (range [0,1..20]) that doxygen will group on one line in the generated HTML # doxygen will group on one line in the generated HTML documentation.
# documentation. Note that a value of 0 will completely suppress the enum #
# values from appearing in the overview section. # Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4 ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# used to set the initial width (in pixels) of the frame in which the tree # to set the initial width (in pixels) of the frame in which the tree is shown.
# is shown. # Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250 TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
# links to external symbols imported via tag files in a separate window. # external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of Latex formulas included # Use this tag to change the font size of LaTeX formulas included as images in
# as images in the HTML documentation. The default is 10. Note that # the HTML documentation. When you change the font size after a successful
# when you change the font size after a successful doxygen run you need # doxygen run you need to manually remove any form_*.png images from the HTML
# to manually remove any form_*.png images from the HTML output directory # output directory to force them to be regenerated.
# to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10 FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images # Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are # generated for formulas are transparent PNGs. Transparent PNGs are not
# not supported properly for IE 6.0, but are supported on all modern browsers. # supported properly for IE 6.0, but are supported on all modern browsers.
# Note that when changing this option you need to delete any form_*.png files #
# in the HTML output before the changes have effect. # Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# (see http://www.mathjax.org) which uses client side Javascript for the # http://www.mathjax.org) which uses client side Javascript for the rendering
# rendering instead of using prerendered bitmaps. Use this if you do not # instead of using prerendered bitmaps. Use this if you do not have LaTeX
# have LaTeX installed or if you want to formulas look prettier in the HTML # installed or if you want to formulas look prettier in the HTML output. When
# output. When enabled you may also need to install MathJax separately and # enabled you may also need to install MathJax separately and configure the path
# configure the path to it using the MATHJAX_RELPATH option. # to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for # When MathJax is enabled you can set the default output format to be used for
# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and # the MathJax output. See the MathJax site (see:
# SVG. The default value is HTML-CSS, which is slower, but has the best # http://docs.mathjax.org/en/latest/output.html) for more details.
# compatibility. # Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the # When MathJax is enabled you need to specify the location relative to the HTML
# HTML output directory using the MATHJAX_RELPATH option. The destination # output directory using the MATHJAX_RELPATH option. The destination directory
# directory should contain the MathJax.js script. For instance, if the mathjax # should contain the MathJax.js script. For instance, if the mathjax directory
# directory is located at the same level as the HTML output directory, then # is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# the MathJax Content Delivery Network so you can quickly see the result without # Content Delivery Network so you can quickly see the result without installing
# installing MathJax. However, it is strongly recommended to install a local # MathJax. However, it is strongly recommended to install a local copy of
# copy of MathJax from http://www.mathjax.org before deployment. # MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# names that should be enabled during MathJax rendering. # extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS = MATHJAX_EXTENSIONS =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# for the HTML output. The underlying search engine uses javascript # of code that will be used on startup of the MathJax code. See the MathJax site
# and DHTML and should work on any modern browser. Note that when using # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets # example see the documentation.
# (GENERATE_DOCSET) there is already a search function so this one should # This tag requires that the tag USE_MATHJAX is set to YES.
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. # implemented using a web server instead of a web client using Javascript. There
# There are two flavours of web server based search depending on the # are two flavours of web server based searching depending on the
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
# searching and an index file used by the script. When EXTERNAL_SEARCH is # searching and an index file used by the script. When EXTERNAL_SEARCH is
# enabled the indexing and searching needs to be provided by external tools. # enabled the indexing and searching needs to be provided by external tools. See
# See the manual for details. # the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file # script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an # which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# the search results. Doxygen ships with an example indexer (doxyindexer) and # search results.
# search engine (doxysearch.cgi) which are based on the open source search engine #
# library Xapian. See the manual for configuration details. # Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server # The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will returned the search results when EXTERNAL_SEARCH is enabled. # which will return the search results when EXTERNAL_SEARCH is enabled.
# Doxygen ships with an example search engine (doxysearch) which is based on #
# the open source search engine library Xapian. See the manual for configuration # Doxygen ships with an example indexer ( doxyindexer) and search engine
# details. # (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL = SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the # search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified. # SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project. # projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID = EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are # projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a # all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# of to a relative location where the documentation can be found. # to a relative location where the documentation can be found. The format is:
# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS = EXTRA_SEARCH_MAPPINGS =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the LaTeX output # Configuration options related to the LaTeX output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# generate Latex output. # The default value is: YES.
GENERATE_LATEX = NO GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# If a relative path is entered the value of OUTPUT_DIRECTORY will be # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# put in front of it. If left blank `latex' will be used as the default path. # it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name. # invoked.
# Note that when enabling USE_PDFLATEX this option is only used for #
# generating bitmaps for formulas in the HTML output, but not in the # Note that when enabling USE_PDFLATEX this option is only used for generating
# Makefile that is written to the output directory. # bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# generate index for LaTeX. If left blank `makeindex' will be used as the # index for LaTeX.
# default command name. # The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
# LaTeX documents. This may be useful for small projects and may help to # documents. This may be useful for small projects and may help to save some
# save some trees in general. # trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used # The PAPER_TYPE tag can be used to set the paper type that is used by the
# by the printer. Possible values are: a4, letter, legal and # printer.
# executive. If left blank a4wide will be used. # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4 PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# packages that should be included in the LaTeX output. # that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES = EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# the generated latex document. The header should contain everything until # generated LaTeX document. The header should contain everything until the first
# the first chapter. If it is left blank doxygen will generate a # chapter. If it is left blank doxygen will generate a standard header. See
# standard header. Notice: only use this tag if you know what you are doing! # section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
# replace them by respectively the title of the page, the current date and time,
# only the current date, the version number of doxygen, the project name (see
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# the generated latex document. The footer should contain everything after # generated LaTeX document. The footer should contain everything after the last
# the last chapter. If it is left blank doxygen will generate a # chapter. If it is left blank doxygen will generate a standard footer.
# standard footer. Notice: only use this tag if you know what you are doing! #
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER = LATEX_FOOTER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# is prepared for conversion to pdf (using ps2pdf). The pdf file will # other source files which should be copied to the LATEX_OUTPUT output
# contain links (just like the HTML output) instead of page references # directory. Note that the files will be copied as-is; there are no commands or
# This makes the output suitable for online browsing using a pdf viewer. # markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# plain latex in the generated Makefile. Set this option to YES to get a # the PDF file directly from the LaTeX files. Set this option to YES to get a
# higher quality PDF documentation. # higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep # command to the generated LaTeX files. This will instruct LaTeX to keep running
# running if errors occur, instead of asking the user for help. # if errors occur, instead of asking the user for help. This option is also used
# This option is also used when generating formulas in HTML. # when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# include the index chapters (such as File Index, Compound Index, etc.) # index chapters (such as File Index, Compound Index, etc.) in the output.
# in the output. # The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# source code with syntax highlighting in the LaTeX output. # code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings #
# such as SOURCE_BROWSER. # Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See # bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX for more info. # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain LATEX_BIB_STYLE = plain
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the RTF output # Configuration options related to the RTF output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
# The RTF output is optimized for Word 97 and may not look very pretty with # RTF output is optimized for Word 97 and may not look too pretty with other RTF
# other RTF readers or editors. # readers/editors.
# The default value is: NO.
GENERATE_RTF = NO GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# If a relative path is entered the value of OUTPUT_DIRECTORY will be # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# put in front of it. If left blank `rtf' will be used as the default path. # it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
# RTF documents. This may be useful for small projects and may help to # documents. This may be useful for small projects and may help to save some
# save some trees in general. # trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# will contain hyperlink fields. The RTF file will # contain hyperlink fields. The RTF file will contain links (just like the HTML
# contain links (just like the HTML output) instead of page references. # output) instead of page references. This makes the output suitable for online
# This makes the output suitable for online browsing using WORD or other # browsing using Word or some other Word compatible readers that support those
# programs which support those fields. # fields.
# Note: wordpad (write) and others do not support links. #
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO RTF_HYPERLINKS = NO
# Load style sheet definitions from file. Syntax is similar to doxygen's # Load stylesheet definitions from file. Syntax is similar to doxygen's config
# config file, i.e. a series of assignments. You only have to provide # file, i.e. a series of assignments. You only have to provide replacements,
# replacements, missing definitions are set to their default value. # missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE = RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document. # Set optional variables used in the generation of an RTF document. Syntax is
# Syntax is similar to doxygen's config file. # similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE = RTF_EXTENSIONS_FILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the man page output # Configuration options related to the man page output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
# generate man pages # classes and files.
# The default value is: NO.
GENERATE_MAN = NO GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# If a relative path is entered the value of OUTPUT_DIRECTORY will be # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# put in front of it. If left blank `man' will be used as the default path. # it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to # The MAN_EXTENSION tag determines the extension that is added to the generated
# the generated man pages (default is the subroutine's section .3) # man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3 MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# then it will generate one additional man file for each entity # will generate one additional man file for each entity documented in the real
# documented in the real man page(s). These additional files # man page(s). These additional files only source the real man page, but without
# only source the real man page, but without them the man command # them the man command would be unable to find the correct page.
# would be unable to find the correct page. The default is NO. # The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO MAN_LINKS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the XML output # Configuration options related to the XML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
# generate an XML file that captures the structure of # captures the structure of the code including all documentation.
# the code including all documentation. # The default value is: NO.
GENERATE_XML = NO GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# If a relative path is entered the value of OUTPUT_DIRECTORY will be # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# put in front of it. If left blank `xml' will be used as the default path. # it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema, # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
# which can be used by a validating XML parser to check the # validating XML parser to check the syntax of the XML files.
# syntax of the XML files. # This tag requires that the tag GENERATE_XML is set to YES.
XML_SCHEMA = XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD, # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
# which can be used by a validating XML parser to check the # validating XML parser to check the syntax of the XML files.
# syntax of the XML files. # This tag requires that the tag GENERATE_XML is set to YES.
XML_DTD = XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# dump the program listings (including syntax highlighting # listings (including syntax highlighting and cross-referencing information) to
# and cross-referencing information) to the XML output. Note that # the XML output. Note that enabling this will significantly increase the size
# enabling this will significantly increase the size of the XML output. # of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES XML_PROGRAMLISTING = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output # Configuration options related to the DOCBOOK output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
# generate an AutoGen Definitions (see autogen.sf.net) file # that can be used to generate PDF.
# that captures the structure of the code including all # The default value is: NO.
# documentation. Note that this feature is still experimental
# and incomplete at the moment. GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
# Definitions (see http://autogen.sf.net) file that captures the structure of
# the code including all documentation. Note that this feature is still
# experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO GENERATE_AUTOGEN_DEF = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the Perl module output # Configuration options related to the Perl module output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES Doxygen will # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
# generate a Perl module file that captures the structure of # file that captures the structure of the code including all documentation.
# the code including all documentation. Note that this #
# feature is still experimental and incomplete at the # Note that this feature is still experimental and incomplete at the moment.
# moment. # The default value is: NO.
GENERATE_PERLMOD = NO GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
# the necessary Makefile rules, Perl scripts and LaTeX code to be able # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# to generate PDF and DVI output from the Perl module output. # output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
# nicely formatted so it can be parsed by a human reader. This is useful # formatted so it can be parsed by a human reader. This is useful if you want to
# if you want to understand what is going on. On the other hand, if this # understand what is going on. On the other hand, if this tag is set to NO the
# tag is set to NO the size of the Perl module output will be much smaller # size of the Perl module output will be much smaller and Perl will parse it
# and Perl will parse it just the same. # just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file # The names of the make variables in the generated doxyrules.make file are
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# This is useful so different doxyrules.make files included by the same # so different doxyrules.make files included by the same Makefile don't
# Makefile don't overwrite each other's variables. # overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX = PERLMOD_MAKEVAR_PREFIX =
@@ -1578,105 +1936,129 @@ PERLMOD_MAKEVAR_PREFIX =
# Configuration options related to the preprocessor # Configuration options related to the preprocessor
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
# evaluate all C-preprocessor directives found in the sources and include # C-preprocessor directives found in the sources and include files.
# files. # The default value is: YES.
ENABLE_PREPROCESSING = YES ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
# names in the source code. If set to NO (the default) only conditional # in the source code. If set to NO only conditional compilation will be
# compilation will be performed. Macro expansion can be done in a controlled # performed. Macro expansion can be done in a controlled way by setting
# way by setting EXPAND_ONLY_PREDEF to YES. # EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = YES MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# then the macro expansion is limited to the macros specified with the # the macro expansion is limited to the macros specified with the PREDEFINED and
# PREDEFINED and EXPAND_AS_DEFINED tags. # EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # If the SEARCH_INCLUDES tag is set to YES the includes files in the
# pointed to by INCLUDE_PATH will be searched when a #include is found. # INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = NO SEARCH_INCLUDES = NO
# The INCLUDE_PATH tag can be used to specify one or more directories that # The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by # contain include files that are not input files but should be processed by the
# the preprocessor. # preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH = INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the # patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will # directories. If left blank, the patterns specified with FILE_PATTERNS will be
# be used. # used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that # The PREDEFINED tag can be used to specify one or more macro names that are
# are defined before the preprocessor is started (similar to the -D option of # defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name # gcc). The argument of the tag is a list of macros of the form: name or
# or name=definition (no spaces). If the definition and the = are # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# omitted =1 is assumed. To prevent a macro definition from being # is assumed. To prevent a macro definition from being undefined via #undef or
# undefined via #undef or recursively expanded use the := operator # recursively expanded use the := operator instead of the = operator.
# instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = DOXYGEN \ PREDEFINED = DOXYGEN \
PIP_EXPORT PIP_EXPORT
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# this tag can be used to specify a list of macro names that should be expanded. # tag can be used to specify a list of macro names that should be expanded. The
# The macro definition that is found in the sources will be used. # macro definition that is found in the sources will be used. Use the PREDEFINED
# Use the PREDEFINED tag if you want to use a different macro definition that # tag if you want to use a different macro definition that overrules the
# overrules the definition found in the source code. # definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED = EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# doxygen's preprocessor will remove all references to function-like macros # remove all refrences to function-like macros that are alone on a line, have an
# that are alone on a line, have an all uppercase name, and do not end with a # all uppercase name, and do not end with a semicolon. Such function macros are
# semicolon, because these will confuse the parser if not removed. # typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = NO SKIP_FUNCTION_MACROS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to external references # Configuration options related to external references
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles. For each # The TAGFILES tag can be used to specify one or more tag files. For each tag
# tag file the location of the external documentation should be added. The # file the location of the external documentation should be added. The format of
# format of a tag file without this location is as follows: # a tag file without this location is as follows:
# TAGFILES = file1 file2 ... # TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows: # Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ... # TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths # where loc1 and loc2 can be relative or absolute paths or URLs. See the
# or URLs. Note that each tag file must have a unique name (where the name does # section "Linking to external documentation" for more information about the use
# NOT include the path). If a tag file is not located in the directory in which # of tag files.
# doxygen is run, you must also specify the path to the tagfile here. # Note: Each tag file must have an unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# a tag file that is based on the input files it reads. # tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
# in the class index. If set to NO only the inherited external classes # class index. If set to NO only the inherited external classes will be listed.
# will be listed. # The default value is: NO.
ALLEXTERNALS = NO ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
# in the modules index. If set to NO, only the current project's groups will # the modules index. If set to NO, only the current project's groups will be
# be listed. # listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# interpreter (i.e. the result of `which perl'). # the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl PERL_PATH = /usr/bin/perl
@@ -1684,222 +2066,280 @@ PERL_PATH = /usr/bin/perl
# Configuration options related to the dot tool # Configuration options related to the dot tool
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# or super classes. Setting the tag to NO turns the diagrams off. Note that # NO turns the diagrams off. Note that this option also works with HAVE_DOT
# this option also works with HAVE_DOT disabled, but it is recommended to # disabled, but it is recommended to install and use dot, since it yields more
# install and use dot, since it yields more powerful graphs. # powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc # You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see # command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where # documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the # the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path. # default search path.
MSCGEN_PATH = MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide # If set to YES, the inheritance and collaboration graphs will hide inheritance
# inheritance and usage relations if the target is undocumented # and usage relations if the target is undocumented or is not a class.
# or is not a class. # The default value is: YES.
HIDE_UNDOC_RELATIONS = YES HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization # available from the path. This tool is part of Graphviz (see:
# toolkit from AT&T and Lucent Bell Labs. The other options in this section # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# have no effect if this option is set to NO (the default) # Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = YES HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# allowed to run in parallel. When set to 0 (the default) doxygen will # to run in parallel. When set to 0 doxygen will base this on the number of
# base this on the number of processors available in the system. You can set it # processors available in the system. You can set it explicitly to a value
# explicitly to a value larger than 0 to get control over the balance # larger than 0 to get control over the balance between CPU load and processing
# between CPU load and processing speed. # speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 8 DOT_NUM_THREADS = 8
# By default doxygen will use the Helvetica font for all dot files that # When you want a differently looking font n the dot files that doxygen
# doxygen generates. When you want a differently looking font you can specify # generates you can specify the font name using DOT_FONTNAME. You need to make
# the font name using DOT_FONTNAME. You need to make sure dot is able to find # sure dot is able to find the font, which can be done by putting it in a
# the font, which can be done by putting it in a standard location or by setting # standard location or by setting the DOTFONTPATH environment variable or by
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the # setting DOT_FONTPATH to the directory containing the font.
# directory containing the font. # The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# The default size is 10pt. # dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10 DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the Helvetica font. # By default doxygen will tell dot to use the default font as specified with
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# set the path where dot can find it. # the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH = DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# will generate a graph for each documented class showing the direct and # each documented class showing the direct and indirect inheritance relations.
# indirect inheritance relations. Setting this tag to YES will force the # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# CLASS_DIAGRAMS tag to NO. # The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# will generate a graph for each documented class showing the direct and # graph for each documented class showing the direct and indirect implementation
# indirect implementation dependencies (inheritance, containment, and # dependencies (inheritance, containment, and class references variables) of the
# class references variables) of the class with other documented classes. # class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = NO COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# will generate a graph for groups, showing the direct groups dependencies # groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = NO GROUP_GRAPHS = NO
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling # collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language. # Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# the class node. If there are many fields or methods and many nodes the # class node. If there are many fields or methods and many nodes the graph may
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# threshold limits the number of items for each type to make the size more # number of items for each type to make the size more manageable. Set this to 0
# managable. Set this to 0 for no limit. Note that the threshold may be # for no limit. Note that the threshold may be exceeded by 50% before the limit
# exceeded by 50% before the limit is enforced. # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 12 UML_LIMIT_NUM_FIELDS = 12
# If set to YES, the inheritance and collaboration graphs will show the # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# relations between templates and their instances. # collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# tags are set to YES then doxygen will generate a graph for each documented # YES then doxygen will generate a graph for each documented file showing the
# file showing the direct and indirect include dependencies of the file with # direct and indirect include dependencies of the file with other documented
# other documented files. # files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = NO INCLUDE_GRAPH = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each # set to YES then doxygen will generate a graph for each documented file showing
# documented header file showing the documented files that directly or # the direct and indirect include dependencies of the file with other documented
# indirectly include this file. # files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = NO INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT options are set to YES then # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# doxygen will generate a call dependency graph for every global function # dependency graph for every global function or class method.
# or class method. Note that enabling this option will significantly increase #
# the time of a run. So in most cases it will be better to enable call graphs # Note that enabling this option will significantly increase the time of a run.
# for selected functions only using the \callgraph command. # So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# doxygen will generate a caller dependency graph for every global function # dependency graph for every global function or class method.
# or class method. Note that enabling this option will significantly increase #
# the time of a run. So in most cases it will be better to enable caller # Note that enabling this option will significantly increase the time of a run.
# graphs for selected functions only using the \callergraph command. # So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# will generate a graphical hierarchy of all classes instead of a textual one. # hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# then doxygen will show the dependencies a directory has on other directories # dependencies a directory has on other directories in a graphical way. The
# in a graphical way. The dependency relations are determined by the #include # dependency relations are determined by the #include relations between the
# relations between the files in the directories. # files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are svg, png, jpg, or gif. # generated by dot.
# If left blank png will be used. If you choose svg you need to set # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files # to make the SVG files visible in IE 9+ (other browsers do not have this
# visible in IE 9+ (other browsers do not have this requirement). # requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = svg DOT_IMAGE_FORMAT = svg
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning. # enable generation of interactive SVG images that allow zooming and panning.
# Note that this requires a modern browser other than Internet Explorer. #
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you # Note that this requires a modern browser other than Internet Explorer. Tested
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files # and working are Firefox, Chrome, Safari, and Opera.
# visible. Older versions of IE do not have SVG support. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = YES INTERACTIVE_SVG = YES
# The tag DOT_PATH can be used to specify the path where the dot tool can be # The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path. # found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH = DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that # The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the # contain dot files that are included in the documentation (see the \dotfile
# \dotfile command). # command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS = DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that # The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the # contain msc files that are included in the documentation (see the \mscfile
# \mscfile command). # command).
MSCFILE_DIRS = MSCFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# nodes that will be shown in the graph. If the number of nodes in a graph # that will be shown in the graph. If the number of nodes in a graph becomes
# becomes larger than this value, doxygen will truncate the graph, which is # larger than this value, doxygen will truncate the graph, which is visualized
# visualized by representing a node as a red box. Note that doxygen if the # by representing a node as a red box. Note that doxygen if the number of direct
# number of direct children of the root node in a graph is already larger than # children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50 DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# graphs generated by dot. A depth value of 3 means that only nodes reachable # generated by dot. A depth value of 3 means that only nodes reachable from the
# from the root by following a path via at most 3 edges will be shown. Nodes # root by following a path via at most 3 edges will be shown. Nodes that lay
# that lay further from the root node will be omitted. Note that setting this # further from the root node will be omitted. Note that setting this option to 1
# option to 1 or 2 may greatly reduce the computation time needed for large # or 2 may greatly reduce the computation time needed for large code bases. Also
# code bases. Also note that the size of a graph can be further restricted by # note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0 MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not # background. This is disabled by default, because dot on Windows does not seem
# seem to support this out of the box. Warning: Depending on the platform used, # to support this out of the box.
# enabling this option may lead to badly anti-aliased labels on the edges of #
# a graph (i.e. they become hard to read). # Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This # files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) # makes dot run faster, but since only newer versions of dot (>1.8.10) support
# support this, this feature is disabled by default. # this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# generate a legend page explaining the meaning of the various boxes and # explaining the meaning of the various boxes and arrows in the dot generated
# arrows in the dot generated graphs. # graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
# remove the intermediate dot files that are used to generate # files that are used to generate the various graphs.
# the various graphs. # The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES DOT_CLEANUP = YES

12
main.cpp
View File

@@ -125,13 +125,13 @@ public:
bool d; bool d;
}; };
/*
PIDiagnostics diag; PIDiagnostics diag;
bool corr = true; bool corr = true;
void te(void * , int) { void te(void * , int) {
diag.received(256, corr); diag.received(256, corr);
diag.sended(512); diag.sended(512);
} }*/
class ObjectA: public PIObject { class ObjectA: public PIObject {
PIOBJECT(ObjectA) PIOBJECT(ObjectA)
@@ -212,10 +212,10 @@ public:
EVENT_HANDLER2(void, re, ullong, id, int, size) {piCout << "written id =" << id << "size =" << size;} EVENT_HANDLER2(void, re, ullong, id, int, size) {piCout << "written id =" << id << "size =" << size;}
}; };
void tfunc(void*,int);
PITimer tm_(tfunc);
void tfunc(void*,int) {piCout << tm_.elapsed_m();}
int main (int argc, char * argv[]) { int main (int argc, char * argv[]) {
//PIKbdListener kbd;
//kbd.enableExitCapture();
/*PIEthernet::InterfaceList il = PIEthernet::interfaces(); /*PIEthernet::InterfaceList il = PIEthernet::interfaces();
//const PIEthernet::Interface & i(*(il.getByName("lo"))); //const PIEthernet::Interface & i(*(il.getByName("lo")));
piForeachC (PIEthernet::Interface & i, il) piForeachC (PIEthernet::Interface & i, il)
@@ -243,7 +243,7 @@ int main (int argc, char * argv[]) {
int a__, b__; int a__, b__;
PIConsole console(false); PIConsole console(false);
console.enableExitCapture(); console.enableExitCapture();
PIProtocol p("/home/peri4/work/ISPUM/nosit_VM6/protocols.conf", "gas", 0, 0, &a__, 4, &b__, 4); PIProtocol p("/home/peri4/work/ISPUM/nosit_VM6/protocols.conf_", "gas", 0, 0, &a__, 4, &b__, 4);
p.start(); p.start();
console.addTab("ftab", 'f'); console.addTab("ftab", 'f');
console.addVariable("service", &p); console.addVariable("service", &p);

23
piconfig.h
View File

@@ -259,7 +259,30 @@ private:
}; };
inline std::ostream & operator <<(std::ostream & s, const PIConfig::Branch & v) {v.coutt(s, ""); return s;} inline std::ostream & operator <<(std::ostream & s, const PIConfig::Branch & v) {v.coutt(s, ""); return s;}
inline std::ostream & operator <<(std::ostream & s, const PIConfig::Entry & v) {s << v.value(); return s;} inline std::ostream & operator <<(std::ostream & s, const PIConfig::Entry & v) {s << v.value(); return s;}
/** \relatesalso PIConfig \relatesalso PIIODevice
* \brief Service function. useful for configuring devices
* \details Function takes entry name "name", default value "def" and two
* \a PIConfig::Entry sections: "em" and their parent "ep". If there is no
* parent ep = 0. If "ep" is not null and entry "name" exists in "ep" function
* returns this value. Else returns value of entry "name" in section "em" or
* "def" if entry doesn`t exists. \n This function useful to read settings
* from configuration file in implementation \a PIIODevice::configureDevice() function */
template<typename T>
T readDeviceSetting(const PIString & name, const T & def, const PIConfig::Entry * em, const PIConfig::Entry * ep) {
if (ep != 0) {
T ret;
bool ex;
ret = ep->getValue(name, def, &ex);
if (!ex) ret = em->getValue(name, def);
return ret;
}
return em->getValue(name, def);
}
#endif // PICONFIG_H #endif // PICONFIG_H

6
pidir.h
View File

@@ -50,9 +50,9 @@ public:
bool isSocket() const {return (mode & S_IFSOCK);} bool isSocket() const {return (mode & S_IFSOCK);}
}; };
const bool isExists() {return (dir_ != 0);} bool isExists() const {return (dir_ != 0);}
const bool isAbsolute() {if (path_.size() == 0) return false; return (path_[0] == separator);} bool isAbsolute() const {if (path_.size() == 0) return false; return (path_[0] == separator);}
PIString path() {return PIString(path_);} const PIString & path() const {return path_;}
PIDir & cleanPath(); PIDir & cleanPath();
PIDir cleanedPath() {PIDir d(path_); d.cleanPath(); return d;} PIDir cleanedPath() {PIDir d(path_); d.cleanPath(); return d;}
PIString absolutePath(); PIString absolutePath();

61
piethernet.cpp
View File

@@ -18,6 +18,7 @@
*/ */
#include "piethernet.h" #include "piethernet.h"
#include "piconfig.h"
PIEthernet::PIEthernet(void * data, ReadRetFunc slot): PIIODevice("", ReadWrite) { PIEthernet::PIEthernet(void * data, ReadRetFunc slot): PIIODevice("", ReadWrite) {
@@ -102,7 +103,7 @@ bool PIEthernet::init() {
sock = socket(AF_INET, st, pr); sock = socket(AF_INET, st, pr);
#endif #endif
if (sock == -1) { if (sock == -1) {
piCoutObj << "[PIEthernet] Can`t create socket, " << ethErrorString(); piCoutObj << "Can`t create socket, " << ethErrorString();
return false; return false;
} }
#ifndef WINDOWS #ifndef WINDOWS
@@ -146,7 +147,7 @@ bool PIEthernet::openDevice() {
tries++; tries++;
} }
if (tries == 10) { if (tries == 10) {
piCoutObj << "[PIEthernet] Can`t bind to " << ip_ << ":" << port_ << ", " << ethErrorString(); piCoutObj << "Can`t bind to " << ip_ << ":" << port_ << ", " << ethErrorString();
return false; return false;
} }
opened_ = true; opened_ = true;
@@ -188,7 +189,7 @@ bool PIEthernet::joinMulticastGroup(const PIString & group) {
if (sock == -1) init(); if (sock == -1) init();
if (sock == -1) return false; if (sock == -1) return false;
if (type_ != UDP) { if (type_ != UDP) {
piCoutObj << "[PIEthernet] Only UDP sockets can join multicast groups"; piCoutObj << "Only UDP sockets can join multicast groups";
return false; return false;
} }
if (!opened_) { if (!opened_) {
@@ -206,14 +207,14 @@ bool PIEthernet::joinMulticastGroup(const PIString & group) {
//setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, (char * )&so, sizeof(so)); //setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, (char * )&so, sizeof(so));
SOCKET ret = WSAJoinLeaf(sock, (sockaddr *)&addr_, sizeof(addr_), NULL, NULL, NULL, NULL, JL_BOTH); SOCKET ret = WSAJoinLeaf(sock, (sockaddr *)&addr_, sizeof(addr_), NULL, NULL, NULL, NULL, JL_BOTH);
if (ret == INVALID_SOCKET) { if (ret == INVALID_SOCKET) {
piCoutObj << "[PIEthernet] Can`t join multicast group " << group << ", " << ethErrorString(); piCoutObj << "Can`t join multicast group " << group << ", " << ethErrorString();
return false; return false;
} }
if (ret != sock) leafs.insert(group, ret); if (ret != sock) leafs.insert(group, ret);
#else #else
# ifndef QNX # ifndef QNX
if (!params[Broadcast]) if (!params[Broadcast])
piCoutObj << "[PIEthernet] Warning: \"Broadcast\" parameter not set, \"joinMulticastGroup(\"" << group << "\")\" may be useless!"; piCoutObj << "Warning: \"Broadcast\" parameter not set, \"joinMulticastGroup(\"" << group << "\")\" may be useless!";
parseAddress(path_, &ip_, &port_); parseAddress(path_, &ip_, &port_);
struct ip_mreqn mreq; struct ip_mreqn mreq;
memset(&mreq, 0, sizeof(mreq)); memset(&mreq, 0, sizeof(mreq));
@@ -230,7 +231,7 @@ bool PIEthernet::joinMulticastGroup(const PIString & group) {
setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, &so, sizeof(so)); setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, &so, sizeof(so));
setsockopt(sock, IPPROTO_IP, IP_MULTICAST_IF, &mreq, sizeof(mreq)); setsockopt(sock, IPPROTO_IP, IP_MULTICAST_IF, &mreq, sizeof(mreq));
if (setsockopt(sock, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)) != 0) { if (setsockopt(sock, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)) != 0) {
piCoutObj << "[PIEthernet] Can`t join multicast group " << group << ", " << ethErrorString(); piCoutObj << "Can`t join multicast group " << group << ", " << ethErrorString();
return false; return false;
} }
# endif # endif
@@ -243,7 +244,7 @@ bool PIEthernet::leaveMulticastGroup(const PIString & group) {
if (sock == -1) init(); if (sock == -1) init();
if (sock == -1) return false; if (sock == -1) return false;
if (type_ != UDP) { if (type_ != UDP) {
piCoutObj << "[PIEthernet] Only UDP sockets can leave multicast groups"; piCoutObj << "Only UDP sockets can leave multicast groups";
return false; return false;
} }
#ifdef WINDOWS #ifdef WINDOWS
@@ -262,7 +263,7 @@ bool PIEthernet::leaveMulticastGroup(const PIString & group) {
mreq.imr_multiaddr.s_addr = inet_addr(group.data()); mreq.imr_multiaddr.s_addr = inet_addr(group.data());
mreq.imr_ifindex = 0; mreq.imr_ifindex = 0;
if (setsockopt(sock, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq)) == -1) { if (setsockopt(sock, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq)) == -1) {
piCoutObj << "[PIEthernet] Can`t leave multicast group " << group << ", " << ethErrorString(); piCoutObj << "Can`t leave multicast group " << group << ", " << ethErrorString();
return false; return false;
} }
#endif #endif
@@ -281,10 +282,10 @@ bool PIEthernet::connect() {
#ifdef QNX #ifdef QNX
addr_.sin_len = sizeof(addr_); addr_.sin_len = sizeof(addr_);
#endif #endif
//piCoutObj << "[PIEthernet] connect to " << ip << ":" << port_; //piCoutObj << "connect to " << ip << ":" << port_;
connected_ = (::connect(sock, (sockaddr * )&addr_, sizeof(addr_)) == 0); connected_ = (::connect(sock, (sockaddr * )&addr_, sizeof(addr_)) == 0);
if (!connected_) if (!connected_)
piCoutObj << "[PIEthernet] Can`t connect to " << ip_ << ":" << port_ << ", " << ethErrorString(); piCoutObj << "Can`t connect to " << ip_ << ":" << port_ << ", " << ethErrorString();
opened_ = connected_; opened_ = connected_;
if (connected_) connected(); if (connected_) connected();
return connected_; return connected_;
@@ -308,14 +309,14 @@ bool PIEthernet::listen() {
tries++; tries++;
} }
if (tries == 10) { if (tries == 10) {
piCoutObj << "[PIEthernet] Can`t bind to " << ip_ << ":" << port_ << ", " << ethErrorString(); piCoutObj << "Can`t bind to " << ip_ << ":" << port_ << ", " << ethErrorString();
return false; return false;
} }
if (::listen(sock, 64) == -1) { if (::listen(sock, 64) == -1) {
piCoutObj << "[PIEthernet] Can`t listen on "<< ip_ << ":" << port_ << ", " << ethErrorString(); piCoutObj << "Can`t listen on "<< ip_ << ":" << port_ << ", " << ethErrorString();
return false; return false;
} }
//piCoutObj << "[PIEthernet] listen on " << ip_ << ":" << port_; //piCoutObj << "listen on " << ip_ << ":" << port_;
server_thread_.start(server_func); server_thread_.start(server_func);
return true; return true;
} }
@@ -328,13 +329,13 @@ int PIEthernet::read(void * read_to, int max_size) {
int rs = 0, s = 0; int rs = 0, s = 0;
sockaddr_in client_addr; sockaddr_in client_addr;
socklen_t slen = sizeof(client_addr); socklen_t slen = sizeof(client_addr);
//piCoutObj << "[PIEthernet] read from " << ip_ << ":" << port_ << endl; //piCoutObj << "read from " << ip_ << ":" << port_ << endl;
switch (type_) { switch (type_) {
case TCP_SingleTCP: case TCP_SingleTCP:
::listen(sock, 64); ::listen(sock, 64);
s = accept(sock, (sockaddr * )&client_addr, &slen); s = accept(sock, (sockaddr * )&client_addr, &slen);
if (s == -1) { if (s == -1) {
//piCoutObj << "[PIEthernet] Can`t accept new connection, " << ethErrorString(); //piCoutObj << "Can`t accept new connection, " << ethErrorString();
msleep(1); msleep(1);
return -1; return -1;
} }
@@ -368,10 +369,10 @@ int PIEthernet::read(void * read_to, int max_size) {
int PIEthernet::write(const void * data, int max_size) { int PIEthernet::write(const void * data, int max_size) {
if (sock == -1) init(); if (sock == -1) init();
if (sock == -1 || !isWriteable()) { if (sock == -1 || !isWriteable()) {
//piCoutObj << "[PIEthernet] Can`t send to uninitialized socket"; //piCoutObj << "Can`t send to uninitialized socket";
return -1; return -1;
} }
//piCoutObj << "[PIEthernet] sending to " << ip_s << ":" << port_s << " " << max_size << " bytes"; //piCoutObj << "sending to " << ip_s << ":" << port_s << " " << max_size << " bytes";
int ret = 0; int ret = 0;
switch (type_) { switch (type_) {
case TCP_SingleTCP: case TCP_SingleTCP:
@@ -384,7 +385,7 @@ int PIEthernet::write(const void * data, int max_size) {
#endif #endif
//piCoutObj << "connect SingleTCP" << ip_s << ":" << port_s << "..."; //piCoutObj << "connect SingleTCP" << ip_s << ":" << port_s << "...";
if (::connect(sock, (sockaddr * )&addr_, sizeof(addr_)) != 0) { if (::connect(sock, (sockaddr * )&addr_, sizeof(addr_)) != 0) {
//piCoutObj << "[PIEthernet] Can`t connect to " << ip_s << ":" << port_s << ", " << ethErrorString(); //piCoutObj << "Can`t connect to " << ip_s << ":" << port_s << ", " << ethErrorString();
msleep(1); msleep(1);
return -1; return -1;
} }
@@ -435,6 +436,17 @@ void PIEthernet::server_func(void * eth) {
} }
bool PIEthernet::configureDevice(const void * e_main, const void * e_parent) {
PIConfig::Entry * em = (PIConfig::Entry * )e_main;
PIConfig::Entry * ep = (PIConfig::Entry * )e_parent;
setReadIP(readDeviceSetting<PIString>("ip", readIP(), em, ep));
setReadPort(readDeviceSetting<int>("port", readPort(), em, ep));
setParameter(PIEthernet::Broadcast, readDeviceSetting<bool>("broadcast", isParameterSet(PIEthernet::Broadcast), em, ep));
setParameter(PIEthernet::ReuseAddress, readDeviceSetting<bool>("reuseAddress", isParameterSet(PIEthernet::ReuseAddress), em, ep));
return true;
}
PIEthernet::InterfaceList PIEthernet::interfaces() { PIEthernet::InterfaceList PIEthernet::interfaces() {
#ifdef WINDOWS #ifdef WINDOWS
PIEthernet::InterfaceList il; PIEthernet::InterfaceList il;
@@ -544,12 +556,25 @@ PIEthernet::InterfaceList PIEthernet::interfaces() {
ci.mac = macFromBytes(PIByteArray(nic.permanent_address, 6)); ci.mac = macFromBytes(PIByteArray(nic.permanent_address, 6));
} }
#else #else
# ifdef MAC_OS
PIString req = PIString(ifconfigPath) + " " + ci.name + " | grep ether";
FILE * fp = popen(req.data(), "r");
if (fp != 0) {
char in[256];
if (fgets(in, 256, fp) != 0) {
req = PIString(in).trim();
ci.mac = req.cutLeft(req.find(" ") + 1).trim().toUpperCase();
}
pclose(fp);
}
# else
if (s != -1) { if (s != -1) {
struct ifreq ir; struct ifreq ir;
strcpy(ir.ifr_name, ret->ifa_name); strcpy(ir.ifr_name, ret->ifa_name);
if (ioctl(s, SIOCGIFHWADDR, &ir) == 0) if (ioctl(s, SIOCGIFHWADDR, &ir) == 0)
ci.mac = macFromBytes(PIByteArray(ir.ifr_hwaddr.sa_data, 6)); ci.mac = macFromBytes(PIByteArray(ir.ifr_hwaddr.sa_data, 6));
} }
# endif
#endif #endif
ci.flags = 0; ci.flags = 0;
if (ret->ifa_flags & IFF_UP) ci.flags |= PIEthernet::ifActive; if (ret->ifa_flags & IFF_UP) ci.flags |= PIEthernet::ifActive;

1
piethernet.h
View File

@@ -143,6 +143,7 @@ public:
protected: protected:
PIEthernet(int sock, PIString ip_port); PIEthernet(int sock, PIString ip_port);
bool configureDevice(const void * e_main, const void * e_parent = 0);
virtual void received(void * data, int size) {;} virtual void received(void * data, int size) {;}
bool init(); bool init();

81
pievaluator.cpp
View File

@@ -56,6 +56,11 @@ PIEvaluatorContent::PIEvaluatorContent() {
addFunction("y0", 1); addFunction("y0", 1);
addFunction("y1", 1); addFunction("y1", 1);
addFunction("yn", 2); addFunction("yn", 2);
addFunction("min", -2); // (x0,x1,...)
addFunction("max", -2); // (x0,x1,...)
addFunction("clamp", 3); // (x,a,b) = x < a ? a : (x > b ? b : x)
addFunction("step", 2); // (x,s) = x >= s ? 1. : 0. (1 if 'x' >= 's', else 0)
addFunction("mix", 3); // (x,a,b) = a*(1.-x) + b*x (interpolate between 'a' and 'b' linear for 'x')
clearCustomVariables(); clearCustomVariables();
//addVariable("n", 0.); //addVariable("n", 0.);
//addVariable("x1", 123); //addVariable("x1", 123);
@@ -138,6 +143,11 @@ PIEvaluatorTypes::BaseFunctions PIEvaluatorContent::getBaseFunction(const PIStri
if (name == "y0") return PIEvaluatorTypes::bfY0; if (name == "y0") return PIEvaluatorTypes::bfY0;
if (name == "y1") return PIEvaluatorTypes::bfY1; if (name == "y1") return PIEvaluatorTypes::bfY1;
if (name == "yn") return PIEvaluatorTypes::bfYN; if (name == "yn") return PIEvaluatorTypes::bfYN;
if (name == "min") return PIEvaluatorTypes::bfMin;
if (name == "max") return PIEvaluatorTypes::bfMax;
if (name == "clamp") return PIEvaluatorTypes::bfClamp;
if (name == "step") return PIEvaluatorTypes::bfStep;
if (name == "mix") return PIEvaluatorTypes::bfMix;
return PIEvaluatorTypes::bfUnknown; return PIEvaluatorTypes::bfUnknown;
} }
@@ -788,18 +798,43 @@ bool PIEvaluator::check() {
for (int i = 0; i < instructions.size_s(); i++) { for (int i = 0; i < instructions.size_s(); i++) {
error = false; error = false;
ci = instructions[i]; ci = instructions[i];
PIEvaluatorTypes::Function cf;
int fac, gac;
switch (ci.operation) { switch (ci.operation) {
case PIEvaluatorTypes::oNone: break; case PIEvaluatorTypes::oNone: break;
case PIEvaluatorTypes::oFunction: case PIEvaluatorTypes::oFunction:
cf = content.function(ci.function);
fac = cf.arguments;
gac = ci.operators.size_s();
for (int j = 0; j < ci.operators.size_s(); j++) { for (int j = 0; j < ci.operators.size_s(); j++) {
if (ci.operators[j] == -666) { //(ci.operators[j] < -variables.size_s() || ci.operators[j] >= kvars->size()) { if (ci.operators[j] == -666) { //(ci.operators[j] < -variables.size_s() || ci.operators[j] >= kvars->size()) {
error = true; error = true;
break; gac--;
} }
} }
if (ci.operators.size_s() != content.function(ci.function).arguments || error) { if (fac > 0) {
lastError = "Invalid arguments count for function \"" + content.function(ci.function).identifier + "\""; if (gac != fac) {
return false; lastError = "Invalid arguments count for function \"" + cf.identifier +
"\", expected " + PIString::fromNumber(fac) + " but " +
PIString::fromNumber(gac) + " given";
return false;
}
if (error) {
lastError = "Invalid at least one of function \"" + cf.identifier + "\" argument";
return false;
}
}
if (fac < 0) {
if (gac < -fac) {
lastError = "Invalid arguments count for function \"" + cf.identifier +
"\", expected at least " + PIString::fromNumber(-fac) + " but " +
PIString::fromNumber(gac) + " given";
return false;
}
if (error) {
lastError = "Invalid at least one of function \"" + cf.identifier + "\" argument";
return false;
}
} }
break; break;
default: default:
@@ -872,7 +907,7 @@ inline complexd PIEvaluator::residue(const complexd & f, const complexd & s) {
inline void PIEvaluator::execFunction(const PIEvaluatorTypes::Instruction & ci) { inline void PIEvaluator::execFunction(const PIEvaluatorTypes::Instruction & ci) {
PIEvaluatorTypes::Function cfunc = content.function(ci.function); PIEvaluatorTypes::Function cfunc = content.function(ci.function);
int oi = -ci.out - 1; int oi = -ci.out - 1;
complexd tmp, stmp; complexd tmp, stmp, ttmp;
ldouble ldtmp; ldouble ldtmp;
//qDebug() << "function " << (int)cfunc.type; //qDebug() << "function " << (int)cfunc.type;
switch (cfunc.type) { switch (cfunc.type) {
@@ -987,6 +1022,37 @@ inline void PIEvaluator::execFunction(const PIEvaluatorTypes::Instruction & ci)
case PIEvaluatorTypes::bfYN: case PIEvaluatorTypes::bfYN:
tmpvars[oi].value = piYn(piRoundd(value(ci.operators[1]).real()), value(ci.operators[0]).real()); tmpvars[oi].value = piYn(piRoundd(value(ci.operators[1]).real()), value(ci.operators[0]).real());
break; break;
case PIEvaluatorTypes::bfMin:
tmp = value(ci.operators[0]);
for (int i = 1; i < ci.operators.size_s(); ++i) {
stmp = value(ci.operators[i]);
tmp = complexd(piMind(tmp.real(), stmp.real()), piMind(tmp.imag(), stmp.imag()));
}
tmpvars[oi].value = tmp;
break;
case PIEvaluatorTypes::bfMax:
tmp = value(ci.operators[0]);
for (int i = 1; i < ci.operators.size_s(); ++i) {
stmp = value(ci.operators[i]);
tmp = complexd(piMaxd(tmp.real(), stmp.real()), piMaxd(tmp.imag(), stmp.imag()));
}
tmpvars[oi].value = tmp;
break;
case PIEvaluatorTypes::bfClamp:
tmp = value(ci.operators[0]);
stmp = value(ci.operators[1]);
ttmp = value(ci.operators[2]);
tmpvars[oi].value = complexd(piClampd(tmp.real(), stmp.real(), ttmp.real()), piClampd(tmp.imag(), stmp.imag(), ttmp.imag()));
break;
case PIEvaluatorTypes::bfStep:
tmpvars[oi].value = value(ci.operators[0]).real() >= value(ci.operators[1]).real() ? complexld_1 : complexld_0;
break;
case PIEvaluatorTypes::bfMix:
tmp = value(ci.operators[0]);
stmp = value(ci.operators[1]);
ttmp = value(ci.operators[2]);
tmpvars[oi].value = stmp.real() * (1. - tmp.real()) + ttmp.real() * tmp.real();
break;
case PIEvaluatorTypes::bfRandom: case PIEvaluatorTypes::bfRandom:
tmp = static_cast<ldouble>(rand()) / RAND_MAX; tmp = static_cast<ldouble>(rand()) / RAND_MAX;
stmp = value(ci.operators[1]) - value(ci.operators[0]); stmp = value(ci.operators[1]) - value(ci.operators[0]);
@@ -1068,8 +1134,11 @@ inline bool PIEvaluator::execInstructions() {
bool PIEvaluator::check(const PIString & string) { bool PIEvaluator::check(const PIString & string) {
currentString = preprocess(string); currentString = preprocess(string);
if (!check()) correct = check();
if (!correct) {
instructions.clear();
return false; return false;
}
lastError = "Correct"; lastError = "Correct";
return true; return true;
} }

31
pievaluator.h
View File

@@ -32,7 +32,8 @@ namespace PIEvaluatorTypes {
enum eType {etNumber, etOperator, etVariable, etFunction}; enum eType {etNumber, etOperator, etVariable, etFunction};
enum Operation {oNone, oAdd, oSubtract, oMultiply, oDivide, oResidue, oPower, enum Operation {oNone, oAdd, oSubtract, oMultiply, oDivide, oResidue, oPower,
oEqual, oNotEqual, oGreater, oSmaller, oGreaterEqual, oSmallerEqual, oEqual, oNotEqual, oGreater, oSmaller, oGreaterEqual, oSmallerEqual,
oAnd, oOr, oFunction}; oAnd, oOr, oFunction
};
enum BaseFunctions {bfUnknown, bfSin, bfCos, bfTg, bfCtg, enum BaseFunctions {bfUnknown, bfSin, bfCos, bfTg, bfCtg,
bfArcsin, bfArccos, bfArctg, bfArcctg, bfArcsin, bfArccos, bfArctg, bfArcctg,
bfExp, bfRandom, bfSh, bfCh, bfTh, bfCth, bfExp, bfRandom, bfSh, bfCh, bfTh, bfCth,
@@ -40,7 +41,9 @@ namespace PIEvaluatorTypes {
bfLn, bfLg, bfLog, bfSign, bfLn, bfLg, bfLog, bfSign,
bfIm, bfRe, bfArg, bfLen, bfConj, bfIm, bfRe, bfArg, bfLen, bfConj,
bfRad, bfDeg, bfJ0, bfJ1, bfJN, bfRad, bfDeg, bfJ0, bfJ1, bfJN,
bfY0, bfY1, bfYN}; bfY0, bfY1, bfYN, bfMin, bfMax,
bfClamp, bfStep, bfMix
};
struct Instruction { struct Instruction {
Instruction() {;} Instruction() {;}
@@ -49,25 +52,29 @@ namespace PIEvaluatorTypes {
Operation operation; Operation operation;
PIVector<int> operators; PIVector<int> operators;
int out; int out;
int function;}; int function;
};
struct Element { struct Element {
Element() {;} Element() {;}
Element(eType new_type, int new_num, int new_var_num = -1) {set(new_type, new_num, new_var_num);} Element(eType new_type, int new_num, int new_var_num = -1) {set(new_type, new_num, new_var_num);}
void set(eType new_type, int new_num, int new_var_num = -1) {type = new_type; num = new_num; var_num = new_var_num;} void set(eType new_type, int new_num, int new_var_num = -1) {type = new_type; num = new_num; var_num = new_var_num;}
eType type; eType type;
int num; int num;
int var_num;}; int var_num;
};
struct Function { struct Function {
Function() {arguments = 0; type = bfUnknown;} Function() {arguments = 0; type = bfUnknown;}
Function(const PIString & name, int args, BaseFunctions ftype) {identifier = name; arguments = args; type = ftype;} Function(const PIString & name, int args, BaseFunctions ftype) {identifier = name; arguments = args; type = ftype;}
PIString identifier; PIString identifier;
BaseFunctions type; BaseFunctions type;
int arguments;}; int arguments;
};
struct Variable { struct Variable {
Variable() {value = 0.;} Variable() {value = 0.;}
Variable(const PIString & var_name, complexd val) {name = var_name; value = val;} Variable(const PIString & var_name, complexd val) {name = var_name; value = val;}
PIString name; PIString name;
complexd value;}; complexd value;
};
}; };
/* /*
≠ : ≠ :
@@ -115,10 +122,11 @@ private:
class PIP_EXPORT PIEvaluator class PIP_EXPORT PIEvaluator
{ {
public: public:
PIEvaluator() {;} PIEvaluator() {correct = false;}
~PIEvaluator() {;} ~PIEvaluator() {;}
bool check(const PIString & string); bool check(const PIString & string);
bool isCorrect() const {return correct;}
int setVariable(const PIString & name, complexd value = 0.) {if (content.findVariable(name) < 0) content.addVariable(name, value); else content.setVariableValue(name, value); return content.findVariable(name);} int setVariable(const PIString & name, complexd value = 0.) {if (content.findVariable(name) < 0) content.addVariable(name, value); else content.setVariableValue(name, value); return content.findVariable(name);}
void setVariable(int index, complexd value = 0.) {if (index >= 0 && index < content.variablesCount()) content.setVariableValue(index, value);} void setVariable(int index, complexd value = 0.) {if (index >= 0 && index < content.variablesCount()) content.setVariableValue(index, value);}
void setCustomVariableValue(int index, complexd value = 0.) {content.variables[index + content.cv_count].value = value;} void setCustomVariableValue(int index, complexd value = 0.) {content.variables[index + content.cv_count].value = value;}
@@ -126,10 +134,10 @@ public:
void removeVariable(const PIString & name) {content.removeVariable(name);} void removeVariable(const PIString & name) {content.removeVariable(name);}
void clearCustomVariables() {content.clearCustomVariables();} void clearCustomVariables() {content.clearCustomVariables();}
int variableIndex(const PIString & name) const {return content.findVariable(name);} int variableIndex(const PIString & name) const {return content.findVariable(name);}
const PIStringList & unknownVariables() {return unknownVars;} const PIStringList & unknownVariables() const {return unknownVars;}
const PIString & expression() {return currentString;} const PIString & expression() const {return currentString;}
const PIString & error() {return lastError;} const PIString & error() const {return lastError;}
const complexd & lastResult() {return out;} const complexd & lastResult() const {return out;}
PIEvaluatorContent content; PIEvaluatorContent content;
@@ -163,6 +171,7 @@ private:
PIStringList unknownVars; PIStringList unknownVars;
PIString currentString, lastError; PIString currentString, lastError;
complexd out; complexd out;
bool correct;
}; };
inline bool operator ==(PIEvaluatorTypes::Element e1, PIEvaluatorTypes::Element e2) {return (e1.type == e2.type && e1.num == e2.num);} inline bool operator ==(PIEvaluatorTypes::Element e1, PIEvaluatorTypes::Element e2) {return (e1.type == e2.type && e1.num == e2.num);}

2
pifile.cpp
View File

@@ -104,7 +104,7 @@ void PIFile::resize(llong new_size, char fill_) {
delete[] buff; delete[] buff;
return; return;
} }
piCoutObj << "[PIFile] Downsize is not support yet :-("; piCoutObj << "Downsize is not support yet :-(";
} }

85
piincludes.cpp
View File

@@ -26,6 +26,9 @@ string ifconfigPath;
PIInit piInit; PIInit piInit;
lconv * currentLocale = std::localeconv(); lconv * currentLocale = std::localeconv();
#ifdef HAS_LOCALE
static locale_t currentLocale_t = 0;
#endif
#ifdef MAC_OS #ifdef MAC_OS
clock_serv_t __pi_mac_clock; clock_serv_t __pi_mac_clock;
@@ -51,6 +54,83 @@ PIMutex __PICout_mutex__;
* \section PICout_ex0 Example * \section PICout_ex0 Example
* \snippet picout.cpp 0 * \snippet picout.cpp 0
*/ */
#ifdef WINDOWS
FILETIME __pi_ftjan1970;
long long __pi_perf_freq = -1;
PINtSetTimerResolution setTimerResolutionAddr = 0;
#endif
PIInit::PIInit() {
if (isPIInit) return;
isPIInit = true;
#ifndef WINDOWS
sigset_t ss;
sigemptyset(&ss);
sigaddset(&ss, SIGALRM);
sigprocmask(SIG_BLOCK, &ss, 0);
pthread_sigmask(SIG_BLOCK, &ss, 0);
ifconfigPath = "/bin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/sbin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/usr/bin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/usr/sbin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "";
}
}
}
}
#else
// WinSock inint
WSADATA wsaData;
WSAStartup(MAKEWORD(2, 2), &wsaData);
// Timers init
SYSTEMTIME jan1970 = {1970, 1, 4, 1, 0, 0, 0, 0};
SystemTimeToFileTime(&jan1970, &__pi_ftjan1970);
LARGE_INTEGER pf;
pf.QuadPart = -1;
if (QueryPerformanceFrequency(&pf) != 0) __pi_perf_freq = pf.QuadPart;
if (__pi_perf_freq == 0) __pi_perf_freq = -1;
// Sleep precision init
ntlib = LoadLibrary("ntdll.dll");
if (ntlib) setTimerResolutionAddr = (PINtSetTimerResolution)GetProcAddress(ntlib, "NtSetTimerResolution");
/*if (setTimerResolution) setTimerResolutionAddr(1, TRUE, &prev_res);*/
#endif
//piDebug = true;
#ifdef HAS_LOCALE
//cout << "has locale" << endl;
if (currentLocale_t != 0) {
freelocale(currentLocale_t);
currentLocale_t = 0;
}
currentLocale_t = newlocale(LC_ALL, setlocale(LC_ALL, ""), 0);
#else
setlocale(LC_ALL, "");
#endif
#ifdef MAC_OS
host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &__pi_mac_clock);
#endif
}
PIInit::~PIInit() {
#ifdef WINDOWS
WSACleanup();
//if (setTimerResolution) setTimerResolutionAddr(prev_res, TRUE, &prev_res);
if (ntlib) FreeLibrary(ntlib);
#endif
#ifdef MAC_OS
mach_port_deallocate(mach_task_self(), __pi_mac_clock);
#endif
//if (currentLocale_t != 0) freelocale(currentLocale_t);
}
#ifdef WINDOWS #ifdef WINDOWS
@@ -243,5 +323,8 @@ void PICout::applyFormat(PICoutFormat f) {
* * peering net node (\a PIPeer) * * peering net node (\a PIPeer)
* * process (\a PIProcess) * * process (\a PIProcess)
* * state machine (\a PIStateMachine) * * state machine (\a PIStateMachine)
* \n Basic using of PIP described at page \ref using_basic
* *
*/ * \page using_basic Getting started
* blablabla
*/

81
piincludes.h
View File

@@ -39,7 +39,7 @@
#define PIP_VERSION_REVISION PIP_VERSION & 0xFF #define PIP_VERSION_REVISION PIP_VERSION & 0xFF
//! Suffix of PIP version //! Suffix of PIP version
#define PIP_VERSION_SUFFIX "_r1" #define PIP_VERSION_SUFFIX "_r3"
#ifdef DOXYGEN #ifdef DOXYGEN
@@ -185,7 +185,6 @@
#include <set> #include <set>
#include <map> #include <map>
#ifdef WINDOWS #ifdef WINDOWS
typedef int socklen_t;
# include <conio.h> # include <conio.h>
# include <io.h> # include <io.h>
# include <winsock2.h> # include <winsock2.h>
@@ -199,6 +198,13 @@
# include <windows.h> # include <windows.h>
# include <wincon.h> # include <wincon.h>
# include <iphlpapi.h> # include <iphlpapi.h>
typedef int socklen_t;
typedef void(*PINtSetTimerResolution)(ULONG, BOOLEAN, PULONG);
extern FILETIME __pi_ftjan1970;
extern long long __pi_perf_freq;
extern PINtSetTimerResolution setTimerResolutionAddr;
inline long long __PIQueryPerformanceCounter() {LARGE_INTEGER li; QueryPerformanceCounter(&li); return li.QuadPart;}
inline void __PISetTimerResolution() {if (setTimerResolutionAddr == NULL) return; ULONG ret; setTimerResolutionAddr(1, TRUE, &ret);}
#else #else
# include <netinet/in.h> # include <netinet/in.h>
# include <arpa/inet.h> # include <arpa/inet.h>
@@ -276,9 +282,6 @@ using std::wstring;
#else #else
typedef std::basic_string<wchar_t> wstring; typedef std::basic_string<wchar_t> wstring;
#endif #endif
#ifdef HAS_LOCALE
static locale_t currentLocale_t = 0;
#endif
/*! \brief Templated function for swap two values /*! \brief Templated function for swap two values
* \details Example:\n \snippet piincludes.cpp swap */ * \details Example:\n \snippet piincludes.cpp swap */
@@ -339,7 +342,7 @@ template<typename T> inline T piAbs(const T & v) {return (v >= T(0) ? v : -v);}
* *
* Example: * Example:
* \snippet piincludes.cpp min2 */ * \snippet piincludes.cpp min2 */
template<typename T> inline T piMin(const T & f, const T & s) {return (f > s) ? s : f;} template<typename T> inline T piMin(const T & f, const T & s) {return ((f > s) ? s : f);}
/*! \brief Templated function return minimum of tree values /*! \brief Templated function return minimum of tree values
* \details There is some macros: * \details There is some macros:
@@ -352,7 +355,7 @@ template<typename T> inline T piMin(const T & f, const T & s) {return (f > s) ?
* *
* Example: * Example:
* \snippet piincludes.cpp min3 */ * \snippet piincludes.cpp min3 */
template<typename T> inline T piMin(const T & f, const T & s, const T & t) {return (f < s && f < t) ? f : ((s < t) ? s : t);} template<typename T> inline T piMin(const T & f, const T & s, const T & t) {return ((f < s && f < t) ? f : ((s < t) ? s : t));}
/*! \brief Templated function return maximum of two values /*! \brief Templated function return maximum of two values
* \details There is some macros: * \details There is some macros:
@@ -365,7 +368,7 @@ template<typename T> inline T piMin(const T & f, const T & s, const T & t) {retu
* *
* Example: * Example:
* \snippet piincludes.cpp max2 */ * \snippet piincludes.cpp max2 */
template<typename T> inline T piMax(const T & f, const T & s) {return (f < s) ? s : f;} template<typename T> inline T piMax(const T & f, const T & s) {return ((f < s) ? s : f);}
/*! \brief Templated function return maximum of tree values /*! \brief Templated function return maximum of tree values
* \details There is some macros: * \details There is some macros:
@@ -378,7 +381,7 @@ template<typename T> inline T piMax(const T & f, const T & s) {return (f < s) ?
* *
* Example: * Example:
* \snippet piincludes.cpp max3 */ * \snippet piincludes.cpp max3 */
template<typename T> inline T piMax(const T & f, const T & s, const T & t) {return (f > s && f > t) ? f : ((s > t) ? s : t);} template<typename T> inline T piMax(const T & f, const T & s, const T & t) {return ((f > s && f > t) ? f : ((s > t) ? s : t));}
/*! \brief Templated function return clamped value /*! \brief Templated function return clamped value
* \details Clamped is the not greater than "max" and not lesser than "min" value \n * \details Clamped is the not greater than "max" and not lesser than "min" value \n
@@ -434,58 +437,14 @@ extern string ifconfigPath;
class PIInit { class PIInit {
public: public:
PIInit() { PIInit();
if (isPIInit) return; ~PIInit();
isPIInit = true;
#ifndef WINDOWS
sigset_t ss;
sigemptyset(&ss);
sigaddset(&ss, SIGALRM);
sigprocmask(SIG_BLOCK, &ss, 0);
pthread_sigmask(SIG_BLOCK, &ss, 0);
ifconfigPath = "/bin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/sbin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/usr/bin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "/usr/sbin/ifconfig";
if (!fileExists(ifconfigPath)) {
ifconfigPath = "";
}
}
}
}
#else
WSADATA wsaData;
WSAStartup(MAKEWORD(2, 2), &wsaData);
#endif
//piDebug = true;
#ifdef HAS_LOCALE
//cout << "has locale" << endl;
if (currentLocale_t != 0) {
freelocale(currentLocale_t);
currentLocale_t = 0;
}
currentLocale_t = newlocale(LC_ALL, setlocale(LC_ALL, ""), 0);
#else
setlocale(LC_ALL, "");
#endif
#ifdef MAC_OS
host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &__pi_mac_clock);
#endif
}
~PIInit() {
#ifdef WINDOWS
WSACleanup();
#endif
#ifdef MAC_OS
mach_port_deallocate(mach_task_self(), __pi_mac_clock);
#endif
//if (currentLocale_t != 0) freelocale(currentLocale_t);
}
private: private:
bool fileExists(const string & p) {FILE * f = fopen(p.c_str(), "r"); if (f == 0) return false; fclose(f); return true;} bool fileExists(const string & p) {FILE * f = fopen(p.c_str(), "r"); if (f == 0) return false; fclose(f); return true;}
#ifdef WINDOWS
HMODULE ntlib;
ULONG prev_res;
#endif
}; };
extern PIInit piInit; extern PIInit piInit;
@@ -680,7 +639,7 @@ private:
#define piCout if (piDebug) PICout() #define piCout if (piDebug) PICout()
//! Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject //! Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject
#define piCoutObj if (piDebug && debug_) PICout() #define piCoutObj if (piDebug && debug_) PICout() << (PIString("[") + debugName() + " \"" + name() + "\"]")
class PIMutex; class PIMutex;
extern PIMutex __PICout_mutex__; extern PIMutex __PICout_mutex__;
@@ -800,6 +759,8 @@ public:
PICout operator <<(const float v); PICout operator <<(const float v);
//! Output operator for <tt>"double"</tt> values //! Output operator for <tt>"double"</tt> values
//! Output operator for pointers
PICout operator <<(const double v); PICout operator <<(const double v);
//! Output operator for \a PICoutSpecialChar values //! Output operator for \a PICoutSpecialChar values

27
piiodevice.cpp
View File

@@ -18,6 +18,7 @@
*/ */
#include "piiodevice.h" #include "piiodevice.h"
#include "piconfig.h"
/*! \class PIIODevice /*! \class PIIODevice
@@ -192,3 +193,29 @@ ullong PIIODevice::writeThreaded(const PIByteArray & data) {
write_thread.unlock(); write_thread.unlock();
return tri - 1; return tri - 1;
} }
bool PIIODevice::configure(const PIString & config_file, const PIString & section, bool parent_section) {
PIConfig conf(config_file, PIIODevice::ReadOnly);
if (!conf.isOpened()) return false;
bool ex = true;
PIConfig::Entry em;
if (section.isEmpty()) em = conf.rootEntry();
else em = conf.getValue(section, PIString(), &ex);
if (!ex) return false;
PIConfig::Entry * ep = 0;
if (parent_section) ep = em.parent();
if (ep != 0) {
setReopenEnabled(ep->getValue("reopenEnabled", reopen_enabled_, &ex));
if (!ex) setReopenEnabled(em.getValue("reopenEnabled", reopen_enabled_));
setReopenTimeout(ep->getValue("reopenTimeout", reopen_timeout_, &ex));
if (!ex) setReopenTimeout(em.getValue("reopenTimeout", reopen_timeout_));
setThreadedReadBufferSize(ep->getValue("threadedReadBufferSize", buffer_tr.size_s(), &ex));
if (!ex) setThreadedReadBufferSize(em.getValue("threadedReadBufferSize", buffer_tr.size_s()));
} else {
setReopenEnabled(em.getValue("reopenEnabled", reopen_enabled_));
setReopenTimeout(em.getValue("reopenTimeout", reopen_timeout_));
setThreadedReadBufferSize(em.getValue("threadedReadBufferSize", buffer_tr.size_s()));
}
return configureDevice(&em, ep);
}

12
piiodevice.h
View File

@@ -146,10 +146,10 @@ public:
//! Reimplement this function to read from your device //! Reimplement this function to read from your device
virtual int read(void * read_to, int max_size) {piCoutObj << "[PIIODevice] \"read\" not implemented!"; return -2;} virtual int read(void * read_to, int max_size) {piCoutObj << "\"read\" is not implemented!"; return -2;}
//! Reimplement this function to write to your device //! Reimplement this function to write to your device
virtual int write(const void * data, int max_size) {piCoutObj << "[PIIODevice] \"write\" not implemented!"; return -2;} virtual int write(const void * data, int max_size) {piCoutObj << "\"write\" is not implemented!"; return -2;}
//! Read from device maximum "max_size" bytes and return them as PIByteArray //! Read from device maximum "max_size" bytes and return them as PIByteArray
@@ -164,6 +164,10 @@ public:
//! Add task to threaded write queue and return task ID //! Add task to threaded write queue and return task ID
ullong writeThreaded(const PIByteArray & data); ullong writeThreaded(const PIByteArray & data);
//! Configure device from section "section" of file "config_file", if "parent_section" parent section also will be read
bool configure(const PIString & config_file, const PIString & section, bool parent_section = true);
EVENT_HANDLER(bool, open) {if (!init_) init(); opened_ = openDevice(); if (opened_) opened(); return opened_;} EVENT_HANDLER(bool, open) {if (!init_) init(); opened_ = openDevice(); if (opened_) opened(); return opened_;}
@@ -230,6 +234,9 @@ protected:
//! Function executed before first \a openDevice() or from constructor //! Function executed before first \a openDevice() or from constructor
virtual bool init() {return true;} virtual bool init() {return true;}
//! Reimplement to configure device from entries "e_main" and "e_parent", cast arguments to \a PIConfig::Entry*
virtual bool configureDevice(const void * e_main, const void * e_parent = 0) {return true;}
//! Reimplement to open device, return value will be set to "opened_" variable //! Reimplement to open device, return value will be set to "opened_" variable
virtual bool openDevice() = 0; // use path_, type_, opened_, init_ variables virtual bool openDevice() = 0; // use path_, type_, opened_, init_ variables
@@ -242,6 +249,7 @@ protected:
void terminate(); void terminate();
PIString path_; PIString path_;
DeviceMode mode_; DeviceMode mode_;
ReadRetFunc ret_func_; ReadRetFunc ret_func_;

3
pimath.h
View File

@@ -130,6 +130,9 @@ inline double fromDb(double val) {return pow(10., val / 10.);}
inline double toRad(double deg) {return deg * M_PI_180;} inline double toRad(double deg) {return deg * M_PI_180;}
inline double toDeg(double rad) {return rad * M_180_PI;} inline double toDeg(double rad) {return rad * M_180_PI;}
template<typename T>
inline PICout operator <<(PICout s, const complex<T> & v) {s.space(); s.setControl(0, true); s << "(" << v.real() << "; " << v.imag() << ")"; s.restoreControl(); return s;}
// [-1 ; 1] // [-1 ; 1]
inline double randomd() {return (double)random() / RAND_MAX * 2. - 1.;} inline double randomd() {return (double)random() / RAND_MAX * 2. - 1.;}
// [-1 ; 1] normal // [-1 ; 1] normal

8
pimultiprotocol.h
View File

@@ -61,15 +61,15 @@ private:
class PIRepeater: public PIMultiProtocol { class PIRepeater: public PIMultiProtocol {
public: public:
PIRepeater(const PIString & config, const PIString & name) { PIRepeater(const PIString & config, const PIString & name_) {
PIConfig conf(config, PIIODevice::ReadOnly); PIConfig conf(config, PIIODevice::ReadOnly);
if (!conf.isOpened()) { if (!conf.isOpened()) {
piCoutObj << "[PIRepeater \"" << name << "\"] Can`t open \"" << config << "\"!"; piCoutObj << "[PIRepeater \"" << name_ << "\"] Can`t open \"" << config << "\"!";
return; return;
} }
PIConfig::Entry & b(conf.getValue(name)); PIConfig::Entry & b(conf.getValue(name_));
if (b.childCount() != 2) { if (b.childCount() != 2) {
piCoutObj << "[PIRepeater \"" << name << "\"] \"" << config << "\" should consist 2 nodes!"; piCoutObj << "[PIRepeater \"" << name_ << "\"] \"" << config << "\" should consist 2 nodes!";
return; return;
} }
addProtocol(config, b.child(0)->fullName()); addProtocol(config, b.child(0)->fullName());

32
piobject.h
View File

@@ -164,7 +164,7 @@
#else #else
#define PIOBJECT(obj) typedef obj __PIObject__; #define PIOBJECT(obj) typedef obj __PIObject__; public: virtual const char * debugName() const {return #obj;} private:
#define EVENT_HANDLER0(ret, name) static ret __stat_eh_##name##__(void * o) {return ((__PIObject__*)o)->name();} ret name() #define EVENT_HANDLER0(ret, name) static ret __stat_eh_##name##__(void * o) {return ((__PIObject__*)o)->name();} ret name()
#define EVENT_HANDLER1(ret, name, a0, n0) static ret __stat_eh_##name##__(void * o, a0 n0) {return ((__PIObject__*)o)->name(n0);} ret name(a0 n0) #define EVENT_HANDLER1(ret, name, a0, n0) static ret __stat_eh_##name##__(void * o, a0 n0) {return ((__PIObject__*)o)->name(n0);} ret name(a0 n0)
@@ -243,11 +243,11 @@ typedef void (*Handler)(void * );
* *
* Example: \snippet piobject.cpp main * Example: \snippet piobject.cpp main
* Result: * Result:
* \code{.cpp} \code{.cpp}
* handler B: 2 , 0.5 handler B: 2 , 0.5
* handler A: event to handler handler A: event to handler
* handler A: event to event handler A: event to event
* \endcode \endcode
*/ */
class PIP_EXPORT PIObject class PIP_EXPORT PIObject
{ {
@@ -255,20 +255,30 @@ class PIP_EXPORT PIObject
public: public:
//! Contructs PIObject with name "name" //! Contructs PIObject with name "name"
PIObject(const PIString & name = PIString()) {piMonitor.objects++; setName(name); objects << this; debug_ = true;} PIObject(const PIString & name = PIString()) {piMonitor.objects++; setName(name); dname_ = "PIObject"; objects << this; debug_ = true;}
~PIObject() {piMonitor.objects--; objects.removeAll(this);} ~PIObject() {piMonitor.objects--; objects.removeAll(this);}
//! Returns object name //! Returns object name
const PIString & name() const {return name_;} const PIString & name() const {return name_;}
//! Set object name //! Returns object class name for debug
void setName(const PIString & name) {name_ = name;} virtual const char * debugName() const {return dname_.data();}
//! Return if debug of this object is active //! Return if debug of this object is active
bool debug() const {return debug_;} bool debug() const {return debug_;}
//! Set object name
void setName(const PIString & name) {name_ = name;}
//! Set object debug active
void setDebugName(const PIString & name) {dname_ = name;}
//! Set object debug active //! Set object debug active
void setDebug(bool debug) {debug_ = debug;} void setDebug(bool debug) {debug_ = debug;}
/* /*
PIStringList events(); PIStringList events();
PIStringList eventHandlers(); PIStringList eventHandlers();
@@ -483,7 +493,7 @@ public:
} }
protected: protected:
PIString name_; PIString name_, dname_;
bool debug_; bool debug_;
private: private:

1
pip.h
View File

@@ -30,3 +30,4 @@
#include "pipeer.h" #include "pipeer.h"
#include "picrc.h" #include "picrc.h"
#include "pistatemachine.h" #include "pistatemachine.h"
#include "piusb.h"

3
pip_0.3.6.kdev4 Normal file
View File

@@ -0,0 +1,3 @@
[Project]
Manager=KDevCMakeManager
Name=pip_0.3.6

20
pipeer.cpp
View File

@@ -152,8 +152,8 @@ void PIPeer::initMulticasts(const PIStringList & al) {
break; break;
} }
} }
if (!rec_mc) piCoutObj << "[PIPeer \"" + name_ + "\"] Can`t find suitable network interface for multicast receive, check for exists at least one interface with multicasting enabled!"; if (!rec_mc) piCoutObj << "Can`t find suitable network interface for multicast receive, check for exists at least one interface with multicasting enabled!";
if (!rec_bc) piCoutObj << "[PIPeer \"" + name_ + "\"] Can`t find suitable network interface for broadcast receive, check for exists at least one interface with broadcasting enabled!"; if (!rec_bc) piCoutObj << "Can`t find suitable network interface for broadcast receive, check for exists at least one interface with broadcasting enabled!";
} }
@@ -186,7 +186,7 @@ PIPeer::PeerInfo * PIPeer::quickestPeer(const PIString & to) {
bool PIPeer::send(const PIString & to, const void * data, int size) { bool PIPeer::send(const PIString & to, const void * data, int size) {
PeerInfo * dp = quickestPeer(to); PeerInfo * dp = quickestPeer(to);
if (dp == 0) { if (dp == 0) {
//piCoutObj << "[PIPeer \"" + name_ + "\"] Can`t find peer \"" << to << "\"!"; //piCoutObj << "Can`t find peer \"" << to << "\"!";
return false; return false;
} }
PIByteArray ba; PIByteArray ba;
@@ -248,14 +248,14 @@ bool PIPeer::dataRead(uchar * readed, int size) {
} }
PeerInfo * dp = quickestPeer(to); PeerInfo * dp = quickestPeer(to);
if (dp == 0) { if (dp == 0) {
//piCoutObj << "[PIPeer \"" + name_ + "\"] Can`t find peer \"" << to << "\"!"; //piCoutObj << "Can`t find peer \"" << to << "\"!";
return true; return true;
} }
cnt++; cnt++;
if (cnt > 100 || from == dp->name) return true; if (cnt > 100 || from == dp->name) return true;
sba << type << from << to << cnt << rec_size; sba << type << from << to << cnt << rec_size;
sba.append(ba); sba.append(ba);
//piCoutObj << "[PIPeer \"" + name_ + "\"] Translate data packet" << type << from << to << cnt << rec_size; //piCoutObj << "Translate data packet" << type << from << to << cnt << rec_size;
sendToNeighbour(dp, sba); sendToNeighbour(dp, sba);
} }
return true; return true;
@@ -287,7 +287,7 @@ bool PIPeer::multicastRead(uchar * data, int size) {
self_info.addNeighbour(pi.name); self_info.addNeighbour(pi.name);
} }
peers << pi; peers << pi;
//piCoutObj << "[PIPeer \"" + name_ + "\"] new peer \"" << pi.name << "\"" << " dist " << pi.dist; //piCoutObj << "new peer \"" << pi.name << "\"" << " dist " << pi.dist;
pi.dist++; pi.dist++;
sendSelfInfo(); sendSelfInfo();
sendPeerInfo(pi); sendPeerInfo(pi);
@@ -299,7 +299,7 @@ bool PIPeer::multicastRead(uchar * data, int size) {
case 2: // remove peer accepted case 2: // remove peer accepted
//piCout << "remove peer packet ..."; //piCout << "remove peer packet ...";
if (removePeer(pi.name)) { if (removePeer(pi.name)) {
//piCoutObj << "[PIPeer \"" + name_ + "\"] remove peer \"" << pi.name << "\""; //piCoutObj << "remove peer \"" << pi.name << "\"";
if (pi.dist == 0) { if (pi.dist == 0) {
pi.removeNeighbour(self_info.name); pi.removeNeighbour(self_info.name);
self_info.removeNeighbour(pi.name); self_info.removeNeighbour(pi.name);
@@ -325,8 +325,8 @@ bool PIPeer::multicastRead(uchar * data, int size) {
PeerInfo & peer(peers[j]); PeerInfo & peer(peers[j]);
if (peer.name == rpeer.name) { if (peer.name == rpeer.name) {
//piCout << "synced " << peer.name; //piCout << "synced " << peer.name;
peer.addresses == rpeer.addresses; peer.addresses = rpeer.addresses;
peer.netmasks == rpeer.netmasks; peer.netmasks = rpeer.netmasks;
peer.addNeighbours(rpeer.neighbours); peer.addNeighbours(rpeer.neighbours);
rpeer.neighbours = peer.neighbours; rpeer.neighbours = peer.neighbours;
if (peer.name == pi.name) peer.sync = 0; if (peer.name == pi.name) peer.sync = 0;
@@ -406,7 +406,7 @@ void PIPeer::syncPeers() {
PeerInfo & cp(peers[i]); PeerInfo & cp(peers[i]);
if (cp.sync > 3 && cp.dist == 0) { if (cp.sync > 3 && cp.dist == 0) {
pn = cp.name; pn = cp.name;
//piCoutObj << "[PIPeer \"" + name_ + "\"] sync: remove " << pn; //piCoutObj << "sync: remove " << pn;
peers.remove(i); peers.remove(i);
sendPeerRemove(pn); sendPeerRemove(pn);
--i; --i;

4
piprocess.cpp
View File

@@ -141,12 +141,12 @@ void PIProcess::run() {
WaitForSingleObject(pi.hProcess, INFINITE); WaitForSingleObject(pi.hProcess, INFINITE);
CloseHandle(pi.hProcess); CloseHandle(pi.hProcess);
} else } else
piCoutObj << "[PIProcess] \"CreateProcess\" error, " << errorString(); piCoutObj << "\"CreateProcess\" error, " << errorString();
#else #else
//cout << "exec " << tf_in << ", " << tf_out << ", " << tf_err << endl; //cout << "exec " << tf_in << ", " << tf_out << ", " << tf_err << endl;
if (execve(str.c_str(), a, e) < 0) if (execve(str.c_str(), a, e) < 0)
piCoutObj << "[PIProcess] \"execve\" error, " << errorString(); piCoutObj << "\"execve\" error, " << errorString();
} else { } else {
msleep(1); msleep(1);
//cout << "wait" << endl; //cout << "wait" << endl;

90
piprotocol.cpp
View File

@@ -20,13 +20,13 @@
#include "piprotocol.h" #include "piprotocol.h"
PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * recHeaderPtr, int recHeaderSize, void * recDataPtr, int recDataSize, void * sendDataPtr_, int sendDataSize_): PIObject() { PIProtocol::PIProtocol(const PIString & config, const PIString & name_, void * recHeaderPtr, int recHeaderSize, void * recDataPtr, int recDataSize, void * sendDataPtr_, int sendDataSize_): PIObject() {
init(); init();
protName = name; protName = name_;
PIObject::setName(name); PIObject::setName(name_);
PIConfig conf(config, PIIODevice::ReadOnly); PIConfig conf(config, PIIODevice::ReadOnly);
if (!conf.isOpened()) { if (!conf.isOpened()) {
piCoutObj << "[PIProtocol \"" << name << "\"] Can`t open \"" << config << "\"!"; piCoutObj << "Can`t open \"" << config << "\"!";
devReceiverState = devSenderState = "Config error"; devReceiverState = devSenderState = "Config error";
return; return;
} }
@@ -34,14 +34,14 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
bool ok, gok, flag, gflag, has_dev = false; bool ok, gok, flag, gflag, has_dev = false;
float freq, gfreq; float freq, gfreq;
PIFlags<PISerial::Parameters> pp(0); PIFlags<PISerial::Parameters> pp(0);
PIConfig::Entry & b(conf.getValue(name)), PIConfig::Entry & b(conf.getValue(name_)),
& rb(b.getValue("receiver")), & rb(b.getValue("receiver")),
& sb(b.getValue("sender")); & sb(b.getValue("sender"));
PIString dev, gdev; PIString dev, gdev;
/// receiver section /// receiver section
if (rb.isEntryExists("ip") && rb.isEntryExists("device")) { if (rb.isEntryExists("ip") && rb.isEntryExists("device")) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receiver type in \"" << config << "\"!"; piCoutObj << "Ambiguous receiver type in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -50,7 +50,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) dev = gdev; if (gok && !ok) dev = gdev;
if (gok && ok && (dev != gdev)) { if (gok && ok && (dev != gdev)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receiver type in \"" << config << "\"!"; piCoutObj << "Ambiguous receiver type in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -59,7 +59,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) ps = gps; if (gok && !ok) ps = gps;
if (gok && ok && (ps != gps)) { if (gok && ok && (ps != gps)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receive port in \"" << config << "\"!"; piCoutObj << "Ambiguous receive port in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -74,7 +74,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous \"reconnectEnabled\" flag in \"" << config << "\"!"; piCoutObj << "Ambiguous \"reconnectEnabled\" flag in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -85,18 +85,18 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) freq = gfreq; if (gok && !ok) freq = gfreq;
if (gok && ok && (freq != gfreq)) { if (gok && ok && (freq != gfreq)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous \"reconnectTimeout\" value in \"" << config << "\"!"; piCoutObj << "Ambiguous \"reconnectTimeout\" value in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
eth->setReopenTimeout(freq * 1000); eth->setReopenTimeout(freq * 1000);
} }
if (recDataPtr == 0) if (recDataPtr == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null receive data pointer!"; piCoutObj << "Warning: null receive data pointer!";
if (recDataSize == 0) if (recDataSize == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null receive data size!"; piCoutObj << "Warning: null receive data size!";
} else { } else {
piCoutObj << "[PIProtocol \"" << name << "\"] Can`t find \"" << name << ".receiver.port\" or \"" << name << ".port\" in \"" << config << "\"!"; piCoutObj << "Can`t find \"" << name_ << ".receiver.port\" or \"" << name_ << ".port\" in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -106,7 +106,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) dev = gdev; if (gok && !ok) dev = gdev;
if (gok && ok && (dev != gdev)) { if (gok && ok && (dev != gdev)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receiver type in \"" << config << "\"!"; piCoutObj << "Ambiguous receiver type in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -115,7 +115,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) ps = gps; if (gok && !ok) ps = gps;
if (gok && ok && (ps != gps)) { if (gok && ok && (ps != gps)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receive \"speed\" in \"" << config << "\"!"; piCoutObj << "Ambiguous receive \"speed\" in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -124,7 +124,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receive \"parity\" in \"" << config << "\"!"; piCoutObj << "Ambiguous receive \"parity\" in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -135,7 +135,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receive \"twoStopBits\" parity in \"" << config << "\"!"; piCoutObj << "Ambiguous receive \"twoStopBits\" parity in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -154,7 +154,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) ps = gps; if (gok && !ok) ps = gps;
if (gok && ok && (ps != gps)) { if (gok && ok && (ps != gps)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receive \"vtime\" in \"" << config << "\"!"; piCoutObj << "Ambiguous receive \"vtime\" in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -162,11 +162,11 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
} }
has_dev = true; has_dev = true;
if (recDataPtr == 0) if (recDataPtr == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null receive data pointer!"; piCoutObj << "Warning: null receive data pointer!";
if (recDataSize == 0) if (recDataSize == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null receive data size!"; piCoutObj << "Warning: null receive data size!";
} else { } else {
piCoutObj << "[PIProtocol \"" << name << "\"] Can`t find \"" << name << ".receiver.speed\" or \"" << name << ".speed\" in \"" << config << "\"!"; piCoutObj << "Can`t find \"" << name_ << ".receiver.speed\" or \"" << name_ << ".speed\" in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -176,7 +176,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) history_write_rec = ghist; if (gok && !ok) history_write_rec = ghist;
if (gok && ok && (history_write_rec != ghist)) { if (gok && ok && (history_write_rec != ghist)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous receiver history in \"" << config << "\"!"; piCoutObj << "Ambiguous receiver history in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -187,7 +187,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
history_id_rec = rb.getValue("historyID", 0, &ok); history_id_rec = rb.getValue("historyID", 0, &ok);
if (!ok) { if (!ok) {
history_id_rec = protName.toByteArray().checksumCRC16(); history_id_rec = protName.toByteArray().checksumCRC16();
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: no receiver history ID defined, write with ID = " << history_id_rec; piCoutObj << "Warning: no receiver history ID defined, write with ID = " << history_id_rec;
} }
history_file_rec.open(history_path_rec, PIIODevice::WriteOnly); history_file_rec.open(history_path_rec, PIIODevice::WriteOnly);
} }
@@ -196,21 +196,21 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
gfreq = b.getValue("frequency", -1.f, &gok); gfreq = b.getValue("frequency", -1.f, &gok);
if (gok && !ok) freq = gfreq; if (gok && !ok) freq = gfreq;
if (gok && ok && (freq != gfreq)) { if (gok && ok && (freq != gfreq)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous expected frequency in \"" << config << "\"!"; piCoutObj << "Ambiguous expected frequency in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
if (freq > 0.f && !has_dev) if (freq > 0.f && !has_dev)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: no receiver device and not null expected frequency!"; piCoutObj << "Warning: no receiver device and not null expected frequency!";
float tm = b.getValue("disconnectTimeout", 3.f); float tm = b.getValue("disconnectTimeout", 3.f);
if (tm <= 0.f) if (tm <= 0.f)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: diconnect timeout <= 0 s!"; piCoutObj << "Warning: diconnect timeout <= 0 s!";
timeout_ = (tm < 0.f) ? 0.f : tm; timeout_ = (tm < 0.f) ? 0.f : tm;
setExpectedFrequency(freq); setExpectedFrequency(freq);
/// sender section /// sender section
if (sb.isEntryExists("ip") && sb.isEntryExists("device")) { if (sb.isEntryExists("ip") && sb.isEntryExists("device")) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous sender type in \"" << config << "\"!"; piCoutObj << "Ambiguous sender type in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -220,7 +220,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) dev = gdev; if (gok && !ok) dev = gdev;
if (gok && ok && (dev != gdev)) { if (gok && ok && (dev != gdev)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous sender type in \"" << config << "\"!"; piCoutObj << "Ambiguous sender type in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -229,7 +229,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) ps = gps; if (gok && !ok) ps = gps;
if (gok && ok && (ps != gps)) { if (gok && ok && (ps != gps)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous send port in \"" << config << "\"!"; piCoutObj << "Ambiguous send port in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -243,7 +243,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous \"reconnectEnabled\" flag in \"" << config << "\"!"; piCoutObj << "Ambiguous \"reconnectEnabled\" flag in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
@@ -254,18 +254,18 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) freq = gfreq; if (gok && !ok) freq = gfreq;
if (gok && ok && (freq != gfreq)) { if (gok && ok && (freq != gfreq)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous \"reconnectTimeout\" value in \"" << config << "\"!"; piCoutObj << "Ambiguous \"reconnectTimeout\" value in \"" << config << "\"!";
devReceiverState = "Config error"; devReceiverState = "Config error";
return; return;
} }
eth->setReopenTimeout(freq * 1000); eth->setReopenTimeout(freq * 1000);
} }
if (sendDataPtr_ == 0) if (sendDataPtr_ == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null send data pointer!"; piCoutObj << "Warning: null send data pointer!";
if (sendDataSize_ == 0) if (sendDataSize_ == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null send data size!"; piCoutObj << "Warning: null send data size!";
} else { } else {
piCoutObj << "[PIProtocol \"" << name << "\"] Can`t find \"" << name << ".sender.port\" or \"" << name << ".port\" in \"" << config << "\"!"; piCoutObj << "Can`t find \"" << name_ << ".sender.port\" or \"" << name_ << ".port\" in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -275,7 +275,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) dev = gdev; if (gok && !ok) dev = gdev;
if (gok && ok && (dev != gdev)) { if (gok && ok && (dev != gdev)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous sender type in \"" << config << "\"!"; piCoutObj << "Ambiguous sender type in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -284,7 +284,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) ps = gps; if (gok && !ok) ps = gps;
if (gok && ok && (ps != gps)) { if (gok && ok && (ps != gps)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous send \"speed\" in \"" << config << "\"!"; piCoutObj << "Ambiguous send \"speed\" in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -293,7 +293,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous send \"parity\" in \"" << config << "\"!"; piCoutObj << "Ambiguous send \"parity\" in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -304,14 +304,14 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
if (ok || gok) { if (ok || gok) {
if (gok && !ok) flag = gflag; if (gok && !ok) flag = gflag;
if (gok && ok && (flag != gflag)) { if (gok && ok && (flag != gflag)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous send \"twoStopBits\" parity in \"" << config << "\"!"; piCoutObj << "Ambiguous send \"twoStopBits\" parity in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
pp.setFlag(PISerial::TwoStopBits, flag); pp.setFlag(PISerial::TwoStopBits, flag);
} }
} else { } else {
piCoutObj << "[PIProtocol \"" << name << "\"] Can`t find \"" << name << ".sender.speed\" or \"" << name << ".speed\" in \"" << config << "\"!"; piCoutObj << "Can`t find \"" << name_ << ".sender.speed\" or \"" << name_ << ".speed\" in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -322,16 +322,16 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
ser->setParameters(pp); ser->setParameters(pp);
has_dev = true; has_dev = true;
if (sendDataPtr_ == 0) if (sendDataPtr_ == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null send data pointer!"; piCoutObj << "Warning: null send data pointer!";
if (sendDataSize_ == 0) if (sendDataSize_ == 0)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: null send data size!"; piCoutObj << "Warning: null send data size!";
} }
history_write_send = sb.getValue("writeHistory", false, &ok); history_write_send = sb.getValue("writeHistory", false, &ok);
ghist = b.getValue("writeHistory", false, &gok); ghist = b.getValue("writeHistory", false, &gok);
if (ok || gok) { if (ok || gok) {
if (gok && !ok) history_write_send = ghist; if (gok && !ok) history_write_send = ghist;
if (gok && ok && (history_write_send != ghist)) { if (gok && ok && (history_write_send != ghist)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous sender history in \"" << config << "\"!"; piCoutObj << "Ambiguous sender history in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
@@ -342,7 +342,7 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
history_id_send = sb.getValue("historyID", 0, &ok); history_id_send = sb.getValue("historyID", 0, &ok);
if (!ok) { if (!ok) {
history_id_send = protName.toByteArray().checksumCRC16() + 1; history_id_send = protName.toByteArray().checksumCRC16() + 1;
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: no sender history ID defined, write with ID = " << history_id_send; piCoutObj << "Warning: no sender history ID defined, write with ID = " << history_id_send;
} }
history_file_send.open(history_path_send, PIIODevice::WriteOnly); history_file_send.open(history_path_send, PIIODevice::WriteOnly);
} }
@@ -351,12 +351,12 @@ PIProtocol::PIProtocol(const PIString & config, const PIString & name, void * re
gfreq = b.getValue("frequency", -1.f, &gok); gfreq = b.getValue("frequency", -1.f, &gok);
if (gok && !ok) freq = gfreq; if (gok && !ok) freq = gfreq;
if (gok && ok && (freq != gfreq)) { if (gok && ok && (freq != gfreq)) {
piCoutObj << "[PIProtocol \"" << name << "\"] Ambiguous sender frequency in \"" << config << "\"!"; piCoutObj << "Ambiguous sender frequency in \"" << config << "\"!";
devSenderState = "Config error"; devSenderState = "Config error";
return; return;
} }
if (freq > 0.f && !has_dev) if (freq > 0.f && !has_dev)
piCoutObj << "[PIProtocol \"" << name << "\"] Warning: no sender device and not null send frequency!"; piCoutObj << "Warning: no sender device and not null send frequency!";
setSenderFrequency(freq); setSenderFrequency(freq);
headerPtr = (uchar * )recHeaderPtr; headerPtr = (uchar * )recHeaderPtr;

64
piserial.cpp
View File

@@ -18,6 +18,7 @@
*/ */
#include "piserial.h" #include "piserial.h"
#include "piconfig.h"
PISerial::PISerial(const PIString & device, void * data_, ReadRetFunc slot): PIIODevice(device, ReadWrite) { PISerial::PISerial(const PIString & device, void * data_, ReadRetFunc slot): PIIODevice(device, ReadWrite) {
@@ -67,14 +68,14 @@ bool PISerial::setPin(int number, bool on) {
case 3: return setST(on); break; case 3: return setST(on); break;
case 4: return setDTR(on); break; case 4: return setDTR(on); break;
case 5: case 5:
piCoutObj << "[PISerial] Pin number 5 is ground"; piCoutObj << "Pin number 5 is ground";
return false; return false;
case 6: return setDSR(on); break; case 6: return setDSR(on); break;
case 7: return setRTS(on); break; case 7: return setRTS(on); break;
case 8: return setCTS(on); break; case 8: return setCTS(on); break;
case 9: return setRNG(on); break; case 9: return setRNG(on); break;
default: default:
piCoutObj << "[PISerial] Pin number " << number << " doesn`t exists!"; piCoutObj << "Pin number " << number << " doesn`t exists!";
return false; return false;
} }
return false; return false;
@@ -93,7 +94,7 @@ bool PISerial::isPin(int number) const {
case 8: return isCTS(); break; case 8: return isCTS(); break;
case 9: return isRNG(); break; case 9: return isRNG(); break;
default: default:
piCoutObj << "[PISerial] Pin number " << number << " doesn`t exists!"; piCoutObj << "Pin number " << number << " doesn`t exists!";
return false; return false;
} }
return false; return false;
@@ -103,16 +104,16 @@ bool PISerial::isPin(int number) const {
bool PISerial::setBit(int bit, bool on, const PIString & bname) { bool PISerial::setBit(int bit, bool on, const PIString & bname) {
#ifndef WINDOWS #ifndef WINDOWS
if (fd < 0) { if (fd < 0) {
piCoutObj << "[PISerial] set" << bname << " error: \"" << path_ << "\" is not opened!"; piCoutObj << "set" << bname << " error: \"" << path_ << "\" is not opened!";
return false; return false;
} }
if (ioctl(fd, on ? TIOCMBIS : TIOCMBIC, &bit) < 0) { if (ioctl(fd, on ? TIOCMBIS : TIOCMBIC, &bit) < 0) {
piCoutObj << "[PISerial] set" << bname << " error: " << errorString(); piCoutObj << "set" << bname << " error: " << errorString();
return false; return false;
} }
return true; return true;
#else #else
piCoutObj << "[PISerial] set" << bname << " doesn`t implemented on Windows, sorry :-("; piCoutObj << "set" << bname << " doesn`t implemented on Windows, sorry :-(";
return false; return false;
#endif #endif
} }
@@ -121,15 +122,15 @@ bool PISerial::setBit(int bit, bool on, const PIString & bname) {
bool PISerial::isBit(int bit, const PIString & bname) const { bool PISerial::isBit(int bit, const PIString & bname) const {
#ifndef WINDOWS #ifndef WINDOWS
if (fd < 0) { if (fd < 0) {
piCoutObj << "[PISerial] is" << bname << " error: \"" << path_ << "\" is not opened!"; piCoutObj << "is" << bname << " error: \"" << path_ << "\" is not opened!";
return false; return false;
} }
int ret = 0; int ret = 0;
if (ioctl(fd, TIOCMGET, &ret) < 0) if (ioctl(fd, TIOCMGET, &ret) < 0)
piCoutObj << "[PISerial] is" << bname << " error: " << errorString(); piCoutObj << "is" << bname << " error: " << errorString();
return ret & bit; return ret & bit;
#else #else
piCoutObj << "[PISerial] set" << bname << " doesn`t implemented on Windows, sorry :-("; piCoutObj << "set" << bname << " doesn`t implemented on Windows, sorry :-(";
return false; return false;
#endif #endif
} }
@@ -301,7 +302,7 @@ bool PISerial::openDevice() {
if (isWriteable()) {ds |= GENERIC_WRITE; sm |= FILE_SHARE_WRITE;} if (isWriteable()) {ds |= GENERIC_WRITE; sm |= FILE_SHARE_WRITE;}
hCom = CreateFileA(path_.data(), ds, sm, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0); hCom = CreateFileA(path_.data(), ds, sm, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
if(hCom == INVALID_HANDLE_VALUE) { if(hCom == INVALID_HANDLE_VALUE) {
piCoutObj << "[PISerial] Unable to open \"" << path_ << "\""; piCoutObj << "Unable to open \"" << path_ << "\"";
return false; return false;
} }
fd = 0; fd = 0;
@@ -312,7 +313,7 @@ bool PISerial::openDevice() {
times.WriteTotalTimeoutConstant = 1; times.WriteTotalTimeoutConstant = 1;
times.WriteTotalTimeoutMultiplier = 0; times.WriteTotalTimeoutMultiplier = 0;
if (SetCommTimeouts(hCom, &times) == -1) { if (SetCommTimeouts(hCom, &times) == -1) {
piCoutObj << "[PISerial] Unable to set timeouts for \"" << path_ << "\""; piCoutObj << "Unable to set timeouts for \"" << path_ << "\"";
CloseHandle(hCom); CloseHandle(hCom);
fd = -1; fd = -1;
return false; return false;
@@ -330,7 +331,7 @@ bool PISerial::openDevice() {
} }
desc.StopBits = params[PISerial::TwoStopBits] ? TWOSTOPBITS : ONESTOPBIT; desc.StopBits = params[PISerial::TwoStopBits] ? TWOSTOPBITS : ONESTOPBIT;
if (SetCommState(hCom, &desc) == -1) { if (SetCommState(hCom, &desc) == -1) {
piCoutObj << "[PISerial] Unable to set comm state for \"" << path_ << "\""; piCoutObj << "Unable to set comm state for \"" << path_ << "\"";
CloseHandle(hCom); CloseHandle(hCom);
fd = -1; fd = -1;
return false; return false;
@@ -345,7 +346,7 @@ bool PISerial::openDevice() {
//cout << "init ser " << path_ << " mode " << om << " param " << params << endl; //cout << "init ser " << path_ << " mode " << om << " param " << params << endl;
fd = ::open(path_.data(), O_NOCTTY | om); fd = ::open(path_.data(), O_NOCTTY | om);
if(fd == -1) { if(fd == -1) {
piCoutObj << "[PISerial] Unable to open \"" << path_ << "\""; piCoutObj << "Unable to open \"" << path_ << "\"";
return false; return false;
} }
@@ -371,20 +372,33 @@ bool PISerial::openDevice() {
fcntl(fd, F_SETFL, 0); fcntl(fd, F_SETFL, 0);
if(tcsetattr(fd, TCSANOW, &desc) < 0) { if(tcsetattr(fd, TCSANOW, &desc) < 0) {
piCoutObj << "[PISerial] Can`t set attributes for \"" << path_ << "\""; piCoutObj << "Can`t set attributes for \"" << path_ << "\"";
::close(fd); ::close(fd);
return false; return false;
} }
//piCoutObj << "[PISerial] Initialized " << path_; //piCoutObj << "Initialized " << path_;
#endif #endif
return true; return true;
} }
int PISerial::read(void * read_to, int max_size) {
#ifdef WINDOWS
if (!canRead()) return -1;
WaitCommEvent(hCom, 0, 0);
ReadFile(hCom, read_to, max_size, &readed, 0);
return readed;
#else
if (!canRead()) return -1;
return ::read(fd, read_to, max_size);
#endif
}
int PISerial::write(const void * data, int max_size, bool wait) { int PISerial::write(const void * data, int max_size, bool wait) {
//piCoutObj << "[PISerial] send " << max_size << ": " << PIString((char*)data, max_size); //piCoutObj << "send " << max_size << ": " << PIString((char*)data, max_size);
if (fd == -1 || !canWrite()) { if (fd == -1 || !canWrite()) {
//piCoutObj << "[PISerial] Can`t write to uninitialized COM"; //piCoutObj << "Can`t write to uninitialized COM";
return -1; return -1;
} }
#ifdef WINDOWS #ifdef WINDOWS
@@ -402,6 +416,18 @@ int PISerial::write(const void * data, int max_size, bool wait) {
if (wait) tcdrain(fd); if (wait) tcdrain(fd);
#endif #endif
return (int)wrote; return (int)wrote;
//piCoutObj << "[PISerial] Error while sending"; //piCoutObj << "Error while sending";
//piCoutObj << "[PISerial] Wrote " << wrote << " bytes in " << path_; //piCoutObj << "Wrote " << wrote << " bytes in " << path_;
}
bool PISerial::configureDevice(const void * e_main, const void * e_parent) {
PIConfig::Entry * em = (PIConfig::Entry * )e_main;
PIConfig::Entry * ep = (PIConfig::Entry * )e_parent;
setDevice(readDeviceSetting<PIString>("device", device(), em, ep));
setSpeed((PISerial::Speed)(readDeviceSetting<int>("speed", (int)ospeed, em, ep)));
setParameter(PISerial::ParityControl, readDeviceSetting<bool>("parityControl", isParameterSet(PISerial::ParityControl), em, ep));
setParameter(PISerial::ParityOdd, readDeviceSetting<bool>("parityOdd", isParameterSet(PISerial::ParityOdd), em, ep));
setParameter(PISerial::TwoStopBits, readDeviceSetting<bool>("twoStopBits", isParameterSet(PISerial::TwoStopBits), em, ep));
return true;
} }

14
piserial.h
View File

@@ -182,17 +182,7 @@ public:
void flush() {if (fd != -1) tcflush(fd, TCIOFLUSH);} void flush() {if (fd != -1) tcflush(fd, TCIOFLUSH);}
#endif #endif
int read(void * read_to, int max_size) { int read(void * read_to, int max_size);
#ifdef WINDOWS
if (!canRead()) return -1;
WaitCommEvent(hCom, 0, 0);
ReadFile(hCom, read_to, max_size, &readed, 0);
return readed;
#else
if (!canRead()) return -1;
return ::read(fd, read_to, max_size);
#endif
}
bool read(void * data, int size, double timeout_ms); bool read(void * data, int size, double timeout_ms);
PIString read(int size = -1, double timeout_ms = 1000.); PIString read(int size = -1, double timeout_ms = 1000.);
PIByteArray readData(int size = -1, double timeout_ms = 1000.); PIByteArray readData(int size = -1, double timeout_ms = 1000.);
@@ -203,8 +193,8 @@ public:
bool send(const PIString & data, bool wait = false) {return (write(data.data(), data.lengthAscii(), wait) == data.size_s());} bool send(const PIString & data, bool wait = false) {return (write(data.data(), data.lengthAscii(), wait) == data.size_s());}
bool send(const PIByteArray & data, bool wait = false) {return (write(data.data(), data.size_s(), wait) == data.size_s());} bool send(const PIByteArray & data, bool wait = false) {return (write(data.data(), data.size_s(), wait) == data.size_s());}
protected: protected:
bool configureDevice(const void * e_main, const void * e_parent = 0);
virtual void received(void * data, int size) {;} virtual void received(void * data, int size) {;}
int convertSpeed(PISerial::Speed speed); int convertSpeed(PISerial::Speed speed);

2
pisystemmonitor.cpp
View File

@@ -42,7 +42,7 @@ bool PISystemMonitor::startOnProcess(int pID) {
file.open("/proc/" + PIString::fromNumber(pID_) + "/stat", PIIODevice::ReadOnly); file.open("/proc/" + PIString::fromNumber(pID_) + "/stat", PIIODevice::ReadOnly);
filem.open("/proc/" + PIString::fromNumber(pID_) + "/statm", PIIODevice::ReadOnly); filem.open("/proc/" + PIString::fromNumber(pID_) + "/statm", PIIODevice::ReadOnly);
if (!file.isOpened()) { if (!file.isOpened()) {
piCoutObj << "[PISystemMonitor] Can`t find process with ID = " << pID_ << "!"; piCoutObj << "Can`t find process with ID = " << pID_ << "!";
return false; return false;
} }
cycle = -1; cycle = -1;

9
pisystemtests.cpp
View File

@@ -31,14 +31,11 @@ namespace PISystemTests {
PISystemTests::PISystemTestReader::PISystemTestReader() { PISystemTests::PISystemTestReader::PISystemTestReader() {
PIConfig conf(
#ifndef WINDOWS #ifndef WINDOWS
"/etc/pip.conf" PIConfig conf("/etc/pip.conf", PIIODevice::ReadOnly);
#else conf.setReopenEnabled(false);
"pip.conf"
#endif
, PIIODevice::ReadOnly);
time_resolution_ns = conf.getValue("time_resolution_ns", 1); time_resolution_ns = conf.getValue("time_resolution_ns", 1);
time_elapsed_ns = conf.getValue("time_elapsed_ns", 0); time_elapsed_ns = conf.getValue("time_elapsed_ns", 0);
usleep_offset_us = conf.getValue("usleep_offset_us", 60); usleep_offset_us = conf.getValue("usleep_offset_us", 60);
#endif
} }

62
pithread.cpp
View File

@@ -36,27 +36,47 @@ void piUSleep(int usecs) {
* \details This class allow you exec your code in separate thread. * \details This class allow you exec your code in separate thread.
* *
* \section PIThread_sec0 Synopsis * \section PIThread_sec0 Synopsis
* Multithread . * Multithreading allow you to write program which will be executed
* in several threads simultaneously. This trend allow you to use all
* cores of modern processors, but there are many dangers.
* *
* \section PIThread_sec1 To/from data convertions * This class provide virtual functions \a begin(), \a run() and \a end(),
* Most common constructor is \a PIThread(const char * str), where "str" * which describes start, execution and finish work of some process.
* is null-terminated string, e.g. \c "string". This is 7 chars with last char = 0. * These functions executes in \b separate thread. When you execute
* Also you can constructs \a PIThread from single \a PIChar, \a PIByteArray, * \a start(), %PIThread create separate system thread and sequentially
* other \a PIThread or sequency of the same characters with custom length.\n \n * executes function \a begin(), \a run() and \a end(). You can
* This class has implicit conversions to <tt>const char * </tt> and * reimplement each function and write your own code to execute.
* \c std::string. Also there are functions to make same convertions: * Scheme of functions executing:
* * \a data() - to <tt>const char * </tt>, \code{.cpp}
* * \a stdString() - to \c std::string, begin();
* * \a toByteArray() - to \a PIByteArray. event started();
while (isRunning()) {
run();
ThreadFunc();
msleep(timer_delay);
}
event stopped();
end();
\endcode
* Unlike from directly using "pthread" or some similar you doesn`t need
* to write your own main thread cycle and sleep at every cycle end.
* %PIThread make it for you, and your job is to set sleep value from
* contructor or when starting thread, and reimplement \a begin(), \a run()
* and \a end() functions.
* *
* \section PIThread_sec2 Numeric operations * \section PIThread_sec1 Using without subclassing
* You can get symbolic representation of any numeric value with function * You can use %PIThread without subclassing by using "ThreadFunc" pointer
* \a setNumber(any integer value, int base = 10, bool * ok = 0). Default * that can be set from constructor or by overloaded function \a start(ThreadFunc func, int timer_delay).
* arguments are set for decimal base system, but you can choose any system * If "func" if not null this function will be executed as \a run(). ThreadFunc is any static
* from 2 to 40. There are the same static functions \a fromNumber(), that * function with format void func(void * data). "Data" is custom data set from constructor or
* returns \a PIThread. \n * with function \a setData(). \n Also you can connect to event \a started(), but
* Also there is function \a setReadableSize() which is set human-readable * in this case you should to white your thread main cycle, because this event raised only one time.
* size in bytes, Kb, Mb, Gb or Pb. Static analog is \a readableSize(). *
* \section PIThread_sec2 Locking
* %PIThread has inrternal mutex that can be locked and unlocked every \a run() if you set this flag
* with function \a needLockRun(bool). Also you can access to this mutex by functions \a lock(), \a unlock()
* and \a mutex(). Using this functions together with needLockRun(true) can guarantee one-thread access to
* some data.
* *
*/ */
@@ -163,6 +183,8 @@ void * PIThread::thread_function(void * t) {
#ifndef WINDOWS #ifndef WINDOWS
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, 0); pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, 0);
pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, 0); pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, 0);
#else
__PISetTimerResolution();
#endif #endif
PIThread & ct = *((PIThread * )t); PIThread & ct = *((PIThread * )t);
ct.running = true; ct.running = true;
@@ -192,6 +214,8 @@ void * PIThread::thread_function_once(void * t) {
#ifndef WINDOWS #ifndef WINDOWS
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, 0); pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, 0);
pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, 0); pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, 0);
#else
__PISetTimerResolution();
#endif #endif
PIThread & ct = *((PIThread * )t); PIThread & ct = *((PIThread * )t);
ct.running = true; ct.running = true;

10
pithread.h
View File

@@ -59,7 +59,11 @@ class PIP_EXPORT PIThread: public PIObject
{ {
PIOBJECT(PIThread) PIOBJECT(PIThread)
public: public:
//! Contructs thread with custom data "data", external function "func" and main cycle delay "timer_delay".
PIThread(void * data, ThreadFunc func, bool startNow = false, int timer_delay = -1); PIThread(void * data, ThreadFunc func, bool startNow = false, int timer_delay = -1);
//! Contructs thread with main cycle delay "timer_delay".
PIThread(bool startNow = false, int timer_delay = -1); PIThread(bool startNow = false, int timer_delay = -1);
virtual ~PIThread(); virtual ~PIThread();
@@ -208,8 +212,14 @@ protected:
static void * thread_function(void * t); static void * thread_function(void * t);
static void * thread_function_once(void * t); static void * thread_function_once(void * t);
//! Function executed once at the start of thread.
virtual void begin() {;} virtual void begin() {;}
//! Function executed at every "timer_delay" msecs until thread was stopped.
virtual void run() {;} virtual void run() {;}
//! Function executed once at the end of thread.
virtual void end() {;} virtual void end() {;}
volatile bool terminating, running, lockRun; volatile bool terminating, running, lockRun;

98
pitimer.cpp
View File

@@ -46,7 +46,21 @@
* Example: \snippet pitimer.cpp elapsed * Example: \snippet pitimer.cpp elapsed
*/ */
/*! \class PISystemTime
* \brief System time
*
* \section PISystemTime_sec0 Synopsis
* This class provide arithmetic functions for POSIX system time.
* This time represents as seconds and nanosecons in integer formats.
* You can take current system time with function \a currentSystemTime(),
* compare times, sum or subtract two times, convert time to/from
* seconds, milliseconds, microseconds or nanoseconds.
* \section PISystemTime_sec1 Example
* \snippet pitimer.cpp system_time
*/
bool operator ==(const PITime & t0, const PITime & t1) { bool operator ==(const PITime & t0, const PITime & t1) {
return (t0.hours == t1.hours && t0.minutes == t1.minutes && t0.seconds == t1.seconds); return (t0.hours == t1.hours && t0.minutes == t1.minutes && t0.seconds == t1.seconds);
} }
@@ -201,7 +215,7 @@ void PITimer::start(double msecs) {
ti = timer_create(CLOCK_REALTIME, &se, &timer); ti = timer_create(CLOCK_REALTIME, &se, &timer);
//cout << "***create timer " << msecs << " msecs\n"; //cout << "***create timer " << msecs << " msecs\n";
if (ti == -1) { if (ti == -1) {
piCoutObj << "[PITimer] Can`t create timer for " << msecs << " msecs: " << errorString(); piCoutObj << "Can`t create timer for " << msecs << " msecs: " << errorString();
return; return;
} }
timer_settime(timer, 0, &spec, 0); timer_settime(timer, 0, &spec, 0);
@@ -219,7 +233,7 @@ void PITimer::deferredStart(double interval_msecs, double delay_msecs) {
ti = timer_create(CLOCK_REALTIME, &se, &timer); ti = timer_create(CLOCK_REALTIME, &se, &timer);
//cout << "***create timer\n"; //cout << "***create timer\n";
if (ti == -1) { if (ti == -1) {
piCoutObj << "[PITimer] Can`t create timer for " << interval_msecs << " msecs: " << errorString(); piCoutObj << "Can`t create timer for " << interval_msecs << " msecs: " << errorString();
return; return;
} }
timer_settime(timer, 0, &spec, 0); timer_settime(timer, 0, &spec, 0);
@@ -245,7 +259,7 @@ void PITimer::deferredStart(double interval_msecs, const PIDateTime & start_date
ti = timer_create(CLOCK_REALTIME, &se, &timer); ti = timer_create(CLOCK_REALTIME, &se, &timer);
//cout << "***create timer\n"; //cout << "***create timer\n";
if (ti == -1) { if (ti == -1) {
piCoutObj << "[PITimer] Can`t create timer for " << interval_msecs << " msecs: " << errorString(); piCoutObj << "Can`t create timer for " << interval_msecs << " msecs: " << errorString();
return; return;
} }
timer_settime(timer, TIMER_ABSTIME, &spec, 0); timer_settime(timer, TIMER_ABSTIME, &spec, 0);
@@ -273,7 +287,7 @@ void PITimer::TimerPool::begin() {
sa.sa_handler = empty_handler; sa.sa_handler = empty_handler;
sigemptyset(&sa.sa_mask); sigemptyset(&sa.sa_mask);
if (sigaction(SIGALRM, &sa, 0) == -1) { if (sigaction(SIGALRM, &sa, 0) == -1) {
piCoutObj << "[PITimer] sigaction error: " << errorString(); piCoutObj << "sigaction error: " << errorString();
stop(); stop();
return; return;
}*/ }*/
@@ -287,12 +301,12 @@ void PITimer::TimerPool::begin() {
spec.it_value = spec.it_interval; spec.it_value = spec.it_interval;
//cout << "***create pool timer\n"; //cout << "***create pool timer\n";
if (timer_create(CLOCK_REALTIME, &se, &timer) == -1) { if (timer_create(CLOCK_REALTIME, &se, &timer) == -1) {
piCoutObj << "[PITimer] Can`t create timer for pool: " << errorString(); piCoutObj << "Can`t create timer for pool: " << errorString();
stop(); stop();
return; return;
} }
if (timer_settime(timer, 0, &spec, 0) == -1) { if (timer_settime(timer, 0, &spec, 0) == -1) {
piCoutObj << "[PITimer] Can`t set timer for pool: " << errorString(); piCoutObj << "Can`t set timer for pool: " << errorString();
stop(); stop();
return; return;
} }
@@ -430,8 +444,12 @@ void PITimer::run() {
deferred_ = false; deferred_ = false;
if (!running_) return; if (!running_) return;
} }
#ifdef WINDOWS
tt_st = __PIQueryPerformanceCounter();
#else
(st_time - currentSystemTime()).sleep(); (st_time - currentSystemTime()).sleep();
st_time += inc_time; st_time += inc_time;
#endif
//if (lockRun) lock(); //if (lockRun) lock();
if (ret_func != 0) ret_func(data, 1); if (ret_func != 0) ret_func(data, 1);
timeout(data, 1); timeout(data, 1);
@@ -444,6 +462,11 @@ void PITimer::run() {
timeout(data, i.delim); timeout(data, i.delim);
tick(data, i.delim); tick(data, i.delim);
} }
#ifdef WINDOWS
tt_cur = __PIQueryPerformanceCounter();
double cdelay = interval_ - ((tt_cur - tt_st) / double(__pi_perf_freq) * 1.E+3);
if (cdelay > 0.) Sleep(piRoundd(cdelay));
#endif
//if (lockRun) unlock(); //if (lockRun) unlock();
} }
@@ -451,8 +474,10 @@ void PITimer::run() {
double PITimer::elapsed_n() { double PITimer::elapsed_n() {
#ifdef WINDOWS #ifdef WINDOWS
t_cur = GetCurrentTime(); pc_cur = __PIQueryPerformanceCounter();
return (t_cur - t_st) * 1000000.; return ((__pi_perf_freq > 0) ? ((pc_cur - pc_st) / double(__pi_perf_freq) * 1.E+9) : -1.);
//t_cur = GetCurrentTime();
//return (t_cur - t_st) * 1000000.;
#else #else
# ifdef MAC_OS # ifdef MAC_OS
clock_get_time(__pi_mac_clock, &t_cur); clock_get_time(__pi_mac_clock, &t_cur);
@@ -466,8 +491,10 @@ double PITimer::elapsed_n() {
double PITimer::elapsed_u() { double PITimer::elapsed_u() {
#ifdef WINDOWS #ifdef WINDOWS
t_cur = GetCurrentTime(); pc_cur = __PIQueryPerformanceCounter();
return (t_cur - t_st) * 1000.; return ((__pi_perf_freq > 0) ? ((pc_cur - pc_st) / double(__pi_perf_freq) * 1.E+6) : -1.);
//t_cur = GetCurrentTime();
//return (t_cur - t_st) * 1000.;
#else #else
# ifdef MAC_OS # ifdef MAC_OS
clock_get_time(__pi_mac_clock, &t_cur); clock_get_time(__pi_mac_clock, &t_cur);
@@ -481,8 +508,10 @@ double PITimer::elapsed_u() {
double PITimer::elapsed_m() { double PITimer::elapsed_m() {
#ifdef WINDOWS #ifdef WINDOWS
t_cur = GetCurrentTime(); pc_cur = __PIQueryPerformanceCounter();
return (double)(t_cur - t_st); return ((__pi_perf_freq > 0) ? ((pc_cur - pc_st) / double(__pi_perf_freq) * 1.E+3) : -1.);
//t_cur = GetCurrentTime();
//return (double)(t_cur - t_st);
#else #else
# ifdef MAC_OS # ifdef MAC_OS
clock_get_time(__pi_mac_clock, &t_cur); clock_get_time(__pi_mac_clock, &t_cur);
@@ -496,8 +525,10 @@ double PITimer::elapsed_m() {
double PITimer::elapsed_s() { double PITimer::elapsed_s() {
#ifdef WINDOWS #ifdef WINDOWS
t_cur = GetCurrentTime(); pc_cur = __PIQueryPerformanceCounter();
return (t_cur - t_st) / 1000.; return ((__pi_perf_freq > 0) ? ((pc_cur - pc_st) / double(__pi_perf_freq)) : -1.);
//t_cur = GetCurrentTime();
//return (t_cur - t_st) / 1000.;
#else #else
# ifdef MAC_OS # ifdef MAC_OS
clock_get_time(__pi_mac_clock, &t_cur); clock_get_time(__pi_mac_clock, &t_cur);
@@ -556,8 +587,10 @@ PISystemTime PITimer::reset_time() {
double PITimer::elapsed_system_n() { double PITimer::elapsed_system_n() {
#ifdef WINDOWS #ifdef WINDOWS
long t_cur = GetCurrentTime(); llong pc_cur = __PIQueryPerformanceCounter();
return (t_cur * 1000000.); return ((__pi_perf_freq > 0) ? (pc_cur / double(__pi_perf_freq) * 1.E+9) : -1.);
//long t_cur = GetCurrentTime();
//return (t_cur * 1000000.);
#else #else
# ifdef MAC_OS # ifdef MAC_OS
mach_timespec_t t_cur; mach_timespec_t t_cur;
@@ -573,8 +606,10 @@ double PITimer::elapsed_system_n() {
double PITimer::elapsed_system_u() { double PITimer::elapsed_system_u() {
#ifdef WINDOWS #ifdef WINDOWS
long t_cur = GetCurrentTime(); llong pc_cur = __PIQueryPerformanceCounter();
return (t_cur * 1000.); return ((__pi_perf_freq > 0) ? (pc_cur / double(__pi_perf_freq) * 1.E+6) : -1.);
//long t_cur = GetCurrentTime();
//return (t_cur * 1000.);
#else #else
# ifdef MAC_OS # ifdef MAC_OS
mach_timespec_t t_cur; mach_timespec_t t_cur;
@@ -590,8 +625,10 @@ double PITimer::elapsed_system_u() {
double PITimer::elapsed_system_m() { double PITimer::elapsed_system_m() {
#ifdef WINDOWS #ifdef WINDOWS
long t_cur = GetCurrentTime(); llong pc_cur = __PIQueryPerformanceCounter();
return (double)t_cur; return ((__pi_perf_freq > 0) ? (pc_cur / double(__pi_perf_freq) * 1.E+3) : -1.);
//long t_cur = GetCurrentTime();
//return (double)t_cur;
#else #else
# ifdef MAC_OS # ifdef MAC_OS
mach_timespec_t t_cur; mach_timespec_t t_cur;
@@ -607,8 +644,10 @@ double PITimer::elapsed_system_m() {
double PITimer::elapsed_system_s() { double PITimer::elapsed_system_s() {
#ifdef WINDOWS #ifdef WINDOWS
long t_cur = GetCurrentTime(); llong pc_cur = __PIQueryPerformanceCounter();
return (t_cur / 1000.); return ((__pi_perf_freq > 0) ? (pc_cur / double(__pi_perf_freq)) : -1.);
//long t_cur = GetCurrentTime();
//return (t_cur / 1000.);
#else #else
# ifdef MAC_OS # ifdef MAC_OS
mach_timespec_t t_cur; mach_timespec_t t_cur;
@@ -661,8 +700,17 @@ PIDateTime currentDateTime() {
PISystemTime currentSystemTime() { PISystemTime currentSystemTime() {
#ifdef WINDOWS #ifdef WINDOWS
long t_cur = GetCurrentTime(); FILETIME ft, sft;
return PISystemTime(t_cur / 1000, (t_cur % 1000) * 1000000); GetSystemTimeAsFileTime(&ft);
sft.dwHighDateTime = ft.dwHighDateTime - __pi_ftjan1970.dwHighDateTime;
if (ft.dwLowDateTime < __pi_ftjan1970.dwLowDateTime) {
sft.dwLowDateTime = ft.dwLowDateTime + (0xFFFFFFFF - __pi_ftjan1970.dwLowDateTime);
sft.dwHighDateTime++;
} else
sft.dwLowDateTime = ft.dwLowDateTime - __pi_ftjan1970.dwLowDateTime;
return PISystemTime(sft.dwHighDateTime * 100 + sft.dwLowDateTime / 10000000, (sft.dwLowDateTime % 10000000) * 100);
//long t_cur = GetCurrentTime();
//return PISystemTime(t_cur / 1000, (t_cur % 1000) * 1000000);
#else #else
# ifdef MAC_OS # ifdef MAC_OS
mach_timespec_t t_cur; mach_timespec_t t_cur;

72
pitimer.h
View File

@@ -33,37 +33,100 @@ typedef void (*TimerEvent)(void * , int );
class PIP_EXPORT PISystemTime { class PIP_EXPORT PISystemTime {
public: public:
//! Contructs system time with s = ns = 0
PISystemTime() {seconds = nanoseconds = 0;} PISystemTime() {seconds = nanoseconds = 0;}
//! Contructs system time with s = "s" and ns = "ns"
PISystemTime(long s, long ns) {seconds = s; nanoseconds = ns; checkOverflows();} PISystemTime(long s, long ns) {seconds = s; nanoseconds = ns; checkOverflows();}
//! Contructs system time from another
PISystemTime(const PISystemTime & t) {seconds = t.seconds; nanoseconds = t.nanoseconds;} PISystemTime(const PISystemTime & t) {seconds = t.seconds; nanoseconds = t.nanoseconds;}
//! Returns stored system time value in seconds
double toSeconds() const {return double(seconds) + nanoseconds / 1.e+9;} double toSeconds() const {return double(seconds) + nanoseconds / 1.e+9;}
//! Returns stored system time value in milliseconds
double toMilliseconds() const {return seconds * 1.e+3 + nanoseconds / 1.e+6;} double toMilliseconds() const {return seconds * 1.e+3 + nanoseconds / 1.e+6;}
//! Returns stored system time value in microseconds
double toMicroseconds() const {return seconds * 1.e+6 + nanoseconds / 1.e+3;} double toMicroseconds() const {return seconds * 1.e+6 + nanoseconds / 1.e+3;}
//! Returns stored system time value in nanoseconds
double toNanoseconds() const {return seconds * 1.e+9 + double(nanoseconds);} double toNanoseconds() const {return seconds * 1.e+9 + double(nanoseconds);}
//! Add to stored system time "v" seconds
PISystemTime & addSeconds(double v) {*this += fromSeconds(v); return *this;} PISystemTime & addSeconds(double v) {*this += fromSeconds(v); return *this;}
//! Add to stored system time "v" milliseconds
PISystemTime & addMilliseconds(double v) {*this += fromMilliseconds(v); return *this;} PISystemTime & addMilliseconds(double v) {*this += fromMilliseconds(v); return *this;}
//! Add to stored system time "v" microseconds
PISystemTime & addMicroseconds(double v) {*this += fromMicroseconds(v); return *this;} PISystemTime & addMicroseconds(double v) {*this += fromMicroseconds(v); return *this;}
//! Add to stored system time "v" nanoseconds
PISystemTime & addNanoseconds(double v) {*this += fromNanoseconds(v); return *this;} PISystemTime & addNanoseconds(double v) {*this += fromNanoseconds(v); return *this;}
//! Sleep for stored value. \warning Use this function to sleep for difference of system times or constructs system time.
//! If you call this function on system time returned from \a currentSystemTime() thread will be sleep almost forever.
void sleep() {piUSleep(piFloord(toMicroseconds()));} // wait self value, useful to wait some dT = (t1 - t0) void sleep() {piUSleep(piFloord(toMicroseconds()));} // wait self value, useful to wait some dT = (t1 - t0)
//! Returns copy of this system time with absolutely values of s and ns
PISystemTime abs() const {return PISystemTime(piAbsl(seconds), piAbsl(nanoseconds));} PISystemTime abs() const {return PISystemTime(piAbsl(seconds), piAbsl(nanoseconds));}
//! Returns sum of this system time with "t"
PISystemTime operator +(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds += t.seconds; tt.nanoseconds += t.nanoseconds; tt.checkOverflows(); return tt;} PISystemTime operator +(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds += t.seconds; tt.nanoseconds += t.nanoseconds; tt.checkOverflows(); return tt;}
//! Returns difference between this system time and "t"
PISystemTime operator -(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds -= t.seconds; tt.nanoseconds -= t.nanoseconds; tt.checkOverflows(); return tt;} PISystemTime operator -(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds -= t.seconds; tt.nanoseconds -= t.nanoseconds; tt.checkOverflows(); return tt;}
//! Add to stored value system time "t"
PISystemTime & operator +=(const PISystemTime & t) {seconds += t.seconds; nanoseconds += t.nanoseconds; checkOverflows(); return *this;} PISystemTime & operator +=(const PISystemTime & t) {seconds += t.seconds; nanoseconds += t.nanoseconds; checkOverflows(); return *this;}
//! Subtract from stored value system time "t"
PISystemTime & operator -=(const PISystemTime & t) {seconds -= t.seconds; nanoseconds -= t.nanoseconds; checkOverflows(); return *this;} PISystemTime & operator -=(const PISystemTime & t) {seconds -= t.seconds; nanoseconds -= t.nanoseconds; checkOverflows(); return *this;}
//! Compare system times
bool operator ==(const PISystemTime & t) {return ((seconds == t.seconds) && (nanoseconds == t.nanoseconds));} bool operator ==(const PISystemTime & t) {return ((seconds == t.seconds) && (nanoseconds == t.nanoseconds));}
//! Compare system times
bool operator !=(const PISystemTime & t) {return ((seconds != t.seconds) || (nanoseconds != t.nanoseconds));} bool operator !=(const PISystemTime & t) {return ((seconds != t.seconds) || (nanoseconds != t.nanoseconds));}
//! Compare system times
bool operator >(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds > t.nanoseconds; return seconds > t.seconds;} bool operator >(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds > t.nanoseconds; return seconds > t.seconds;}
//! Compare system times
bool operator <(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds < t.nanoseconds; return seconds < t.seconds;} bool operator <(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds < t.nanoseconds; return seconds < t.seconds;}
//! Compare system times
bool operator >=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds >= t.nanoseconds; return seconds >= t.seconds;} bool operator >=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds >= t.nanoseconds; return seconds >= t.seconds;}
//! Compare system times
bool operator <=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds <= t.nanoseconds; return seconds <= t.seconds;} bool operator <=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds <= t.nanoseconds; return seconds <= t.seconds;}
//! Contructs system time from seconds "v"
static PISystemTime fromSeconds(double v) {long s = piFloord(v); return PISystemTime(s, (v - s) * 1000000000);} static PISystemTime fromSeconds(double v) {long s = piFloord(v); return PISystemTime(s, (v - s) * 1000000000);}
//! Contructs system time from milliseconds "v"
static PISystemTime fromMilliseconds(double v) {long s = piFloord(v / 1000.); return PISystemTime(s, (v / 1000. - s) * 1000000000);} static PISystemTime fromMilliseconds(double v) {long s = piFloord(v / 1000.); return PISystemTime(s, (v / 1000. - s) * 1000000000);}
//! Contructs system time from microseconds "v"
static PISystemTime fromMicroseconds(double v) {long s = piFloord(v / 1000000.); return PISystemTime(s, (v / 1000000. - s) * 1000000000);} static PISystemTime fromMicroseconds(double v) {long s = piFloord(v / 1000000.); return PISystemTime(s, (v / 1000000. - s) * 1000000000);}
//! Contructs system time from nanoseconds "v"
static PISystemTime fromNanoseconds(double v) {long s = piFloord(v / 1000000000.); return PISystemTime(s, (v / 1000000000. - s) * 1000000000);} static PISystemTime fromNanoseconds(double v) {long s = piFloord(v / 1000000000.); return PISystemTime(s, (v / 1000000000. - s) * 1000000000);}
//! Seconds of stored system time
long seconds; long seconds;
//! Nanoseconds of stored system time
long nanoseconds; long nanoseconds;
private: private:
@@ -71,7 +134,10 @@ private:
}; };
//! \relatesalso PISystemTime \relatesalso PIByteArray \brief Output operator to PIByteArray
inline PIByteArray & operator <<(PIByteArray & s, const PISystemTime & v) {s << v.seconds << v.nanoseconds; return s;} inline PIByteArray & operator <<(PIByteArray & s, const PISystemTime & v) {s << v.seconds << v.nanoseconds; return s;}
//! \relatesalso PISystemTime \relatesalso PIByteArray \brief Input operator from PIByteArray
inline PIByteArray & operator >>(PIByteArray & s, PISystemTime & v) {s >> v.seconds >> v.nanoseconds; return s;} inline PIByteArray & operator >>(PIByteArray & s, PISystemTime & v) {s >> v.seconds >> v.nanoseconds; return s;}
struct PIP_EXPORT PITime { struct PIP_EXPORT PITime {
@@ -174,7 +240,8 @@ public:
EVENT_HANDLER0(void, reset) { EVENT_HANDLER0(void, reset) {
# ifdef WINDOWS # ifdef WINDOWS
t_st = GetCurrentTime(); //t_st = GetCurrentTime();
pc_st = __PIQueryPerformanceCounter();
# elif defined(MAC_OS) # elif defined(MAC_OS)
clock_get_time(__pi_mac_clock, &t_st); clock_get_time(__pi_mac_clock, &t_st);
# else # else
@@ -358,6 +425,7 @@ private:
double interval_; double interval_;
#ifdef WINDOWS #ifdef WINDOWS
llong pc_st, pc_cur, tt_st, tt_cur;
long long
#elif defined(MAC_OS) #elif defined(MAC_OS)
mach_timespec_t mach_timespec_t
@@ -386,6 +454,8 @@ extern PITimer::TimerPool * pool;
PIP_EXPORT PITime currentTime(); PIP_EXPORT PITime currentTime();
PIP_EXPORT PIDate currentDate(); PIP_EXPORT PIDate currentDate();
PIP_EXPORT PIDateTime currentDateTime(); PIP_EXPORT PIDateTime currentDateTime();
//! \relatesalso PISystemTime \brief Returns current system time
PIP_EXPORT PISystemTime currentSystemTime(); PIP_EXPORT PISystemTime currentSystemTime();
PIP_EXPORT PIString time2string(const PITime & time, const PIString & format = "h:mm:ss"); // obsolete, use PITime.toString() instead PIP_EXPORT PIString time2string(const PITime & time, const PIString & format = "h:mm:ss"); // obsolete, use PITime.toString() instead
PIP_EXPORT PIString date2string(const PIDate & date, const PIString & format = "d.MM.yyyy"); // obsolete, use PITime.toString() instead PIP_EXPORT PIString date2string(const PIDate & date, const PIString & format = "d.MM.yyyy"); // obsolete, use PITime.toString() instead

72
piusb.cpp
View File

@@ -1,4 +1,5 @@
#include "piusb.h" #include "piusb.h"
#include "piconfig.h"
#ifdef PIP_USB #ifdef PIP_USB
# ifdef WINDOWS # ifdef WINDOWS
@@ -68,7 +69,7 @@ bool PIUSB::setConfiguration(uchar value) {
piForeachC (Configuration & c, desc_.configurations) piForeachC (Configuration & c, desc_.configurations)
if (c.value_to_select == value) {found = true; conf_ = c; break;} if (c.value_to_select == value) {found = true; conf_ = c; break;}
if (!found) { if (!found) {
piCoutObj << "[PIUSB] Can`t find configuration with \"value_to_select\" =" << value; piCoutObj << "Can`t find configuration with \"value_to_select\" =" << value;
return false; return false;
} }
if (interface_claimed >= 0) if (interface_claimed >= 0)
@@ -88,14 +89,14 @@ bool PIUSB::setInterface(uchar value) {
piForeachC (Interface & i, conf_.interfaces) piForeachC (Interface & i, conf_.interfaces)
if (i.value_to_select == value) {found = true; iface_ = i; break;} if (i.value_to_select == value) {found = true; iface_ = i; break;}
if (!found) { if (!found) {
piCoutObj << "[PIUSB] Can`t find interface with \"value_to_select\" =" << value; piCoutObj << "Can`t find interface with \"value_to_select\" =" << value;
return false; return false;
} }
if (interface_claimed >= 0) if (interface_claimed >= 0)
usb_release_interface(hdev, interface_claimed); usb_release_interface(hdev, interface_claimed);
interface_claimed = -1; interface_claimed = -1;
if (usb_claim_interface(hdev, iface_.value_to_select) < 0) { if (usb_claim_interface(hdev, iface_.value_to_select) < 0) {
piCoutObj << "[PIUSB] Error: Cant`t claim interface!"; piCoutObj << "Error: Cant`t claim interface!";
return false; return false;
} }
eps.clear(); eps.clear();
@@ -115,6 +116,33 @@ bool PIUSB::setInterface(uchar value) {
} }
bool PIUSB::configureDevice(const void * e_main, const void * e_parent) {
#ifdef PIP_USB
PIConfig::Entry * em = (PIConfig::Entry * )e_main;
PIConfig::Entry * ep = (PIConfig::Entry * )e_parent;
PIString vp = readDeviceSetting<PIString>("device", "", em, ep);
ushort v, p;
if (vp.isEmpty()) {
v = readDeviceSetting<ushort>("vid", vendorID(), em, ep);
p = readDeviceSetting<ushort>("pid", productID(), em, ep);
} else {
v = vp.left(vp.find(":")).toInt(16);
p = vp.right(vp.length() - vp.find(":") - 1).toInt(16);
}
setVendorID(v);
setProductID(p);
setDeviceNumber(readDeviceSetting<int>("deviceNumber", deviceNumber(), em, ep));
setConfiguration(readDeviceSetting<ushort>("configuration", currentConfiguration().value_to_select, em, ep));
setInterface(readDeviceSetting<ushort>("interface", currentInterface().value_to_select, em, ep));
setEndpointRead(Endpoint(readDeviceSetting<ushort>("endpointRead", endpointRead().address, em, ep)));
setEndpointWrite(Endpoint(readDeviceSetting<ushort>("endpointWrite", endpointWrite().address, em, ep)));
return true;
#else
return false;
#endif
}
bool PIUSB::openDevice() { bool PIUSB::openDevice() {
#ifdef PIP_USB #ifdef PIP_USB
if (path_.size_s() >= 8) { if (path_.size_s() >= 8) {
@@ -128,15 +156,15 @@ bool PIUSB::openDevice() {
usb_init(); usb_init();
//usb_set_debug(4); //usb_set_debug(4);
if (usb_find_busses() < 0) { if (usb_find_busses() < 0) {
piCoutObj << "[PIUSB] Error: Cant`t find busses!"; piCoutObj << "Error: Cant`t find busses!";
return false; return false;
} }
if (usb_find_devices() < 0) { if (usb_find_devices() < 0) {
piCoutObj << "[PIUSB] Error: Cant`t find devices!"; piCoutObj << "Error: Cant`t find devices!";
return false; return false;
} }
//piCoutObj << "[PIUSB] Search for device ... " << flush; //piCoutObj << "Search for device ... " << flush;
int cur_num = 1; int cur_num = 1;
bool found = false; bool found = false;
struct usb_device * dev; struct usb_device * dev;
@@ -196,11 +224,11 @@ bool PIUSB::openDevice() {
eps << Endpoint(is->endpoint[i].bEndpointAddress, eps << Endpoint(is->endpoint[i].bEndpointAddress,
is->endpoint[i].bmAttributes, is->endpoint[i].bmAttributes,
is->endpoint[i].wMaxPacketSize); is->endpoint[i].wMaxPacketSize);
if (eps.back().direction == Endpoint::Write && ep_write.address == 0) ep_write = eps.back(); if (eps.back().direction == Endpoint::Write && (eps.back().address == ep_write.address || ep_write.address == 0)) ep_write = eps.back();
if (eps.back().direction == Endpoint::Read && ep_read.address == 0) ep_read = eps.back(); if (eps.back().direction == Endpoint::Read && (eps.back().address == ep_read.address || ep_read.address == 0)) ep_read = eps.back();
} }
//piCoutObj << "[PIUSB] Device found at address:" << "Bus: " << dev->bus->dirname << ", Device: " << dev->filename; //piCoutObj << "Device found at address:" << "Bus: " << dev->bus->dirname << ", Device: " << dev->filename;
found = true; found = true;
break; break;
} else cur_num++; } else cur_num++;
@@ -209,15 +237,15 @@ bool PIUSB::openDevice() {
if (found) break; if (found) break;
} }
if (!found) { if (!found) {
piCoutObj << "[PIUSB] Error: Cant`t find device!"; piCoutObj << "Error: Cant`t find device!";
return false; return false;
} }
//piCoutObj << "[PIUSB] Open ... " << flush; //piCoutObj << "Open ... " << flush;
hdev = usb_open(dev); hdev = usb_open(dev);
if (hdev == 0) { if (hdev == 0) {
piCoutObj << "[PIUSB] Error: Cant`t open device:" << usb_strerror(); piCoutObj << "Error: Cant`t open device:" << usb_strerror();
return false; return false;
}// else piCoutObj << "[PIUSB] ok"; }// else piCoutObj << "ok";
//usb_reset(hdev); //usb_reset(hdev);
//usb_set_configuration(hdev, 1); //usb_set_configuration(hdev, 1);
@@ -225,22 +253,22 @@ bool PIUSB::openDevice() {
# ifndef WINDOWS # ifndef WINDOWS
char tbuff[256]; char tbuff[256];
//piCoutObj << "[PIUSB] Check for bounded driver ... " << flush; //piCoutObj << "Check for bounded driver ... " << flush;
if (usb_get_driver_np(hdev, intefrace_, tbuff, sizeof(tbuff) - 1) >= 0) { if (usb_get_driver_np(hdev, intefrace_, tbuff, sizeof(tbuff) - 1) >= 0) {
//piCoutObj << "[PIUSB] yes" << "Found driver: " << tbuff; //piCoutObj << "yes" << "Found driver: " << tbuff;
//piCoutObj << "[PIUSB] Detach driver ... " << flush; //piCoutObj << "Detach driver ... " << flush;
if (usb_detach_kernel_driver_np(hdev, intefrace_)< 0) { if (usb_detach_kernel_driver_np(hdev, intefrace_)< 0) {
piCoutObj << "[PIUSB] Error: Cant`t detach bounded driver!"; piCoutObj << "Error: Cant`t detach bounded driver!";
return false; return false;
}// else piCoutObj << "[PIUSB] ok"; }// else piCoutObj << "ok";
}// else piCoutObj << "[PIUSB] no"; }// else piCoutObj << "no";
# endif # endif
//piCoutObj << "[PIUSB] Claim interface ... " << flush; //piCoutObj << "Claim interface ... " << flush;
if (usb_claim_interface(hdev, intefrace_) < 0) { if (usb_claim_interface(hdev, intefrace_) < 0) {
piCoutObj << "[PIUSB] Error: Cant`t claim interface:" << usb_strerror(); piCoutObj << "Error: Cant`t claim interface:" << usb_strerror();
return false; return false;
} // else piCoutObj << "[PIUSB] ok"; } // else piCoutObj << "ok";
interface_claimed = intefrace_; interface_claimed = intefrace_;
return true; return true;

6
piusb.h
View File

@@ -95,6 +95,8 @@ public:
ushort vendorID() const {return vid_;} ushort vendorID() const {return vid_;}
ushort productID() const {return pid_;} ushort productID() const {return pid_;}
int deviceNumber() const {return dev_num;}
const PIVector<Endpoint> & endpoints() const {return eps;} const PIVector<Endpoint> & endpoints() const {return eps;}
PIVector<Endpoint> endpointsRead(); PIVector<Endpoint> endpointsRead();
PIVector<Endpoint> endpointsWrite(); PIVector<Endpoint> endpointsWrite();
@@ -103,6 +105,9 @@ public:
const Endpoint & endpointRead() {return ep_read;} const Endpoint & endpointRead() {return ep_read;}
const Endpoint & endpointWrite() {return ep_write;} const Endpoint & endpointWrite() {return ep_write;}
void setVendorID(ushort vid) {vid_ = vid; path_ = PIString::fromNumber(vid_, 16).expandLeftTo(4, "0") + ":" + PIString::fromNumber(pid_, 16).expandLeftTo(4, "0");}
void setProductID(ushort pid) {pid_ = pid; path_ = PIString::fromNumber(vid_, 16).expandLeftTo(4, "0") + ":" + PIString::fromNumber(pid_, 16).expandLeftTo(4, "0");}
bool setConfiguration(uchar value); bool setConfiguration(uchar value);
bool setInterface(uchar value); bool setInterface(uchar value);
@@ -119,6 +124,7 @@ public:
void flush(); void flush();
protected: protected:
bool configureDevice(const void * e_main, const void * e_parent = 0);
//bool init(); //bool init();
bool openDevice(); bool openDevice();
bool closeDevice(); bool closeDevice();