pax_global_header 0000666 0000000 0000000 00000000064 12623421622 0014512 g ustar 00root root 0000000 0000000 52 comment=5fd76aa1f1211788ebc4f1800910df976cc52c84
elektra-0.8.14/ 0000775 0000000 0000000 00000000000 12623421622 0013233 5 ustar 00root root 0000000 0000000 elektra-0.8.14/.gitignore 0000664 0000000 0000000 00000000652 12623421622 0015226 0 ustar 00root root 0000000 0000000 # git-ls-files --others --exclude-from=.git/info/exclude
# Lines that start with '#' are comments.
# For a project mostly in C, the following would be a good set of
# exclude patterns (uncomment them if you want to use them):
#ignore backups
*~
#ignore debian patches
.pc/
debian/patches/
#ignore all build directories of cmake
build*
#ignore ctags + gdb history files
.ctags
.gdb_history
#ignore emacs backup files
\#*#
elektra-0.8.14/CMakeLists.txt 0000664 0000000 0000000 00000005517 12623421622 0016003 0 ustar 00root root 0000000 0000000 cmake_minimum_required (VERSION 2.8.8)
# allows us to override platform specific variables
set(CMAKE_USER_MAKE_RULES_OVERRIDE "${CMAKE_SOURCE_DIR}/cmake/Platform.cmake")
project (Elektra)
#fix OS X RPATH issues
set(CMAKE_MACOSX_RPATH 1)
#additional modules for loading libraries
set (CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
#fix policy stuff
if (POLICY CMP0026)
cmake_policy(SET CMP0026 OLD) # reinvestigate at 2.8.11 or later
endif()
if (POLICY CMP0043)
cmake_policy(SET CMP0043 OLD) # to have consistent behavior for pre 2.8.10
#also reinvestigate when they do not need to be supported anymore
endif()
if (POLICY CMP0046)
cmake_policy(SET CMP0046 OLD) # new behaviour seems stupid, of course
# dependency is not yet available if it's generated later?
endif()
#needed by ifs below
include (cmake/ElektraCache.cmake)
include (cmake/ElektraCompiling.cmake)
if (ENABLE_COVERAGE)
include (cmake/ElektraCoverage.cmake)
endif (ENABLE_COVERAGE)
if (ENABLE_TESTING)
enable_testing ()
include (Dart)
endif (ENABLE_TESTING)
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
if (NOT FORCE_IN_SOURCE_BUILD)
message(FATAL_ERROR
"In-source builds are not permitted.\n"
"Make a separate folder for building:\n"
" mkdir build && cd build && cmake ..\n"
"Before that, remove the files already created:\n"
" rm -rf CMakeCache.txt CMakeFiles\n"
"If you really know what you are doing\n"
"(will overwrite original files!) use:\n"
" cmake -DFORCE_IN_SOURCE_BUILD=ON\n"
)
endif (NOT FORCE_IN_SOURCE_BUILD)
endif(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
if (NOT CMAKE_BUILD_TYPE)
SET(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE)
endif (NOT CMAKE_BUILD_TYPE)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
#some basic and important variables
set (DOMAIN libelektra.org) #needed by doxygen
set (REVERSE_DOMAIN org.libelektra)
set (KDB_VERSION_MAJOR 0)
set (KDB_VERSION_MINOR 8)
set (KDB_VERSION_MICRO 14)
set (KDB_VERSION "${KDB_VERSION_MAJOR}.${KDB_VERSION_MINOR}.${KDB_VERSION_MICRO}")
set (SO_VERSION 4)
#set (SO_VERSION_TOOLS 3)
#needs version above
include (cmake/ElektraPackaging.cmake)
#now add all directories
add_subdirectory (cmake)
add_subdirectory (scripts)
if (BUILD_DOCUMENTATION)
add_subdirectory (doc)
endif (BUILD_DOCUMENTATION)
#is there anything to build except documentation?
if (BUILD_FULL OR BUILD_STATIC OR BUILD_SHARED)
if (BUILD_TESTING)
find_package (GTest)
endif (BUILD_TESTING)
add_subdirectory (src)
add_subdirectory (examples)
add_subdirectory (benchmarks)
if (BUILD_TESTING)
add_subdirectory (tests)
endif (BUILD_TESTING)
endif()
elektra-0.8.14/README.md 0000664 0000000 0000000 00000023001 12623421622 0014506 0 ustar 00root root 0000000 0000000 # libelektra #
_Elektra provides a universal and secure framework to store configuration
parameters in a global, hierarchical key database._
The core is a small library implemented in C. The plugin-based framework fulfills many
configuration-related tasks to avoid any unnecessary code duplication
across applications while it still allows the core to stay without any
external dependency. Elektra abstracts from cross-platform-related issues
with an consistent API, and allows applications to be aware of other
applications' configurations, leveraging easy application integration.
[Why should I use Elektra?](#goals)
## Contact ##
Do not hesitate to ask any question on
[github issue tracker](https://github.com/ElektraInitiative/libelektra/issues),
[Mailing List](https://lists.sourceforge.net/lists/listinfo/registry-list)
or directly to one of the [authors](doc/AUTHORS).
## Quickstart ##
If you want to use Elektra for your application, [read the application integration tutorial](doc/tutorials/application-integration.md).
### Installation ###
The preferred way to install Elektra is by using packages provided for
your distribution. On Debian/Ubuntu, this can be done by running the following
command:
```bash
sudo apt-get install elektra-bin libelektra-dev
```
This will install the Elektra tools as well as everything needed to develop
with Elektra.
If you're not running Debian/Ubuntu, check out the [package list](#packages),
[download elektra directly](#download) or [compile it yourself](#compiling).
It is preferable to use a recent version: They contain many bug fixes and
additional features. See [INSTALL](doc/INSTALL.md) for other ways to install
Elektra.
### Usage ###
Now that we have Elektra installed, we can start using the [kdb command](/doc/help/kdb.md) and
the [qt-gui](/src/tools/qt-gui/).
You can use the `kdb` command to configure your applications:
```bash
kdb set user/env/override/HTTP_PROXY "http://my.proxy:8080"
```
This will set the `HTTP_PROXY` environment variable to `http://my.proxy:8080`.
Configuration can be retrieved with `kdb get`:
```bash
kdb get /env/override/HTTP_PROXY
```
For information about elektrified environment variables, see
[src/libgetenv/README.md](src/libgetenv/README.md)
### Documentation ###
To get an idea of Elektra, you can take a look at the
[presentation](http://www.libelektra.org/ftp/elektra/presentations/2016/FOSDEM/fosdem.odp).
The full documentation, including
[tutorials](http://libelektra.org/blob/master/doc/tutorials/),
[glossary](/doc/help/elektra-glossary.md), and
[concepts and man pages](/doc/help/elektra-introduction.md)
is available in the github repository.
You can read the documentation for the kdb tool, either
- [on github](http://libelektra.org/blob/master/doc/help/kdb.md)
- [in the API docu](http://doc.libelektra.org/api/latest/html/md_doc_help_kdb.html)
- by using `kdb --help` or `kdb help `
- by using `man kdb`
## Goals ##
- Make it trivial for applications and administrators to access
any configuration
- Postpone some decisions from programmers to
- Make configuration storage more safe: avoid that applications
receive wrong or unexpected values that could lead to undefined behaviour.
- Allow software to be better integrated on configuration level
maintainers/administrators, e.g. which syntax and the location of
configuration files.
- Reduce rank growth of configuration parsers in our ecosystem, but
foster well maintained plugins instead.
And in terms of quality, we want:
1. Simplicity (make configuration tasks simple),
2. Robustness (no undefined behaviour of applications), and
3. Extensibility (gain control over configuration access)
[Read more about the goals of Elektra](doc/GOALS.md)
## Facts and Features ##
* Elektra uses the [BSD licence](doc/COPYING).
* Elektra implements an [API](http://doc.libelektra.org/api/latest/html/) to fully access a global key database.
* Elektra can be thought of a virtual file system for configuration.
* Elektra supports mounting of existing configuration files into the global key database.
* Elektra has dozens of [Plugins](src/plugins/) that make it possible
to have a tiny core, but still support many features, including:
* Elektra can import and export configuration files in any [supported format](src/plugins/).
* Elektra is able to log and notify other software on any configuration changes, e.g., using [Dbus](src/plugins/dbus/) and [Journald](src/plugins/journald/).
* Elektra can improve robustness by rejecting invalid configuration via [type checking](src/plugins/type/), [regex](src/plugins/validation/) and more.
* Elektra provides different mechanisms to [locate configuration files](src/plugins/resolver/).
* Elektra supports different ways to [escape](src/plugins/ccode/) and [encode](src/plugins/iconv/) content of configuration files.
* Elektra is multi-process safe and can be used in multi-threaded programs.
* Elektra (except for some [plugins](src/plugins/)) is portable and completely written in Ansi-C99.
* Elektra (except for some [plugins](src/plugins/)) has no external dependency.
* Elektra is suitable for embedded systems and early boot stage programs.
* Elektra uses simple key/value pairs that include metadata for any other information.
* Elektra provides many powerful [Bindings](src/bindings) to avoid low-level access code.
* Elektra provides powerful [Code Generation Techniques](src/tools/gen) for high-level configuration access.
## News ##
- [17 Sep 2015 0.8.13](http://doc.libelektra.org/news/3c00a5f1-c017-4555-92b5-a2cf6e0803e3.html) adds elektrify-getenv
- [12 Jul 2015 0.8.12](http://doc.libelektra.org/news/98770541-32a1-486a-98a1-d02f26afc81a.html) adds dir namespace
- [03 Apr 2015 0.8.11](http://doc.libelektra.org/news/7d4647d4-4131-411e-9c2a-2aca39446e18.html) adds spec namespace
- [02 Dec 2014 0.8.10](http://doc.libelektra.org/news/6ce57ecf-420a-4a31-821e-1c5fe5532eb4.html) adds XDG/OpenICC compatibility
- [04 Nov 2014 0.8.9](http://doc.libelektra.org/news/38640673-3e07-4cff-9647-f6bdd89b1b08.html) adds qt-gui
- [02 Sep 2014 0.8.8](http://doc.libelektra.org/news/eca69e19-5ddb-438c-ac06-57c20b1a9160.html) adds 3-way merging
Also see [News](doc/NEWS.md) and its [RSS feed](http://www.libelektra.org/news/feed.rss).
## Sources ##
### Packages ###
The preferred way to install Elektra is by using packages provided for
your distribution:
- [Fedora](https://admin.fedoraproject.org/pkgdb/package/elektra/)
- [Gentoo](http://packages.gentoo.org/package/app-admin/elektra)
- [Arch Linux](https://aur.archlinux.org/packages/elektra/)
- [Debian](https://packages.debian.org/de/jessie/libelektra4)
- [Ubuntu](https://launchpad.net/ubuntu/+source/elektra)
Available, but not up-to-date (Version 0.7):
- [Mageia](http://svnweb.mageia.org/packages/updates/1/elektra/)
- [Linux Mint](http://community.linuxmint.com/software/view/elektra)
For [OpenSUSE, CentOS, Fedora, RHEL and SLE](https://build.opensuse.org/package/show/home:bekun:devel/elektra)
Kai-Uwe Behrmann kindly provides packages [for download](http://software.opensuse.org/download.html?project=home%3Abekun%3Adevel&package=libelektra4).
For Debian wheezy and jessie amd64 we provide latest builds. See build server below.
If there are no packages available for your distribution, see the
[installation document](doc/INSTALL.md).
### Download ###
Elektra's uses a [git repository at github](https://github.com/ElektraInitiative/libelektra).
You can clone the latest version of Elektra by running:
git clone https://github.com/ElektraInitiative/libelektra.git
Releases can be downloaded from [http](http://www.libelektra.org/ftp/elektra/releases/) and
`ftp://ftp.libelektra.org/elektra/releases/`
### Compiling ###
After downloading or cloning Elektra, `cd` to the directory and run the
following commands to compile it:
* `mkdir -p build`
* `cd build`
* `cmake ..`
* `make`
Then you can use `sudo make install` to install it.
You can also use the [`./configure`](configure) command to generate a `cmake`
command with special options.
For more information, especially how to set CMake Cache, see [here](doc/COMPILE.md).
Make sure to read how to add plugins, tools and bindings.
## Build Server ##
The [build server](http://build.libelektra.org:8080/) builds
Elektra on every commit in various ways and also produces [LCOV code
coverage report](http://doc.libelektra.org/coverage/latest).
To use the debian repository of the latest builds from master put following files in
/etc/apt/sources.list.
For jessie:
deb [trusted=yes] http://194.117.254.29/elektra-stable/ jessie main
deb-src [trusted=yes] http://194.117.254.29/elektra-stable/ jessie main
For wheezy:
deb [trusted=yes] http://build.libelektra.org/debian/ wheezy main
deb-src [trusted=yes] http://build.libelektra.org/debian/ wheezy main
## Develop ##
To start development, just clone the repo and start hacking!
- We encourage you to improve documentation, especially the README.md
as if they were a webpage.
- You should read the [coding document](doc/CODING.md) before you issue a
pull request.
- Make yourself familiar with the [KeySet](/doc/help/elektra-data-structures.md)
(also in the [API docu](http://doc.libelektra.org/api/latest/html/group__keyset.html))
the central data structure in Elektra.
- You should read the [design document](doc/DESIGN.md) before you make
design relevant decisions.
- You can always peek into the [TODOs](doc/todo), if you don't know
what to do.
elektra-0.8.14/benchmarks/ 0000775 0000000 0000000 00000000000 12623421622 0015350 5 ustar 00root root 0000000 0000000 elektra-0.8.14/benchmarks/CMakeLists.txt 0000664 0000000 0000000 00000001356 12623421622 0020115 0 ustar 00root root 0000000 0000000 include (LibAddMacros)
add_headers (HDR_FILES)
macro (do_benchmark source)
include_directories ("${CMAKE_CURRENT_SOURCE_DIR}")
set (SOURCES ${HDR_FILES} benchmarks.c benchmarks.h ${source}.c)
add_executable (${source} ${SOURCES})
target_link_elektra(${source})
set_target_properties (${source} PROPERTIES
COMPILE_DEFINITIONS HAVE_KDBCONFIG_H)
get_target_property (command ${source} LOCATION)
add_custom_target (benchmark_${source}
rm -f *.out
COMMAND valgrind --tool=callgrind --callgrind-out-file=callgrind.out "${command}" > output.out
# COMMAND strace -o strace.out "${command}"
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
)
endmacro (do_benchmark)
do_benchmark (large)
do_benchmark (cmp)
do_benchmark (createkeys)
elektra-0.8.14/benchmarks/README.md 0000664 0000000 0000000 00000001147 12623421622 0016632 0 ustar 00root root 0000000 0000000 This directory is for benchmarking.
Instead of collecting all statistics in a single file,
commits are used per benchmark.
So to do a benchmark you first write the code and
go to a specific commit of Elektra. Then you can
run a benchmark. Afterwards you commit all information
you have collected.
This has the advantage that it is reproduceable.
Everyone can go anytime back to the benchmark commits
and run the same benchmarks again.
For running benchmarks you can use on unix:
make benchmark
which will run valgrind on it.
The old STATISTICS file is no longer used and will be
removed with this commit.
elektra-0.8.14/benchmarks/benchmarks.c 0000664 0000000 0000000 00000001724 12623421622 0017635 0 ustar 00root root 0000000 0000000 #include
#include
struct timeval start;
int num_dir = NUM_DIR;
int num_key = NUM_KEY;
KeySet *large;
void timeInit(void)
{
gettimeofday (&start,0);
}
void timePrint(char * msg)
{
struct timeval measure;
time_t diff;
gettimeofday (&measure, 0);
diff = (measure.tv_sec - start.tv_sec) * 1000000 + (measure.tv_usec - start.tv_usec);
fprintf (stdout, "%20s: %20d Microseconds\n", msg, (int)diff);
gettimeofday (&start,0);
}
void benchmarkCreate()
{
large = ksNew(num_key*num_dir, KS_END);
}
void benchmarkFillup ()
{
int i,j;
char name [KEY_NAME_LENGTH + 1];
char value [] = "data";
for (i=0; i< num_dir; i++)
{
snprintf (name, KEY_NAME_LENGTH, "%s/%s%d", KEY_ROOT, "dir", i);
ksAppendKey(large, keyNew (name, KEY_VALUE, value, KEY_END));
for (j=0; j
#include
#include
#include
#include
#include
#include
#define KEY_ROOT "user/benchmark"
#define KEY_NAME_LENGTH 1000
#define NUM_DIR 200
#define NUM_KEY 200
#define NR 50
#define BUF_SIZ 50
void timeInit (void);
void timePrint (char * msg);
void benchmarkCreate();
void benchmarkFillup();
extern int num_dir; // default = NUM_DIR;
extern int num_key; // default = NUM_KEY;
extern KeySet *large;
#endif
elektra-0.8.14/benchmarks/cmp.c 0000664 0000000 0000000 00000003500 12623421622 0016271 0 ustar 00root root 0000000 0000000 #include
#include
int owncmp(const char*str1, const char*str2)
{
while(*str1 && (*str1==*str2))
{
str1++;
str2++;
}
return *(const unsigned char*)str1-*(const unsigned char*)str2;
}
// warning: these are not correct implementations, but just to get an
// impression about performance
int slacmp(const char*str1, const char*str2)
{
while(*str1 && (*str1==*str2))
{
str1++;
str2++;
}
if (*str1 == '/')
{
return 1;
} else if (*str2 == '/')
{
return -1;
}
return *(const unsigned char*)str1-*(const unsigned char*)str2;
// found different char
}
int natcmp(const char*str1, const char*str2)
{
int count_num = -1;
while(*str1 && (*str1==*str2))
{
str1++;
str2++;
if (*str1 == '#')
{
count_num = 0;
}
else if (count_num >= 0 && !isdigit(*str1))
{
++ count_num;
} else {
count_num = -1;
}
}
if (count_num > 0)
{
return 12;
}
if (*str1 == '/')
{
return 1;
} else if (*str2 == '/')
{
return -1;
}
return *(const unsigned char*)str1-*(const unsigned char*)str2;
}
int main()
{
long long nrIterations = 100000000;
const char str1[] = "some string to be compared with/some\\/more with a long common part, and only a bit different";
char* str2 = malloc(sizeof(str1));
strcat(str2, str1);
str2[sizeof(str1)-5] = 'X';
int res = 0;
timeInit ();
for (int i=0; i
void benchmarkDel()
{
ksDel (large);
}
int main(int argc, char** argv)
{
if (argc != 3)
{
printf ("no arguments given, will exit\n");
printf ("usage %s dir key (both dir+key are numbers)\n", argv[0]);
exit(0);
}
else
{
num_dir = atoi(argv[1]);
num_key = atoi(argv[2]);
printf ("Using %d dirs %d keys\n", num_dir, num_key);
}
timeInit ();
benchmarkCreate();
timePrint ("Created empty keyset");
benchmarkFillup();
timePrint ("New large keyset");
benchmarkDel();
timePrint ("Del large keyset");
}
elektra-0.8.14/benchmarks/large.c 0000664 0000000 0000000 00000003225 12623421622 0016610 0 ustar 00root root 0000000 0000000 #include
KDB * kdb;
Key * key;
KeySet * large;
void benchmarkOpen()
{
kdb = kdbOpen(key);
}
void benchmarkInread()
{
KeySet *n = ksNew(0, KS_END);
kdbGet(kdb, n, key);
ksDel(n);
}
void benchmarkReadin()
{
KeySet *n = ksNew(0, KS_END);
kdbGet(kdb, n, key);
ksDel(n);
}
void benchmarkLookupByName()
{
int i,j;
char name [KEY_NAME_LENGTH + 1];
for (i=0; i< NUM_DIR; i++)
{
snprintf (name, KEY_NAME_LENGTH, "%s/%s%d", KEY_ROOT, "dir", i);
ksLookupByName(large, name, 0);
for (j=0; j ${COVERAGE_DIR}/coverage-filtered.info
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Stop capturing data for coverage."
)
find_program(COVERAGE_GENHTML genhtml)
if(EXISTS ${COVERAGE_GENHTML})
add_custom_target(coverage-genhtml
COMMAND ${COVERAGE_GENHTML} ${COMMON_FLAGS}
${COVERAGE_DIR}/coverage-filtered.info
--prefix "${COVERAGE_PREFIX}"
--output-directory ${COVERAGE_DIR}
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Create html statistics of data for coverage."
)
add_dependencies(coverage-genhtml coverage-stop)
else()
message(WARNING "no genhtml (coverage-genhtml target not added)")
endif()
else()
message(WARNING "no lcov and/or awk (coverage targets not added)")
endif()
elektra-0.8.14/cmake/ElektraPackaging.cmake 0000664 0000000 0000000 00000010007 12623421622 0020507 0 ustar 00root root 0000000 0000000 set (PACKAGE_NAME "elektra")
set (CPACK_PACKAGE_NAME "${PACKAGE_NAME}")
set (PACKAGE_URL "http://www.libelektra.org/")
set (PACKAGE_BUGREPORT "http://bugs.libelektra.org/")
set (PROJECT_VERSION "${KDB_VERSION}")
set (CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
set (CPACK_DEBIAN_PACKAGE_VERSION "${PROJECT_VERSION}")
set (PACKAGE_DESCRIPTION "Elektra provides a universal and secure framework to store configuration parameters in a global, hierarchical key database. The core is a small library implemented in C. The plugin-based framework fulfills many configuration-related tasks to avoid any unnecessary code duplication across applications while it still allows the core to stay without any external dependency. Elektra abstracts from cross-platform-related issues with an consistent API, and allows applications to be aware of other applications' configurations, leveraging easy application integration.")
set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PACKAGE_DESCRIPTION}")
set (CPACK_PACKAGE_CONTACT "${PACKAGE_URL}")
set (CPACK_SOURCE_IGNORE_FILES
"/.cvsignore"
"/.gitignore"
"/songs/"
"/build/"
"/.svn/"
"/.git/"
"/osx-utils/"
"/portage-overlay/"
)
set (CPACK_PACKAGE_EXECUTABLES kdb)
set (CPACK_SOURCE_GENERATOR "TBZ2")
set (CPACK_GENERATOR "TBZ2")
# needed because otherwise files would be written to
# system during creating the package
SET (CPACK_SET_DESTDIR "ON")
#package is not relocatable:
unset(CPACK_RPM_PACKAGE_RELOCATABLE)
unset(CPACK_RPM_PACKAGE_RELOCATABLE CACHE)
if ("${CMAKE_BUILD_TYPE}" MATCHES "Release")
set (CPACK_STRIP_FILES TRUE)
endif ("${CMAKE_BUILD_TYPE}" MATCHES "Release")
if (APPLE)
set (CPACK_GENERATOR "PACKAGEMAKER;OSXX11")
endif (APPLE)
if (UNIX)
# Try to find architecture
execute_process (COMMAND uname -m OUTPUT_VARIABLE CPACK_PACKAGE_ARCHITECTURE)
string (STRIP "${CPACK_PACKAGE_ARCHITECTURE}" CPACK_PACKAGE_ARCHITECTURE)
# Try to find distro name and distro-specific arch
execute_process (COMMAND lsb_release -is OUTPUT_VARIABLE LSB_ID)
execute_process (COMMAND lsb_release -rs OUTPUT_VARIABLE LSB_RELEASE)
string (STRIP "${LSB_ID}" LSB_ID)
string (STRIP "${LSB_RELEASE}" LSB_RELEASE)
set (LSB_DISTRIB "${LSB_ID}${LSB_RELEASE}")
if (NOT LSB_DISTRIB)
set (LSB_DISTRIB "unix")
endif (NOT LSB_DISTRIB)
# For Debian-based distros we want to create DEB packages.
if ("${LSB_DISTRIB}" MATCHES "Ubuntu|Debian")
set (CPACK_GENERATOR "DEB")
set (CPACK_DEBIAN_PACKAGE_PRIORITY "optional")
set (CPACK_DEBIAN_PACKAGE_SECTION "libs")
set (CPACK_DEBIAN_PACKAGE_RECOMMENDS "")
set (CPACK_DEBIAN_PACKAGE_DEPENDS " ") # no dependencies without any PLUGINS
# We need to alter the architecture names as per distro rules
if ("${CPACK_PACKAGE_ARCHITECTURE}" MATCHES "i[3-6]86")
set (CPACK_PACKAGE_ARCHITECTURE i386)
endif ("${CPACK_PACKAGE_ARCHITECTURE}" MATCHES "i[3-6]86")
if ("${CPACK_PACKAGE_ARCHITECTURE}" MATCHES "x86_64")
set (CPACK_PACKAGE_ARCHITECTURE amd64)
endif ("${CPACK_PACKAGE_ARCHITECTURE}" MATCHES "x86_64")
endif ("${LSB_DISTRIB}" MATCHES "Ubuntu|Debian")
set (CPACK_SYSTEM_NAME "${LSB_DISTRIB}-${CPACK_PACKAGE_ARCHITECTURE}")
message (STATUS "Detected ${CPACK_SYSTEM_NAME}. Use make package to build packages (${CPACK_GENERATOR}).")
endif (UNIX)
set(CPACK_RPM_SPEC_MORE_DEFINE "%define ignore \#")
set(CPACK_RPM_USER_FILELIST
"%ignore /etc/profile.d"
"%ignore /etc"
"%ignore /etc/bash_completion.d"
"%ignore /usr"
"%ignore /usr/local"
"%ignore /usr/local/bin"
"%ignore /usr/local/include"
"%ignore /usr/local/lib"
"%ignore /usr/local/share"
"%ignore /usr/local/share/man"
"%ignore /etc"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /etc/bash_completion.d"
"%ignore /usr"
"%ignore /usr/bin"
"%ignore /usr/include"
"%ignore /usr/lib"
"%ignore /usr/share"
"%ignore /usr/share/doc"
"%ignore /usr/share/man"
)
include (CPack)
elektra-0.8.14/cmake/ElektraUninstall.cmake 0000664 0000000 0000000 00000001732 12623421622 0020601 0 ustar 00root root 0000000 0000000 #
# Much faster is:
# xargs rm < install_manifest.txt
#
set(MANIFEST "@CMAKE_BINARY_DIR@/install_manifest.txt")
if (NOT EXISTS "@MANIFEST@")
message (FATAL_ERROR "Cannot find install manifest: @MANIFEST@")
endif (NOT EXISTS "@MANIFEST@")
file (READ "@MANIFEST@" files)
string (REGEX REPLACE "\n" ";" files "${files}")
foreach (file ${files})
message(STATUS "Uninstalling $ENV{DESTDIR}${file}")
if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
exec_program(
"@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
OUTPUT_VARIABLE rm_out
RETURN_VALUE rm_retval
)
if (NOT "${rm_retval}" STREQUAL 0)
message (FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}")
endif (NOT "${rm_retval}" STREQUAL 0)
else (IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
message (STATUS "File $ENV{DESTDIR}${file} does not exist.")
endif (IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
endforeach (file)
elektra-0.8.14/cmake/Modules/ 0000775 0000000 0000000 00000000000 12623421622 0015723 5 ustar 00root root 0000000 0000000 elektra-0.8.14/cmake/Modules/COPYING-CMAKE-SCRIPTS 0000664 0000000 0000000 00000002457 12623421622 0020731 0 ustar 00root root 0000000 0000000 Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
elektra-0.8.14/cmake/Modules/Copyright.txt 0000664 0000000 0000000 00000005140 12623421622 0020434 0 ustar 00root root 0000000 0000000 CMake - Cross Platform Makefile Generator
Copyright 2000-2015 Kitware, Inc.
Copyright 2000-2011 Insight Software Consortium
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the names of Kitware, Inc., the Insight Software Consortium,
nor the names of their contributors may be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
------------------------------------------------------------------------------
The above copyright and license notice applies to distributions of
CMake in source and binary form. Some source files contain additional
notices of original copyright by their contributors; see each source
for details. Third-party software packages supplied with CMake under
compatible licenses provide their own copyright notices documented in
corresponding subdirectories.
------------------------------------------------------------------------------
CMake was initially developed by Kitware with the following sponsorship:
* National Library of Medicine at the National Institutes of Health
as part of the Insight Segmentation and Registration Toolkit (ITK).
* US National Labs (Los Alamos, Livermore, Sandia) ASC Parallel
Visualization Initiative.
* National Alliance for Medical Image Computing (NAMIC) is funded by the
National Institutes of Health through the NIH Roadmap for Medical Research,
Grant U54 EB005149.
* Kitware, Inc.
elektra-0.8.14/cmake/Modules/FindAugeas.cmake 0000664 0000000 0000000 00000002566 12623421622 0020744 0 ustar 00root root 0000000 0000000 # Finds augeas and its libraries
# Uses the same semantics as pkg_check_modules, i.e. LIBAUGEAS{_FOUND,_INCLUDE_DIR,_LIBRARIES}
#
# This is an adapted version of FindSystemd.cmake:
# Copyright: Red Hat, Inc. 2013
# Author: Martin Briza
#
# Distributed under the BSD license. See COPYING-CMAKE-SCRIPTS for details.
if (LIBAUGEAS_INCLUDE_DIR)
# in cache already
set (LIBAUGEAS_FOUND TRUE)
else (LIBAUGEAS_INCLUDE_DIR)
# try to find libaugeas via pkg-config
find_package(PkgConfig)
if (PKG_CONFIG_FOUND)
pkg_check_modules(_LIBAUGEAS_PC QUIET "libaugeas")
endif (PKG_CONFIG_FOUND)
find_path (LIBAUGEAS_INCLUDE_DIR augeas.h
${_LIBAUGEAS_PC_INCLUDE_DIRS}
/usr/include
/usr/local/include
)
find_library (LIBAUGEAS_LIBRARIES NAMES augeas
PATHS
${_LIBAUGEAS_PC_LIBDIR}
)
if (LIBAUGEAS_INCLUDE_DIR AND LIBAUGEAS_LIBRARIES)
set (LIBAUGEAS_FOUND TRUE)
endif (LIBAUGEAS_INCLUDE_DIR AND LIBAUGEAS_LIBRARIES)
if (LIBAUGEAS_FOUND)
if (NOT LIBAUGEAS_FIND_QUIETLY)
message(STATUS "Found augeas: ${LIBAUGEAS_LIBRARIES}")
endif (NOT LIBAUGEAS_FIND_QUIETLY)
else (LIBAUGEAS_FOUND)
if (LIBAUGEAS_FIND_REQUIRED)
message(FATAL_ERROR "Could NOT find augeas")
endif (LIBAUGEAS_FIND_REQUIRED)
endif (LIBAUGEAS_FOUND)
mark_as_advanced(LIBAUGEAS_INCLUDE_DIR LIBAUGEAS_LIBRARIES)
endif (LIBAUGEAS_INCLUDE_DIR)
elektra-0.8.14/cmake/Modules/FindDBus.cmake 0000664 0000000 0000000 00000004203 12623421622 0020362 0 ustar 00root root 0000000 0000000 # - Try to find the low-level D-Bus library
# Once done this will define
#
# DBUS_FOUND - system has D-Bus
# DBUS_INCLUDE_DIR - the D-Bus include directory
# DBUS_ARCH_INCLUDE_DIR - the D-Bus architecture-specific include directory
# DBUS_LIBRARIES - the libraries needed to use D-Bus
# Copyright (c) 2008, Kevin Kofler,
# modeled after FindLibArt.cmake:
# Copyright (c) 2006, Alexander Neundorf,
#
# Redistribution and use is allowed according to the terms of the BSD license.
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
if (DBUS_INCLUDE_DIR AND DBUS_ARCH_INCLUDE_DIR AND DBUS_LIBRARIES)
# in cache already
SET(DBUS_FOUND TRUE)
else (DBUS_INCLUDE_DIR AND DBUS_ARCH_INCLUDE_DIR AND DBUS_LIBRARIES)
IF (NOT WIN32)
FIND_PACKAGE(PkgConfig)
IF (PKG_CONFIG_FOUND)
# use pkg-config to get the directories and then use these values
# in the FIND_PATH() and FIND_LIBRARY() calls
pkg_check_modules(_DBUS_PC QUIET dbus-1)
ENDIF (PKG_CONFIG_FOUND)
ENDIF (NOT WIN32)
FIND_PATH(DBUS_INCLUDE_DIR dbus/dbus.h
${_DBUS_PC_INCLUDE_DIRS}
/usr/include
/usr/include/dbus-1.0
/usr/local/include
)
FIND_PATH(DBUS_ARCH_INCLUDE_DIR dbus/dbus-arch-deps.h
${_DBUS_PC_INCLUDE_DIRS}
/usr/lib${LIB_SUFFIX}/include
/usr/lib${LIB_SUFFIX}/dbus-1.0/include
/usr/lib64/include
/usr/lib64/dbus-1.0/include
/usr/lib/include
/usr/lib/dbus-1.0/include
)
FIND_LIBRARY(DBUS_LIBRARIES NAMES dbus-1 dbus
PATHS
${_DBUS_PC_LIBDIR}
)
if (DBUS_INCLUDE_DIR AND DBUS_ARCH_INCLUDE_DIR AND DBUS_LIBRARIES)
set(DBUS_FOUND TRUE)
endif (DBUS_INCLUDE_DIR AND DBUS_ARCH_INCLUDE_DIR AND DBUS_LIBRARIES)
if (DBUS_FOUND)
if (NOT DBus_FIND_QUIETLY)
message(STATUS "Found D-Bus: ${DBUS_LIBRARIES}")
endif (NOT DBus_FIND_QUIETLY)
else (DBUS_FOUND)
if (DBus_FIND_REQUIRED)
message(FATAL_ERROR "Could NOT find D-Bus")
endif (DBus_FIND_REQUIRED)
endif (DBUS_FOUND)
MARK_AS_ADVANCED(DBUS_INCLUDE_DIR DBUS_ARCH_INCLUDE_DIR DBUS_LIBRARIES)
endif (DBUS_INCLUDE_DIR AND DBUS_ARCH_INCLUDE_DIR AND DBUS_LIBRARIES)
elektra-0.8.14/cmake/Modules/FindDiscount.cmake 0000664 0000000 0000000 00000010437 12623421622 0021323 0 ustar 00root root 0000000 0000000
#-------------------------------------------------------------------------------
# Copyright (c) 2013-2013, Lars Baehren
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#-------------------------------------------------------------------------------
# DISCOUNT is a implementation of John Gruber's Markdown markup language.
#
# DISCOUNT is free software written by David Parsons ;
# it is released under a BSD-style license that allows you to do
# as you wish with it as long as you don't attempt to claim it as
# your own work.
#
# The following variables are set when DISCOUNT is found:
# DISCOUNT_FOUND = Set to true, if all components of DISCOUNT have been found.
# DISCOUNT_INCLUDES = Include path for the header files of DISCOUNT
# DISCOUNT_LIBRARIES = Link these to use DISCOUNT
# DISCOUNT_LFLAGS = Linker flags (optional)
if (NOT DISCOUNT_FOUND)
if (NOT DISCOUNT_ROOT_DIR)
set (DISCOUNT_ROOT_DIR ${CMAKE_INSTALL_PREFIX})
endif (NOT DISCOUNT_ROOT_DIR)
##____________________________________________________________________________
## Check for the header files
find_path (DISCOUNT_INCLUDES
NAMES mkdio.h
HINTS ${DISCOUNT_ROOT_DIR} ${CMAKE_INSTALL_PREFIX}
PATH_SUFFIXES include
)
##____________________________________________________________________________
## Check for the library
find_library (DISCOUNT_LIBRARIES markdown
HINTS ${DISCOUNT_ROOT_DIR} ${CMAKE_INSTALL_PREFIX}
PATH_SUFFIXES lib
)
##____________________________________________________________________________
## Check for the executable
find_program (MARKDOWN_EXECUTABLE markdown
HINTS ${DISCOUNT_ROOT_DIR} ${CMAKE_INSTALL_PREFIX}
PATH_SUFFIXES bin
)
##____________________________________________________________________________
## Actions taken when all components have been found
find_package_handle_standard_args (DISCOUNT DEFAULT_MSG
DISCOUNT_LIBRARIES DISCOUNT_INCLUDES MARKDOWN_EXECUTABLE
)
if (DISCOUNT_FOUND)
## Update DISCOUNT_ROOT DIR
get_filename_component (_name ${MARKDOWN_EXECUTABLE} NAME)
string (REGEX REPLACE "/bin/${_name}" "" DISCOUNT_ROOT_DIR ${MARKDOWN_EXECUTABLE})
## Display variables
if (NOT DISCOUNT_FIND_QUIETLY)
message (STATUS "Found components for DISCOUNT")
message (STATUS "DISCOUNT_ROOT_DIR = ${DISCOUNT_ROOT_DIR}")
message (STATUS "DISCOUNT_INCLUDES = ${DISCOUNT_INCLUDES}")
message (STATUS "DISCOUNT_LIBRARIES = ${DISCOUNT_LIBRARIES}")
message (STATUS "MARKDOWN_EXECUTABLE = ${MARKDOWN_EXECUTABLE}")
endif (NOT DISCOUNT_FIND_QUIETLY)
else (DISCOUNT_FOUND)
if (DISCOUNT_FIND_REQUIRED)
message (FATAL_ERROR "Could not find DISCOUNT!")
endif (DISCOUNT_FIND_REQUIRED)
endif (DISCOUNT_FOUND)
##____________________________________________________________________________
## Mark advanced variables
mark_as_advanced (
DISCOUNT_ROOT_DIR
DISCOUNT_INCLUDES
DISCOUNT_LIBRARIES
MARKDOWN_EXECUTABLE
)
endif (NOT DISCOUNT_FOUND)
elektra-0.8.14/cmake/Modules/FindGObjectIntrospection.cmake 0000664 0000000 0000000 00000004152 12623421622 0023626 0 ustar 00root root 0000000 0000000 # - try to find gobject-introspection
#
# Once done this will define
#
# INTROSPECTION_FOUND - system has gobject-introspection
# INTROSPECTION_SCANNER - the gobject-introspection scanner, g-ir-scanner
# INTROSPECTION_COMPILER - the gobject-introspection compiler, g-ir-compiler
# INTROSPECTION_GENERATE - the gobject-introspection generate, g-ir-generate
# INTROSPECTION_GIRDIR
# INTROSPECTION_TYPELIBDIR
# INTROSPECTION_CFLAGS
# INTROSPECTION_LIBS
#
# Copyright (C) 2010, Pino Toscano,
#
# Redistribution and use is allowed according to the terms of the BSD license.
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
macro(_GIR_GET_PKGCONFIG_VAR _outvar _varname)
execute_process(
COMMAND ${PKG_CONFIG_EXECUTABLE} --variable=${_varname} gobject-introspection-1.0
OUTPUT_VARIABLE _result
RESULT_VARIABLE _null
)
if (_null)
else()
string(REGEX REPLACE "[\r\n]" " " _result "${_result}")
string(REGEX REPLACE " +$" "" _result "${_result}")
separate_arguments(_result)
set(${_outvar} ${_result} CACHE INTERNAL "")
endif()
endmacro(_GIR_GET_PKGCONFIG_VAR)
find_package(PkgConfig)
if(PKG_CONFIG_FOUND)
if(GObjectIntrospection_FIND_VERSION_COUNT GREATER 0)
set(_gir_version_cmp ">=${GObjectIntrospection_FIND_VERSION}")
endif()
pkg_check_modules(_pc_gir gobject-introspection-1.0${_gir_version_cmp})
if(_pc_gir_FOUND)
set(INTROSPECTION_FOUND TRUE)
_gir_get_pkgconfig_var(INTROSPECTION_SCANNER "g_ir_scanner")
_gir_get_pkgconfig_var(INTROSPECTION_COMPILER "g_ir_compiler")
_gir_get_pkgconfig_var(INTROSPECTION_GENERATE "g_ir_generate")
_gir_get_pkgconfig_var(INTROSPECTION_GIRDIR "girdir")
_gir_get_pkgconfig_var(INTROSPECTION_TYPELIBDIR "typelibdir")
set(INTROSPECTION_CFLAGS "${_pc_gir_CFLAGS}")
set(INTROSPECTION_LIBS "${_pc_gir_LIBS}")
set(INTROSPECTION_VERSION "${_pc_gir_VERSION}")
endif()
endif()
mark_as_advanced(
INTROSPECTION_SCANNER
INTROSPECTION_COMPILER
INTROSPECTION_GENERATE
INTROSPECTION_GIRDIR
INTROSPECTION_TYPELIBDIR
INTROSPECTION_CFLAGS
INTROSPECTION_LIBS
INTROSPECTION_VERSION
)
elektra-0.8.14/cmake/Modules/FindGTest.cmake 0000664 0000000 0000000 00000001576 12623421622 0020565 0 ustar 00root root 0000000 0000000 # This script reads the GTEST_ROOT variable, if available,
# looking into it as base directory of the GoogleTest sources.
#
# Otherwise it will use the source as included with Elektra.
#
# Must be included only once
#
# GTEST_ROOT will only be honored in the very first invocation
if(NOT GOOGLETEST_ROOT)
if(NOT (GTEST_ROOT STREQUAL ""))
if(EXISTS ${GTEST_ROOT}/CMakeLists.txt)
set(GOOGLETEST_ROOT
"${GTEST_ROOT}"
CACHE INTERNAL
"Folder which gtest will use"
FORCE)
message (STATUS "used external gtest below ${GTEST_ROOT}")
endif()
else()
set(GOOGLETEST_ROOT
${CMAKE_SOURCE_DIR}/tests/gtest-1.7.0
CACHE INTERNAL
"Folder which gtest will use"
FORCE)
endif()
endif()
add_subdirectory(${GOOGLETEST_ROOT} ${CMAKE_BINARY_DIR}/gtest)
set_property (TARGET gtest PROPERTY COMPILE_FLAGS "-w" )
set_property (TARGET gtest_main PROPERTY COMPILE_FLAGS "-w" )
elektra-0.8.14/cmake/Modules/FindLibGcrypt.cmake 0000664 0000000 0000000 00000003555 12623421622 0021435 0 ustar 00root root 0000000 0000000
# - Try to find the Gcrypt library
# Once run this will define
#
# LIBGCRYPT_FOUND - set if the system has the gcrypt library
# LIBGCRYPT_CFLAGS - the required gcrypt compilation flags
# LIBGCRYPT_LIBRARIES - the linker libraries needed to use the gcrypt library
#
# Copyright (c) 2006 Brad Hards
#
# Redistribution and use is allowed according to the terms of the BSD license.
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
# libgcrypt is moving to pkg-config, but earlier version don't have it
#search in typical paths for libgcrypt-config
FIND_PROGRAM(LIBGCRYPTCONFIG_EXECUTABLE NAMES libgcrypt-config)
#reset variables
set(LIBGCRYPT_LIBRARIES)
set(LIBGCRYPT_CFLAGS)
# if libgcrypt-config has been found
IF(LIBGCRYPTCONFIG_EXECUTABLE)
# workaround for MinGW/MSYS
# CMake can't starts shell scripts on windows so it need to use sh.exe
EXECUTE_PROCESS(COMMAND sh ${LIBGCRYPTCONFIG_EXECUTABLE} --libs RESULT_VARIABLE _return_VALUE OUTPUT_VARIABLE LIBGCRYPT_LIBRARIES OUTPUT_STRIP_TRAILING_WHITESPACE)
EXECUTE_PROCESS(COMMAND sh ${LIBGCRYPTCONFIG_EXECUTABLE} --cflags RESULT_VARIABLE _return_VALUE OUTPUT_VARIABLE LIBGCRYPT_CFLAGS OUTPUT_STRIP_TRAILING_WHITESPACE)
IF(NOT LIBGCRYPT_CFLAGS AND NOT _return_VALUE)
SET(LIBGCRYPT_CFLAGS " ")
ENDIF(NOT LIBGCRYPT_CFLAGS AND NOT _return_VALUE)
IF(LIBGCRYPT_LIBRARIES AND LIBGCRYPT_CFLAGS)
SET(LIBGCRYPT_FOUND TRUE)
ENDIF(LIBGCRYPT_LIBRARIES AND LIBGCRYPT_CFLAGS)
ENDIF(LIBGCRYPTCONFIG_EXECUTABLE)
if (LIBGCRYPT_FOUND)
if (NOT LibGcrypt_FIND_QUIETLY)
message(STATUS "Found libgcrypt: ${LIBGCRYPT_LIBRARIES}")
endif (NOT LibGcrypt_FIND_QUIETLY)
else (LIBGCRYPT_FOUND)
if (LibGcrypt_FIND_REQUIRED)
message(FATAL_ERROR "Could not find libgcrypt libraries")
endif (LibGcrypt_FIND_REQUIRED)
endif (LIBGCRYPT_FOUND)
MARK_AS_ADVANCED(LIBGCRYPT_CFLAGS LIBGCRYPT_LIBRARIES)
elektra-0.8.14/cmake/Modules/FindLua52.cmake 0000664 0000000 0000000 00000004261 12623421622 0020421 0 ustar 00root root 0000000 0000000 # Locate Lua library
# This module defines
# LUA52_FOUND, if false, do not try to link to Lua
# LUA_LIBRARIES
# LUA_INCLUDE_DIR, where to find lua.h
# LUA_VERSION_STRING, the version of Lua found (since CMake 2.8.8)
#
# Note that the expected include convention is
# #include "lua.h"
# and not
# #include
# This is because, the lua location is not standardized and may exist
# in locations other than lua/
#=============================================================================
# Copyright 2007-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
find_path(LUA_INCLUDE_DIR lua.h
HINTS
ENV LUA_DIR
PATH_SUFFIXES include/lua52 include/lua5.2 include/lua-5.2 include/lua include
PATHS
~/Library/Frameworks
/Library/Frameworks
/sw # Fink
/opt/local # DarwinPorts
/opt/csw # Blastwave
/opt
)
find_library(LUA_LIBRARY
NAMES lua52 lua5.2 lua-5.2 lua
HINTS
ENV LUA_DIR
PATH_SUFFIXES lib
PATHS
~/Library/Frameworks
/Library/Frameworks
/sw
/opt/local
/opt/csw
/opt
)
if(LUA_LIBRARY)
# include the math library for Unix
if(UNIX AND NOT APPLE AND NOT BEOS)
find_library(LUA_MATH_LIBRARY m)
set( LUA_LIBRARIES "${LUA_LIBRARY};${LUA_MATH_LIBRARY}" CACHE STRING "Lua Libraries")
# For Windows and Mac, don't need to explicitly include the math library
else()
set( LUA_LIBRARIES "${LUA_LIBRARY}" CACHE STRING "Lua Libraries")
endif()
endif()
include(FindPackageHandleStandardArgs)
# handle the QUIETLY and REQUIRED arguments and set LUA_FOUND to TRUE if
# all listed variables are TRUE
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Lua52
REQUIRED_VARS LUA_LIBRARIES LUA_INCLUDE_DIR)
mark_as_advanced(LUA_INCLUDE_DIR LUA_LIBRARIES LUA_LIBRARY LUA_MATH_LIBRARY)
elektra-0.8.14/cmake/Modules/FindPython2Interp.cmake 0000664 0000000 0000000 00000014240 12623421622 0022254 0 ustar 00root root 0000000 0000000 # - Find python interpreter
# This module finds if Python interpreter is installed and determines where the
# executables are. This code sets the following variables:
#
# PYTHON2INTERP_FOUND - Was the Python executable found
# PYTHON2_EXECUTABLE - path to the Python interpreter
#
# PYTHON2_VERSION_STRING - Python version found e.g. 2.5.2
# PYTHON2_VERSION_MAJOR - Python major version found e.g. 2
# PYTHON2_VERSION_MINOR - Python minor version found e.g. 5
# PYTHON2_VERSION_PATCH - Python patch version found e.g. 2
#
# The Python2_ADDITIONAL_VERSIONS variable can be used to specify a list of
# version numbers that should be taken into account when searching for Python.
# You need to set this variable before calling find_package(Python2Interp).
#=============================================================================
# Copyright 2005-2010 Kitware, Inc.
# Copyright 2011 Bjoern Ricks
# Copyright 2012 Rolf Eike Beer
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
unset(_Python_NAMES)
set(_PYTHON2_VERSIONS 2.7)
if(Python2Interp_FIND_VERSION)
if(Python2Interp_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
string(REGEX REPLACE "^([0-9]+\\.[0-9]+).*" "\\1" _PYTHON2_FIND_MAJ_MIN "${Python2Interp_FIND_VERSION}")
string(REGEX REPLACE "^([0-9]+).*" "\\1" _PYTHON2_FIND_MAJ "${_PYTHON2_FIND_MAJ_MIN}")
list(APPEND _Python_NAMES python${_PYTHON2_FIND_MAJ_MIN} python${_PYTHON2_FIND_MAJ})
unset(_PYTHON2_FIND_OTHER_VERSIONS)
if(NOT Python2Interp_FIND_VERSION_EXACT)
foreach(_PYTHON2_V ${_PYTHON2${_PYTHON2_FIND_MAJ}_VERSIONS})
if(NOT _PYTHON2_V VERSION_LESS _PYTHON2_FIND_MAJ_MIN)
list(APPEND _PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON2_V})
endif()
endforeach()
endif(NOT Python2Interp_FIND_VERSION_EXACT)
unset(_PYTHON2_FIND_MAJ_MIN)
unset(_PYTHON2_FIND_MAJ)
else(Python2Interp_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
list(APPEND _Python_NAMES python${Python2Interp_FIND_VERSION})
set(_PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON2${Python2Interp_FIND_VERSION}_VERSIONS})
endif(Python2Interp_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
else(Python2Interp_FIND_VERSION)
set(_PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON2_VERSIONS})
endif(Python2Interp_FIND_VERSION)
list(APPEND _Python_NAMES python)
# Search for the current active python version first
find_program(PYTHON2_EXECUTABLE NAMES ${_Python_NAMES})
# Set up the versions we know about, in the order we will search. Always add
# the user supplied additional versions to the front.
set(_Python2_VERSIONS
${Python2_ADDITIONAL_VERSIONS}
${_PYTHON2_FIND_OTHER_VERSIONS}
)
unset(_PYTHON2_FIND_OTHER_VERSIONS)
unset(_PYTHON2_VERSIONS)
# Search for newest python version if python executable isn't found
if(NOT PYTHON2_EXECUTABLE)
foreach(_CURRENT_VERSION ${_Python2_VERSIONS})
set(_Python_NAMES python${_CURRENT_VERSION})
if(WIN32)
list(APPEND _Python_NAMES python)
endif()
find_program(PYTHON2_EXECUTABLE
NAMES ${_Python_NAMES}
PATHS [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]
)
endforeach()
endif()
# determine python version string
if(PYTHON2_EXECUTABLE)
execute_process(COMMAND "${PYTHON2_EXECUTABLE}" -c
"import sys; sys.stdout.write(';'.join([str(x) for x in sys.version_info[:3]]))"
OUTPUT_VARIABLE _VERSION
RESULT_VARIABLE _PYTHON2_VERSION_RESULT
ERROR_QUIET)
if(NOT _PYTHON2_VERSION_RESULT)
string(REPLACE ";" "." PYTHON2_VERSION_STRING "${_VERSION}")
list(GET _VERSION 0 PYTHON2_VERSION_MAJOR)
list(GET _VERSION 1 PYTHON2_VERSION_MINOR)
list(GET _VERSION 2 PYTHON2_VERSION_PATCH)
if(PYTHON2_VERSION_PATCH EQUAL 0)
# it's called "Python 2.7", not "2.7.0"
string(REGEX REPLACE "\\.0$" "" PYTHON2_VERSION_STRING "${PYTHON2_VERSION_STRING}")
endif()
else()
# sys.version predates sys.version_info, so use that
execute_process(COMMAND "${PYTHON2_EXECUTABLE}" -c "import sys; sys.stdout.write(sys.version)"
OUTPUT_VARIABLE _VERSION
RESULT_VARIABLE _PYTHON2_VERSION_RESULT
ERROR_QUIET)
if(NOT _PYTHON2_VERSION_RESULT)
string(REGEX REPLACE " .*" "" PYTHON2_VERSION_STRING "${_VERSION}")
string(REGEX REPLACE "^([0-9]+)\\.[0-9]+.*" "\\1" PYTHON2_VERSION_MAJOR "${PYTHON2_VERSION_STRING}")
string(REGEX REPLACE "^[0-9]+\\.([0-9])+.*" "\\1" PYTHON2_VERSION_MINOR "${PYTHON2_VERSION_STRING}")
if(PYTHON2_VERSION_STRING MATCHES "^[0-9]+\\.[0-9]+\\.[0-9]+.*")
string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" PYTHON2_VERSION_PATCH "${PYTHON2_VERSION_STRING}")
else()
set(PYTHON2_VERSION_PATCH "0")
endif()
else()
# sys.version was first documented for Python 1.5, so assume
# this is older.
set(PYTHON2_VERSION_STRING "1.4")
set(PYTHON2_VERSION_MAJOR "1")
set(PYTHON2_VERSION_MAJOR "4")
set(PYTHON2_VERSION_MAJOR "0")
endif()
endif()
unset(_PYTHON2_VERSION_RESULT)
unset(_VERSION)
endif(PYTHON2_EXECUTABLE)
# handle the QUIETLY and REQUIRED arguments and set PYTHON2INTERP_FOUND to TRUE if
# all listed variables are TRUE
include(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Python2Interp REQUIRED_VARS PYTHON2_EXECUTABLE VERSION_VAR PYTHON2_VERSION_STRING)
mark_as_advanced(PYTHON2_EXECUTABLE)
elektra-0.8.14/cmake/Modules/FindPython2Libs.cmake 0000664 0000000 0000000 00000027476 12623421622 0021723 0 ustar 00root root 0000000 0000000 # - Find python libraries
# This module finds if Python is installed and determines where the
# include files and libraries are. It also determines what the name of
# the library is. This code sets the following variables:
#
# PYTHON2LIBS_FOUND - have the Python libs been found
# PYTHON2_LIBRARIES - path to the python library
# PYTHON2_INCLUDE_PATH - path to where Python.h is found (deprecated)
# PYTHON2_INCLUDE_DIRS - path to where Python.h is found
# PYTHON2_DEBUG_LIBRARIES - path to the debug library (deprecated)
# PYTHON2LIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8)
#
# The Python2_ADDITIONAL_VERSIONS variable can be used to specify a list of
# version numbers that should be taken into account when searching for Python.
# You need to set this variable before calling find_package(Python2Libs).
#
# If you'd like to specify the installation of Python to use, you should modify
# the following cache variables:
# PYTHON2_LIBRARY - path to the python library
# PYTHON2_INCLUDE_DIR - path to where Python.h is found
#=============================================================================
# Copyright 2001-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
INCLUDE(CMakeFindFrameworks)
# Search for the python framework on Apple.
CMAKE_FIND_FRAMEWORKS(Python)
SET(_PYTHON21_VERSIONS 1.6 1.5)
SET(_PYTHON22_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0)
SET(_PYTHON23_VERSIONS 3.3 3.2 3.1 3.0)
IF(Python2Libs_FIND_VERSION)
IF(Python2Libs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
STRING(REGEX REPLACE "^([0-9]+\\.[0-9]+).*" "\\1" _PYTHON2_FIND_MAJ_MIN "${Python2Libs_FIND_VERSION}")
STRING(REGEX REPLACE "^([0-9]+).*" "\\1" _PYTHON2_FIND_MAJ "${_PYTHON2_FIND_MAJ_MIN}")
UNSET(_PYTHON2_FIND_OTHER_VERSIONS)
IF(Python2Libs_FIND_VERSION_EXACT)
IF(_PYTHON2_FIND_MAJ_MIN STREQUAL Python2Libs_FIND_VERSION)
SET(_PYTHON2_FIND_OTHER_VERSIONS "${Python2Libs_FIND_VERSION}")
ELSE(_PYTHON2_FIND_MAJ_MIN STREQUAL Python2Libs_FIND_VERSION)
SET(_PYTHON2_FIND_OTHER_VERSIONS "${Python2Libs_FIND_VERSION}" "${_PYTHON2_FIND_MAJ_MIN}")
ENDIF(_PYTHON2_FIND_MAJ_MIN STREQUAL Python2Libs_FIND_VERSION)
ELSE(Python2Libs_FIND_VERSION_EXACT)
FOREACH(_PYTHON2_V ${_PYTHON2${_PYTHON2_FIND_MAJ}_VERSIONS})
IF(NOT _PYTHON2_V VERSION_LESS _PYTHON2_FIND_MAJ_MIN)
LIST(APPEND _PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON2_V})
ENDIF()
ENDFOREACH()
ENDIF(Python2Libs_FIND_VERSION_EXACT)
UNSET(_PYTHON2_FIND_MAJ_MIN)
UNSET(_PYTHON2_FIND_MAJ)
ELSE(Python2Libs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
SET(_PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON2${Python2Libs_FIND_VERSION}_VERSIONS})
ENDIF(Python2Libs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
ELSE(Python2Libs_FIND_VERSION)
SET(_PYTHON2_FIND_OTHER_VERSIONS ${_PYTHON23_VERSIONS} ${_PYTHON22_VERSIONS} ${_PYTHON21_VERSIONS})
ENDIF(Python2Libs_FIND_VERSION)
# Set up the versions we know about, in the order we will search. Always add
# the user supplied additional versions to the front.
SET(_Python2_VERSIONS
${Python2_ADDITIONAL_VERSIONS}
${_PYTHON2_FIND_OTHER_VERSIONS}
)
UNSET(_PYTHON2_FIND_OTHER_VERSIONS)
UNSET(_PYTHON21_VERSIONS)
UNSET(_PYTHON22_VERSIONS)
UNSET(_PYTHON23_VERSIONS)
FOREACH(_CURRENT_VERSION ${_Python2_VERSIONS})
STRING(REPLACE "." "" _CURRENT_VERSION_NO_DOTS ${_CURRENT_VERSION})
IF(WIN32)
FIND_LIBRARY(PYTHON2_DEBUG_LIBRARY
NAMES python${_CURRENT_VERSION_NO_DOTS}_d python
PATHS
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
)
ENDIF(WIN32)
FIND_LIBRARY(PYTHON2_LIBRARY
NAMES
python${_CURRENT_VERSION_NO_DOTS}
python${_CURRENT_VERSION}mu
python${_CURRENT_VERSION}m
python${_CURRENT_VERSION}u
python${_CURRENT_VERSION}
PATHS
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
# Avoid finding the .dll in the PATH. We want the .lib.
NO_SYSTEM_ENVIRONMENT_PATH
)
# Look for the static library in the Python config directory
FIND_LIBRARY(PYTHON2_LIBRARY
NAMES python${_CURRENT_VERSION_NO_DOTS} python${_CURRENT_VERSION}
# Avoid finding the .dll in the PATH. We want the .lib.
NO_SYSTEM_ENVIRONMENT_PATH
# This is where the static library is usually located
PATH_SUFFIXES python${_CURRENT_VERSION}/config
)
# For backward compatibility, honour value of PYTHON2_INCLUDE_PATH, if
# PYTHON2_INCLUDE_DIR is not set.
IF(DEFINED PYTHON2_INCLUDE_PATH AND NOT DEFINED PYTHON2_INCLUDE_DIR)
SET(PYTHON2_INCLUDE_DIR "${PYTHON2_INCLUDE_PATH}" CACHE PATH
"Path to where Python.h is found" FORCE)
ENDIF(DEFINED PYTHON2_INCLUDE_PATH AND NOT DEFINED PYTHON2_INCLUDE_DIR)
SET(PYTHON2_FRAMEWORK_INCLUDES)
IF(Python_FRAMEWORKS AND NOT PYTHON2_INCLUDE_DIR)
FOREACH(dir ${Python_FRAMEWORKS})
SET(PYTHON2_FRAMEWORK_INCLUDES ${PYTHON2_FRAMEWORK_INCLUDES}
${dir}/Versions/${_CURRENT_VERSION}/include/python${_CURRENT_VERSION})
ENDFOREACH(dir)
ENDIF(Python_FRAMEWORKS AND NOT PYTHON2_INCLUDE_DIR)
FIND_PATH(PYTHON2_INCLUDE_DIR
NAMES Python.h
PATHS
${PYTHON2_FRAMEWORK_INCLUDES}
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include
PATH_SUFFIXES
python${_CURRENT_VERSION}mu
python${_CURRENT_VERSION}m
python${_CURRENT_VERSION}u
python${_CURRENT_VERSION}
)
# For backward compatibility, set PYTHON2_INCLUDE_PATH.
SET(PYTHON2_INCLUDE_PATH "${PYTHON2_INCLUDE_DIR}")
IF(PYTHON2_INCLUDE_DIR AND EXISTS "${PYTHON2_INCLUDE_DIR}/patchlevel.h")
FILE(STRINGS "${PYTHON2_INCLUDE_DIR}/patchlevel.h" python_version_str
REGEX "^#define[ \t]+PY_VERSION[ \t]+\"[^\"]+\"")
STRING(REGEX REPLACE "^#define[ \t]+PY_VERSION[ \t]+\"([^\"]+)\".*" "\\1"
PYTHON2LIBS_VERSION_STRING "${python_version_str}")
UNSET(python_version_str)
ENDIF(PYTHON2_INCLUDE_DIR AND EXISTS "${PYTHON2_INCLUDE_DIR}/patchlevel.h")
IF(PYTHON2_LIBRARY AND PYTHON2_INCLUDE_DIR)
BREAK()
ENDIF(PYTHON2_LIBRARY AND PYTHON2_INCLUDE_DIR)
ENDFOREACH(_CURRENT_VERSION)
MARK_AS_ADVANCED(
PYTHON2_DEBUG_LIBRARY
PYTHON2_LIBRARY
PYTHON2_INCLUDE_DIR
)
# We use PYTHON2_INCLUDE_DIR, PYTHON2_LIBRARY and PYTHON2_DEBUG_LIBRARY for the
# cache entries because they are meant to specify the location of a single
# library. We now set the variables listed by the documentation for this
# module.
SET(PYTHON2_INCLUDE_DIRS "${PYTHON2_INCLUDE_DIR}")
SET(PYTHON2_DEBUG_LIBRARIES "${PYTHON2_DEBUG_LIBRARY}")
# These variables have been historically named in this module different from
# what SELECT_LIBRARY_CONFIGURATIONS() expects.
SET(PYTHON2_LIBRARY_DEBUG "${PYTHON2_DEBUG_LIBRARY}")
SET(PYTHON2_LIBRARY_RELEASE "${PYTHON2_LIBRARY}")
INCLUDE(SelectLibraryConfigurations)
SELECT_LIBRARY_CONFIGURATIONS(PYTHON2)
# SELECT_LIBRARY_CONFIGURATIONS() sets ${PREFIX}_FOUND if it has a library.
# Unset this, this prefix doesn't match the module prefix, they are different
# for historical reasons.
UNSET(PYTHON2_FOUND)
INCLUDE(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Python2Libs
REQUIRED_VARS PYTHON2_LIBRARIES PYTHON2_INCLUDE_DIRS
VERSION_VAR PYTHON2LIBS_VERSION_STRING)
# PYTHON2_ADD_MODULE( src1 src2 ... srcN) is used to build modules for python.
# PYTHON2_WRITE_MODULES_HEADER() writes a header file you can include
# in your sources to initialize the static python modules
FUNCTION(PYTHON2_ADD_MODULE _NAME )
GET_PROPERTY(_TARGET_SUPPORTS_SHARED_LIBS
GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS)
OPTION(PYTHON2_ENABLE_MODULE_${_NAME} "Add module ${_NAME}" TRUE)
OPTION(PYTHON2_MODULE_${_NAME}_BUILD_SHARED
"Add module ${_NAME} shared" ${_TARGET_SUPPORTS_SHARED_LIBS})
# Mark these options as advanced
MARK_AS_ADVANCED(PYTHON2_ENABLE_MODULE_${_NAME}
PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
IF(PYTHON2_ENABLE_MODULE_${_NAME})
IF(PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
SET(PY_MODULE_TYPE MODULE)
ELSE(PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
SET(PY_MODULE_TYPE STATIC)
SET_PROPERTY(GLOBAL APPEND PROPERTY PY_STATIC_MODULES_LIST ${_NAME})
ENDIF(PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
SET_PROPERTY(GLOBAL APPEND PROPERTY PY_MODULES_LIST ${_NAME})
ADD_LIBRARY(${_NAME} ${PY_MODULE_TYPE} ${ARGN})
# TARGET_LINK_LIBRARIES(${_NAME} ${PYTHON2_LIBRARIES})
IF(PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
SET_TARGET_PROPERTIES(${_NAME} PROPERTIES PREFIX "${PYTHON2_MODULE_PREFIX}")
IF(WIN32 AND NOT CYGWIN)
SET_TARGET_PROPERTIES(${_NAME} PROPERTIES SUFFIX ".pyd")
ENDIF(WIN32 AND NOT CYGWIN)
ENDIF(PYTHON2_MODULE_${_NAME}_BUILD_SHARED)
ENDIF(PYTHON2_ENABLE_MODULE_${_NAME})
ENDFUNCTION(PYTHON2_ADD_MODULE)
FUNCTION(PYTHON2_WRITE_MODULES_HEADER _filename)
GET_PROPERTY(PY_STATIC_MODULES_LIST GLOBAL PROPERTY PY_STATIC_MODULES_LIST)
GET_FILENAME_COMPONENT(_name "${_filename}" NAME)
STRING(REPLACE "." "_" _name "${_name}")
STRING(TOUPPER ${_name} _nameUpper)
SET(_filename ${CMAKE_CURRENT_BINARY_DIR}/${_filename})
SET(_filenameTmp "${_filename}.in")
FILE(WRITE ${_filenameTmp} "/*Created by cmake, do not edit, changes will be lost*/\n")
FILE(APPEND ${_filenameTmp}
"#ifndef ${_nameUpper}
#define ${_nameUpper}
#include
#ifdef __cplusplus
extern \"C\" {
#endif /* __cplusplus */
")
FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp} "extern void init${PYTHON2_MODULE_PREFIX}${_currentModule}(void);\n\n")
ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp}
"#ifdef __cplusplus
}
#endif /* __cplusplus */
")
FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp} "int ${_name}_${_currentModule}(void) \n{\n static char name[]=\"${PYTHON2_MODULE_PREFIX}${_currentModule}\"; return PyImport_AppendInittab(name, init${PYTHON2_MODULE_PREFIX}${_currentModule});\n}\n\n")
ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp} "void ${_name}_LoadAllPythonModules(void)\n{\n")
FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp} " ${_name}_${_currentModule}();\n")
ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
FILE(APPEND ${_filenameTmp} "}\n\n")
FILE(APPEND ${_filenameTmp} "#ifndef EXCLUDE_LOAD_ALL_FUNCTION\nvoid CMakeLoadAllPythonModules(void)\n{\n ${_name}_LoadAllPythonModules();\n}\n#endif\n\n#endif\n")
# with CONFIGURE_FILE() cmake complains that you may not use a file created using FILE(WRITE) as input file for CONFIGURE_FILE()
EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${_filenameTmp}" "${_filename}" OUTPUT_QUIET ERROR_QUIET)
ENDFUNCTION(PYTHON2_WRITE_MODULES_HEADER)
elektra-0.8.14/cmake/Modules/FindSystemdJournal.cmake 0000664 0000000 0000000 00000004753 12623421622 0022522 0 ustar 00root root 0000000 0000000 # Finds systemd-journal and its libraries
# Uses the same semantics as pkg_check_modules, i.e. LIBSYSTEMD_JOURNAL{_FOUND,_INCLUDE_DIR,_LIBRARIES}
#
# This is an adapted version of FindSystemd.cmake:
# Copyright: Red Hat, Inc. 2013
# Author: Martin Briza
#
# Distributed under the BSD license. See COPYING-CMAKE-SCRIPTS for details.
if (LIBSYSTEMD_JOURNAL_INCLUDE_DIR AND LIBSYSTEMD_ID128_INCLUDE_DIR)
# in cache already
set (LIBSYSTEMD_JOURNAL_FOUND TRUE)
else (LIBSYSTEMD_JOURNAL_INCLUDE_DIR AND LIBSYSTEMD_ID128_INCLUDE_DIR)
# try to find systemd-journal via pkg-config
find_package(PkgConfig)
if (PKG_CONFIG_FOUND)
pkg_check_modules(_LIBSYSTEMD_JOURNAL_PC QUIET "libsystemd-journal")
pkg_check_modules(_LIBSYSTEMD_ID128_PC QUIET "libsystemd-id128")
pkg_check_modules(_LIBSYSTEMD_PC QUIET "libsystemd")
endif (PKG_CONFIG_FOUND)
find_path (LIBSYSTEMD_JOURNAL_INCLUDE_DIR systemd/sd-journal.h
${_LIBSYSTEMD_JOURNAL_PC_INCLUDE_DIRS}
${_LIBSYSTEMD_PC_INCLUDE_DIRS}
/usr/include
/usr/local/include
)
find_path (LIBSYSTEMD_ID128_INCLUDE_DIR systemd/sd-id128.h
${_LIBSYSTEMD_ID128_PC_INCLUDE_DIRS}
${_LIBSYSTEMD_PC_INCLUDE_DIRS}
/usr/include
/usr/local/include
)
find_library (LIBSYSTEMD_JOURNAL_LIBRARIES NAMES systemd-journal systemd-id128
PATHS
${_LIBSYSTEMD_JOURNAL_PC_LIBDIR}
${_LIBSYSTEMD_ID128_PC_LIBDIR}
)
# at least on newer versions of debian the libraries have been merged
if (NOT LIBSYSTEMD_JOURNAL_LIBRARIES)
find_library (LIBSYSTEMD_JOURNAL_LIBRARIES NAMES systemd
PATHS
${_LIBSYSTEMD_PC_LIBDIR}
)
endif (NOT LIBSYSTEMD_JOURNAL_LIBRARIES)
if (LIBSYSTEMD_JOURNAL_INCLUDE_DIR AND LIBSYSTEMD_ID128_INCLUDE_DIR AND LIBSYSTEMD_JOURNAL_LIBRARIES)
set (LIBSYSTEMD_JOURNAL_FOUND TRUE)
endif (LIBSYSTEMD_JOURNAL_INCLUDE_DIR AND LIBSYSTEMD_ID128_INCLUDE_DIR AND LIBSYSTEMD_JOURNAL_LIBRARIES)
if (LIBSYSTEMD_JOURNAL_FOUND)
if (NOT LIBSYSTEMD_JOURNAL_FIND_QUIETLY)
message(STATUS "Found systemd-journal: ${LIBSYSTEMD_JOURNAL_LIBRARIES}")
endif (NOT LIBSYSTEMD_JOURNAL_FIND_QUIETLY)
else (LIBSYSTEMD_JOURNAL_FOUND)
if (LIBSYSTEMD_JOURNAL_FIND_REQUIRED)
message(FATAL_ERROR "Could NOT find systemd-journal")
endif (LIBSYSTEMD_JOURNAL_FIND_REQUIRED)
endif (LIBSYSTEMD_JOURNAL_FOUND)
mark_as_advanced(LIBSYSTEMD_JOURNAL_INCLUDE_DIR LIBSYSTEMD_ID128_INCLUDE_DIR LIBSYSTEMD_JOURNAL_LIBRARIES)
endif (LIBSYSTEMD_JOURNAL_INCLUDE_DIR AND LIBSYSTEMD_ID128_INCLUDE_DIR)
elektra-0.8.14/cmake/Modules/FindYajl.cmake 0000664 0000000 0000000 00000001726 12623421622 0020433 0 ustar 00root root 0000000 0000000 #
# Find libyajl
#
# yajl is a json parser needed for the plugin yajl
#
# YAJL_FOUND - true if yajl was found
# YAJL_INCLUDE_DIRS - where to find the header file yajl/yajl_common.h
# YAJL_LIBRARIES - where to find the library libyail
# YAJL_VERSION - "1" if no yajl/yajl_version.h found
#
find_path(YAJL_INCLUDE_DIR yajl/yajl_common.h)
set(YAJL_NAMES ${YAJL_NAMES} yajl libyajl)
find_library(YAJL_LIBRARY NAMES ${YAJL_NAMES} PATH)
INCLUDE(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Yajl DEFAULT_MSG YAJL_LIBRARY YAJL_INCLUDE_DIR)
if(YAJL_FOUND)
set (YAJL_INCLUDE_DIRS ${YAJL_INCLUDE_DIR})
set (YAJL_LIBRARIES ${YAJL_LIBRARY})
find_path(YAJL2_INCLUDE_DIR yajl/yajl_version.h)
if(NOT YAJL2_INCLUDE_DIR)
message(STATUS "Assume Yajl Version 1 because yajl/yajl_version.h was not found")
set(YAJL_NO_VERSION "1")
endif(NOT YAJL2_INCLUDE_DIR)
endif(YAJL_FOUND)
mark_as_advanced( YAJL2_INCLUDE_DIR YAJL_INCLUDE_DIR YAJL_LIBRARY)
elektra-0.8.14/cmake/Modules/LibAddMacros.cmake 0000664 0000000 0000000 00000047642 12623421622 0021226 0 ustar 00root root 0000000 0000000 # Copy a file from source dir to binary dir
#
# copy_file or directory
#
macro (copy_file src dest)
execute_process (
COMMAND
${CMAKE_COMMAND} -E copy
"${src}"
"${dest}"
)
endmacro (copy_file)
# Create a symlink
#create_symlink old new - create a symbolic link new -> old
#
macro (create_symlink old new)
execute_process (
COMMAND
${CMAKE_COMMAND} -E create_symlink
"${old}"
"${new}"
)
endmacro (create_symlink)
# Make a directory
#
# mkdir dir
#
macro (mkdir dir)
execute_process (
COMMAND
${CMAKE_COMMAND} -E make_directory
"${dir}"
)
endmacro (mkdir)
macro (add_testheaders HDR_FILES)
include_directories ("${PROJECT_SOURCE_DIR}/tests/cframework")
file (GLOB BIN_HDR_FILES
"${PROJECT_SOURCE_DIR}/tests/cframework/*.h")
list (APPEND ${HDR_FILES} ${BIN_HDR_FILES})
endmacro (add_testheaders HDR_FILES)
# for generic targets (not tools) use this function to link against elektra
function (target_link_elektra TARGET)
if (BUILD_FULL)
target_link_libraries (${TARGET} elektra-full)
elseif (BUILD_STATIC)
target_link_libraries (${TARGET} elektra-static)
elseif (BUILD_SHARED)
target_link_libraries (${TARGET} elektra)
else ()
message(SEND_ERROR "no elektra to link for ${TARGET}, please enable BUILD_FULL, BUILD_STATIC or BUILD_SHARED")
endif ()
endfunction()
function (target_link_elektratools TARGET)
if (BUILD_FULL)
target_link_libraries (${TARGET} elektratools-full)
elseif (BUILD_STATIC)
target_link_libraries (${TARGET} elektratools-static)
elseif (BUILD_SHARED)
target_link_libraries (${TARGET} elektratools)
else ()
message(SEND_ERROR "no elektratools to link for ${TARGET}, please enable BUILD_FULL, BUILD_STATIC or BUILD_SHARED")
endif ()
endfunction()
# for tools (not tests) use this function to link against elektra
macro(tool_link_elektra TARGET)
if (BUILD_SHARED)
target_link_libraries (${TARGET} elektra)
elseif (BUILD_FULL)
target_link_libraries (${TARGET} elektra-full)
elseif (BUILD_STATIC)
target_link_libraries (${TARGET} elektra-static)
else ()
message(SEND_ERROR "no elektra to link for ${TARGET}, please enable BUILD_FULL, BUILD_STATIC or BUILD_SHARED")
endif ()
endmacro()
macro(tool_link_elektratools TARGET)
if (BUILD_SHARED)
target_link_libraries (${TARGET} elektratools)
elseif (BUILD_FULL)
target_link_libraries (${TARGET} elektratools-full)
elseif (BUILD_STATIC)
target_link_libraries (${TARGET} elektratools-static)
else ()
message(SEND_ERROR "no elektratools to link for ${TARGET}, please enable BUILD_FULL, BUILD_STATIC or BUILD_SHARED")
endif ()
endmacro()
# Add a test for a plugin
#
# will include the common tests.h file + its source file
# additional source files can be added as additional arguments
#
# links the executeable (only if build_full)
# and adds a test
macro (add_plugintest testname)
if (BUILD_TESTING AND (BUILD_STATIC OR BUILD_FULL))
cmake_parse_arguments (ARG
"MEMLEAK" # optional keywords
"" # one value keywords
"COMPILE_DEFINITIONS;INCLUDE_DIRECTORIES;LINK_LIBRARIES;WORKING_DIRECTORY" # multi value keywords
${ARGN}
)
set (TEST_SOURCES
$
${ARG_UNPARSED_ARGUMENTS}
)
add_headers(TEST_SOURCES)
add_testheaders(TEST_SOURCES)
include_directories ("${CMAKE_SOURCE_DIR}/tests/cframework")
add_executable (testmod_${testname} ${TEST_SOURCES} testmod_${testname}.c)
if (INSTALL_TESTING)
install (TARGETS testmod_${testname}
DESTINATION ${TARGET_TOOL_EXEC_FOLDER})
endif (INSTALL_TESTING)
target_link_elektra(testmod_${testname})
target_link_libraries (testmod_${testname} ${ARG_LINK_LIBRARIES})
set_target_properties (testmod_${testname} PROPERTIES
COMPILE_DEFINITIONS "HAVE_KDBCONFIG_H;${ARG_COMPILE_DEFINITIONS}")
set_property(TARGET testmod_${testname}
APPEND PROPERTY INCLUDE_DIRECTORIES
${ARG_INCLUDE_DIRECTORIES})
add_test (NAME testmod_${testname}
COMMAND "${CMAKE_BINARY_DIR}/bin/testmod_${testname}" "${CMAKE_CURRENT_SOURCE_DIR}"
WORKING_DIRECTORY ${ARG_WORKING_DIRECTORY}
)
if (ARG_MEMLEAK)
set_property(TEST testmod_${testname} PROPERTY
LABELS memleak)
endif (ARG_MEMLEAK)
endif ()
endmacro (add_plugintest)
macro(find_swig)
if (NOT SWIG_FOUND)
find_package(SWIG 3)
if (NOT SWIG_FOUND)
message(STATUS "Search for swig2 instead")
find_package(SWIG 2 QUIET)
endif()
endif (NOT SWIG_FOUND)
endmacro(find_swig)
#
# find an util to pass to add_custom_command later
#
# Parameters:
#
# 1. util [in] : the utility fo search for. Must be added using
# add_executable first.
# 2. EXE_SYM_LOC [out]: a name for a variable where the program to be executed
# is written to.
# Note: you must pass this value to COMMAND of add_custom_command
# 3. EXE_SYM_ARG [out]: a name for a variable where the argument to be executed
# is written to.
# Note: you must pass this value to ARGS in add_custom_command
#
# Example Usage:
# add_executable (exportsymbols ...)
# include(LibAddMacros)
# find_util(exportsymbols EXE_SYM_LOC EXE_SYM_ARG)
#
# add_custom_command (
# DEPENDS exportsymbols
# COMMAND ${EXE_SYM_LOC}
# ARGS ${EXE_SYM_ARG} ... other arguments
# )
#
function(find_util util output_loc output_arg)
if (CMAKE_CROSSCOMPILING)
if (WIN32)
find_program(EXE_LOC wine)
if (EXE_LOC)
set (ARG_LOC "${CMAKE_BINARY_DIR}/bin/${util}.exe")
else()
find_program (EXE_LOC
HINTS
${CMAKE_BINARY_DIR}
${util}.exe)
endif ()
else()
find_program (EXE_LOC ${util})
endif ()
else (CMAKE_CROSSCOMPILING)
get_target_property (EXE_LOC ${util} LOCATION)
endif (CMAKE_CROSSCOMPILING)
set (${output_loc} ${EXE_LOC} PARENT_SCOPE)
set (${output_arg} ${ARG_LOC} PARENT_SCOPE)
endfunction(find_util util output)
#- Adds all headerfiles of global include path to the given variable
#
# ADD_HEADERS (variable)
#
# example:
#add_headers (SOURCES)
#SOURCES now contain the names of all global header files
#
# thus the necessary directories are also included within the macro
# don't execute this within a loop.
#
# The added files will be always the same anyway. Example see in
# tests/CMakeLists.txt
#
macro (add_headers HDR_FILES)
set (BINARY_INCLUDE_DIR "${PROJECT_BINARY_DIR}/src/include")
set (SOURCE_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/src/include")
include_directories (BEFORE "${BINARY_INCLUDE_DIR}")
file (GLOB BIN_HDR_FILES ${BINARY_INCLUDE_DIR}/*.h)
list (APPEND ${HDR_FILES} ${BIN_HDR_FILES})
include_directories (AFTER ${SOURCE_INCLUDE_DIR})
file (GLOB SRC_HDR_FILES ${SOURCE_INCLUDE_DIR}/*.h)
list (APPEND ${HDR_FILES} ${SRC_HDR_FILES})
find_util(exporterrors EXE_ERR_LOC EXE_ERR_ARG)
add_custom_command (
OUTPUT ${BINARY_INCLUDE_DIR}/kdberrors.h
DEPENDS exporterrors
COMMAND ${EXE_ERR_LOC}
ARGS ${EXE_ERR_ARG} ${CMAKE_SOURCE_DIR}/src/liberror/specification ${BINARY_INCLUDE_DIR}/kdberrors.h
)
list (APPEND ${HDR_FILES} "${BINARY_INCLUDE_DIR}/kdberrors.h")
endmacro (add_headers)
# Add all headers needed for cpp bindings
#
macro (add_cppheaders HDR_FILES)
include_directories ("${PROJECT_BINARY_DIR}/src/bindings/cpp/include")
file (GLOB BIN_HDR_FILES ${PROJECT_BINARY_DIR}/src/bindings/cpp/include/*.hpp)
list (APPEND ${HDR_FILES} ${BIN_HDR_FILES})
include_directories ("${PROJECT_SOURCE_DIR}/src/bindings/cpp/include")
file (GLOB SRC_HDR_FILES ${PROJECT_SOURCE_DIR}/src/bindings/cpp/include/*.hpp)
list (APPEND ${HDR_FILES} ${SRC_HDR_FILES})
endmacro (add_cppheaders)
macro (add_toolheaders HDR_FILES)
include_directories ("${PROJECT_BINARY_DIR}/src/libtools/include")
file (GLOB BIN_HDR_FILES ${PROJECT_BINARY_DIR}/src/libtools/include/*)
list (APPEND ${HDR_FILES} ${BIN_HDR_FILES})
include_directories ("${PROJECT_SOURCE_DIR}/src/libtools/include")
file (GLOB SRC_HDR_FILES ${PROJECT_SOURCE_DIR}/src/libtools/include/*)
list (APPEND ${HDR_FILES} ${SRC_HDR_FILES})
endmacro (add_toolheaders)
#- Removes a plugin from the global cache
#
# REMOVE_PLUGIN (name reason)
#
# example:
#remove_plugin (fstab "mntent is missing")
#
macro (remove_plugin name reason)
set (TMP ${PLUGINS})
message (STATUS "Exclude Plugin ${name} because ${reason}")
list (REMOVE_ITEM TMP ${name})
set (PLUGINS ${TMP} CACHE STRING ${PLUGINS_DOC} FORCE)
endmacro (remove_plugin)
macro (remove_binding name reason)
set (TMP ${BINDINGS})
message (STATUS "Exclude Binding ${name} because ${reason}")
list (REMOVE_ITEM TMP ${name})
set (BINDINGS ${TMP} CACHE STRING ${BINDINGS_DOC} FORCE)
endmacro (remove_binding)
macro (remove_tool name reason)
set (TMP ${TOOLS})
message (STATUS "Exclude tool ${name} because ${reason}")
list (REMOVE_ITEM TMP ${name})
set (TOOLS ${TMP} CACHE STRING ${TOOLS_DOC} FORCE)
endmacro (remove_tool)
# LIST_FILTER( [ ...]
# [OUTPUT_VARIABLE ])
# Removes items from which match any of the specified
# regular expressions. An optional argument OUTPUT_VARIABLE
# specifies a variable in which to store the matched items instead of
# updating
# As regular expressions can not be given to macros (see bug #5389), we pass
# variable names whose content is the regular expressions.
#
# copied from http://www.cmake.org/Wiki/CMakeMacroListOperations
MACRO(list_filter)
cmake_parse_arguments(LIST_FILTER "" "OUTPUT_VARIABLE" "" ${ARGV})
# Check arguments.
LIST(LENGTH LIST_FILTER_DEFAULT_ARGS LIST_FILTER_default_length)
IF(${LIST_FILTER_default_length} EQUAL 0)
MESSAGE(FATAL_ERROR "LIST_FILTER: missing list variable.")
ENDIF(${LIST_FILTER_default_length} EQUAL 0)
IF(${LIST_FILTER_default_length} EQUAL 1)
MESSAGE(FATAL_ERROR "LIST_FILTER: missing regular expression variable.")
ENDIF(${LIST_FILTER_default_length} EQUAL 1)
# Reset output variable
IF(NOT LIST_FILTER_OUTPUT_VARIABLE)
SET(LIST_FILTER_OUTPUT_VARIABLE "LIST_FILTER_internal_output")
ENDIF(NOT LIST_FILTER_OUTPUT_VARIABLE)
SET(${LIST_FILTER_OUTPUT_VARIABLE})
# Extract input list from arguments
LIST(GET LIST_FILTER_DEFAULT_ARGS 0 LIST_FILTER_input_list)
LIST(REMOVE_AT LIST_FILTER_DEFAULT_ARGS 0)
FOREACH(LIST_FILTER_item ${${LIST_FILTER_input_list}})
set(add_item "1")
FOREACH(LIST_FILTER_regexp_var ${LIST_FILTER_DEFAULT_ARGS})
FOREACH(LIST_FILTER_regexp ${${LIST_FILTER_regexp_var}})
IF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
set(add_item "0")
ENDIF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
ENDFOREACH(LIST_FILTER_regexp ${${LIST_FILTER_regexp_var}})
ENDFOREACH(LIST_FILTER_regexp_var)
if (add_item)
LIST(APPEND ${LIST_FILTER_OUTPUT_VARIABLE} ${LIST_FILTER_item})
endif()
ENDFOREACH(LIST_FILTER_item)
# If OUTPUT_VARIABLE is not specified, overwrite the input list.
IF(${LIST_FILTER_OUTPUT_VARIABLE} STREQUAL "LIST_FILTER_internal_output")
SET(${LIST_FILTER_input_list} ${${LIST_FILTER_OUTPUT_VARIABLE}})
ENDIF(${LIST_FILTER_OUTPUT_VARIABLE} STREQUAL "LIST_FILTER_internal_output")
ENDMACRO(list_filter)
#find string in list with regex
function(list_find input_list regexp_var output)
# Reset output variable
# Extract input list from arguments
set(${output} "0" PARENT_SCOPE)
FOREACH(LIST_FILTER_item ${${input_list}})
FOREACH(LIST_FILTER_regexp ${${regexp_var}})
#message("try to match ${LIST_FILTER_regexp} with ${LIST_FILTER_item}")
IF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
set(${output} "1" PARENT_SCOPE)
ENDIF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
ENDFOREACH(LIST_FILTER_regexp ${regexp_var})
ENDFOREACH(LIST_FILTER_item)
endfunction(list_find)
#- Add sources for a target
#
# ADD_SOURCES ( [ ...])
#
# The target should add the sources using:
#
#get_property (elektra_SRCS GLOBAL PROPERTY elektra_SRCS)
#list (APPEND SRC_FILES ${elektra_SRCS})
#
## descend into sub-directories
#add_subdirectory(a)
#add_subdirectory(b)
#
#get_property(super_SRCS GLOBAL PROPERTY super_SRCS)
#
#add_library(super STATIC ${super_SRCS})
################
#
#a/CMakeLists.txt:
##################
#add_sources(super
# a1.f
# a2.f
# a3.f
# )
##################
#
#b/CMakeLists.txt:
##################
#add_sources(super
# b1.f
# b2.f
# )
##################
#
#Thank to Michael Wild
#
#
# elektra... are the sources for all elektra targets
# elektra-shared... are the additional sources
# for elektra SHARED only (excludes elektra-full)
# elektra-full... are the additional sources for the versions
# with all plugins built-in (excludes elektra-shared)
#
function (add_sources target)
# define the _SRCS properties if necessary
get_property (prop_defined GLOBAL PROPERTY ${target}_SRCS DEFINED)
if (NOT prop_defined)
define_property (GLOBAL PROPERTY ${target}_SRCS
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
endif (NOT prop_defined)
# create list of sources (absolute paths)
set (SRCS)
foreach (src ${ARGN})
if (NOT IS_ABSOLUTE "${src}")
get_filename_component (src "${src}" ABSOLUTE)
endif (NOT IS_ABSOLUTE "${src}")
list (APPEND SRCS "${src}")
endforeach (src ${ARGN})
# append to global property
set_property (GLOBAL APPEND PROPERTY "${target}_SRCS" "${SRCS}")
endfunction (add_sources)
#- Add includes for a target
#
# ADD_INCLUDES ( [ ...])
#
# The target should do:
#
#get_property (elektra_INCLUDES GLOBAL PROPERTY elektra_INCLUDES)
#include_directories (${elektra_INCLUDES})
#
function (add_includes target)
# define the _INCLUDES properties if necessary
get_property (prop_defined GLOBAL PROPERTY ${target}_INCLUDES DEFINED)
if (NOT prop_defined)
define_property (GLOBAL PROPERTY ${target}_INCLUDES
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
endif (NOT prop_defined)
# create list of sources (absolute paths)
set (INCLUDES)
foreach (src ${ARGN})
list (APPEND INCLUDES "${src}")
endforeach (src ${ARGN})
# append to global property
set_property (GLOBAL APPEND PROPERTY "${target}_INCLUDES" "${INCLUDES}")
endfunction (add_includes)
#- Add libraries for a target
#
# ADD_LIBRARIES ( [ ...])
#
# The target should do:
#
#get_property (elektra_LIBRARIES GLOBAL PROPERTY elektra_LIBRARIES)
#target_link_libraries (elektra ${elektra_LIBRARIES})
#
function (add_libraries target)
# define the _LIBRARIES properties if necessary
get_property (prop_defined GLOBAL PROPERTY ${target}_LIBRARIES DEFINED)
if (NOT prop_defined)
define_property (GLOBAL PROPERTY ${target}_LIBRARIES
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
endif (NOT prop_defined)
# create list of sources (absolute paths)
set (LIBRARIES)
foreach (src ${ARGN})
list (APPEND LIBRARIES "${src}")
endforeach (src ${ARGN})
# append to global property
set_property (GLOBAL APPEND PROPERTY "${target}_LIBRARIES" "${LIBRARIES}")
endfunction (add_libraries)
#- Create a static library from sources collected by MY_ADD_LIBRARY
#
# MY_ADD_STATIC_MODULE()
#
# Compiles a static library from the sources defined in
# MY_STATIC_MODULES__SOURCES by MY_ADD_LIBRARY(). This
# function must be called after all calls to MY_ADD_LIBRARY()
# contributing sources to this static module.
#
#Thanks to Michael Wild
#
function(my_add_static_module name)
get_property(srcs GLOBAL PROPERTY
MY_STATIC_MODULES_${name}_SOURCES)
if (not SRCS)
message(SEND_ERROR "No sources defined for static module ${name}")
endif (not SRCS)
add_library(${name} STATIC ${srcs})
endfunction()
macro(remember_for_removal ELEMENTS TO_REMOVE_ELEMENTS)
set (MY_ELEMENTS ${${ELEMENTS}})
set (MY_REMOVE_ELEMENTS "")
foreach(B ${MY_ELEMENTS})
if(B MATCHES "^-.*")
## remove pseudo "-element"
list(REMOVE_ITEM MY_ELEMENTS ${B})
string(LENGTH ${B} B_LENGTH)
math(EXPR L ${B_LENGTH}-1)
string(SUBSTRING ${B} 1 ${L} B_OUT)
list(APPEND MY_REMOVE_ELEMENTS ${B_OUT})
endif()
endforeach(B)
set(${TO_REMOVE_ELEMENTS} ${MY_REMOVE_ELEMENTS})
set(${ELEMENTS} ${MY_ELEMENTS})
endmacro()
macro(removal ELEMENTS TO_REMOVE_ELEMENTS)
set(MY_ELEMENTS ${${ELEMENTS}})
list(REMOVE_DUPLICATES MY_ELEMENTS)
foreach(B ${${TO_REMOVE_ELEMENTS}})
list(REMOVE_ITEM MY_ELEMENTS ${B})
endforeach(B)
set(${ELEMENTS} ${MY_ELEMENTS})
endmacro()
function (generate_manpage NAME)
if (RONN_LOC) # disable function when RONN_LOC is not set
cmake_parse_arguments (ARG
"" # optional keywords
"SECTION;FILENAME" # one value keywords
"" # multi value keywords
${ARGN}
)
if (ARG_SECTION)
set(SECTION ${ARG_SECTION})
else ()
set(SECTION 1)
endif ()
if (ARG_FILENAME)
set(MDFILE ${ARG_FILENAME})
else ()
set(MDFILE ${CMAKE_CURRENT_SOURCE_DIR}/${NAME}.md)
endif ()
set(OUTFILE ${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${SECTION})
add_custom_command(
OUTPUT ${OUTFILE}
DEPENDS ${MDFILE}
COMMAND ${RONN_LOC}
ARGS -r --pipe ${MDFILE} > ${OUTFILE}
)
add_custom_target(man-${NAME} ALL DEPENDS ${OUTFILE})
add_dependencies(man man-${NAME})
if (INSTALL_DOCUMENTATION)
install(
FILES ${OUTFILE}
DESTINATION share/man/man${SECTION}
)
endif ()
endif (RONN_LOC)
endfunction ()
#
# Parameter: the pluginname
#
# converts a README.md (markdown texts with key/value pairs)
# to a readme_pluginname.c that contains keys to be added in the contract
#
# the key/value pairs need to be written like:
# - infos/licence = BSD
#
# - infos/description =
# has a special functionality: when it is used the rest of the file
# is interpreted as description. So this key must be last.
#
function (generate_readme p)
# rerun cmake when README.md is changed
# also allows cmake variable substitution
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/README.md ${CMAKE_CURRENT_BINARY_DIR}/README.out)
# read
FILE(READ ${CMAKE_CURRENT_BINARY_DIR}/README.out contents)
STRING(REGEX REPLACE "\\\\" "\\\\\\\\" contents "${contents}")
STRING(REGEX REPLACE "\"" "\\\\\"" contents "${contents}")
STRING(REGEX REPLACE "\n" "\\\\n\"\n\"" contents "${contents}")
STRING(REGEX REPLACE "- infos = ([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/licence *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/licence\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/author *= *([.@<>a-zA-Z0-9 %_-]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/author\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/provides *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/provides\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/placements *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/placements\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/recommends *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/recommends\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/ordering *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/ordering\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/stacking *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/stacking\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/needs *= *([a-zA-Z0-9 ]*)\\\\n\"" "keyNew(\"system/elektra/modules/${p}/infos/needs\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
STRING(REGEX REPLACE "\"- +infos/description *= *(.*)\\\\n\"\n\"" "keyNew(\"system/elektra/modules/${p}/infos/description\",\nKEY_VALUE, \"\\1\", KEY_END)," contents "${contents}")
# allow macros:
STRING(REGEX REPLACE "\" *#ifdef ([^\\]*)\\\\n\"" "#ifdef \\1" contents "${contents}")
STRING(REGEX REPLACE "\" *#endif\\\\n\"" "#endif" contents "${contents}")
FILE(WRITE ${CMAKE_CURRENT_BINARY_DIR}/readme_${p}.c "${contents}\n")
endfunction()
elektra-0.8.14/cmake/Modules/LibAddPlugin.cmake 0000664 0000000 0000000 00000005702 12623421622 0021227 0 ustar 00root root 0000000 0000000 include(LibAddMacros)
# add_plugin: add a plugin to Elektra
#
# SOURCES:
# The sources of the plugin
#
# SHARED_SOURCES:
# Will be added only once without any per-variant macros nor
# COMPILE_DEFINITIONS.
#
# LINK_LIBRARIES:
# add here only add libraries found by cmake
# do not add dependencies to Elektra
#
# COMPILE_DEFINITIONS:
# Set additional macros for per-variant compilation.
#
# INCLUDE_DIRECTORIES:
# Append to include path (globally+plugin specific).
function(add_plugin PLUGIN_SHORT_NAME)
cmake_parse_arguments (ARG
"CPP" # optional keywords
"" # one value keywords
"SOURCES;SHARED_SOURCES;LINK_LIBRARIES;COMPILE_DEFINITIONS;INCLUDE_DIRECTORIES" # multi value keywords
${ARGN}
)
set (PLUGIN_NAME elektra-${PLUGIN_SHORT_NAME})
set (PLUGIN_OBJS ${PLUGIN_NAME}-objects)
set (PLUGIN_TARGET_OBJS "$")
file(GLOB PLUGIN_SHARED_SOURCES ${ARG_SHARED_SOURCES})
#message (STATUS "name: ${PLUGIN_NAME}")
#message (STATUS "srcs are: ${ARG_SOURCES}")
#message (STATUS "deps are: ${ARG_LINK_LIBRARIES}")
#message (STATUS "comp are: ${ARG_COMPILE_DEFINITIONS}")
#message (STATUS "incl are: ${ARG_INCLUDE_DIRECTORIES}")
#message (STATUS "current bin ${CMAKE_CURRENT_BINARY_DIR}")
add_headers(ARG_SOURCES)
if (ARG_CPP)
add_cppheaders(ARG_SOURCES)
endif (ARG_CPP)
add_library (${PLUGIN_OBJS} OBJECT ${ARG_SOURCES})
add_dependencies(${PLUGIN_OBJS} readme_${PLUGIN_SHORT_NAME}.c)
generate_readme (${PLUGIN_SHORT_NAME})
set_property(TARGET ${PLUGIN_OBJS}
APPEND PROPERTY COMPILE_DEFINITIONS
${ARG_COMPILE_DEFINITIONS}
"ELEKTRA_STATIC"
"HAVE_KDBCONFIG_H"
"PLUGIN_SHORT_NAME=${PLUGIN_SHORT_NAME}"
"README=readme_${PLUGIN_SHORT_NAME}.c"
)
set_property(TARGET ${PLUGIN_OBJS}
APPEND PROPERTY INCLUDE_DIRECTORIES
${ARG_INCLUDE_DIRECTORIES}
${CMAKE_CURRENT_BINARY_DIR} #for readme
)
set_property(TARGET ${PLUGIN_OBJS}
APPEND PROPERTY COMPILE_FLAGS
${CMAKE_PIC_FLAGS} # needed for shared libraries
)
# needs cmake 3.0:
#set_property(TARGET ${PLUGIN_OBJS}
# PROPERTY CMAKE_POSITION_INDEPENDENT_CODE ON)
if (BUILD_SHARED)
add_library (${PLUGIN_NAME} MODULE ${ARG_SOURCES}
${PLUGIN_SHARED_SOURCES})
target_link_libraries (${PLUGIN_NAME} elektra)
target_link_libraries (${PLUGIN_NAME}
${ARG_LINK_LIBRARIES})
install (TARGETS ${PLUGIN_NAME} DESTINATION
lib${LIB_SUFFIX}/${TARGET_PLUGIN_FOLDER})
set_property(TARGET ${PLUGIN_NAME}
APPEND PROPERTY
COMPILE_DEFINITIONS
${ARG_COMPILE_DEFINITIONS}
"HAVE_KDBCONFIG_H"
"PLUGIN_SHORT_NAME=${PLUGIN_SHORT_NAME}"
"README=readme_${PLUGIN_SHORT_NAME}.c"
)
set_property(TARGET ${PLUGIN_NAME}
APPEND PROPERTY INCLUDE_DIRECTORIES
${ARG_INCLUDE_DIRECTORIES}
${CMAKE_CURRENT_BINARY_DIR} #for readme
)
endif()
set_property (GLOBAL APPEND PROPERTY "elektra-full_SRCS"
${PLUGIN_TARGET_OBJS}
${PLUGIN_SHARED_SOURCES}
)
set_property (GLOBAL APPEND PROPERTY "elektra-full_LIBRARIES"
"${ARG_LINK_LIBRARIES}"
)
endfunction()
elektra-0.8.14/cmake/Modules/LibAddTest.cmake 0000664 0000000 0000000 00000002357 12623421622 0020713 0 ustar 00root root 0000000 0000000 # Allows one to add test cases using Google Test
#
# recommended to use
#
# export GTEST_CATCH_EXCEPTIONS=0
#
# which disables a feature that seems to be popup-blocker for Windows
macro (add_gtest source)
cmake_parse_arguments (ARG
"MEMLEAK;NO_MAIN;NO_TOOLS" # optional keywords
"" # one value keywords
"" # multi value keywords
${ARGN}
)
if (BUILD_TESTING)
set (SOURCES ${HDR_FILES} ${source}.cpp)
add_executable (${source} ${SOURCES})
if (NOT ARG_NO_TOOLS)
# invert logic?
target_link_elektratools(${source})
endif (NOT ARG_NO_TOOLS)
target_link_libraries(${source} gtest)
if (NOT ARG_NO_MAIN)
target_link_libraries(${source} gtest_main)
endif (NOT ARG_NO_MAIN)
include_directories(SYSTEM ${GOOGLETEST_ROOT}/include)
include_directories(${CMAKE_SOURCE_DIR}/tests/gtest-framework)
if (INSTALL_TESTING)
install (TARGETS ${source}
DESTINATION ${TARGET_TOOL_EXEC_FOLDER})
endif (INSTALL_TESTING)
set_target_properties (${source} PROPERTIES
COMPILE_DEFINITIONS HAVE_KDBCONFIG_H)
add_test (${source}
"${CMAKE_BINARY_DIR}/bin/${source}"
"${CMAKE_CURRENT_BINARY_DIR}/"
)
endif(BUILD_TESTING)
if (ARG_MEMLEAK)
set_property(TEST ${source} PROPERTY
LABELS memleak)
endif (ARG_MEMLEAK)
endmacro (add_gtest)
elektra-0.8.14/cmake/Modules/LibFindMacros.cmake 0000664 0000000 0000000 00000006627 12623421622 0021414 0 ustar 00root root 0000000 0000000 # Works the same as find_package, but forwards the "REQUIRED" argument used for
# the current package and always uses the "QUIET" flag. For this to work, the
# first parameter must be the prefix of the current package, then the prefix of
# the new package etc, which are passed to find_package.
macro (libfind_package PREFIX)
set (LIBFIND_PACKAGE_ARGS ${ARGN} QUIET)
if (${PREFIX}_FIND_REQUIRED)
set (LIBFIND_PACKAGE_ARGS ${LIBFIND_PACKAGE_ARGS} REQUIRED)
endif (${PREFIX}_FIND_REQUIRED)
find_package(${LIBFIND_PACKAGE_ARGS})
endmacro (libfind_package)
# Damn CMake developers made the UsePkgConfig system deprecated in the same release (2.6)
# where they added pkg_check_modules. Consequently I need to support both in my scripts
# to avoid those deprecated warnings. Here's a helper that does just that.
# Works identically to pkg_check_modules, except that no checks are needed prior to use.
macro (libfind_pkg_check_modules PREFIX PKGNAME)
if (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
include(UsePkgConfig)
pkgconfig(${PKGNAME} ${PREFIX}_INCLUDE_DIRS ${PREFIX}_LIBRARY_DIRS ${PREFIX}_LDFLAGS ${PREFIX}_CFLAGS)
else (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
find_package(PkgConfig)
if (PKG_CONFIG_FOUND)
pkg_check_modules(${PREFIX} ${PKGNAME})
endif (PKG_CONFIG_FOUND)
endif (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
endmacro (libfind_pkg_check_modules)
# Do the final processing once the paths have been detected.
# If include dirs are needed, ${PREFIX}_PROCESS_INCLUDES should be set to contain
# all the variables, each of which contain one include directory.
# Ditto for ${PREFIX}_PROCESS_LIBS and library files.
# Will set ${PREFIX}_FOUND, ${PREFIX}_INCLUDE_DIRS and ${PREFIX}_LIBRARIES.
# Also handles errors in case library detection was required, etc.
macro (libfind_process PREFIX)
# Skip processing if already processed during this run
if (NOT ${PREFIX}_FOUND)
# Start with the assumption that the library was found
set (${PREFIX}_FOUND TRUE)
# Process all includes and set _FOUND to false if any are missing
foreach (i ${${PREFIX}_PROCESS_INCLUDES})
if (${i})
set (${PREFIX}_INCLUDE_DIRS ${${PREFIX}_INCLUDE_DIRS} ${${i}})
mark_as_advanced(${i})
else (${i})
set (${PREFIX}_FOUND FALSE)
endif (${i})
endforeach (i)
# Process all libraries and set _FOUND to false if any are missing
foreach (i ${${PREFIX}_PROCESS_LIBS})
if (${i})
set (${PREFIX}_LIBRARIES ${${PREFIX}_LIBRARIES} ${${i}})
mark_as_advanced(${i})
else (${i})
set (${PREFIX}_FOUND FALSE)
endif (${i})
endforeach (i)
# Print message and/or exit on fatal error
if (${PREFIX}_FOUND)
if (NOT ${PREFIX}_FIND_QUIETLY)
message (STATUS "Found ${PREFIX} ${${PREFIX}_VERSION}")
endif (NOT ${PREFIX}_FIND_QUIETLY)
else (${PREFIX}_FOUND)
if (${PREFIX}_FIND_REQUIRED)
foreach (i ${${PREFIX}_PROCESS_INCLUDES} ${${PREFIX}_PROCESS_LIBS})
message("${i}=${${i}}")
endforeach (i)
message (FATAL_ERROR "Required library ${PREFIX} NOT FOUND.\nInstall the library (dev version) and try again. If the library is already installed, use ccmake to set the missing variables manually.")
endif (${PREFIX}_FIND_REQUIRED)
endif (${PREFIX}_FOUND)
endif (NOT ${PREFIX}_FOUND)
endmacro (libfind_process)
elektra-0.8.14/cmake/Platform.cmake 0000664 0000000 0000000 00000000065 12623421622 0017102 0 ustar 00root root 0000000 0000000 # this file overrides platform specific information
elektra-0.8.14/cmake/TestScript.cmake 0000664 0000000 0000000 00000000452 12623421622 0017422 0 ustar 00root root 0000000 0000000 set (CTEST_SOURCE_DIRECTORY /home/markus/Projekte/Elektra/current)
set (CTEST_BINARY_DIRECTORY /home/markus/Projekte/Elektra/current/build)
set (CTEST_COMMAND ctest)
set ($ENV{srcdir} /home/markus/Projekte/Elektra/current/build/tests)
set (MemoryCheckCommand /usr/bin/valgrind)
ctest_memcheck ()
elektra-0.8.14/cmake/Toolchain/ 0000775 0000000 0000000 00000000000 12623421622 0016233 5 ustar 00root root 0000000 0000000 elektra-0.8.14/cmake/Toolchain/Toolchain-mingw-w64-x86_64.cmake 0000664 0000000 0000000 00000001345 12623421622 0023651 0 ustar 00root root 0000000 0000000 # the name of the target operating system
SET(CMAKE_SYSTEM_NAME Windows)
# which compilers to use for C and C++
SET(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc-posix)
SET(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++-posix)
SET(CMAKE_RC_COMPILER x86_64-w64-mingw32-windres)
# link libraries statically. wine is unable to find them
SET(CMAKE_SHARED_LINKER_FLAGS "-static" CACHE STRING "" FORCE)
SET(CMAKE_EXE_LINKER_FLAGS "-static" CACHE STRING "" FORCE)
# adjust the default behaviour of the FIND_XXX() commands:
# search headers and libraries in the target environment, search
# programs in the host environment
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
elektra-0.8.14/cmake/Toolchain/Toolchain-mingw32.cmake 0000664 0000000 0000000 00000001037 12623421622 0022442 0 ustar 00root root 0000000 0000000 # the name of the target operating system
SET(CMAKE_SYSTEM_NAME Windows)
# which compilers to use for C and C++
SET(CMAKE_C_COMPILER i586-mingw32msvc-gcc)
SET(CMAKE_CXX_COMPILER i586-mingw32msvc-g++)
SET(CMAKE_RC_COMPILER i586-mingw32msvc-windres)
# adjust the default behaviour of the FIND_XXX() commands:
# search headers and libraries in the target environment, search
# programs in the host environment
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
elektra-0.8.14/cmake/elektra.pc.in 0000664 0000000 0000000 00000000664 12623421622 0016701 0 ustar 00root root 0000000 0000000 prefix=@CMAKE_INSTALL_PREFIX@
exec_prefix=${prefix}/bin
libdir=${prefix}/lib@LIB_SUFFIX@
includedir=${prefix}/include/@TARGET_INCLUDE_FOLDER@
plugindir=${prefix}/lib@LIB_SUFFIX@/@TARGET_PLUGIN_FOLDER@
tool_execdir=${prefix}/@TARGET_TOOL_EXEC_FOLDER@
templatedir=${prefix}/@TARGET_TEMPLATE_FOLDER@
Name: @PACKAGE_NAME@
Description: @PACKAGE_DESCRIPTION@
Version: @KDB_VERSION@
Libs: -L${libdir} -l@PACKAGE_NAME@
Cflags: -I${includedir}
elektra-0.8.14/configure 0000775 0000000 0000000 00000004661 12623421622 0015151 0 ustar 00root root 0000000 0000000 #!/bin/sh
# Internal variables.
alnum=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
CMAKEFLAGS=
srcdir=".."
builddir="build"
# Get command line options. We use getopt to "break them down into nice, digestible particles".
set -- `getopt -u -l "all,srcdir:,builddir:,prefix:,eprefix:,bindir:,sbindir:,libexecdir:,sysconfdir:,libdir:,includedir:,oldincludedir:,datarootdir:,datadir:,infodir:,localedir:,mandir:,docdir:,htmldir:,dvidir:,pdfdir:,psdir:,quiet,silent,version,help,run" hVqn "$@"`
test $# -lt 1 && exit 1
while test $# -gt 0
do
case "$1" in
-h|--help) break;;
-V|--version) cmake --version; exit;;
--builddir) builddir="$2"; shift;;
--srcdir) srcdir="$2"; shift;;
--prefix) prefix="$2"; shift;;
--bindir) bindir="$2"; shift;;
--libdir) libdir="$2"; shift;;
--includedir) includedir="$2"; shift;;
--all) all="y";;
--) shift; break;;
esac
shift
done
# Set up CMake flags.
# Set prefix
if test -n "$prefix"; then
CMAKEFLAGS="$CMAKEFLAGS -DCMAKE_INSTALL_PREFIX:PATH=$prefix"
fi
# Set bindir.
if test -n "$bindir"; then
CMAKEFLAGS="$CMAKEFLAGS -DBIN_INSTALL_DIR:PATH=$bindir"
fi
# Set libdir.
if test -n "$libdir"; then
CMAKEFLAGS="$CMAKEFLAGS -DLIB_INSTALL_DIR:PATH=$libdir"
fi
# Set includedir.
if test -n "$includedir"; then
CMAKEFLAGS="$CMAKEFLAGS -DINCLUDE_INSTALL_DIR:PATH=$includedir"
fi
if test -n "$all"; then
CMAKEFLAGS="$CMAKEFLAGS "
fi
# print info.
echo ""
echo "Elektra uses the CMake (http://www.cmake.org) buildsystem instead of configure."
echo "CMake uses different options than configure, but some have direct equivalents:"
echo " --srcdir= : the top level source directory"
echo " --builddir= : the directory where Elektra is build"
echo " --prefix= : -DCMAKE_INSTALL_PREFIX:PATH="
echo " --bindir= : -DBIN_INSTALL_DIR:PATH="
echo " --includedir= : -DINCLUDE_INSTALL_DIR:PATH="
echo " --libdir= : -DLIB_INSTALL_DIR:PATH="
echo "Once CMake has run successfully, you can use \"make edit_cache\" to view and modify all settings."
echo ""
echo "To configure all parts on a debian system, see scripts/configure-debian"
echo ""
echo "Your current configure options translate more or less to:"
echo " mkdir -p $builddir; cd $builddir; cmake$CMAKEFLAGS $srcdir"
echo ""
echo "After configuration, you have to issue following command in $builddir"
echo " make -j5; make install"
elektra-0.8.14/doc/ 0000775 0000000 0000000 00000000000 12623421622 0014000 5 ustar 00root root 0000000 0000000 elektra-0.8.14/doc/API.md 0000664 0000000 0000000 00000015410 12623421622 0014734 0 ustar 00root root 0000000 0000000 ## Elektra Initiative Overview ##
Elektra provides a universal and secure framework to store configuration
parameters in a global, hierarchical key database. The core is a small
library implemented in C. The plugin-based framework fulfills many
configuration-related tasks to avoid any unnecessary code duplication
across applications while it still allows the core to stay without any
external dependency. Elektra abstracts from cross-platform-related issues
with an consistent API, and allows applications to be aware of other
applications' configurations, leveraging easy application integration.
See the Readme for more information [Readme](/README.md).
See the [glossary](/doc/help/elektra-glossary.md) for the used
terminology.
## API docu ##
This document occupies with the API implementation, documentation,
internals and plugins.
On the one hand it gives an overview and an introduction for
developers using Elektra, on the
other hand it gives an informal descriptions what methods must and may provide
to allow an alternative implementation of the API.
The current version (for stable releases) of this document can be found at
http://doc.libelektra.org/api/current/html
The latest version (from git master) of this document can be found at
http://doc.libelektra.org/api/latest/html
## Using the Elektra Library ##
A C or C++ source file that wants to use Elektra should include:
#include
To link an executable with the Elektra library, one way is to
use the @c pkg-config tool:
$ gcc -o application `pkg-config --cflags --libs elektra` application.c
Another way is to use CMake:
find_package(Elektra REQUIRED)
include_directories (${ELEKTRA_INCLUDE_DIR})
target_link_libraries (application ${ELEKTRA_LIBRARIES})
Read about [compiling elektra](/doc/COMPILE.md).
### Tutorials ###
* [Application Integration](/doc/tutorials/application-integration.md)
* [Compilation Variants](/doc/tutorials/compilation-variants.md)
* [Merge Integration](/doc/tutorials/elektra-merge-integration.md)
* [Export](/doc/tutorials/export.md)
* [Import](/doc/tutorials/import.md)
* [Merge](/doc/tutorials/merge.md)
* [Namespaces](/doc/tutorials/namespaces.md)
* [Plugins](/doc/tutorials/plugins.md)
[List of all available Plugins](/src/plugins/)
## Elektra API ##
The API was written in pure C because Elektra was designed to be useful
even for the most basic system programs.
The API follows an object-oriented design, and there are 3 main classes
as shown by the figure:
Some general things you can do with each class are:
[KDB (Key Database)](@ref kdb)
- [Open](@ref kdbOpen) and [Close](@ref kdbClose) the Key Database
- [Get](@ref kdbGet) and [Set](@ref kdbSet)
[KeySet](@ref keyset) in the Key Database
- See [class documentation](@ref kdb) for more
[Key](@ref key)
- [Create](@ref keyNew) and [Delete](@ref keyDel)
- Get and Set key the [name](@ref keySetName)
- Get and Set [string](@ref keySetString) or [binary](@ref keySetBinary) values
- Get and Set [Meta Data](@ref keymeta)
- See [class documentation](@ref key) for more
[KeySet](@ref keyset)
- [Create](@ref ksNew) and [Delete](@ref ksDel)
- Append [a single key](@ref ksAppendKey) or an
entire [KeySet](@ref ksAppend)
- [Work with](@ref ksNext) its [internal cursor](@ref ksCurrent)
- See [class documentation](@ref keyset) for more
[More background information about the classes](/doc/help/elektra-classes.md)
## Namespaces ##
There are 5 trees (=namespaces) of keys: `spec`, `proc`, `dir`, `user` and `system`
that are all unified (in the given order) in one cascading tree starting with `/`.
The cascading tree is the logical tree to be used in applications.
The other trees are the physical ones that stem from configuration sources.
When using cascading key the best key will be searched at runtime,
which appears like a tree on its own.
See @ref cascading in the documentation of ksLookupByName() how the selection
of keys works.
- The `spec` tree\n
This tree specifies how the lookup should take place and also allows us to
define defaults or document a key.
The metadata of a key contains this information:
+ `override/#`: use these keys *in favour* of the key itself (note that
`#` is the syntax for arrays, e.g. `#0` for the first element,
`#10` for the 11th and so on)
+ `namespace/#`: instead of using all namespaces in the predefined order,
one can specify which namespaces should be searched in which order
+ `fallback/#`: when no key was found in any of the (specified) namespaces
the `fallback`-keys will be searched
+ `default`: this value will be used if nothing else was found
- The `proc` tree\n
Is the only read-only tree. The configuration does not stem from the
[KDB (Key Database)](@ref kdb), but any other source, e.g. command-line arguments or environment.
- The `dir` tree\n
Allows us to have a per-directory overwrite of configuration files, e.g.
for project specific settings.
- The `user` tree \n
Used to store user-specific configurations, like the personal settings
of a user to certain programs. The user subtree will always be favoured
if present (except for security concerns the user subtree may not be considered).
- The `system` tree\n
It is provided to store system-wide configuration keys, that is,
the last fallback for applications but the only resort for
daemons and system services.
Read more about [namespaces](/doc/help/elektra-namespaces.md)
and a tutorial for [namespaces](/doc/tutorials/namespaces.md).
## Rules for Key Names ##
When using Elektra to store your application's configuration and state,
please keep in mind the following rules:
- You are not allowed to create keys right under the root.
They are reserved for more generic purposes.
- The keys for your application, called say *myapp*, should be created under
`@p /sw/org/myapp/#0/current`
+ sw is for software
+ org is the organisation. For uniqueness a full reverse url encoded with '/' instead of '.' is useful.
+ `#0` is the major version of the configuration
+ current is the default configuration profile.
+ That means you just need to kdbGet() `/sw/org/myapp/#0/profile`
and then ksLookupByName() in `/sw/org/myapp/#0/profile/key` where
profile is from command-line arguments and defaults to current.
Read more about [key names](/doc/help/elektra-key-names.md)
## Backend Overview ##
The core of Elektra does not store configuration itself to the
harddisk. Instead this work is delegated to backends.
If you want to develop a backend, you should already have some experience
with Elektra from the user point of view. You should be familiar with
the data structures: [Key](@ref key) and [KeySet](@ref keyset)
Then you can start reading about Backends that are composed out of
[Plugin](@ref plugin).
To get started with writing plugins, first read our plugin tutorial in doc/tutorials!
Read more about [mounting](/doc/help/elektra-mounting.md)
elektra-0.8.14/doc/AUTHORS 0000664 0000000 0000000 00000003236 12623421622 0015054 0 ustar 00root root 0000000 0000000 The list of authors that contributed to Elektra.
Markus Raab
maintainer, main development, documentation
Devel/Test on: Debian
Manuel Mausz
bindings, swig, gobject, main development
Devel/Test on: Fedora
Felix Berlakovich
journald plugin, augeas plugin, keytometa, main development
Devel/Test on: Debian Wheezy
Pino Toscano
Debian Packaging, Documentation
Devel/Test on: Debian
Kai-Uwe Behrmann
Test/Packaging on: CentOS, Fedora, OpenSUSE, RHEL and SLE
Christopher Meng
Fedora packaging
Test on: Fedora
Ian S. Donnelly
Google Summer of Code 2014
Devel/Test on: Debian Stable
Charles Lindsay
ni library
Avi Alkalay
Initial concept, previous website
Backends: fstab
Yannick Lecaillez
previous Mandriva packaging
Jens Andersen
bug fixing
Patrick Sabin
trie development, previous python bindings
Studio-HB
Elektra logo, design of previous website
Pier Luigi Fiorini
pkg-config file
Rèmi
XML schema
Andreas Rottmann
previous Debian packaging and 0.7 scheme bindings
Simon Law
previous Debian Packaging
Daniel Bugl
documentation, new README.md, zeromq, web ui
Kurt Micheli
Optimizing ksLookup with order preserving minimal perfect hash map, markdown link converter for doxygen
Alexander Rössler
improvements to the dbus plugin
elektra-0.8.14/doc/CMakeLists.txt 0000664 0000000 0000000 00000005576 12623421622 0016555 0 ustar 00root root 0000000 0000000 find_package(Doxygen)
# do_doc
#
#builds and install documentation
#
#target is man, html or latex
#folder is the folder where it will be built
#file is the file name to set a depencency to
#install is where it should be installed
#
macro (do_doc target folder file install)
# sometimes doxygen is too slow and fails with "Could not create output directory .../doc/html"
file(MAKE_DIRECTORY(${folder}))
add_custom_command (
OUTPUT ${folder}/${file}
COMMAND ${DOXYGEN_EXECUTABLE}
ARGS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile markdownlinkconverter
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)
#get_filename_component (name ${target} NAME_WE)
add_custom_target (${target} ALL
DEPENDS ${folder}/${file}
)
if (INSTALL_DOCUMENTATION)
install (
DIRECTORY ${folder}
DESTINATION ${install}
)
endif (INSTALL_DOCUMENTATION)
endmacro (do_doc)
if (DOXYGEN_FOUND)
set (OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
if (BUILD_PDF)
find_package(LATEX)
if (LATEX_COMPILER)
set (WITH_LATEX YES)
else (LATEX_COMPILER)
set (WITH_LATEX NO)
message (WARNING "Latex not found, PDF Manual can't be created.")
endif (LATEX_COMPILER)
else (BUILD_PDF)
set (WITH_LATEX NO)
endif (BUILD_PDF)
if (DOXYGEN_DOT_FOUND)
set (WITH_DOT YES)
else (DOXYGEN_DOT_FOUND)
set (WITH_DOT NO)
endif (DOXYGEN_DOT_FOUND)
find_package(Perl)
add_executable (markdownlinkconverter markdownlinkconverter/markdownlinkconverter.c)
# fix usage with wine
# https://github.com/ElektraInitiative/libelektra/pull/340#discussion_r44044444
find_util (markdownlinkconverter MARKDOWN_LINK_CONVERTER "")
configure_file (
"${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile"
"${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
@ONLY
)
do_doc(html ${OUTPUT_DIRECTORY}/html/ index.html
${TARGET_DOCUMENTATION_HTML_FOLDER})
do_doc(man3 ${OUTPUT_DIRECTORY}/man/man3elektra/ kdb.3elektra
"${TARGET_DOCUMENTATION_MAN_FOLDER};PATTERN;_*;EXCLUDE")
if (WITH_LATEX)
do_doc(latex ${OUTPUT_DIRECTORY}/latex/ refman.tex
${TARGET_DOCUMENTATION_LATEX_FOLDER})
file (COPY "${CMAKE_CURRENT_SOURCE_DIR}/markdownlinkconverter/elektraSpecialCharacters.sty"
DESTINATION "${OUTPUT_DIRECTORY}/latex/")
add_custom_command (
OUTPUT ${OUTPUT_DIRECTORY}/latex/refman.pdf
COMMAND ${PDFLATEX_COMPILER} ARGS ${OUTPUT_DIRECTORY}/latex/refman.tex
COMMAND ${PDFLATEX_COMPILER} ARGS ${OUTPUT_DIRECTORY}/latex/refman.tex
COMMAND ${PDFLATEX_COMPILER} ARGS ${OUTPUT_DIRECTORY}/latex/refman.tex
DEPENDS ${OUTPUT_DIRECTORY}/latex/refman.tex markdownlinkconverter
WORKING_DIRECTORY ${OUTPUT_DIRECTORY}/latex/
)
add_custom_target (pdf ALL
DEPENDS ${OUTPUT_DIRECTORY}/latex/refman.pdf
)
endif (WITH_LATEX)
else (DOXYGEN_FOUND)
message (WARNING "Doxygen not found, Reference Manual can't be created even though requested with BUILD_DOCUMENTATION.")
endif (DOXYGEN_FOUND)
add_subdirectory(help)
elektra-0.8.14/doc/CODING.md 0000664 0000000 0000000 00000011321 12623421622 0015263 0 ustar 00root root 0000000 0000000 # CODING #
This document provides an introduction in how the source code of
libelektra is organized and how and where to add functionality.
Make sure to read [DESIGN](DESIGN.md) together with this document.
## Folder structure ##
After you downloaded and unpacked Elektra you see untypically many
folders. The reason is that Elektra project consists of many activities.
The most important are:
* **src:** Here is the source for the library and the tools itself.
* **doc:** Documentation for the library.
* **example:** Examples of using the library.
* **tests:** Is the testing framework for the source.
## Source Code ##
libelektra is the ANSI/ISO C-Core which does interacts between the user
and the plugins.
The plugins have all kinds of dependencies. It is the responsibility of
the plugins to find and check them using CMake. The same guidelines
apply for all code in the repository including the plugins.
`libloader` is responsible for loading the backend modules. It works for
various operating systems by using `libltdl`, but has an optimized code
for static linking and win32.
kdb is the commandline-tool to access and initialize the Elektra database.
### General Guidelines ###
It is only allowed to break a guideline if there is a good reason
for it. When doing so, document the fact either in the commit message,
or as comment next to the code.
Of course all rules of good software engineering apply, like to
use good names, make software testable and reusable.
The purpose of the guidelines is to have a consistent
style, not to teach programming.
If you see broken guidelines do not hesitate to fix them. At least put a
TODO marker to make the places visible.
If you see inconsistency do not hesitate to talk about it with the
intent to add a new rule here.
See [DESIGN](DESIGN.md) document too, they complement each other.
### C Guidelines ###
* Functions should not exceed 100 lines.
* Files should not exceed 1000 lines.
* A line should not be longer then 72 characters.
* Split up when those limits are reached.
* Rationale: Readability with split windows.
* The compiler shall not emit any warning (or error).
* Use tabs for indentation.
* Prefer to use blocks to single line statements.
* Curly braces go on a line on their own on the previous indentation level
* Use goto only for error situations.
* Use camelCase for functions and variables.
* Start types with upper-case, everything else with lower-case.
* Avoid spaces between words and round braces.
* Use C-comments `/**/` with doxygen style for functions.
* Use C++-comments `//` for single line statements about the code in the
next line.
* Avoid multiple variable declarations at one place and `*` are next to the
variable names.
* Use `const` as much as possible.
* Use `static` methods if they should not be externally visible.
* Declare Variables as late as possible, preferable within blocks.
* C-Files have extension `.c`, Header files `.h`.
* Prefix names with `elektra` for internal usage. External API either starts
with `ks`, `key` or `kdb`.
**Example:** [src/libelektra/kdb.c](../src/libelektra/kdb.c)
### C++ Guidelines ###
* Everything as in C if not noted otherwise.
* Do not use goto at all, use RAII instead.
* Do not use raw pointers, use smart pointers instead.
* C++-Files have extension `.cpp`, Header files `.hpp`.
* Do not use `static`, but anonymous namespaces.
* Write everything within namespaces and do not prefix names.
**Example:** [src/bindings/cpp/include/kdb.hpp](http://libelektra.org/tree/master/src/bindings/cpp/include/kdb.hpp)
### Doxygen Guidelines ###
`doxygen` is used to document the API and to build the html and pdf output.
We support also the import of markdown pages, but a minimum version of 1.8.8
of Doxygen is required for this feature (Anyways you can find the
[API Doc](http://doc.libelektra.org/api/latest/html/) online).
Links between markdown files will be converted with the
[Markdown Link Converter](markdownlinkconverter/README.md).
**Markdown pages are used in the pdf, therefore watch your characters and
provide a proper encoding!**
* use `@` to start doxygen tags
* Do not duplicate information available in git in doxygen.
* Use `@copydoc`, `@copybrief` and `@copydetails` intensively (except for file header).
### File Headers ###
Files should start with:
\verbatim
/**
* @file
*
* @brief
*
* @copyright BSD License (see doc/COPYING or http://www.libelektra.org)
*/
\endverbatim
Note:
- `@file` has *no* parameters.
- `@brief` is optional and should contain a short statement about the content of the file.
The duplication of the filename, author and date is not needed, because
this information is tracked using git and doc/AUTHORS already.
elektra-0.8.14/doc/COMPILE.md 0000664 0000000 0000000 00000023544 12623421622 0015422 0 ustar 00root root 0000000 0000000 # COMPILE #
## DEPENDENCIES ##
For the base system you only need cmake and build-essential (make, gcc,
some unix tools).
To build documentation you need doxygen and graphviz.
To build pdf documentation you need pdflatex with
texlive-fonts-recommended
texlive-latex-recommended
For the debian package, please refer to debian/control (in the debian
branch).
For the plugins, please refer to the README.md of the respective
plugin.
## PREPARATION ##
Elektra is using cmake.
Tested are cmake version 2.8.9 and version 3.0.2.
To configure Elektra graphically (with curses) run (.. belongs to command):
mkdir build && cd build && ccmake ..
and press 'c':
All options described here, can also be used with cmake rather then
ccmake (.. belongs to the command!):
mkdir build && cd build && cmake -D= -D= ..
For information what you can use as OPTION1 and OPTION2 see above.
Note to pass "" to VAR if it contains ;.
E.g.:
cmake -DPLUGINS="dump;resolver;yajl" ..
Some scripts in the folder of the same name may help you running cmake.
### COMPILERS ###
For supported compilers see the automatic build farm on
http://build.libelektra.org:8080/
Additional gcc 4.6 armhf is tested regularly.
| Compiler | Version | Target |
|-------------------|-----------------------------|-------------------|
| gcc | gcc (Debian 4.7.2-5) 4.7.2 | i386 |
| gcc | gcc (Debian 4.7.2-5) 4.7.2 | amd64 |
| gcc | gcc 4.8 | amd64 |
| gcc | gcc 4.9 | amd64 |
| gcc | (Debian 4.4.5-8) 4.4.5 | amd64 |
| gcc | (Debian 4.4.5-8) 4.3 | amd64 |
| gcc | 4.6 | armhf |
| mingw | 4.6 | i386 |
| clang | version 3.5.0-1~exp1 |x86_64-pc-linux-gnu|
| icc | 14.0.2 20140120 |x86_64-pc-linux-gnu|
To change the compiler, use
CMAKE_C_COMPILER and CMAKE_CXX_COMPILER.
for example to use gcc-4.3
cmake -DCMAKE_C_COMPILER=gcc-4.3 -DCMAKE_CXX_COMPILER=g++-4.3 ..
### OPTIONS ###
Some options, i.e. PLUGINS, BINDINGS and TOOLS are either:
- a list of elements separated with ;
(note that shells typically need ; to be escaped)
- a special uppercase element that gets replaced by a list of elements, that are:
- ALL to include all elements (except elements with unfulfilled dependencies)
- NODEP to include all elements without dependencies
- DEFAULT to go back to the situation that was there when nothing was changed
- elements prefixed with a minus symbol (-) to exclude an element
Examples for this are especially in the subsection PLUGINS below, but they work in the
same fashion for BINDINGS and TOOLS.
#### PLUGINS ####
Read about available plugins [here](/src/plugins/).
Because the core of elektra is minimal, plugins are needed to
actually read and write to configuration files (storage plugins),
commit the changes (resolver plugin, also takes care about how
the configuration files are named) and also do many other
tasks related to configuration.
The default is also the minimal set of plugins you should add:
- dump is the default storage.
If you remove it, make sure you add another one and set
`KDB_DEFAULT_STORAGE` to it.
- resolver is the default resolver.
If you remove it, make sure you add another one and set
`KDB_DEFAULT_RESOLVER` to it.
- sync is very useful to not lose any data.
If you do not want to include it, make sure to set
`/sw/kdb/current/plugins` to a value not containing sync.
See [kdb-mount(1)](/doc/help/kdb-mount.md).
To add all plugins, you can use:
-DPLUGINS=ALL
Note that plugins get dropped when dependencies are not satisfied.
To add all plugins except some plugins you can use:
-DPLUGINS="ALL;-plugin1;-plugin2"
E.g. if you want all plugins except the jni plugin you would use:
-DPLUGINS="ALL;-jni"
To add all plugins not having additional dependencies
(they need only POSIX), you can use
-DPLUGINS=NODEP
To manually set the default (same as not setting PLUGINS), you can use
-DPLUGINS=DEFAULT
This only states the list of the plugins are the default list and does
not mean that a different default is used after Elektra was installed.
For this endeavour you need to change:
-DKDB_DEFAULT_RESOLVER=resolver
and
-DKDB_DEFAULT_STORAGE=dump
Alternatively, you can pass the list of plugins you want, e.g.:
-DPLUGINS="resolver;sync;dump"
Some plugins are compile-time configureable. Then you can choose which
features are compiled in or out. This is especially important in the
bootstrapping phase, because then only the compiled in configuration
applies. To compile-time-configure a plugin, you just pass a underscore
(_) and flags after the name of the plugin.
Note that the base-plugin itself need to be part of PLUGINS, so that the
variants will work.
The resolver even distinguish between 3 different kind of flags:
-DPLUGINS="resolver_baseflags_userflags_systemflags"
Following baseflags are available:
- 'c' for debugging conflicts
- 'l' for enabling file locking
- 'm' for enabling mutex locking
The user flags are (the order matters!):
- 'p' use passwd/ldap to lookup home directory using getpwuid_r
- 'h' use the environment variable HOME
- 'u' use the environment variable USER
- 'b' use the built-in default CMAKE variable KDB_DB_HOME
The system flags are (the order matters!):
- if a path that begins with / is chosen the system flags are irrelevant
and the path is taken as-is.
- 'x' use the environment variable XDG_CONFIG_DIRS
(: are interpreted as part of filename, no searching is done!)
This option is not recommended (unless for testing), because it
allows users to fake system configuration.
- 'b' use the built-in default CMAKE variable KDB_DB_SYSTEM
E.g. one may use:
-DPLUGINS="resolver;resolver_lm_uhpb_b"
#### TOOLS ####
Tools are used to add extra functionality to Elektra.
The flag used to specify which tools are compiled is
`-DTOOLS`, thus flag works similarly to the `-DPLUGINS` flag.
To add all tools, you can use::
-DTOOLS=ALL
To add all plugins not having additional dependencies
(they need only POSIX), you can use:
-DTOOLS=NODEP
To build only the default tools, you can use:
-DTOOLS=DEFAULT
To specify specific tools you can use, e.g.:
-DTOOLS=qt-gui;kdb
#### BINDINGS ####
Bindings are used in the same way as PLUGINS and TOOLS.
For example you can use:
-DBINDINGS=ALL
Note that the same languages are sometimes available over GI and SWIG.
In this case, the SWIG bindings are preferred.
To add all swig bindings (and also cpp), you can use:
-DBINDINGS=SWIG;cpp
The SWIG executable my be specified with:
-DSWIG_EXECUTABLE=...
If this option is not used, cmake will find the first occurrence of
``swig`` in your environment's path.
#### CMAKE_BUILD_TYPE ####
Debug, Release or RelWithDebInfo
See help bar at bottom of ccmake for that option or:
http://www.cmake.org/Wiki/CMake_Useful_Variables
#### ELEKTRA_DEBUG_BUILD and ELEKTRA_VERBOSE_BUILD ####
Only needed by Elektra developers.
Make the library to output logging information.
It is not recommended to use these options.
#### BUILD_DOCUMENTATION ####
build documentation with doxygen the kdb tool does only have the integrated docu at the moment
#### CMAKE_INSTALL_PREFIX ####
By default all files will installed below /usr/local.
Edit that cache entry to change that behaviour.
Also called system prefix within the documentation.
If you want to create a package afterwards it is ok to use
pathes that you can write to (e.g. CMAKE_INSTALL_PREFIX /home/markus/bin)
#### LIB_SUFFIX ####
Lets you install libraries into architecture specific folder.
E.g. for 32/64 bit systems you might install libraries under
lib64. Set LIB_SUFFIX to 64 to achieve exactly that.
So the system library folder will be CMAKE_INSTALL_PREFIX/lib64
then.
#### TARGET_INCLUDE_FOLDER ####
By default include folders will be installed below
CMAKE_INSTALL_PREFIX/include/elektra
This entry let you change the elektra.
If the entry is empty, the include files will be
installed directly to CMAKE_INSTALL_PREFIX/include.
#### TARGET_PLUGIN_FOLDER ####
Similar to above, but with the plugins. Default is:
CMAKE_INSTALL_PREFIX/lib${LIB_SUFFIX}/elektra
It can be also left empty to install plugins next
to other libraries.
#### GTEST_ROOT ####
Specifies the root of the GoogleTest sources, to be used
for some of the tests. A CMakeLists.txt inside GTEST_ROOT
will be searched as way to detect a valid GoogleTest source
directory.
If it is "", an internal version of gtest will be used.
It is recommended that you browse through all of the options.
Afterwards press c again (maybe multiple times until all variables are
resolved) and then g to generate. Finally press e to exit.
## BUILDING ##
### NO IDE ###
To build the source use:
make
You can pass:
-j for parallel builds
VERBOSE=1 to see the invocations of the compiler
### CodeBlocks ###
You can build Elektra using Code::Blocks under Gentoo:
Precondition:
Make sure you have a compiler, xml2 (for kdb tool) and xsl (see later)
installed. cmake configure will help you with that, it will make sure you don't forget something
essential.
For Most Linux system all you have to do is open up a console and
mkdir build
cd build
cmake .. -G 'CodeBlocks - Unix Makefiles'
make package
Note 1:
You can use other editor if you like just type cmake at the
console to get a list of option you can pass to cmake as long as well
as a list of what code editor project cmake can create.
Note 2:
For Unix if you have nCurses install you can run ccmake to set important option after
running cmake like to enable debug symbol.
Note 3:
for Gentoo is recommend to emerge sys-apps/lsb-release to name the package
right even thou not required.
elektra-0.8.14/doc/CONTRACT.ini 0000664 0000000 0000000 00000021366 12623421622 0015726 0 ustar 00root root 0000000 0000000 [system/elektra/modules]
type = null
status = implemented
version = 1.0.0
description = This part of the hierarchy specifies the semantics of a
contract. Each key is a clause of the contract.
Whenever this file is changed, following files need to be adapted:
- src/libtools/src/plugin.cpp (validator of this specification)
- src/libtools/src/plugins.cpp (placements)
- cmake/Modules/LibAddMacros.cmake (for README.md conversion)
Use "kdb check" to validate.
In doubt this specification overrules other specifications.
It is allowed to export additional keys (below the plugins module
name). They might, however, someday conflict with the specification
here. So prefer to prefix plugin specific clauses.
[system/elektra/modules/_]
type = null
status = implemented
description = Indicates that the module exists.
[system/elektra/modules/_/exports]
type = null
status = implemented
description = Indicate that symbols are exported.
[system/elektra/modules/_/exports/_]
type = func
status = implemented
description = Allows a plugin to export any functions.
Typical names are get, set, error, open or close.
A plugin can export symbols for external use. Users of
the library can look for these symbols and get a pointer to a function.
Other plugins, however, are not supposed to use these symbols.
checkfile can be used for resolvers.
The name of the symbols can be any valid
C name. It contains a function pointer as value to enable applications to call
the function. Given the plugin and symbol's name the function pointer
can be accessed by a unique locator in the global key database.
The usage of such functions will couple plugins or applications
tightly, so avoid them if possible.
[system/elektra/modules/_/constants]
type = null
status = implemented
description = Indicate that constants are available.
[system/elektra/modules/_/constants/_]
type = string
status = implemented
description = Exports constants that might be interesting for users,
applications or other plugins.
All plugin specific compilation information (e.g. verbosity, pathes)
should be exported as constants.
[system/elektra/modules/_/infos]
type = string
status = implemented
description = Indicate that info is available.
These clauses are required so that plugins can be mounted.
[system/elektra/modules/_/infos/author]
type = string
status = implemented
description = The name and e-mail address of the author of the plugin.
It blames the person responsible for the plugin.
The plugin must behave as described in the contract.
This clause should contain an e-mail address so that direct contact is possible.
If you want, you can get an @libelektra.org e-mail address.
[system/elektra/modules/_/infos/licence]
type = string
status = implemented
example = BSD
description = The licence relevant for the user of the plugin.
For plugins published with Elektra it is "BSD".
Note that it might be illegal to use some combinations of licences,
so "BSD" is preferred whenever possible.
If the plugin links against a library, the library's licence might
enforce another licence.
Note that even if the
plugin's code is BSD licenced (Berkeley Software Distribution)
but it links against GPL (GNU General Public
License) code, the contract needs to say GPL.
BSD stands for the simplified, three-clause BSD licence that is used by Elektra itself.
For any plugin which does not declare the licence to be BSD currently,
a warning will be displayed during the mount process, because the overall
licence of the installation concerned may change.
The warning might be wrong, if the licence actually is compatible.
[system/elektra/modules/_/infos/description]
type = string
status = implemented
description = The full text describing everything relevant for the
users, developers or maintainers of this plugin.
Do not duplicate information from other clauses.
Explains informally what the plugin does. It
should be humanly readable and will not be parsed or checked. The person
reading it should get an idea if, and why, this plugin should be used.
This clause is the most important, but not used for the
contract's validity.
It should use markdown syntax.
It should contain long tutorial-like explanations.
Use README.md to make the content easily readable and editable.
The clause should at least contain:
- Purpose
- Possible Usage
- (Current) Limitations, Roadmap or TODOs
- Dependencies
- affiliated Projects or Plugins
- relevant Links for further Information
[system/elektra/modules/_/infos/provides]
type = enum
resolver
storage
code
notification
apply
conv
check
logging
status = implemented
description = Introduces a more abstract name (=provider) for the type
of problem the plugin solves.
A plugin indicates that it
is a provider for all activities necessary to fulfil
a specific mission. The name already provides users with an
understanding what this assignment is. Together with an informal text
(`infos/description?) it exactly describes the responsibilities.
Other plugins can utilise this service.
The above enum lists (in type) the current known providers, even though any other
name can be used, too.
Note, that similar to adding new clauses, usages of prefixes is
highly recommended to avoid name conflicts with future providers added
here.
[system/elektra/modules/_/infos/placements]
type = enum
prerollback
rollback
postrollback
getresolver
pregetstorage
getstorage
postgetstorage
setresolver
presetstorage
setstorage
precommit
commit
postcommit
status = implemented
description = gives a list of places in which the plugin must appear.
During mounting, the algorithm checks if a free slot is available in
the requested position. Because of this clause the placement works
automatically.
The type enumerates the only supported placements.
The places are referred to with the names given in
[elektra-ordering(7)](/doc/help/elektra-ordering.md).
During mounting, the algorithm checks if
a free slot is available in the requested position. Because of this
clause the placement works automatically.
[system/elektra/modules/_/infos/ordering]
type = string
status = implemented
description = requests that a list of plugins or provided names is not
present at the time of insertion. If such a plugin is already there,
the order constraint is violated. Note, that the relation to the
storage and resolver plugins is already determined using the clause
placement.
So it is a simple way to ensure that your plugin will be added before
the one given with this contract clause.
[system/elektra/modules/_/infos/stacking]
type = string
status = implemented
description = any non-empty string disables the stacking of plugins.
By default, plugins in
postgetstorage are ordered in reverse order than in presetstorage.
This is called stacking. The stacking reintroduces the feature which
would automatically be available when only one array of plugins is
processed bidirectionally.
[system/elektra/modules/_/infos/needs]
type = string
status = implemented
description = Lists the requirements of the plugin.
This can be a name of a plugin, but you should always prefer
the name of providers.
Then, any plugin providing the functionality can be used and the
coupling is reduced.
infos/needs is the counterpart of provides. Using it, plugins
delegate some work to other plugins. They need a provider of a specific
service to work properly. The clause describes that the plugin can
only fulfil its work if a specific service is present in the backend.
It does not state when the work has to be done. The clause only declares
that such a provider must be present anywhere in the backend. The name
can also directly refer to another plugin's name.
[system/elektra/modules/_/infos/recommends]
type = string
status = implemented
description = Recommendations are similar to needs, but the backend
also validates if they are not included.
[system/elektra/modules/_/infos/version]
type = string
status = implemented
example = 1
description = Exports the plugin version this plugin was compiled
against. Use the macro PLUGINVERSION in kdbplugin.h for its value.
The current version is the major version as indicated in this file.
The version implies how the plugin interface must look like.
[system/elektra/modules/_/config/needs]
type = null
status = implemented
description = Indicates that this plugin exports a configuration it
needs. All keys below will be propagated to the backend configuration.
One of the provider should provide this configuration.
It presents the plugin configuration needed so that
the plugin works properly. Typically the configuration is not for the
plugin itself, but for other needed plugins (in infos/needs)
elektra-0.8.14/doc/COPYING 0000664 0000000 0000000 00000003357 12623421622 0015043 0 ustar 00root root 0000000 0000000 ## COPYING ##
This is the "New BSD license" as in
http://opensource.org/licenses/BSD-3-Clause
The license below does not contain the advertising clause.
For discussion of BSD licences, see:
https://fsfe.org/freesoftware/transcripts/rms-fs-2006-03-09.en.html#q2
Copyright (c) 2014, Elektra (contributors see in AUTHORS file)
Some rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of Elektra nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
elektra-0.8.14/doc/DESIGN.md 0000664 0000000 0000000 00000021770 12623421622 0015302 0 ustar 00root root 0000000 0000000 # DESIGN ##
This document describes the design of the c-api and gives
hints for binding writers. It does not aim to plugin writers
because this detail is hidden from the programmer and is
Elektra specific.
Elektra follows the design principles to make it hard to use
it wrong and fully aims towards an easy to use API for
programmers reading and writing configuration. The data structures
are optimized to get, set and lookup values easily and fast.
The idea is that the KDB API is not only implemented by Elektra.
Elektra provides a full blown architecture to really support
modern Linux Systems, but comes with some overhead. In this
document the KDB API is described. But sometimes there are
hints for elektra specific conventions.
## Data Structures ##
Key, KeySet and KDB datastructures are defined in kdbprivate.h
to remain ABI compatible when something is added to a struct. That means
it is not possible to put one of elektra's datastructures on the stack.
You must use the memory management facilities mentioned in the next chapter.
## Memory Management ##
Elektra manages memory itself. No free must be required, which
was not allocated by the programmer himself. This avoids that
free is forgotten, makes the API more beginner-friendly. In
addition to all that malloc and free must have the same libc
version. malloc in a library linked against another libc, but
freed by the application could lead to hard to find bugs.
Some calls have a opposite call to get the structure freed again:
KDB * kdbOpen();
will need the function:
int kdbClose(KDB *handle);
to get rid of the resources again. It maybe also shut down
connections, so it really must be called at the end of the
program.
Key *keyNew(const char *keyName, ...);
int keyDel(Key *key);
KeySet *ksNew(int alloc, ...);
int ksDel(KeySet *ks);
These 2 pairs just malloc what is necessary and free it again.
There are more mallocs then just the KDB, Key and KeySet
structures, but they are invisible and they happen implicit
within any of these 3 classes.
Name, Value, Comment can't be handled as easy, because elektra
does not provide a string library. There are 2 ways to access it,
showed on the Comment example:
char *keyComment(const Key *key);
just returns the comment and does not allow any change of size of
the comment.
ssize_t keyGetCommentSize(const Key *key);
to see how long the comment is for above function and how much
buffer to allocate for function below. This value can be directly
passed to malloc.
ssize_t keyGetComment(const Key *key, char *returnedDesc, size_t maxSize);
will write the comment in a buffer maintained by you which is allocated
with at least the size of the function above.
## Variable Arguments ##
The constructors for Key and KeySet take a variable list of arguments
as alternative to keySet* functions and to ksAppendKey(). With that you
can generate any key or keyset in a single c-statement. This can be
done programmatically by keyGenerate or ksGenerate in libelektratools.
To just get a key, use
Key *k = keyNew (0);
and to just get a keyset, use
KeySet *k = ksNew(0, KS_END);
The macros va_start and va_end will not be used then. Otherwise pass
a list like described in the documentation.
## Off-by-one ##
Off-by-one errors (OBOE) are avoided by starting all pointers with 0
as usual in C. The size returned by the *GetSize functions
(keyGetValueSize, keyGetCommentSize and keyGetOwnerSize) is exactly
the size needed to be allocated. So if you add 1 to it, too much is
allocated, but no error will occur.
## Minimal Set ##
The functions listed in kdb.h is a minimal set to fully work with
a key database. They are implemented in src/libelektra in ANSI C.
Functions used by backends are implemented in src/backends/helpers.
They need the POSIX interface and can optionally use iconv to make
utf8 conversations.
## Value, String or Binary ##
Some confusion is about value, string or binary. Value is just a name
which does not specify if it is a string or binary. String is a
char array, with a terminating '\0', but Binary is a void array,
not terminated by '\0'. Only strings may be converted to other charsets.
Use the appendant Get functions, to be not depend on that internal facts.
const void *keyValue(const Key *key);
does not specify whether it is a binary or string, it will just return
the pointer to it. When Key is a string (check with `keyIsString()`) at
least "" will be returned, see below Return Values for strings.
For binary data a NULL pointer is also possible
to distinguish between no data and '\0'.
ssize_t keyGetValueSize(const Key *key);
does not specify whether it is a binary or string, it will just return
the size which can be passed to malloc to hold the entire value.
ssize_t keyGetString(const Key *key, char *returnedString, size_t maxSize);
Get the string into a buffer maintained by you.
ssize_t keySetString(Key *key, const char *newString);
Set the null terminated string.
ssize_t keyGetBinary(const Key *key, void *returnedBinary, size_t maxSize);
Get the binary data which might contain '\0'.
ssize_t keySetBinary(Key *key, const void *newBinary, size_t dataSize);
Set the binary data which might contain '\0'. The length is given
by dataSize.
## Return Value ##
There are many different types of return values. What they have in
common is there error behaviour. Every function must return -1 on
error if it returns Integers (like int, ssize_t). If they return a
pointer, 0 (NULL) will show the error. This can't be used for Integers,
because 0 might be a valid size or is used as "false".
Elektra does not use any float or double, so there is no issue there.
But Elektra uses integers for c-string length, reference counting,
keyset length and internal keyset allocations.
The interface always accept size_t and uses internal size_t
which can hold larger numbers then ssize_t. But to indicate an error it must
be always possible to return -1. This is only possible with
int or ssize_t. These two are used for tests and to return a
size.
So the real size of c-strings and buffers is limited to
SSIZE_MAX which must be checked in every function. When it
exceeds that limit -1 (see above Return Value) or NULL pointer
must be returned.
There are some functions which return an internal string:
const char *keyName(const Key *key);
const char *keyBaseName(const Key *key);
const char *keyOwner(const Key *key);
const char *keyComment(const Key *key);
and in the case that (`keyIsBinary(key)==1`) also:
const void *keyValue(const Key *key);
A Null pointer will lead in all that cases that you get back
a Null pointer.
When there is no string you will get back "", that is a pointer to
'\0'. It marks that there is no string. The function to determine
the size will return 1 in that case. That means that 1 is for empty
strings (Nothing except the NULL terminator).
This is not true for keyValue in the case of binary data, because
'\0' in the first byte is a perfect legal binary data. keyGetValueSize()
may also return 0 for that reason.
## Error Handling ##
Error handling will not be implemented with 0.7.0. So it won't be
possible for an application to determine what exactly went wrong.
Elektra does not set errno. If a function you call sets errno, make sure
to set it back to the old value again.
## Naming ##
All Function Names begin with their class name, e.g. kdb, ks or key.
The words are written together with large letters for separation.
This leads to short names, but might be not as good to read.
*Get* and *Set* are used for getters/and setters, *Is* to ask about
a flag or state, *Needs* to ask about state related to database
and e.g. keyRemove to set a flag or state.
For allocation/deallocation the names are c++ stylish,
like the *New functions *Del.
Macros and Enums are written in capital letters. Options start
with KDB_O, errors KDB_ERR, namespaces KEY_NS and key types with
KEY_TYPE.
The data structures start with a capital letter for every part of
the word:
KDB ... Key Data Base Handle
KeySet ... Key Set
Key ... Key
keyGetUID() and keyGetGID() have upper case letters because ID is commonly
written in upper case letters.
Only singular is used for all names.
Function Names not belonging to one of the three classes are Elektra specific.
Those have the prefix elektra*. They will always be Elektra specific and
won't be implemented by other KDB implementations.
## const ##
Where possible the functions should use const for parameters. Where Key
or KeySet is not modified, const is used. For return values no const is
used, its more disturbing then have any positive effect. The only
exceptions are:
In special:
const char *keyName(const Key *key);
const char *keyBaseName(const Key *key);
const char *keyComment(const Key *key);
const void *keyValue(const Key *key);
const char *keyString(const Key *key);
const Key *keyGetMeta(const Key *key, const char* metaName)
These functions are really thought to get something and not to change anything!
Elektra will lose the knowledge if these keys are synchronized or not. So
they are marked const, and you must not cast that away.
elektra-0.8.14/doc/Doxyfile 0000664 0000000 0000000 00000315625 12623421622 0015522 0 ustar 00root root 0000000 0000000 # Doxyfile 1.8.8
# 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 = "@CMAKE_PROJECT_NAME@"
# 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 = @KDB_VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 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 = @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 = NO
# 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 = @PROJECT_SOURCE_DIR@
# 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 =
# 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 = YES
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the 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 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 = YES
# 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 = NO
# 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
# 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. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO 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 = YES
# 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 = YES
# 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 = YES
# 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 = 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 = YES
# 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 ... \endif and \cond
# ... \endcond blocks.
ENABLED_SECTIONS = NO
# 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 = YES
# 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 = YES
# 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.
# Note: If this tag is empty the current directory is searched.
INPUT = @PROJECT_SOURCE_DIR@/src/libelektra \
@PROJECT_SOURCE_DIR@/src/include \
@PROJECT_SOURCE_DIR@/src/libtools \
@PROJECT_SOURCE_DIR@/src/bindings/cpp/include \
@PROJECT_SOURCE_DIR@/src/plugins/doc/doc.h \
@PROJECT_SOURCE_DIR@/src/libloader/doc.c \
@PROJECT_SOURCE_DIR@/src/libgetenv/README.md \
@PROJECT_SOURCE_DIR@/doc \
@PROJECT_SOURCE_DIR@/src/plugins \
@PROJECT_SOURCE_DIR@/README.md
# 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. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.c \
*.md \
*.hxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.inc \
*.py \
*.lua \
*.h
# 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 = */doc/todo/* \
*/doc/old/* \
*/plugins/*.c \
*/plugins/*.h \
*/plugins/*.cpp \
*/plugins/*.hpp \
*/plugins/*.in
# 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 = doxygen* \
_*
# 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 = "@PROJECT_SOURCE_DIR@/examples" \
"@PROJECT_SOURCE_DIR@/src/bindings/cpp/examples" \
"@PROJECT_SOURCE_DIR@/tests/abi" \
"@PROJECT_SOURCE_DIR@/tests/ctest" \
"@PROJECT_SOURCE_DIR@/tests/cframework" \
"@PROJECT_SOURCE_DIR@/src/plugins/doc"
# 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 = "@PROJECT_SOURCE_DIR@/doc/images/"
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
#
#
# where is the value of the INPUT_FILTER tag, and is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# 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.
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.
FILTER_PATTERNS = *.md=@MARKDOWN_LINK_CONVERTER@
# 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 = API.md
#---------------------------------------------------------------------------
# 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 = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# 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 = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# compiled with the --with-libclang option.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
#---------------------------------------------------------------------------
# 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 = NO
# 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 therefor more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra stylesheet files is of importance (e.g. the last
# stylesheet 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 stylesheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# 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 NO can help when comparing the output of multiple runs.
# The default value is: YES.
# 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 = "@PROJECT_NAME@"
# 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 = @REVERSE_DOMAIN@
# 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 stylesheets (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 = NO
# 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
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
# external symbols imported via tag files in a separate window.
# 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 prerendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you 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 + S
# (what the is depends on the OS and browser, but it is typically
# , /
The core is a small library implemented in C. The plugin-based framework fulfills many
configuration-related tasks to avoid any unnecessary code duplication
across applications while it still allows the core to stay without any
external dependency. Elektra abstracts from cross-platform-related issues
with an consistent API, and allows applications to be aware of other
applications' configurations, leveraging easy application integration.
[Why should I use Elektra?](#goals)
## Contact ##
Do not hesitate to ask any question on
[github issue tracker](https://github.com/ElektraInitiative/libelektra/issues),
[Mailing List](https://lists.sourceforge.net/lists/listinfo/registry-list)
or directly to one of the [authors](doc/AUTHORS).
## Quickstart ##
If you want to use Elektra for your application, [read the application integration tutorial](doc/tutorials/application-integration.md).
### Installation ###
The preferred way to install Elektra is by using packages provided for
your distribution. On Debian/Ubuntu, this can be done by running the following
command:
```bash
sudo apt-get install elektra-bin libelektra-dev
```
This will install the Elektra tools as well as everything needed to develop
with Elektra.
If you're not running Debian/Ubuntu, check out the [package list](#packages),
[download elektra directly](#download) or [compile it yourself](#compiling).
It is preferable to use a recent version: They contain many bug fixes and
additional features. See [INSTALL](doc/INSTALL.md) for other ways to install
Elektra.
### Usage ###
Now that we have Elektra installed, we can start using the [kdb command](/doc/help/kdb.md) and
the [qt-gui](/src/tools/qt-gui/).
You can use the `kdb` command to configure your applications:
```bash
kdb set user/env/override/HTTP_PROXY "http://my.proxy:8080"
```
This will set the `HTTP_PROXY` environment variable to `http://my.proxy:8080`.
Configuration can be retrieved with `kdb get`:
```bash
kdb get /env/override/HTTP_PROXY
```
For information about elektrified environment variables, see
[src/libgetenv/README.md](src/libgetenv/README.md)
### Documentation ###
To get an idea of Elektra, you can take a look at the
[presentation](http://www.libelektra.org/ftp/elektra/presentations/2016/FOSDEM/fosdem.odp).
The full documentation, including
[tutorials](http://libelektra.org/blob/master/doc/tutorials/),
[glossary](/doc/help/elektra-glossary.md), and
[concepts and man pages](/doc/help/elektra-introduction.md)
is available in the github repository.
You can read the documentation for the kdb tool, either
- [on github](http://libelektra.org/blob/master/doc/help/kdb.md)
- [in the API docu](http://doc.libelektra.org/api/latest/html/md_doc_help_kdb.html)
- by using `kdb --help` or `kdb help