./ 0000755 0000041 0000041 00000000000 12752376103 011251 5 ustar www-data www-data ./doc/ 0000755 0000041 0000041 00000000000 12752376103 012016 5 ustar www-data www-data ./doc/Makefile.am 0000644 0000041 0000041 00000002213 12752376103 014050 0 ustar www-data www-data ##
## Makefile for the doc subdirectory of libgeis
##
## Copyright (C) 2010 Canonical Ltd.
##
## Process this file with automake to produce Makefile.in.
##
## This file is part of the libgeis project. This library is free
## software; you can redistribute it and/or modify it under the
## terms of the GNU General Public License as published by the
## Free Software Foundation; either version 3, or (at your option)
## any later version.
##
## This library is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License along
## with this library; see the file COPYING3. If not see
## .
##
api/html:
mkdir -p api/html
doc-html: doc-html-doxygen
doc-man: doc-man-doxygen
doc-html-doxygen:
doxygen
doc-man-doxygen:
doxygen
install-data-local: api/html
$(INSTALL) -d $(DESTDIR)$(docdir)
cp -a api/html $(DESTDIR)$(docdir)
clean-local:
-rm -rf *.html api
EXTRA_DIST = Doxyfile
./doc/Doxyfile 0000644 0000041 0000041 00000221370 12752376103 013531 0 ustar www-data www-data # Doxyfile 1.7.4
# 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 = Frame
# 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 = 2.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "A library to encapsulate touch events"
# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = api
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = "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 = NO
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
# path to strip.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
# are normally passed to the compiler using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful if your file system
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 8
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this
# tag. The format is ext=language, where ext is a file extension, and language
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also makes the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
# unions are shown inside the group in which they are included (e.g. using
# @ingroup) instead of on a separate page (for HTML and Man pages) or
# section (for LaTeX and RTF).
INLINE_GROUPED_CLASSES = 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 = YES
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penalty.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will roughly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# 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 namespaces are hidden.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
# function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = YES
# 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 = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = NO
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
# do proper type resolution of all parameters of a function it will reject a
# match between the prototype and the implementation of a member function even
# if there is only one candidate or it is obvious which candidate to choose
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
# will still accept a match between prototype and implementation in such cases.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or macro consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and macros in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = NO
# 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 = NO
# 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
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
# be obtained via FILE_VERSION_FILTER)
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = ../include/oif
# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.for \
*.vhd \
*.vhdl
# 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 file system feature) are excluded
# from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command , where
# is the value of the INPUT_FILTER tag, and is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output. If FILTER_PATTERNS is specified, this tag will be
# ignored.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty or if
# non of the patterns match the file name, INPUT_FILTER is applied.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
# and it is also possible to disable source filtering for a specific pattern
# using *.ext= (so without naming a filter). This option only has effect when
# FILTER_SOURCE_FILES is enabled.
FILTER_SOURCE_PATTERNS =
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = 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 = NO
#---------------------------------------------------------------------------
# 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. Note that when using a custom header you are responsible
# for the proper inclusion of any scripts and style sheets that doxygen
# needs, which is dependent on the configuration options used.
# It is adviced to generate a default header using "doxygen -w html
# header.html footer.html stylesheet.css YourConfigFile" and then modify
# that header. Note that the header is subject to change so you typically
# have to redo this when upgrading to a newer version of doxygen or when
# changing the value of configuration settings such as GENERATE_TREEVIEW!
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# 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 =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
# the files will be copied as-is; there are no commands or markers available.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
# The allowed range is 0 to 359.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
# the colors in the HTML output. For a value of 0 the output will use
# grayscales only. A value of 255 will produce the most vivid colors.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
# the luminance component of the colors in the HTML output. Values below
# 100 gradually make the output lighter, whereas values above 100 make
# the output darker. The value divided by 100 is the actual gamma applied,
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
HTML_TIMESTAMP = YES
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output directory.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
# that can be used as input for Qt's qhelpgenerator to generate a
# Qt Compressed Help (.qch) of the generated HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# add. For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see
#
# Qt Help Project / Custom Filters.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's
# filter section matches.
#
# Qt Help Project / Filter Attributes.
QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
# will be generated, which together with the HTML files, form an Eclipse help
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
# the help appears.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.
ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
# documentation. Note that a value of 0 will completely suppress the enum
# values from appearing in the overview section.
ENUM_VALUES_PER_LINE = 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 YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = YES
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = YES
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are
# not supported properly for IE 6.0, but are supported on all modern browsers.
# Note that when changing this option you need to delete any form_*.png files
# in the HTML output before the changes have effect.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
# (see http://www.mathjax.org) which uses client side Javascript for the
# rendering instead of using prerendered bitmaps. Use this if you do not
# have LaTeX installed or if you want to formulas look prettier in the HTML
# output. When enabled you also need to install MathJax separately and
# configure the path to it using the MATHJAX_RELPATH option.
USE_MATHJAX = NO
# When MathJax is enabled you need to specify the location relative to the
# HTML output directory using the MATHJAX_RELPATH option. The destination
# directory should contain the MathJax.js script. For instance, if the mathjax
# directory is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
# mathjax.org site, so you can quickly see the result without installing
# MathJax, but it is strongly recommended to install a local copy of MathJax
# before deployment.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
SEARCHENGINE = NO
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvantages are that it is more difficult to setup
# and does not have live searching capabilities.
SERVER_BASED_SEARCH = NO
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
# the generated latex document. The footer should contain everything after
# the last chapter. If it is left blank doxygen will generate a
# standard footer. Notice: only use this tag if you know what you are doing!
LATEX_FOOTER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
# such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# 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
# pointed to by INCLUDE_PATH will be searched when a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition that
# overrules the definition found in the source code.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all references to function-like macros
# that are alone on a line, have an all uppercase name, and do not end with a
# semicolon, because these will confuse the parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option also works with HAVE_DOT disabled, but it is recommended to
# install and use dot, since it yields more powerful graphs.
CLASS_DIAGRAMS = NO
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will
# base this on the number of processors available in the system. You can set it
# explicitly to a value larger than 0 to get control over the balance
# between CPU load and processing speed.
DOT_NUM_THREADS = 0
# By default doxygen will write a font called Helvetica to the output
# directory and reference it in all dot files that doxygen generates.
# When you want a differently looking font you can specify the font name
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will generate a graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are svg, png, jpg, or gif.
# If left blank png will be used.
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 MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the
# \mscfile command).
MSCFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. Warning: Depending on the platform used,
# enabling this option may lead to badly anti-aliased labels on the edges of
# a graph (i.e. they become hard to read).
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
# support this, this feature is disabled by default.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
./autogen.sh 0000755 0000041 0000041 00000000313 12752376103 013247 0 ustar www-data www-data #! /bin/sh
srcdir=`dirname $0`
test -z "$srcdir" && srcdir=.
ORIGDIR=`pwd`
cd $srcdir
autoreconf --force --install || exit 1
cd $ORIGDIR || exit $?
test -n "$NOCONFIGURE" || "$srcdir/configure" "$@"
./include/ 0000755 0000041 0000041 00000000000 12752376103 012674 5 ustar www-data www-data ./include/oif/ 0000755 0000041 0000041 00000000000 12752376103 013451 5 ustar www-data www-data ./include/oif/frame_backend.h 0000644 0000041 0000041 00000020031 12752376103 016357 0 ustar www-data www-data /**
* @file oif/frame_backend.h
* API for creating objects.
*/
#ifndef FRAME_OIF_FRAME_BACKEND_H_
#define FRAME_OIF_FRAME_BACKEND_H_
/* front end definitions */
#include
#ifdef __cplusplus
extern "C" {
#endif
/** Handle for a device to be used on the backend API */
typedef struct UFBackendDevice_* UFBackendDevice;
/** Handle for a frame to be used on the backend API */
typedef struct UFBackendFrame_* UFBackendFrame;
/** Handle for a touch to be used on the backend API */
typedef struct UFBackendTouch_* UFBackendTouch;
/********************************************************************
* Event
********************************************************************/
/**
* Creates a new event with a reference count of one.
*/
FRAME_PUBLIC
UFEvent frame_event_new();
/**
* Sets the type of the given event
*/
FRAME_PUBLIC
void frame_event_set_type(UFEvent event, UFEventType type);
/**
* Sets the device property of the given event
*
* It increases the reference count of the corresponding UFDevice by one.
*/
FRAME_PUBLIC
void frame_event_set_device(UFEvent event, UFBackendDevice device);
/**
* Sets the frame property of the given event
*
* It increases the reference count of the corresponding UFFrame by one.
*/
FRAME_PUBLIC
void frame_event_set_frame(UFEvent event, UFBackendFrame frame);
/**
* Sets the time of the given event
*/
FRAME_PUBLIC
void frame_event_set_time(UFEvent event, uint64_t time);
/********************************************************************
* Device
********************************************************************/
/**
* Creates a new UFDevice and returns its backend handle.
*/
FRAME_PUBLIC
UFBackendDevice frame_backend_device_new();
/**
* Returns a UFDevice instance given its backend handle.
*/
FRAME_PUBLIC
UFDevice frame_backend_device_get_device(UFBackendDevice device);
/**
* Sets the "Name" property of the given device
*/
FRAME_PUBLIC
void frame_backend_device_set_name(UFBackendDevice device, const char *name);
/**
* Sets the "Direct" property of the given device
*/
FRAME_PUBLIC
void frame_backend_device_set_direct(UFBackendDevice device, int direct);
/**
* Sets the "Independent" property of the given device
*/
FRAME_PUBLIC
void frame_backend_device_set_independent(UFBackendDevice device, int independent);
/**
* Sets the "SemiMT" property of the given device
*/
FRAME_PUBLIC
void frame_backend_device_set_semi_mt(UFBackendDevice device, int semi_mt);
/**
* Sets the "MaxTouches" property of the given device
*/
FRAME_PUBLIC
void frame_backend_device_set_max_touches(UFBackendDevice device, unsigned int max_touches);
/**
* Sets the "WindowResolutionX" and "WindowResolutionY" properties of the
* given device.
*/
FRAME_PUBLIC
void frame_backend_device_set_window_resolution(UFBackendDevice device, float x, float y);
/**
* Adds an axis to the device
*/
FRAME_PUBLIC
void frame_backend_device_add_axis(UFBackendDevice device,
UFAxisType type,
float min, float max, float resolution);
/**
* Deletes the backend handle of a UFDevice, decreasing its reference count by one.
*/
FRAME_PUBLIC
void frame_backend_device_delete(UFBackendDevice device);
/********************************************************************
* Frame
********************************************************************/
/**
* Creates a new, empty, UFFrame and returns its backend handle.
*
* Usually you will use this method only for the very first frame. For all
* subsequent ones it will be safer and more convinent to use
* frame_backend_frame_create_next().
*/
FRAME_PUBLIC
UFBackendFrame frame_backend_frame_new();
/**
* Creates a new UFFrame that is a continuation of the given one.
*
* Touches that had a "begin" state on the given frame will be hard-copied and
* have an "update" state on the new frame.
*
* Touches that had an "update" state will be lazily copied to the new frame.
*
* Touches that had a "end" state on the given frame won't be present
* on the new frame.
*
* The "ActiveTouches" property is automatically set to match the number
* of UFTouches present or remaining.
*/
FRAME_PUBLIC
UFBackendFrame frame_backend_frame_create_next(UFBackendFrame frame);
/**
* Returns a UFFrame instance given its backend handle.
*/
FRAME_PUBLIC
UFFrame frame_backend_frame_get_frame(UFBackendFrame frame);
/**
* Gets a UFBackendTouch for the UFTouch that has the given id.
*
* The underlying UFTouch is moved from the given frame to the returned UFBackendTouch.
* Once done modifying the touch you're expected to return it to the frame via
* frame_backend_frame_give_touch().
*
* If the underlying UFTouch is a lazy copy (likely from a touch in the previous frame), a hard copy
* will be made upon the first change made to it.
*
* Possible errors: UFStatusErrorInvalidTouch
*/
FRAME_PUBLIC
UFStatus frame_backend_frame_borrow_touch_by_id(UFBackendFrame frame,
UFTouchId id,
UFBackendTouch *touch);
/**
* Sets the "Device" property of the given frame
*/
FRAME_PUBLIC
void frame_backend_frame_set_device(UFBackendFrame frame, UFBackendDevice device);
/**
* Sets the "WindowId" property of the given frame
*/
FRAME_PUBLIC
void frame_backend_frame_set_window_id(UFBackendFrame frame, UFWindowId window_id);
/**
* Sets the "ActiveTouches" property of the given frame
*
* If unset this property returns the number of touches.
*/
FRAME_PUBLIC
void frame_backend_frame_set_active_touches(UFBackendFrame frame, unsigned int active_touches);
/**
* Gives a UFTouch to the specified frame.
*
* Gives the underlying UFTouch to the specified frame. The UFBackendTouch
* is deleted and no longer valid after this call.
*
* A frame is a snapshot of the state of all touches at a given point in time.
* Therefore it must not have multiple UFTouch instances with the same touch ID.
* Attempting to do so will result in a UFStatusErrorTouchIdExists being returned.
*
* Possible errors: UFStatusErrorTouchIdExists
*/
FRAME_PUBLIC
UFStatus frame_backend_frame_give_touch(UFBackendFrame frame, UFBackendTouch *touch);
/**
* Deletes the backend handle of a UFFrame,
* decreasing its reference count by one.
*/
FRAME_PUBLIC
void frame_backend_frame_delete(UFBackendFrame frame);
/********************************************************************
* Touch
********************************************************************/
/**
* Creates a new UFTouch and returns its backend handle.
*
* Its state will be set to "Begin".
*
* After filled out, it should be given to a frame via frame_backend_frame_give_touch()
*/
FRAME_PUBLIC
UFBackendTouch frame_backend_touch_new();
/**
* Returns a UFTouch instance given its backend handle.
*/
FRAME_PUBLIC
UFTouch frame_backend_touch_get_touch(UFBackendTouch touch);
/**
* Sets the "Id" property of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_id(UFBackendTouch touch, UFTouchId id);
/**
* Sets the "State" property of the given touch to "End"
*/
FRAME_PUBLIC
void frame_backend_touch_set_ended(UFBackendTouch touch);
/**
* Sets the "WindowX" and "WindowY" properties of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_window_pos(UFBackendTouch touch, float x, float y);
/**
* Sets the "Time" property of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_time(UFBackendTouch touch, uint64_t time);
/**
* Sets the "StartTime" property of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_start_time(UFBackendTouch touch, uint64_t start_time);
/**
* Sets the "Owned" property of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_owned(UFBackendTouch touch, int owned);
/**
* Sets the "PendingEnd" property of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_pending_end(UFBackendTouch touch, int pending_end);
/**
* Sets the value of an axis of the given touch
*/
FRAME_PUBLIC
void frame_backend_touch_set_value(UFBackendTouch touch, UFAxisType type, float value);
#ifdef __cplusplus
}
#endif
#endif /* FRAME_OIF_FRAME_BACKEND_H_ */
./include/oif/frame.h.in 0000644 0000041 0000041 00000056111 12752376103 015325 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2010-2013 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
/**
* @file oif/frame.h
* Definitions of the main and platform-generic API
*/
#ifndef FRAME_OIF_FRAME_H_
#define FRAME_OIF_FRAME_H_
/* Macros that set symbol visibilities in shared libraries properly.
* Adapted from http://gcc.gnu.org/wiki/Visibility
*/
#if defined _WIN32 || defined __CYGWIN__
#ifdef BUILDING_FRAME
#define FRAME_PUBLIC __declspec(dllexport)
#else
#define FRAME_PUBLIC __declspec(dllimport)
#endif
#else
#if defined __GNUC__
#define FRAME_PUBLIC __attribute__ ((visibility("default")))
#else
#pragma message ("Compiler does not support symbol visibility.")
#define FRAME_PUBLIC
#endif
#endif
/* Clang provides __has_feature, but GCC does not */
#ifdef __has_feature
#if __has_feature(c_generic_selections)
#define HAS_C_GENERIC_SELECTIONS
#endif // __has_feature
#endif // __has_feature(c_generic_selections)
/* Whether the X11 backend (frame_x11.h) is available.
FRAME_X11_BACKEND will be defined if it is and FRAME_NO_X11_BACKEND otherwise. */
#define @FRAME_X11_BACKEND@
#ifdef __cplusplus
extern "C" {
#endif
#include
/** An object for the context of the frame instance */
typedef struct UFHandle_* UFHandle;
/** An object for an event */
typedef struct UFEvent_* UFEvent;
/** An object for a frame of touches */
typedef struct UFFrame_* UFFrame;
/** An object for a touch */
typedef struct UFTouch_* UFTouch;
/** An object for a device */
typedef struct UFDevice_* UFDevice;
/** An object for a device axis */
typedef struct UFAxis_* UFAxis;
/** An object for a window ID */
typedef uint64_t UFWindowId;
/** An object for a touch ID */
typedef uint64_t UFTouchId;
/** The status code denoting the result of a function call */
typedef enum UFStatus {
UFStatusSuccess = 0, /**< The call was successful */
UFStatusErrorGeneric, /**< A platform-dependent error occurred */
UFStatusErrorResources, /**< An error occurred due to insufficient resources */
UFStatusErrorNoEvent, /**< No events were available to get */
UFStatusErrorUnknownProperty, /**< The requested property value was not set */
UFStatusErrorInvalidTouch, /**< The requested touch does not exist */
UFStatusErrorInvalidAxis, /**< The requested axis does not exist */
UFStatusErrorUnsupported, /**< The requested function is not supported by the
window server */
UFStatusErrorInvalidType, /**< The variable type passed as a void pointer into
a property getter is invalid for the property
*/
UFStatusErrorTouchIdExists, /**< A touch with the same ID already exists */
} UFStatus;
/** Properties of a device */
typedef enum UFDeviceProperty {
/**
* The name of the device
*
* Value type: const char *
*
* The frame library owns the string. The string is valid until an event
* notifying removal of the device is released.
*/
UFDevicePropertyName = 0,
/**
* Whether the device is a direct touch device
*
* Value type: int with boolean semantics
*
* A direct touch device is a device where there is a direct transformation
* from the touch location to the event location on the screen. An indirect
* touch device is a device where the touch has meaning relative to a position
* on the screen, such as the location of a cursor. A touchscreens is an
* example of a direct device, and a trackpad is an example of an indirect
* device.
*/
UFDevicePropertyDirect,
/**
* Whether the device is an independent touch device
*
* Value type: int with boolean semantics
*
* An independent device is an indirect device whose cursor moves
* independently of the touches on the device. A mouse with a touch area for
* gestures is an example of an independent device, and a trackpad is an
* example of a dependent device.
*/
UFDevicePropertyIndependent,
/**
* Whether the device is a semi-multitouch device
*
* Value type: int with boolean semantics
*
* A semi-multitouch device provides a bounding box of some touches on the
* touch surface. In contrast, a full-multitouch device provides accurate
* locations of each individual touch.
*/
UFDevicePropertySemiMT,
/**
* The maximum number of touches supported by the device
*
* Value type: unsigned int
*/
UFDevicePropertyMaxTouches,
/**
* The number of touch axes provided by the device
*
* Value type: unsigned int
*/
UFDevicePropertyNumAxes,
/**
* The resolution of the window coordinates of the device in the X axis
*
* Value type: float
*
* The resolution is provided in pixels per meter.
*/
UFDevicePropertyWindowResolutionX,
/**
* The resolution of the window coordinates of the device in the Y axis
*
* Value type: float
*
* The resolution is provided in pixels per meter.
*/
UFDevicePropertyWindowResolutionY,
} UFDeviceProperty;
/** Device touch axis types */
typedef enum UFAxisType {
UFAxisTypeX = 0, /**< X coordinate */
UFAxisTypeY, /**< Y coordinate */
UFAxisTypeTouchMajor, /**< Width along major axis of contact area of touch */
UFAxisTypeTouchMinor, /**< Width along minor axis of contact area of touch */
UFAxisTypeWidthMajor, /**< Width along major axis of touch tool */
UFAxisTypeWidthMinor, /**< Width along minor axis of touch tool */
UFAxisTypeOrientation, /**< Orientation of major axis of contact ellipse */
UFAxisTypeTool, /**< Tool type */
UFAxisTypeBlobId, /**< Blob ID of group of touches */
UFAxisTypeTrackingId, /**< Tracking ID */
UFAxisTypePressure, /**< Pressure */
UFAxisTypeDistance, /**< Hover distance */
} UFAxisType;
/** Event properties */
typedef enum UFEventProperty {
/**
* Type of event
*
* Value type: UFEventType
*/
UFEventPropertyType = 0,
/**
* Device added or removed
*
* Value type: UFDevice
*
* This property is set only when the event type is UFEventTypeDeviceAdded
* or UFEventTypeDeviceRemoved. The object is owned by the library and is
* valid until an event notifying removal of the device is released.
*/
UFEventPropertyDevice,
/**
* Touch frame
*
* Value type: UFFrame
*
* This property is set only when the event type is UFEventTypeFrame. The
* object is owned by the library and is valid until the event is released.
*/
UFEventPropertyFrame,
/**
* Event time
*
* Value type: 64-bit unsigned int
*
* This property holds the time the event occurred in display server
* timespace. The time is provided in milliseconds (ms). If the event, such as
* device addition, occurred before the frame context was created, the value
* will be 0.
*/
UFEventPropertyTime,
} UFEventProperty;
/** Event types */
typedef enum UFEventType {
UFEventTypeDeviceAdded = 0, /**< A new device has been added */
UFEventTypeDeviceRemoved, /**< An existing device has been removed */
UFEventTypeFrame, /**< The state of one or more touches has changed */
} UFEventType;
/** Touch frame properties */
typedef enum UFFrameProperty {
/**
* The device for the frame
*
* Value type: UFDevice
*/
UFFramePropertyDevice = 0,
/**
* The window server ID of the window for the frame
*
* Value type: UFWindowId
*/
UFFramePropertyWindowId,
/**
* Number of touches in the frame
*
* Value type: unsigned int
*
* Some devices can track more touches than they can report data for. Only
* touches with X and Y position are provided in the frame.
*/
UFFramePropertyNumTouches,
/**
* Total number of active touches on the device
*
* Value type: unsigned int
*
* Some devices can track more touches than they can report data for. This
* value includes the number of reported and unreported touches.
*/
UFFramePropertyActiveTouches,
} UFFrameProperty;
/** State of an individual touch */
typedef enum UFTouchState {
UFTouchStateBegin = 0, /**< The touch began */
UFTouchStateUpdate, /**< A value or property of the touch changed */
UFTouchStateEnd, /**< The touch ended */
} UFTouchState;
/** Touch properties */
typedef enum UFTouchProperty {
/**
* Window server ID of the touch
*
* Value type: UFTouchId
*/
UFTouchPropertyId = 0,
/**
* State of the touch
*
* Value type: UFTouchState
*/
UFTouchPropertyState,
/**
* Location along X axis of touch relative to event window
*
* Value type: float
*
* The window server may provide touch location in window coordinate space.
* This property will be set where available.
*/
UFTouchPropertyWindowX,
/**
* Location along Y axis of touch relative to event window
*
* Value type: float
*
* The window server may provide touch location in window coordinate space.
* This property will be set where available.
*/
UFTouchPropertyWindowY,
/**
* Time of last touch state change
*
* Value type: 64-bit unsigned int
*
* See UFEventPropertyTime for the semantics of the value. If the touch has
* not changed during this frame, the value of this property will be less than
* the value of the UFEventPropertyTime event property for this frame.
*/
UFTouchPropertyTime,
/**
* Start time of touch
*
* Value type: 64-bit unsigned int
*
* See UFEventPropertyTime for the semantics of the value.
*/
UFTouchPropertyStartTime,
/**
* Whether the touch is owned by the client
*
* Value type: int with boolean semantics
*
* Some window servers have the concept of touch ownership. This property
* is only valid when the server supports touch ownership.
*/
UFTouchPropertyOwned,
/**
* Whether the touch has physically ended before the touch sequence has ended
*
* Value type: int with boolean semantics
*
* Some window servers have the concept of touch ownership. If a touch has
* ended before the client receives ownership, this property will be set to
* true. The property will also be set to true when the touch has ended before
* the client has accepted or rejected ownership of the touch sequence.
*/
UFTouchPropertyPendingEnd,
} UFTouchProperty;
/**
* Get the event file descriptor for the frame context
*
* @param [in] handle The frame context object
* @return A file descriptor for the context
*
* When events are available for processing, the file descriptor will be
* readable. Perform an 8-byte read from the file descriptor to clear the state.
* Refer to the EVENTFD(2) man page for more details.
*/
FRAME_PUBLIC
int frame_get_fd(UFHandle handle);
/**
* Get an event from the frame context
*
* @param [in] handle The context object
* @param [out] event The retrieved event
* @return UFStatusSuccess or UFStatusErrorNoEvent
*
* The reference count of the returned event is implicity incremented once.
*/
FRAME_PUBLIC
UFStatus frame_get_event(UFHandle handle, UFEvent *event);
/**
* Get the value of a property of a device
*
* @param [in] device The device object (const)
* @param [in] property The property to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess or UFStatusErrorUnknownProperty
*/
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */
FRAME_PUBLIC
UFStatus frame_device_get_property(UFDevice device, UFDeviceProperty property,
void *value);
#endif
/**
* Get a device touch axis by index
*
* @param [in] device The device object (const)
* @param [in] index The index of the axis to get
* @param [out] axis The axis retrieved
* @return UFStatusSuccess or UFStatusErrorInvalidAxis
*
* The index value must be greater than or equal to 0 and less than the number
* axes of the device.
*/
FRAME_PUBLIC
UFStatus frame_device_get_axis_by_index(UFDevice device, unsigned int index,
UFAxis *axis);
/**
* Get a device touch axis by axis type
*
* @param [in] device The device object (const)
* @param [in] type The axis type
* @param [out] axis The axis retrieved
* @return UFStatusSuccess or UFStatusErrorInvalidAxis
*
* UFStatusErrorInvalidAxis is returned if the device does not have an axis of
* the type requested.
*/
FRAME_PUBLIC
UFStatus frame_device_get_axis_by_type(UFDevice device, UFAxisType type,
UFAxis *axis);
/**
* Get the type of a touch device axis
*
* @param [in] axis The touch device axis (const)
* @return The type of the axis
*/
FRAME_PUBLIC
UFAxisType frame_axis_get_type(UFAxis axis);
/**
* Get the minimum value of a touch device axis
*
* @param [in] axis The touch device axis (const)
* @return The minimum value of the axis
*/
FRAME_PUBLIC
float frame_axis_get_minimum(UFAxis axis);
/**
* Get the maximum value of a touch device axis
*
* @param [in] axis The touch device axis (const)
* @return The maximum value of the axis
*/
FRAME_PUBLIC
float frame_axis_get_maximum(UFAxis axis);
/**
* Get the resolution of a touch device axis
*
* @param [in] axis The touch device axis (const)
* @return The resolution of the axis
*/
FRAME_PUBLIC
float frame_axis_get_resolution(UFAxis axis);
/**
* Increment the reference count of an event
*
* @param [in] event The event object
*/
FRAME_PUBLIC
void frame_event_ref(UFEvent event);
/**
* Decrement the reference count of an event
*
* @param [in] event The event object
*
* When the reference count reaches zero, the event is freed.
*/
FRAME_PUBLIC
void frame_event_unref(UFEvent event);
/**
* Get the value of a property of an event
*
* @param [in] event The event object (const)
* @param [in] property The property to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess or UFStatusErrorUnknownProperty
*/
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */
FRAME_PUBLIC
UFStatus frame_event_get_property(UFEvent event, UFEventProperty property,
void *value);
#endif
/**
* Get the value of a property of a frame
*
* @param [in] frame The frame object (const)
* @param [in] property The property to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess or UFStatusErrorUnknownProperty
*/
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */
FRAME_PUBLIC
UFStatus frame_frame_get_property(UFFrame frame, UFFrameProperty property,
void *value);
#endif
/**
* Get a touch of a frame by index
*
* @param [in] frame The frame object (const)
* @param [in] index The index of the touch to get
* @param [out] touch The touch retrieved
* @return UFStatusSuccess or UFStatusErrorInvalidTouch
*
* The index value must be greater than or equal to 0 and less than the number
* touches reported in the frame.
*/
FRAME_PUBLIC
UFStatus frame_frame_get_touch_by_index(UFFrame frame, unsigned int index,
UFTouch *touch);
/**
* Get a touch from a frame by the window server ID
*
* @param [in] frame The frame object (const)
* @param [in] touch_id The window server ID of the touch
* The value type of the touch ID is window server dependent. See
* UFTouchPropertyId for more details.
* @param [out] touch The touch object
* @return UFStatusSuccess or UFStatusErrorInvalidTouch
*/
FRAME_PUBLIC
UFStatus frame_frame_get_touch_by_id(UFFrame frame, UFTouchId touch_id,
UFTouch* touch);
/**
* Get the previous value of a property of a touch
*
* @param [in] frame The current frame object (const)
* @param [in] touch The current touch object (const)
* @param [in] property The property to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess, UFStatusErrorUnknownProperty, or
* UFStatusErrorInvalidTouch
*
* The previous value is the value of the property in the previous frame.
* UFStatusErrorInvalidTouch is returned if the touch did not exist in the
* previous frame.
*/
FRAME_PUBLIC
UFStatus frame_frame_get_previous_touch_property(UFFrame frame, UFTouch touch,
UFTouchProperty property,
void *value);
/**
* Get the previous value of an axis of a touch
*
* @param [in] frame The current frame object (const)
* @param [in] touch The current touch object (const)
* @param [in] type The axis to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess, UFStatusErrorInvalidAxis, or
* UFStatusErrorInvalidTouch
*
* The previous value is the value of the axis in the previous frame.
* UFStatusErrorInvalidTouch is returned if the touch did not exist in the
* previous frame.
*/
FRAME_PUBLIC
UFStatus frame_frame_get_previous_touch_value(UFFrame frame, UFTouch touch,
UFAxisType type, float* value);
/**
* Get the value of a property of a touch
*
* @param [in] touch The touch object (const)
* @param [in] property The property to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess or UFStatusErrorUnknownProperty
*/
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */
FRAME_PUBLIC
UFStatus frame_touch_get_property(UFTouch touch, UFTouchProperty property,
void *value);
#endif
/**
* Get the value of an axis of a touch
*
* @param [in] touch The touch object (const)
* @param [in] type The axis to retrieve a value for
* @param [out] value The value retrieved
* @return UFStatusSuccess or UFStatusErrorInvalidAxis
*/
FRAME_PUBLIC
UFStatus frame_touch_get_value(UFTouch touch, UFAxisType type, float *value);
/**
* @defgroup v2-helpers Helper Functions
* These helper functions may be used in place of the generic property getters.
* They are limited to properties that are guaranteed to exist in all instances
* of the objects.
* @{
*/
/**
* Get the type of an event
*
* @param [in] event The event object (const)
* @return The type of the event
*/
FRAME_PUBLIC
UFEventType frame_event_get_type(UFEvent event);
/**
* Get the time of an event
*
* @param [in] event The event object (const)
* @return The time of the event
*/
FRAME_PUBLIC
uint64_t frame_event_get_time(UFEvent event);
/**
* Get the number of axes of a device
*
* @param [in] device The device object (const)
* @return The number of axes
*/
FRAME_PUBLIC
unsigned int frame_device_get_num_axes(UFDevice device);
/**
* Get The resolution of the window coordinates of the device in the X axis
*
* @param [in] device The device object (const)
* @return The resolution in pixels per meter
*/
FRAME_PUBLIC
float frame_device_get_window_resolution_x(UFDevice device);
/**
* Get The resolution of the window coordinates of the device in the Y axis
*
* @param [in] device The device object (const)
* @return The resolution in pixels per meter
*/
FRAME_PUBLIC
float frame_device_get_window_resolution_y(UFDevice device);
/**
* Get the number of touches in the frame
*
* @param [in] frame The frame object (const)
* @return The number of touches
*/
FRAME_PUBLIC
uint32_t frame_frame_get_num_touches(UFFrame frame);
/**
* Get the device of a frame
*
* @param [in] frame The frame context object (const)
* return The device of the window context
*/
FRAME_PUBLIC
UFDevice frame_frame_get_device(UFFrame frame);
/**
* Get the window ID of a frame
*
* @param [in] frame The frame context object (const)
* @return The window server ID of the window of the frame
*/
FRAME_PUBLIC
UFWindowId frame_frame_get_window_id(UFFrame frame);
/**
* Get the window server ID of a touch
*
* @param [in] touch The touch context object (const)
* @return The window server ID of the touch
*/
FRAME_PUBLIC
UFTouchId frame_touch_get_id(UFTouch touch);
/**
* Get the state of a touch
*
* @param [in] touch The touch object (const)
* @return The state of the touch
*/
FRAME_PUBLIC
UFTouchState frame_touch_get_state(UFTouch touch);
/**
* Get the X window coordinate of a touch
*
* @param [in] touch The touch object (const)
* @return The X window coordinate of the touch
*/
FRAME_PUBLIC
float frame_touch_get_window_x(UFTouch touch);
/**
* Get the Y window coordinate of a touch
*
* @param [in] touch The touch object (const)
* @return The Y window coordinate of the touch
*/
FRAME_PUBLIC
float frame_touch_get_window_y(UFTouch touch);
/**
* Get the X device coordinate of a touch
*
* @param [in] touch The touch object (const)
* @return The X device coordinate of the touch
*/
FRAME_PUBLIC
float frame_touch_get_device_x(UFTouch touch);
/**
* Get the Y device coordinate of a touch
*
* @param [in] touch The touch object (const)
* @return The Y device coordinate of the touch
*/
FRAME_PUBLIC
float frame_touch_get_device_y(UFTouch touch);
/**
* Get the time of a touch state change
*
* @param [in] touch The touch object (const)
* @return The time of the touch state change
*/
FRAME_PUBLIC
uint64_t frame_touch_get_time(UFTouch touch);
/**
* Get the start time of a touch
*
* @param [in] touch The touch object (const)
* @return The start time of the touch
*/
FRAME_PUBLIC
uint64_t frame_touch_get_start_time(UFTouch touch);
/**
* Accept ownership of a touch
*
* All touches received should be eventally accepted or rejected.
* This decision can come even after they have already ended but
* should be done as soon as possible.
*
* You should accept a touch when you're going to use it and
* reject it if you're not interested in it.
*
* Not all window servers have this concept. Those that do use
* this information to pass rejected touches forward to other
* clients that might want it.
*
* @param [in] device The device object for the touch (const)
* @param [in] window The window to accept the touch for
* @param [in] touch_id The touch ID object for the touch
* @return UFStatusSuccess, UFStatusErrorInvalidTouch
* @see frame_reject_touch
*/
FRAME_PUBLIC
UFStatus frame_accept_touch(UFDevice device, UFWindowId window,
UFTouchId touch_id);
/**
* Reject ownership of a touch
*
* @param [in] device The device object for the touch (const)
* @param [in] window The window to reject the touch for
* @param [in] touch_id The touch ID object for the touch
* @return UFStatusSuccess, UFStatusErrorInvalidTouch
* @see frame_accept_touch
*/
FRAME_PUBLIC
UFStatus frame_reject_touch(UFDevice device, UFWindowId window,
UFTouchId touch_id);
/** @} */
#include "oif/frame_internal.h"
#ifdef __cplusplus
}
#endif
#undef HAS_C_GENERIC_SELECTIONS
#endif // FRAME_OIF_FRAME_H_
./include/oif/frame_internal.h 0000644 0000041 0000041 00000012412 12752376103 016610 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2010-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#ifndef FRAME_OIF_FRAME_INTERNAL_H_
#define FRAME_OIF_FRAME_INTERNAL_H_
#ifdef HAS_C_GENERIC_SELECTIONS
#include
FRAME_PUBLIC
UFStatus frame_device_get_property_string_(UFDevice device,
UFDeviceProperty property,
char **value);
FRAME_PUBLIC
UFStatus frame_device_get_property_int_(UFDevice device,
UFDeviceProperty property, int *value);
FRAME_PUBLIC
UFStatus frame_device_get_property_unsigned_int_(UFDevice device,
UFDeviceProperty property,
unsigned int *value);
#define frame_device_get_property(device, property, value) \
_Generic((value), \
char **: frame_device_get_property_string_, \
int *: frame_device_get_property_int_, \
unsigned int *: frame_device_get_property_unsigned_int_) ((device), \
(property), \
(value))
FRAME_PUBLIC
UFStatus frame_event_get_property_type_(UFEvent event, UFEventProperty property,
UFEventType *value);
FRAME_PUBLIC
UFStatus frame_event_get_property_device_(UFEvent event,
UFEventProperty property,
UFDevice *value);
FRAME_PUBLIC
UFStatus frame_event_get_property_frame_(UFEvent event,
UFEventProperty property,
UFFrame *value);
FRAME_PUBLIC
UFStatus frame_event_get_property_uint64_(UFEvent event,
UFEventProperty property,
uint64_t *value);
#define frame_event_get_property(event, property, value) \
_Generic((value), \
UFEventType *: frame_event_get_property_type_, \
UFDevice *: frame_event_get_property_device_, \
UFFrame *: frame_event_get_property_frame_, \
uint64_t *: frame_event_get_property_uint64_) ((event), \
(property), (value))
FRAME_PUBLIC
UFStatus frame_frame_get_property_device_(UFFrame frame,
UFFrameProperty property,
UFDevice *value);
FRAME_PUBLIC
UFStatus frame_frame_get_property_uint64_(UFFrame frame,
UFFrameProperty property,
uint64_t *value);
FRAME_PUBLIC
UFStatus frame_frame_get_property_unsigned_int_(UFFrame frame,
UFFrameProperty property,
unsigned int *value);
#define frame_frame_get_property(frame, property, value) \
_Generic((value), \
UFDevice *: frame_frame_get_property_device_, \
uint64_t *: frame_frame_get_property_window_id_, \
unsigned int *: frame_frame_get_property_unsigned_int_) ( \
(frame), \
(property), \
(value))
FRAME_PUBLIC
UFStatus frame_touch_get_property_uint64_(UFTouch touch,
UFTouchProperty property,
uint64_t *value);
FRAME_PUBLIC
UFStatus frame_touch_get_property_state_(UFTouch touch,
UFTouchProperty property,
UFTouchState *value);
FRAME_PUBLIC
UFStatus frame_touch_get_property_float_(UFTouch touch,
UFTouchProperty property,
float *value);
FRAME_PUBLIC
UFStatus frame_touch_get_property_int_(UFTouch touch, UFTouchProperty property,
int *value);
#define frame_touch_get_property(touch, property, value) \
_Generic((value), \
uint64_t *: frame_touch_get_property_uint64_, \
UFTouchState *: frame_touch_get_property_state_, \
float *: frame_touch_get_property_float_, \
int *: frame_touch_get_property_int_) ((touch), (property), \
(value))
#endif // HAS_C_GENERIC_SELECTIONS
#endif // FRAME_OIF_FRAME_INTERNAL_H_
./include/oif/frame_x11.h 0000644 0000041 0000041 00000007723 12752376103 015416 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2010-2013 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#ifndef FRAME_OIF_FRAME_X11_H_
#define FRAME_OIF_FRAME_X11_H_
#include "oif/frame.h"
#include
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup x11 X11
* @{
*/
/**
* Create a new frame context for an X11 window server
*
* @param [in] display The X11 server connection
* @param [out] handle The object for the new frame instance
* @return UFStatusSuccess, UFStatusErrorResources, or UFStatusErrorGeneric
*/
FRAME_PUBLIC
UFStatus frame_x11_new(Display *display, UFHandle *handle);
/**
* Delete an X11 frame instance
*
* @param [in] handle The object for the frame instance
*/
FRAME_PUBLIC
void frame_x11_delete(UFHandle handle);
/**
* Process an X11 input event into the frame instance
*
* @param [in] handle The frame context
* @param [in] event The X11 generic input event cookie
* @return UFStatusSuccess or UFStatusErrorGeneric
*
* The frame library can process XIDeviceEvent and
* XIHierarchyEvent events. Processing these events requires additional event
* data. This data is obtained by calling XGetEventData on the XEvent. See the
* XGetEventData and XFreeEventData man pages for more details.
*
* This function will silently ignore any events other than those listed above.
*/
FRAME_PUBLIC
UFStatus frame_x11_process_event(UFHandle handle, XGenericEventCookie *xcookie);
/**
* Accept ownership of a touch
*
* @deprecated Use frame_accept_touch instead.
* @param [in] device The device object for the touch (const)
* @param [in] window The window to accept the touch for
* @param [in] touch_id The touch ID object for the touch
* @return UFStatusSuccess, UFStatusErrorInvalidTouch
*/
FRAME_PUBLIC
UFStatus frame_x11_accept_touch(UFDevice device, UFWindowId window,
UFTouchId touch_id);
/**
* Reject ownership of a touch
*
* @deprecated Use frame_reject_touch instead.
* @param [in] device The device object for the touch (const)
* @param [in] window The window to reject the touch for
* @param [in] touch_id The touch ID object for the touch
* @return UFStatusSuccess, UFStatusErrorInvalidTouch
*/
FRAME_PUBLIC
UFStatus frame_x11_reject_touch(UFDevice device, UFWindowId window,
UFTouchId touch_id);
/**
* Get the X11 Window ID of a frame window
*
* @param [in] window_id The frame window ID object (const)
* @return The X11 window ID
*/
FRAME_PUBLIC
Window frame_x11_get_window_id(UFWindowId window_id);
/**
* Create a new frame window ID object for an X11 window ID
*
* @param [in] id The X11 ID of the window
* @return The new frame window ID object
*/
FRAME_PUBLIC
UFWindowId frame_x11_create_window_id(Window id);
/**
* Get the X11 touch ID of a frame touch
*
* @param [in] touch_id The frame touch ID object (const)
* @return The X11 touch ID
*/
FRAME_PUBLIC
unsigned int frame_x11_get_touch_id(UFTouchId touch_id);
/**
* Create a new frame touch ID object for an X11 touch ID
*
* @param [in] id The X11 ID of the touch
* @return The new frame touch ID object
*/
FRAME_PUBLIC
UFTouchId frame_x11_create_touch_id(unsigned int id);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif // FRAME_OIF_FRAME_X11_H_
./src/ 0000755 0000041 0000041 00000000000 12752376120 012037 5 ustar www-data www-data ./src/libframe.ver 0000644 0000041 0000041 00000006176 12752376103 014351 0 ustar www-data www-data FRAME_2.2 {
global:
frame_get_fd;
frame_get_event;
frame_device_get_property;
frame_device_get_property_string_;
frame_device_get_property_int_;
frame_device_get_property_unsigned_int_;
frame_device_get_axis_by_index;
frame_device_get_axis_by_type;
frame_device_get_window_resolution_x;
frame_device_get_window_resolution_y;
frame_axis_get_type;
frame_axis_get_minimum;
frame_axis_get_maximum;
frame_axis_get_resolution;
frame_event_ref;
frame_event_unref;
frame_event_get_property;
frame_event_get_property_type_;
frame_event_get_property_device_;
frame_event_get_property_frame_;
frame_event_get_property_uint64_;
frame_frame_get_property;
frame_frame_get_property_device_;
frame_frame_get_property_uint64_;
frame_frame_get_property_unsigned_int_;
frame_frame_get_touch_by_index;
frame_frame_get_touch_by_id;
frame_frame_get_previous_touch_property;
frame_frame_get_previous_touch_value;
frame_touch_get_property;
frame_touch_get_property_uint64_;
frame_touch_get_property_state_;
frame_touch_get_property_float_;
frame_touch_get_property_int_;
frame_touch_get_value;
frame_event_get_type;
frame_event_get_time;
frame_device_get_num_axes;
frame_frame_get_num_touches;
frame_frame_get_window_id;
frame_frame_get_device;
frame_touch_get_id;
frame_touch_get_state;
frame_touch_get_window_x;
frame_touch_get_window_y;
frame_touch_get_device_x;
frame_touch_get_device_y;
frame_touch_get_time;
frame_touch_get_start_time;
frame_x11_new;
frame_x11_delete;
frame_x11_process_event;
frame_x11_accept_touch;
frame_x11_reject_touch;
frame_x11_get_window_id;
frame_x11_create_window_id;
frame_x11_get_touch_id;
frame_x11_create_touch_id;
local:
*;
};
FRAME_2.4 {
global:
frame_backend_device_new;
frame_backend_device_get_device;
frame_backend_device_delete;
frame_backend_device_set_name;
frame_backend_device_set_direct;
frame_backend_device_set_independent;
frame_backend_device_set_semi_mt;
frame_backend_device_set_max_touches;
frame_backend_device_set_window_resolution;
frame_backend_device_add_axis;
frame_backend_frame_new;
frame_backend_frame_create_next;
frame_backend_frame_get_frame;
frame_backend_frame_borrow_touch_by_id;
frame_backend_frame_set_device;
frame_backend_frame_set_window_id;
frame_backend_frame_set_active_touches;
frame_backend_frame_give_touch;
frame_backend_frame_delete;
frame_backend_touch_new;
frame_backend_touch_get_touch;
frame_backend_touch_set_id;
frame_backend_touch_set_ended;
frame_backend_touch_set_window_pos;
frame_backend_touch_set_time;
frame_backend_touch_set_start_time;
frame_backend_touch_set_owned;
frame_backend_touch_set_pending_end;
frame_backend_touch_set_value;
frame_event_new;
frame_event_set_type;
frame_event_set_device;
frame_event_set_frame;
frame_event_set_time;
} FRAME_2.2;
FRAME_2.5 {
global:
frame_accept_touch;
frame_reject_touch;
} FRAME_2.4;
./src/value.cpp 0000644 0000041 0000041 00000012343 12752376103 013663 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#include "value.h"
#include
#include
#include
#include "device.h"
#include "frame.h"
namespace oif {
namespace frame {
Value::Value(bool value) : type_(kBool), bool_(value) {
}
Value::Value(int value) : type_(kInt), int_(value) {
}
Value::Value(unsigned int value) : type_(kUnsignedInt), unsigned_int_(value) {
}
Value::Value(float value) : type_(kFloat), float_(value) {
}
#ifdef HAVE_LONG_UNSIGNED_VALUE
Value::Value(long unsigned int value)
: type_(kLongUnsignedInt),
long_unsigned_int_(value) {
}
#endif // HAVE_LONG_UNSIGNED_VALUE
Value::Value(uint64_t value) : type_(kuint64_t), uint64_t_(value) {
}
Value::Value(const char* value) : type_(kString), string_(strdup(value)) {
}
Value::Value(const SharedUFDevice& device)
: type_(kSharedDevice),
device_(new SharedUFDevice(device)) {
}
Value::Value(const SharedUFFrame& frame)
: type_(kSharedFrame),
frame_(new SharedUFFrame(frame)) {
}
Value::Value(UFEventType value) : type_(kEventType), event_type_(value) {
}
Value::Value(UFTouchState value) : type_(kTouchState), touch_state_(value) {
}
Value::Value(const Value& value)
: type_(value.type_),
any_(value.any_) {
switch (type_) {
case kString:
string_ = strdup(value.string_);
break;
case kSharedDevice:
device_ = new SharedUFDevice(*value.device_);
break;
case kSharedFrame:
frame_ = new SharedUFFrame(*value.frame_);
break;
default:
break;
}
}
void Value::GetValue(void* data) const {
switch (type_) {
case kBool:
*reinterpret_cast(data) = bool_;
break;
case kInt:
*reinterpret_cast(data) = int_;
break;
case kUnsignedInt:
*reinterpret_cast(data) = unsigned_int_;
break;
case kFloat:
*reinterpret_cast(data) = float_;
break;
#ifdef HAVE_LONG_UNSIGNED_VALUE
case kLongUnsignedInt:
*reinterpret_cast(data) = long_unsigned_int_;
break;
#endif // HAVE_LONG_UNSIGNED_VALUE
case kuint64_t:
*reinterpret_cast(data) = uint64_t_;
break;
case kString:
*reinterpret_cast(data) = string_;
break;
case kSharedDevice:
*reinterpret_cast< ::UFDevice*>(data) = device_->get();
break;
case kSharedFrame:
*reinterpret_cast< ::UFFrame*>(data) = frame_->get();
break;
case kEventType:
*reinterpret_cast(data) = event_type_;
break;
case kTouchState:
*reinterpret_cast(data) = touch_state_;
break;
}
}
void Value::GetValue(char** value) const {
if (type_ == kString)
*value = string_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(int* value) const {
if (type_ == kInt)
*value = int_;
else if (type_ == kBool)
*value = bool_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(unsigned int* value) const {
if (type_ == kUnsignedInt)
*value = unsigned_int_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(UFEventType* value) const {
if (type_ == kEventType)
*value = event_type_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(::UFDevice* value) const {
if (type_ == kSharedDevice)
*value = device_->get();
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(::UFFrame* value) const {
if (type_ == kSharedFrame)
*value = frame_->get();
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(uint64_t* value) const {
if (type_ == kuint64_t)
*value = uint64_t_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(UFTouchState* value) const {
if (type_ == kTouchState)
*value = touch_state_;
else
throw std::runtime_error("Bad property value type");
}
void Value::GetValue(float* value) const {
if (type_ == kFloat)
*value = float_;
else
throw std::runtime_error("Bad property value type");
}
Value::~Value() {
switch (type_) {
case kString:
free(const_cast(string_));
break;
case kSharedDevice:
delete device_;
break;
case kSharedFrame:
delete frame_;
break;
default:
break;
}
}
} // namespace frame
} // namespace oif
./src/Makefile.am 0000644 0000041 0000041 00000002467 12752376103 014105 0 ustar www-data www-data version_script = $(srcdir)/libframe.ver
lib_LTLIBRARIES = libframe.la
libframe_la_LDFLAGS = \
-version-info @LIB_VERSION@ \
-Wl,-z,defs -Wl,--as-needed \
-Wl,--version-script=$(version_script)
libframe_la_LIBADD = \
-lm \
$(COVERAGE_LIBS) \
$(XINPUT_LIBS) \
$(CXX_LIBS)
AM_CPPFLAGS = \
-I$(top_builddir)/include \
-I$(top_srcdir)/include/ \
-I$(top_srcdir)/src \
$(WARNING_CPPFLAGS) \
-DBUILDING_FRAME
AM_CFLAGS = $(VISIBILITY_CFLAGS) $(COVERAGE_CFLAGS)
AM_CXXFLAGS = \
$(CXX11_CXXFLAGS) \
$(VISIBILITY_CXXFLAGS) \
$(COVERAGE_CXXFLAGS) \
$(XINPUT_CFLAGS)
libframeincludedir = $(includedir)/oif
libframeinclude_HEADERS = \
$(top_builddir)/include/oif/frame.h \
$(top_srcdir)/include/oif/frame_backend.h \
$(top_srcdir)/include/oif/frame_internal.h
if HAVE_XINPUT
libframeinclude_HEADERS += \
$(top_srcdir)/include/oif/frame_x11.h
endif
libframe_la_SOURCES = \
axis.h \
axis.cpp \
device.h \
device.cpp \
event.h \
event.cpp \
frame.h \
frame.cpp \
handle.h \
handle.cpp \
property.h \
touch.h \
touch.cpp \
typedefs.h \
value.h \
value.cpp \
window.h \
window.cpp
if HAVE_XINPUT
libframe_la_SOURCES += \
x11/device_x11.h \
x11/device_x11.cpp \
x11/frame_x11.cpp \
x11/handle_x11.h \
x11/handle_x11.cpp \
x11/window_x11.h \
x11/window_x11.cpp
endif
EXTRA_DIST = $(version_script)
./src/value.h 0000644 0000041 0000041 00000005536 12752376103 013336 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#ifndef FRAME_VALUE_H_
#define FRAME_VALUE_H_
#include
#include
#include "oif/frame.h"
#include "typedefs.h"
#if __SIZEOF_LONG__ != __SIZEOF_LONG_LONG__
#define HAVE_LONG_UNSIGNED_VALUE
#endif
namespace oif {
namespace frame {
class Value {
public:
explicit Value(bool value);
explicit Value(int value);
explicit Value(unsigned int value);
explicit Value(float value);
#ifdef HAVE_LONG_UNSIGNED_VALUE
explicit Value(long unsigned int value);
#endif // HAVE_LONG_UNSIGNED_VALUE
explicit Value(uint64_t value);
explicit Value(const char* value);
explicit Value(const SharedUFDevice& device);
explicit Value(const SharedUFFrame& frame);
explicit Value(UFEventType value);
explicit Value(UFTouchState value);
explicit Value(const Value& value);
~Value();
void GetValue(void* data) const;
void GetValue(char** data) const;
void GetValue(int* data) const;
void GetValue(unsigned int* data) const;
void GetValue(UFEventType* data) const;
void GetValue(::UFDevice* data) const;
void GetValue(::UFFrame* data) const;
void GetValue(uint64_t* data) const;
void GetValue(UFTouchState* data) const;
void GetValue(float* data) const;
Value& operator=(const Value&) = delete;
private:
const enum {
kBool,
kInt,
kUnsignedInt,
kFloat,
#ifdef HAVE_LONG_UNSIGNED_VALUE
kLongUnsignedInt,
#endif // HAVE_LONG_UNSIGNED_VALUE
kuint64_t,
kString,
kSharedDevice,
kSharedFrame,
kEventType,
kTouchState,
} type_;
union {
const int bool_;
const int int_;
const unsigned int unsigned_int_;
const float float_;
#ifdef HAVE_LONG_UNSIGNED_VALUE
const long unsigned int long_unsigned_int_;
#endif // HAVE_LONG_UNSIGNED_VALUE
const uint64_t uint64_t_;
char* string_;
SharedUFDevice* device_;
SharedUFFrame* frame_;
UFEventType event_type_;
UFTouchState touch_state_;
uint64_t const any_; /* Used to set any value */
};
};
} // namespace frame
} // namespace oif
#endif // FRAME_VALUE_H_
./src/touch.cpp 0000644 0000041 0000041 00000022340 12752376103 013667 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#include "touch.h"
#include
#include "frame.h"
#include
oif::frame::UFTouch* UFBackendTouch_::GetModifiableTouch() {
if (shared_ptr.unique()) {
return static_cast(shared_ptr.get());
} else {
/* Make a hard-copy. We don't want other holders of that UFTouch (like frames
from previous but still existing events) to get the changes about to be
made through this UFBackendTouch. */
oif::frame::UFTouch *old_touch =
static_cast(shared_ptr.get());
oif::frame::UFTouch *new_touch = new oif::frame::UFTouch(*old_touch);
shared_ptr.reset(new_touch);
return new_touch;
}
}
namespace oif {
namespace frame {
UFTouch::UFTouch()
: state_(UFTouchStateBegin) {
const Value* value;
value = new Value(state_);
InsertProperty(UFTouchPropertyState, value);
}
UFTouch::UFTouch(UFTouchState state, UFTouchId id, float x, float y,
uint64_t time)
: id_(id),
state_(state),
values_() {
const Value* value;
value = new Value(state);
InsertProperty(UFTouchPropertyState, value);
value = new Value(id);
InsertProperty(UFTouchPropertyId, value);
value = new Value(x);
InsertProperty(UFTouchPropertyWindowX, value);
value = new Value(y);
InsertProperty(UFTouchPropertyWindowY, value);
value = new Value(time);
InsertProperty(UFTouchPropertyTime, value);
if (state == UFTouchStateBegin) {
value = new Value(time);
InsertProperty(UFTouchPropertyStartTime, value);
}
}
UFTouch::UFTouch(const UFTouch& touch, UFTouchState new_state)
: Property(touch),
id_(touch.id_),
state_(new_state),
values_(touch.values_) {
const Value* value = new Value(new_state);
InsertProperty(UFTouchPropertyState, value);
}
void UFTouch::SetValue(UFAxisType type, float value) {
values_[type] = value;
}
UFStatus UFTouch::GetValue(UFAxisType type, float* value) const {
auto it = values_.find(type);
if (it == values_.end())
return UFStatusErrorInvalidAxis;
*value = it->second;
return UFStatusSuccess;
}
} // namespace frame
} // namespace oif
extern "C" {
FRAME_PUBLIC
UFStatus frame_touch_get_property_uint64_(UFTouch touch,
UFTouchProperty property,
uint64_t *value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetProperty(property, value);
}
FRAME_PUBLIC
UFStatus frame_touch_get_property_state_(UFTouch touch,
UFTouchProperty property,
UFTouchState *value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetProperty(property, value);
}
FRAME_PUBLIC
UFStatus frame_touch_get_property_float_(UFTouch touch,
UFTouchProperty property,
float *value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetProperty(property, value);
}
FRAME_PUBLIC
UFStatus frame_touch_get_property_int_(UFTouch touch, UFTouchProperty property,
int *value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetProperty(property, value);
}
#undef frame_touch_get_property /* Override C11 generic selections macro */
FRAME_PUBLIC
UFStatus frame_touch_get_property(UFTouch touch, UFTouchProperty property,
void* value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetProperty(property, value);
}
UFStatus frame_touch_get_value(UFTouch touch, UFAxisType type, float* value) {
const oif::frame::UFTouch* uftouch =
static_cast(touch);
return uftouch->GetValue(type, value);
}
UFTouchId frame_touch_get_id(UFTouch touch) {
UFTouchId touch_id;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyId, &touch_id);
assert(status == UFStatusSuccess);
return touch_id;
}
UFTouchState frame_touch_get_state(UFTouch touch) {
UFTouchState state;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyState, &state);
assert(status == UFStatusSuccess);
return state;
}
float frame_touch_get_window_x(UFTouch touch) {
float x;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyWindowX, &x);
assert(status == UFStatusSuccess);
return x;
}
float frame_touch_get_window_y(UFTouch touch) {
float y;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyWindowY, &y);
assert(status == UFStatusSuccess);
return y;
}
float frame_touch_get_device_x(UFTouch touch) {
float x;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetValue(UFAxisTypeX, &x);
assert(status == UFStatusSuccess);
return x;
}
float frame_touch_get_device_y(UFTouch touch) {
float y;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetValue(UFAxisTypeY, &y);
assert(status == UFStatusSuccess);
return y;
}
uint64_t frame_touch_get_time(UFTouch touch) {
uint64_t time;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyTime, &time);
assert(status == UFStatusSuccess);
return time;
}
uint64_t frame_touch_get_start_time(UFTouch touch) {
uint64_t start_time;
const oif::frame::UFTouch* uftouch =
static_cast(touch);
UFStatus status = uftouch->GetProperty(UFTouchPropertyStartTime, &start_time);
assert(status == UFStatusSuccess);
return start_time;
}
UFBackendTouch frame_backend_touch_new()
{
return new UFBackendTouch_(new oif::frame::UFTouch);
}
UFTouch frame_backend_touch_get_touch(UFBackendTouch touch)
{
return touch->shared_ptr.get();
}
void frame_backend_touch_set_id(UFBackendTouch touch_backend, UFTouchId id)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyId, new oif::frame::Value(id));
touch->SetId(id);
}
void frame_backend_touch_set_ended(UFBackendTouch touch_backend)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyState, new oif::frame::Value(UFTouchStateEnd));
touch->SetState(UFTouchStateEnd);
}
void frame_backend_touch_set_window_pos(UFBackendTouch touch_backend, float x, float y)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyWindowX, new oif::frame::Value(x));
touch->InsertProperty(UFTouchPropertyWindowY, new oif::frame::Value(y));
}
void frame_backend_touch_set_time(UFBackendTouch touch_backend, uint64_t time)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyTime, new oif::frame::Value(time));
}
void frame_backend_touch_set_start_time(UFBackendTouch touch_backend,
uint64_t start_time)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyStartTime, new oif::frame::Value(start_time));
}
void frame_backend_touch_set_owned(UFBackendTouch touch_backend, int owned)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyOwned, new oif::frame::Value(owned));
}
void frame_backend_touch_set_pending_end(UFBackendTouch touch_backend, int pending_end)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->InsertProperty(UFTouchPropertyPendingEnd, new oif::frame::Value(pending_end));
}
void frame_backend_touch_set_value(UFBackendTouch touch_backend,
UFAxisType type, float value)
{
oif::frame::UFTouch *touch = touch_backend->GetModifiableTouch();
touch->SetValue(type, value);
}
} // extern "C"
./src/frame.cpp 0000644 0000041 0000041 00000031260 12752376103 013640 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#include "frame.h"
#include
#include
#include "device.h"
#include "touch.h"
#include
namespace oif {
namespace frame {
UFFrame::UFFrame(const SharedUFFrame& prev)
: prev_(prev),
touches_array_(),
touches_map_() {
for (const SharedUFTouch& prev_touch : prev_->touches_array_) {
if (prev_touch->state() == UFTouchStateBegin) {
touches_map_[prev_touch->id()] = touches_array_.size();
SharedUFTouch touch(prev->CopyTouch(prev_touch->id(),
UFTouchStateUpdate));
touches_array_.push_back(touch);
} else if (prev_touch->state() == UFTouchStateUpdate) {
touches_map_[prev_touch->id()] = touches_array_.size();
touches_array_.push_back(prev_touch);
}
}
const Value* value;
value = new Value(static_cast(touches_map_.size()));
InsertProperty(UFFramePropertyNumTouches, value);
value = new Value(static_cast(touches_map_.size()));
InsertProperty(UFFramePropertyActiveTouches, value);
}
UFTouch* UFFrame::CopyTouch(UFTouchId touchid, UFTouchState new_state) const {
auto map_it = touches_map_.find(touchid);
if (map_it == touches_map_.end()) {
fprintf(stderr, "Failed to copy non-existent touch\n");
return NULL;
}
return new UFTouch(*touches_array_[map_it->second].get(), new_state);
}
bool UFFrame::IsTouchOwned(UFTouchId touchid) {
auto map_it = touches_map_.find(touchid);
if (map_it == touches_map_.end())
return false;
SharedUFTouch& touch = touches_array_[map_it->second];
int owned;
UFStatus status = touch->GetProperty(UFTouchPropertyOwned, &owned);
if (status != UFStatusSuccess)
/* If the window server doesn't support touch ownership, then all touches
* are implicitly owned. */
return true;
return owned;
}
namespace {
void CopyStartTime(const SharedUFTouch& src,
const SharedUFTouch& dst) {
uint64_t start_time = 0;
UFStatus status = src->GetProperty(UFTouchPropertyStartTime, &start_time);
assert(status == UFStatusSuccess);
const Value* value = new Value(start_time);
dst->InsertProperty(UFTouchPropertyStartTime, value);
}
} // namespace
UFStatus UFFrame::GiveTouch(SharedUFTouch& touch) {
auto map_it = touches_map_.find(touch->id());
if (map_it != touches_map_.end()) {
/* A loan is being returned */
SharedUFTouch &our_touch = touches_array_[map_it->second];
/* we shouldn't be referencing to any UFTouch here.
If we are, it's a programming error by the API user. */
if (our_touch.get() != NULL) {
return UFStatusErrorTouchIdExists;
}
/* take back our UFtouch */
our_touch.swap(touch);
} else {
touches_map_[touch->id()] = touches_array_.size();
touches_array_.push_back(touch);
touch.reset();
}
return UFStatusSuccess;
}
void UFFrame::UpdateTouch(const SharedUFTouch& touch) {
auto map_it = touches_map_.find(touch->id());
switch (touch->state()) {
case UFTouchStateBegin:
if (map_it != touches_map_.end()) {
CopyStartTime(touches_array_[map_it->second], touch);
touches_array_[map_it->second] = touch;
} else {
touches_map_[touch->id()] = touches_array_.size();
touches_array_.push_back(touch);
}
break;
case UFTouchStateUpdate: {
case UFTouchStateEnd:
if (map_it == touches_map_.end()) {
fprintf(stderr, "Warning: ignoring update for unknown touch %ju\n",
touch->id());
break;
}
CopyStartTime(touches_array_[map_it->second], touch);
touches_array_[map_it->second] = touch;
break;
}
}
}
bool UFFrame::IsEnded() const {
for (const SharedUFTouch& touch : touches_array_)
if (touch->state() != UFTouchStateEnd)
return false;
return true;
}
UFStatus UFFrame::GetPreviousTouchProperty(const UFTouch* touch,
UFTouchProperty property,
void* value) const {
if (!prev_)
return UFStatusErrorInvalidTouch;
auto it = prev_->touches_map_.find(touch->id());
if (it == prev_->touches_map_.end())
return UFStatusErrorInvalidTouch;
return prev_->touches_array_[it->second]->GetProperty(property, value);
}
UFStatus UFFrame::GetPreviousTouchValue(const UFTouch* touch, UFAxisType type,
float* value) const {
if (!prev_)
return UFStatusErrorInvalidTouch;
auto it = prev_->touches_map_.find(touch->id());
if (it == prev_->touches_map_.end())
return UFStatusErrorInvalidTouch;
return prev_->touches_array_[it->second]->GetValue(type, value);
}
UFStatus UFFrame::GetTouchByIndex(unsigned int index, ::UFTouch* touch) const {
if (index >= touches_array_.size())
return UFStatusErrorInvalidTouch;
*touch = touches_array_[index].get();
return UFStatusSuccess;
}
SharedUFTouch* UFFrame::GetSharedTouchById(UFTouchId touch_id) {
auto it = touches_map_.find(touch_id);
if (it == touches_map_.end())
return nullptr;
else
return &(touches_array_[it->second]);
}
UFStatus UFFrame::GetTouchById(UFTouchId touch_id, ::UFTouch* touch) const {
auto it = touches_map_.find(touch_id);
if (it == touches_map_.end())
return UFStatusErrorInvalidTouch;
*touch = touches_array_[it->second].get();
return UFStatusSuccess;
}
void UFFrame::ReleasePreviousFrame() {
prev_.reset();
}
} // namespace frame
} // namespace oif
extern "C" {
FRAME_PUBLIC
UFStatus frame_frame_get_property_device_(UFFrame frame,
UFFrameProperty property,
UFDevice *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetProperty(property, value);
}
FRAME_PUBLIC
UFStatus frame_frame_get_property_uint64_(UFFrame frame,
UFFrameProperty property,
uint64_t *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetProperty(property, value);
}
FRAME_PUBLIC
UFStatus frame_frame_get_property_unsigned_int_(UFFrame frame,
UFFrameProperty property,
unsigned int *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
if (property == UFFramePropertyNumTouches) {
*value = ufframe->GetNumTouches();
return UFStatusSuccess;
} else if (property == UFFramePropertyActiveTouches) {
UFStatus status = ufframe->GetProperty(property, value);
if (status != UFStatusSuccess) {
*value = ufframe->GetNumTouches();
status = UFStatusSuccess;
}
return status;
} else {
return ufframe->GetProperty(property, value);
}
}
#undef frame_frame_get_property /* Override C11 generic selections macro */
FRAME_PUBLIC
UFStatus frame_frame_get_property(UFFrame frame, UFFrameProperty property,
void *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
if (property == UFFramePropertyNumTouches) {
*reinterpret_cast(value) = ufframe->GetNumTouches();
return UFStatusSuccess;
} else if (property == UFFramePropertyActiveTouches) {
UFStatus status = ufframe->GetProperty(property, value);
if (status != UFStatusSuccess) {
*reinterpret_cast(value) = ufframe->GetNumTouches();
status = UFStatusSuccess;
}
return status;
} else {
return ufframe->GetProperty(property, value);
}
}
UFStatus frame_frame_get_touch_by_index(UFFrame frame, unsigned int index,
UFTouch *touch) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetTouchByIndex(index, touch);
}
UFStatus frame_frame_get_touch_by_id(UFFrame frame, UFTouchId touch_id,
UFTouch *touch) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetTouchById(touch_id, touch);
}
UFStatus frame_frame_get_previous_touch_property(UFFrame frame, UFTouch touch,
UFTouchProperty property,
void *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetPreviousTouchProperty(
static_cast(touch),
property,
value);
}
UFStatus frame_frame_get_previous_touch_value(UFFrame frame, UFTouch touch,
UFAxisType type, float *value) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetPreviousTouchValue(
static_cast(touch),
type,
value);
}
UFWindowId frame_frame_get_window_id(UFFrame frame) {
UFWindowId window_id;
const oif::frame::UFFrame* ufframe =
static_cast(frame);
UFStatus status = ufframe->GetProperty(UFFramePropertyWindowId, &window_id);
assert(status == UFStatusSuccess);
return window_id;
}
uint32_t frame_frame_get_num_touches(UFFrame frame) {
const oif::frame::UFFrame* ufframe =
static_cast(frame);
return ufframe->GetNumTouches();
}
UFDevice frame_frame_get_device(UFFrame frame) {
UFDevice device;
const oif::frame::UFFrame* ufframe =
static_cast(frame);
UFStatus status = ufframe->GetProperty(UFFramePropertyDevice, &device);
assert(status == UFStatusSuccess);
return device;
}
UFBackendFrame frame_backend_frame_new()
{
return new UFBackendFrame_(new oif::frame::UFFrame);
}
UFBackendFrame frame_backend_frame_create_next(UFBackendFrame frame)
{
return new UFBackendFrame_(new oif::frame::UFFrame(frame->shared_ptr));
}
UFFrame frame_backend_frame_get_frame(UFBackendFrame frame)
{
return frame->shared_ptr.get();
}
UFStatus frame_backend_frame_borrow_touch_by_id(UFBackendFrame frame,
UFTouchId id,
UFBackendTouch *touch)
{
oif::frame::UFFrame* ufframe =
static_cast(frame->shared_ptr.get());
oif::frame::SharedUFTouch *shared_touch = ufframe->GetSharedTouchById(id);
if (shared_touch) {
*touch = new UFBackendTouch_(*shared_touch);
return UFStatusSuccess;
} else {
return UFStatusErrorInvalidTouch;
}
}
void frame_backend_frame_set_device(UFBackendFrame frame, UFBackendDevice device)
{
static_cast(frame->shared_ptr.get())->
InsertProperty(UFFramePropertyDevice,
new oif::frame::Value(device->shared_ptr));
}
void frame_backend_frame_set_window_id(UFBackendFrame frame, UFWindowId window_id)
{
static_cast(frame->shared_ptr.get())->
InsertProperty(UFFramePropertyWindowId,
new oif::frame::Value(window_id));
}
void frame_backend_frame_set_active_touches(UFBackendFrame frame, unsigned int active_touches)
{
static_cast(frame->shared_ptr.get())->
InsertProperty(UFFramePropertyActiveTouches,
new oif::frame::Value(active_touches));
}
UFStatus frame_backend_frame_give_touch(UFBackendFrame frame, UFBackendTouch *touch)
{
UFStatus status;
/* the touch backend must be carrying a UFtouch */
assert((*touch)->shared_ptr);
status = static_cast(frame->shared_ptr.get())->
GiveTouch((*touch)->shared_ptr);
/* frame must have taken the touch */
assert(!(*touch)->shared_ptr);
delete (*touch);
*touch = nullptr;
return status;
}
void frame_backend_frame_delete(UFBackendFrame frame)
{
delete frame;
}
} // extern "C"
./src/device.cpp 0000644 0000041 0000041 00000017267 12752376120 014017 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#include "device.h"
#include "axis.h"
#include
namespace oif {
namespace frame {
UFStatus UFDevice::GetAxisByIndex(unsigned int index, ::UFAxis* axis) const {
if (index >= axes_.size())
return UFStatusErrorInvalidAxis;
auto it = axes_.cbegin();
std::advance(it, index);
*axis = it->second.get();
return UFStatusSuccess;
}
UFStatus UFDevice::GetAxisByType(UFAxisType type, ::UFAxis* axis) const {
auto it = axes_.find(type);
if (it == axes_.end())
return UFStatusErrorInvalidAxis;
*axis = it->second.get();
return UFStatusSuccess;
}
UFStatus UFDevice::AcceptTouch(UFWindowId window_id, UFTouchId touch_id)
{
(void)window_id;
(void)touch_id;
return UFStatusSuccess;
}
UFStatus UFDevice::RejectTouch(UFWindowId window_id, UFTouchId touch_id)
{
(void)window_id;
(void)touch_id;
return UFStatusSuccess;
}
} // namespace frame
} // namespace oif
extern "C" {
FRAME_PUBLIC
UFStatus frame_device_get_property_string_(UFDevice device,
UFDeviceProperty property,
char **value) {
return static_cast(device)->GetProperty(
property,
value);
}
FRAME_PUBLIC
UFStatus frame_device_get_property_int_(UFDevice device,
UFDeviceProperty property, int *value) {
return static_cast(device)->GetProperty(
property,
value);
}
FRAME_PUBLIC
UFStatus frame_device_get_property_unsigned_int_(UFDevice device,
UFDeviceProperty property,
unsigned int *value) {
if (property == UFDevicePropertyNumAxes) {
*value = static_cast(device)->axes_.size();
return UFStatusSuccess;
} else {
return static_cast(device)->GetProperty(
property,
value);
}
}
#undef frame_device_get_property /* Override C11 generic selections macro */
FRAME_PUBLIC
UFStatus frame_device_get_property(UFDevice device, UFDeviceProperty property,
void *value) {
if (property == UFDevicePropertyNumAxes) {
*reinterpret_cast(value) =
static_cast(device)->axes_.size();
return UFStatusSuccess;
} else {
return static_cast(device)->GetProperty(
property,
value);
}
}
UFStatus frame_device_get_axis_by_index(UFDevice device, unsigned int index,
UFAxis* axis) {
return static_cast(device)->GetAxisByIndex(
index,
axis);
}
UFStatus frame_device_get_axis_by_type(UFDevice device, UFAxisType type,
UFAxis* axis) {
return static_cast(device)->GetAxisByType(
type,
axis);
}
unsigned int frame_device_get_num_axes(UFDevice device) {
unsigned int num_axes;
UFStatus status = frame_device_get_property(device, UFDevicePropertyNumAxes,
&num_axes);
if (status == UFStatusSuccess)
return num_axes;
fprintf(stderr, "Error: failed to get device number of axes\n");
return 0;
}
float frame_device_get_window_resolution_x(UFDevice device) {
float resolution;
UFStatus status = frame_device_get_property(device,
UFDevicePropertyWindowResolutionX,
&resolution);
if (status == UFStatusSuccess)
return resolution;
fprintf(stderr, "Error: failed to get device X resolution\n");
return 0;
}
float frame_device_get_window_resolution_y(UFDevice device) {
float resolution;
UFStatus status = frame_device_get_property(device,
UFDevicePropertyWindowResolutionY,
&resolution);
if (status == UFStatusSuccess)
return resolution;
fprintf(stderr, "Error: failed to get device Y resolution\n");
return 0;
}
UFStatus frame_accept_touch(UFDevice device, UFWindowId window_id,
UFTouchId touch_id)
{
return static_cast(device)->
AcceptTouch(window_id, touch_id);
}
UFStatus frame_reject_touch(UFDevice device, UFWindowId window_id,
UFTouchId touch_id)
{
return static_cast(device)->
RejectTouch(window_id, touch_id);
}
UFBackendDevice frame_backend_device_new()
{
return new UFBackendDevice_(new oif::frame::UFDevice);
}
UFDevice frame_backend_device_get_device(UFBackendDevice device)
{
return device->shared_ptr.get();
}
void frame_backend_device_delete(UFBackendDevice device)
{
delete device;
}
void frame_backend_device_set_name(UFBackendDevice device, const char *name)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyName,
new oif::frame::Value(name));
}
void frame_backend_device_set_direct(UFBackendDevice device, int direct)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyDirect,
new oif::frame::Value(direct));
}
void frame_backend_device_set_independent(UFBackendDevice device, int independent)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyIndependent,
new oif::frame::Value(independent));
}
void frame_backend_device_set_semi_mt(UFBackendDevice device, int semi_mt)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertySemiMT,
new oif::frame::Value(semi_mt));
}
void frame_backend_device_set_max_touches(UFBackendDevice device, unsigned int max_touches)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyMaxTouches,
new oif::frame::Value(max_touches));
}
void frame_backend_device_set_window_resolution(UFBackendDevice device, float x, float y)
{
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyWindowResolutionX,
new oif::frame::Value(x));
static_cast(device->shared_ptr.get())->
InsertProperty(UFDevicePropertyWindowResolutionY,
new oif::frame::Value(y));
}
void frame_backend_device_add_axis(UFBackendDevice device,
UFAxisType type,
float min, float max, float resolution)
{
using oif::frame::UFAxis;
UFAxis_* axis = new UFAxis(type, min, max, resolution);
static_cast(device->shared_ptr.get())->
axes_[type] = std::unique_ptr(static_cast(axis));
}
} // extern "C"
./src/axis.cpp 0000644 0000041 0000041 00000003113 12752376103 013506 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#include "axis.h"
#include "value.h"
namespace oif {
namespace frame {
UFAxis::UFAxis(UFAxisType type, float min, float max, float resolution)
: type_(type), min_(min), max_(max), resolution_(resolution) {
}
} // namespace frame
} // namespace oif
extern "C" {
UFAxisType frame_axis_get_type(UFAxis axis) {
return static_cast(axis)->type();
}
float frame_axis_get_minimum(UFAxis axis) {
return static_cast(axis)->min();
}
float frame_axis_get_maximum(UFAxis axis) {
return static_cast(axis)->max();
}
float frame_axis_get_resolution(UFAxis axis) {
return static_cast(axis)->resolution();
}
} // extern "C"
./src/window.h 0000644 0000041 0000041 00000002622 12752376103 013522 0 ustar www-data www-data /*****************************************************************************
*
* frame - Touch Frame Library
*
* Copyright (C) 2011-2012 Canonical Ltd.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranties of
* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
****************************************************************************/
#ifndef FRAME_WINDOW_H_
#define FRAME_WINDOW_H_
#include