diff options
37 files changed, 2548 insertions, 261 deletions
diff --git a/project2/Doxyfile b/project2/Doxyfile new file mode 100644 index 0000000..d59538c --- /dev/null +++ b/project2/Doxyfile @@ -0,0 +1,1600 @@ +# Doxyfile 1.6.3 + +# 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 = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = Project2 + +# 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 = v0.2 + +# 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 = docs + +# 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-Cyrilic, 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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +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 is your file systems +# 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 = + +# 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 = NO + +# 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, C#, 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 make 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 to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +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 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 penality. +# 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 rougly 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 + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# 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 = NO + +# 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 = NO + +# 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 = YES + +# 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 + +# 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 define 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 defines 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 <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. 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 = + +#--------------------------------------------------------------------------- +# 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 + +# This WARN_NO_PARAMDOC option can be abled 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 = . + +# 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 = UTF-8 + +# 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++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.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 \ + *.vhd \ + *.vhdl + +# 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 +# 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. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem 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 <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +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, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# 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 + +#--------------------------------------------------------------------------- +# 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 = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# 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 = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# 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 = NO + +# 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. + +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 = + +# 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 +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# 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 + +# 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 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +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 at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# 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. + +GENERATE_TREEVIEW = NO + +# 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 + +# 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 + +# 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 disadvances is 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, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# 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 = + +# 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 + +#--------------------------------------------------------------------------- +# 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 stylesheet 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 +# in the INCLUDE_PATH (see below) will be search if 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. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +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 is superseded by the HAVE_DOT option below. This is only a +# fallback. 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 + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need 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 = FreeSans + +# 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 output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +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 +# 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 = NO + +# 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 = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will 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 png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# 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 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/project2/Jamfile.jam b/project2/Jamfile.jam index fe900cd..a8cf8ae 100644 --- a/project2/Jamfile.jam +++ b/project2/Jamfile.jam @@ -1,22 +1,22 @@ +using gcc ; + alias libxmlpp : : : : <cflags>"`pkg-config --cflags libxml++-2.6`" <linkflags>"`pkg-config --libs libxml++-2.6`" ; lib fcgi : : <name>fcgi ; lib odbc : : <name>odbc ; +lib boost_regex : : <name>boost_regex ; +lib cgicc : : <name>cgicc ; exe p2web : - p2webMain.cpp - sourceObject.cpp - dataSource.cpp - rdbmsDataSource.cpp - view.cpp - sqlView.cpp - envproc.cpp libxmlpp + [ glob *.cpp ] ../libmisc ../libodbcpp : <include>../libmisc/ <include>../libodbcpp/ + <library>boost_regex <library>odbc + <library>cgicc <library>fcgi ; diff --git a/project2/appEngine.cpp b/project2/appEngine.cpp new file mode 100644 index 0000000..632bb11 --- /dev/null +++ b/project2/appEngine.cpp @@ -0,0 +1,10 @@ +#include "appEngine.h" + +ApplicationEngine::ApplicationEngine(const Environment *) +{ +} + +ApplicationEngine::~ApplicationEngine() +{ +} + diff --git a/project2/appEngine.h b/project2/appEngine.h new file mode 100644 index 0000000..cffd44e --- /dev/null +++ b/project2/appEngine.h @@ -0,0 +1,36 @@ +#ifndef APPENGINE_H +#define APPENGINE_H + +#include "environment.h" +#include "dataSource.h" + +class ApplicationEngine { + public: + class DataSourceNotFound : std::exception { }; + class DataSourceNotCompatible : std::exception { }; + + ApplicationEngine(const Environment *); + virtual ~ApplicationEngine() = 0; + + virtual void process() const = 0; + virtual const Environment * env() const = 0; + + template <class DataSourceType> + const DataSourceType * dataSource(const std::string & name) const + { + DataSources::const_iterator i = datasources.find(name); + if (i == datasources.end()) { + throw DataSourceNotFound(); + } + const DataSourceType * s = dynamic_cast<const DataSourceType *>(i->second.get()); + if (!s) { + throw DataSourceNotCompatible(); + } + return s; + } + protected: + mutable DataSources datasources; +}; + +#endif + diff --git a/project2/cgiAppEngine.cpp b/project2/cgiAppEngine.cpp new file mode 100644 index 0000000..860ce51 --- /dev/null +++ b/project2/cgiAppEngine.cpp @@ -0,0 +1,152 @@ +#include "cgiAppEngine.h" +#include <syslog.h> +#include <cgicc/Cgicc.h> +#include <libxml++/parsers/domparser.h> +#include <libxml/xinclude.h> +#include "xmlObjectLoader.h" +#include "rdbmsDataSource.h" +#include <boost/bind.hpp> + + +CgiApplicationEngine::CgiApplicationEngine(const CgiEnvironment * e) : + ApplicationEngine(e), + _env(e) +{ + if (_env->getRequestMethod() == "POST") { + currentStage = new RequestStage(this, e->elems[0]); + } + else { + currentStage = new PresentStage(this, e->elems.size() > 0 ? e->elems[0] : "index"); + } +} + +CgiApplicationEngine::~CgiApplicationEngine() +{ +} + +const Environment * +CgiApplicationEngine::env() const +{ + return _env; +} + +void +CgiApplicationEngine::process() const +{ + while (!doc && currentStage) { + Stage * prev = currentStage; + currentStage = currentStage->run(); + delete prev; + } +} + +CgiApplicationEngine::Stage::Stage(const CgiApplicationEngine * e) : appEngine(e) +{ +} + +CgiApplicationEngine::Stage::~Stage() +{ +} + +CgiApplicationEngine::PresentStage::PresentStage(const CgiApplicationEngine * e, const std::string & id) : CgiApplicationEngine::Stage(e) +{ + xmlpp::DomParser present("present/" + id + ".xml"); + while (xmlXIncludeProcessFlags(present.get_document()->cobj(), XML_PARSE_NOXINCNODE) > 0); + xmlpp::Element * presentRoot = present.get_document()->get_root_node(); + responseRootNodeName = presentRoot->get_attribute_value("root"); + responseStyle = presentRoot->get_attribute_value("style"); + + Loaders loaders; + _DataSource::AddLoaders(loaders, appEngine->datasources); + _ParamChecker::AddLoaders(loaders, parameterChecks); + _View::AddLoaders(loaders, views); + _LoaderBase::collectAll(loaders, "project2", presentRoot, true, true); +} +CgiApplicationEngine::PresentStage::~PresentStage() +{ +} +CgiApplicationEngine::Stage * +CgiApplicationEngine::PresentStage::run() +{ + BOOST_FOREACH(OrderedParamCheckers::value_type pc, parameterChecks) { + if (!pc.second->performCheck(appEngine)) { + return new PresentStage(appEngine, pc.second->present); + } + } + boost::shared_ptr<xmlpp::Document> responseDoc = boost::shared_ptr<xmlpp::Document>(new xmlpp::Document("1.0")); + xmlpp::Element * responseRoot = responseDoc->create_root_node(responseRootNodeName); + BOOST_FOREACH(Views::value_type s, views) { + s.second->execute(responseRoot, this->appEngine); + } + // These were for debug... but why not pass them on? + xmlNewNs(responseRoot->cobj(), BAD_CAST "http://project2.randomdan.homeip.net/", BAD_CAST "project2"); + responseRoot->add_child("fqdn", "project2")->set_child_text(appEngine->_env->getServerName()); + responseRoot->add_child("requesturi", "project2")->set_child_text(appEngine->_env->getScriptName()); + // URL elements + xmlpp::Element * uriElems = responseRoot->add_child("uriElems", "project2"); + BOOST_FOREACH(std::string s, appEngine->_env->elems) { + uriElems->add_child("uriElem", "project2")->set_child_text(s); + } + // Parameters + xmlpp::Element * paramsXml = responseRoot->add_child("params", "project2"); + BOOST_FOREACH(cgicc::FormEntry fe, appEngine->_env->cgi->getElements()) { + xmlpp::Element * param = paramsXml->add_child("param", "project2"); + param->add_child_text(fe.getValue()); + param->set_attribute("name", fe.getName()); + } + // XSLT Style + char * buf; + if (asprintf(&buf, "type=\"text/xsl\" href=\"%s\"", + responseStyle.c_str()) > 0) { + xmlAddPrevSibling(responseRoot->cobj(), + xmlNewDocPI(responseDoc->cobj(), BAD_CAST "xml-stylesheet", BAD_CAST buf)); + } + free(buf); + appEngine->doc = responseDoc; + return NULL; +} + +CgiApplicationEngine::RequestStage::RequestStage(const CgiApplicationEngine * e, const std::string & id) : CgiApplicationEngine::Stage(e) +{ + xmlpp::DomParser request("request/" + id + ".xml"); + while (xmlXIncludeProcessFlags(request.get_document()->cobj(), XML_PARSE_NOXINCNODE) > 0); + xmlpp::Element * requestRoot = request.get_document()->get_root_node(); + present = requestRoot->get_attribute_value("present"); + + Loaders loaders; + _DataSource::AddLoaders(loaders, appEngine->datasources); + _ParamChecker::AddLoaders(loaders, parameterChecks); + _Task::AddLoaders(loaders, tasks); + _LoaderBase::collectAll(loaders, "project2", requestRoot, true, true); +} +CgiApplicationEngine::RequestStage::~RequestStage() +{ +} +CgiApplicationEngine::Stage * +CgiApplicationEngine::RequestStage::run() +{ + BOOST_FOREACH(OrderedParamCheckers::value_type pc, parameterChecks) { + if (!pc.second->performCheck(appEngine)) { + return new PresentStage(appEngine, pc.second->present); + } + } + syslog(LOG_DEBUG, "Checks passed"); + try { + BOOST_FOREACH(OrderedTasks::value_type t, tasks) { + t.second->execute(appEngine); + } + // Commit data source transactions (without invoking a connection) + BOOST_FOREACH(DataSources::value_type ds, appEngine->datasources) { + ds.second->commit(); + } + } + catch (...) { + // Do something about the error + BOOST_FOREACH(DataSources::value_type ds, appEngine->datasources) { + ds.second->rollback(); + } + throw; + } + return new PresentStage(appEngine, present); +} + diff --git a/project2/cgiAppEngine.h b/project2/cgiAppEngine.h new file mode 100644 index 0000000..80707a0 --- /dev/null +++ b/project2/cgiAppEngine.h @@ -0,0 +1,58 @@ +#ifndef CGIAPPENGINE_H +#define CGIAPPENGINE_H + +#include "appEngine.h" +#include "cgiEnvironment.h" +#include "task.h" +#include "paramChecker.h" +#include <boost/shared_ptr.hpp> +#include <libxml++/document.h> + +class CgiApplicationEngine : public ApplicationEngine { + public: + CgiApplicationEngine(const CgiEnvironment *); + virtual ~CgiApplicationEngine(); + + void process() const; + template <class Writer> + void write(const Writer & w) const + { + w(doc->cobj()); + } + const Environment * env() const; + const CgiEnvironment * _env; + private: + mutable boost::shared_ptr<xmlpp::Document> doc; + class Stage { + public: + Stage(const CgiApplicationEngine *); + virtual ~Stage() = 0; + virtual Stage * run() = 0; + protected: + const CgiApplicationEngine * appEngine; + OrderedParamCheckers parameterChecks; + }; + class RequestStage : public Stage { + public: + RequestStage(const CgiApplicationEngine *, const std::string & id); + virtual ~RequestStage(); + virtual Stage * run(); + std::string present; + protected: + OrderedTasks tasks; + }; + class PresentStage : public Stage { + public: + PresentStage(const CgiApplicationEngine *, const std::string & id); + virtual ~PresentStage(); + virtual Stage * run(); + protected: + Views views; + Glib::ustring responseRootNodeName; + Glib::ustring responseStyle; + }; + mutable Stage * currentStage; +}; + +#endif + diff --git a/project2/cgiEnvironment.cpp b/project2/cgiEnvironment.cpp new file mode 100644 index 0000000..fe38f57 --- /dev/null +++ b/project2/cgiEnvironment.cpp @@ -0,0 +1,34 @@ +#include "cgiEnvironment.h" +#include <map> +#include <cgicc/Cgicc.h> +#include <boost/tokenizer.hpp> + +template <class X, class Y> +std::vector<X>makeVector(const Y & y) +{ + return std::vector<X>(y.begin(), y.end()); +} + +CgiEnvironment::CgiEnvironment(cgicc::Cgicc * c) : + cgicc::CgiEnvironment(c->getEnvironment()), + elems(makeVector<std::string>(boost::tokenizer<boost::char_separator<char> >(getRedirectURL(), boost::char_separator<char>("/")))), + cgi(c) +{ +} + +CgiEnvironment::~CgiEnvironment() +{ +} + +Glib::ustring +CgiEnvironment::getParamUri(const std::string & p) const +{ + return elems[atoi(p.c_str())]; +} + +Glib::ustring +CgiEnvironment::getParamQuery(const std::string & p) const +{ + return (*cgi)(p); +} + diff --git a/project2/cgiEnvironment.h b/project2/cgiEnvironment.h new file mode 100644 index 0000000..7d9b820 --- /dev/null +++ b/project2/cgiEnvironment.h @@ -0,0 +1,25 @@ +#ifndef ENVPROC_H +#define ENVPROC_H + +#include <string> +#include <vector> +#include "environment.h" +#include <cgicc/CgiEnvironment.h> + +namespace cgicc { + class Cgicc; +} + +class CgiEnvironment : public Environment, public cgicc::CgiEnvironment { + public: + CgiEnvironment(cgicc::Cgicc *); + virtual ~CgiEnvironment(); + + Glib::ustring getParamUri(const std::string & idx) const; + Glib::ustring getParamQuery(const std::string & idx) const; + + std::vector<std::string> elems; + const cgicc::Cgicc * const cgi; +}; + +#endif diff --git a/project2/dataSource.cpp b/project2/dataSource.cpp index f4b72cf..984ea53 100644 --- a/project2/dataSource.cpp +++ b/project2/dataSource.cpp @@ -1,6 +1,7 @@ #include "dataSource.h" #include "xmlObjectLoader.h" #include <libxml++/nodes/textnode.h> +#include "rdbmsDataSource.h" _DataSource::_DataSource(const xmlpp::Element * p) : _Project2SourceObject(p) @@ -11,3 +12,8 @@ _DataSource::~_DataSource() { } +void +_DataSource::AddLoaders(Loaders & l, DataSources & dss) +{ + l.insert(LoadersVT("rdbmsdatasource", _LoaderBase::Make<_RdbmsDataSource, _DataSource, std::string, _Project2SourceObject, &_Project2SourceObject::name>(&dss))); +} diff --git a/project2/dataSource.h b/project2/dataSource.h index 85bc395..9d30d07 100644 --- a/project2/dataSource.h +++ b/project2/dataSource.h @@ -5,14 +5,22 @@ #include <boost/shared_ptr.hpp> #include <map> #include "sourceObject.h" +#include "xmlObjectLoader.h" + +class _DataSource; +typedef boost::shared_ptr<_DataSource> DataSource; +typedef std::map<std::string, DataSource> DataSources; class _DataSource : public _Project2SourceObject { public: _DataSource(const xmlpp::Element * p); virtual ~_DataSource(); + + virtual void commit() { }; + virtual void rollback() { }; + + static void AddLoaders(Loaders & l, DataSources & dss); }; -typedef boost::shared_ptr<_DataSource> DataSource; -typedef std::map<std::string, DataSource> DataSources; #endif diff --git a/project2/environment.cpp b/project2/environment.cpp new file mode 100644 index 0000000..9e4d9f0 --- /dev/null +++ b/project2/environment.cpp @@ -0,0 +1,20 @@ +#include "environment.h" + +Environment::Environment() +{ +} + +Environment::~Environment() +{ +} + +Glib::ustring +Environment::getParamUri(const std::string &) const +{ + throw ParameterTypeNotSupported(); +} +Glib::ustring +Environment::getParamQuery(const std::string &) const +{ + throw ParameterTypeNotSupported(); +} diff --git a/project2/environment.h b/project2/environment.h new file mode 100644 index 0000000..b5e9307 --- /dev/null +++ b/project2/environment.h @@ -0,0 +1,20 @@ +#ifndef ENVIRONMENT_H +#define ENVIRONMENT_H + +#include <string> +#include <glibmm/ustring.h> + +class Environment { + public: + class ParameterTypeNotSupported : std::exception { }; + + Environment(); + virtual ~Environment() = 0; + + virtual Glib::ustring getParamUri(const std::string & idx) const; + virtual Glib::ustring getParamQuery(const std::string & idx) const; + private: +}; + +#endif + diff --git a/project2/envproc.cpp b/project2/envproc.cpp deleted file mode 100644 index feb5ad1..0000000 --- a/project2/envproc.cpp +++ /dev/null @@ -1,89 +0,0 @@ -#include "xmlObjectLoader.h" -#include "envproc.h" -#include "rdbmsDataSource.h" -#include "sqlView.h" -#include <map> -#include <libxml++/parsers/domparser.h> -#include <libxml/xinclude.h> -#include <boost/shared_ptr.hpp> -#include <boost/any.hpp> -#include <boost/foreach.hpp> - -void -EnvironmentProcessor::init() -{ - elems = regexExtractSet("/([^/?]+)", request_uri.c_str()); - params = regexExtractMulti("&?([^=]+)=?([^&]*)", query_string.c_str(), 2); - page = elems.size() > 0 ? elems[0] : "index"; -} - -void -EnvironmentProcessor::Initialise() -{ - xmlpp::DomParser present("present/" + page + ".xml"); - while (xmlXIncludeProcessFlags(present.get_document()->cobj(), XML_PARSE_NOXINCNODE) > 0); - xmlpp::Element * presentRoot = present.get_document()->get_root_node(); - responseRootNodeName = presentRoot->get_attribute_value("root"); - responseStyle = presentRoot->get_attribute_value("style"); - // Collect datasources - collectAll<_RdbmsDataSource>(datasources, presentRoot, "rdbmsdatasource", &_Project2SourceObject::name, true, true); - // Collect views - collectAll<_SqlView>(views, presentRoot, "sqlview", &_SqlView::name, true, true); -} - -boost::shared_ptr<xmlpp::Document> -EnvironmentProcessor::process() const -{ - boost::shared_ptr<xmlpp::Document> responseDoc = boost::shared_ptr<xmlpp::Document>(new xmlpp::Document("1.0")); - xmlpp::Element * responseRoot = responseDoc->create_root_node(responseRootNodeName); - try { - BOOST_FOREACH(Views::value_type s, views) { - s.second->execute(responseRoot, this); - } - } - catch (...) { - } - // These were for debug... but why not pass them on? - xmlNewNs(responseRoot->cobj(), BAD_CAST "http://project2.randomdan.homeip.net/", BAD_CAST "project2"); - responseRoot->add_child("fqdn", "project2")->set_child_text(http_host); - responseRoot->add_child("requesturi", "project2")->set_child_text(request_uri); - // URL elements - xmlpp::Element * uriElems = responseRoot->add_child("uriElems", "project2"); - BOOST_FOREACH(std::string s, elems) { - uriElems->add_child("uriElem", "project2")->set_child_text(s); - } - // Parameters - xmlpp::Element * paramsXml = responseRoot->add_child("params", "project2"); - BOOST_FOREACH(RegMultiMatch::value_type u, params) { - xmlpp::Element * param = paramsXml->add_child("param", "project2"); - param->add_child_text(u[1]); - param->set_attribute("name", u[0]); - } - // XSLT Style - char * buf; - if (asprintf(&buf, "type=\"text/xsl\" href=\"%s\"", - responseStyle.c_str()) > 0) { - xmlAddPrevSibling(responseRoot->cobj(), - xmlNewDocPI(responseDoc->cobj(), BAD_CAST "xml-stylesheet", BAD_CAST buf)); - } - free(buf); - return responseDoc; -} - -Glib::ustring -EnvironmentProcessor::getParamUri(const std::string & p) const -{ - return elems[atoi(p.c_str())]; -} - -Glib::ustring -EnvironmentProcessor::getParamQuery(const std::string & p) const -{ - BOOST_FOREACH(RegMultiMatch::value_type u, params) { - if (u[0] == p) { - return u[1]; - } - } - return Glib::ustring(); -} - diff --git a/project2/envproc.h b/project2/envproc.h deleted file mode 100644 index 44556b7..0000000 --- a/project2/envproc.h +++ /dev/null @@ -1,60 +0,0 @@ -#ifndef ENVPROC_H -#define ENVPROC_H - -#include <string> -#include <libxml++/document.h> -#include <boost/shared_ptr.hpp> -#include "regexex.h" -#include "dataSource.h" -#include "view.h" - -class EnvironmentProcessor { - public: - class DataSourceNotFound : std::exception { }; - class DataSourceNotCompatible : std::exception { }; - template <class getenvFunc> - EnvironmentProcessor(const getenvFunc & getenv) : - request_uri(getenv("REQUEST_URI")), - query_string(getenv("QUERY_STRING")), - http_host(getenv("HTTP_HOST")), - request_method(getenv("REQUEST_METHOD")) - { - init(); - } - template <class DataSourceType> - const DataSourceType * dataSource(const std::string & name) const - { - DataSources::const_iterator i = datasources.find(name); - if (i == datasources.end()) { - throw DataSourceNotFound(); - } - const DataSourceType * s = dynamic_cast<const DataSourceType *>(i->second.get()); - if (!s) { - throw DataSourceNotCompatible(); - } - return s; - } - void Initialise(); - virtual boost::shared_ptr<xmlpp::Document> process() const; - - Glib::ustring getParamUri(const std::string & idx) const; - Glib::ustring getParamQuery(const std::string & idx) const; - private: - void init(); - - std::string request_uri; - std::string query_string; - std::string http_host; - std::string request_method; - - StringSet elems; - RegMultiMatch params; - std::string page; - Glib::ustring responseRootNodeName; - Glib::ustring responseStyle; - - DataSources datasources; - Views views; -}; - -#endif diff --git a/project2/iHaveParameters.cpp b/project2/iHaveParameters.cpp new file mode 100644 index 0000000..c13eddf --- /dev/null +++ b/project2/iHaveParameters.cpp @@ -0,0 +1,26 @@ +#include "iHaveParameters.h" +#include "xmlObjectLoader.h" +#include <boost/foreach.hpp> + +IHaveParameters::IHaveParameters(const xmlpp::Element * p) +{ + xmlpp::NodeSet ps = p->find("parameters"); + Loaders loaders; + loaders.insert(LoadersVT("param", + _LoaderBase::Make<_Parameter, _Parameter, unsigned int, _Parameter, &_Parameter::bind>(¶meters))); + BOOST_FOREACH(xmlpp::Node * psi, ps) { + _LoaderBase::collectAll(loaders, "", dynamic_cast<const xmlpp::Element *>(psi), false, true); + } +} + +IHaveParameters::~IHaveParameters() +{ +} + +IHaveParameters::_Parameter::_Parameter(const xmlpp::Element * p) : + source(p->get_attribute_value("source")), + id(p->get_attribute_value("id")), + bind(atoi(p->get_attribute_value("bind").c_str())) +{ +} + diff --git a/project2/iHaveParameters.h b/project2/iHaveParameters.h new file mode 100644 index 0000000..31c597a --- /dev/null +++ b/project2/iHaveParameters.h @@ -0,0 +1,25 @@ +#ifndef IHAVEPARAMETERS +#define IHAVEPARAMETERS + +#include <libxml++/nodes/element.h> +#include <boost/shared_ptr.hpp> + +class IHaveParameters { + public: + class _Parameter { + public: + _Parameter(const xmlpp::Element * p); + const std::string source; + const std::string id; + const unsigned int bind; + }; + IHaveParameters(const xmlpp::Element * p); + virtual ~IHaveParameters() = 0; + typedef boost::shared_ptr<_Parameter> Parameter; + typedef std::map<unsigned int, Parameter> Parameters; + protected: + Parameters parameters; +}; + +#endif + diff --git a/project2/p2webMain.cpp b/project2/p2webMain.cpp index b5d4c59..1eafd2d 100644 --- a/project2/p2webMain.cpp +++ b/project2/p2webMain.cpp @@ -1,55 +1,76 @@ -// Undefine me to run from console for debugging -#define FCGI - #include <libxml/tree.h> -#ifdef FCGI +#include <cgicc/Cgicc.h> +#include <cgicc/CgiEnvironment.h> #include <fcgi_stdio.h> -#endif -#include "envproc.h" +#include "cgiEnvironment.h" +#include "cgiAppEngine.h" #include <boost/bind.hpp> -#ifdef FCGI int xmlWrite(void * _out, const char * buf, int len) { return FCGX_PutStr(buf, len, (FCGX_Stream*)_out); } -#endif +class CgiReader : public cgicc::CgiInput { + public: + CgiReader(FCGX_Stream * i, FCGX_ParamArray & e) : + in(i), + envp(e) + { + } + ~CgiReader() { } + + size_t read(char * data, size_t length) + { + return FCGX_GetStr(data, length, in); + } + std::string getenv(const char * env) + { + const char * e = FCGX_GetParam(env, envp); + return e ? e : ""; + } + private: + FCGX_Stream *in; + FCGX_ParamArray envp; +}; int main(void) { -#ifdef FCGI - FCGX_Stream *in, *_out, *err; - FCGX_ParamArray envp; + if (!FCGX_IsCGI()) { + FCGX_Stream *in, *_out, *err; + FCGX_ParamArray envp; - while (FCGX_Accept(&in, &_out, &err, &envp) >= 0) - { - try { - EnvironmentProcessor ep(boost::bind(FCGX_GetParam, _1, envp)); - ep.Initialise(); - boost::shared_ptr<xmlpp::Document> doc = ep.process(); - - FCGX_FPrintF(_out, "Content-type: text/xml-xslt\r\n\r\n"); - xmlOutputBufferPtr out = xmlOutputBufferCreateIO( - xmlWrite, NULL, _out, xmlGetCharEncodingHandler(XML_CHAR_ENCODING_UTF8)); - xmlSaveFileTo(out, doc->cobj(), NULL); - } - catch (const std::exception & e) { - FCGX_FPrintF(_out, "Content-type: text/plain\r\n\r\n"); - FCGX_FPrintF(_out, "Kaboom!\r\n\r\n"); - FCGX_FPrintF(_out, "%s\r\n\r\n", e.what()); - } - catch (...) { - FCGX_FPrintF(_out, "Content-type: text/plain\r\n\r\n"); - FCGX_FPrintF(_out, "Kaboom!\r\n\r\n"); - FCGX_FPrintF(_out, "Unknown exception.\r\n\r\n"); + while (FCGX_Accept(&in, &_out, &err, &envp) >= 0) + { + CgiReader reader(in, envp); + cgicc::Cgicc cgi(&reader); + try { + CgiEnvironment env(&cgi); + CgiApplicationEngine app(&env); + app.process(); + FCGX_FPrintF(_out, "Content-type: text/xml-xslt\r\n\r\n"); + xmlOutputBufferPtr out = xmlOutputBufferCreateIO( + xmlWrite, NULL, _out, xmlGetCharEncodingHandler(XML_CHAR_ENCODING_UTF8)); + app.write(boost::bind(xmlSaveFileTo, out, _1, "utf-8")); + } + catch (const std::exception & e) { + FCGX_FPrintF(_out, "Content-type: text/plain\r\n\r\n"); + FCGX_FPrintF(_out, "Kaboom!\r\n\r\n"); + FCGX_FPrintF(_out, "%s\r\n\r\n", e.what()); + } + catch (...) { + FCGX_FPrintF(_out, "Content-type: text/plain\r\n\r\n"); + FCGX_FPrintF(_out, "Kaboom!\r\n\r\n"); + FCGX_FPrintF(_out, "Unknown exception.\r\n\r\n"); + } } } -#else - EnvironmentProcessor ep(getenv); - ep.Initialise(); - boost::shared_ptr<xmlpp::Document> doc = ep.process(); - xmlDocDump(stdout, doc->cobj()); -#endif + else { + cgicc::Cgicc cgi(NULL); + CgiEnvironment env(&cgi); + CgiApplicationEngine app(&env); + app.process(); + //app.write(boost::bind(xmlDocDump, stdout, _1)); + } return 0; } diff --git a/project2/paramChecker.cpp b/project2/paramChecker.cpp new file mode 100644 index 0000000..697728a --- /dev/null +++ b/project2/paramChecker.cpp @@ -0,0 +1,28 @@ +#include "paramChecker.h" +#include "xmlObjectLoader.h" +#include <libxml++/nodes/textnode.h> +#include "regexCheck.h" +#include "sqlCheck.h" + +unsigned int _ParamChecker::loadOrder = 1; + +_ParamChecker::_ParamChecker(const xmlpp::Element * p) : + _Project2SourceObject(p), + message(xmlChildText(p, "message")), + applyTo(p->get_attribute_value("apply-to")), + present(p->get_attribute_value("present")), + order(loadOrder++) +{ +} + +_ParamChecker::~_ParamChecker() +{ +} + +void +_ParamChecker::AddLoaders(Loaders & l, OrderedParamCheckers & checks) +{ + l.insert(LoadersVT("regexcheck", _LoaderBase::Make<_RegexCheck, _ParamChecker, unsigned int, _ParamChecker, &_ParamChecker::order>(&checks))); + l.insert(LoadersVT("sqlcheck", _LoaderBase::Make<_SqlCheck, _ParamChecker, unsigned int, _ParamChecker, &_ParamChecker::order>(&checks))); +} + diff --git a/project2/paramChecker.h b/project2/paramChecker.h new file mode 100644 index 0000000..28c0275 --- /dev/null +++ b/project2/paramChecker.h @@ -0,0 +1,35 @@ +#ifndef PARAMCHECKER_H +#define PARAMCHECKER_H + +#include <libxml/tree.h> +#include <boost/shared_ptr.hpp> +#include <map> +#include "sourceObject.h" +#include "xmlObjectLoader.h" + +class ApplicationEngine; +class _ParamChecker; +typedef boost::shared_ptr<_ParamChecker> ParamChecker; +typedef std::map<std::string, ParamChecker> ParamCheckers; +typedef std::map<unsigned int, ParamChecker> OrderedParamCheckers; + +class _ParamChecker : public _Project2SourceObject { + public: + _ParamChecker(const xmlpp::Element * p); + virtual ~_ParamChecker(); + + virtual bool performCheck(const ApplicationEngine *) const = 0; + + const Glib::ustring message; + const std::string applyTo; + const std::string present; + const unsigned int order; + + static void AddLoaders(Loaders & l, OrderedParamCheckers & vs); + private: + static unsigned int loadOrder; +}; + +#endif + + diff --git a/project2/rdbmsDataSource.cpp b/project2/rdbmsDataSource.cpp index 5e6ad16..dad35a3 100644 --- a/project2/rdbmsDataSource.cpp +++ b/project2/rdbmsDataSource.cpp @@ -14,13 +14,34 @@ _RdbmsDataSource::getWritable() const if (!database) { database = boost::shared_ptr<ODBC::Connection>(new ODBC::Connection(masterDsn)); } + if (!database->inTx()) { + database->beginTx(); + } return *database; } ODBC::Connection & _RdbmsDataSource::getReadonly() const { - // For now :) - return getWritable(); + if (!database) { + database = boost::shared_ptr<ODBC::Connection>(new ODBC::Connection(masterDsn)); + } + return *database; +} + +void +_RdbmsDataSource::commit() +{ + if (database && database->inTx()) { + database->commitTx(); + } +} + +void +_RdbmsDataSource::rollback() +{ + if (database && database->inTx()) { + database->rollbackTx(); + } } diff --git a/project2/rdbmsDataSource.h b/project2/rdbmsDataSource.h index 622754e..ee75550 100644 --- a/project2/rdbmsDataSource.h +++ b/project2/rdbmsDataSource.h @@ -12,6 +12,8 @@ class _RdbmsDataSource : public _DataSource { _RdbmsDataSource(const xmlpp::Element * p); ODBC::Connection & getReadonly() const; ODBC::Connection & getWritable() const; + virtual void commit(); + virtual void rollback(); const std::string masterDsn; private: mutable boost::shared_ptr<ODBC::Connection> database; diff --git a/project2/regexCheck.cpp b/project2/regexCheck.cpp new file mode 100644 index 0000000..abe134c --- /dev/null +++ b/project2/regexCheck.cpp @@ -0,0 +1,22 @@ +#include "regexCheck.h" +#include "xmlObjectLoader.h" +#include "appEngine.h" +#include <boost/regex.hpp> + +_RegexCheck::_RegexCheck(const xmlpp::Element * p) : + _ParamChecker(p), + regex(xmlChildText(p, "regex").raw()) +{ +} + +_RegexCheck::~_RegexCheck() +{ +} + +bool +_RegexCheck::performCheck(const ApplicationEngine * ep) const +{ + const Glib::ustring & param = ep->env()->getParamQuery(applyTo); + return boost::regex_match(param.begin(), param.end(), regex); +} + diff --git a/project2/regexCheck.h b/project2/regexCheck.h new file mode 100644 index 0000000..5db92f5 --- /dev/null +++ b/project2/regexCheck.h @@ -0,0 +1,19 @@ +#ifndef REGEXCHECK_H +#define REGEXCHECK_H + +#include "paramChecker.h" +#include <boost/regex.hpp> + +class _RegexCheck : public _ParamChecker { + public: + _RegexCheck(const xmlpp::Element * p); + virtual ~_RegexCheck(); + + bool performCheck(const ApplicationEngine *) const; + + const boost::regex regex; +}; +typedef boost::shared_ptr<_RegexCheck> RegexCheck; +typedef std::map<std::string, RegexCheck> RegexChecks; + +#endif diff --git a/project2/sourceObject.cpp b/project2/sourceObject.cpp index fc57b91..9d10f52 100644 --- a/project2/sourceObject.cpp +++ b/project2/sourceObject.cpp @@ -1,7 +1,11 @@ #include "sourceObject.h" _Project2SourceObject::_Project2SourceObject(const xmlpp::Element * p) : - name(p->get_attribute_value("name").raw()) + name(p->get_attribute_value("name")) +{ +} + +_Project2SourceObject::~_Project2SourceObject() { } diff --git a/project2/sourceObject.h b/project2/sourceObject.h index fc010d9..421054d 100644 --- a/project2/sourceObject.h +++ b/project2/sourceObject.h @@ -2,11 +2,14 @@ #define SOURCEOBJECT_H #include <libxml++/nodes/element.h> +#include <boost/shared_ptr.hpp> class _Project2SourceObject { public: _Project2SourceObject(const xmlpp::Element * p); + virtual ~_Project2SourceObject() = 0; const std::string name; }; +typedef boost::shared_ptr<_Project2SourceObject> Project2SourceObject; #endif diff --git a/project2/sqlCheck.cpp b/project2/sqlCheck.cpp new file mode 100644 index 0000000..25094a6 --- /dev/null +++ b/project2/sqlCheck.cpp @@ -0,0 +1,60 @@ +#include "sqlCheck.h" +#include "xmlObjectLoader.h" +#include "appEngine.h" +#include "selectcommand.h" +#include "column.h" +#include "rdbmsDataSource.h" +#include <boost/regex.hpp> + +_SqlCheck::_SqlCheck(const xmlpp::Element * p) : + IHaveParameters(p), + _ParamChecker(p), + dataSource(p->get_attribute_value("datasource")), + sql(xmlChildText(p, "sql")), + testOp(p->get_attribute_value("testOp")), + testValue(atof(p->get_attribute_value("testValue").c_str())) +{ +} + +_SqlCheck::~_SqlCheck() +{ +} + +bool +_SqlCheck::performCheck(const ApplicationEngine * ep) const +{ + ODBC::SelectCommand * query = new ODBC::SelectCommand(ep->dataSource<_RdbmsDataSource>(dataSource)->getReadonly(), sql); + BOOST_FOREACH(Parameters::value_type p, parameters) { + if (p.second->source == "uri") { + query->bindParamS(p.second->bind, ep->env()->getParamUri(p.second->id)); + } + else if (p.second->source == "query") { + query->bindParamS(p.second->bind, ep->env()->getParamQuery(p.second->id)); + } + } + bool retVal = false; + while (query->fetch()) { + int val = (*query)[0]; + if ((testOp == "==" || testOp == "=") && val == testValue) { + retVal = true; + } + else if (testOp == "<" && val < testValue) { + retVal = true; + } + else if (testOp == ">" && val > testValue) { + retVal = true; + } + else if (testOp == "!=" && val != testValue) { + retVal = true; + } + else if ((testOp == "<=" || testOp == "=<") && val <= testValue) { + retVal = true; + } + else if ((testOp == ">=" || testOp == "=>") && val >= testValue) { + retVal = true; + } + } + delete query; + return retVal; +} + diff --git a/project2/sqlCheck.h b/project2/sqlCheck.h new file mode 100644 index 0000000..a5a5ae0 --- /dev/null +++ b/project2/sqlCheck.h @@ -0,0 +1,22 @@ +#ifndef SQLCHECK_H +#define SQLCHECK_H + +#include "paramChecker.h" +#include "iHaveParameters.h" + +class _SqlCheck : public IHaveParameters, public _ParamChecker { + public: + _SqlCheck(const xmlpp::Element * p); + virtual ~_SqlCheck(); + + bool performCheck(const ApplicationEngine *) const; + + const std::string dataSource; + const Glib::ustring sql; + const std::string testOp; + const double testValue; +}; +typedef boost::shared_ptr<_SqlCheck> SqlCheck; +typedef std::map<std::string, SqlCheck> SqlChecks; + +#endif diff --git a/project2/sqlTask.cpp b/project2/sqlTask.cpp new file mode 100644 index 0000000..2832f73 --- /dev/null +++ b/project2/sqlTask.cpp @@ -0,0 +1,44 @@ +#include "sqlTask.h" +#include <boost/foreach.hpp> +#include "xmlObjectLoader.h" +#include "modifycommand.h" +#include "appEngine.h" +#include "rdbmsDataSource.h" +#include "sqlView.h" + +_SqlTask::_SqlTask(const xmlpp::Element * p) : + _Task(p), + IHaveParameters(p), + dataSource(p->get_attribute_value("datasource")), + sql(xmlChildText(p, "sql")) +{ +} + +_SqlTask::~_SqlTask() +{ +} + +void +_SqlTask::execute(const ApplicationEngine * ep, const _View * parent) const +{ + ODBC::ModifyCommand modify(ep->dataSource<_RdbmsDataSource>(dataSource)->getWritable(), sql); + BOOST_FOREACH(Parameters::value_type p, parameters) { + if (p.second->source == "uri") { + modify.bindParamS(p.second->bind, ep->env()->getParamUri(p.second->id)); + } + else if (p.second->source == "modify") { + modify.bindParamS(p.second->bind, ep->env()->getParamQuery(p.second->id)); + } + else if (parent && p.second->source == "parent") { + const _SqlView * psqlview = dynamic_cast<const _SqlView *>(parent); + if (psqlview) { + psqlview->rebindCurrentValue(p.second->id, &modify, p.second->bind); + } + else { + modify.bindParamS(p.second->bind, parent->getCurrentValue(p.second->id)); + } + } + } + modify.execute(); +} + diff --git a/project2/sqlTask.h b/project2/sqlTask.h new file mode 100644 index 0000000..75333e3 --- /dev/null +++ b/project2/sqlTask.h @@ -0,0 +1,28 @@ +#ifndef SQLTASK_H +#define SQLTASK_H + +#include <libxml++/nodes/element.h> +#include <boost/shared_ptr.hpp> +#include <map> +#include "task.h" +#include "iHaveParameters.h" + +class ApplicationEngine; +class _View; + +class _SqlTask : public _Task, public IHaveParameters { + public: + _SqlTask(const xmlpp::Element * p); + virtual ~_SqlTask(); + virtual void execute(const ApplicationEngine *, const _View * parent = NULL) const; + + const std::string dataSource; + const std::string sql; + protected: +}; +typedef boost::shared_ptr<_SqlTask> SqlTask; +typedef std::map<std::string, SqlTask> SqlTasks; + +#endif + + diff --git a/project2/sqlView.cpp b/project2/sqlView.cpp index 928482f..1fe0a0d 100644 --- a/project2/sqlView.cpp +++ b/project2/sqlView.cpp @@ -5,22 +5,19 @@ #include <string.h> #include <libxml++/nodes/textnode.h> #include "xmlObjectLoader.h" -#include "envproc.h" -#include <boost/bind.hpp> +#include "environment.h" +#include "appEngine.h" _SqlView::_SqlView(const xmlpp::Element * p) : + IHaveParameters(p), _View(p), + dataSource(p->get_attribute_value("datasource")), sql(xmlChildText(p, "sql")), query(NULL) { - collectAll<_SqlView>(subViews, p, "sqlview", &_Project2SourceObject::name, true, true); -} - -_SqlView::_Parameter::_Parameter(const xmlpp::Element * p) : - source(p->get_attribute_value("source")), - id(p->get_attribute_value("id")), - bind(atoi(p->get_attribute_value("bind").c_str())) -{ + Loaders loaders; + _View::AddLoaders(loaders, subViews); + _LoaderBase::collectAll(loaders, "project2", p, true, true); } Glib::ustring @@ -35,16 +32,16 @@ _SqlView::rebindCurrentValue(const Glib::ustring & id, ODBC::Command * cmd, unsi (*query)[id].rebind(cmd, bind); } -void _SqlView::execute(xmlpp::Element * par, const EnvironmentProcessor * ep, const _View * parent) const +void _SqlView::execute(xmlpp::Element * par, const ApplicationEngine * ep, const _View * parent) const { typedef std::map<std::string, xmlpp::Element *> Columns; query = new ODBC::SelectCommand(ep->dataSource<_RdbmsDataSource>(dataSource)->getReadonly(), sql); BOOST_FOREACH(Parameters::value_type p, parameters) { if (p.second->source == "uri") { - query->bindParamS(p.second->bind, ep->getParamUri(p.second->id)); + query->bindParamS(p.second->bind, ep->env()->getParamUri(p.second->id)); } else if (p.second->source == "query") { - query->bindParamS(p.second->bind, ep->getParamQuery(p.second->id)); + query->bindParamS(p.second->bind, ep->env()->getParamQuery(p.second->id)); } else if (parent && p.second->source == "parent") { const _SqlView * psqlview = dynamic_cast<const _SqlView *>(parent); diff --git a/project2/sqlView.h b/project2/sqlView.h index d8efa0f..1a77e7d 100644 --- a/project2/sqlView.h +++ b/project2/sqlView.h @@ -7,22 +7,23 @@ #include "selectcommand.h" #include "view.h" #include "rdbmsDataSource.h" +#include "iHaveParameters.h" -class EnvironmentProcessor; -class _SqlView; -typedef boost::shared_ptr<_SqlView> SqlView; -typedef std::map<std::string, SqlView> SqlViews; +class ApplicationEngine; -class _SqlView : public _View { +class _SqlView : public IHaveParameters, public _View { public: _SqlView(const xmlpp::Element * p); - void execute(xmlpp::Element *, const EnvironmentProcessor *, const _View * parent = NULL) const; + void execute(xmlpp::Element *, const ApplicationEngine *, const _View * parent = NULL) const; Glib::ustring getCurrentValue(const Glib::ustring & id) const; + const std::string dataSource; const Glib::ustring sql; + void rebindCurrentValue(const Glib::ustring & id, ODBC::Command *, unsigned int) const; private: mutable ODBC::SelectCommand * query; - void rebindCurrentValue(const Glib::ustring & id, ODBC::Command *, unsigned int) const; }; +typedef boost::shared_ptr<_SqlView> SqlView; +typedef std::map<std::string, SqlView> SqlViews; #endif diff --git a/project2/task.cpp b/project2/task.cpp new file mode 100644 index 0000000..9800b78 --- /dev/null +++ b/project2/task.cpp @@ -0,0 +1,23 @@ +#include "task.h" +#include <boost/foreach.hpp> +#include "xmlObjectLoader.h" +#include "sqlTask.h" + +unsigned int _Task::loadOrder = 1; + +_Task::_Task(const xmlpp::Element * p) : + _Project2SourceObject(p), + order(loadOrder++) +{ +} + +_Task::~_Task() +{ +} + +void +_Task::AddLoaders(Loaders & l, OrderedTasks & tasks) +{ + l.insert(LoadersVT("sqltask", _LoaderBase::Make<_SqlTask, _Task, unsigned int, _Task, &_Task::order>(&tasks))); +} + diff --git a/project2/task.h b/project2/task.h new file mode 100644 index 0000000..00fce4b --- /dev/null +++ b/project2/task.h @@ -0,0 +1,31 @@ +#ifndef TASK_H +#define TASK_H + +#include <libxml++/nodes/element.h> +#include <boost/shared_ptr.hpp> +#include <map> +#include "sourceObject.h" +#include "xmlObjectLoader.h" +#include "view.h" + +class ApplicationEngine; +class _Task; +typedef boost::shared_ptr<_Task> Task; +typedef std::map<std::string, Task> Tasks; +typedef std::map<unsigned int, Task> OrderedTasks; + +class _Task : public _Project2SourceObject { + public: + _Task(const xmlpp::Element * p); + virtual ~_Task(); + virtual void execute(const ApplicationEngine *, const _View * parent = NULL) const = 0; + const unsigned int order; + + static void AddLoaders(Loaders & l, OrderedTasks & vs); + private: + static unsigned int loadOrder; +}; + +#endif + + diff --git a/project2/view.cpp b/project2/view.cpp index e674af8..31596d5 100644 --- a/project2/view.cpp +++ b/project2/view.cpp @@ -1,19 +1,21 @@ #include "view.h" #include <boost/foreach.hpp> #include "xmlObjectLoader.h" +#include "sqlView.h" _View::_View(const xmlpp::Element * p) : _Project2SourceObject(p), - dataSource(p->get_attribute_value("datasource")), recordName(p->get_attribute_value("recordname")) { - xmlpp::NodeSet ps = p->find("parameters"); - BOOST_FOREACH(xmlpp::Node * psi, ps) { - collectAll<_Parameter>(parameters, dynamic_cast<xmlpp::Element *>(psi), "param", &_Parameter::bind, true, true); - } } _View::~_View() { } +void +_View::AddLoaders(Loaders & l, Views & views) +{ + l.insert(LoadersVT("sqlview", _LoaderBase::Make<_SqlView, _View, std::string, _Project2SourceObject, &_Project2SourceObject::name>(&views))); +} + diff --git a/project2/view.h b/project2/view.h index 281f9d2..43f2792 100644 --- a/project2/view.h +++ b/project2/view.h @@ -3,35 +3,25 @@ #include <libxml++/nodes/element.h> #include <boost/shared_ptr.hpp> -#include <boost/any.hpp> #include <map> #include "sourceObject.h" +#include "xmlObjectLoader.h" -class EnvironmentProcessor; +class ApplicationEngine; class _View; typedef boost::shared_ptr<_View> View; typedef std::map<std::string, View> Views; class _View : public _Project2SourceObject { public: - class _Parameter { - public: - _Parameter(const xmlpp::Element * p); - const std::string source; - const std::string id; - const unsigned int bind; - }; - typedef boost::shared_ptr<_Parameter> Parameter; - typedef std::map<unsigned int, Parameter> Parameters; - _View(const xmlpp::Element * p); virtual ~_View(); - virtual void execute(xmlpp::Element *, const EnvironmentProcessor *, const _View * parent = NULL) const = 0; + virtual void execute(xmlpp::Element *, const ApplicationEngine *, const _View * parent = NULL) const = 0; virtual Glib::ustring getCurrentValue(const Glib::ustring & id) const = 0; - const Glib::ustring dataSource; const Glib::ustring recordName; + + static void AddLoaders(Loaders & l, Views & vs); protected: - Parameters parameters; Views subViews; }; diff --git a/project2/xmlObjectLoader.cpp b/project2/xmlObjectLoader.cpp new file mode 100644 index 0000000..1eb85f9 --- /dev/null +++ b/project2/xmlObjectLoader.cpp @@ -0,0 +1,32 @@ +#include "xmlObjectLoader.h" + +_LoaderBase::_LoaderBase() +{ +} +_LoaderBase::~_LoaderBase() +{ +} + +void +_LoaderBase::collectAll(const Loaders & ls, const Glib::ustring & ns, const xmlpp::Element * node, bool recursive, bool childrenOnly) +{ + if (!node) { + return; + } + if (!childrenOnly && ns == node->get_namespace_prefix()) { + Glib::ustring name = node->get_name(); + unsigned int created = 0; + for(Loaders::const_iterator i = ls.lower_bound(name); i != ls.upper_bound(name); i++) { + i->second->go(node); + created += 1; + } + if (created < 1) { + fprintf(stderr, "Didn't create any objects for %s:%s\n", ns.c_str(), name.c_str()); + } + } + else if (recursive || childrenOnly) { + BOOST_FOREACH(xmlpp::Node * child, node->get_children()) { + collectAll(ls, ns, dynamic_cast<const xmlpp::Element *>(child), recursive, false); + } + } +} diff --git a/project2/xmlObjectLoader.h b/project2/xmlObjectLoader.h index 6664018..59c4f1c 100644 --- a/project2/xmlObjectLoader.h +++ b/project2/xmlObjectLoader.h @@ -7,33 +7,64 @@ #include <libxml++/nodes/element.h> #include <boost/shared_ptr.hpp> #include <boost/foreach.hpp> +#include <boost/bind.hpp> +#include <libxml++/nodes/textnode.h> #define xmlChildText(p, t) dynamic_cast<const xmlpp::Element&>(*p->get_children(t).front()).get_child_text()->get_content() -template <class ObjectType, class ContainerType, class IDType, class ObjectBase> -void -collectAll(std::map<IDType, ContainerType> & objs, const xmlpp::Element * node, const Glib::ustring & name, - const IDType ObjectBase::*id, bool childrenOnly, bool recursive) -{ - if (!node) { - return; - } - if (!childrenOnly && name == node->get_name()) { - try { - ContainerType c = ContainerType(new ObjectType(node)); - objs[(*c).*id] = c; - } - catch (const std::exception & e) { - // Assume the XML node is not what we thought it was + +class _LoaderBase; +template <class T, class IT, class Key> +class _Loader; +typedef boost::shared_ptr<_LoaderBase> Loader; +typedef std::multimap<std::string, Loader> Loaders; + +class _LoaderBase { + public: + _LoaderBase(); + virtual ~_LoaderBase() = 0; + virtual void go(const xmlpp::Element * e) const = 0; + + template <class T, typename KeyT, class IdT, const KeyT IdT::*Var> + static + void + storeByX(std::map<KeyT, boost::shared_ptr<T> > * m, boost::shared_ptr<T> o) + { + if (o) { + (*m)[o.get()->*Var] = o; + } } - catch (...) { - // Assume the XML node is not what we thought it was + template <class CT, class BaseT, class KeyT, class IdT, const KeyT IdT::*Var> + static + Loader Make(std::map<KeyT, boost::shared_ptr<BaseT> > * m); + static void collectAll(const Loaders & ls, const Glib::ustring & ns, const xmlpp::Element * node, bool recursive, bool childrenOnly); +}; + +template <class T, class IT, class Key> +class _Loader : public _LoaderBase { + public: + typedef boost::shared_ptr<T> ptr; + typedef std::map<Key, ptr> ptrmap; + typedef void (*S)(ptrmap *, ptr); + + _Loader(S s, ptrmap * m) : _LoaderBase(), storer(s), map(m) + { } - } - else if (recursive || childrenOnly) { - BOOST_FOREACH(xmlpp::Node * child, node->get_children()) { - collectAll<ObjectType, ContainerType>(objs, dynamic_cast<const xmlpp::Element *>(child), name, id, false, recursive); + + void go(const xmlpp::Element * e) const + { + storer(map, ptr(new IT(e))); } - } + const S storer; + ptrmap * map; +}; +typedef Loaders::value_type LoadersVT; + + +template <class CT, class BaseT, class KeyT, class IdT, const KeyT IdT::*Var> +Loader +_LoaderBase::Make(std::map<KeyT, boost::shared_ptr<BaseT> > * m) +{ + return Loader(new _Loader<BaseT, CT, KeyT>(&storeByX<BaseT, KeyT, IdT, Var>, m)); } #endif |