From 16062fcaa393328d2ac404cce40ec2e0ae2ffa7d Mon Sep 17 00:00:00 2001 From: Kaian Date: Mon, 24 Jun 2013 19:52:56 +0200 Subject: [PATCH] Documented for Doxygen Also added LICENSE file and headers for GPLv3 --- Doxyfile | 1782 +++++++++++++++++++++++++++++++++++++++++ LICENSE | 674 ++++++++++++++++ doc/footer.html | 4 + src/exec.c | 40 +- src/exec.h | 43 +- src/main.c | 57 +- src/pcap.c | 52 +- src/pcap.h | 57 +- src/sip.c | 175 +--- src/sip.h | 89 +- src/ui_call_flow.c | 73 +- src/ui_call_flow.h | 108 ++- src/ui_call_flow_ex.c | 81 +- src/ui_call_flow_ex.h | 114 ++- src/ui_call_list.c | 73 +- src/ui_call_list.h | 129 ++- src/ui_call_raw.c | 44 +- src/ui_call_raw.h | 94 ++- src/ui_manager.c | 56 +- src/ui_manager.h | 93 ++- 20 files changed, 3333 insertions(+), 505 deletions(-) create mode 100644 Doxyfile create mode 100644 LICENSE create mode 100644 doc/footer.html diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..583291e --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1782 @@ +# Doxyfile 1.7.6.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = ISO-8859-1 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = sngrep + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 0.1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# 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 +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# 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 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +#SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# 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 +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = src doc + +# 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 +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = ISO-8859-1 + +# 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 +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.h *.c *.php *.lua *.dox + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = *.lua=/usr/bin/lua2dox + +# 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 +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = YES + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = 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. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +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 which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = doc/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# style sheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +#HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +#USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# 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. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). 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. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see 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. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# 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 +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = YES + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# 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. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. 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. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH 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. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# 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 +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/doc/footer.html b/doc/footer.html new file mode 100644 index 0000000..5e89e68 --- /dev/null +++ b/doc/footer.html @@ -0,0 +1,4 @@ +
+Generated on $datetime for $projectname  irontec
+ + \ No newline at end of file diff --git a/src/exec.c b/src/exec.c index 97a28da..d50bdb5 100644 --- a/src/exec.c +++ b/src/exec.c @@ -1,32 +1,40 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file exec.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in exec.h + * + */ #include #include #include -#include "sip.h" #include "ui_manager.h" +//! Forced stdbuf command line arguments #define STDBUF_ARGS "-i0 -o0 -e0" +//! Forced ngrep command line arguments #define NGREP_ARGS "-qpt -W byline" /**************************************************************************** @@ -67,7 +75,7 @@ run_ngrep(void *pargv) return 1; } - /* Read the output a line at a time - output it. */ + // Read the output a line at a time - output it. while (fgets(stdout_line, 1024, fp) != NULL) { if (!strncmp(stdout_line, "\n", 1) && strlen(msg_header) && strlen(msg_payload)) { // Parse message @@ -91,7 +99,7 @@ run_ngrep(void *pargv) } } - /* close */ + // Close read pipe pclose(fp); return 0; } diff --git a/src/exec.h b/src/exec.h index 8be2407..3bdc360 100644 --- a/src/exec.h +++ b/src/exec.h @@ -1,26 +1,37 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ -#ifndef __NGREP_EXEC_H -#define __NGREP_EXEC_H +/** + * @file exec.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage ngrep background execution + * + * This file contains the functions to spawn an ngrep process and read its + * output. This process is done in a detached thread that will request UI + * updates when new messages are parsed. + * + */ +#ifndef __SNGREP_EXEC_H +#define __SNGREP_EXEC_H /**************************************************************************** ** Current version of sngrep launches a thread that execs original ngrep @@ -38,7 +49,7 @@ ** (let's say -T), sngrep will fail at parsing any header :( ** ****************************************************************************/ -int +extern int run_ngrep(void *pargs); #endif diff --git a/src/main.c b/src/main.c index f6e47d4..795504f 100644 --- a/src/main.c +++ b/src/main.c @@ -1,37 +1,45 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file main.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of initial functions used by sngrep + * + * @todo This should be coded properly. We could use use -f flag argument to + * load the pcap file (because ngrep has no -f flag) and assume any other + * argument are ngrep arguments. Anyway, actual main code is awful. + */ + #include -#include -#include -#include #include #include "exec.h" #include "pcap.h" #include "ui_manager.h" /** - * Usage function - * Print all available options (which are none actually) + * @brief Usage function * + * Print all available options (which are none actually) */ void usage(const char* progname) @@ -45,7 +53,8 @@ usage(const char* progname) } /** - * Main function + * @brief Main function logic + * * Parse command line options and start running threads * * @note There are no params actually... if you supply one @@ -59,9 +68,12 @@ main(int argc, char* argv[]) { int ret; - struct ui_config config; /* ui configuration */ - pthread_attr_t attr; /* ngrep thread attributes */ - pthread_t exec_t; /* ngrep running thread */ + //! ui configuration @todo Remove this structure + struct ui_config config; + //! ngrep thread attributes + pthread_attr_t attr; + //! ngrep running thread + pthread_t exec_t; // Parse arguments.. I mean.. if (argc < 2) { @@ -98,4 +110,3 @@ main(int argc, char* argv[]) // Leaving! return ret; } - diff --git a/src/pcap.c b/src/pcap.c index 618087a..dae198d 100644 --- a/src/pcap.c +++ b/src/pcap.c @@ -1,39 +1,41 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ -#include +/** + * @file pcap.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in pcap.h + * + * sngrep can parse a pcap file to display call flows. + * This file include the functions that uses libpcap to do so. + * + * @todo We could request libpcap to filter the file before being processed + * and only read sip packages. We also allow UDP packages here, and SIP can + * use other transports, uh. + * + */ #include "pcap.h" #include "sip.h" -/** - * Read from pcap file and fill sngrep sctuctures - * This function will use libpcap files and previous structures to - * parse the pcap file. - * This program is only focused in VoIP calls so we only consider - * TCP/UDP packets with Ethernet or Linux coocked headers - * - * @param file Full path to PCAP file - * @return 0 if load has been successfull, 1 otherwise - * - */ int load_pcap_file(const char* file) { diff --git a/src/pcap.h b/src/pcap.h index d0e0176..ebb2e2b 100644 --- a/src/pcap.h +++ b/src/pcap.h @@ -1,24 +1,38 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file pcap.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage pcap files + * + * sngrep can parse a pcap file to display call flows. + * This file include the functions that uses libpcap to do so. + * + * @todo We could request libpcap to filter the file before being processed + * and only read sip packages. We also allow UDP packages here, and SIP can + * use other transports, uh. + * + */ #ifndef __SNGREP_PCAP_H #define __SNGREP_PCAP_H @@ -30,14 +44,16 @@ #include #include -/* Ethernet headers are always exactly 14 bytes */ +//! Ethernet headers are always exactly 14 bytes #define SIZE_ETHERNET 14 -/* Linux cooked packages headers are 16 bytes */ +//! Linux cooked packages headers are 16 bytes #define SLL_HDR_LEN 16 -/* UDP headers are always exactly 8 bytes */ +//! UDP headers are always exactly 8 bytes #define SIZE_UDP 8 -/* IP data structure */ +/** + * @brief IP data structure + */ struct nread_ip { //! header length, version @@ -71,7 +87,9 @@ struct nread_ip #define IP_HL(ip) (((ip)->ip_vhl) & 0x0f) #define IP_V(ip) (((ip)->ip_vhl) >> 4) -/* UDP data structure */ +/** + * @brief UDP data structure + */ struct nread_udp { //! source port @@ -85,7 +103,8 @@ struct nread_udp }; /** - * Read from pcap file and fill sngrep sctuctures + * @brief Read from pcap file and fill sngrep sctuctures + * * This function will use libpcap files and previous structures to * parse the pcap file. * This program is only focused in VoIP calls so we only consider diff --git a/src/sip.c b/src/sip.c index d48032d..e777957 100644 --- a/src/sip.c +++ b/src/sip.c @@ -1,59 +1,60 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file sip.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in sip.h + * + * @todo This functions should be recoded. They parse the payload searching + * for fields with sscanf and can fail easily. + * We could use an external parser library (osip maybe?) but I prefer recoding + * this to avoid more dependencies. + * + * @todo Replace structures for their typedef shorter names + */ #include #include #include -#include #include -#include #include "sip.h" /** - * Linked list of parsed calls + * @brief Linked list of parsed calls + * * All parsed calls will be added to this list, only accesible from * this awesome pointer, so, keep it thread-safe. */ -struct sip_call *calls = NULL; +sip_call_t *calls = NULL; /** - * Warranty thread-safe access to the calls list. + * @brief Warranty thread-safe access to the calls list. + * * This lock should be used whenever the calls pointer is updated, but * before single call locking, it will be used everytime a thread access * single call data. */ pthread_mutex_t calls_lock; -/** - * This function parses ngrep header and SIP message payload to - * fill a sip_message structure. - * - * If no call is found with the given Call-ID, a new one will be - * created and added to calls list. - * - * @param header ngrep header generated by -qpt arguments - * @param payload SIP message payload - * @returns the message structure @sip_msg - * - */ sip_msg_t * sip_parse_message(const char *header, const char *payload) { @@ -79,13 +80,6 @@ sip_parse_message(const char *header, const char *payload) return call_add_message(call, header, payload); } -/** - * Parses Call-ID header of a SIP message payload - * - * @param payload SIP message payload - * @returns callid parsed from Call-ID header - * @note the returned pointer MUST be deallocated after use - */ char * get_callid(const char* payload) { @@ -112,12 +106,6 @@ get_callid(const char* payload) return callid; } -/** - * Create a new call with the given callid (Minimum required data) - * - * @param callid Call-ID Header value - * @returns pointer to the sip_call created - */ struct sip_call * call_new(const char *callid) { @@ -144,14 +132,6 @@ call_new(const char *callid) return call; } -/** - * Parse the ngrep header and payload and add the result message - * to the given call. - * - * @param call pointer to the call owner of the message - * @param header ngrep header generated by -qpt arguments - * @param payload SIP message payload - */ struct sip_msg * call_add_message(struct sip_call *call, const char *header, const char *payload) { @@ -178,14 +158,6 @@ call_add_message(struct sip_call *call, const char *header, const char *payload) return msg; } -/** - * Parse ngrep header line to get timestamps and ip addresses - * of the SIP message. - * - * @param msg SIP message structure - * @param header ngrep header generated by -qpt arguments - * @returns 0 on success, 1 on malformed header - */ int msg_parse_header(struct sip_msg *msg, const char *header) { @@ -211,17 +183,6 @@ msg_parse_header(struct sip_msg *msg, const char *header) return 1; } -/** - * Parse SIP Message payload to fill sip_msg structe - * - * XXX This function is the worst thing at perfomance and coding - * XXX but its easy to change, maybe for an external parser like - * XXX osip2 parser. - * - * @param msg SIP message structure - * @param payload SIP message payload - * @returns 0 in all cases - */ int msg_parse_payload(struct sip_msg *msg, const char *payload) { @@ -264,12 +225,6 @@ msg_parse_payload(struct sip_msg *msg, const char *payload) return 0; } -/** - * Find a call structure in calls linked list given an xcallid - * - * @param xcallid X-Call-ID or X-CID Header value - * @returns pointer to the sip_call structure found or NULL - */ struct sip_call * call_find_by_callid(const char *callid) { @@ -283,12 +238,6 @@ call_find_by_callid(const char *callid) return NULL; } -/** - * Find a call structure in calls linked list given an callid - * - * @param callid Call-ID Header value - * @returns pointer to the sip_call structure found or NULL - */ struct sip_call * call_find_by_xcallid(const char *xcallid) { @@ -302,11 +251,6 @@ call_find_by_xcallid(const char *xcallid) return NULL; } -/** - * Getter for calls linked list size - * - * @returns how many calls are linked in the list - */ int get_n_calls() { @@ -319,11 +263,6 @@ get_n_calls() return callcnt; } -/** - * Getter for call messages linked list size - * - * @returns how many messages are in the call - */ int get_n_msgs(struct sip_call *call) { @@ -338,16 +277,6 @@ get_n_msgs(struct sip_call *call) return msgcnt; } -/** - * Finds the other leg of this call. - * - * If this call has a X-CID or X-Call-ID header, that call will be - * find and returned. Otherwise, a call with X-CID or X-Call-ID header - * matching the given call's Call-ID will be find or returned. - * - * @param call SIP call structure - * @returns The other call structure or NULL if none found - */ struct sip_call * get_ex_call(struct sip_call *call) { @@ -358,16 +287,6 @@ get_ex_call(struct sip_call *call) } } -/** - * Finds the next msg in a call. If the passed msg is - * NULL it returns the first message in the call - * - * @PARAM CALL sip CALL STRUCTURe - * @param msg Actual SIP msg from the call (can be NULL) - * @returns Next chronological message in the call - * - * XXX This function must be recoded if message linked list is not sorted - */ struct sip_msg * get_next_msg(struct sip_call *call, struct sip_msg *msg) { @@ -382,16 +301,6 @@ get_next_msg(struct sip_call *call, struct sip_msg *msg) return ret; } -/** - * Finds the next msg in call and it's extended. If the passed msg is - * NULL it returns the first message in the conversation - * - * @param call SIP call structure - * @param msg Actual SIP msg from the call (can be NULL) - * @returns Next chronological message in the conversation - * - * XXX This function must be recoded if message linked list is not sorted - */ struct sip_msg * get_next_msg_ex(struct sip_call *call, struct sip_msg *msg) { @@ -404,24 +313,24 @@ get_next_msg_ex(struct sip_call *call, struct sip_msg *msg) if (!(call2 = get_ex_call(call))) return get_next_msg(call, msg); if (!msg) { - /* No msg, compare the first one of both calls */ + // No msg, compare the first one of both calls msg1 = get_next_msg(call, NULL); msg2 = get_next_msg(call2, NULL); } else if (msg->call == call) { - /** Message is from first call, get the next message in the call */ + // Message is from first call, get the next message in the call msg1 = get_next_msg(call, msg); - /** Get the chronological next message in second call */ + // Get the chronological next message in second call while ((msg2 = get_next_msg(call2, msg2))) { - /** Compare with the actual message */ + // Compare with the actual message if (msg->ts.tv_sec < msg2->ts.tv_sec || (msg->ts.tv_sec == msg2->ts.tv_sec && msg->ts.tv_usec < msg2->ts.tv_usec)) break; } } else if (msg->call == call2) { - /** Message is from second call, get the next message in the call */ + // Message is from second call, get the next message in the call msg1 = get_next_msg(call2, msg); - /** Get the chronological next message in first call */ + // Get the chronological next message in first call while ((msg2 = get_next_msg(call, msg2))) { - /** Compare with the actual message */ + // Compare with the actual message if (msg->ts.tv_sec < msg2->ts.tv_sec || (msg->ts.tv_sec == msg2->ts.tv_sec && msg->ts.tv_usec < msg2->ts.tv_usec)) break; } @@ -447,14 +356,10 @@ parse_msg(sip_msg_t *msg) if (msg->parsed) return msg; // Parse message header - if (msg_parse_header(msg, msg->headerptr) != 0) { - return NULL; - } + if (msg_parse_header(msg, msg->headerptr) != 0) return NULL; // Parse message payload - if (msg_parse_payload(msg, msg->payloadptr) != 0) { - return NULL; - } + if (msg_parse_payload(msg, msg->payloadptr) != 0) return NULL; // Free message pointers free(msg->headerptr); diff --git a/src/sip.h b/src/sip.h index 539e5a0..a2d6901 100644 --- a/src/sip.h +++ b/src/sip.h @@ -1,24 +1,36 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file sip.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage SIP calls and messages + * + * This file contains the functions and structures to manage the SIP calls and + * messages. + * + * @todo Add iterator for calls. We could add some kind of filtering + * + */ #ifndef __SNGREP_SIP_H #define __SNGREP_SIP_H @@ -31,8 +43,7 @@ typedef struct sip_call sip_call_t; typedef struct sip_msg sip_msg_t; /** - * This structure contains all required information of a single - * message withing a dialog. + * @brief Information of a single message withing a dialog. * * Most of the data is just stored to be displayed in the UI so * the formats may be no the best, but the simplest for this @@ -75,8 +86,7 @@ struct sip_msg }; /** - * This structure contains all required information of a call - * and a pointer to the first message. + * @brief Contains all information of a call and its messages * * Most of the data is just stored to be displayed in the UI so * the formats may be no the best, but the simplest for this @@ -98,6 +108,8 @@ struct sip_call }; /** + * @brief Parse header and payload into a new message + * * This function parses ngrep header and SIP message payload to * fill a sip_message structure. * @@ -113,7 +125,7 @@ extern sip_msg_t * sip_parse_message(const char *header, const char *payload); /** - * Parses Call-ID header of a SIP message payload + * @brief Parses Call-ID header of a SIP message payload * * @param payload SIP message payload * @returns callid parsed from Call-ID header @@ -123,7 +135,7 @@ extern char * get_callid(const char* payload); /** - * Create a new call with the given callid (Minimum required data) + * @brief Create a new call with the given callid (Minimum required data) * * @param callid Call-ID Header value * @returns pointer to the sip_call created @@ -132,6 +144,8 @@ extern sip_call_t * call_new(const char *callid); /** + * @brief Parse header and payload and add the message to the given call + * * Parse the ngrep header and payload and add the result message * to the given call. * @@ -144,8 +158,7 @@ extern sip_msg_t * call_add_message(sip_call_t *call, const char *header, const char *payload); /** - * Parse ngrep header line to get timestamps and ip addresses - * of the SIP message. + * @brief Parse ngrep header line to get timestamps and ip addresses * * @param msg SIP message structure * @param header ngrep header generated by -qpt arguments @@ -155,7 +168,7 @@ extern int msg_parse_header(sip_msg_t *msg, const char *header); /** - * Parse SIP Message payload to fill sip_msg structe + * @brief Parse SIP Message payload to fill sip_msg structe * * @param msg SIP message structure * @param payload SIP message payload @@ -165,7 +178,7 @@ extern int msg_parse_payload(sip_msg_t *msg, const char *payload); /** - * Find a call structure in calls linked list given an xcallid + * @brief Find a call structure in calls linked list given an xcallid * * @param xcallid X-Call-ID or X-CID Header value * @returns pointer to the sip_call structure found or NULL @@ -174,7 +187,7 @@ extern sip_call_t * call_find_by_xcallid(const char *xcallid); /** - * Find a call structure in calls linked list given an callid + * @brief Find a call structure in calls linked list given an callid * * @param callid Call-ID Header value * @returns pointer to the sip_call structure found or NULL @@ -183,7 +196,7 @@ extern sip_call_t * call_find_by_callid(const char *callid); /** - * Getter for calls linked list size + * @brief Getter for calls linked list size * * @returns how many calls are linked in the list */ @@ -191,7 +204,7 @@ extern int get_n_calls(); /** - * Getter for call messages linked list size + * @brief Getter for call messages linked list size * * @returns how many messages are in the call */ @@ -199,7 +212,7 @@ extern int get_n_msgs(sip_call_t *call); /** - * Finds the other leg of this call. + * @brief Finds the other leg of this call. * * If this call has a X-CID or X-Call-ID header, that call will be * find and returned. Otherwise, a call with X-CID or X-Call-ID header @@ -212,8 +225,10 @@ extern sip_call_t * get_ex_call(sip_call_t *call); /** - * Finds the next msg in a call. If the passed msg is - * NULL it returns the first message in the call + * @brief Finds the next msg in a call. + * + * If the passed msg is NULL it returns the first message + * in the call * * @param msg Actual SIP msg from the call (can be NULL) * @returns Next chronological message in the call @@ -222,8 +237,10 @@ extern sip_msg_t * get_next_msg(sip_call_t *call, sip_msg_t *msg); /** - * Finds the next msg in call and it's extended. If the passed msg is - * NULL it returns the first message in the conversation + * @brief Finds the next msg in call and it's extended. + * + * If the passed msg is NULL it returns the first message + * in the conversation * * @param call SIP call structure * @param msg Actual SIP msg from the call (can be NULL) @@ -233,6 +250,16 @@ get_next_msg(sip_call_t *call, sip_msg_t *msg); extern sip_msg_t * get_next_msg_ex(sip_call_t *call, sip_msg_t *msg); +/** + * @brief Parse internal header and payload + * + * By default, only the first message of each call is parsed. + * This function will parse the message (if it's not already parsed) + * filling all internal fields. + * + * @param msg Not Parsed (or parsed) message + * @return a parsed message + */ extern sip_msg_t * parse_msg(sip_msg_t *msg); diff --git a/src/ui_call_flow.c b/src/ui_call_flow.c index a78d507..a848537 100644 --- a/src/ui_call_flow.c +++ b/src/ui_call_flow.c @@ -1,36 +1,40 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_flow.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in ui_call_flow.h + * + * @todo Code help screen. Please. + * @todo Maybe we should merge this and Call-Flow Extended into one panel + * + */ #include #include -#include "ui_manager.h" #include "ui_call_flow.h" #include "ui_call_flow_ex.h" #include "ui_call_raw.h" -/** - * @brief Call flow status information - * This data stores the actual status of the panel. It's stored in the - * PANEL user pointer. - */ PANEL * call_flow_create() { @@ -79,21 +83,6 @@ call_flow_create() return panel; } -int -call_flow_redraw_required(PANEL *panel, sip_msg_t *msg) -{ - // Get panel information - call_flow_info_t *info; - - // Check we have panel info - if (!(info = (call_flow_info_t*) panel_userptr(panel))) return -1; - - // If this message belongs to first call - if (msg->call == info->call) return 0; - - return -1; -} - void call_flow_destroy(PANEL *panel) { @@ -111,6 +100,21 @@ call_flow_destroy(PANEL *panel) del_panel(panel); } +int +call_flow_redraw_required(PANEL *panel, sip_msg_t *msg) +{ + // Get panel information + call_flow_info_t *info; + + // Check we have panel info + if (!(info = (call_flow_info_t*) panel_userptr(panel))) return -1; + + // If this message belongs to first call + if (msg->call == info->call) return 0; + + return -1; +} + int call_flow_draw(PANEL *panel) { @@ -261,7 +265,6 @@ call_flow_handle_key(PANEL *panel, int key) ui_set_replace(ui_find_by_panel(panel), next_panel); break; case 'r': - case 'R': // KEY_R, display current call in raw mode next_panel = ui_create(ui_find_by_type(RAW_PANEL)); call_raw_set_call(info->call); diff --git a/src/ui_call_flow.h b/src/ui_call_flow.h index 16dad46..35b7074 100644 --- a/src/ui_call_flow.h +++ b/src/ui_call_flow.h @@ -1,27 +1,36 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_flow.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage Call Flow screen + * + * This file contains the functions and structures to manage the call flow + * screen. + * + */ #ifndef __UI_CALL_FLOW_H #define __UI_CALL_FLOW_H -#include "sip.h" #include "ui_manager.h" //! Sorter declaration of struct call_flow_info @@ -29,6 +38,7 @@ typedef struct call_flow_info call_flow_info_t; /** * @brief Call flow status information + * * This data stores the actual status of the panel. It's stored in the * PANEL user pointer. */ @@ -41,18 +51,88 @@ struct call_flow_info int cur_line; }; +/** + * @brief Create Call Flow panel + * + * This function will allocate the ncurses pointer and draw the static + * stuff of the screen (which usually won't be redrawn) + * It will also create an information structure of the panel status and + * store it in the panel's userpointer + * + * @return the allocated ncurses panel + */ extern PANEL * call_flow_create(); + +/** + * @brief Destroy panel + * + * This function will hide the panel and free all allocated memory. + * + * @return panel Ncurses panel pointer + */ extern void call_flow_destroy(PANEL *panel); + +/** + * @brief Check if the panel requires to be redrawn + * + * During online mode, this function will be invoked if this is the topmost + * panel every time a new message has been readed. + * + * @param panel Ncurses panel pointer + * @param msg New readed message + * @return 0 if the panel needs to be redrawn, -1 otherwise + */ extern int call_flow_redraw_required(PANEL *panel, sip_msg_t *msg); + +/** + * @brief Draw the Call flow panel + * + * This function will drawn the panel into the screen based on its stored + * status + * + * @param panel Ncurses panel pointer + * @return 0 if the panel has been drawn, -1 otherwise + */ extern int call_flow_draw(PANEL *panel); + +/** + * @brief Handle Call flow key strokes + * + * This function will manage the custom keybindings of the panel. If this + * function returns -1, the ui manager will check if the pressed key + * is one of the common ones (like toggle colors and so). + * + * @param panel Ncurses panel pointer + * @param key Pressed keycode + * @return 0 if the function can handle the key, -1 otherwise + */ extern int call_flow_handle_key(PANEL *panel, int key); + +/** + * @brief Request the panel to show its help + * + * This function will request to panel to show its help (if any) by + * invoking its help function. + * + * @param panel Ncurses panel pointer + * @return 0 if the screen has help, -1 otherwise + */ extern int call_flow_help(PANEL *panel); + +/** + * @brief Set the active call of the panel + * + * This function will access the panel information and will set the + * call pointer to the processed call. + * + * @param call Call pointer to be set in the internal info struct + */ extern int call_flow_set_call(sip_call_t *call); diff --git a/src/ui_call_flow_ex.c b/src/ui_call_flow_ex.c index a1dc388..c816a8d 100644 --- a/src/ui_call_flow_ex.c +++ b/src/ui_call_flow_ex.c @@ -1,36 +1,40 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_flow_ex.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in ui_call_flow_ex.h + * + * @todo Code help screen. Please. + * @todo Maybe we should merge this and Call-Flow into one panel + * + */ #include #include -#include "ui_manager.h" #include "ui_call_flow.h" #include "ui_call_flow_ex.h" #include "ui_call_raw.h" -/** - * @brief Call flow status information - * This data stores the actual status of the panel. It's stored in the - * PANEL user pointer. - */ PANEL * call_flow_ex_create() { @@ -86,26 +90,6 @@ call_flow_ex_create() return panel; } -int -call_flow_ex_redraw_required(PANEL *panel, sip_msg_t *msg) -{ - // Get panel information - call_flow_ex_info_t *info; - - // Check we have panel info - if (!(info = (call_flow_ex_info_t*) panel_userptr(panel))) return -1; - - // If this message belongs to first call - if (msg->call == info->call) - return 0; - - // If this message belongs to second call - if (msg->call == info->call2) - return 0; - - return -1; -} - void call_flow_ex_destroy(PANEL *panel) { @@ -123,6 +107,24 @@ call_flow_ex_destroy(PANEL *panel) del_panel(panel); } +int +call_flow_ex_redraw_required(PANEL *panel, sip_msg_t *msg) +{ + // Get panel information + call_flow_ex_info_t *info; + + // Check we have panel info + if (!(info = (call_flow_ex_info_t*) panel_userptr(panel))) return -1; + + // If this message belongs to first call + if (msg->call == info->call) return 0; + + // If this message belongs to second call + if (msg->call == info->call2) return 0; + + return -1; +} + int call_flow_ex_draw(PANEL *panel) { @@ -295,7 +297,6 @@ call_flow_ex_handle_key(PANEL *panel, int key) ui_set_replace(ui_find_by_panel(panel), next_panel); break; case 'r': - case 'R': // KEY_R, display current call in raw mode next_panel = ui_create(ui_find_by_type(RAW_PANEL)); call_raw_set_call(info->call); diff --git a/src/ui_call_flow_ex.h b/src/ui_call_flow_ex.h index 7537945..b22ad09 100644 --- a/src/ui_call_flow_ex.h +++ b/src/ui_call_flow_ex.h @@ -1,34 +1,44 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ -#ifndef __UI_CALL_flow_ex_H -#define __UI_CALL_flow_ex_H -#include "sip.h" +/** + * @file ui_call_flow_ex.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage Call Flow Extended screen + * + * This file contains the functions and structures to manage the call flow + * extended screen. + * + */ +#ifndef __UI_CALL_FLOW_EX_H +#define __UI_CALL_FLOW_EX_H #include "ui_manager.h" //! Sorter declaration of struct call_flow_ex_info typedef struct call_flow_ex_info call_flow_ex_info_t; /** - * @brief Call flow status information + * @brief Call flow Extended status information + * * This data stores the actual status of the panel. It's stored in the * PANEL user pointer. */ @@ -42,18 +52,88 @@ struct call_flow_ex_info int cur_line; }; +/** + * @brief Create Call Flow extended panel + * + * This function will allocate the ncurses pointer and draw the static + * stuff of the screen (which usually won't be redrawn) + * It will also create an information structure of the panel status and + * store it in the panel's userpointer + * + * @return the allocated ncurses panel + */ extern PANEL * call_flow_ex_create(); + +/** + * @brief Destroy panel + * + * This function will hide the panel and free all allocated memory. + * + * @return panel Ncurses panel pointer + */ extern void call_flow_ex_destroy(PANEL *panel); + +/** + * @brief Check if the panel requires to be redrawn + * + * During online mode, this function will be invoked if this is the topmost + * panel every time a new message has been readed. + * + * @param panel Ncurses panel pointer + * @param msg New readed message + * @return 0 if the panel needs to be redrawn, -1 otherwise + */ extern int call_flow_ex_redraw_required(PANEL *panel, sip_msg_t *msg); + +/** + * @brief Draw the Call flow extended panel + * + * This function will drawn the panel into the screen based on its stored + * status + * + * @param panel Ncurses panel pointer + * @return 0 if the panel has been drawn, -1 otherwise + */ extern int call_flow_ex_draw(PANEL *panel); + +/** + * @brief Handle Call flow extended key strokes + * + * This function will manage the custom keybindings of the panel. If this + * function returns -1, the ui manager will check if the pressed key + * is one of the common ones (like toggle colors and so). + * + * @param panel Ncurses panel pointer + * @param key Pressed keycode + * @return 0 if the function can handle the key, -1 otherwise + */ extern int call_flow_ex_handle_key(PANEL *panel, int key); + +/** + * @brief Request the panel to show its help + * + * This function will request to panel to show its help (if any) by + * invoking its help function. + * + * @param panel Ncurses panel pointer + * @return 0 if the screen has help, -1 otherwise + */ extern int call_flow_ex_help(PANEL *panel); + +/** + * @brief Set the active call of the panel + * + * This function will access the panel information and will set the + * call pointer to the processed call. + * + * @param call Call pointer to be set in the internal info struct + */ extern int call_flow_ex_set_call(sip_call_t *call); diff --git a/src/ui_call_list.c b/src/ui_call_list.c index 0cdc95a..1f232b5 100644 --- a/src/ui_call_list.c +++ b/src/ui_call_list.c @@ -1,24 +1,33 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_list.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in ui_call_list.h + * + * @todo Recode help screen. Please. + * @todo Replace calls structure this for a iterator at sip.h + */ #include #include #include @@ -26,10 +35,9 @@ #include "ui_call_flow.h" #include "ui_call_flow_ex.h" #include "ui_call_raw.h" -#include "sip.h" -// FIXME create a getter function for this at sip.c -extern struct sip_call *calls; +//! Calls structure list +extern sip_call_t *calls; PANEL * call_list_create() @@ -76,7 +84,7 @@ call_list_create() mvwaddch(win, 7, width - 1, ACS_RTEE); mvwprintw(win, height - 2, 2, "Q/Esc: Quit"); mvwprintw(win, height - 2, 16, "F1: Help"); - mvwprintw(win, height - 2, 27, "X: Call-Flow Extended"); + mvwprintw(win, height - 2, 27, "x: Call-Flow Extended"); // Draw columns titles for (colpos = 5, i = 0; i < info->columncnt; i++) { @@ -89,9 +97,25 @@ call_list_create() return panel; } +void +call_list_destroy(PANEL *panel) +{ + call_list_info_t *info; + + // Hide the panel + hide_panel(panel); + + // Free its status data + if ((info = (call_list_info_t*) panel_userptr(panel))) free(info); + + // Finally free the panel memory + del_panel(panel); +} + int call_list_redraw_required(PANEL *panel, sip_msg_t *msg) { + //@todo alway redraw this screen on new messages return 0; } @@ -296,21 +320,6 @@ call_list_help(PANEL * ppanel) return 0; } -void -call_list_destroy(PANEL *panel) -{ - call_list_info_t *info; - - // Hide the panel - hide_panel(panel); - - // Free its status data - if ((info = (call_list_info_t*) panel_userptr(panel))) free(info); - - // Finally free the panel memory - del_panel(panel); -} - int call_list_add_column(PANEL *panel, int id, char *title, int width) { diff --git a/src/ui_call_list.h b/src/ui_call_list.h index b4cae55..a8aeb73 100644 --- a/src/ui_call_list.h +++ b/src/ui_call_list.h @@ -1,28 +1,37 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_list.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage Call List screen + * + * This file contains the functions and structures to manage the call list + * screen. + * + */ #ifndef __UI_CALL_LIST_H #define __UI_CALL_LIST_H #include "ui_manager.h" -#include "sip.h" //! Sorter declaration of call_list_column struct typedef struct call_list_column call_list_column_t; @@ -31,6 +40,7 @@ typedef struct call_list_info call_list_info_t; /** * @brief Call List column information + * * It will be nice make which columns will appear in this list and * in which order a configurable option. * This structure is one step towards configurable stuff @@ -44,6 +54,7 @@ struct call_list_column /** * @brief Call List panel status information + * * This data stores the actual status of the panel. It's stored in the * panel pointer. */ @@ -65,18 +76,92 @@ struct call_list_info int cur_line; }; +/** + * @brief Create Call List panel + * + * This function will allocate the ncurses pointer and draw the static + * stuff of the screen (which usually won't be redrawn) + * It will also create an information structure of the panel status and + * store it in the panel's userpointer + * + * @return the allocated ncurses panel + */ extern PANEL * call_list_create(); -extern int -call_list_redraw_required(PANEL *panel, sip_msg_t *msg); -extern int -call_list_draw(PANEL *panel); -extern int -call_list_handle_key(PANEL *panel, int key); -extern int -call_list_help(PANEL *panel); + +/** + * @brief Destroy panel + * + * This function will hide the panel and free all allocated memory. + * + * @return panel Ncurses panel pointer + */ extern void call_list_destroy(PANEL *panel); + +/** + * @brief Check if the panel requires to be redrawn + * + * During online mode, this function will be invoked if this is the topmost + * panel every time a new message has been readed. + * + * @param panel Ncurses panel pointer + * @param msg New readed message + * @return 0 if the panel needs to be redrawn, -1 otherwise + */ +extern int +call_list_redraw_required(PANEL *panel, sip_msg_t *msg); + +/** + * @brief Draw the Call list panel + * + * This function will drawn the panel into the screen based on its stored + * status + * + * @param panel Ncurses panel pointer + * @return 0 if the panel has been drawn, -1 otherwise + */ +extern int +call_list_draw(PANEL *panel); + +/** + * @brief Handle Call list key strokes + * + * This function will manage the custom keybindings of the panel. If this + * function returns -1, the ui manager will check if the pressed key + * is one of the common ones (like toggle colors and so). + * + * @param panel Ncurses panel pointer + * @param key Pressed keycode + * @return 0 if the function can handle the key, -1 otherwise + */ +extern int +call_list_handle_key(PANEL *panel, int key); + +/** + * @brief Request the panel to show its help + * + * This function will request to panel to show its help (if any) by + * invoking its help function. + * + * @param panel Ncurses panel pointer + * @return 0 if the screen has help, -1 otherwise + */ +extern int +call_list_help(PANEL *panel); + +/** + * @brief Add a column the Call List + * + * This function will add a new column to the Call List panel + * @todo Columns are not configurable yet. + * + * @param panel Ncurses panel pointer + * @param id Column ID + * @param title Column Title + * @param width Column Width + * @return 0 if column has been successufly added to the list, -1 otherwise + */ extern int call_list_add_column(PANEL *panel, int id, char *title, int width); #endif diff --git a/src/ui_call_raw.c b/src/ui_call_raw.c index e7e8afc..aa56e75 100644 --- a/src/ui_call_raw.c +++ b/src/ui_call_raw.c @@ -1,27 +1,36 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_raw.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in ui_call_raw.h + * + * @todo Code help screen. Please. + * @todo Replace the panel refresh. Wclear sucks on high latency conections. + * + */ #include #include -#include "ui_manager.h" #include "ui_call_raw.h" PANEL * @@ -49,6 +58,7 @@ call_raw_create() return panel; } + int call_raw_redraw_required(PANEL *panel, sip_msg_t *msg) { @@ -130,12 +140,6 @@ call_raw_handle_key(PANEL *panel, int key) return 0; } -int -call_raw_help(PANEL * ppanel) -{ - return 0; -} - int call_raw_set_call(sip_call_t *call) { diff --git a/src/ui_call_raw.h b/src/ui_call_raw.h index 9eb15e5..1887792 100644 --- a/src/ui_call_raw.h +++ b/src/ui_call_raw.h @@ -1,27 +1,36 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_call_raw.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage Raw output screen of Sip messages + * + * This file contains the functions and structures to manage the raw message + * output screen. + * + */ #ifndef __UI_CALL_RAW_H #define __UI_CALL_RAW_H -#include "sip.h" #include "ui_manager.h" //! Sorter declaration of struct call_raw_info @@ -29,6 +38,7 @@ typedef struct call_raw_info call_raw_info_t; /** * @brief Call raw status information + * * This data stores the actual status of the panel. It's stored in the * PANEL user pointer. */ @@ -40,16 +50,66 @@ struct call_raw_info int all_lines; }; +/** + * @brief Create Call Raw panel + * + * This function will allocate the ncurses pointer and draw the static + * stuff of the screen (which usually won't be redrawn) + * It will also create an information structure of the panel status and + * store it in the panel's userpointer + * + * @return the allocated ncurses panel + */ extern PANEL * call_raw_create(); -int + +/** + * @brief Check if the panel requires to be redrawn + * + * During online mode, this function will be invoked if this is the topmost + * panel every time a new message has been readed. + * + * @param panel Ncurses panel pointer + * @param msg New readed message + * @return 0 if the panel needs to be redrawn, -1 otherwise + */ +extern int call_raw_redraw_required(PANEL *panel, sip_msg_t *msg); + +/** + * @brief Draw the Call Raw panel + * + * This function will drawn the panel into the screen based on its stored + * status + * + * @param panel Ncurses panel pointer + * @return 0 if the panel has been drawn, -1 otherwise + */ extern int call_raw_draw(PANEL *panel); + +/** + * @brief Handle Call Raw key strokes + * + * This function will manage the custom keybindings of the panel. If this + * function returns -1, the ui manager will check if the pressed key + * is one of the common ones (like toggle colors and so). + * + * @param panel Ncurses panel pointer + * @param key Pressed keycode + * @return 0 if the function can handle the key, -1 otherwise + */ extern int call_raw_handle_key(PANEL *panel, int key); -extern int -call_raw_help(PANEL *panel); + +/** + * @brief Set the active call of the panel + * + * This function will access the panel information and will set the + * call pointer to the processed call. + * + * @param call Call pointer to be set in the internal info struct + */ extern int call_raw_set_call(sip_call_t *call); diff --git a/src/ui_manager.c b/src/ui_manager.c index 4ae8344..b6ec640 100644 --- a/src/ui_manager.c +++ b/src/ui_manager.c @@ -1,17 +1,31 @@ -/****************************************************************************** +/************************************************************************** ** - ** Copyright (C) 2011-2012 Irontec SL. All rights reserved. + ** sngrep - SIP callflow viewer using ngrep ** - ** This file may be used under the terms of the GNU General Public - ** License version 3.0 as published by the Free Software Foundation - ** and appearing in the file LICENSE.GPL included in the packaging of - ** this file. Please review the following information to ensure GNU - ** General Public Licensing requirements will be met: + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE - ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ******************************************************************************/ + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. + ** + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . + ** + ****************************************************************************/ +/** + * @file ui_manager.c + * @author Ivan Alonso [aka Kaian] + * + * @brief Source of functions defined in ui_manager.h + * + */ #include "ui_manager.h" #include "ui_call_list.h" #include "ui_call_flow.h" @@ -20,8 +34,10 @@ /** * @brief Interface status data + * * XXX I think this should be in the applicaton configuration structure * avaliable everywhere in the program + * FIXME Replace this an ui_config for an application configuration struct */ static struct ui_status { @@ -30,8 +46,10 @@ static struct ui_status /** * @brief Available panel windows list + * * This list contein the available list of windows * and pointer to their main functions. + * * XXX If the panel count increase a lot, it will be required to * load panels as modules and provide a way to register * themselfs into the panel pool dynamically. @@ -69,15 +87,8 @@ static ui_t panel_pool[] = { .create = call_raw_create, .redraw_required = call_raw_redraw_required, .draw = call_raw_draw, - .handle_key = call_raw_handle_key, - .help = call_raw_help } }; + .handle_key = call_raw_handle_key, } }; -/** - * Initialize ncurses mode and create a main window - * - * @param ui_config UI configuration structure - * @returns 0 on ncurses initialization success, 1 otherwise - */ int init_interface(const struct ui_config uicfg) { @@ -209,7 +220,9 @@ ui_t * ui_find_by_panel(PANEL *panel) { int i; + // Panel pool is fixed size int panelcnt = sizeof(panel_pool) / sizeof(ui_t); + // Return ui pointer if found for (i = 0; i < panelcnt; i++) { if (panel_pool[i].panel == panel) return &panel_pool[i]; } @@ -220,7 +233,9 @@ ui_t * ui_find_by_type(int type) { int i; + // Panel pool is fixed size int panelcnt = sizeof(panel_pool) / sizeof(ui_t); + // Return ui pointer if found for (i = 0; i < panelcnt; i++) { if (panel_pool[i].type == type) return &panel_pool[i]; } @@ -257,18 +272,15 @@ wait_for_input(ui_t *ui) // Otherwise, use standard keybindings switch (c) { - case 'C': case 'c': - // TODO general application config structure + // @todo general application config structure status.color = (status.color) ? 0 : 1; toggle_color(status.color); break; - case 'H': case 'h': case 265: /* KEY_F1 */ ui_help(ui); break; - case 'Q': case 'q': case 27: /* KEY_ESC */ ui_destroy(ui); diff --git a/src/ui_manager.h b/src/ui_manager.h index 2dc3048..d65daa0 100644 --- a/src/ui_manager.h +++ b/src/ui_manager.h @@ -1,26 +1,41 @@ /************************************************************************** ** - ** sngrep - Ncurses ngrep interface for SIP + ** sngrep - SIP callflow viewer using ngrep ** - ** Copyright (C) 2013 Ivan Alonso (Kaian) - ** Copyright (C) 2013 Irontec SL. All rights reserved. + ** Copyright (C) 2013 Ivan Alonso (Kaian) + ** Copyright (C) 2013 Irontec SL. All rights reserved. ** - ** This program is free software: you can redistribute it and/or modify - ** it under the terms of the GNU General Public License as published by - ** the Free Software Foundation, either version 3 of the License, or - ** (at your option) any later version. + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. ** - ** This program is distributed in the hope that it will be useful, - ** but WITHOUT ANY WARRANTY; without even the implied warranty of - ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - ** GNU General Public License for more details. + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. ** - ** You should have received a copy of the GNU General Public License - ** along with this program. If not, see . + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see . ** ****************************************************************************/ +/** + * @file ui_manager.h + * @author Ivan Alonso [aka Kaian] + * + * @brief Functions to manage interface panels + * + * All sngrep panel pointers are encapsulated into a ui structure that is + * used to invoke custom functions for creating, destroying, drawing, etc + * the screens. + * + * This sctructure also manages concurrents updates and access to ncurses + * panel pointers. + * + */ #ifndef __SNGREP_UI_MANAGER_H #define __SNGREP_UI_MANAGER_H + #include #include #include "sip.h" @@ -30,6 +45,7 @@ typedef struct ui ui_t; /** * @brief Panel information structure + * * This struct contains the panel related data, including * a pointer to the function that manages its drawing */ @@ -65,37 +81,51 @@ struct ui }; /** - * Enum for available color pairs + * @brief Enum for available color pairs + * * Colors for each pair are chosen in toggle_colors function */ enum sngrep_colors { + //! Highlight color for Call List HIGHLIGHT_COLOR = 1, + //! Key name color in help screens HELP_COLOR, + //! Outgoing messages color OUTGOING_COLOR, + //! Incoming messages color INCOMING_COLOR, + //! Call-Flow border color DETAIL_BORDER_COLOR, - DETAIL_WIN_COLOR, }; /** - * Enum for available panel types + * @brief Enum for available panel types + * * Mostly used for managing keybindings and offloop ui refresh + * + * FIXME Replace this IDs for something more representative */ enum panel_types { + //! Call List ui screen MAIN_PANEL = 0, - MHELP_PANEL, + //! Call-Flow ui screen DETAILS_PANEL, + //! Call-Flow Extended ui screen DETAILS_EX_PANEL, + //! Raw SIP messages ui screen RAW_PANEL, }; /** - * Interface configuration. + * @brief Interface configuration. + * * If some day a rc file is created, its data will be loaded * into this structure. * By now, we'll store some ui information. + * + * FIXME Replace this for an application config struct */ struct ui_config { @@ -105,7 +135,10 @@ struct ui_config }; /** - * Initialize ncurses mode and create a main window + * @brief Initialize ncurses mode + * + * This functions will initialize ncurses mode and show a + * Call List panel. * * @param ui_config UI configuration structure * @returns 0 on ncurses initialization success, 1 otherwise @@ -115,12 +148,24 @@ init_interface(const struct ui_config); /** * @brief Create a panel structure + * + * Create a ncurses panel associated to the given ui + * This function is a small wrapper for panel create function + * + * @param ui UI structure + * @return the ui structure with the panel pointer created */ extern ui_t * ui_create(ui_t *ui); /** * @brief Destroy a panel structure + * + * Removes the panel associatet to the given ui and free + * its memory. Most part of this task is done in the custom + * destroy function of the panel. + * + * @param ui UI structure */ extern void ui_destroy(ui_t *ui); @@ -218,8 +263,12 @@ extern int wait_for_input(ui_t *ui); /** - * Draw a box around passed windows with two bars (top and bottom) - * of one line each. + * @brief Draw a box around passed windows + * + * Draw a box around passed windows with two bars + * (top and bottom) of one line each. + * + * FIXME The parameter should be a panel, or ui, but not a window.. * * @param win Window to draw borders on */ @@ -227,6 +276,8 @@ extern void title_foot_box(WINDOW *win); /** + * @brief Update topmost panel with the newest readed message + * * This function is invocked asynchronously from the * ngrep exec thread to notify a new message of the giving * callid. If the UI is displaying this call or it's