Wiki » History » Version 10

J. Wienke, 12/04/2010 12:40 AM

1 7 J. Wienke
h1. Prerequisites
2 1 J. Wienke
3 7 J. Wienke
h2. Dependencies
4 7 J. Wienke
5 4 J. Wienke
* Boost >= 1.38 (for hardy available in the gar-installer, 1.34.1 untested)
6 4 J. Wienke
* CMake (tested with 2.8)
7 4 J. Wienke
* optional
8 4 J. Wienke
** Doxygen for API generation
9 1 J. Wienke
** Lcov for code coverage analysis
10 7 J. Wienke
11 7 J. Wienke
h2. Supported Operating Systems and Compilers
12 7 J. Wienke
13 7 J. Wienke
* Linux (GCC 4.x)
14 7 J. Wienke
* Windows (MS Visual Studio 9 2008)
15 4 J. Wienke
16 8 J. Wienke
Other combination may be possible but are currently untested.
17 8 J. Wienke
18 4 J. Wienke
h1. Contents
19 4 J. Wienke
20 6 J. Wienke
h2. Logging Adapter
21 6 J. Wienke
22 6 J. Wienke
Several different logging systems exist with different advantages and dependencies. E.g. log4cxx heavily relies on APR which is a huge dependency to built i.e. for embedded systems like Nao. To decouple libraries from concrete logging implementations and their dependencies, RSC contains a flexible adaption layer that can utilize different logging mechanisms through one interface. If e.g. log4cxx is available, a client using the RSC logging system can use log4cxx through the provided interfaces. If no versatile logging system is available, RSC falls back on a simple console logging mechanism without any dependencies. Hence, client code does not need to be recompiled for changing the logging system.
23 6 J. Wienke
24 6 J. Wienke
Currently the linker call decides which logging mechanisms are available by linking their adapter shared libraries to the client. A plugin system is planned to remove the necessity of calling the linker.
25 6 J. Wienke
26 9 J. Wienke
h2. Subprocess
27 9 J. Wienke
28 9 J. Wienke
A high-level interface for starting executables and automatically terminating them based on the RAII-pattern. The operating system is abstracted.
29 9 J. Wienke
30 9 J. Wienke
h2. Threading
31 9 J. Wienke
32 9 J. Wienke
Support classes for threading tasks like synchronized queues, a task abstraction, or a thread pools for dispatching asynchronous events with ordering guarantees.
33 9 J. Wienke
34 9 J. Wienke
h2. Misc
35 9 J. Wienke
36 9 J. Wienke
Collection of various utility classes including:
37 9 J. Wienke
* *Registry*: Key-value based registry for system components.
38 9 J. Wienke
* *UUID*: Simplified wrapper for boost::uuid.
39 9 J. Wienke
* Various utility functions for string manipulation or boost::shared_ptr handling.
40 9 J. Wienke
41 4 J. Wienke
h2. CMake Support Library
42 4 J. Wienke
43 1 J. Wienke
RSC contains different CMake scripts and macros which are generally useful. These include:
44 10 J. Wienke
* Find macros for various software packages like spread, BoostUUID, Eigen2, Log4cxx
45 2 J. Wienke
* *EnableConverageReport*: Support for html code coverage reports on GCC using gcov and lcov.
46 1 J. Wienke
* *CheckInitMethod*: Checks which compiler-specific method can be used to execute before the main method begins. This is e.g. useful to install extensions
47 1 J. Wienke
* *InstallFilesRecursive*: A macro to install files while preserving their folder structure. The normal install macro of CMake copies all given files into a flat list at the target location.
48 1 J. Wienke
* *ParseArguments*: Helper to parse arguments to CMake macros and functions with UPPERCASE keywords to separate lists.
49 1 J. Wienke
50 5 J. Wienke
All CMake files are installed to @$prefix/share/cmake/Modules@ and available in the repository at source:/trunk/rsc/cmake.
51 4 J. Wienke
52 4 J. Wienke
h2. To be continued