From 8bff62c335842b4c850cc09716e79c2f556247c7 Mon Sep 17 00:00:00 2001 From: Wolf Bergenheim Date: Tue, 2 Feb 2010 15:51:41 +0200 Subject: directory structure changes --- Doxyfile | 1542 -------------------- Makefile | 26 - include/resource-set.h | 206 --- include/resource.h | 80 - include/resources.h | 169 --- libresourceqt.pro | 31 - libresourceqt/Doxyfile | 1542 ++++++++++++++++++++ libresourceqt/include/resource-set.h | 206 +++ libresourceqt/include/resource.h | 80 + libresourceqt/include/resources.h | 169 +++ libresourceqt/libresourceqt.pro | 30 + libresourceqt/src/resource-engine.cpp | 197 +++ libresourceqt/src/resource-engine.h | 55 + libresourceqt/src/resource-factory.cpp | 31 + libresourceqt/src/resource-set.cpp | 111 ++ libresourceqt/src/resource.cpp | 57 + libresourceqt/src/resources.cpp | 347 +++++ src/resource-engine.cpp | 197 --- src/resource-engine.h | 55 - src/resource-factory.cpp | 31 - src/resource-set.cpp | 111 -- src/resource.cpp | 57 - src/resources.cpp | 347 ----- tests/Makefile | 21 - .../test-resource-engine/test-resource-engine.cpp | 62 + tests/test-resource-engine/test-resource-engine.h | 32 + .../test-resource-engine/test-resource-engine.pro | 29 + tests/test-resource-set.cpp | 172 --- tests/test-resource-set.h | 50 - tests/test-resource-set.pro | 21 - tests/test-resource-set/test-resource-set.cpp | 172 +++ tests/test-resource-set/test-resource-set.h | 50 + tests/test-resource-set/test-resource-set.pro | 21 + tests/test-resource.cpp | 281 ---- tests/test-resource.h | 54 - tests/test-resource.pro | 21 - tests/test-resource/test-resource.cpp | 281 ++++ tests/test-resource/test-resource.h | 54 + tests/test-resource/test-resource.pro | 21 + 39 files changed, 3547 insertions(+), 3472 deletions(-) delete mode 100644 Doxyfile delete mode 100644 Makefile delete mode 100644 include/resource-set.h delete mode 100644 include/resource.h delete mode 100644 include/resources.h delete mode 100644 libresourceqt.pro create mode 100644 libresourceqt/Doxyfile create mode 100644 libresourceqt/include/resource-set.h create mode 100644 libresourceqt/include/resource.h create mode 100644 libresourceqt/include/resources.h create mode 100644 libresourceqt/libresourceqt.pro create mode 100644 libresourceqt/src/resource-engine.cpp create mode 100644 libresourceqt/src/resource-engine.h create mode 100644 libresourceqt/src/resource-factory.cpp create mode 100644 libresourceqt/src/resource-set.cpp create mode 100644 libresourceqt/src/resource.cpp create mode 100644 libresourceqt/src/resources.cpp delete mode 100644 src/resource-engine.cpp delete mode 100644 src/resource-engine.h delete mode 100644 src/resource-factory.cpp delete mode 100644 src/resource-set.cpp delete mode 100644 src/resource.cpp delete mode 100644 src/resources.cpp delete mode 100644 tests/Makefile create mode 100644 tests/test-resource-engine/test-resource-engine.cpp create mode 100644 tests/test-resource-engine/test-resource-engine.h create mode 100644 tests/test-resource-engine/test-resource-engine.pro delete mode 100644 tests/test-resource-set.cpp delete mode 100644 tests/test-resource-set.h delete mode 100644 tests/test-resource-set.pro create mode 100644 tests/test-resource-set/test-resource-set.cpp create mode 100644 tests/test-resource-set/test-resource-set.h create mode 100644 tests/test-resource-set/test-resource-set.pro delete mode 100644 tests/test-resource.cpp delete mode 100644 tests/test-resource.h delete mode 100644 tests/test-resource.pro create mode 100644 tests/test-resource/test-resource.cpp create mode 100644 tests/test-resource/test-resource.h create mode 100644 tests/test-resource/test-resource.pro diff --git a/Doxyfile b/Doxyfile deleted file mode 100644 index d41c553..0000000 --- a/Doxyfile +++ /dev/null @@ -1,1542 +0,0 @@ -# Doxyfile 1.5.8 - -# 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 = ResourcePolicy - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = 0.1 - -# 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, 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, and Ukrainian. - -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 = YES - -# 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 = 4 - -# 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 - -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 = YES - -# 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 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_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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name -# of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# 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 = include/resource.h \ - include/resource-set.h - -# 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 , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, 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_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 = YES - -# 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 = ../libresourceqt.qch - -# 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 = libresourceqt - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see -# Qt Help Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. -# Qt Help Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = /usr/bin/qhelpgenerator - -# 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 = 1 - -# 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 FRAME, 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 (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE -# respectively. - -GENERATE_TREEVIEW = HIERARCHIES - -# 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 - -#--------------------------------------------------------------------------- -# 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. - -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 - -#--------------------------------------------------------------------------- -# 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 = YES - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. 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 = YES - -# 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 = NO - -# 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 = YES - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = YES - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = YES - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will 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 - -#--------------------------------------------------------------------------- -# Options related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO diff --git a/Makefile b/Makefile deleted file mode 100644 index 387abfa..0000000 --- a/Makefile +++ /dev/null @@ -1,26 +0,0 @@ -QMAKE = qmake -MAKEFILE = libresourceqt.make -LIB = build/libresourceqt.so.1.0.0 - -%.make: %.pro - $(QMAKE) -o $@ $< - -all: $(MAKEFILE) - $(MAKE) -f $(MAKEFILE) all - $(MAKE) -C tests all - -clean: - $(RM) $(MAKEFILE) - $(RM) -r build - $(MAKE) -C tests clean - -install: $(MAKEFILE) - $(MAKE) -f $(MAKEFILE) install - $(MAKE) -C tests install - -tests: force - $(MAKE) -C tests tests - -force: ; - -.phony: clean all install tests diff --git a/include/resource-set.h b/include/resource-set.h deleted file mode 100644 index 1f515ee..0000000 --- a/include/resource-set.h +++ /dev/null @@ -1,206 +0,0 @@ -#ifndef RESOURCE_SET_H -#define RESOURCE_SET_H - -#include "resources.h" -#include -#include -#include -#include - -/** - * \mainpage Resource Policy Library - * - * \section intro_section Introduction - * - * This library is used to request resources from the Polict Resource Manager. - * To use this library two classes are provided: \ref ResourcePolicy::Resource and - * \ref ResourcePolicy::ResourceSet. - * - * \section library_use_section Library Usage - * - * To use the Resource Policy Library, you first need to create a set of - * \ref Resource objects like this (given as an example of what a media player - * might want/need): - * \code - * ResourcePolicy::AudioResource *audioResource = new ResourcePolicy::AudioResource(); - * ResourcePolicy::VideoResource *audioResource = new ResourcePolicy::AudioResource(); - * videoResource->setOptional(); - * \endcode - * Then you need to create a \ref ResourcePolicy::ResourceSet like this: - * \code - * ResourcePolicy::ResourceSet *resources = new ResourcePolicy::ResourceSet("player"); - * resources->addResource(audioResource); - * resources->addResource(videoResource); - * resources->initialize(); - * QObject::connect(resources, SIGNAL(connectedToManager), this, SLOT(connectedHandler())); - * resources->connectToManager(); - * \endcode - * Then the when you want to acquire the \ref ResourcePolicy::ResourceSet you simply use the - * \ref acquire() method of the \ref ResourceSet object, like this: - * \code - * QObject::connect(resources, SIGNAL(resourcesAcquired), - * this, SLOT(acquireOkHandler(QList))); - * QObject::connect(resources, SIGNAL(resourcesDenied), this, SLOT(acquireDeniedHandler())); - * resources->acquire(); - * \endcode - */ - -/** - * The Namespace for Resource Policy. - */ -namespace ResourcePolicy -{ - /** - * The resourceSet repesents a set of attributes. Each set can only contain - * a single Resource of a given type. That is one AudioPlaybackResource, etc. - * - * Internally the set is stored as a QVector of \ref Resource objects. - */ - class ResourceSet: public QObject - { - Q_OBJECT - Q_DISABLE_COPY( ResourceSet ) - public: - /** - * The constructor. - * \param applicationClass This parameter defines the application class. - * The application class is used to determine the priority order of the - * application. - * \param parent The optional parent of of this class. - */ - ResourceSet(const QString &applicationClass, QObject *parent=NULL); - /** - * The destructor - */ - ~ResourceSet(); - /** - * Initializes the underlaying communications library. - * \return true if initialization is successful. - */ - bool initialize(); - - /** - * This method adds a resource to the set. A set contains only a single - * instance of a given resource. If the ResourceSet already contains a - * resource of the given type it will be overridden. - * \param resource The resource to add to the set. A copy of this object - * is stored in the Set. - */ - void addResource(const Resource *resource); - /** - * This method adds all resources in the list to the set. - * A set contains only a single instance of a given resource. If the - * ResourceSet already contains a resource of the given type it will be - * overridden. - * \param resources The list of resources to add to the set. These will - * be copied. - */ - void addResources(const QListresources); - /** - * This method removes the resource of the given type - * \param type The type of the resource to remove from the set. - */ - void delResource(ResourceType type); - - /** - * This method returns a list of all resource in the set. - * \return a QList of all resources in the set. - */ - QList resources(); - /** - * This method returns a const pointer to a resource of a specific type. - * \type The type of resource we are interested in. - * \return a pointer to the Resource if it is defined NULL otherwise. - */ - Resource * resource(ResourceType type) const; - /** - * Checks if the \ref ResourceSet contains the given \ref Resource - * \param type The Resource to look for - * \return true if the \ref Resource is defined in this \ref ResourceSet - */ - bool contains(ResourceType type) const; - - /** - * Checks if the \ref ResourceSet contains all given resources. - * \param types A list of resources to check for - * \return true if \b all given resources are defined in the ResourceSet. - */ - bool contains(const QList &types) const; - - quint32 id() const; - - /** - * Connects to the Resource Policy Manager. The connected() signal is sent - * when the connection has been established. Acquiring the ResourceSet can - * be attempted at any time after this, but not before. - * \return true if the connection request was successfully sent. - * \param reconnectOnDisconnect. Set to true to automatically reconnect on - * lost connection to the Policy Resource Manager. This optional parameter - * defaults to true. - */ - bool connectToManager(bool reconnectOnDisconnect); - /** - * Disconnects from the Resource Policy Manager. Further attempts at acquiring - * the \ref ResourceSet will fail. - */ - void disconnectFromManager(); - /** - * Checks whether the ResourceSet is connected or not. - */ - bool isConnectedToManager(); - /** - * Attempt to acquire the ResourceSet. The response is returned as the - * resourcesAcquired() signal. - */ - bool acquire(); - /** - * Release the acquired resources. - */ - bool release(); - /** - * Commit changes to the \ref ResourceSet to the Manager. - */ - bool update(); - - signals: - /** - * This signal is emited when the Resource Policy Manager notifies that - * the given resources have become available. - * \param availableResources A list of available resources. - */ - void resourcesBecameAvailable(QList availableResources); - /** - * This signal is emited as a response to the acquire() request. - * \param grantedResources The list of granted optional resources. - */ - void resourcesGranted(QList grantedOptionalResources); - /** - * This signal is emited as a response to the acquire() request, in the - * case where we are not granted any requests. - */ - void resourcesDenied(); - /** - * This signal is emited when some other program with a higher priority - * superseeds us, and as a result we loose our resources. - */ - void lostResources(); - /** - * This signal is emited when we have successfully connected to the manager. - */ - void connectedToManager(); - /** - * This signal is emited when we loose the connection to the manager. - * A reconnect is automatically attempted. - */ - void disconnectedFromManager(); - - - private: - quint32 identifier; - const QString applicationClass; - Resource* resourceSet[NumberOfTypes]; - }; -} - -#endif - diff --git a/include/resource.h b/include/resource.h deleted file mode 100644 index 13265d5..0000000 --- a/include/resource.h +++ /dev/null @@ -1,80 +0,0 @@ -#ifndef RESOURCE_H -#define RESOURCE_H - -#include - -namespace ResourcePolicy { - enum ResourceType { - AudioPlaybackType = 0, - VideoPlaybackType, - AudioRecorderType, - VideoRecorderType, - VibraType, - LedsType, - BacklightType, - SystemButtonType, - LockButtonType, - ScaleButtonType, - SnapButtonType, - LensCoverType, - NumberOfTypes - }; - - /** - * This class is the super class for all resources. It represents a generic - * \ref Resource. The type specific resource classes should be used. - */ - class Resource - { - public: - /** - * Whether or not this resource is optional, in that it doesn't need to - * be available for the set to be acquired. - * \return true when this resource is optional. - */ - bool isOptional() const; - /** - * Set the resource to be optional or mandatory. - * \param resourceIsOptional This optional parameter defaults to true. - * The default, true, results in the resource becoming optional. When it - * is set to false the resource becomes mandatory. - */ - void setOptional(bool resourceIsOptional=true); - /** - * Whether or not the resource to be shared. If it is shared then other - * programs are allowed to share this resource. - * \return true when this resource is shared. - */ - bool isShared() const; - /** - * Sets the resource to be shared/private. - * \param resourceIsShared This optional parameter defaults to true. - * When it is set to true (de default) the resource is shared with - * other programs. Setting it to false makes this resource exclusive. - */ - void setShared(bool resourceIsShared=true); - /** - * Whether or not this resource has been granted. - * \return true if this resource has been granted. - */ - bool isGranted() const; - void setGranted(); - void unsetGranted(); - - virtual ResourceType type() const = 0; - virtual Resource * clone() const = 0; - virtual ~Resource(); - protected: - Resource(); - Resource(const Resource &other); - - ResourceType resourceType; - bool optional; - bool shared; - quint32 identifier; - bool granted; - }; -} - -#endif - diff --git a/include/resources.h b/include/resources.h deleted file mode 100644 index 8e3da70..0000000 --- a/include/resources.h +++ /dev/null @@ -1,169 +0,0 @@ -#ifndef RESOURCES_H -#define RESOURCES_H - -#include "resource.h" -#include -#include - -namespace ResourcePolicy { - - class AudioResource: public Resource - { - public: - AudioResource(const QString &audioGroup=QString()); - AudioResource(const AudioResource &other); - virtual ~AudioResource(); - - QString audioGroup() const; - void setAudioGroup(const QString & newGroup); - - quint32 processID() const; - void setProcessID(quint32 newPID); - - QString streamTag() const; - void setStreamTag(const QString & newStreamTag); - - virtual ResourceType type() const; - virtual Resource * clone() const; - private: - QString group; - quint32 pid; - QString stream; - }; - - class AudioRecorderResource: public Resource - { - public: - AudioRecorderResource(const QString & audioGroup=QString()); - AudioRecorderResource(const AudioRecorderResource &other); - virtual ~AudioRecorderResource(); - - QString audioGroup() const; - void setAudioGroup(const QString & newGroup); - - quint32 processID() const; - void setProcessID(quint32 newPID); - - QString streamTag() const; - void setStreamTag(const QString & newStreamTag); - - virtual ResourceType type() const; - virtual Resource * clone() const; - private: - QString group; - quint32 pid; - QString stream; - }; - - class BacklightResource: public Resource - { - public: - BacklightResource(); - BacklightResource(const BacklightResource &other); - virtual ~BacklightResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class LedsResource: public Resource - { - public: - LedsResource(); - LedsResource(const LedsResource &other); - virtual ~LedsResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class VibraResource: public Resource - { - public: - VibraResource(); - VibraResource(const VibraResource &other); - virtual ~VibraResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class VideoRecorderResource: public Resource - { - public: - VideoRecorderResource(); - VideoRecorderResource(const VideoRecorderResource &other); - virtual ~VideoRecorderResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class VideoResource: public Resource - { - public: - VideoResource(); - VideoResource(const VideoResource &other); - virtual ~VideoResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class SystemButtonResource: public Resource - { - public: - SystemButtonResource(); - SystemButtonResource(const SystemButtonResource &other); - virtual ~SystemButtonResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class LockButtonResource: public Resource - { - public: - LockButtonResource(); - LockButtonResource(const LockButtonResource &other); - virtual ~LockButtonResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class ScaleButtonResource: public Resource - { - public: - ScaleButtonResource(); - ScaleButtonResource(const ScaleButtonResource &other); - virtual ~ScaleButtonResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class SnapButtonResource: public Resource - { - public: - SnapButtonResource(); - SnapButtonResource(const SnapButtonResource &other); - virtual ~SnapButtonResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; - - class LensCoverResource: public Resource - { - public: - LensCoverResource(); - LensCoverResource(const LensCoverResource &other); - virtual ~LensCoverResource(); - - virtual ResourceType type() const; - virtual Resource * clone() const; - }; -} -#endif - diff --git a/libresourceqt.pro b/libresourceqt.pro deleted file mode 100644 index bf4f4dc..0000000 --- a/libresourceqt.pro +++ /dev/null @@ -1,31 +0,0 @@ -TEMPLATE = lib -VERSION = 1.0.0 -TARGET = resourceqt -DESTDIR = build -DEPENDPATH += include src -INCLUDEPATH += src include ../libresource/src - -# Input -PUBLIC_HEADERS = include/resource.h include/resource-set.h include/resources.h - -HEADERS += $$PUBLIC_HEADERS - -SOURCES += src/resource.cpp \ - src/resource-set.cpp \ - src/resources.cpp - -OBJECTS_DIR = build -MOC_DIR = build - -CONFIG += qt link_pkgconfig dll -QT = core -PKGCONFIG += dbus-1 - -# Install directives -headers.files = $$PUBLIC_HEADERS -INSTALLBASE = /usr -target.path = $$INSTALLBASE/lib -headers.path = $$INSTALLBASE/include/resource/qt4 - -INSTALLS = target headers - diff --git a/libresourceqt/Doxyfile b/libresourceqt/Doxyfile new file mode 100644 index 0000000..d41c553 --- /dev/null +++ b/libresourceqt/Doxyfile @@ -0,0 +1,1542 @@ +# Doxyfile 1.5.8 + +# 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 = ResourcePolicy + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 0.1 + +# 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, 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, and Ukrainian. + +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 = YES + +# 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 = 4 + +# 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 + +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 = YES + +# 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 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_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 , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# 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 = include/resource.h \ + include/resource-set.h + +# 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 , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, 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_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 = YES + +# 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 = ../libresourceqt.qch + +# 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 = libresourceqt + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = /usr/bin/qhelpgenerator + +# 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 = 1 + +# 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 FRAME, 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = HIERARCHIES + +# 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 + +#--------------------------------------------------------------------------- +# 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. + +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 + +#--------------------------------------------------------------------------- +# 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 = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. 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 = YES + +# 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 = NO + +# 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 = YES + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = YES + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will 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 + +#--------------------------------------------------------------------------- +# Options related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/libresourceqt/include/resource-set.h b/libresourceqt/include/resource-set.h new file mode 100644 index 0000000..1f515ee --- /dev/null +++ b/libresourceqt/include/resource-set.h @@ -0,0 +1,206 @@ +#ifndef RESOURCE_SET_H +#define RESOURCE_SET_H + +#include "resources.h" +#include +#include +#include +#include + +/** + * \mainpage Resource Policy Library + * + * \section intro_section Introduction + * + * This library is used to request resources from the Polict Resource Manager. + * To use this library two classes are provided: \ref ResourcePolicy::Resource and + * \ref ResourcePolicy::ResourceSet. + * + * \section library_use_section Library Usage + * + * To use the Resource Policy Library, you first need to create a set of + * \ref Resource objects like this (given as an example of what a media player + * might want/need): + * \code + * ResourcePolicy::AudioResource *audioResource = new ResourcePolicy::AudioResource(); + * ResourcePolicy::VideoResource *audioResource = new ResourcePolicy::AudioResource(); + * videoResource->setOptional(); + * \endcode + * Then you need to create a \ref ResourcePolicy::ResourceSet like this: + * \code + * ResourcePolicy::ResourceSet *resources = new ResourcePolicy::ResourceSet("player"); + * resources->addResource(audioResource); + * resources->addResource(videoResource); + * resources->initialize(); + * QObject::connect(resources, SIGNAL(connectedToManager), this, SLOT(connectedHandler())); + * resources->connectToManager(); + * \endcode + * Then the when you want to acquire the \ref ResourcePolicy::ResourceSet you simply use the + * \ref acquire() method of the \ref ResourceSet object, like this: + * \code + * QObject::connect(resources, SIGNAL(resourcesAcquired), + * this, SLOT(acquireOkHandler(QList))); + * QObject::connect(resources, SIGNAL(resourcesDenied), this, SLOT(acquireDeniedHandler())); + * resources->acquire(); + * \endcode + */ + +/** + * The Namespace for Resource Policy. + */ +namespace ResourcePolicy +{ + /** + * The resourceSet repesents a set of attributes. Each set can only contain + * a single Resource of a given type. That is one AudioPlaybackResource, etc. + * + * Internally the set is stored as a QVector of \ref Resource objects. + */ + class ResourceSet: public QObject + { + Q_OBJECT + Q_DISABLE_COPY( ResourceSet ) + public: + /** + * The constructor. + * \param applicationClass This parameter defines the application class. + * The application class is used to determine the priority order of the + * application. + * \param parent The optional parent of of this class. + */ + ResourceSet(const QString &applicationClass, QObject *parent=NULL); + /** + * The destructor + */ + ~ResourceSet(); + /** + * Initializes the underlaying communications library. + * \return true if initialization is successful. + */ + bool initialize(); + + /** + * This method adds a resource to the set. A set contains only a single + * instance of a given resource. If the ResourceSet already contains a + * resource of the given type it will be overridden. + * \param resource The resource to add to the set. A copy of this object + * is stored in the Set. + */ + void addResource(const Resource *resource); + /** + * This method adds all resources in the list to the set. + * A set contains only a single instance of a given resource. If the + * ResourceSet already contains a resource of the given type it will be + * overridden. + * \param resources The list of resources to add to the set. These will + * be copied. + */ + void addResources(const QListresources); + /** + * This method removes the resource of the given type + * \param type The type of the resource to remove from the set. + */ + void delResource(ResourceType type); + + /** + * This method returns a list of all resource in the set. + * \return a QList of all resources in the set. + */ + QList resources(); + /** + * This method returns a const pointer to a resource of a specific type. + * \type The type of resource we are interested in. + * \return a pointer to the Resource if it is defined NULL otherwise. + */ + Resource * resource(ResourceType type) const; + /** + * Checks if the \ref ResourceSet contains the given \ref Resource + * \param type The Resource to look for + * \return true if the \ref Resource is defined in this \ref ResourceSet + */ + bool contains(ResourceType type) const; + + /** + * Checks if the \ref ResourceSet contains all given resources. + * \param types A list of resources to check for + * \return true if \b all given resources are defined in the ResourceSet. + */ + bool contains(const QList &types) const; + + quint32 id() const; + + /** + * Connects to the Resource Policy Manager. The connected() signal is sent + * when the connection has been established. Acquiring the ResourceSet can + * be attempted at any time after this, but not before. + * \return true if the connection request was successfully sent. + * \param reconnectOnDisconnect. Set to true to automatically reconnect on + * lost connection to the Policy Resource Manager. This optional parameter + * defaults to true. + */ + bool connectToManager(bool reconnectOnDisconnect); + /** + * Disconnects from the Resource Policy Manager. Further attempts at acquiring + * the \ref ResourceSet will fail. + */ + void disconnectFromManager(); + /** + * Checks whether the ResourceSet is connected or not. + */ + bool isConnectedToManager(); + /** + * Attempt to acquire the ResourceSet. The response is returned as the + * resourcesAcquired() signal. + */ + bool acquire(); + /** + * Release the acquired resources. + */ + bool release(); + /** + * Commit changes to the \ref ResourceSet to the Manager. + */ + bool update(); + + signals: + /** + * This signal is emited when the Resource Policy Manager notifies that + * the given resources have become available. + * \param availableResources A list of available resources. + */ + void resourcesBecameAvailable(QList availableResources); + /** + * This signal is emited as a response to the acquire() request. + * \param grantedResources The list of granted optional resources. + */ + void resourcesGranted(QList grantedOptionalResources); + /** + * This signal is emited as a response to the acquire() request, in the + * case where we are not granted any requests. + */ + void resourcesDenied(); + /** + * This signal is emited when some other program with a higher priority + * superseeds us, and as a result we loose our resources. + */ + void lostResources(); + /** + * This signal is emited when we have successfully connected to the manager. + */ + void connectedToManager(); + /** + * This signal is emited when we loose the connection to the manager. + * A reconnect is automatically attempted. + */ + void disconnectedFromManager(); + + + private: + quint32 identifier; + const QString applicationClass; + Resource* resourceSet[NumberOfTypes]; + }; +} + +#endif + diff --git a/libresourceqt/include/resource.h b/libresourceqt/include/resource.h new file mode 100644 index 0000000..13265d5 --- /dev/null +++ b/libresourceqt/include/resource.h @@ -0,0 +1,80 @@ +#ifndef RESOURCE_H +#define RESOURCE_H + +#include + +namespace ResourcePolicy { + enum ResourceType { + AudioPlaybackType = 0, + VideoPlaybackType, + AudioRecorderType, + VideoRecorderType, + VibraType, + LedsType, + BacklightType, + SystemButtonType, + LockButtonType, + ScaleButtonType, + SnapButtonType, + LensCoverType, + NumberOfTypes + }; + + /** + * This class is the super class for all resources. It represents a generic + * \ref Resource. The type specific resource classes should be used. + */ + class Resource + { + public: + /** + * Whether or not this resource is optional, in that it doesn't need to + * be available for the set to be acquired. + * \return true when this resource is optional. + */ + bool isOptional() const; + /** + * Set the resource to be optional or mandatory. + * \param resourceIsOptional This optional parameter defaults to true. + * The default, true, results in the resource becoming optional. When it + * is set to false the resource becomes mandatory. + */ + void setOptional(bool resourceIsOptional=true); + /** + * Whether or not the resource to be shared. If it is shared then other + * programs are allowed to share this resource. + * \return true when this resource is shared. + */ + bool isShared() const; + /** + * Sets the resource to be shared/private. + * \param resourceIsShared This optional parameter defaults to true. + * When it is set to true (de default) the resource is shared with + * other programs. Setting it to false makes this resource exclusive. + */ + void setShared(bool resourceIsShared=true); + /** + * Whether or not this resource has been granted. + * \return true if this resource has been granted. + */ + bool isGranted() const; + void setGranted(); + void unsetGranted(); + + virtual ResourceType type() const = 0; + virtual Resource * clone() const = 0; + virtual ~Resource(); + protected: + Resource(); + Resource(const Resource &other); + + ResourceType resourceType; + bool optional; + bool shared; + quint32 identifier; + bool granted; + }; +} + +#endif + diff --git a/libresourceqt/include/resources.h b/libresourceqt/include/resources.h new file mode 100644 index 0000000..8e3da70 --- /dev/null +++ b/libresourceqt/include/resources.h @@ -0,0 +1,169 @@ +#ifndef RESOURCES_H +#define RESOURCES_H + +#include "resource.h" +#include +#include + +namespace ResourcePolicy { + + class AudioResource: public Resource + { + public: + AudioResource(const QString &audioGroup=QString()); + AudioResource(const AudioResource &other); + virtual ~AudioResource(); + + QString audioGroup() const; + void setAudioGroup(const QString & newGroup); + + quint32 processID() const; + void setProcessID(quint32 newPID); + + QString streamTag() const; + void setStreamTag(const QString & newStreamTag); + + virtual ResourceType type() const; + virtual Resource * clone() const; + private: + QString group; + quint32 pid; + QString stream; + }; + + class AudioRecorderResource: public Resource + { + public: + AudioRecorderResource(const QString & audioGroup=QString()); + AudioRecorderResource(const AudioRecorderResource &other); + virtual ~AudioRecorderResource(); + + QString audioGroup() const; + void setAudioGroup(const QString & newGroup); + + quint32 processID() const; + void setProcessID(quint32 newPID); + + QString streamTag() const; + void setStreamTag(const QString & newStreamTag); + + virtual ResourceType type() const; + virtual Resource * clone() const; + private: + QString group; + quint32 pid; + QString stream; + }; + + class BacklightResource: public Resource + { + public: + BacklightResource(); + BacklightResource(const BacklightResource &other); + virtual ~BacklightResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class LedsResource: public Resource + { + public: + LedsResource(); + LedsResource(const LedsResource &other); + virtual ~LedsResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class VibraResource: public Resource + { + public: + VibraResource(); + VibraResource(const VibraResource &other); + virtual ~VibraResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class VideoRecorderResource: public Resource + { + public: + VideoRecorderResource(); + VideoRecorderResource(const VideoRecorderResource &other); + virtual ~VideoRecorderResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class VideoResource: public Resource + { + public: + VideoResource(); + VideoResource(const VideoResource &other); + virtual ~VideoResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class SystemButtonResource: public Resource + { + public: + SystemButtonResource(); + SystemButtonResource(const SystemButtonResource &other); + virtual ~SystemButtonResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class LockButtonResource: public Resource + { + public: + LockButtonResource(); + LockButtonResource(const LockButtonResource &other); + virtual ~LockButtonResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class ScaleButtonResource: public Resource + { + public: + ScaleButtonResource(); + ScaleButtonResource(const ScaleButtonResource &other); + virtual ~ScaleButtonResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class SnapButtonResource: public Resource + { + public: + SnapButtonResource(); + SnapButtonResource(const SnapButtonResource &other); + virtual ~SnapButtonResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; + + class LensCoverResource: public Resource + { + public: + LensCoverResource(); + LensCoverResource(const LensCoverResource &other); + virtual ~LensCoverResource(); + + virtual ResourceType type() const; + virtual Resource * clone() const; + }; +} +#endif + diff --git a/libresourceqt/libresourceqt.pro b/libresourceqt/libresourceqt.pro new file mode 100644 index 0000000..b9e5cd5 --- /dev/null +++ b/libresourceqt/libresourceqt.pro @@ -0,0 +1,30 @@ +TEMPLATE = lib +VERSION = 1.0.0 +TARGET = resourceqt +DESTDIR = build +DEPENDPATH += include src +INCLUDEPATH += src include ../libresource/src + +# Input +PUBLIC_HEADERS = include/resource.h include/resource-set.h include/resources.h + +HEADERS += $$PUBLIC_HEADERS + +SOURCES += src/resource.cpp \ + src/resource-set.cpp \ + src/resources.cpp + +OBJECTS_DIR = build +MOC_DIR = build + +CONFIG += qt link_pkgconfig dll +QT = core +PKGCONFIG += dbus-1 + +# Install directives +headers.files = $$PUBLIC_HEADERS +INSTALLBASE = /usr +target.path = $$INSTALLBASE/lib +headers.path = $$INSTALLBASE/include/resource/qt4 + +INSTALLS = target headers diff --git a/libresourceqt/src/resource-engine.cpp b/libresourceqt/src/resource-engine.cpp new file mode 100644 index 0000000..cd34c08 --- /dev/null +++ b/libresourceqt/src/resource-engine.cpp @@ -0,0 +1,197 @@ +#include "resource-engine.h" +#include +#include + +using namespace ResourcePolicy; + +static void connectionIsUp(resconn_t *connection); +static inline quint32 allResourcesToBitmask(const ResourceSet *resourceSet); +static inline quint32 optionalResourcesToBitmask(const ResourceSet *resourceSet); +static inline quint32 sharedResourcesToBitmask(const ResourceSet *resourceSet); + +ResourceEngine::ResourceEngine(ResourceSet *resourceSet) + : QObject(resourceSet), resourceSet(resourceSet), requestId(0) +{ + identifier = (quint32)this; +} + +ResourceEngine::~ResourceEngine() +{ +} + +bool ResourceEngine::initialize() +{ + DBusError dbusError; + DBusConnection *dbusConnection; + + dbus_error_init(&dbusError); + dbusConnection = dbus_bus_get(DBUS_BUS_SYSTEM, &dbusError); + if(dbus_error_is_set(&dbusError)) { + qDebug("Error while connection to the system bus: %s", dbusError.message); + dbus_error_free(&dbusError); + return false; + } + dbus_error_free(&dbusError); + libresourceConnection = resproto_init(RESPROTO_ROLE_CLIENT, RESPROTO_TRANSPORT_DBUS, + connectionIsUp, dbusConnection); + if(libresourceConnection == NULL) { + return NULL; + } + +/* resproto_set_handler(libresourceConnection, RESMSG_UNREGISTER, handleUnregisterMessage); + resproto_set_handler(libresourceConnection, RESMSG_GRANT, handleGrantMessage); + resproto_set_handler(libresourceConnection, RESMSG_ADVICE, handleAdviceMessage);*/ + return true; +} + +bool ResourceEngine::connect() +{ + resmsg_t resourceMessage; + resourceMessage.record.type = RESMSG_REGISTER; + resourceMessage.record.id = identifier; + resourceMessage.record.reqno = ++reqestId; + + requestMap.insert(requestId, RESMSG_REGISTER); + + uint32_t allResources, optionalResources, sharedResources; + allResources = allResourcesToBitmask(resourceSet); + allResources = optionalResourcesToBitmask(resourceSet); + allResources = sharedResourcesToBitmask(resourceSet); + + resourceMessage.record.rset.all = allResources; + resourceMessage.record.rset.opt = optionalResources; + resourceMessage.record.rset.share = sharedResources; + resourceMessage.record.rset.mask = 0; //find out what it is + + resourceMessage.record.klass = resourceSet->applicationClass(); + resourceMessage.record.mode = 0; //No auto release + + libresourceSet = resconn_connect(libresourceConnection, &resourceMessage, handleConnect); + + libresourceSet->userdata = this; //save our context + index = REQHASH_INDEX(reqno); + reqtyp[index] = RESMSG_REGISTER; + return true; +} + +static inline quint32 allResourcesToBitmask(const ResourceSet *resourceSet) +{ + QList resourceList = resourceSet->resources(); + quint32 bitmask=0; + for(int i=0; i < resourceList.size(); i++) { + switch(resourceList[i].type()) { + case AudioPlaybackResource: + bitmask += RESMSG_AUDIO_PLAYBACK; + break; + case VideoPlaybackResource: + bitmask += RESMSG_VIDEO_PLAYBACK; + break; + case AudioRecorderResource: + bitmask += RESMSG_AUDIO_RECORDING; + break; + case VideoRecorderResource: + bitmask += RESMSG_VIDEO_RECORDING; + break; + case VibraResource: + bitmask += RESMSG_VIBRA; + break; + case + default: + break; + } + } + return bitmask; +} + +static inline quint32 optionalResourcesToBitmask(const ResourceSet *resourceSet) +{ + QList resourceList = resourceSet->resources(); + quint32 bitmask=0; + for(int i=0; i < resourceList.size(); i++) { + if(resourceList[i].isOptional()) { + switch(resourceList[i].type()) { + case AudioPlaybackResource: + bitmask += RESMSG_AUDIO_PLAYBACK; + break; + case VideoPlaybackResource: + bitmask += RESMSG_VIDEO_PLAYBACK; + break; + case AudioRecorderResource: + bitmask += RESMSG_AUDIO_RECORDING; + break; + case VideoRecorderResource: + bitmask += RESMSG_VIDEO_RECORDING; + break; + default: + break; + } + } + } + return bitmask; +} + +static inline quint32 sharedResourcesToBitmask(const ResourceSet *resourceSet) +{ + QList resourceList = resourceSet->resources(); + quint32 bitmask=0; + for(int i=0; i < resourceList.size(); i++) { + if(resourceList[i].isShared()) { + switch(resourceList[i].type()) { + case AudioPlaybackResource: + bitmask += RESMSG_AUDIO_PLAYBACK; + break; + case VideoPlaybackResource: + bitmask += RESMSG_VIDEO_PLAYBACK; + break; + case AudioRecorderResource: + bitmask += RESMSG_AUDIO_RECORDING; + break; + case VideoRecorderResource: + bitmask += RESMSG_VIDEO_RECORDING; + break; + default: + break; + } + } + } + return bitmask; +} + +bool ResourceEngine::isConnected() +{ + return false; +} + +bool ResourceEngine::acquireResources() +{ + return false; +} + +bool ResourceEngine::releaseResources() +{ + return false; +} + +bool ResourceEngine::updateResources() +{ + return false; +} + +bool ResourceEngine::registerAudioProperties(quint32 pid, QString streamName) +{ + return false; +} + +static void connectionIsUp(resconn_t *connection) +{ + ResourceEngine *resourceEngine; + + resourceEngine = (ResourceEngine *)(connection->dbus.rsets->userdata); + + resourceEngine->handleConnectionIsUp(); +} + +void ResourceEngine::handleConnectionIsUp() +{ + emit connectedToManager(); +} diff --git a/libresourceqt/src/resource-engine.h b/libresourceqt/src/resource-engine.h new file mode 100644 index 0000000..9dd5fe5 --- /dev/null +++ b/libresourceqt/src/resource-engine.h @@ -0,0 +1,55 @@ +#ifndef RESOURCE_ENGINE_H +#define RESOURCE_ENGINE_H + +#include +#include +#include +#include +#include "resource-set.h" + +namespace ResourcePolicy { + +class ResourceEngineData; + +class ResourceEngine: public QObject +{ + Q_OBJECT + Q_DISABLE_COPY( ResourceEngine ) +public: + ResourceEngine(ResourceSet *resourceSet=NULL); + ~ResourceEngine(); + + bool initialize(); + + bool connect(); + bool disconnect(); + bool isConnected(); + + bool acquireResources(); + bool releaseResources(); + bool updateResources(); + + bool registerAudioProperties(quint32 pid, QString streamName); + + void handleConnectionIsUp(); + +signals: + void resourcesBecameAvailable(QList availableResources); + void resourcesAcquired(QList grantedResources); + void resourcesDenied(); + void lostResources(); + void connectedToManager(); + void disconnectedFromManager(); + +private: + bool connected; + ResourceSet *resourceSet; + DBusConnection *dbusConnection; + resconn_t *libresourceConnection; + resset_t *libresourceSet; + quint32 requestId; + QMap messageMap; +}; +} + +#endif diff --git a/libresourceqt/src/resource-factory.cpp b/libresourceqt/src/resource-factory.cpp new file mode 100644 index 0000000..f500792 --- /dev/null +++ b/libresourceqt/src/resource-factory.cpp @@ -0,0 +1,31 @@ +#include "resource-factory.h" +#include "libplayback-wrapper.h" + +using namespace ResourceTypes; + +ResourceFactory::ResourceFactory(QObject *parent) + : QObject(parent), sessionBusConnection(QDBusConnection::sessionBus()) +{ +} + +ResourceFactory::~ResourceFactory() +{ +} + +Resource * ResourceFactory::createResource(enum ResourceClass applicationClass, + quint16 requestedResources) +{ + qDebug("We %s connected to DBus",sessionBusConnection.isConnected()?"are":"are not"); + Resource *resource = new Resource(applicationClass, requestedResources, this); + ResourceLibrary *libPlayback = new LibPlaybackWrapper(resource); + + bool resourceProperlyInitialized = resource->initialize(libPlayback); + if(resourceProperlyInitialized) { + return resource; + } + else { + qDebug("Failed to initialize Resource. Returning NULL!"); + delete resource; + return NULL; + } +} diff --git a/libresourceqt/src/resource-set.cpp b/libresourceqt/src/resource-set.cpp new file mode 100644 index 0000000..c7862ef --- /dev/null +++ b/libresourceqt/src/resource-set.cpp @@ -0,0 +1,111 @@ +#include "resource-set.h" +using namespace ResourcePolicy; + + +ResourceSet::ResourceSet(const QString &applicationClass, QObject * parent) + : QObject(parent), applicationClass(applicationClass) +{ + identifier = (quint32)this; + memset(resourceSet, 0, sizeof(QPointer)*NumberOfTypes); +} + +ResourceSet::~ResourceSet() +{ + for(int i=0;itype()] = resource->clone(); +} + +void ResourceSet::addResources(const QListresources) +{ + for(int i=0; i < resources.size(); i++) { + addResource(resources.at(i)); + } +} + +void ResourceSet::delResource(ResourceType type) +{ + if(contains(type)) { + delete resourceSet[type]; + resourceSet[type] = NULL; + } +} + +bool ResourceSet::contains(ResourceType type) const +{ + if((type < NumberOfTypes) && (resourceSet[type] != NULL)) + return true; + else + return false; +} + +bool ResourceSet::contains(const QList &types) const +{ + bool containsAll=true; + int i=0; + do { + containsAll = contains(types.at(i)); + i++; + } while((i < NumberOfTypes) && containsAll); + return containsAll; +} + +quint32 ResourceSet::id() const +{ + return identifier; +} + +QList ResourceSet::resources() +{ + QList listOfResources; + for(int i=0; i < NumberOfTypes; i++) { + if(resourceSet[i] != NULL) { + Resource *clone = resourceSet[i]->clone(); + listOfResources.append(clone); + } + } + return listOfResources; +} + +Resource * ResourceSet::resource(ResourceType type) const +{ + if(contains(type)) + return resourceSet[type]->clone(); + else + return NULL; +} + +bool ResourceSet::connectToManager(bool reconnectOnDisconnect) +{ + return false; +} + +void ResourceSet::disconnectFromManager() +{ +} + +bool ResourceSet::isConnectedToManager() +{ + return false; +} + +bool ResourceSet::acquire() +{ + return false; +} + +bool ResourceSet::release() +{ + return false; +} + +bool ResourceSet::update() +{ + return false; +} + diff --git a/libresourceqt/src/resource.cpp b/libresourceqt/src/resource.cpp new file mode 100644 index 0000000..8207b66 --- /dev/null +++ b/libresourceqt/src/resource.cpp @@ -0,0 +1,57 @@ +#include "resource.h" + +using namespace ResourcePolicy; + +Resource::Resource() + : optional(false), shared(false), + identifier(0), granted(false) +{ + identifier = (quint32)this; +} + +Resource::Resource(const Resource &other) + : optional(other.optional), shared(other.shared), + identifier(other.identifier), granted(other.granted) +{ +} + +Resource::~Resource() +{ +} + +bool Resource::isOptional() const +{ + return optional; +} + +void Resource::setOptional(bool resourceIsOptional) +{ + optional = resourceIsOptional; +} + +bool Resource::isShared() const +{ + return shared; +} + +void Resource::setShared(bool shared) +{ + this->shared = shared; +} + +bool Resource::isGranted() const +{ + return granted; +} + +void Resource::setGranted() +{ + granted = true; +} + +void Resource::unsetGranted() +{ + granted = false; +} + + diff --git a/libresourceqt/src/resources.cpp b/libresourceqt/src/resources.cpp new file mode 100644 index 0000000..9858bd3 --- /dev/null +++ b/libresourceqt/src/resources.cpp @@ -0,0 +1,347 @@ +#include "resources.h" + +using namespace ResourcePolicy; + +AudioResource::AudioResource(const QString &audioGroup) + : Resource(), group(audioGroup), pid(0), stream(QString()) +{ +} + +AudioResource::AudioResource(const AudioResource &other) + : Resource(other), group(other.group), pid(other.pid), stream(other.stream) +{ +} + +Resource * AudioResource::clone() const +{ + return new AudioResource(*this); +} + +AudioResource::~AudioResource() +{ +} + +QString AudioResource::audioGroup() const +{ + return group; +} + +void AudioResource::setAudioGroup(const QString &newGroup) +{ + group = newGroup; +} + +quint32 AudioResource::processID() const +{ + return pid; +} + +void AudioResource::setProcessID(quint32 newPID) +{ + pid = newPID; +} + +QString AudioResource::streamTag() const +{ + return stream; +} + +void AudioResource::setStreamTag(const QString & newStreamTag) +{ + stream = newStreamTag; +} + +ResourceType AudioResource::type() const +{ + return AudioPlaybackType; +} + +AudioRecorderResource::AudioRecorderResource(const QString & audioGroup) + : Resource(), group(audioGroup), pid(0), stream(QString()) +{ +} + +AudioRecorderResource::AudioRecorderResource(const AudioRecorderResource &other) + : Resource(other), group(other.group), pid(other.pid), stream(other.stream) +{ +} + +Resource * AudioRecorderResource::clone() const +{ + return new AudioRecorderResource(*this); +} + +AudioRecorderResource::~AudioRecorderResource() +{ +} + +void AudioRecorderResource::setAudioGroup(const QString & newGroup) +{ + group = newGroup; +} + +quint32 AudioRecorderResource::processID() const +{ + return pid; +} + +void AudioRecorderResource::setProcessID(quint32 newPID) +{ + pid = newPID; +} + +QString AudioRecorderResource::streamTag() const +{ + return stream; +} + +void AudioRecorderResource::setStreamTag(const QString & newStreamTag) +{ + stream = newStreamTag; +} + +ResourceType AudioRecorderResource::type() const +{ + return AudioRecorderType; +} + +VideoResource::VideoResource() + : Resource() +{ +} + +VideoResource::VideoResource(const VideoResource &other) + : Resource(other) +{ +} + +Resource * VideoResource::clone() const +{ + return new VideoResource(*this); +} + +VideoResource::~VideoResource() +{ +} + +ResourceType VideoResource::type() const +{ + return VideoPlaybackType; +} + +VideoRecorderResource::VideoRecorderResource() + : Resource() +{ +} + +VideoRecorderResource::VideoRecorderResource(const VideoRecorderResource &other) + : Resource(other) +{ +} + +Resource * VideoRecorderResource::clone() const +{ + return new VideoRecorderResource(*this); +} + +VideoRecorderResource::~VideoRecorderResource() +{ +} + +ResourceType VideoRecorderResource::type() const +{ + return VideoRecorderType; +} + +VibraResource::VibraResource() + : Resource() +{ +} + +VibraResource::VibraResource(const VibraResource &other) + : Resource(other) +{ +} + +Resource * VibraResource::clone() const +{ + return new VibraResource(*this); +} + +VibraResource::~VibraResource() +{ +} + +ResourceType VibraResource::type() const +{ + return VibraType; +} + +LedsResource::LedsResource() + : Resource() +{ +} + +LedsResource::LedsResource(const LedsResource &other) + : Resource(other) +{ +} + +Resource * LedsResource::clone() const +{ + return new LedsResource(*this); +} + +LedsResource::~LedsResource() +{ +} + +ResourceType LedsResource::type() const +{ + return LedsType; +} + +BacklightResource::BacklightResource() + : Resource() +{ +} + +BacklightResource::BacklightResource(const BacklightResource &other) + : Resource(other) +{ +} + +Resource * BacklightResource::clone() const +{ + return new BacklightResource(*this); +} + +BacklightResource::~BacklightResource() +{ +} + +ResourceType BacklightResource::type() const +{ + return BacklightType; +} + +SystemButtonResource::SystemButtonResource() + : Resource() +{ +} + +SystemButtonResource::SystemButtonResource(const SystemButtonResource &other) + : Resource(other) +{ +} + +Resource * SystemButtonResource::clone() const +{ + return new SystemButtonResource(*this); +} + +SystemButtonResource::~SystemButtonResource() +{ +} + +ResourceType SystemButtonResource::type() const +{ + return SystemButtonType; +} + +LockButtonResource::LockButtonResource() + : Resource() +{ +} + +LockButtonResource::LockButtonResource(const LockButtonResource &other) + : Resource(other) +{ +} + +Resource * LockButtonResource::clone() const +{ + return new LockButtonResource(*this); +} + +LockButtonResource::~LockButtonResource() +{ +} + +ResourceType LockButtonResource::type() const +{ + return LockButtonType; +} + +ScaleButtonResource::ScaleButtonResource() + : Resource() +{ +} + +ScaleButtonResource::ScaleButtonResource(const ScaleButtonResource &other) + : Resource(other) +{ +} + +Resource * ScaleButtonResource::clone() const +{ + return new ScaleButtonResource(*this); +} + +ScaleButtonResource::~ScaleButtonResource() +{ +} + +ResourceType ScaleButtonResource::type() const +{ + return ScaleButtonType; +} + +SnapButtonResource::SnapButtonResource() + : Resource() +{ +} + +SnapButtonResource::SnapButtonResource(const SnapButtonResource &other) + : Resource(other) +{ +} + +Resource * SnapButtonResource::clone() const +{ + return new SnapButtonResource(*this); +} + +SnapButtonResource::~SnapButtonResource() +{ +} + +ResourceType SnapButtonResource::type() const +{ + return SnapButtonType; +} + +LensCoverResource::LensCoverResource() + : Resource() +{ +} + +LensCoverResource::LensCoverResource(const LensCoverResource &other) + : Resource(other) +{ +} + +Resource * LensCoverResource::clone() const +{ + return new LensCoverResource(*this); +} + +LensCoverResource::~LensCoverResource() +{ +} + +ResourceType LensCoverResource::type() const +{ + return LensCoverType; +} + diff --git a/src/resource-engine.cpp b/src/resource-engine.cpp deleted file mode 100644 index cd34c08..0000000 --- a/src/resource-engine.cpp +++ /dev/null @@ -1,197 +0,0 @@ -#include "resource-engine.h" -#include -#include - -using namespace ResourcePolicy; - -static void connectionIsUp(resconn_t *connection); -static inline quint32 allResourcesToBitmask(const ResourceSet *resourceSet); -static inline quint32 optionalResourcesToBitmask(const ResourceSet *resourceSet); -static inline quint32 sharedResourcesToBitmask(const ResourceSet *resourceSet); - -ResourceEngine::ResourceEngine(ResourceSet *resourceSet) - : QObject(resourceSet), resourceSet(resourceSet), requestId(0) -{ - identifier = (quint32)this; -} - -ResourceEngine::~ResourceEngine() -{ -} - -bool ResourceEngine::initialize() -{ - DBusError dbusError; - DBusConnection *dbusConnection; - - dbus_error_init(&dbusError); - dbusConnection = dbus_bus_get(DBUS_BUS_SYSTEM, &dbusError); - if(dbus_error_is_set(&dbusError)) { - qDebug("Error while connection to the system bus: %s", dbusError.message); - dbus_error_free(&dbusError); - return false; - } - dbus_error_free(&dbusError); - libresourceConnection = resproto_init(RESPROTO_ROLE_CLIENT, RESPROTO_TRANSPORT_DBUS, - connectionIsUp, dbusConnection); - if(libresourceConnection == NULL) { - return NULL; - } - -/* resproto_set_handler(libresourceConnection, RESMSG_UNREGISTER, handleUnregisterMessage); - resproto_set_handler(libresourceConnection, RESMSG_GRANT, handleGrantMessage); - resproto_set_handler(libresourceConnection, RESMSG_ADVICE, handleAdviceMessage);*/ - return true; -} - -bool ResourceEngine::connect() -{ - resmsg_t resourceMessage; - resourceMessage.record.type = RESMSG_REGISTER; - resourceMessage.record.id = identifier; - resourceMessage.record.reqno = ++reqestId; - - requestMap.insert(requestId, RESMSG_REGISTER); - - uint32_t allResources, optionalResources, sharedResources; - allResources = allResourcesToBitmask(resourceSet); - allResources = optionalResourcesToBitmask(resourceSet); - allResources = sharedResourcesToBitmask(resourceSet); - - resourceMessage.record.rset.all = allResources; - resourceMessage.record.rset.opt = optionalResources; - resourceMessage.record.rset.share = sharedResources; - resourceMessage.record.rset.mask = 0; //find out what it is - - resourceMessage.record.klass = resourceSet->applicationClass(); - resourceMessage.record.mode = 0; //No auto release - - libresourceSet = resconn_connect(libresourceConnection, &resourceMessage, handleConnect); - - libresourceSet->userdata = this; //save our context - index = REQHASH_INDEX(reqno); - reqtyp[index] = RESMSG_REGISTER; - return true; -} - -static inline quint32 allResourcesToBitmask(const ResourceSet *resourceSet) -{ - QList resourceList = resourceSet->resources(); - quint32 bitmask=0; - for(int i=0; i < resourceList.size(); i++) { - switch(resourceList[i].type()) { - case AudioPlaybackResource: - bitmask += RESMSG_AUDIO_PLAYBACK; - break; - case VideoPlaybackResource: - bitmask += RESMSG_VIDEO_PLAYBACK; - break; - case AudioRecorderResource: - bitmask += RESMSG_AUDIO_RECORDING; - break; - case VideoRecorderResource: - bitmask += RESMSG_VIDEO_RECORDING; - break; - case VibraResource: - bitmask += RESMSG_VIBRA; - break; - case - default: - break; - } - } - return bitmask; -} - -static inline quint32 optionalResourcesToBitmask(const ResourceSet *resourceSet) -{ - QList resourceList = resourceSet->resources(); - quint32 bitmask=0; - for(int i=0; i < resourceList.size(); i++) { - if(resourceList[i].isOptional()) { - switch(resourceList[i].type()) { - case AudioPlaybackResource: - bitmask += RESMSG_AUDIO_PLAYBACK; - break; - case VideoPlaybackResource: - bitmask += RESMSG_VIDEO_PLAYBACK; - break; - case AudioRecorderResource: - bitmask += RESMSG_AUDIO_RECORDING; - break; - case VideoRecorderResource: - bitmask += RESMSG_VIDEO_RECORDING; - break; - default: - break; - } - } - } - return bitmask; -} - -static inline quint32 sharedResourcesToBitmask(const ResourceSet *resourceSet) -{ - QList resourceList = resourceSet->resources(); - quint32 bitmask=0; - for(int i=0; i < resourceList.size(); i++) { - if(resourceList[i].isShared()) { - switch(resourceList[i].type()) { - case AudioPlaybackResource: - bitmask += RESMSG_AUDIO_PLAYBACK; - break; - case VideoPlaybackResource: - bitmask += RESMSG_VIDEO_PLAYBACK; - break; - case AudioRecorderResource: - bitmask += RESMSG_AUDIO_RECORDING; - break; - case VideoRecorderResource: - bitmask += RESMSG_VIDEO_RECORDING; - break; - default: - break; - } - } - } - return bitmask; -} - -bool ResourceEngine::isConnected() -{ - return false; -} - -bool ResourceEngine::acquireResources() -{ - return false; -} - -bool ResourceEngine::releaseResources() -{ - return false; -} - -bool ResourceEngine::updateResources() -{ - return false; -} - -bool ResourceEngine::registerAudioProperties(quint32 pid, QString streamName) -{ - return false; -} - -static void connectionIsUp(resconn_t *connection) -{ - ResourceEngine *resourceEngine; - - resourceEngine = (ResourceEngine *)(connection->dbus.rsets->userdata); - - resourceEngine->handleConnectionIsUp(); -} - -void ResourceEngine::handleConnectionIsUp() -{ - emit connectedToManager(); -} diff --git a/src/resource-engine.h b/src/resource-engine.h deleted file mode 100644 index 9dd5fe5..0000000 --- a/src/resource-engine.h +++ /dev/null @@ -1,55 +0,0 @@ -#ifndef RESOURCE_ENGINE_H -#define RESOURCE_ENGINE_H - -#include -#include -#include -#include -#include "resource-set.h" - -namespace ResourcePolicy { - -class ResourceEngineData; - -class ResourceEngine: public QObject -{ - Q_OBJECT - Q_DISABLE_COPY( ResourceEngine ) -public: - ResourceEngine(ResourceSet *resourceSet=NULL); - ~ResourceEngine(); - - bool initialize(); - - bool connect(); - bool disconnect(); - bool isConnected(); - - bool acquireResources(); - bool releaseResources(); - bool updateResources(); - - bool registerAudioProperties(quint32 pid, QString streamName); - - void handleConnectionIsUp(); - -signals: - void resourcesBecameAvailable(QList availableResources); - void resourcesAcquired(QList grantedResources); - void resourcesDenied(); - void lostResources(); - void connectedToManager(); - void disconnectedFromManager(); - -private: - bool connected; - ResourceSet *resourceSet; - DBusConnection *dbusConnection; - resconn_t *libresourceConnection; - resset_t *libresourceSet; - quint32 requestId; - QMap messageMap; -}; -} - -#endif diff --git a/src/resource-factory.cpp b/src/resource-factory.cpp deleted file mode 100644 index f500792..0000000 --- a/src/resource-factory.cpp +++ /dev/null @@ -1,31 +0,0 @@ -#include "resource-factory.h" -#include "libplayback-wrapper.h" - -using namespace ResourceTypes; - -ResourceFactory::ResourceFactory(QObject *parent) - : QObject(parent), sessionBusConnection(QDBusConnection::sessionBus()) -{ -} - -ResourceFactory::~ResourceFactory() -{ -} - -Resource * ResourceFactory::createResource(enum ResourceClass applicationClass, - quint16 requestedResources) -{ - qDebug("We %s connected to DBus",sessionBusConnection.isConnected()?"are":"are not"); - Resource *resource = new Resource(applicationClass, requestedResources, this); - ResourceLibrary *libPlayback = new LibPlaybackWrapper(resource); - - bool resourceProperlyInitialized = resource->initialize(libPlayback); - if(resourceProperlyInitialized) { - return resource; - } - else { - qDebug("Failed to initialize Resource. Returning NULL!"); - delete resource; - return NULL; - } -} diff --git a/src/resource-set.cpp b/src/resource-set.cpp deleted file mode 100644 index c7862ef..0000000 --- a/src/resource-set.cpp +++ /dev/null @@ -1,111 +0,0 @@ -#include "resource-set.h" -using namespace ResourcePolicy; - - -ResourceSet::ResourceSet(const QString &applicationClass, QObject * parent) - : QObject(parent), applicationClass(applicationClass) -{ - identifier = (quint32)this; - memset(resourceSet, 0, sizeof(QPointer)*NumberOfTypes); -} - -ResourceSet::~ResourceSet() -{ - for(int i=0;itype()] = resource->clone(); -} - -void ResourceSet::addResources(const QListresources) -{ - for(int i=0; i < resources.size(); i++) { - addResource(resources.at(i)); - } -} - -void ResourceSet::delResource(ResourceType type) -{ - if(contains(type)) { - delete resourceSet[type]; - resourceSet[type] = NULL; - } -} - -bool ResourceSet::contains(ResourceType type) const -{ - if((type < NumberOfTypes) && (resourceSet[type] != NULL)) - return true; - else - return false; -} - -bool ResourceSet::contains(const QList &types) const -{ - bool containsAll=true; - int i=0; - do { - containsAll = contains(types.at(i)); - i++; - } while((i < NumberOfTypes) && containsAll); - return containsAll; -} - -quint32 ResourceSet::id() const -{ - return identifier; -} - -QList ResourceSet::resources() -{ - QList listOfResources; - for(int i=0; i < NumberOfTypes; i++) { - if(resourceSet[i] != NULL) { - Resource *clone = resourceSet[i]->clone(); - listOfResources.append(clone); - } - } - return listOfResources; -} - -Resource * ResourceSet::resource(ResourceType type) const -{ - if(contains(type)) - return resourceSet[type]->clone(); - else - return NULL; -} - -bool ResourceSet::connectToManager(bool reconnectOnDisconnect) -{ - return false; -} - -void ResourceSet::disconnectFromManager() -{ -} - -bool ResourceSet::isConnectedToManager() -{ - return false; -} - -bool ResourceSet::acquire() -{ - return false; -} - -bool ResourceSet::release() -{ - return false; -} - -bool ResourceSet::update() -{ - return false; -} - diff --git a/src/resource.cpp b/src/resource.cpp deleted file mode 100644 index 8207b66..0000000 --- a/src/resource.cpp +++ /dev/null @@ -1,57 +0,0 @@ -#include "resource.h" - -using namespace ResourcePolicy; - -Resource::Resource() - : optional(false), shared(false), - identifier(0), granted(false) -{ - identifier = (quint32)this; -} - -Resource::Resource(const Resource &other) - : optional(other.optional), shared(other.shared), - identifier(other.identifier), granted(other.granted) -{ -} - -Resource::~Resource() -{ -} - -bool Resource::isOptional() const -{ - return optional; -} - -void Resource::setOptional(bool resourceIsOptional) -{ - optional = resourceIsOptional; -} - -bool Resource::isShared() const -{ - return shared; -} - -void Resource::setShared(bool shared) -{ - this->shared = shared; -} - -bool Resource::isGranted() const -{ - return granted; -} - -void Resource::setGranted() -{ - granted = true; -} - -void Resource::unsetGranted() -{ - granted = false; -} - - diff --git a/src/resources.cpp b/src/resources.cpp deleted file mode 100644 index 9858bd3..0000000 --- a/src/resources.cpp +++ /dev/null @@ -1,347 +0,0 @@ -#include "resources.h" - -using namespace ResourcePolicy; - -AudioResource::AudioResource(const QString &audioGroup) - : Resource(), group(audioGroup), pid(0), stream(QString()) -{ -} - -AudioResource::AudioResource(const AudioResource &other) - : Resource(other), group(other.group), pid(other.pid), stream(other.stream) -{ -} - -Resource * AudioResource::clone() const -{ - return new AudioResource(*this); -} - -AudioResource::~AudioResource() -{ -} - -QString AudioResource::audioGroup() const -{ - return group; -} - -void AudioResource::setAudioGroup(const QString &newGroup) -{ - group = newGroup; -} - -quint32 AudioResource::processID() const -{ - return pid; -} - -void AudioResource::setProcessID(quint32 newPID) -{ - pid = newPID; -} - -QString AudioResource::streamTag() const -{ - return stream; -} - -void AudioResource::setStreamTag(const QString & newStreamTag) -{ - stream = newStreamTag; -} - -ResourceType AudioResource::type() const -{ - return AudioPlaybackType; -} - -AudioRecorderResource::AudioRecorderResource(const QString & audioGroup) - : Resource(), group(audioGroup), pid(0), stream(QString()) -{ -} - -AudioRecorderResource::AudioRecorderResource(const AudioRecorderResource &other) - : Resource(other), group(other.group), pid(other.pid), stream(other.stream) -{ -} - -Resource * AudioRecorderResource::clone() const -{ - return new AudioRecorderResource(*this); -} - -AudioRecorderResource::~AudioRecorderResource() -{ -} - -void AudioRecorderResource::setAudioGroup(const QString & newGroup) -{ - group = newGroup; -} - -quint32 AudioRecorderResource::processID() const -{ - return pid; -} - -void AudioRecorderResource::setProcessID(quint32 newPID) -{ - pid = newPID; -} - -QString AudioRecorderResource::streamTag() const -{ - return stream; -} - -void AudioRecorderResource::setStreamTag(const QString & newStreamTag) -{ - stream = newStreamTag; -} - -ResourceType AudioRecorderResource::type() const -{ - return AudioRecorderType; -} - -VideoResource::VideoResource() - : Resource() -{ -} - -VideoResource::VideoResource(const VideoResource &other) - : Resource(other) -{ -} - -Resource * VideoResource::clone() const -{ - return new VideoResource(*this); -} - -VideoResource::~VideoResource() -{ -} - -ResourceType VideoResource::type() const -{ - return VideoPlaybackType; -} - -VideoRecorderResource::VideoRecorderResource() - : Resource() -{ -} - -VideoRecorderResource::VideoRecorderResource(const VideoRecorderResource &other) - : Resource(other) -{ -} - -Resource * VideoRecorderResource::clone() const -{ - return new VideoRecorderResource(*this); -} - -VideoRecorderResource::~VideoRecorderResource() -{ -} - -ResourceType VideoRecorderResource::type() const -{ - return VideoRecorderType; -} - -VibraResource::VibraResource() - : Resource() -{ -} - -VibraResource::VibraResource(const VibraResource &other) - : Resource(other) -{ -} - -Resource * VibraResource::clone() const -{ - return new VibraResource(*this); -} - -VibraResource::~VibraResource() -{ -} - -ResourceType VibraResource::type() const -{ - return VibraType; -} - -LedsResource::LedsResource() - : Resource() -{ -} - -LedsResource::LedsResource(const LedsResource &other) - : Resource(other) -{ -} - -Resource * LedsResource::clone() const -{ - return new LedsResource(*this); -} - -LedsResource::~LedsResource() -{ -} - -ResourceType LedsResource::type() const -{ - return LedsType; -} - -BacklightResource::BacklightResource() - : Resource() -{ -} - -BacklightResource::BacklightResource(const BacklightResource &other) - : Resource(other) -{ -} - -Resource * BacklightResource::clone() const -{ - return new BacklightResource(*this); -} - -BacklightResource::~BacklightResource() -{ -} - -ResourceType BacklightResource::type() const -{ - return BacklightType; -} - -SystemButtonResource::SystemButtonResource() - : Resource() -{ -} - -SystemButtonResource::SystemButtonResource(const SystemButtonResource &other) - : Resource(other) -{ -} - -Resource * SystemButtonResource::clone() const -{ - return new SystemButtonResource(*this); -} - -SystemButtonResource::~SystemButtonResource() -{ -} - -ResourceType SystemButtonResource::type() const -{ - return SystemButtonType; -} - -LockButtonResource::LockButtonResource() - : Resource() -{ -} - -LockButtonResource::LockButtonResource(const LockButtonResource &other) - : Resource(other) -{ -} - -Resource * LockButtonResource::clone() const -{ - return new LockButtonResource(*this); -} - -LockButtonResource::~LockButtonResource() -{ -} - -ResourceType LockButtonResource::type() const -{ - return LockButtonType; -} - -ScaleButtonResource::ScaleButtonResource() - : Resource() -{ -} - -ScaleButtonResource::ScaleButtonResource(const ScaleButtonResource &other) - : Resource(other) -{ -} - -Resource * ScaleButtonResource::clone() const -{ - return new ScaleButtonResource(*this); -} - -ScaleButtonResource::~ScaleButtonResource() -{ -} - -ResourceType ScaleButtonResource::type() const -{ - return ScaleButtonType; -} - -SnapButtonResource::SnapButtonResource() - : Resource() -{ -} - -SnapButtonResource::SnapButtonResource(const SnapButtonResource &other) - : Resource(other) -{ -} - -Resource * SnapButtonResource::clone() const -{ - return new SnapButtonResource(*this); -} - -SnapButtonResource::~SnapButtonResource() -{ -} - -ResourceType SnapButtonResource::type() const -{ - return SnapButtonType; -} - -LensCoverResource::LensCoverResource() - : Resource() -{ -} - -LensCoverResource::LensCoverResource(const LensCoverResource &other) - : Resource(other) -{ -} - -Resource * LensCoverResource::clone() const -{ - return new LensCoverResource(*this); -} - -LensCoverResource::~LensCoverResource() -{ -} - -ResourceType LensCoverResource::type() const -{ - return LensCoverType; -} - diff --git a/tests/Makefile b/tests/Makefile deleted file mode 100644 index 20ae9ef..0000000 --- a/tests/Makefile +++ /dev/null @@ -1,21 +0,0 @@ -QMAKE = qmake -MAKEFILES = $(patsubst %.pro,%.make,$(wildcard *.pro)) -MAKEOVERRIDES = - -%.make: %.pro - $(QMAKE) -o $@ $< - -tests: all - find build -type f -name 'test-*' -exec sh -c "if test -x {}; then {}; fi" \; - -clean: - $(RM) $(MAKEFILES) - $(RM) -r build - -all: $(MAKEFILES) - for makefile in $(MAKEFILES); do $(MAKE) -f "$$makefile" all; done - -install: $(MAKEFILES) - for makefile in $(MAKEFILES); do $(MAKE) -f "$$makefile" install; done - -.phony: install tests all clean diff --git a/tests/test-resource-engine/test-resource-engine.cpp b/tests/test-resource-engine/test-resource-engine.cpp new file mode 100644 index 0000000..5c95224 --- /dev/null +++ b/tests/test-resource-engine/test-resource-engine.cpp @@ -0,0 +1,62 @@ +#include "test-resource-engine.h" +#include + +using namespace ResourcePolicy; + +TestResourceEngine::TestResourceEngine() + : resourceEngine(NULL), resourceSet(NULL), + audioPlayback(AudioPlaybackResource), videoPlayback(VideoPlaybackResource), + audioRecorder(AudioRecorderResource), videoRecorder(VideoRecorderResource) +{ + resourceSet = new ResourceSet("player", this); + resourceSet->addResource(audioPlayback); + resourceSet->addResource(videoPlayback); + resourceSet->addResource(audioRecorder); + resourceSet->addResource(videoRecorder); +} + +TestResourceEngine::~TestResourceEngine() +{ +} + +void TestResourceEngine::init() +{ + resourceEngine = new ResourceEngine(resourceSet); + bool initializeSucceeded = resourceEngine->initialize(); + QVERIFY(!resourceEngine->isConnected()); + QVERIFY(initializeSucceeded); +} + +void TestResourceEngine::testConnect() +{ + bool connectIsSuccessful = resourceEngine->connect(); + QVERIFY(connectIsSuccessful); +} + +QTEST_MAIN(TestResourceEngine) + +//////////////////////////////////////////////////////////////// + +resconn_t* resproto_init(resproto_role_t role, resproto_transport_t transport, ...) +{ + resconn_t *resourceConnection; + resconn_linkup_t callbackFunction; + DBusConnection *dbusConnection, systemBus; + va_list args; + + va_start(); + callbackFunction = va_arg(args, resconn_linkup_t); + dbusConnection = va_arg(args, DBusConnection *); + va_end(); + + systemBus = dbus_bus_get(DBUS_BUS_SYSTEM); + + QVERIFY(callbackFunction != NULL); + QVERIFY(dbusConnection == systemBus); + QVERIFY(role == RESPROTO_ROLE_CLIENT); + QVERIFY(transport == RESPROTO_TRANSPORT_DBUS); + + resourceConnection =(resconn_t *) calloc(1, sizeof(resconn_t)); + + return resourceConnection; +} diff --git a/tests/test-resource-engine/test-resource-engine.h b/tests/test-resource-engine/test-resource-engine.h new file mode 100644 index 0000000..5484a05 --- /dev/null +++ b/tests/test-resource-engine/test-resource-engine.h @@ -0,0 +1,32 @@ +#ifndef TEST_RESOURCE_ENGINE_H +#define TEST_RESOURCE_ENGINE_H + +#include +#include "resource-engine.h" + +using namespace ResourcePolicy; + +class TestResourceEngine: public QObject +{ + Q_OBJECT + friend resconn_t* resproto_init(resproto_role_t, resproto_transport_t, ...); +private: + ResourceEngine *resourceEngine; + ResourceSet *resourceSet; + Resource audioPlayback; + Resource videoPlayback; + Resource audioRecorder; + Resource videoRecorder; + bool libresourceInitialized; +public: + TestResourceEngine(); + ~TestResourceEngine(); +public slots: + +private slots: + void init(); + + void testConnect(); +}; + +#endif diff --git a/tests/test-resource-engine/test-resource-engine.pro b/tests/test-resource-engine/test-resource-engine.pro new file mode 100644 index 0000000..9413609 --- /dev/null +++ b/tests/test-resource-engine/test-resource-engine.pro @@ -0,0 +1,29 @@ +BASE = .. +TEMPLATE = app +TARGET = test-resource-engine +DESTDIR = build +DEPENDPATH += $${BASE}/include $${BASE}/src . +INCLUDEPATH += $${BASE}/src $${BASE}/include $${BASE}/../libresource/src + +# Input +HEADERS += $${BASE}/include/resource.h \ + $${BASE}/include/resource-set.h \ + $${BASE}/src/resource-engine.h \ + test-resource-engine.h + +SOURCES += $${BASE}/src/resource.cpp \ + $${BASE}/src/resource-set.cpp \ + $${BASE}/src/resource-engine.cpp \ + test-resource-engine.cpp + +OBJECTS_DIR = build +MOC_DIR = build + +CONFIG += qt qtestlib debug warn_on link_pkgconfig +QT -= gui +PKGCONFIG += dbus-1 + +# Install directives +INSTALLBASE = /usr +target.path = $${INSTALLBASE}/share/libresourceqt/tests +INSTALLS = target diff --git a/tests/test-resource-set.cpp b/tests/test-resource-set.cpp deleted file mode 100644 index e9ee74b..0000000 --- a/tests/test-resource-set.cpp +++ /dev/null @@ -1,172 +0,0 @@ -#include "test-resource-set.h" - -Resource * TestResourceSet::resourceFromType(ResourceType type) -{ - switch(type) { - case AudioPlaybackType: - return audioResource; - case AudioRecorderType: - return audioRecorderResource; - case VideoPlaybackType: - return videoResource; - case VideoRecorderType: - return videoRecorderResource; - case VibraType: - return vibraResource; - case LedsType: - return ledsResource; - case BacklightType: - return backlightResource; - case SystemButtonType: - return systemButtonResource; - case LockButtonType: - return lockButtonResource; - case ScaleButtonType: - return scaleButtonResource; - case SnapButtonType: - return snapButtonResource; - case LensCoverType: - return lensCoverResource; - default: - return NULL; - } -} - -using namespace ResourcePolicy; - -TestResourceSet::TestResourceSet() -{ - audioResource = new AudioResource; - audioRecorderResource = new AudioRecorderResource; - videoResource = new VideoResource; - videoRecorderResource = new VideoRecorderResource; - vibraResource = new VibraResource; - ledsResource = new LedsResource; - backlightResource = new BacklightResource; - systemButtonResource = new SystemButtonResource; - lockButtonResource = new LockButtonResource; - scaleButtonResource = new ScaleButtonResource; - snapButtonResource = new SnapButtonResource; - lensCoverResource = new LensCoverResource; -} - -TestResourceSet::~TestResourceSet() -{ - delete audioResource; - delete audioRecorderResource; - delete videoResource; - delete videoRecorderResource; - delete vibraResource; - delete ledsResource; - delete backlightResource; - delete systemButtonResource; - delete lockButtonResource; - delete scaleButtonResource; - delete snapButtonResource; - delete lensCoverResource; -} - -void TestResourceSet::init() -{ - resourceSet = new ResourceSet("player"); -} - -void TestResourceSet::cleanup() -{ - delete resourceSet; -} - -void TestResourceSet::testIdentifier() -{ - ResourceSet otherSet("game"); - - bool identifiersAreUnique = (resourceSet->id() != otherSet.id()); - QVERIFY(identifiersAreUnique); - QVERIFY(resourceSet->id() == (quint32)resourceSet); - QVERIFY(otherSet.id() == (quint32)&otherSet); -} - -void TestResourceSet::testAddResource() -{ - for(int i=0;iaddResource(resource); - bool setContainsGivenResource = resourceSet->contains(type); - QVERIFY(setContainsGivenResource); - } -} - -void TestResourceSet::testAddResources() -{ - resourceSet->addResource(audioResource); - - bool setContainsAudioResource = resourceSet->contains(AudioPlaybackType); - QVERIFY(setContainsAudioResource); - QList resources; - - resources << audioResource << videoResource; - - resourceSet->addResources(resources); - - QVERIFY(resourceSet->contains(AudioPlaybackType)); - QVERIFY(resourceSet->contains(VideoPlaybackType)); -} - -void TestResourceSet::testDelResource() -{ - resourceSet->addResource(audioResource); - resourceSet->addResource(vibraResource); - resourceSet->delResource(AudioPlaybackType); - - bool setDoesNotContainAudioResource = !resourceSet->contains(AudioPlaybackType); - QVERIFY(setDoesNotContainAudioResource); - QVERIFY(resourceSet->contains(VibraType)); -} - -void TestResourceSet::testContainsSingle() -{ - QList resources; - - resources << audioResource << videoResource << audioRecorderResource; - resourceSet->addResources(resources); - QList resourcesInSet = resourceSet->resources(); - - bool containsVideoPlayback = resourceSet->contains(VideoPlaybackType); - QVERIFY(containsVideoPlayback); -} - -void TestResourceSet::testDoesNotContainSingle() -{ - QList resources; - - resources << audioResource << videoResource; - resourceSet->addResources(resources); - QList resourcesInSet = resourceSet->resources(); - - bool doesNotContainVideoRecorder = !resourceSet->contains(VideoRecorderType); - QVERIFY(doesNotContainVideoRecorder); -} - - -void TestResourceSet::testContainsSet() -{ - QList types, subset; - QList resources; - - types << AudioPlaybackType << VideoPlaybackType - << AudioRecorderType << VideoRecorderType << LensCoverType; - subset << AudioPlaybackType << VideoPlaybackType << LensCoverType; - - resources << audioResource << videoResource - << audioRecorderResource << videoRecorderResource << lensCoverResource; - - resourceSet->addResources(resources); - - bool containsAll = resourceSet->contains(types); - bool containsSubset = resourceSet->contains(subset); - QVERIFY(containsAll); - QVERIFY(containsSubset); -} -QTEST_MAIN(TestResourceSet) - diff --git a/tests/test-resource-set.h b/tests/test-resource-set.h deleted file mode 100644 index 0a3eeef..0000000 --- a/tests/test-resource-set.h +++ /dev/null @@ -1,50 +0,0 @@ -#ifndef TEST_RESOURCE_SET_H -#define TEST_RESOURCE_SET_H - -#include -#include "resource-set.h" - -using namespace ResourcePolicy; - -class TestResourceSet: public QObject -{ - Q_OBJECT -private: - ResourceSet *resourceSet; - - AudioResource *audioResource; - AudioRecorderResource *audioRecorderResource; - Resource *videoResource; - Resource *videoRecorderResource; - Resource *vibraResource; - Resource *ledsResource; - Resource *backlightResource; - Resource *systemButtonResource; - Resource *lockButtonResource; - Resource *scaleButtonResource; - Resource *snapButtonResource; - Resource *lensCoverResource; - - Resource * resourceFromType(ResourceType type); -public: - TestResourceSet(); - ~TestResourceSet(); - - -private slots: - - void init(); - void cleanup(); - - void testIdentifier(); - - void testAddResource(); - void testAddResources(); - void testDelResource(); - - void testContainsSingle(); - void testDoesNotContainSingle(); - void testContainsSet(); -}; - -#endif diff --git a/tests/test-resource-set.pro b/tests/test-resource-set.pro deleted file mode 100644 index ad6d90d..0000000 --- a/tests/test-resource-set.pro +++ /dev/null @@ -1,21 +0,0 @@ -BASE = .. -TEMPLATE = app -TARGET = test-resource-set -DESTDIR = build -DEPENDPATH += $${BASE}/include $${BASE}/src . -INCLUDEPATH += $${BASE}/src $${BASE}/include - -# Input -HEADERS += $${BASE}/include/resources.h $${BASE}/include/resource-set.h test-resource-set.h -SOURCES += $${BASE}/src/resource.cpp $${BASE}/src/resources.cpp $${BASE}/src/resource-set.cpp test-resource-set.cpp - -OBJECTS_DIR = build -MOC_DIR = build - -CONFIG += qt qtestlib debug warn_on -QT -= gui - -# Install directives -INSTALLBASE = /usr -target.path = $$INSTALLBASE/share/libresourceqt/tests -INSTALLS = target diff --git a/tests/test-resource-set/test-resource-set.cpp b/tests/test-resource-set/test-resource-set.cpp new file mode 100644 index 0000000..e9ee74b --- /dev/null +++ b/tests/test-resource-set/test-resource-set.cpp @@ -0,0 +1,172 @@ +#include "test-resource-set.h" + +Resource * TestResourceSet::resourceFromType(ResourceType type) +{ + switch(type) { + case AudioPlaybackType: + return audioResource; + case AudioRecorderType: + return audioRecorderResource; + case VideoPlaybackType: + return videoResource; + case VideoRecorderType: + return videoRecorderResource; + case VibraType: + return vibraResource; + case LedsType: + return ledsResource; + case BacklightType: + return backlightResource; + case SystemButtonType: + return systemButtonResource; + case LockButtonType: + return lockButtonResource; + case ScaleButtonType: + return scaleButtonResource; + case SnapButtonType: + return snapButtonResource; + case LensCoverType: + return lensCoverResource; + default: + return NULL; + } +} + +using namespace ResourcePolicy; + +TestResourceSet::TestResourceSet() +{ + audioResource = new AudioResource; + audioRecorderResource = new AudioRecorderResource; + videoResource = new VideoResource; + videoRecorderResource = new VideoRecorderResource; + vibraResource = new VibraResource; + ledsResource = new LedsResource; + backlightResource = new BacklightResource; + systemButtonResource = new SystemButtonResource; + lockButtonResource = new LockButtonResource; + scaleButtonResource = new ScaleButtonResource; + snapButtonResource = new SnapButtonResource; + lensCoverResource = new LensCoverResource; +} + +TestResourceSet::~TestResourceSet() +{ + delete audioResource; + delete audioRecorderResource; + delete videoResource; + delete videoRecorderResource; + delete vibraResource; + delete ledsResource; + delete backlightResource; + delete systemButtonResource; + delete lockButtonResource; + delete scaleButtonResource; + delete snapButtonResource; + delete lensCoverResource; +} + +void TestResourceSet::init() +{ + resourceSet = new ResourceSet("player"); +} + +void TestResourceSet::cleanup() +{ + delete resourceSet; +} + +void TestResourceSet::testIdentifier() +{ + ResourceSet otherSet("game"); + + bool identifiersAreUnique = (resourceSet->id() != otherSet.id()); + QVERIFY(identifiersAreUnique); + QVERIFY(resourceSet->id() == (quint32)resourceSet); + QVERIFY(otherSet.id() == (quint32)&otherSet); +} + +void TestResourceSet::testAddResource() +{ + for(int i=0;iaddResource(resource); + bool setContainsGivenResource = resourceSet->contains(type); + QVERIFY(setContainsGivenResource); + } +} + +void TestResourceSet::testAddResources() +{ + resourceSet->addResource(audioResource); + + bool setContainsAudioResource = resourceSet->contains(AudioPlaybackType); + QVERIFY(setContainsAudioResource); + QList resources; + + resources << audioResource << videoResource; + + resourceSet->addResources(resources); + + QVERIFY(resourceSet->contains(AudioPlaybackType)); + QVERIFY(resourceSet->contains(VideoPlaybackType)); +} + +void TestResourceSet::testDelResource() +{ + resourceSet->addResource(audioResource); + resourceSet->addResource(vibraResource); + resourceSet->delResource(AudioPlaybackType); + + bool setDoesNotContainAudioResource = !resourceSet->contains(AudioPlaybackType); + QVERIFY(setDoesNotContainAudioResource); + QVERIFY(resourceSet->contains(VibraType)); +} + +void TestResourceSet::testContainsSingle() +{ + QList resources; + + resources << audioResource << videoResource << audioRecorderResource; + resourceSet->addResources(resources); + QList resourcesInSet = resourceSet->resources(); + + bool containsVideoPlayback = resourceSet->contains(VideoPlaybackType); + QVERIFY(containsVideoPlayback); +} + +void TestResourceSet::testDoesNotContainSingle() +{ + QList resources; + + resources << audioResource << videoResource; + resourceSet->addResources(resources); + QList resourcesInSet = resourceSet->resources(); + + bool doesNotContainVideoRecorder = !resourceSet->contains(VideoRecorderType); + QVERIFY(doesNotContainVideoRecorder); +} + + +void TestResourceSet::testContainsSet() +{ + QList types, subset; + QList resources; + + types << AudioPlaybackType << VideoPlaybackType + << AudioRecorderType << VideoRecorderType << LensCoverType; + subset << AudioPlaybackType << VideoPlaybackType << LensCoverType; + + resources << audioResource << videoResource + << audioRecorderResource << videoRecorderResource << lensCoverResource; + + resourceSet->addResources(resources); + + bool containsAll = resourceSet->contains(types); + bool containsSubset = resourceSet->contains(subset); + QVERIFY(containsAll); + QVERIFY(containsSubset); +} +QTEST_MAIN(TestResourceSet) + diff --git a/tests/test-resource-set/test-resource-set.h b/tests/test-resource-set/test-resource-set.h new file mode 100644 index 0000000..0a3eeef --- /dev/null +++ b/tests/test-resource-set/test-resource-set.h @@ -0,0 +1,50 @@ +#ifndef TEST_RESOURCE_SET_H +#define TEST_RESOURCE_SET_H + +#include +#include "resource-set.h" + +using namespace ResourcePolicy; + +class TestResourceSet: public QObject +{ + Q_OBJECT +private: + ResourceSet *resourceSet; + + AudioResource *audioResource; + AudioRecorderResource *audioRecorderResource; + Resource *videoResource; + Resource *videoRecorderResource; + Resource *vibraResource; + Resource *ledsResource; + Resource *backlightResource; + Resource *systemButtonResource; + Resource *lockButtonResource; + Resource *scaleButtonResource; + Resource *snapButtonResource; + Resource *lensCoverResource; + + Resource * resourceFromType(ResourceType type); +public: + TestResourceSet(); + ~TestResourceSet(); + + +private slots: + + void init(); + void cleanup(); + + void testIdentifier(); + + void testAddResource(); + void testAddResources(); + void testDelResource(); + + void testContainsSingle(); + void testDoesNotContainSingle(); + void testContainsSet(); +}; + +#endif diff --git a/tests/test-resource-set/test-resource-set.pro b/tests/test-resource-set/test-resource-set.pro new file mode 100644 index 0000000..ad6d90d --- /dev/null +++ b/tests/test-resource-set/test-resource-set.pro @@ -0,0 +1,21 @@ +BASE = .. +TEMPLATE = app +TARGET = test-resource-set +DESTDIR = build +DEPENDPATH += $${BASE}/include $${BASE}/src . +INCLUDEPATH += $${BASE}/src $${BASE}/include + +# Input +HEADERS += $${BASE}/include/resources.h $${BASE}/include/resource-set.h test-resource-set.h +SOURCES += $${BASE}/src/resource.cpp $${BASE}/src/resources.cpp $${BASE}/src/resource-set.cpp test-resource-set.cpp + +OBJECTS_DIR = build +MOC_DIR = build + +CONFIG += qt qtestlib debug warn_on +QT -= gui + +# Install directives +INSTALLBASE = /usr +target.path = $$INSTALLBASE/share/libresourceqt/tests +INSTALLS = target diff --git a/tests/test-resource.cpp b/tests/test-resource.cpp deleted file mode 100644 index 2098a88..0000000 --- a/tests/test-resource.cpp +++ /dev/null @@ -1,281 +0,0 @@ -#include "test-resource.h" -#include - -using namespace ResourcePolicy; - -Resource * TestResource::resourceFromType(ResourceType type) -{ - switch(type) { - case AudioPlaybackType: - return audioResource; - case AudioRecorderType: - return audioRecorderResource; - case VideoPlaybackType: - return videoResource; - case VideoRecorderType: - return videoRecorderResource; - case VibraType: - return vibraResource; - case LedsType: - return ledsResource; - case BacklightType: - return backlightResource; - case SystemButtonType: - return systemButtonResource; - case LockButtonType: - return lockButtonResource; - case ScaleButtonType: - return scaleButtonResource; - case SnapButtonType: - return snapButtonResource; - case LensCoverType: - return lensCoverResource; - default: - return NULL; - } -} - -const char * TestResource::stringFromType(ResourceType type) -{ - switch(type) { - case AudioPlaybackType: - return "AudioPlaybackType"; - case AudioRecorderType: - return "AudioRecorderType"; - case VideoPlaybackType: - return "VideoPlaybackType"; - case VideoRecorderType: - return "VideoRecorderType"; - case VibraType: - return "VibraType"; - case LedsType: - return "LedsType"; - case BacklightType: - return "BacklightType"; - case SystemButtonType: - return "SystemButtonType"; - case LockButtonType: - return "LockButtonType"; - case ScaleButtonType: - return "ScaleButtonType"; - case SnapButtonType: - return "SnapButtonType"; - case LensCoverType: - return "LensCoverType"; - default: - qDebug("Unknown Type 0x%02x requested", type); - return NULL; - } -} - -TestResource::TestResource() -{ -} - -TestResource::~TestResource() -{ -} - -void TestResource::init() -{ - audioResource = new AudioResource; - audioRecorderResource = new AudioRecorderResource; - videoResource = new VideoResource; - videoRecorderResource = new VideoRecorderResource; - vibraResource = new VibraResource; - ledsResource = new LedsResource; - backlightResource = new BacklightResource; - systemButtonResource = new SystemButtonResource; - lockButtonResource = new LockButtonResource; - scaleButtonResource = new ScaleButtonResource; - snapButtonResource = new SnapButtonResource; - lensCoverResource = new LensCoverResource; -} - -void TestResource::cleanup() -{ - delete audioResource; - delete audioRecorderResource; - delete videoResource; - delete videoRecorderResource; - delete vibraResource; - delete ledsResource; - delete backlightResource; - delete systemButtonResource; - delete lockButtonResource; - delete scaleButtonResource; - delete snapButtonResource; - delete lensCoverResource; -} - -void TestResource::testType() -{ - for(quint32 type=AudioPlaybackType; type < NumberOfTypes; type++) { - ResourceType expected = (ResourceType)type; - Resource *resource = resourceFromType(expected); - if(resource->type() != expected) { - qDebug("expected ResourceType = %s, got %s", - stringFromType(expected), stringFromType(resource->type())); - } - QVERIFY(resource->type() == expected); - } -} - -void TestResource::testOptional_data() -{ - QTest::addColumn("type"); - QTest::addColumn("optional"); - QTest::addColumn("expected"); - - QTest::newRow("Resource is optional") << AudioPlaybackType << true << true; - QTest::newRow("Resource is not optional") << AudioPlaybackType << false << false; - QTest::newRow("Resource is optional") << AudioRecorderType << true << true; - QTest::newRow("Resource is not optional") << AudioRecorderType << false << false; - QTest::newRow("Resource is optional") << VideoPlaybackType << true << true; - QTest::newRow("Resource is not optional") << VideoPlaybackType << false << false; - QTest::newRow("Resource is optional") << VideoRecorderType << true << true; - QTest::newRow("Resource is not optional") << VideoRecorderType << false << false; - QTest::newRow("Resource is optional") << VibraType << true << true; - QTest::newRow("Resource is not optional") << VibraType<< false << false; - QTest::newRow("Resource is optional") << BacklightType << true << true; - QTest::newRow("Resource is not optional") << BacklightType << false << false; - QTest::newRow("Resource is optional") << SystemButtonType << true << true; - QTest::newRow("Resource is not optional") << SystemButtonType << false << false; - QTest::newRow("Resource is optional") << LedsType << true << true; - QTest::newRow("Resource is not optional") << LedsType << false << false; - QTest::newRow("Resource is optional") << LockButtonType << true << true; - QTest::newRow("Resource is not optional") << LockButtonType << false << false; - QTest::newRow("Resource is optional") << ScaleButtonType << true << true; - QTest::newRow("Resource is not optional") << ScaleButtonType << false << false; - QTest::newRow("Resource is optional") << SnapButtonType << true << true; - QTest::newRow("Resource is not optional") << SnapButtonType << false << false; - QTest::newRow("Resource is optional") << LensCoverType << true << true; - QTest::newRow("Resource is not optional") << LensCoverType << false << false; -} - -void TestResource::testOptional() -{ - QFETCH(ResourceType, type); - QFETCH(bool, optional); - QFETCH(bool, expected); - - Resource *resource = resourceFromType(type); - - resource->setOptional(optional); - bool result = resource->isOptional(); - - QVERIFY(result == expected); -} - -void TestResource::testShared_data() -{ - QTest::addColumn("type"); - QTest::addColumn("shared"); - QTest::addColumn("expected"); - - QTest::newRow("Resource is shared") << AudioPlaybackType << true << true; - QTest::newRow("Resource is not shared") << AudioPlaybackType << false << false; - QTest::newRow("Resource is shared") << AudioRecorderType << true << true; - QTest::newRow("Resource is not shared") << AudioRecorderType << false << false; - QTest::newRow("Resource is shared") << VideoPlaybackType << true << true; - QTest::newRow("Resource is not shared") << VideoPlaybackType << false << false; - QTest::newRow("Resource is shared") << VideoRecorderType << true << true; - QTest::newRow("Resource is not shared") << VideoRecorderType << false << false; - QTest::newRow("Resource is shared") << VibraType << true << true; - QTest::newRow("Resource is not shared") << VibraType<< false << false; - QTest::newRow("Resource is shared") << BacklightType << true << true; - QTest::newRow("Resource is not shared") << BacklightType << false << false; - QTest::newRow("Resource is shared") << SystemButtonType << true << true; - QTest::newRow("Resource is not shared") << SystemButtonType << false << false; - QTest::newRow("Resource is shared") << LedsType << true << true; - QTest::newRow("Resource is not shared") << LedsType << false << false; - QTest::newRow("Resource is shared") << LockButtonType << true << true; - QTest::newRow("Resource is not shared") << LockButtonType << false << false; - QTest::newRow("Resource is shared") << ScaleButtonType << true << true; - QTest::newRow("Resource is not shared") << ScaleButtonType << false << false; - QTest::newRow("Resource is shared") << SnapButtonType << true << true; - QTest::newRow("Resource is not shared") << SnapButtonType << false << false; - QTest::newRow("Resource is shared") << LensCoverType << true << true; - QTest::newRow("Resource is not shared") << LensCoverType << false << false; -} - -void TestResource::testShared() -{ - QFETCH(ResourceType, type); - QFETCH(bool, shared); - QFETCH(bool, expected); - - Resource *resource = resourceFromType(type); - resource->setShared(shared); - - bool result = resource->isShared(); - - QCOMPARE(result, expected); -} - -void TestResource::testGranted_data() -{ - QTest::addColumn("type"); - QTest::addColumn("granted"); - QTest::addColumn("expected"); - - QTest::newRow("Resource is granted") << AudioPlaybackType << true << true; - QTest::newRow("Resource is denied") << AudioPlaybackType << false << false; - QTest::newRow("Resource is granted") << AudioRecorderType << true << true; - QTest::newRow("Resource is denied") << AudioRecorderType << false << false; - QTest::newRow("Resource is granted") << VideoPlaybackType << true << true; - QTest::newRow("Resource is denied") << VideoPlaybackType << false << false; - QTest::newRow("Resource is granted") << VideoRecorderType << true << true; - QTest::newRow("Resource is denied") << VideoRecorderType << false << false; - QTest::newRow("Resource is granted") << VibraType << true << true; - QTest::newRow("Resource is denied") << VibraType<< false << false; - QTest::newRow("Resource is granted") << BacklightType << true << true; - QTest::newRow("Resource is denied") << BacklightType << false << false; - QTest::newRow("Resource is granted") << SystemButtonType << true << true; - QTest::newRow("Resource is denied") << SystemButtonType << false << false; - QTest::newRow("Resource is granted") << LedsType << true << true; - QTest::newRow("Resource is denied") << LedsType << false << false; - QTest::newRow("Resource is granted") << LockButtonType << true << true; - QTest::newRow("Resource is denied") << LockButtonType << false << false; - QTest::newRow("Resource is granted") << ScaleButtonType << true << true; - QTest::newRow("Resource is denied") << ScaleButtonType << false << false; - QTest::newRow("Resource is granted") << SnapButtonType << true << true; - QTest::newRow("Resource is denied") << SnapButtonType << false << false; - QTest::newRow("Resource is granted") << LensCoverType << true << true; - QTest::newRow("Resource is denied") << LensCoverType << false << false; -} - -void TestResource::testGranted() -{ - QFETCH(ResourceType, type); - QFETCH(bool, granted); - QFETCH(bool, expected); - - Resource *resource = resourceFromType(type); - - if(granted) - resource->setGranted(); - else - resource->unsetGranted(); - bool result = resource->isGranted(); - - QVERIFY(result == expected); -} - -void TestResource::testClone() -{ - for(quint32 type=AudioPlaybackType; type < NumberOfTypes; type++) { - Resource *resource = resourceFromType((ResourceType)type); - resource->setOptional(); - Resource *copy = resource->clone(); - - QCOMPARE(copy->isOptional(), resource->isOptional()); - QCOMPARE(copy->isShared(), resource->isShared()); - QCOMPARE(copy->isGranted(), resource->isGranted()); - QCOMPARE(copy->type(), resource->type()); - delete copy; - } -} - -QTEST_MAIN(TestResource) - diff --git a/tests/test-resource.h b/tests/test-resource.h deleted file mode 100644 index fc04c47..0000000 --- a/tests/test-resource.h +++ /dev/null @@ -1,54 +0,0 @@ -#ifndef TEST_RESOURCE_H -#define TEST_RESOURCE_H - -#include -#include -#include "resources.h" - -Q_DECLARE_METATYPE(ResourcePolicy::ResourceType) - -using namespace ResourcePolicy; - -class TestResource: public QObject -{ - Q_OBJECT -private: - AudioResource *audioResource; - AudioRecorderResource *audioRecorderResource; - Resource *videoResource; - Resource *videoRecorderResource; - Resource *vibraResource; - Resource *ledsResource; - Resource *backlightResource; - Resource *systemButtonResource; - Resource *lockButtonResource; - Resource *scaleButtonResource; - Resource *snapButtonResource; - Resource *lensCoverResource; - - Resource * resourceFromType(ResourceType type); - const char * stringFromType(ResourceType type); -public: - TestResource(); - ~TestResource(); - -private slots: - - void init(); - void cleanup(); - - void testType(); - - void testOptional_data(); - void testOptional(); - - void testShared_data(); - void testShared(); - - void testGranted_data(); - void testGranted(); - - void testClone(); -}; - -#endif diff --git a/tests/test-resource.pro b/tests/test-resource.pro deleted file mode 100644 index 7ab2678..0000000 --- a/tests/test-resource.pro +++ /dev/null @@ -1,21 +0,0 @@ -BASE = .. -TEMPLATE = app -TARGET = test-resource -DESTDIR = build -DEPENDPATH += $${BASE}/include $${BASE}/src . -INCLUDEPATH += $${BASE}/src $${BASE}/include - -# Input -HEADERS += $${BASE}/include/resource.h $${BASE}/include/resources.h test-resource.h -SOURCES += $${BASE}/src/resource.cpp $${BASE}/src/resources.cpp test-resource.cpp - -OBJECTS_DIR = build -MOC_DIR = build - -CONFIG += qt qtestlib debug warn_on -QT -= gui - -# Install directives -INSTALLBASE = /usr -target.path = $$INSTALLBASE/share/libresourceqt/tests -INSTALLS = target diff --git a/tests/test-resource/test-resource.cpp b/tests/test-resource/test-resource.cpp new file mode 100644 index 0000000..2098a88 --- /dev/null +++ b/tests/test-resource/test-resource.cpp @@ -0,0 +1,281 @@ +#include "test-resource.h" +#include + +using namespace ResourcePolicy; + +Resource * TestResource::resourceFromType(ResourceType type) +{ + switch(type) { + case AudioPlaybackType: + return audioResource; + case AudioRecorderType: + return audioRecorderResource; + case VideoPlaybackType: + return videoResource; + case VideoRecorderType: + return videoRecorderResource; + case VibraType: + return vibraResource; + case LedsType: + return ledsResource; + case BacklightType: + return backlightResource; + case SystemButtonType: + return systemButtonResource; + case LockButtonType: + return lockButtonResource; + case ScaleButtonType: + return scaleButtonResource; + case SnapButtonType: + return snapButtonResource; + case LensCoverType: + return lensCoverResource; + default: + return NULL; + } +} + +const char * TestResource::stringFromType(ResourceType type) +{ + switch(type) { + case AudioPlaybackType: + return "AudioPlaybackType"; + case AudioRecorderType: + return "AudioRecorderType"; + case VideoPlaybackType: + return "VideoPlaybackType"; + case VideoRecorderType: + return "VideoRecorderType"; + case VibraType: + return "VibraType"; + case LedsType: + return "LedsType"; + case BacklightType: + return "BacklightType"; + case SystemButtonType: + return "SystemButtonType"; + case LockButtonType: + return "LockButtonType"; + case ScaleButtonType: + return "ScaleButtonType"; + case SnapButtonType: + return "SnapButtonType"; + case LensCoverType: + return "LensCoverType"; + default: + qDebug("Unknown Type 0x%02x requested", type); + return NULL; + } +} + +TestResource::TestResource() +{ +} + +TestResource::~TestResource() +{ +} + +void TestResource::init() +{ + audioResource = new AudioResource; + audioRecorderResource = new AudioRecorderResource; + videoResource = new VideoResource; + videoRecorderResource = new VideoRecorderResource; + vibraResource = new VibraResource; + ledsResource = new LedsResource; + backlightResource = new BacklightResource; + systemButtonResource = new SystemButtonResource; + lockButtonResource = new LockButtonResource; + scaleButtonResource = new ScaleButtonResource; + snapButtonResource = new SnapButtonResource; + lensCoverResource = new LensCoverResource; +} + +void TestResource::cleanup() +{ + delete audioResource; + delete audioRecorderResource; + delete videoResource; + delete videoRecorderResource; + delete vibraResource; + delete ledsResource; + delete backlightResource; + delete systemButtonResource; + delete lockButtonResource; + delete scaleButtonResource; + delete snapButtonResource; + delete lensCoverResource; +} + +void TestResource::testType() +{ + for(quint32 type=AudioPlaybackType; type < NumberOfTypes; type++) { + ResourceType expected = (ResourceType)type; + Resource *resource = resourceFromType(expected); + if(resource->type() != expected) { + qDebug("expected ResourceType = %s, got %s", + stringFromType(expected), stringFromType(resource->type())); + } + QVERIFY(resource->type() == expected); + } +} + +void TestResource::testOptional_data() +{ + QTest::addColumn("type"); + QTest::addColumn("optional"); + QTest::addColumn("expected"); + + QTest::newRow("Resource is optional") << AudioPlaybackType << true << true; + QTest::newRow("Resource is not optional") << AudioPlaybackType << false << false; + QTest::newRow("Resource is optional") << AudioRecorderType << true << true; + QTest::newRow("Resource is not optional") << AudioRecorderType << false << false; + QTest::newRow("Resource is optional") << VideoPlaybackType << true << true; + QTest::newRow("Resource is not optional") << VideoPlaybackType << false << false; + QTest::newRow("Resource is optional") << VideoRecorderType << true << true; + QTest::newRow("Resource is not optional") << VideoRecorderType << false << false; + QTest::newRow("Resource is optional") << VibraType << true << true; + QTest::newRow("Resource is not optional") << VibraType<< false << false; + QTest::newRow("Resource is optional") << BacklightType << true << true; + QTest::newRow("Resource is not optional") << BacklightType << false << false; + QTest::newRow("Resource is optional") << SystemButtonType << true << true; + QTest::newRow("Resource is not optional") << SystemButtonType << false << false; + QTest::newRow("Resource is optional") << LedsType << true << true; + QTest::newRow("Resource is not optional") << LedsType << false << false; + QTest::newRow("Resource is optional") << LockButtonType << true << true; + QTest::newRow("Resource is not optional") << LockButtonType << false << false; + QTest::newRow("Resource is optional") << ScaleButtonType << true << true; + QTest::newRow("Resource is not optional") << ScaleButtonType << false << false; + QTest::newRow("Resource is optional") << SnapButtonType << true << true; + QTest::newRow("Resource is not optional") << SnapButtonType << false << false; + QTest::newRow("Resource is optional") << LensCoverType << true << true; + QTest::newRow("Resource is not optional") << LensCoverType << false << false; +} + +void TestResource::testOptional() +{ + QFETCH(ResourceType, type); + QFETCH(bool, optional); + QFETCH(bool, expected); + + Resource *resource = resourceFromType(type); + + resource->setOptional(optional); + bool result = resource->isOptional(); + + QVERIFY(result == expected); +} + +void TestResource::testShared_data() +{ + QTest::addColumn("type"); + QTest::addColumn("shared"); + QTest::addColumn("expected"); + + QTest::newRow("Resource is shared") << AudioPlaybackType << true << true; + QTest::newRow("Resource is not shared") << AudioPlaybackType << false << false; + QTest::newRow("Resource is shared") << AudioRecorderType << true << true; + QTest::newRow("Resource is not shared") << AudioRecorderType << false << false; + QTest::newRow("Resource is shared") << VideoPlaybackType << true << true; + QTest::newRow("Resource is not shared") << VideoPlaybackType << false << false; + QTest::newRow("Resource is shared") << VideoRecorderType << true << true; + QTest::newRow("Resource is not shared") << VideoRecorderType << false << false; + QTest::newRow("Resource is shared") << VibraType << true << true; + QTest::newRow("Resource is not shared") << VibraType<< false << false; + QTest::newRow("Resource is shared") << BacklightType << true << true; + QTest::newRow("Resource is not shared") << BacklightType << false << false; + QTest::newRow("Resource is shared") << SystemButtonType << true << true; + QTest::newRow("Resource is not shared") << SystemButtonType << false << false; + QTest::newRow("Resource is shared") << LedsType << true << true; + QTest::newRow("Resource is not shared") << LedsType << false << false; + QTest::newRow("Resource is shared") << LockButtonType << true << true; + QTest::newRow("Resource is not shared") << LockButtonType << false << false; + QTest::newRow("Resource is shared") << ScaleButtonType << true << true; + QTest::newRow("Resource is not shared") << ScaleButtonType << false << false; + QTest::newRow("Resource is shared") << SnapButtonType << true << true; + QTest::newRow("Resource is not shared") << SnapButtonType << false << false; + QTest::newRow("Resource is shared") << LensCoverType << true << true; + QTest::newRow("Resource is not shared") << LensCoverType << false << false; +} + +void TestResource::testShared() +{ + QFETCH(ResourceType, type); + QFETCH(bool, shared); + QFETCH(bool, expected); + + Resource *resource = resourceFromType(type); + resource->setShared(shared); + + bool result = resource->isShared(); + + QCOMPARE(result, expected); +} + +void TestResource::testGranted_data() +{ + QTest::addColumn("type"); + QTest::addColumn("granted"); + QTest::addColumn("expected"); + + QTest::newRow("Resource is granted") << AudioPlaybackType << true << true; + QTest::newRow("Resource is denied") << AudioPlaybackType << false << false; + QTest::newRow("Resource is granted") << AudioRecorderType << true << true; + QTest::newRow("Resource is denied") << AudioRecorderType << false << false; + QTest::newRow("Resource is granted") << VideoPlaybackType << true << true; + QTest::newRow("Resource is denied") << VideoPlaybackType << false << false; + QTest::newRow("Resource is granted") << VideoRecorderType << true << true; + QTest::newRow("Resource is denied") << VideoRecorderType << false << false; + QTest::newRow("Resource is granted") << VibraType << true << true; + QTest::newRow("Resource is denied") << VibraType<< false << false; + QTest::newRow("Resource is granted") << BacklightType << true << true; + QTest::newRow("Resource is denied") << BacklightType << false << false; + QTest::newRow("Resource is granted") << SystemButtonType << true << true; + QTest::newRow("Resource is denied") << SystemButtonType << false << false; + QTest::newRow("Resource is granted") << LedsType << true << true; + QTest::newRow("Resource is denied") << LedsType << false << false; + QTest::newRow("Resource is granted") << LockButtonType << true << true; + QTest::newRow("Resource is denied") << LockButtonType << false << false; + QTest::newRow("Resource is granted") << ScaleButtonType << true << true; + QTest::newRow("Resource is denied") << ScaleButtonType << false << false; + QTest::newRow("Resource is granted") << SnapButtonType << true << true; + QTest::newRow("Resource is denied") << SnapButtonType << false << false; + QTest::newRow("Resource is granted") << LensCoverType << true << true; + QTest::newRow("Resource is denied") << LensCoverType << false << false; +} + +void TestResource::testGranted() +{ + QFETCH(ResourceType, type); + QFETCH(bool, granted); + QFETCH(bool, expected); + + Resource *resource = resourceFromType(type); + + if(granted) + resource->setGranted(); + else + resource->unsetGranted(); + bool result = resource->isGranted(); + + QVERIFY(result == expected); +} + +void TestResource::testClone() +{ + for(quint32 type=AudioPlaybackType; type < NumberOfTypes; type++) { + Resource *resource = resourceFromType((ResourceType)type); + resource->setOptional(); + Resource *copy = resource->clone(); + + QCOMPARE(copy->isOptional(), resource->isOptional()); + QCOMPARE(copy->isShared(), resource->isShared()); + QCOMPARE(copy->isGranted(), resource->isGranted()); + QCOMPARE(copy->type(), resource->type()); + delete copy; + } +} + +QTEST_MAIN(TestResource) + diff --git a/tests/test-resource/test-resource.h b/tests/test-resource/test-resource.h new file mode 100644 index 0000000..fc04c47 --- /dev/null +++ b/tests/test-resource/test-resource.h @@ -0,0 +1,54 @@ +#ifndef TEST_RESOURCE_H +#define TEST_RESOURCE_H + +#include +#include +#include "resources.h" + +Q_DECLARE_METATYPE(ResourcePolicy::ResourceType) + +using namespace ResourcePolicy; + +class TestResource: public QObject +{ + Q_OBJECT +private: + AudioResource *audioResource; + AudioRecorderResource *audioRecorderResource; + Resource *videoResource; + Resource *videoRecorderResource; + Resource *vibraResource; + Resource *ledsResource; + Resource *backlightResource; + Resource *systemButtonResource; + Resource *lockButtonResource; + Resource *scaleButtonResource; + Resource *snapButtonResource; + Resource *lensCoverResource; + + Resource * resourceFromType(ResourceType type); + const char * stringFromType(ResourceType type); +public: + TestResource(); + ~TestResource(); + +private slots: + + void init(); + void cleanup(); + + void testType(); + + void testOptional_data(); + void testOptional(); + + void testShared_data(); + void testShared(); + + void testGranted_data(); + void testGranted(); + + void testClone(); +}; + +#endif diff --git a/tests/test-resource/test-resource.pro b/tests/test-resource/test-resource.pro new file mode 100644 index 0000000..7ab2678 --- /dev/null +++ b/tests/test-resource/test-resource.pro @@ -0,0 +1,21 @@ +BASE = .. +TEMPLATE = app +TARGET = test-resource +DESTDIR = build +DEPENDPATH += $${BASE}/include $${BASE}/src . +INCLUDEPATH += $${BASE}/src $${BASE}/include + +# Input +HEADERS += $${BASE}/include/resource.h $${BASE}/include/resources.h test-resource.h +SOURCES += $${BASE}/src/resource.cpp $${BASE}/src/resources.cpp test-resource.cpp + +OBJECTS_DIR = build +MOC_DIR = build + +CONFIG += qt qtestlib debug warn_on +QT -= gui + +# Install directives +INSTALLBASE = /usr +target.path = $$INSTALLBASE/share/libresourceqt/tests +INSTALLS = target -- cgit v1.2.3