diff options
-rw-r--r-- | .gitignore | 44 | ||||
-rw-r--r-- | AUTHORS | 1 | ||||
-rw-r--r-- | Doxyfile | 2458 | ||||
-rw-r--r-- | LICENSE | 202 | ||||
-rw-r--r-- | Makefile.am | 2 | ||||
-rwxr-xr-x | autogen.sh | 18 | ||||
-rw-r--r-- | configure.ac | 90 | ||||
-rw-r--r-- | packaging/libsystem.spec | 105 | ||||
-rw-r--r-- | src/.gitignore | 2 | ||||
-rw-r--r-- | src/Makefile.am | 143 | ||||
-rw-r--r-- | src/libsystem-sd/.gitignore | 1 | ||||
-rw-r--r-- | src/libsystem-sd/libsystem-sd.pc.in | 17 | ||||
-rw-r--r-- | src/libsystem-sd/systemd.c | 876 | ||||
-rw-r--r-- | src/libsystem-sd/systemd.h | 734 | ||||
-rw-r--r-- | src/libsystem/.gitignore | 1 | ||||
-rw-r--r-- | src/libsystem/config-parser.c | 347 | ||||
-rw-r--r-- | src/libsystem/config-parser.h | 176 | ||||
-rw-r--r-- | src/libsystem/dbus-util.h | 63 | ||||
-rw-r--r-- | src/libsystem/exec.c | 90 | ||||
-rw-r--r-- | src/libsystem/glib-util.c | 56 | ||||
-rw-r--r-- | src/libsystem/glib-util.h | 146 | ||||
-rw-r--r-- | src/libsystem/libsystem.c | 887 | ||||
-rw-r--r-- | src/libsystem/libsystem.h | 955 | ||||
-rw-r--r-- | src/libsystem/libsystem.pc.in | 17 | ||||
-rw-r--r-- | src/libsystem/proc.c | 95 | ||||
-rw-r--r-- | src/libsystem/time-util.c | 87 | ||||
-rw-r--r-- | src/test/test-truncate_nl.c | 41 |
27 files changed, 7654 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8c45dde --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +.deps/ +.dirstamp +.libs/ +html/ +latex/ +.autotools +INSTALL +Makefile.in +README +aclocal.m4 +compile +config.guess +config.h +config.h.in +config.log +config.status +config.sub +configure +depcomp +install-sh +libtool +ltmain.sh +m4/* +missing +stamp-* +*~ +*.a +*.cache +*.html +*.la +*.lo +*.log +*.o +*.plist +*.pyc +*.stamp +*.swp +*.trs +/Makefile +/TAGS +/debugfiles.list +/debuglinks.list +/debugsources.list +/documentation.list
\ No newline at end of file @@ -0,0 +1 @@ +WaLyong Cho <walyong.cho@samsung.com> diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..2f5e01e --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2458 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# 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. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = libsystem + +# 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 = 4.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 = "system utility library" + +# With the PROJECT_LOGO tag one can specify a logo or an 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) path +# into which the generated documentation will be written. 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 = + +# 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 causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, 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. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, 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. +# The default value is: YES. + +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 and 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. +# The default value is: NO. + +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. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, 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 +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# 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. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = src/ + +# 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 list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = src/ + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +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-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +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 behavior. 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 behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +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. +# The default value is: NO. + +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. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +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. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. 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: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# 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); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) 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. +# The default value is: NO. + +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 will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +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. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES 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. +# The default value is: YES. + +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). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag 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. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +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. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If 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, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO 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. +# The default value is: NO. + +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, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +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, these declarations will be +# included in the documentation. +# The default value is: NO. + +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, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +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 then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +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. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = YES + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = 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. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES 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. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +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 constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# 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 group names will +# appear in their defined order. +# The default value is: NO. + +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 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. +# The default value is: NO. + +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. +# The default value is: NO. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +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. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# 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 value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +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. To 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. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag 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. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This 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, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = 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) +# The default value is: $file:$line: $text. + +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 standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src/libsystem \ + src/libsystem-sd + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +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 patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +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 +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */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. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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 information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +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 tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# 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 that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +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. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES 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. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES 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. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# 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 a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +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. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# 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 left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_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. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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 (see: http://developer.apple.com/tools/xcode/), 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset 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. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# 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. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_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. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# 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. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# 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. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# 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). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# 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. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# 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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 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. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# 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. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. 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. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# 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 pre-rendered 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 may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# 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 +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +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. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when enabling USE_PDFLATEX this option is only used for generating +# bitmaps for formulas in the HTML output, but not in the Makefile that is +# written to the output directory. +# The default file is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a +# higher quality PDF documentation. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = 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 too pretty with other RTF +# readers/editors. +# The default value is: NO. + +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. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +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 some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# 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. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's config file. A template extensions file can be generated +# using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# 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 value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +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. +# The default value is: NO. + +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. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# 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. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sf.net) file that captures the +# structure of the code including all documentation. Note that this feature is +# still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# 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. +# The default value is: NO. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +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. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +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. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +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, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set 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. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = 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. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +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. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +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 e.g. +# 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. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +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. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES 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. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. 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. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: 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. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +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. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of 'which perl'). +# The default file (with absolute path) is: /usr/bin/perl. + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML 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. +# The default value is: YES. + +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 = + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_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. +# The default value is: YES. + +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 (see: +# http://www.graphviz.org/), 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 value is: NO. + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 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. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates 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. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is 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. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = 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. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is 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. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is 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. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is 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. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +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). +# This tag requires that the tag HAVE_DOT is set to YES. + +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 DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# 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. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# 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. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# 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). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to 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. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..dfa49b2 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,2 @@ +AUTOMAKE_OPTIONS = foreign +SUBDIRS = src diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..7d3fd65 --- /dev/null +++ b/autogen.sh @@ -0,0 +1,18 @@ +#!/bin/sh + +set -e + +if [ -f .git/hooks/pre-commit.sample ] && [ ! -f .git/hooks/pre-commit ]; then + # This part is allowed to fail + cp -p .git/hooks/pre-commit.sample .git/hooks/pre-commit && \ + chmod +x .git/hooks/pre-commit && \ + echo "Activated pre-commit hook." || : +fi + +# README and INSTALL are required by automake, but may be deleted by +# clean up rules. to get automake to work, simply touch these here, +# they will be regenerated from their corresponding *.in files by +# ./configure anyway. +touch README INSTALL + +autoreconf --force --install --verbose || exit $? diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..49bf6cc --- /dev/null +++ b/configure.ac @@ -0,0 +1,90 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.68]) +AC_INIT([libsystem], [4.0], [walyong.cho@samsung.com]) + +dnl AC_CONFIG_MACRO_DIRS([m4]) +AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_HEADERS([config.h]) + +AC_USE_SYSTEM_EXTENSIONS +AC_SYS_LARGEFILE +AC_PREFIX_DEFAULT([/usr]) +AM_INIT_AUTOMAKE([foreign subdir-objects]) + +LT_PREREQ(2.2) +LT_INIT([disable-static]) + +# Checks for programs. +AC_PROG_CC +AC_PROG_INSTALL + +# Checks for libraries. +# FIXME: Replace `main' with a function in `-lrt': +AC_CHECK_LIB([rt], [main]) + +# Checks for header files. +AC_CHECK_HEADERS([limits.h mntent.h stddef.h stdint.h stdlib.h string.h sys/time.h unistd.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_C_INLINE +AC_TYPE_INT32_T +AC_TYPE_INT64_T +AC_TYPE_MODE_T +AC_TYPE_PID_T +AC_TYPE_SIZE_T +AC_TYPE_SSIZE_T +AC_TYPE_UINT32_T +AC_TYPE_UINT64_T + +# Checks for library functions. +AC_FUNC_FORK +AC_FUNC_GETMNTENT +AC_FUNC_LSTAT_FOLLOWS_SLASHED_SYMLINK +AC_FUNC_MKTIME +AC_FUNC_REALLOC +AC_CHECK_FUNCS([getmntent gettimeofday localtime_r memset mkdir rmdir strchr strcspn strdup strndup strrchr strspn]) + +# ------------------------------------------------------------------------------ +PKG_CHECK_MODULES(DBUS, [dbus-1 >= 1.3.2]) +PKG_CHECK_MODULES(GLIB, [glib-2.0]) +PKG_CHECK_MODULES(GIO, [gio-2.0]) + +# ------------------------------------------------------------------------------ +AC_SUBST([LIBSYSTEM_PC_REQUIRES], "") +AC_SUBST([LIBSYSTEM_PC_CFLAGS], "-D_GNU_SOURCE") +AC_SUBST([LIBSYSTEM_PC_LIBS], "-L${libdir} -lsystem") + +AC_SUBST([LIBSYSTEM_PC_REQUIRES], "${LIBSYSTEM_PC_REQUIRES} ${GLIB_REQUIRES}") +AC_SUBST([LIBSYSTEM_PC_CFLAGS], "${LIBSYSTEM_PC_CFLAGS} ${GLIB_CFLAGS}") +AC_SUBST([LIBSYSTEM_PC_LIBS], "${LIBSYSTEM_PC_LIBS} ${GLIB_LIBS}") + +# ------------------------------------------------------------------------------ +AC_SUBST([LIBSYSTEM_SD_PC_REQUIRES], "libsystem") +AC_SUBST([LIBSYSTEM_SD_PC_CFLAGS], "") +AC_SUBST([LIBSYSTEM_SD_PC_LIBS], "-L${libdir} -lsystem-sd") + +AC_SUBST([LIBSYSTEM_SD_PC_REQUIRES], "${LIBSYSTEM_SD_PC_REQUIRES} ${DBUS_REQUIRES}") +AC_SUBST([LIBSYSTEM_SD_PC_CFLAGS], "${LIBSYSTEM_SD_PC_CFLAGS} ${DBUS_CFLAGS}") +AC_SUBST([LIBSYSTEM_SD_PC_LIBS], "${LIBSYSTEM_SD_PC_LIBS} ${DBUS_LIBS}") + +AC_SUBST([LIBSYSTEM_SD_PC_REQUIRES], "${LIBSYSTEM_SD_PC_REQUIRES} ${GIO_REQUIRES}") +AC_SUBST([LIBSYSTEM_SD_PC_CFLAGS], "${LIBSYSTEM_SD_PC_CFLAGS} ${GIO_CFLAGS}") +AC_SUBST([LIBSYSTEM_SD_PC_LIBS], "${LIBSYSTEM_SD_PC_LIBS} ${GIO_LIBS}") + +# ------------------------------------------------------------------------------ +AC_CONFIG_FILES([Makefile + src/Makefile]) +AC_OUTPUT +AC_MSG_RESULT([ + $PACKAGE_NAME $VERSION + + prefix: ${prefix} + rootprefix: ${with_rootprefix} + datarootdir: ${datarootdir} + lib dir: ${libdir} + rootlib dir: ${with_rootlibdir} + + OUR CFLAGS: ${OUR_CFLAGS} ${CFLAGS} +]) diff --git a/packaging/libsystem.spec b/packaging/libsystem.spec new file mode 100644 index 0000000..a19c75a --- /dev/null +++ b/packaging/libsystem.spec @@ -0,0 +1,105 @@ +Name: libsystem +Summary: System Libraries +Version: 4.0 +Release: 0 +License: Apache-2.0 +Group: System/Libraries +Source: %{name}-%{version}.tar.gz + +BuildRequires: autoconf +BuildRequires: automake +BuildRequires: libtool +BuildRequires: pkgconfig(dbus-1) +BuildRequires: pkgconfig(glib-2.0) +BuildRequires: pkgconfig(gio-2.0) + +Requires: /bin/cp + +Requires(post): /sbin/ldconfig +Requires(postun): /sbin/ldconfig + +%description +System libraries. + +%package devel +Summary: Development header files for System Libraries +License: Apache-2.0 +Requires: pkgconfig(glib-2.0) + +%description devel +Development headers and auxiliary files. + +%package -n libsystem-sd +Summary: Utility libraries for systemd +License: Apache-2.0 + +%description -n libsystem-sd +systemd utility libraries. + +%package -n libsystem-sd-devel +Summary: Development header files for systemd util +License: Apache-2.0 +Requires: pkgconfig(gio-2.0) +Requires: pkgconfig(dbus-1) +Requires: pkgconfig(libsystem) + +%description -n libsystem-sd-devel +Development header files for systemd util. + +%prep +%setup -q + +%build +%if 0%{?debug_enable} +export CFLAGS=$(echo $CFLAGS | sed -e 's/^-g / /g' | sed -e 's/ -g / /g') +export CFLAGS=$(echo $CFLAGS | sed -e 's/^-O[0-9] / /g' | sed -e 's/ $-O[0-9] / /g') +export CFLAGS=$(echo $CFLAGS | sed -e 's/-Wp,-D_FORTIFY_SOURCE=2 / /g') +export CFLAGS="-O0 -g $CFLAGS" +%endif + +./autogen.sh +%configure \ + --disable-static \ + --prefix=%{_prefix} \ + +make %{?_smp_mflags} + +%install +%make_install + +# Remove local archives +rm -f %{buildroot}%{_libdir}/*.la + + +%post +/sbin/ldconfig + +%postun -p /sbin/ldconfig + +%post -n libsystem-sd +/sbin/ldconfig + +%postun -n libsystem-sd -p /sbin/ldconfig + +%files +%defattr(-,root,root,-) +%{_libdir}/libsystem.so.* + +%files devel +%defattr(-,root,root,-) +%{_libdir}/libsystem.so +%{_includedir}/libsystem/config-parser.h +%{_includedir}/libsystem/dbus-util.h +%{_includedir}/libsystem/glib-util.h +%{_includedir}/libsystem/libsystem.h +%{_libdir}/pkgconfig/libsystem.pc + +%files -n libsystem-sd +%defattr(-,root,root,-) +%{_libdir}/libsystem-sd.so.* + +%files -n libsystem-sd-devel +%defattr(-,root,root,-) +%{_libdir}/libsystem-sd.so +%{_includedir}/libsystem-sd/systemd.h +%{_libdir}/pkgconfig/libsystem-sd.pc diff --git a/src/.gitignore b/src/.gitignore new file mode 100644 index 0000000..7ca4570 --- /dev/null +++ b/src/.gitignore @@ -0,0 +1,2 @@ +/Makefile +/test-*
\ No newline at end of file diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..61fee7c --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,143 @@ +AUTOMAKE_OPTIONS = color-tests parallel-tests + +pkgconfiglibdir=$(libdir)/pkgconfig + +CLEANFILES = +EXTRA_DIST = + +lib_LTLIBRARIES = +noinst_LTLIBRARIES = +noinst_DATA = +pkgconfiglib_DATA = + +check_PROGRAMS = +check_DATA = +tests= +noinst_PROGRAMS = $(tests) +check_PROGRAMS += $(tests) +TESTS = $(tests) + +DEFAULT_CFLAGS = \ + $(OUR_CFLAGS) + +DEFAULT_LDFLAGS = \ + $(OUR_LDFLAGS) + +AM_CPPFLAGS = \ + -include $(top_builddir)/config.h \ + $(DEFAULT_CFLAGS) + +AM_CFLAGS = $(DEFAULT_CFLAGS) +AM_LDFLAGS = $(DEFAULT_LDFLAGS) + +INSTALL_EXEC_HOOKS = +UNINSTALL_EXEC_HOOKS = + +# ------------------------------------------------------------------------------ +pkgconfiglib_DATA += \ + libsystem/libsystem.pc + +EXTRA_DIST += \ + libsystem/libsystem.pc.in + +CLEANFILES += \ + libsystem/libsystem.pc + +libsystem_pkgincludedir=$(includedir)/libsystem +libsystem_pkginclude_HEADERS = + +libsystem_pkginclude_HEADERS += \ + libsystem/config-parser.h \ + libsystem/dbus-util.h \ + libsystem/glib-util.h \ + libsystem/libsystem.h + +lib_LTLIBRARIES += \ + libsystem.la + +libsystem_la_SOURCES = \ + libsystem/config-parser.c \ + libsystem/config-parser.h \ + libsystem/dbus-util.h\ + libsystem/exec.c \ + libsystem/glib-util.c \ + libsystem/glib-util.h \ + libsystem/libsystem.c \ + libsystem/libsystem.h \ + libsystem/proc.c \ + libsystem/time-util.c + +libsystem_la_CFLAGS = \ + $(AM_CFLAGS) \ + $(GLIB_CFLAGS) + +libsystem_la_LIBADD = \ + -lrt + +# ------------------------------------------------------------------------------ +test_truncate_nl_SOURCES = \ + test/test-truncate_nl.c + +test_truncate_nl_LDADD = \ + libsystem.la + +tests += test-truncate_nl + +# ------------------------------------------------------------------------------ +pkgconfiglib_DATA += \ + libsystem-sd/libsystem-sd.pc + +EXTRA_DIST += \ + libsystem-sd/libsystem-sd.pc.in + +CLEANFILES += \ + libsystem-sd/libsystem-sd.pc + +libsystem_sd_pkgincludedir=$(includedir)/libsystem-sd +libsystem_sd_pkginclude_HEADERS = + +libsystem_sd_pkginclude_HEADERS += \ + libsystem-sd/systemd.h + +lib_LTLIBRARIES += \ + libsystem-sd.la + +libsystem_sd_la_SOURCES = \ + libsystem-sd/systemd.c \ + libsystem-sd/systemd.h + +libsystem_sd_la_CFLAGS = \ + $(AM_CFLAGS) \ + $(DBUS_CFLAGS) \ + $(GLIB_CFLAGS) \ + $(GIO_CFLAGS) + +libsystem_sd_la_LIBADD = \ + -lrt \ + $(DBUS_LIBS) \ + $(GIO_LIBS) \ + libsystem.la + +# ------------------------------------------------------------------------------ +substitutions = \ + '|PACKAGE_VERSION=$(PACKAGE_VERSION)|' \ + '|PACKAGE_NAME=$(PACKAGE_NAME)|' \ + '|PACKAGE_URL=$(PACKAGE_URL)|' \ + '|LIBSYSTEM_PC_REQUIRES=$(LIBSYSTEM_PC_REQUIRES)|' \ + '|LIBSYSTEM_PC_CFLAGS=$(LIBSYSTEM_PC_CFLAGS)|' \ + '|LIBSYSTEM_PC_LIBS=$(LIBSYSTEM_PC_LIBS)|' \ + '|LIBSYSTEM_SD_PC_REQUIRES=$(LIBSYSTEM_SD_PC_REQUIRES)|' \ + '|LIBSYSTEM_SD_PC_CFLAGS=$(LIBSYSTEM_SD_PC_CFLAGS)|' \ + '|LIBSYSTEM_SD_PC_LIBS=$(LIBSYSTEM_SD_PC_LIBS)|' \ + '|includedir=$(includedir)|' \ + '|VERSION=$(VERSION)|' + +SED_PROCESS = \ + $(AM_V_GEN)$(MKDIR_P) $(dir $@) && \ + $(SED) $(subst '|,-e 's|@,$(subst =,\@|,$(subst |',|g',$(substitutions)))) \ + < $< > $@ + +%.pc: %.pc.in + $(SED_PROCESS) + +install-exec-hook: $(INSTALL_EXEC_HOOKS) diff --git a/src/libsystem-sd/.gitignore b/src/libsystem-sd/.gitignore new file mode 100644 index 0000000..15db81b --- /dev/null +++ b/src/libsystem-sd/.gitignore @@ -0,0 +1 @@ +/libsystem-sd.pc
\ No newline at end of file diff --git a/src/libsystem-sd/libsystem-sd.pc.in b/src/libsystem-sd/libsystem-sd.pc.in new file mode 100644 index 0000000..ba7828b --- /dev/null +++ b/src/libsystem-sd/libsystem-sd.pc.in @@ -0,0 +1,17 @@ +# Package Information for pkg-config +# +# Copyright (c) 2016 Samsung Electronics Co., Ltd. +# All rights reserved. +# + +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: libsystem-sd +Description: systemd Dbus utility libraries +Version: @PACKAGE_VERSION@ +Requires.private: @LIBSYSTEM_SD_PC_REQUIRES@ +Cflags: @LIBSYSTEM_SD_PC_CFLAGS@ +Libs: @LIBSYSTEM_SD_PC_LIBS@ diff --git a/src/libsystem-sd/systemd.c b/src/libsystem-sd/systemd.c new file mode 100644 index 0000000..ec53b90 --- /dev/null +++ b/src/libsystem-sd/systemd.c @@ -0,0 +1,876 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem-sd + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stdio.h> +#include <assert.h> +#include <gio/gio.h> +#include <errno.h> + +#include "libsystem/libsystem.h" +#include "libsystem/glib-util.h" +#include "libsystem-sd/systemd.h" + +#define DBUS_INTERFACE_DBUS_PROPERTIES DBUS_SERVICE_DBUS ".Properties" +#define DBUS_INTERFACE_DBUS_PEER DBUS_SERVICE_DBUS ".Peer" +#define DBUS_INTERFACE_DBUS_INTROSPECTABLE DBUS_SERVICE_DBUS ".Introspectable" + +#define ERR_MSG_DUP(to, from) do { \ + (to) = strdup((from)); \ + assert((to)); \ +} while (0) + +static const char* const systemd_unit_type_string[_SYSTEMD_UNIT_TYPE_MAX] = { + [SYSTEMD_UNIT_SERVICE] = "service", + [SYSTEMD_UNIT_SOCKET] = "socket", + [SYSTEMD_UNIT_DEVICE] = "device", + [SYSTEMD_UNIT_MOUNT] = "mount", + [SYSTEMD_UNIT_AUTOMOUNT] = "automount", + [SYSTEMD_UNIT_SWAP] = "swap", + [SYSTEMD_UNIT_TARGET] = "target", + [SYSTEMD_UNIT_PATH] = "path", + [SYSTEMD_UNIT_TIMER] = "timer", + [SYSTEMD_UNIT_SNAPSHOT] = "snapshot", + [SYSTEMD_UNIT_SLICE] = "slice", + [SYSTEMD_UNIT_SCOPE] = "scope", +}; + +static int systemd_call_sync(GDBusConnection *connection, + const char *name, + const char *path, + const char *iface, + const char *method, + GVariant *parameters, + GVariant **reply, + GError **error) { + + GError *err = NULL; + GVariant *gvar; + +#if (GLIB_MAJOR_VERSION <= 2 && GLIB_MINOR_VERSION < 36) + g_type_init(); +#endif + + assert(name); + assert(path); + assert(iface); + assert(method); + assert(reply); + assert(error && !*error); + + if (connection) + gvar = g_dbus_connection_call_sync(connection, + name, + path, + iface, + method, + parameters, + NULL, + G_DBUS_CALL_FLAGS_NONE, + -1, + NULL, + &err); + else { + _cleanup_g_object_unref_ GDBusProxy *proxy = NULL; + + proxy = g_dbus_proxy_new_for_bus_sync(G_BUS_TYPE_SYSTEM, + G_DBUS_PROXY_FLAGS_NONE, + NULL, /* GDBusInterfaceInfo */ + name, + path, + iface, + NULL, /* GCancellable */ + &err); + + if (err) { + *error = err; + return -gerror_to_errno(err); + } + + err = NULL; + gvar = g_dbus_proxy_call_sync(proxy, + method, + parameters, + G_DBUS_CALL_FLAGS_NONE, + -1, + NULL, /* GCancellable */ + &err); + } + + if (err) { + *error = err; + return -gerror_to_errno(err); + } + + g_assert(gvar != NULL); + *reply = gvar; + + return 0; +} + +int systemd_subscribe(GDBusConnection *connection, char **err_msg) { + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + int r; + + r = systemd_call_sync(connection, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + "Subscribe", + NULL, + &reply, + &error); + if (error) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + return -gerror_to_errno(error); + } + + return r; +} + +int systemd_unsubscribe(GDBusConnection *connection, char **err_msg) { + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + int r; + + r = systemd_call_sync(connection, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + "Unsubscribe", + NULL, + &reply, + &error); + if (error) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + return -gerror_to_errno(error); + } + + return r; +} + +int systemd_get_unit(GDBusConnection *connection, + const char *name, + char **unit, + char **err_msg) { + + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + char *obj = NULL; + int r; + + assert(name); + assert(unit); + + r = systemd_call_sync(connection, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + "GetUnit", + g_variant_new("(s)", + name), + &reply, + &error); + if (r < 0) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + return -gerror_to_errno(error); + } + + if (!g_variant_is_of_type(reply, G_VARIANT_TYPE("(o)"))) { + if (err_msg) + ERR_MSG_DUP(*err_msg, "reply message is not type of object path"); + + return -EBADMSG; + } + + g_variant_get(reply, "(o)", &obj); + + *unit = obj; + + return 0; +} + +int systemd_control_unit(GDBusConnection *connection, + const char *method, + const char *name, + char **job, + char **err_msg) { + + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + char *obj = NULL; + int r; + + assert(method); + assert(name); + assert(job); + + r = systemd_call_sync(connection, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + method, + g_variant_new("(ss)", + name, + "replace"), + &reply, + &error); + if (r < 0) { + *err_msg = strdup(error->message); + if (!*err_msg) + return -ENOMEM; + + return -gerror_to_errno(error); + } + + if (!g_variant_is_of_type(reply, G_VARIANT_TYPE("(o)"))) { + if (err_msg) + ERR_MSG_DUP(*err_msg, "reply message is not type of object path"); + + return -EBADMSG; + } + + g_variant_get(reply, "(o)", &obj); + + *job = obj; + + return 0; +} + +int systemd_start_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "StartUnit", name, job, err_msg); +} + +int systemd_stop_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "StopUnit", name, job, err_msg); +} + +int systemd_reload_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "ReloadUnit", name, job, err_msg); +} + +int systemd_restart_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "RestartUnit", name, job, err_msg); +} + +int systemd_try_restart_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "TryRestartUnit", name, job, err_msg); +} + +int systemd_reload_or_restart_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "ReloadOrRestartUnit", name, job, err_msg); +} + +int systemd_reload_or_try_restart_unit(GDBusConnection *connection, + const char *name, + char **job, + char **err_msg) { + + assert(name); + assert(job); + + return systemd_control_unit(connection, "ReloadOrTryRestartUnit", name, job, err_msg); +} + +static int systemd_get_property(GDBusConnection *connection, + const char *name, + const char *path, + const char *iface, + const char *method, + const char *interface, + const char *property, + GVariant **variant, + char **err_msg) { + + _cleanup_g_error_free_ GError *error = NULL; + int r; + + assert(name); + assert(path); + assert(iface); + assert(method); + assert(interface); + assert(property); + assert(variant); + + r = systemd_call_sync(connection, + name, + path, + iface, + method, + g_variant_new("(ss)", + interface, + property), + variant, + &error); + + if (r < 0) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + r = -gerror_to_errno(error); + } + + return r; +} + +static int systemd_get_manager_property(GDBusConnection *connection, + const char *iface, + const char *property, + GVariant **variant, + char **err_msg) { + + assert(iface); + assert(property); + assert(variant); + + return systemd_get_property(connection, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_INTERFACE_DBUS_PROPERTIES, + "Get", + iface, + property, + variant, + err_msg); +} + +static int systemd_get_unit_property(GDBusConnection *connection, + const char *unit, + const char *property, + GVariant **variant, + char **err_msg) { + + _cleanup_free_ char *systemd_unit_obj_path = NULL; + int r; + + assert(unit); + assert(property); + assert(variant); + + r = systemd_get_unit(connection, unit, &systemd_unit_obj_path, err_msg); + if (r < 0) + return r; + + return systemd_get_property(connection, + DBUS_SYSTEMD_BUSNAME, + systemd_unit_obj_path, + DBUS_INTERFACE_DBUS_PROPERTIES, + "Get", + DBUS_SYSTEMD_INTERFACE_UNIT, + property, + variant, + err_msg); +} + +static int systemd_get_service_property(GDBusConnection *connection, + const char *unit, + const char *property, + GVariant **variant, + char **err_msg) { + + _cleanup_free_ char *systemd_unit_obj_path = NULL; + int r; + + assert(unit); + assert(property); + assert(variant); + + r = systemd_get_unit(connection, unit, &systemd_unit_obj_path, err_msg); + if (r < 0) + return r; + + return systemd_get_property(connection, + DBUS_SYSTEMD_BUSNAME, + systemd_unit_obj_path, + DBUS_INTERFACE_DBUS_PROPERTIES, + "Get", + DBUS_SYSTEMD_INTERFACE_SERVICE, + property, + variant, + err_msg); +} + +#define g_variant_get_function_int32_t(v) g_variant_get_int32(v) +#define g_variant_get_function_int64_t(v) g_variant_get_int64(v) +#define g_variant_get_function_uint32_t(v) g_variant_get_uint32(v) +#define g_variant_get_function_uint64_t(v) g_variant_get_uint64(v) +#define g_variant_get_function_string(v) g_variant_dup_string(v, NULL) +#define g_variant_get_function_strv(v) g_variant_dup_strv(v, NULL) + +#define DEFINE_SYSTEMD_GET_PROPERTY(iface, type, value) \ + int systemd_get_##iface##_property_as_##type( \ + GDBusConnection *connection, \ + const char* target, \ + const char* property, \ + value* result, \ + char** err_msg) { \ + \ + _cleanup_g_variant_unref_ GVariant *var = NULL, *inner = NULL; \ + int r; \ + \ + assert(target); \ + assert(property); \ + assert(result); \ + \ + r = systemd_get_##iface##_property(connection, \ + target, \ + property, \ + &var, \ + err_msg); \ + if (r < 0) \ + return r; \ + \ + g_assert(g_variant_is_of_type(var, G_VARIANT_TYPE("(v)"))); \ + g_variant_get(var, g_variant_get_type_string(var), &inner); \ + *result = g_variant_get_function_##type(inner); \ + \ + return 0; \ + } + +DEFINE_SYSTEMD_GET_PROPERTY(manager, int32_t, int32_t) +DEFINE_SYSTEMD_GET_PROPERTY(manager, uint32_t, uint32_t) +DEFINE_SYSTEMD_GET_PROPERTY(manager, int64_t, int64_t) +DEFINE_SYSTEMD_GET_PROPERTY(manager, uint64_t, uint64_t) +DEFINE_SYSTEMD_GET_PROPERTY(manager, string, char*) +DEFINE_SYSTEMD_GET_PROPERTY(manager, strv, char**) +DEFINE_SYSTEMD_GET_PROPERTY(unit, int32_t, int32_t) +DEFINE_SYSTEMD_GET_PROPERTY(unit, uint32_t, uint32_t) +DEFINE_SYSTEMD_GET_PROPERTY(unit, int64_t, int64_t) +DEFINE_SYSTEMD_GET_PROPERTY(unit, uint64_t, uint64_t) +DEFINE_SYSTEMD_GET_PROPERTY(unit, string, char*) +DEFINE_SYSTEMD_GET_PROPERTY(unit, strv, char**) +DEFINE_SYSTEMD_GET_PROPERTY(service, int32_t, int32_t) +DEFINE_SYSTEMD_GET_PROPERTY(service, uint32_t, uint32_t) +DEFINE_SYSTEMD_GET_PROPERTY(service, int64_t, int64_t) +DEFINE_SYSTEMD_GET_PROPERTY(service, uint64_t, uint64_t) +DEFINE_SYSTEMD_GET_PROPERTY(service, string, char*) +DEFINE_SYSTEMD_GET_PROPERTY(service, strv, char**) + +enum SystemdUnitType systemd_get_unit_type_from_name(const char *unit) { + enum SystemdUnitType type = _SYSTEMD_UNIT_TYPE_INVALID; + enum SystemdUnitType t; + const char *e; + + assert(unit); + + e = strrchr(unit, '.'); + if (!e) + return _SYSTEMD_UNIT_TYPE_INVALID; + + for (t = 0; t < _SYSTEMD_UNIT_TYPE_MAX; t++) { + if (endswith(e + 1, systemd_unit_type_string[t])) { + type = t; + break; + } + } + + return type; +} + +int systemd_get_service_main_pid(GDBusConnection *connection, + const char *unit, + pid_t *pid, + char **err_msg) { + uint32_t u; + int r; + + assert(unit); + assert(pid); + + r = systemd_get_service_property_as_uint32_t(connection, + unit, + "ExecMainPID", + &u, + err_msg); + if (r < 0) + return r; + + *pid = (pid_t) u; + + return 0; +} + +void systemd_unit_status_free(struct systemd_unit_status *unit_status) { + + if (!unit_status) + return; + + if (unit_status->name) + free(unit_status->name); + + if (unit_status->description) + free(unit_status->description); + + if (unit_status->load_state) + free(unit_status->load_state); + + if (unit_status->active_state) + free(unit_status->active_state); + + if (unit_status->sub_state) + free(unit_status->sub_state); + + if (unit_status->followed) + free(unit_status->followed); + + if (unit_status->obj_path) + free(unit_status->obj_path); + + if (unit_status->job_type) + free(unit_status->job_type); + + if (unit_status->job_obj_path) + free(unit_status->job_obj_path); + + free(unit_status); +} + +static void systemd_unit_status_destroy_notify(gpointer data) { + systemd_unit_status_free((struct systemd_unit_status *)data); +} + +void systemd_unit_status_list_free_full(GList *status_list) { + + if (!status_list) + return; + + g_list_free_full(status_list, systemd_unit_status_destroy_notify); +} + +static int systemd_parse_list_units_result(GVariant *result, GList **unit_list) { + char *name, *description, *load_state, *active_state, *sub_state; + char *followed, *obj_path, *job_type, *job_obj_path; + _cleanup_g_variant_iter_free_ GVariantIter *iter; + unsigned int job_id; + GList *list = NULL; + int r; + + g_variant_get(result, "(a(ssssssouso))", &iter); + + while (g_variant_iter_loop(iter, + "(ssssssouso)", + &name, + &description, + &load_state, + &active_state, + &sub_state, + &followed, + &obj_path, + &job_id, + &job_type, + &job_obj_path)) { + + struct systemd_unit_status *unit_status = NULL; + + unit_status = new0(struct systemd_unit_status, 1); + if (!unit_status) { + r = -ENOMEM; + goto on_error; + } + + /* + * At the first, prepend unit_status to list. If error + * occurred, we have to destroy the list fully. To + * easily free this unit_status also, prepend this + * unit_list to the list. + */ + list = g_list_prepend(list, unit_status); + + if (name) { + unit_status->name = strdup(name); + if (!unit_status->name) { + r = -ENOMEM; + goto on_error; + } + } + + if (description) { + unit_status->description = strdup(description); + if (!unit_status->description) { + r = -ENOMEM; + goto on_error; + } + } + + if (load_state) { + unit_status->load_state = strdup(load_state); + if (!unit_status->load_state) { + r = -ENOMEM; + goto on_error; + } + } + + if (active_state) { + unit_status->active_state = strdup(active_state); + if (!unit_status->active_state) { + r = -ENOMEM; + goto on_error; + } + } + if (sub_state) { + unit_status->sub_state = strdup(sub_state); + if (!unit_status->sub_state) { + r = -ENOMEM; + goto on_error; + } + } + + if (followed) { + unit_status->followed = strdup(followed); + if (!unit_status->followed) { + r = -ENOMEM; + goto on_error; + } + } + + if (obj_path) { + unit_status->obj_path = strdup(obj_path); + if (!unit_status->obj_path) { + r = -ENOMEM; + goto on_error; + } + } + + unit_status->job_id = job_id; + + if (job_type) { + unit_status->job_type = strdup(job_type); + if (!unit_status->job_type) { + r = -ENOMEM; + goto on_error; + } + } + + if (job_obj_path) { + unit_status->job_obj_path = strdup(job_obj_path); + if (!unit_status->job_obj_path) { + r = -ENOMEM; + goto on_error; + } + } + } + + *unit_list = list; + + return 0; + +on_error: + if (list) + systemd_unit_status_list_free_full(list); + + return r; +} + +int systemd_get_units_list(GDBusConnection *conn, GList **unit_list, char **err_msg) { + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + int r; + + assert(unit_list); + + r = systemd_call_sync(conn, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + "ListUnits", + NULL, + &reply, + &error); + if (r < 0) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + return r; + } + + if (!g_variant_is_of_type(reply, G_VARIANT_TYPE("(a(ssssssouso))"))) { + if (err_msg) + *err_msg = strdup("systemd ListUnits() reply message is not type of (a(ssssssouso))"); + + return -EBADMSG; + } + + return systemd_parse_list_units_result(reply, unit_list); +} + + +void systemd_unit_file_status_free(struct systemd_unit_file_status *unit_file_status) { + + if (!unit_file_status) + return; + + if (unit_file_status->name) + free(unit_file_status->name); + + if (unit_file_status->status) + free(unit_file_status->status); + + free(unit_file_status); +} + +static void systemd_unit_file_status_destroy_notify(gpointer data) { + systemd_unit_file_status_free((struct systemd_unit_file_status *)data); +} + +void systemd_unit_file_status_list_free_full(GList *status_list) { + if (status_list) + return; + + g_list_free_full(status_list, systemd_unit_file_status_destroy_notify); +} + +static int systemd_parse_list_unit_files_result(GVariant *result, GList **unit_files_list) { + _cleanup_g_variant_iter_free_ GVariantIter *iter; + GList *list = NULL; + char *name, *status; + int r; + + g_variant_get(result, "(a(ss))", &iter); + + while (g_variant_iter_loop(iter, + "(ss)", + &name, + &status)) { + + struct systemd_unit_file_status *unit_file_status = NULL; + + unit_file_status = new0(struct systemd_unit_file_status, 1); + if (!unit_file_status) { + r = -ENOMEM; + goto on_error; + } + + /* + * At the first, prepend unit_file_status to list. If + * error occurred, we have to destroy the list + * fully. To easily free this unit_file_status also, + * prepend this unit_file_status to the list. + */ + list = g_list_prepend(list, unit_file_status); + + if (name) { + unit_file_status->name = strdup(name); + if (!unit_file_status->name) { + r = -ENOMEM; + goto on_error; + } + } + + if (status) { + unit_file_status->status = strdup(status); + if (!unit_file_status->status) { + r = -ENOMEM; + goto on_error; + } + } + } + + *unit_files_list = list; + + return 0; + +on_error: + if (list) + systemd_unit_file_status_list_free_full(list); + + return r; +} + +int systemd_get_unit_files_list(GDBusConnection *conn, GList **unit_files_list, char **err_msg) { + _cleanup_g_variant_unref_ GVariant *reply = NULL; + _cleanup_g_error_free_ GError *error = NULL; + int r; + + assert(conn); + assert(unit_files_list); + + r = systemd_call_sync(conn, + DBUS_SYSTEMD_BUSNAME, + DBUS_SYSTEMD_PATH, + DBUS_SYSTEMD_INTERFACE_MANAGER, + "ListUnitFiles", + NULL, + &reply, + &error); + if (r < 0) { + if (err_msg) + ERR_MSG_DUP(*err_msg, error->message); + + return r; + } + + if (!g_variant_is_of_type(reply, G_VARIANT_TYPE("(a(ss))"))) { + if (err_msg) + *err_msg = strdup("systemd ListUnitFiles() reply message is not type of (a(ss))"); + + return -EBADMSG; + } + + return systemd_parse_list_unit_files_result(reply, unit_files_list); +} diff --git a/src/libsystem-sd/systemd.h b/src/libsystem-sd/systemd.h new file mode 100644 index 0000000..b9fb24a --- /dev/null +++ b/src/libsystem-sd/systemd.h @@ -0,0 +1,734 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem-sd + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file systemd.h + * + * systemd utility library + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved. + * + */ + +#pragma once + +#include <stdint.h> +#include <dbus/dbus.h> +#include <gio/gio.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @defgroup SYSTEMD_HELPER_GROUP systemd Helper + * + * @brief systemd utility library + * @{ + */ + +/** + * enumerate systemd unit type + */ +enum SystemdUnitType { + /** service type systemd unit */ + SYSTEMD_UNIT_SERVICE = 0, + /** socket type systemd unit */ + SYSTEMD_UNIT_SOCKET, + /** device type systemd unit */ + SYSTEMD_UNIT_DEVICE, + /** mount type systemd unit */ + SYSTEMD_UNIT_MOUNT, + /** automount type systemd unit */ + SYSTEMD_UNIT_AUTOMOUNT, + /** swap type systemd unit */ + SYSTEMD_UNIT_SWAP, + /** target type systemd unit */ + SYSTEMD_UNIT_TARGET, + /** path type systemd unit */ + SYSTEMD_UNIT_PATH, + /** timer type systemd unit */ + SYSTEMD_UNIT_TIMER, + /** snapshot type systemd unit */ + SYSTEMD_UNIT_SNAPSHOT, + /** slice type systemd unit */ + SYSTEMD_UNIT_SLICE, + /** scope type systemd unit */ + SYSTEMD_UNIT_SCOPE, + /** maxium number of this enum */ + _SYSTEMD_UNIT_TYPE_MAX, + /** invalid type systemd unit */ + _SYSTEMD_UNIT_TYPE_INVALID = -1 +}; + +/** "org.freedesktop.systemd1" */ +#define DBUS_SYSTEMD_BUSNAME "org.freedesktop.systemd1" +/** "org.freedesktop.systemd1.Manager" */ +#define DBUS_SYSTEMD_INTERFACE_MANAGER DBUS_SYSTEMD_BUSNAME ".Manager" +/** "org.freedesktop.systemd1.Unit" */ +#define DBUS_SYSTEMD_INTERFACE_UNIT DBUS_SYSTEMD_BUSNAME ".Unit" +/** "org.freedesktop.systemd1.Service" */ +#define DBUS_SYSTEMD_INTERFACE_SERVICE DBUS_SYSTEMD_BUSNAME ".Service" +/** "org.freedesktop.systemd1.Target" */ +#define DBUS_SYSTEMD_INTERFACE_TARGET DBUS_SYSTEMD_BUSNAME ".Target" + +/** "/org/freedesktop/systemd1" */ +#define DBUS_SYSTEMD_PATH "/org/freedesktop/systemd1" +/** "/org/freedesktop/systemd1/unit" */ +#define DBUS_SYSTEMD_UNIT_PATH DBUS_SYSTEMD_PATH "/unit" +/** "/org/freedesktop/systemd1/unit/" */ +#define DBUS_SYSTEMD_UNIT_PATH_PREFIX DBUS_SYSTEMD_UNIT_PATH "/" + +/** + * @brief Subscribe systemd signals. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_subscribe(GDBusConnection *connection, char **err_msg); + +/** + * @brief Subscribe systemd signals. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_unsubscribe(GDBusConnection *connection, char **err_msg); + +/** + * @brief Get unit DBus object path. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param unit unit object path is filled on success. NULL on + * failure. If this value is returned with not NULL, this value has + * to be free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit(GDBusConnection *connection, const char *name, char **unit, char **err_msg); + +/** + * @brief Controls systemd unit. Internally, use method call to + * systemd. systemd unit control method calls are only allowed to + * root uid. So the caller of this api is also run with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param method systemd unit control DBus method call name + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_control_unit(GDBusConnection *connection, const char *method, const char *name, char **job, char **err_msg); + +/** + * @brief Start systemd unit. Internally, use systemd "StartUnit" + * method call to systemd. systemd unit control method calls are + * only allowed to root uid. So the caller of this api is also run + * with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_start_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Stop systemd unit. Internally, use systemd "StopUnit" + * method call to systemd. systemd unit control method calls are + * only allowed to root uid. So the caller of this api is also run + * with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_stop_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Reload systemd unit. Internally, use systemd "ReloadUnit" + * method call to systemd. systemd unit control method calls are + * only allowed to root uid. So the caller of this api is also run + * with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_reload_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Restart systemd unit. Internally, use systemd "RestartUnit" + * method call to systemd. systemd unit control method calls are + * only allowed to root uid. So the caller of this api is also run + * with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_restart_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Try to restart systemd unit. Internally, use systemd + * "TryRestartUnit" method call to systemd. Different with + * RestartUnit, if the unit is not running, the unit is not started. + * systemd unit control method calls are only allowed to root + * uid. So the caller of this api is also run with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_try_restart_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Reload(if unit support) and restart systemd + * unit. Internally, use systemd "ReloadOrRestartUnit" method call + * to systemd. systemd unit control method calls are only allowed to + * root uid. So the caller of this api is also run with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_reload_or_restart_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Reload(if unit support) and try to restart systemd + * unit. Internally, use systemd "ReloadOrTryRestartUnit" method + * call to systemd. Similar to "TryRestartUnit", if the unit is not + * running, the unit is not restarted. systemd unit control method + * calls are only allowed to root uid. So the caller of this api is + * also run with root uid. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param name systemd unit name + * @param job systemd job object path is filled such like + * "/org/freedesktop/systemd1/job/2416". + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_reload_or_try_restart_unit(GDBusConnection *connection, const char *name, char **job, char **err_msg); + +/** + * @brief Get systemd manager int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_int32_t(GDBusConnection *connection, const char *iface, const char *property, int32_t *result, char **err_msg); + +/** + * @brief Get systemd manager uint32 type(unsigned int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_uint32_t(GDBusConnection *connection, const char *iface, const char *property, uint32_t *result, char **err_msg); + +/** + * @brief Get systemd manager int64 type(long long) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_int64_t(GDBusConnection *connection, const char *iface, const char *property, int64_t *result, char **err_msg); + +/** + * @brief Get systemd manager uint64 type(unsigned long long) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_uint64_t(GDBusConnection *connection, const char *iface, const char *property, uint64_t *result, char **err_msg); + +/** + * @brief Get systemd manager string type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Duplicated property result string. This value has to + * be free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_string(GDBusConnection *connection, const char *iface, const char *property, char **result, char **err_msg); + +/** + * @brief Get systemd manager string list type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param iface systemd manager interface. Generally + * DBUS_SYSTEMD_INTERFACE_MANAGER can be used. + * @param property Property name + * @param result Duplicated string list. This string list has to be + * free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_manager_property_as_strv(GDBusConnection *connection, const char *iface, const char *property, char ***result, char **err_msg); + +/** + * @brief Get systemd unit int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_int32_t(GDBusConnection *connection, const char *unit, const char *property, int32_t *result, char **err_msg); + +/** + * @brief Get systemd unit uint32 type(unsigned int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_uint32_t(GDBusConnection *connection, const char *unit, const char *property, uint32_t *result, char **err_msg); + +/** + * @brief Get systemd unit int64 type(long long) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_int64_t(GDBusConnection *connection, const char *unit, const char *property, int64_t *result, char **err_msg); + +/** + * @brief Get systemd unit uint64 type(unsigned long long) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_uint64_t(GDBusConnection *connection, const char *unit, const char *property, uint64_t *result, char **err_msg); + +/** + * @brief Get systemd unit string type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name + * @param property Property name + * @param result Duplicated property result string. This value has to + * be free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_string(GDBusConnection *connection, const char *unit, const char *property, char **result, char **err_msg); + +/** + * @brief Get systemd unit string list type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name + * @param property Property name + * @param result Duplicated string list. This string list has to be + * free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_property_as_strv(GDBusConnection *connection, const char *unit, const char *property, char ***result, char **err_msg); + +/** + * @brief Get systemd service int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_int32_t(GDBusConnection *connection, const char *unit, const char *property, int32_t *result, char **err_msg); + +/** + * @brief Get systemd service int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_uint32_t(GDBusConnection *connection, const char *unit, const char *property, uint32_t *result, char **err_msg); + +/** + * @brief Get systemd service int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_int64_t(GDBusConnection *connection, const char *unit, const char *property, int64_t *result, char **err_msg); + +/** + * @brief Get systemd service int32 type(int) property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name. + * @param property Property name + * @param result Property get result + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_uint64_t(GDBusConnection *connection, const char *unit, const char *property, uint64_t *result, char **err_msg); + +/** + * @brief Get systemd service string type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name + * @param property Property name + * @param result Duplicated property result string. This value has to + * be free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_string(GDBusConnection *connection, const char *unit, const char *property, char **result, char **err_msg); + +/** + * @brief Get systemd service string list type property. + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd unit name + * @param property Property name + * @param result Duplicated string list. This string list has to be + * free-ed by caller. + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_property_as_strv(GDBusConnection *connection, const char *unit, const char *property, char ***result, char **err_msg); + +/** + * @brief Get systemd unit type from unit name + * + * @param unit name + * + * @return a #SystemdUnitType. _SYSTEMD_UNIT_TYPE_INVALID for unknown. + */ +enum SystemdUnitType systemd_get_unit_type_from_name(const char *unit); + +/** + * @brief Get systemd service main pid + * + * @param connection GDBus connection or NULL. If connection is NULL, + * this is working with GDBusProxy. + * @param unit systemd service name + * @param pid main pid variable pointer + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_service_main_pid(GDBusConnection *connection, const char *unit, pid_t *pid, char **err_msg); + +/** + * systemd unit status + */ +struct systemd_unit_status { + /** + * The primary unit name as string + */ + char *name; + + /** + * The human readable description string + */ + char *description; + + /** + * The load state (i.e. whether the unit file has been loaded + * successfully) + */ + char *load_state; + + /** + * The active state (i.e. whether the unit is currently + * started or not) + */ + char *active_state; + + /** + * The sub state (a more fine-grained version of the active + * state that is specific to the unit type, which the active + * state is not) + */ + char *sub_state; + + /** + * A unit that is being followed in its state by this unit, if + * there is any, otherwise the empty string. + */ + char *followed; + + /** + * The unit object path + */ + char *obj_path; + + /** + * If there is a job queued for the job unit the numeric job + * id, 0 otherwise + */ + unsigned int job_id; + + /** + * The job type as string + */ + char *job_type; + + /** + * The job object path + */ + char *job_obj_path; +}; + +/** + * @brief free #systemd_unit_status struct + * + * @param unit_status a #systemd_unit_status struct + */ +void systemd_unit_status_free(struct systemd_unit_status *unit_status); + +/** + * @brief free all #systemd_unit_status struct list + * + * @param status_list #systemd_unit_status struct list to free + */ +void systemd_unit_status_list_free_full(GList *status_list); + +/** + * @brief Get currently loaded systemd unit list. + * + * @param conn GDBus connection or NULL. If connection is NULL, this + * is working with GDBusProxy. + * @param unit_list loaded systemd unit list is stored to here on + * success. This list has to be destroied by called after use with + * #systemd_unit_status_list_free_full(). + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_units_list(GDBusConnection *conn, GList **unit_list, char **err_msg); + +/** + * systemd unit file status + */ +struct systemd_unit_file_status { + /** + * The primary unit name as string + */ + char *name; + + /** + * The primary unit name as string + */ + char *status; +}; + +/** + * @brief free #systemd_unit_file_status struct + * + * @param unit_file_status a #systemd_unit_file_status struct + */ +void systemd_unit_file_status_free(struct systemd_unit_file_status *unit_file_status); + +/** + * @brief free all #systemd_unit_file_status struct list + * + * @param status_list #systemd_unit_file_status struct list to free + */ +void systemd_unit_file_status_list_free_full(GList *status_list); + +/** + * @brief Get an array of unit names plus their enablement + * status. Note that #systemd_get_units_list() returns a list of units + * currently loaded into memory, while #systemd_get_unit_files_list() + * returns a list of unit files that could be found on disk. + * + * @param conn GDBus connection or NULL. If connection is NULL, this + * is working with GDBusProxy. @param unit_files_list unit files + * list what can be found by systemd. This list has to be destroied + * by called after use with + * #systemd_unit_file_status_list_free_full(). + * @param err_msg NULL is filled on success, error message is filled + * on failure. This value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int systemd_get_unit_files_list(GDBusConnection *conn, GList **unit_files_list, char **err_msg); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif diff --git a/src/libsystem/.gitignore b/src/libsystem/.gitignore new file mode 100644 index 0000000..c97363e --- /dev/null +++ b/src/libsystem/.gitignore @@ -0,0 +1 @@ +/libsystem.pc
\ No newline at end of file diff --git a/src/libsystem/config-parser.c b/src/libsystem/config-parser.c new file mode 100644 index 0000000..3319056 --- /dev/null +++ b/src/libsystem/config-parser.c @@ -0,0 +1,347 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stdio.h> +#include <string.h> +#include <errno.h> +#include <assert.h> +#include <stdbool.h> +#include <limits.h> + +#include "libsystem.h" +#include "config-parser.h" + +#define MAX_SECTION 64 + +static int config_table_lookup( + void *table, + const char *section, + const char *lvalue, + ConfigParserCallback *func, + int *ltype, + void **data) { + + ConfigTableItem *t; + + assert(table); + assert(lvalue); + assert(func); + assert(ltype); + assert(data); + + for (t = table; t->lvalue; t++) { + + if (!streq(lvalue, t->lvalue)) + continue; + + if (!streq_ptr(section, t->section)) + continue; + + *func = t->cb; + *ltype = t->ltype; + *data = t->data; + return 1; + } + + return 0; +} + +/* Run the user supplied parser for an assignment */ +static int config_parse_table( + const char *filename, + unsigned line, + void *table, + const char *section, + const char *lvalue, + const char *rvalue) { + + ConfigParserCallback cb = NULL; + int ltype = 0; + void *data = NULL; + int r; + + assert(filename); + assert(section); + assert(lvalue); + assert(rvalue); + + r = config_table_lookup(table, + section, + lvalue, + &cb, + <ype, + &data); + if (r <= 0) + return r; + + if (cb) + return cb(filename, + line, + section, + lvalue, + ltype, + rvalue, + data); + + return 0; +} + +int config_parse( + const char *filename, + void *table) { + + _cleanup_fclose_ FILE *f = NULL; + char *sections[MAX_SECTION] = { 0 }; + char *section = NULL, *n, *e, l[LINE_MAX]; + size_t len; + int i, r, num_section = 0; + bool already; + unsigned line = 0; + + assert(filename); + + f = fopen(filename, "r"); + if (!f) + return -errno; + + while (!feof(f)) { + _cleanup_free_ char *lvalue = NULL, *rvalue = NULL; + + if (fgets(l, LINE_MAX, f) == NULL) { + if (feof(f)) + break; + + r = -errno; + goto finish; + } + + line++; + truncate_nl(l); + + if (strchr(COMMENTS NEWLINE, *l)) + continue; + + if (*l == '[') { + len = strlen(l); + if (l[len-1] != ']') { + r = -EBADMSG; + goto finish; + } + + n = strndup(l+1, len-2); + if (!n) { + r = -ENOMEM; + goto finish; + } + + already = false; + for (i = 0; i < num_section; i++) { + if (streq(n, sections[i])) { + section = sections[i]; + already = true; + free(n); + break; + } + } + + if (already) + continue; + + section = n; + sections[num_section] = n; + num_section++; + if (num_section > MAX_SECTION) { + r = -EOVERFLOW; + goto finish; + } + + continue; + } + + if (!section) + continue; + + e = strchr(l, '='); + if (e == NULL) + continue; + + r = strndup_strip(l, e - l, &lvalue); + if (r < 0) + goto finish; + + r = strdup_strip(e + 1, &rvalue); + if (r < 0) + goto finish; + + r = config_parse_table(filename, + line, + table, + section, + lvalue, + rvalue); + if (r < 0) + goto finish; + } + + r = 0; + +finish: + for (i=0; i<num_section; i++) + if (sections[i]) + free(sections[i]); + + return r; +} + +int config_parse_dir(const char *dir, ConfigParseFunc fp, void *data) { + _cleanup_closedir_ DIR *d = NULL; + struct dirent *de; + + d = opendir(dir); + if (!d) + return errno; + + FOREACH_DIRENT(de, d, return -errno) { + _cleanup_free_ char *path = NULL; + int r; + + if (de->d_type != DT_REG) + continue; + + r = asprintf(&path, "%s/%s", dir, de->d_name); + if (r < 0) + return -ENOMEM; + + /* Do not just break loop until parse all file of + * dir. ignore return */ + (void) fp(path, data); + } + + return 0; +} + +int config_parse_int( + const char *filename, + unsigned line, + const char *section, + const char *lvalue, + int ltype, + const char *rvalue, + void *data) { + + int *i = data; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + if (!is_number(rvalue, strlen(rvalue))) + return -EINVAL; + + *i = atoi(rvalue); + + return 0; +} + +int config_parse_bool( + const char *filename, + unsigned line, + const char *section, + const char *lvalue, + int ltype, + const char *rvalue, + void *data) { + + int k; + bool *b = data; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + k = parse_boolean(rvalue); + if (k < 0) + return 0; + + *b = !!k; + return 0; +} + +int config_parse_string( + const char *filename, + unsigned line, + const char *section, + const char *lvalue, + int ltype, + const char *rvalue, + void *data) { + + char **s = data, *n; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + if (isempty(rvalue)) + n = NULL; + else { + n = strdup(rvalue); + if (!n) + return -ENOMEM; + } + + free(*s); + *s = n; + + return 0; +} + +int config_parse_bytes( + const char *filename, + unsigned line, + const char *section, + const char *lvalue, + int ltype, + const char *rvalue, + void *data) { + + size_t *ss = data, s = 0; + int r; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + if (isempty(rvalue)) + s = 0; + else { + r = parse_bytes(rvalue, &s); + if (r < 0) + return r; + } + + *ss = s; + + return 0; +} diff --git a/src/libsystem/config-parser.h b/src/libsystem/config-parser.h new file mode 100644 index 0000000..f2e9d3f --- /dev/null +++ b/src/libsystem/config-parser.h @@ -0,0 +1,176 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file config-parser.h + * + * ini type config file parser + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved. + * + */ + +#pragma once + +#include <stdio.h> +#ifndef __cplusplus +#include <stdbool.h> +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Prototype for a parser for a specific configuration setting + */ +typedef int (*ConfigParserCallback)( + const char *filename, + unsigned line, + const char *section, + const char *lvalue, + int ltype, + const char *rvalue, + void *data); + +/** + * @brief A callback function of #config_parse_dir. + * + * @param path a parsing config file name + * @param data user data to be passed by #config_parse_dir. + */ +typedef int (*ConfigParseFunc)(const char *path, void *data); + +/** + * Wraps information for parsing a specific configuration variable, to + * be stored in a simple array + */ +typedef struct ConfigTableItem { + /** + * Section + */ + const char *section; + + /** + * Name of the variable + */ + const char *lvalue; + + /** + * Function that is called to parse the variable's value + */ + ConfigParserCallback cb; + + /** + * Distinguish different variables passed to the same callback + */ + int ltype; + + /** + * Where to store the variable's data + */ + void *data; +} ConfigTableItem; + +/** + * @brief config parser function + * + * @param filename full path of config file + * @param table a table of #ConfigTableItem to parse + * + * @return 0 on success, -errno on failure. + */ +int config_parse(const char *filename, void *table); + +/** + * @brief parse all regular config files in directory + * + * @param dir dir full path + * @param fp config parse function. + * @param data user data to be passed to config parser function + * + * @return 0 on success, -errno on failure. + */ +int config_parse_dir(const char *dir, ConfigParseFunc fp, void *data); + + +/** + * @brief A common int type rvalue parser. + * + * @param filename a parsing config file name + * @param line a parsing config file line + * @param section a parsing config file section + * @param lvalue a parsing config file left value + * @param ltype a parsing config file left value type. (not used.) + * @param rvalue a parsing config file rvalue + * @param data user data + * + * @return 0 on success, -errno on failure. + */ +int config_parse_int(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data); + +/** + * @brief A common boolean type rvalue parser. + * + * @param filename a parsing config file name + * @param line a parsing config file line + * @param section a parsing config file section + * @param lvalue a parsing config file left value + * @param ltype a parsing config file left value type. (not used.) + * @param rvalue a parsing config file rvalue + * @param data user data + * + * @return 0 on success, -errno on failure. + */ +int config_parse_bool(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data); + +/** + * @brief A common string type rvalue parser. + * + * @param filename a parsing config file name + * @param line a parsing config file line + * @param section a parsing config file section + * @param lvalue a parsing config file left value + * @param ltype a parsing config file left value type. (not used.) + * @param rvalue a parsing config file rvalue + * @param data user data + * + * @return 0 on success, -errno on failure. + */ +int config_parse_string(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data); + +/** + * @brief A common byte type rvalue parser. + * + * @param filename a parsing config file name + * @param line a parsing config file line + * @param section a parsing config file section + * @param lvalue a parsing config file left value + * @param ltype a parsing config file left value type. (not used.) + * @param rvalue a parsing config file rvalue + * @param data user data + * + * @return 0 on success, -errno on failure. + */ +int config_parse_bytes(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data); + +#ifdef __cplusplus +} +#endif diff --git a/src/libsystem/dbus-util.h b/src/libsystem/dbus-util.h new file mode 100644 index 0000000..6f2a953 --- /dev/null +++ b/src/libsystem/dbus-util.h @@ -0,0 +1,63 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file dbus-util.h + * + * dbus utility library + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved. + * + */ + +#pragma once + +#include <dbus/dbus.h> +#include "libsystem.h" + +#ifdef __cplusplus +extern "C" { +#endif + +static inline void __dbus_error_free(DBusError *error) { + if (error && dbus_error_is_set(error)) + dbus_error_free(error); +} + +static inline void __dbus_message_unref(DBusMessage **message) { + if (*message) + dbus_message_unref(*message); +} + +/** + * Declare value with cleanup attribute. dbus_error_free() is called + * when is going out the scope. + */ +#define _cleanup_dbus_error_free_ _cleanup_(__dbus_error_free) + +/** + * Declare value with cleanup attribute. dbus_message_unref() is + * called when is going out the scope. + */ +#define _cleanup_dbus_message_unref_ _cleanup_(__dbus_message_unref) + +#ifdef __cplusplus +} +#endif diff --git a/src/libsystem/exec.c b/src/libsystem/exec.c new file mode 100644 index 0000000..05dc89c --- /dev/null +++ b/src/libsystem/exec.c @@ -0,0 +1,90 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stdlib.h> +#include <stdio.h> +#include <unistd.h> +#include <string.h> +#include <errno.h> +#include <assert.h> +#include <stdint.h> +#include <stdbool.h> +#include <sys/time.h> +#include <sys/types.h> +#include <sys/wait.h> + +#include "libsystem.h" + +int do_fork_exec(char *const argv[], char * const envp[], int64_t timeout_msec) { + pid_t pid; + + assert(argv); + + pid = fork(); + if (pid < 0) + return -errno; + else if (pid == 0) { + if (!envp) + execv(*argv, argv); + else + execvpe(*argv, argv, envp); + + _exit(EXIT_FAILURE); + } else { + struct timeval start, timeout; + int status; + + if (timeout_msec < 0) + return 0; + + if (timeout_msec > 0) { + msec_to_timeval((uint64_t) timeout_msec, &timeout); + + if (gettimeofday(&start, NULL) < 0) + return -errno; + } + + for (;;) { + struct timeval current, delta; + pid_t p; + + p = waitpid(pid, &status, WNOHANG); + if (p == pid) + break; + + if (timeout_msec == 0) + continue; + + if (gettimeofday(¤t, NULL) < 0) + return -errno; + + timersub(¤t, &start, &delta); + + if (timercmp(&timeout, &delta, <)) + return -ETIME; + + usleep(100000); + } + + return WEXITSTATUS(status); + } + + return 0; +} diff --git a/src/libsystem/glib-util.c b/src/libsystem/glib-util.c new file mode 100644 index 0000000..5866b4c --- /dev/null +++ b/src/libsystem/glib-util.c @@ -0,0 +1,56 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <errno.h> +#include <assert.h> +#include <glib.h> + +static const int gerror_code_table[] = { + [G_FILE_ERROR_EXIST] = EEXIST, + [G_FILE_ERROR_ISDIR] = EISDIR, + [G_FILE_ERROR_ACCES] = EACCES, + [G_FILE_ERROR_NAMETOOLONG] = ENAMETOOLONG, + [G_FILE_ERROR_NOENT] = ENOENT, + [G_FILE_ERROR_NOTDIR] = ENOTDIR, + [G_FILE_ERROR_NXIO] = ENXIO, + [G_FILE_ERROR_NODEV] = ENODEV, + [G_FILE_ERROR_ROFS] = EROFS, + [G_FILE_ERROR_TXTBSY] = ETXTBSY, + [G_FILE_ERROR_FAULT] = EFAULT, + [G_FILE_ERROR_LOOP] = ELOOP, + [G_FILE_ERROR_NOSPC] = ENOSPC, + [G_FILE_ERROR_NOMEM] = ENOMEM, + [G_FILE_ERROR_MFILE] = EMFILE, + [G_FILE_ERROR_NFILE] = ENFILE, + [G_FILE_ERROR_BADF] = EBADF, + [G_FILE_ERROR_INVAL] = EINVAL, + [G_FILE_ERROR_PIPE] = EPIPE, + [G_FILE_ERROR_AGAIN] = EAGAIN, + [G_FILE_ERROR_INTR] = EINTR, + [G_FILE_ERROR_IO] = EIO, + [G_FILE_ERROR_PERM] = EPERM, + [G_FILE_ERROR_NOSYS] = ENOSYS, +}; + +int gerror_to_errno(GError *error) { + assert(error); + + return gerror_code_table[error->code]; +} diff --git a/src/libsystem/glib-util.h b/src/libsystem/glib-util.h new file mode 100644 index 0000000..b87ebdf --- /dev/null +++ b/src/libsystem/glib-util.h @@ -0,0 +1,146 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file glib-util.h + * + * GLib utility library + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved. + * + */ + +#pragma once + +#include <glib.h> +#include <gio/gio.h> + +#include "libsystem.h" + +#ifdef __cplusplus +extern "C" { +#endif + + +/** + * gchar free function. This function has to not be called + * directly. If a gchar value is declared with #_cleanup_g_free_, this + * function is called when the value goes out of scope. + */ +static inline void __g_free(gchar **p) { + if (*p) + g_free(*p); +} + +/** + * GError free function. This function has to not be called + * directly. If a GError value is declared with + * #_cleanup_g_error_free_, this function is called when the value + * goes out of scope. + */ +static inline void __g_error_free(GError **e) { + if (*e) + g_error_free(*e); +} + +/** + * GObject free function. This function has to not be called + * directly. If a GObject value is declared with + * #_cleanup_g_object_unref_, this function is called when the value + * goes out of scope. + */ +static inline void __g_object_unref(gpointer p) { + if (p) + g_object_unref(*(gpointer *) p); +} + +/** + * GVariant free function. This function has to not be called + * directly. If a GVariant value is declared with + * #_cleanup_g_variant_unref_, this function is called when the value + * goes out of scope. + */ +static inline void __g_variant_unref(GVariant **v) { + if (*v) + g_variant_unref(*v); +} + +/** + * GVariantIter free function. This function has to not be called + * directly. If a GVariantIter value is declared with + * #_cleanup_g_variant_iter_free_, this function is called when the + * value goes out of scope. + */ +static inline void __g_variant_iter_free(GVariantIter **i) { + if (*i) + g_variant_iter_free(*i); +} + +/** + * cleanup attribute for gchar to run #__g_free() when the value is + * going out of scope. + */ +#define _cleanup_g_free_ _cleanup_(__g_free) + +/** + * cleanup attribute for GError to run #__g_error_free() when the + * value is going out of scope. + */ +#define _cleanup_g_error_free_ _cleanup_(__g_error_free) + +/** + * cleanup attribute for GObject to run #__g_object_unref() when the + * value is going out of scope. + */ +#define _cleanup_g_object_unref_ _cleanup_(__g_object_unref) + +/** + * cleanup attribute for GVariant to run #__g_variant_unref() when the + * value is going out of scope. + */ +#define _cleanup_g_variant_unref_ _cleanup_(__g_variant_unref) + +/** + * cleanup attribute for GVariantIter to run #__g_variant_iter_free() + * when the value is going out of scope. + */ +#define _cleanup_g_variant_iter_free_ _cleanup_(__g_variant_iter_free) + +/** + * @brief Iterate for each list nodes. + * + * @param n each list nodes + * @param l list to iterate + */ +#define FOREACH_G_LIST(n, l) \ + for (n = g_list_first(l); n; n = g_list_next(n)) + +/** + * @brief Convert GError to errno. + * + * @param error GError to convert + * + * @return converted errno. + */ +int gerror_to_errno(GError *error); + +#ifdef __cplusplus +} +#endif diff --git a/src/libsystem/libsystem.c b/src/libsystem/libsystem.c new file mode 100644 index 0000000..0159c03 --- /dev/null +++ b/src/libsystem/libsystem.c @@ -0,0 +1,887 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stddef.h> +#include <assert.h> +#include <errno.h> +#include <unistd.h> +#include <limits.h> +#include <ctype.h> +#include <sys/wait.h> +#include <sys/stat.h> +#include <mntent.h> + +#include "libsystem.h" + +static int _errno_old; + +#define STORE_RESET_ERRNO do { \ + _errno_old = errno; \ + errno = 0; \ +} while (0) + +#define RESTORE_ERRNO do { \ + errno = _errno_old; \ + _errno_old = 0; \ +} while (0) + +bool streq_ptr(const char *a, const char *b) { + + /* Like streq(), but tries to make sense of NULL pointers */ + + if (a && b) + return streq(a, b); + + if (!a && !b) + return true; + + return false; +} + +char *truncate_nl(char *s) { + assert(s); + + s[strcspn(s, NEWLINE)] = 0; + + return s; +} + +char *strnappend(const char *s, const char *suffix, size_t b) { + size_t a; + char *r; + + if (!s && !suffix) + return strdup(""); + + if (!s) + return strndup(suffix, b); + + if (!suffix) + return strdup(s); + + assert(s); + assert(suffix); + + a = strlen(s); + if (b > ((size_t) -1) - a) + return NULL; + + r = new(char, a+b+1); + if (!r) + return NULL; + + memcpy(r, s, a); + memcpy(r+a, suffix, b); + r[a+b] = 0; + + return r; +} + +char *strappend(const char *s, const char *suffix) { + return strnappend(s, suffix, suffix ? strlen(suffix) : 0); +} + +char *strstrip(char *s) { + char *e; + + /* Drops trailing whitespace. Modifies the string in + * place. Returns pointer to first non-space character */ + + s += strspn(s, WHITESPACE); + + for (e = strchr(s, 0); e > s; e --) + if (!strchr(WHITESPACE, e[-1])) + break; + + *e = 0; + + return s; +} + +int strdup_strip(const char *str, char **ret) { + char *r = NULL; + size_t s, l; + + assert(str); + assert(ret); + + s = strspn(str, WHITESPACE); + + for (l = strlen(str + s); l > 0; l--) + if (!strchr(WHITESPACE, str[s + l - 1])) + break; + + r = strndup(str + s, l); + if (!r) + return -ENOMEM; + + *ret = r; + + return 0; +} + +int strndup_strip(const char *str, size_t len, char **ret) { + char *r = NULL; + size_t s, l; + + assert(str); + assert(ret); + + s = strspn(str, WHITESPACE); + + l = strlen(str + s); + if (len > s) + l = l < len - s ? l : len - s; + else + return -EFAULT; + + for (; l > 0; l--) + if (!strchr(WHITESPACE, str[s + l - 1])) + break; + + r = strndup(str + s, l); + if (!r) + return -ENOMEM; + + *ret = r; + + return 0; +} + +bool nulstr_contains(const char*nulstr, const char *needle) { + const char *i; + + if (!nulstr) + return false; + + NULSTR_FOREACH(i, nulstr) + if (streq(i, needle)) + return true; + + return false; +} + +bool path_is_absolute(const char *p) { + + assert(p); + + return p[0] == '/'; +} + +char *path_kill_slashes(char *path) { + char *f, *t; + bool slash = false; + + /* Removes redundant inner and trailing slashes. Modifies the + * passed string in-place. + * + * ///foo///bar/ becomes /foo/bar + */ + + for (f = path, t = path; *f; f++) { + + if (*f == '/') { + slash = true; + continue; + } + + if (slash) { + slash = false; + *(t++) = '/'; + } + + *(t++) = *f; + } + + /* Special rule, if we are talking of the root directory, a + trailing slash is good */ + + if (t == path && slash) + *(t++) = '/'; + + *t = 0; + return path; +} + +char* endswith(const char *s, const char *postfix) { + size_t sl, pl; + + assert(s); + assert(postfix); + + sl = strlen(s); + pl = strlen(postfix); + + if (pl == 0) + return (char*) s + sl; + + if (sl < pl) + return NULL; + + if (memcmp(s + sl - pl, postfix, pl) != 0) + return NULL; + + return (char*) s + sl - pl; +} + +int parse_boolean(const char *v) { + assert(v); + + if (streq(v, "1") || v[0] == 'y' || v[0] == 'Y' || v[0] == 't' || v[0] == 'T' || strcaseeq(v, "on")) + return 1; + else if (streq(v, "0") || v[0] == 'n' || v[0] == 'N' || v[0] == 'f' || v[0] == 'F' || strcaseeq(v, "off")) + return 0; + + return -EINVAL; +} + +int parse_bytes(const char *b, size_t *s) { + _cleanup_free_ char *num = NULL; + size_t len, num_l, unit_l; + + assert(b); + + len = strlen(b); + + if (!len) + return 0; + + num_l = strspn(b, "0123456789"); + if (num_l < len-1) + return -EINVAL; + + unit_l = strcspn(b, "BKMG"); + if (num_l != unit_l) + return -EINVAL; + + num = strndup(b, num_l); + if (!num) + return -ENOMEM; + + switch (b[len - 1]) { + case 'G': + *s = atoi(num) << 30; + break; + case 'M': + *s = atoi(num) << 20; + break; + case 'K': + *s = atoi(num) << 10; + break; + case 'B': + default: + *s = atoi(num); + break; + } + + return 0; +} + +int parse_percent(const char *string, size_t *percent) { + _cleanup_free_ char *num = NULL; + size_t len, num_len, per; + + assert(string); + assert(percent); + + len = strlen(string); + if (!len) + return 0; + + if (string[len-1] != '%') + return -EINVAL; + + num_len = strspn(string, "0123456789"); + if (num_len < len-1) + return -EINVAL; + + num = strndup(string, num_len); + if (!num) + return -ENOMEM; + + per = atoi(num); + if (per > 100) + return -EINVAL; + + *percent = per; + + return 0; +} + +static bool __quote_complete(char *str, size_t l, char q) { + char *s, *s2; + + assert(str); + + if (!l) + return true; + + s = strchr(str, q); + if (!s || (s - str) > l) + return true; + + s = strchr(s + 1, q); + if (!s || (s - str) > l) + return false; + + s2 = strchr(s + 1, q); + if (!s2 || (s2 - str) > l) + return true; + + return __quote_complete(s + 1, l - (s + 1 - str), q); +} + +static bool quote_complete(char *str, size_t l) { + char quotes[] = QUOTES; + int i; + + assert(str); + + if (!l) + return true; + + for (i = 0; quotes[i]; i++) { + if (!__quote_complete(str, l, quotes[i])) + return false; + } + + return true; +} + +char *split(const char *c, size_t *l, const char *separator, char **state) { + bool separator_include_quotes; + char *current; + size_t s; + + assert(c); + assert(l); + assert(separator); + assert(state); + + current = *state ? *state : (char*) c; + if (!*current || *c == 0) + return NULL; + + *l = 0; + separator_include_quotes = !!strspn(separator, QUOTES); + current += strspn(current, separator); + + while((s = strcspn(current + *l, separator))) { + *l += s; + if (separator_include_quotes || + quote_complete(current, *l)) + break; + (*l)++; + } + + *state = current + *l; + + return (char *)current; +} + +bool is_number(const char *s, int l) { + int i; + + for (i = 0; i < l; i++) + if (!isdigit(s[i])) + return false; + + return true; +} + +int do_copy(const char *src, const char *dst, const char *option, int64_t timeout_msec) { + /* TODO + * change direct execution of cp to c api + */ + char *argv[] = {"/bin/cp", NULL, NULL, NULL, NULL}; + + assert(src); + assert(dst); + assert(option); + + argv[1] = (char *)src; + argv[2] = (char *)dst; + argv[3] = (char *)option; + + return do_fork_exec(argv, NULL, timeout_msec); +} + +int do_mkdir(const char *path, mode_t mode) { + size_t s, l; + int p; + int r; + + assert(path); + + l = strlen(path); + + for (p = 0, s = 0; p < l; p += s+1) { + _cleanup_free_ char *d = NULL; + + s = strcspn(path+p, "/"); + if (!s) + continue; + + d = new0(char, p+s+1); + if (!d) + return -ENOMEM; + + r = snprintf(d, p+s+1, "%s", path); + if (r < 0) + return r; + + r = mkdir(d, mode); + if (r < 0 && errno != EEXIST) + return -errno; + } + + return 0; +} + +int rmdir_recursive(const char *path) { + _cleanup_closedir_ DIR *d = NULL; + struct dirent *de; + int r; + + assert(path); + + d = opendir(path); + if (!d) + return -errno; + + FOREACH_DIRENT(de, d, return -errno) { + _cleanup_free_ char *p = NULL; + + r = asprintf(&p, "%s/%s", path, de->d_name); + if (r < 0) + return -ENOMEM; + + if (de->d_type == DT_DIR) { + r = rmdir_recursive(p); + if (r < 0) + return r; + } else { + r = unlink(p); + if (r < 0) + return r; + } + } + + return rmdir(path); +} + +char *strdup_unquote(const char *str, const char *quotes) { + size_t l; + + assert(str); + + l = strlen(str); + if (l < 2) + return strdup(str); + + if (strchr(quotes, str[0]) && + str[0] == str[l-1]) + return strndup(str+1, l-2); + + return strdup(str); +} + +int write_str_to_file(FILE *f, const char *str, enum file_write_flags flags) { + int r = 0; + + assert(f); + assert(str); + + STORE_RESET_ERRNO; + + (void) fputs(str, f); + if ((flags & FILE_WRITE_NEWLINE_IF_NOT) && + !endswith(str, "\n")) + (void) fputc('\n', f); + + if (flags & FILE_WRITE_WITH_FFLUSH) + (void) fflush(f); + + if (ferror(f)) + r = errno ? -errno : -EIO; + + RESTORE_ERRNO; + + return r; +} + +int write_str_to_path(const char *path, const char *str, enum file_write_flags flags) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + assert(str); + + if (flags & FILE_WRITE_APPEND) + f = fopen(path, "ae"); + else + f = fopen(path, "we"); + if (!f) + return -errno; + + return write_str_to_file(f, str, flags); +} + +int write_int32_to_file(FILE *f, int32_t i, enum file_write_flags flags) { + int r = 0; + + assert(f); + + STORE_RESET_ERRNO; + + (void) fprintf(f, "%d", i); + if (flags & FILE_WRITE_NEWLINE_IF_NOT) + (void) fputc('\n', f); + + if (flags & FILE_WRITE_WITH_FFLUSH) + (void) fflush(f); + + if (ferror(f)) + r = errno ? -errno : -EIO; + + RESTORE_ERRNO; + + return r; +} + +int write_int32_to_path(const char *path, int32_t i, enum file_write_flags flags) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + + if (flags & FILE_WRITE_APPEND) + f = fopen(path, "ae"); + else + f = fopen(path, "we"); + if (!f) + return -errno; + + return write_int32_to_file(f, i, flags); +} + +int write_uint32_to_file(FILE *f, uint32_t u, enum file_write_flags flags) { + int r = 0; + + assert(f); + + STORE_RESET_ERRNO; + + (void) fprintf(f, "%u", u); + if (flags & FILE_WRITE_NEWLINE_IF_NOT) + (void) fputc('\n', f); + + if (flags & FILE_WRITE_WITH_FFLUSH) + (void) fflush(f); + + if (ferror(f)) + r = errno ? -errno : -EIO; + + RESTORE_ERRNO; + + return r; +} + +int write_uint32_to_path(const char *path, uint32_t u, enum file_write_flags flags) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + + if (flags & FILE_WRITE_APPEND) + f = fopen(path, "ae"); + else + f = fopen(path, "we"); + if (!f) + return -errno; + + return write_uint32_to_file(f, u, flags); +} + +int read_one_line_from_file(FILE *f, char **line) { + char t[LINE_MAX], *c; + + assert(f); + assert(line); + + STORE_RESET_ERRNO; + + if (!fgets(t, sizeof(t), f)) { + + if (ferror(f)) { + int r; + + r = errno ? -errno : -EIO; + RESTORE_ERRNO; + return r; + } + + t[0] = 0; + } + + RESTORE_ERRNO; + + c = strdup(t); + if (!c) + return -ENOMEM; + + *line = truncate_nl(c); + + return 0; +} + +int read_one_line_from_path(const char *path, char **line) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + assert(line); + + f = fopen(path, "re"); + if (!f) + return -errno; + + return read_one_line_from_file(f, line); +} + +int read_int32_from_file(FILE *f, int32_t *i) { + int r = 0; + + assert(f); + assert(i); + + STORE_RESET_ERRNO; + + r = fscanf(f, "%d", i); + if (r == EOF && ferror(f)) + r = errno ? -errno : -EOF; + + RESTORE_ERRNO; + + return r; +} + +int read_int32_from_path(const char *path, int32_t *i) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + assert(i); + + f = fopen(path, "re"); + if (!f) + return -errno; + + return read_int32_from_file(f, i); +} + +int read_uint32_from_file(FILE *f, uint32_t *u) { + int r = 0; + + assert(f); + assert(u); + + STORE_RESET_ERRNO; + + r = fscanf(f, "%u", u); + if (r == EOF && ferror(f)) + r = errno ? -errno : -EOF; + + RESTORE_ERRNO; + + return r; +} + +int read_uint32_from_path(const char *path, uint32_t *u) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + assert(u); + + f = fopen(path, "re"); + if (!f) + return -errno; + + return read_uint32_from_file(f, u); +} + +int str_to_strv(const char *str, char ***strv, const char *separator) { + char *w, *state, *p; + char **v = NULL, **new = NULL; + size_t l; + size_t i = 0; + + FOREACH_WORD_SEPARATOR(w, l, str, separator, state) { + p = strndup(w, l); + if (!p) { + if (v) + free(v); + return -ENOMEM; + } + + new = (char **)realloc(v, sizeof(char *) * (i + 2)); + if (!new) { + free(p); + p = NULL; + return -ENOMEM; + } + + v = new; + + v[i] = p; + v[i+1] = NULL; + i++; + } + + *strv = v; + + return 0; +} + +size_t sizeof_strv(char **strv) { + size_t u = 0; + + if (!strv) + return 0; + + while(strv[u++]) + ; + + return u - 1; +} + +int strv_attach(char **first, char **second, char ***strv, bool free_second) { + char **new = NULL; + size_t n1 = 0, n2 = 0; + + assert(strv); + + if (first) + n1 = sizeof_strv(first); + + if (second) { + n2 = sizeof_strv(second); + + new = (char **)realloc(first, sizeof(char *) * (n1 + n2 + 1)); + if (!new) + return -ENOMEM; + + first = new; + + memcpy(first + n1, second, sizeof(char *) * (n2 + 1)); + + if (free_second) + free(second); + } + + *strv = first; + + return 0; +} + +void strv_free_full(char **strv) { + char **s; + + if (!strv) + return; + + FOREACH_STRV(s, strv) { + if (s && *s) { + free(*s); + *s = NULL; + } + } + + free(strv); + strv = NULL; +} + +bool isdir(const char *path) { + struct stat st; + + assert(path); + + if (lstat(path, &st) < 0) + return false; + + return S_ISDIR(st.st_mode); +} + +int touch(const char *path) { + _cleanup_fclose_ FILE *f = NULL; + + assert(path); + + f = fopen(path, "w"); + if (!f) + return -errno; + + return 0; +} + +bool mnt_is_mounted(const char *fsname, const char *dir, const char *type, const char *opts) { + struct mntent *ent; + FILE *f = NULL; + bool matched = false; + + f = setmntent("/etc/mtab", "r"); + if (!f) + return false; + + while ((ent = getmntent(f))) { + if (fsname) { + if (streq(fsname, ent->mnt_fsname)) + matched = true; + else + goto no_match; + } + + if (dir) { + if (streq(dir, ent->mnt_dir)) + matched = true; + else + goto no_match; + } + + if (type) { + if (streq(type, ent->mnt_type)) + matched = true; + else + goto no_match; + } + + if (opts) { + if (streq(opts, ent->mnt_opts)) + matched = true; + else + goto no_match; + } + + if (matched) + break; + + no_match: + matched = false; + } + + endmntent(f); + + return matched; +} diff --git a/src/libsystem/libsystem.h b/src/libsystem/libsystem.h new file mode 100644 index 0000000..7819aa7 --- /dev/null +++ b/src/libsystem/libsystem.h @@ -0,0 +1,955 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file libsystem.h + * + * system utility library + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved. + * + */ + +#pragma once + +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#ifndef __cplusplus +#include <stdbool.h> +#endif +#include <unistd.h> +#include <string.h> +#include <dirent.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Many functions have no effects except the return value and their + * return value depends only on the parameters and/or global + * variables. Such a function can be subject to common subexpression + * elimination and loop optimization just as an arithmetic operator + * would be. These functions should be declared with the attribute + * pure. + */ +#define _pure_ __attribute__ ((pure)) + +/** + * The cleanup attribute runs a function when the variable goes out of + * scope. This attribute can only be applied to auto function scope + * variables; it may not be applied to parameters or variables with + * static storage duration. The function must take one parameter, a + * pointer to a type compatible with the variable. The return value of + * the function (if any) is ignored. + */ +#define _cleanup_(x) __attribute__((cleanup(x))) + +/** + * whitespaces such like space, tab or newlines + */ +#define WHITESPACE " \t\n\r" + +/** + * newlines + */ +#define NEWLINE "\n\r" + +/** + * single or double quotes + */ +#define QUOTES "\"\'" + +/** + * comment start specifiers such like sharp(#) or semicolon(;) + */ +#define COMMENTS "#;" + +/** + * @defgroup GCC_CLEANUP_ATT_GROUP gcc cleanup attribute + * + * @{ + */ + +static inline void __cleanup_free_func(void *p) { + free(*(void**) p); +} + +static inline void __cleanup_close_func(int *fd) { + if (*fd >= 0) + close(*fd); +} + +static inline void __cleanup_fclose_func(FILE **f) { + if (*f) + fclose(*f); +} + +static inline void __cleanup_pclose_func(FILE **f) { + if (*f) + pclose(*f); +} + +static inline void __cleanup_closedir_func(DIR **d) { + if (*d) + closedir(*d); +} + +static inline const char *startswith(const char *s, const char *prefix) { + if (strncmp(s, prefix, strlen(prefix)) == 0) + return s + strlen(prefix); + return NULL; +} + +static inline bool isempty(const char *p) { + return !p || !p[0]; +} + +/** + * Declare value with cleanup attribute. free() is called when is + * going out the scope. + */ +#define _cleanup_free_ _cleanup_(__cleanup_free_func) + +/** + * Declare value with cleanup attribute. close() is called when is + * going out the scope. + */ +#define _cleanup_close_ _cleanup_(__cleanup_close_func) + +/** + * Declare value with cleanup attribute. fclose() is called when is + * going out the scope. + */ +#define _cleanup_fclose_ _cleanup_(__cleanup_fclose_func) + +/** + * Declare value with cleanup attribute. pclose() is called when is + * going out the scope. + */ +#define _cleanup_pclose_ _cleanup_(__cleanup_pclose_func) + +/** + * Declare value with cleanup attribute. closedir() is called when is + * going out the scope. + */ +#define _cleanup_closedir_ _cleanup_(__cleanup_closedir_func) +/** + * @} + */ + +/** + * Allocate n number of size t memory. + */ +#define new(t, n) ((t*) malloc(sizeof(t) * (n))) + +/** + * Allocate n number of size t memory. And initialize to 0 all. + */ +#define new0(t, n) ((t*) calloc((n), sizeof(t))) + +/** + * Allocate n number memory. + */ +#define malloc0(n) (calloc((n), 1)) + +/** + * @brief Parse boolean type string. + * + * @param v String to parse. + * + * @return TRUE on "1", 'y', 'Y', 't', 'T' and "on". FALSE on "0", + * 'n', 'N', 'f', 'F', "off". + */ +int parse_boolean(const char *v) _pure_; + +/** + * @brief Parse byte type string. + * + * @param b Byte string. This can be only digit number with byte unit + * "BKMG". B is byte, K is kilo byte, M is mega byte and G is gira + * byte. Byte is default. + * @param s Parsed byte size is filled. + * + * @return 0 on success, -errno on failure. + */ +int parse_bytes(const char *b, size_t *s) _pure_; + +/** + * @brief Parse percentage type string. + * + * @param string Percentage string to parse. Such like "70%". + * @param percent Parsed percentage size is filled. + * + * @return 0 on success, -errno on failure. + */ +int parse_percent(const char *string, size_t *percent) _pure_; + +/** + * @brief check the path string is started with '/' + * + * @param p a path to check + * + * @return true if p started with '/', otherwise false. + */ +bool path_is_absolute(const char *p); + +/** + * @brief Removes redundant inner and trailing slashes. Modifies the + * passed string in-place. For example, if "///foo//bar/" is given + * then the path will be changed as "/foo/bar" + * + * @param path a path to modify. + * + * @return modified path pointer. It maybe identical with given path. + */ +char *path_kill_slashes(char *path); + +/** + * Get element number of array. + */ +#define ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0])) + +/** + * Iterate for each struct reference. + */ +#define FOREACH_STRUCT_REF(s, f, i) \ + for ((i) = 0; s[(i)].f != NULL; (i)++) + +/** + * @brief Iterate for each directory entries exclude "." and "..". + */ +#define FOREACH_DIRENT(de, d, on_error) \ + for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \ + if (!de) { \ + if (errno > 0) { \ + on_error; \ + } \ + break; \ + } else if (streq(de->d_name, ".") || \ + streq(de->d_name, "..")) \ + continue; \ + else + +/** + * @brief Check string is digit. + * + * @param s String to check. + * @param l Length to check. + * + * @return TRUE on all the characters are digit. FALSE on the others. + */ +bool is_number(const char *s, int l); + +/** + * @brief Run cp with given src, dst with option. Internally, directly + * calls /bin/cp with given arguments. + * @todo change direct calls of /bin/cp to c api. + * + * @param src source + * @param dst destination + * @param option cp option + * @param timeout_msec timeout milliseconds + * + * @return return exit code of /bin/cp or negative errno. + */ +int do_copy(const char *src, const char *dst, const char *option, int64_t timeout_msec); + +/** + * @brief Make a directory. If parent directories are also absent, + * make them also. Corresponding with "mkdir -p". + * + * @param path Path to make directory. + * @param mode The directory mode. + * + * @return 0 on success, -errno on failure. + */ +int do_mkdir(const char *path, mode_t mode); + +/** + * @brief Remove all elements in path recursivly. + * + * @param path Path to make directory. + * + * @return 0 on success, -errno on failure. + */ +int rmdir_recursive(const char *path); + +/** + * @defgroup FILE_READ_WRITE_GROUP File Read/Write utility + * + * @{ + */ + +/** + * file write flags + */ +enum file_write_flags { + /** Append line-end(\\n) at the end of file. In case of string + * write, if given string has already line-end characters + * then this flag has no effect. */ + FILE_WRITE_NEWLINE_IF_NOT = 1 << 0, + /** Run fflush(3) after file write. */ + FILE_WRITE_WITH_FFLUSH = 1 << 1, + /** Open file as append mode. */ + FILE_WRITE_APPEND = 1 << 2, +}; + +/** + * @brief Write strings to FILE + * + * @param f File pointer. + * @param str Strings to write. + * @param flags Optional flags to write file. For + * ::FILE_WRITE_NEWLINE_IF_NOT, if str has already line-end, + * ::FILE_WRITE_NEWLINE_IF_NOT will has no effect. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_str_to_file(FILE *f, const char *str, enum file_write_flags flags); + +/** + * @brief Write strings to path. + * + * @param path File path. + * @param str Strings to write. + * @param flags Optional flags to write file. For + * ::FILE_WRITE_NEWLINE_IF_NOT, if str has already line-end, + * ::FILE_WRITE_NEWLINE_IF_NOT will has no effect. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_str_to_path(const char *path, const char *str, enum file_write_flags flags); + +/** + * @brief Write signed decimal integer to FILE. + * + * @param f File pointer. + * @param i Signed integer to write. + * @param flags Optional flags to write file. if + * ::FILE_WRITE_NEWLINE_IF_NOT is set, line-end added. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_int32_to_file(FILE *f, int32_t i, enum file_write_flags flags); + +/** + * @brief Write signed decimal integer to path. + * + * @param path File path. + * @param i Signed integer to write. + * @param flags Optional flags to write file. if + * ::FILE_WRITE_NEWLINE_IF_NOT is set, line-end added. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_int32_to_path(const char *path, int32_t i, enum file_write_flags flags); + +/** + * @brief Write unsigned decimal integer to FILE. + * + * @param f File pointer + * @param u Unsigned integer to write. + * @param flags Optional flags to write file. if + * ::FILE_WRITE_NEWLINE_IF_NOT is set, line-end added. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_uint32_to_file(FILE *f, uint32_t u, enum file_write_flags flags); + +/** + * @brief Write unsigned decimal integer to path. + * + * @param path File path. + * @param u Unsigned integer to write. + * @param flags Optional flags to write file. if + * ::FILE_WRITE_NEWLINE_IF_NOT is set, line-end added. For detail, see + * ::file_write_flags. + * + * @return 0 on success, -errno on failure. + */ +int write_uint32_to_path(const char *path, uint32_t u, enum file_write_flags flags); + +/** + * @brief Read the first line from FILE + * + * @param f File pointer. + * @param line Duplicated string line is filled. This value has to + * be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int read_one_line_from_file(FILE *f, char **line); + +/** + * @brief Read the first line from path + * + * @param path File path. + * @param line Duplicated string line is filled. This value has to + * be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int read_one_line_from_path(const char *path, char **line); + +/** + * @brief Read signed decimal integer from FILE. + * + * @param f File pointer. + * @param i signed int value pointer. + * + * @return 0 on success, -errno on failure. + */ +int read_int32_from_file(FILE *f, int32_t *i); + +/** + * @brief Read signed decimalinteger from path. + * + * @param path File path. + * @param i signed int value pointer. + * + * @return 0 on success, -errno on failure. + */ +int read_int32_from_path(const char *path, int32_t *i); + +/** + * @brief Read unsigned decimalinteger from FILE. + * + * @param f File pointer. + * @param u unsigned int value pointer. + * + * @return 0 on success, -errno on failure. + */ +int read_uint32_from_file(FILE *f, uint32_t *u); + +/** + * @brief Read unsigned decimal integer from path + * + * @param path File path. + * @param u unsigned int value pointer. + * + * @return 0 on success, -errno on failure. + */ +int read_uint32_from_path(const char *path, uint32_t *u); +/** + * @} + */ + +/** + * @defgroup STRING_GROUP String helper + * + * @{ + */ + +/** + * Compare two strings. TRUE on same, FALSE on others. + * Same with (strcmp((a),(b)) == 0) + */ +#define streq(a,b) (strcmp((a),(b)) == 0) +/** + * Compare two strings for n length. TRUE on same, FALSE on others. + * Same with (strncmp((a), (b), (n)) == 0) + */ +#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0) + +/** + * Compare two strings. Similar to streq() but ignore case. TRUE on + * same, FALSE on others. + * Same with (strcasecmp((a),(b)) == 0) + */ +#define strcaseeq(a,b) (strcasecmp((a),(b)) == 0) + +/** + * Compare two strings for n length. Similar to strneq() but ignore + * case. TRUE on same, FALSE on others. + * Same with (strcasecmp((a),(b)) == 0) + */ +#define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0) + +/** + * Iterate string in strings which include null characters. + * For example, + *\code{.c} +const char str[] = { + "foo\0" + "bar\0"; +}; + +const char *s; + +NULSTR_FOREACH(s, str) { + // do something here +} + *\endcode + */ +#define NULSTR_FOREACH(i, l) \ + for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1) + +/** + * @brief Like streq(), but tries to make sense of NULL pointers. + * + * @param a String. + * @param b String. + * + * @return TRUE on same, FALSE on the others. + */ +bool streq_ptr(const char *a, const char *b) _pure_; + +/** + * @brief Truncate line end characters. + * + * @param s String to truncate. + * + * @return Result string. + */ +char *truncate_nl(char *s); + +/** + * @brief Append suffix string to sting s with size b. + * + * @param s Ahead string. + * @param suffix The second string. + * @param b suffix size to append. + * + * @return Result string. This string has to be free-ed by caller. + */ +char *strnappend(const char *s, const char *suffix, size_t b); + +/** + * @brief Append suffix string to sting s. + * + * @param s Ahead string. + * @param suffix The second string. + * + * @return Result string. This string has to be free-ed by caller. + */ +char *strappend(const char *s, const char *suffix); + +/** + * @brief Drops trailing whitespaces. + * + * @param s String. + * + * @return The pointer to the first non-space character. + */ +char *strstrip(char *s); + +/** + * @brief duplicate string without leading and trailing whitespaces + * + * @param str a target string to duplicate + * @param ret newly allocated string is filled + * + * @return 0 on success, -errno on failure. + */ +int strdup_strip(const char *str, char **ret); + +/** + * @brief duplicate string without leading and trailing whitespaces, + * duplicated string is not over given length len + * + * @param str a target string to duplicate + * @param len maxium length of duplicate + * @param ret newly allocated string is filled + * + * @return 0 on success, -errno on failure. + */ +int strndup_strip(const char *str, size_t len, char **ret); + +/** + * @brief nulstr is similar to string list but each strings ends with + * null and the strings are put at one memory buffer. For example, + * "foo" and "bar" string can be represented "foo\0bar". This function + * check nulstr is containing the needle string. + * + * @param nulstr a nulstr + * @param needle a needle string to find + * + * @return true if the needle found, otherwise false. + */ +bool nulstr_contains(const char*nulstr, const char *needle); + +/** + * @brief check a string ends with postfix pattern + * + * @param s a string to check + * @param postfix postfix string + * + * @return if s is ended with postfix string the pointer of the + * string, matched pointer of s is returned. Otherwise NULL. + */ +char* endswith(const char *s, const char *postfix); + +/** + * @brief split a string into words. This api generally is not called + * directly, #FOREACH_WORD_SEPARATOR or #FOREACH_WORD are using + * this. If separator does not include quotes then quoted words are + * assumed as single word. + * + * @param c string to split + * @param l splitted word length + * @param separator separator strings such like #WHITESPACE + * @param state a state internally used + * + * @return a splitted current word pointer + */ +char *split(const char *c, size_t *l, const char *separator, char **state); + +/** + * @brief Iterate for each words. If separator does not include quotes + * then quoted words are assumed as single word. + * + * @param word Each word + * @param length Length of word + * @param s Target string + * @param separator Seperator string + * @param state Used only internal split(). + */ +#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \ + for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state))) + +/** + * @brief Iterate for each words. (Seperators are WHITESPACES.) Quoted + * words are assumed as single word. + * + * @param word Each word + * @param length Length of word + * @param s Target string + * @param state Used only internal split(). + */ +#define FOREACH_WORD(word, length, s, state) \ + FOREACH_WORD_SEPARATOR(word, length, s, WHITESPACE, state) + +/** + * @brief Duplicate string and strip quotes from the string. + * + * @param str String to duplicate. + * @param quotes Quote characters to strip. Predefined #QUOTES can be + * used to specify quote and double quote. + * + * @return Result string. This value has to be free-ed by caller. + */ +char *strdup_unquote(const char *str, const char *quotes); +/** + * @} + */ + +/** + * @defgroup STRV_GROUP String List + * + * @{ + */ + +/** + * iterate for each elements of string list. + */ +#define FOREACH_STRV(s, l) \ + for ((s) = (l); (s) && *(s); (s)++) + +/** + * @brief Split given string to string list with separator. + * + * @param str string to split as string list. + * @param strv Splitted string list is filled. This string list has to + * be free-ed. + * @param separator sperators to split the string. + * + * @return 0 on success, -errno on failure. + */ +int str_to_strv(const char *str, char ***strv, const char *separator); + +/** + * @brief Get elements of string list. #sizeof_strv() does not count + * end of list NULL. For example, for {"foo", "bar", NULL} string + * list, #sizeof_strv() returns 2. + * + * @param strv string list. + * + * @return number of string list. + */ +size_t sizeof_strv(char **strv); + +/** + * @brief Merge two string lists. If {"foo", "bar"} and {"baz", "qux"} + * are given, the result is {"foo", "bar", "baz", "quz"}. + * + * @param first The first string list. + * @param second The second string list. + * @param strv Merged string list. + * @param free_second If TRUE is given, the second string list will be + * free-ed. If FALSE, no action. + * + * @return number of string list. + */ +int strv_attach(char **first, char **second, char ***strv, bool free_second); + +/** + * @brief Free all given string list + * + * @param strv string list to free. + */ +void strv_free_full(char **strv); +/** + * @} + */ + +/** + * @brief Check given path is directory or not + * + * @param path path to check + * + * @return TRUE if path is directory, FALSE on others. + */ +bool isdir(const char *path); + +/** + * @brief Simple file create api similar to touch(1) + * + * @param path file path + * + * @return 0 on success, -errno on failure. + */ +int touch(const char *path); + +/** + * @defgroup PROC_GROUP proc group + * + * @brief A set utility library for /proc. Some of library functions + * are only able to be successful root uid with security permissions. + * + * @{ + */ + +/** + * @brief Get string with operator from /proc/cmdline. If foo=bar is + * included in /proc/cmdline and want to get the bar, then: + * \code{.c} + char *buf; + + cmdline_get_str(&buf, "foo="); + * \endcode + * + * @param buf The value string is filled to here. This value has to be + * free-ed by caller. + * @param op An operator string. + * + * @return Result string. This value has to be free-ed by caller. + */ +ssize_t cmdline_get_str(char **buf, const char *op); + +/** + * @brief Get PID of process. + * + * @param pname Process name. + * + * @return PID on successful find. If not found, 0 is returned. And + * -errno is returned on failure. + */ +int pid_of(const char *pname); + +/** + * @brief Check mount entry. Multiple matches of conditoin are able to + * be set with mnt_fsname, mnt_dir, mnt_type or mnt_opts. If multiple + * matches are given, return true if a entry satisfied all matches. + * + * \code{.c} +// check cgroup is mounted +if (is_mounted("cgroup", NULL, NULL, NULL)) + printf("cgroup is mounted\n"); + +// check /tmp is mounted +if (is_mounted("tmpfs", "/tmp", NULL, NULL)) + printf("/tmp is mounted\n"); + +// check cgroup is mounted as cgroup2 +if (is_mounted("cgroup", "/sys/fs/cgroup", "cgroup2", NULL)) + printf("cgroup is mounted as cgroup2\n"); + * \endcode + * + * @param fsname find matched mount filesystem name + * @param dir find matched mount dir(path) name + * @param type find matched mount type name + * @param opts find matched mount option name + * + * @return true if matched mount entry found, otherwise false. + */ +bool mnt_is_mounted(const char *fsname, const char *dir, const char *type, const char *opts); +/** + * @} + */ + +/** + * @defgroup EXEC_GROUP exec group + * + * @brief fork() and exec() utility + * @{ + */ + +/** + * @brief Traditional fork() and exec() helper. + * + * @param argv array of pointers to null-terminated strings that + * represent the argument list available to the new program. The first + * argument should point to the filename associated with the file + * being executed. The array of pointers must be terminated by a NULL pointer. + * @param envp specify the environment of the executed program via the + * argument envp. The envp argument is an array of pointers to + * null-terminated strings and must be terminated by a NULL pointer. + * @param timeout_msec timeout millisecond to prevent infinite + * waiting. If negative is given, the parent will not wait the + * child. In other word, the parent will return immediately. If 0 is + * given, parent will wait the child infinitly. And if positive value + * is given parent will wait given milliseconds and expired return + * -1. If the child is exit within the tiemout millisecond return with + * child exit code. + * + * @return exit code of child. It is fully depend on the child + * process. If the child exit with 1 then this function also return 1. + * Negative errno on error. -ETIME on timer expired. + */ +int do_fork_exec(char *const argv[], char * const envp[], int64_t timeout_msec); + +/** + * @} + */ + +/** + * @defgroup TIME_UTIL_GROUP time util group + * + * @brief time utility libraries + * @{ + */ + +/** millisecond per second */ +#define MSEC_PER_SEC 1000ULL +/** microsecond per second */ +#define USEC_PER_SEC ((uint64_t) 1000000ULL) +/** microsecond per millisecond */ +#define USEC_PER_MSEC ((uint64_t) 1000ULL) +/** nanosecond per second */ +#define NSEC_PER_SEC ((uint64_t) 1000000000ULL) +/** nanosecond per microsecond */ +#define NSEC_PER_MSEC ((uint64_t) 1000000ULL) +/** nanosecond per microsecond */ +#define NSEC_PER_USEC ((uint64_t) 1000ULL) + +/** microsecond per minute */ +#define USEC_PER_MINUTE ((uint64_t) (60ULL*USEC_PER_SEC)) +/** nanosecond per minute */ +#define NSEC_PER_MINUTE ((uint64_t) (60ULL*NSEC_PER_SEC)) +/** microsecond per hour */ +#define USEC_PER_HOUR ((uint64_t) (60ULL*USEC_PER_MINUTE)) +/** nanosecond per hour */ +#define NSEC_PER_HOUR ((uint64_t) (60ULL*NSEC_PER_MINUTE)) +/** microsecond per day */ +#define USEC_PER_DAY ((uint64_t) (24ULL*USEC_PER_HOUR)) +/** nanosecond per day */ +#define NSEC_PER_DAY ((uint64_t) (24ULL*NSEC_PER_HOUR)) +/** microsecond per week */ +#define USEC_PER_WEEK ((uint64_t) (7ULL*USEC_PER_DAY)) +/** nanosecond per week */ +#define NSEC_PER_WEEK ((uint64_t) (7ULL*NSEC_PER_DAY)) +/** microsecond per month */ +#define USEC_PER_MONTH ((uint64_t) (2629800ULL*USEC_PER_SEC)) +/** nanosecond per month */ +#define NSEC_PER_MONTH ((uint64_t) (2629800ULL*NSEC_PER_SEC)) +/** microsecond per year */ +#define USEC_PER_YEAR ((uint64_t) (31557600ULL*USEC_PER_SEC)) +/** nanosecond per year */ +#define NSEC_PER_YEAR ((uint64_t) (31557600ULL*NSEC_PER_SEC)) + +/** frequently used time format string: 12:34 */ +#define HH_MM "%H:%M" +/** frequently used time format string: 12:34:56 */ +#define HH_MM_SS "%H:%M:%S" + +/** frequently used time format string: 2015-01-23 */ +#define YYYY_MM_DD "%Y-%m-%d" +/** frequently used time format string: 2015-01-23 12:34 */ +#define YYYY_MM_DD_HH_MM "%Y-%m-%d %H:%M" +/** frequently used time format string: 2015-01-23 12:34:56 */ +#define YYYY_MM_DD_HH_MM_SS "%Y-%m-%d %H:%M:%S" +/** frequently used time format string: 2015-01-23 12:34:56 KST */ +#define YYYY_MM_DD_HH_MM_SS_Z "%Y-%m-%d %H:%M:%S %Z" + +/** frequently used time format string: Fri 2015-01-23 */ +#define DOW_YYYY_MM_DD "%a %Y-%m-%d" +/** frequently used time format string: Fri 2015-01-23 12:34 */ +#define DOW_YYYY_MM_DD_HH_MM "%a %Y-%m-%d %H:%M" +/** frequently used time format string: Fri 2015-01-23 12:34:56 */ +#define DOW_YYYY_MM_DD_HH_MM_SS "%a %Y-%m-%d %H:%M:%S" +/** frequently used time format string: Fri 2015-01-23 12:34:56 KST */ +#define DOW_YYYY_MM_DD_HH_MM_SS_Z "%a %Y-%m-%d %H:%M:%S %Z" + +/** + * @brief Convert time_t to given format time string. + * + * @param sec time second to convert + * @param format format string + * @param time string pointer to converted time is filled. On + * successful return, this value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int sec_to_timestr(time_t sec, const char *format, char **time); + +/** + * @brief Convert time_t to \%a \%Y-\%m-\%d \%H:\%M:\%S \%Z format time string. + * + * @param sec time second to convert + * @param time string pointer to converted time is filled. On + * successful return, this value has to be free-ed by caller. + * + * @return 0 on success, -errno on failure. + */ +int sec_to_timestr_full(time_t sec, char **time); + +/** + * @brief Convert given format time string to time_t. + * + * @param format format string + * @param time time string to convert to time_t + * @param sec converted time_t + * + * @return 0 on success, -errno on failure. + */ +int timestr_to_sec(const char *format, const char *time, time_t *sec); + +/** + * @brief Make struct timeval from millisecond + * + * @param msec millisecond to Convert + * @param tv struct timeval to be filled + */ +void msec_to_timeval(uint64_t msec, struct timeval *tv); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif diff --git a/src/libsystem/libsystem.pc.in b/src/libsystem/libsystem.pc.in new file mode 100644 index 0000000..e942770 --- /dev/null +++ b/src/libsystem/libsystem.pc.in @@ -0,0 +1,17 @@ +# Package Information for pkg-config +# +# Copyright (c) 2016 Samsung Electronics Co., Ltd. +# All rights reserved. +# + +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: libsystem +Description: system utility libraries +Version: @PACKAGE_VERSION@ +Requires.private: @LIBSYSTEM_PC_REQUIRES@ +Cflags: @LIBSYSTEM_PC_CFLAGS@ +Libs: @LIBSYSTEM_PC_LIBS@ diff --git a/src/libsystem/proc.c b/src/libsystem/proc.c new file mode 100644 index 0000000..acac082 --- /dev/null +++ b/src/libsystem/proc.c @@ -0,0 +1,95 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stdlib.h> +#include <string.h> +#include <errno.h> +#include <assert.h> + +#include "libsystem.h" + +/* In old kernel, this symbol maybe NOT */ +#ifndef TASK_COMM_LEN +#define TASK_COMM_LEN 16 +#endif + +ssize_t cmdline_get_str(char **buf, const char *op) { + _cleanup_free_ char *cmdline = NULL; + char *s, *w, *state; + size_t l, ll; + int r; + + assert(buf); + assert(op); + + r = read_one_line_from_path("/proc/cmdline", &cmdline); + if (r < 0) + return r; + + ll = strlen(op); + FOREACH_WORD(w, l, cmdline, state) + if (strneq(op, w, ll)) { + s = new0(char, l - ll + 1); + if (!s) + return -ENOMEM; + + strncpy(s, w + ll, l - ll + 1); + + *buf = s; + + return l - ll + 1; + } + + return -ENOENT; +} + +int pid_of(const char *pname) { + _cleanup_closedir_ DIR *dir = NULL; + struct dirent *de; + int r; + + dir = opendir("/proc"); + if (!dir) + return -errno; + + FOREACH_DIRENT(de, dir, return -errno) { + _cleanup_free_ char *path = NULL; + _cleanup_free_ char *comm = NULL; + + if (de->d_type != DT_DIR) + continue; + + if (!is_number(de->d_name, strlen(de->d_name))) + continue; + + r = asprintf(&path, "/proc/%s/comm", de->d_name); + if (r < 0) + return -ENOMEM; + + r = read_one_line_from_path(path, &comm); + if (r < 0) + continue; + + if (strneq(pname, comm, TASK_COMM_LEN-1)) + return atoi(de->d_name); + } + + return 0; +} diff --git a/src/libsystem/time-util.c b/src/libsystem/time-util.c new file mode 100644 index 0000000..28ac86f --- /dev/null +++ b/src/libsystem/time-util.c @@ -0,0 +1,87 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * time-util.c + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +#include <stdlib.h> +#include <unistd.h> +#include <assert.h> +#include <errno.h> +#include <time.h> +#include <sys/time.h> + +#include "libsystem.h" + +#define TIME_BUF_LEN 30 + +int sec_to_timestr(time_t sec, const char *format, char **time) { + struct tm tm; + char *buf; + size_t l; + + assert(format); + assert(time); + + localtime_r(&sec, &tm); + + buf = new0(char, TIME_BUF_LEN); + if (!buf) + return -ENOMEM; + + l = strftime(buf, TIME_BUF_LEN, format, &tm); + if (l <= 0) { + free(buf); + return -EINVAL; + } + + *time = buf; + + return 0; +} + +int sec_to_timestr_full(time_t sec, char **time) { + assert(time); + + return sec_to_timestr(sec, DOW_YYYY_MM_DD_HH_MM_SS_Z, time); +} + +int timestr_to_sec(const char *format, const char *time, time_t *sec) { + struct tm tm; + char *ret; + + assert(format); + assert(time); + assert(sec); + + memset(&tm, 0, sizeof(struct tm)); + ret = strptime(time, format, &tm); + if ((ret - time) < strlen(time)) + return -EINVAL; + + *sec = mktime(&tm); + + return 0; +} + +void msec_to_timeval(uint64_t msec, struct timeval *tv) { + assert(tv); + + tv->tv_sec = msec / MSEC_PER_SEC; + tv->tv_usec = (msec % MSEC_PER_SEC) * USEC_PER_MSEC; +} diff --git a/src/test/test-truncate_nl.c b/src/test/test-truncate_nl.c new file mode 100644 index 0000000..07d01e8 --- /dev/null +++ b/src/test/test-truncate_nl.c @@ -0,0 +1,41 @@ +/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ + +/* + * libsystem + * + * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <stdio.h> +#include <assert.h> + +#include "libsystem/libsystem.h" + +#define TEST_STRING "hello libsystem" +#define TEST_STRING_NL TEST_STRING "\n\r" + +static void test_truncate_nl(void) { + char s[] = TEST_STRING_NL; + + assert(!streq(s, TEST_STRING)); + truncate_nl(s); + assert(streq(s, TEST_STRING)); +} + +int main(int argc, char *argv[]) { + test_truncate_nl(); + + return 0; +} |