Development/Tutorials/Using KConfig XT
| Tutorial Series | KConfig |
| Previous | Introduction to KConfig Introduction to CMake |
| What's Next | None |
| Further Reading | The KDE Configuration Compiler (KDE 4) The KDE Configuration Compiler (KDE 3) |
Parts to be reviewed:
- Port to KF5
- Update screenshot
Contents
Using KConfig XT
Original Author: Zack Rusin <[email protected]>
This tutorial introduces the main concepts of the KconfigXT configuration framework and shows how to efficiently use it in applications. It assumes that the reader has already developed a KDE application and is familiar with KConfig. A basic understanding of XML and concepts behind XML Schema is also required.
The main idea behind KConfig XT is to make the life of application developers easier while making the administration of large KDE installations more manageable. The four basic parts of the new framework are:
- KConfigSkeleton - a class in the libkdecore library which grants a more flexible access to the configuration options,
- XML file containing information about configuration options (the .kcfg file)
- An ini like file which provides the code generation options (the .kcfgc file)
- kconfig_compiler - which generates C++ source code from .kcfg and .kcfgc files. The generated class is based on KConfigSkeleton and provides an API for the application to access its configuration data.
.kcfg Structure
The structure of the .kcfg file is described by its XML Schema (kcfg.xsd - available from here or from the kdecore library ). Please go through it before you go any further.
Lets create a simple .kcfg file. Please reference the code below as we go through each step.
<?xml version="1.0" encoding="UTF-8"?>
<kcfg xmlns="http://www.kde.org/standards/kcfg/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
<include>kglobalsettings.h</include>
<kcfgfile name="kjotsrc"/>
<group name="kjots">
<entry name="SplitterSizes" type="IntList">
<label>How the main window is divided.</label>
</entry>
<entry name="Width" type="Int">
<label>Width of the main window.</label>
<default>600</default>
</entry>
<entry name="Height" type="Int">
<label>Height of the main window.</label>
<default>400</default>
</entry>
<entry name="OpenBooks" type="StringList">
<label>All books that are opened.</label>
</entry>
<entry name="CurrentBook" type="String">
<label>The book currently opened.</label>
</entry>
<entry name="Font" type="Font">
<label>The font used to display the contents of books.</label>
<default code="true">KGlobalSettings::generalFont()</default>
</entry>
</group>
</kcfg>
- Use your favorite code editor to open a your_application_name.kcfg file (of course replacing your_application_name with the name of the application you want to convert to KConfig XT).
- Start that file by opening the <kcfgfile> tag which controls which KConfig file the data will be stored in. There are three possibilities:
- If the <kcfgfile> tag has no attributes the generated code will use the application's default KConfig file (normally $HOME/.config/<appname>rc).
- The "name" attribute is used to manually specify a file name. If the value assigned to "name" is not an absolute file path, the file will be created in the default KDE config directory (normally $HOME/.kde/config).
- If you would like to be able to specify the config file at construction time, use <kcfgfile arg="true">. This causes the constructor of the generated class to take a KSharedConfig::Ptr as an argument, allowing you to construct multiple instances pointing to different files.
- Add the optional <include> tags which may contain C++ header files that are needed to compile the code required to compute the default values.
- The remaining entries in the XML file are grouped by the tag <group> which describes the corresponding groups in the configuration file.
- The individual entries must have at least a name or a key. The key is used as the key in the config file. The name is used to create accessor and modifier functions. If <key> is not given, the name is used as the config file key. If <key> is given, but not <name>, the name is constructed by removing all spaces from the <key> contents.
- Always add <label>, <tooltip> and <whatsthis> tags to your application in which you describe the configuration options. The <label> tag is used for short descriptions of the entry, while <tooltip> and <whatsthis> contains more verbose documentation. It's important for tools like KConfigEditor which can be used by systems administrators to setup machines over on the network. Note that this tags will be ignored unless you provide SetUserTexts=true option in your .kcfgc file (see section on it below)
- An entry must also have a type. The allowed types are: String, Url, StringList, Font, Rect, Size, Color, Point, Int, UInt, Bool, Double, DateTime, Int64, UInt64 and Password. Besides those basic type the following special types are supported and include:
- Path - This is a string that is specially treated as a file-path. In particular paths in the home directory are prefixed with $HOME when being stored in the configuration file.
- Enum - This indicates an enumeration. The possible enum values should be provided via the <choices> tag. Enum values are accessed as integers by the application but stored as string in the configuration file. This makes it possible to add more values at a later date without breaking compatibility.
- IntList - This indicates a list of integers. This information is provided to the application as QList<int>. Useful for storing QSplitter geometries.
- PathList - List of Path elements.
- Color - isn't a special type but has special input. It is generated as QColor. Any valid input to QColor(QString) can be used (hex or SVG keyword notation) as well as a special format
r,g,b,awhere the a denotes the alpha channel and may be omitted.
- The <min> and <max> tags can be set to limit the value of the integer-type options.
- The <emit> tag can be used to specify a signal to emit when the property change
- An entry can optionally have a default value which is used as default when the value isn't specified in any config file. Default values are interpreted as literal constant values. If a default value needs to be computed or if it needs to be obtained from a function call, the <default> tag should contain the code="true" attribute. The contents of the <default> tag is then considered to be a C++ expression.
- Additional code for computing default values can be provided via the <code> tag. The contents of the <code> tag is inserted as-is. A typical use for this is to compute a common default value which can then be referenced by multiple entries that follow.
- Optionally, the hidden option can also be added to the <entry>. The possible values are true and false.
.kcfgc files
After creating a .kcfg file create a .kcfgc file which describes the C++ file generation options. The .kcfgc file is a simple ini file with the typical "entry=value" format. To create a simple .kcfgc file follow these steps:
- Open a new file in your favorite text editor.
- Start it with the "File=your_application_name.kcfg" entry which specifies where the configuration options for your application are stored.
- Add the "ClassName=YourConfigClassName" entry which specifies the name of the class that will be generated from the .kcfg file. Remember that the generated class will be derived from KConfigSkeleton. Please make sure that YourConfigClassName is not a class name already used in your application. Save this file under yourconfigclassname.kcfgc. This will ensure the generation of the yourconfigclassname.{h,cpp} files where your configuration class will reside.
- Add any additional entries, which your application might need. Those additional entries include:
- NameSpace - specifies the namespace in which the generated config class should reside,
- Inherits - if you need the generated class to inherit your custom class,
- Visibility - Exported symbol visibility such as Q_DECL_EXPORT,
- IncludeFiles - List of included file,
- Singleton - if the configuration class should use the singleton pattern to restricts the instantiation of the class to one object,
- MemberVariables - specifies the access to the member variables, default is private,
- ItemAccessors - relates to the above item, if member variables are public then it might make little sense to generate accessors. By default they are generated,
- Mutators - similar to the above one, but applies to the mutator methods,
- Notifiers - specifies whether entries should be written with the Notify flag, so a change to them can be detected using KConfigWatcher
- GlobalEnums - specifies whether enums should be class wide or whether they should be always explicitly prefixed with their type name,
- UseEnumTypes - specifies whether enum values should be passed as type int or as their enum type in the return value of accessor functions and the arguments of mutator and signal functions.
- SetUserTexts - specifies whether <label>, <tooltip> and <whatsthis> tags should be processed. This allows tools like KConfigDialog make use of these tags. By default this tags are ignored
- GenerateProperties - specifies whether to add Q_PROPERTY declarations
For details see the description of kconfig_compiler: [1]
Adjusting the CMakeLists.txt file
After creating the .kcfg and .kcfgc files the next step is to adjust the build to let kconfig_compiler generate the required class at compile time. For in-source builds, doing this is trivial and requires only one step, adding this two lines to the CMakeLists.txt file example (asuming your files are named settings.kcfg and settings.kcfgc):
kconfig_add_kcfg_files(<project name>_SRCS settings.kcfgc)
install(FILES settings.kcfg DESTINATION ${KCFG_INSTALL_DIR})
Alternatively, if a .moc file needs to be generated before compiling the generated source code, use
kconfig_add_kcfg_files(<project name>_SRCS GENERATE_MOC settings.kcfgc)
install(FILES settings.kcfg DESTINATION ${KCFG_INSTALL_DIR})
This assures that the configuration class is properly generated (kconfig_add_kcfg_files) and that the .kcfg is installed so it can be used by tools like the KConfigEditor (install).
Out-of-source builds
Out-of-source builds require one more step.
The problem: In out-of-source builds, the code that is generated by kconfig_compiler is saved in the build tree. So how can we still include the header generated by kconfig_compiler with a simple #include "settings.h"?
The solution: Probably you have yet a line similar to the following line in your CMakeLists.txt:
include_directories(${QT_INCLUDE} ${KDE4_INCLUDES})
Add the variable CMAKE_CURRENT_BINARY_DIR, so that you get something like this:
include_directories(${QT_INCLUDE} ${KDE4_INCLUDES} ${CMAKE_CURRENT_BINARY_DIR})
Notice that you should call include_directories only once in your project. (When you call include_directories in your base source directory, but than call it another time in a subdirectory (added by add_subdirectory), then the second call will be ignored.)
Use and Dialogs
After making all of the above changes you're ready to use KConfig XT. The kconfig_compiler generated header file will have the name equal to the name of the .kcfg file but with a ".h" extension. Simply include that file wherever you want to access your configuration options.
The use will depend on whether you have added the Singleton=true entry to your .kcfgc file.
One of the nicest features of the KConfig XT is its seamless integration with the Qt Designer generated dialogs. You can do that by using KConfigDialog. The steps to do that are as follows:
- Create the KConfigDialog and pass the instance of your configuration data as one of the arguments. The construct would look like the following example:
KConfigDialog* dialog = new KConfigDialog(
this, "settings", YourAppSettings::self() );
assuming that YourAppSettings is the value of the ClassName variable from the kcfgc file and the settings class is a singelton.
- In Qt Designer create widgets which should be used to configure your options. In order to make those widgets interact with the kcfg you have to name each one of them using the following scheme:
- Prefix the Name of the widget which should control one of the options with "kcfg_"
- Append the "name" attribute value from your kcfg file which corresponds to option the given widget should control.
- Add the Qt Designer generated widget to the KConfigDialog.
- Show the dialog when you're done.
Using Outside of KConfigDialog or with dynamic widgets
While KConfigDialog provide a convenient way of binding KConfig XT based settings with dialogs, some use case require manual binding. A common one is heavy and slow loading KConfigDialog being replaced with lazy loaded containers. Another one is where is when multiple instances KConfigSkeleton based object exist. Finally, this can also be used to load a set of values used outside of a config dialog. Here is a basic example of manual binding:
KConfigDialogManager* manager = new KConfigDialogManager(this, YourAppSettings::self());
connect(this, SIGNAL(okClicked()), manager, SLOT(updateSettings()));
connect(this, SIGNAL(applyClicked()), manager, SLOT(updateSettings()));
connect(this, SIGNAL(cancelClicked()), manager, SLOT(updateWidgets()));
connect(this, SIGNAL(defaultClicked()), manager, SLOT(updateWidgetsDefault()));
connect(manager, SIGNAL(settingsChanged()), this, SLOT(updateButtons()));
connect(manager, SIGNAL(widgetModified()), this, SLOT(updateButtons()));
manager->addWidget(myConfigWidget);
Example
Here's an example usage of KConfig XT for the application named Example. With the following example.kcfg file:
<?xml version="1.0" encoding="UTF-8"?>
<kcfg xmlns="http://www.kde.org/standards/kcfg/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
<kcfgfile name="examplerc"/>
<group name="network">
<entry name="ServerName" type="String">
<label>Defines the sample server.</label>
</entry>
<entry name="Port" type="Int">
<label>Defines the server port</label>
<default>21</default>
<min>20</min>
<max>990</max>
</entry>
</group>
</kcfg>
And here's how to actually use the generated class for the given kcfgc file.
File=example.kcfg
ClassName=ExampleSettings
Singleton=true
Mutators=true
The header files wouldn't change, but the cpp files must now contain the following code to access and store the configuration data :
...
#include <ExampleSettings.h>
...
void ExampleClass::readConfig() {
m_server = ExampleSettings::serverName();
m_port = ExampleSettings::port();
}
void ExampleClass::saveSettings() {
ExampleSettings::setServerName( m_server );
ExampleSettings::setPort( m_port );
ExampleSettings::self()->writeConfig();
}
self() returns the current instance of the object. You need to call writeConfig() this way, since it's a virtual method.
To add a dialog you need to create a Qt Designer widget with the widget names corresponding to the names of the options they should edit and prefixed with "kcfg_". It could be something along the lines of:
And you can use the dialog with the following code:
// An instance of your dialog could be already created and could be
// cached, in which case you want to display the cached dialog
// instead of creating another one
if ( KConfigDialog::showDialog( "settings" ) )
return;
// KConfigDialog didn't find an instance of this dialog, so lets
// create it :
KConfigDialog* dialog = new KConfigDialog(this, "settings",
ExampleSettings::self());
ExampleDesignerWidget* confWdg =
new ExampleDesignerWidget( 0, "Example" );
dialog->addPage( confWdg, i18n("Example"), "example" );
// User edited the configuration - update your local copies of the
// configuration data
connect( dialog, SIGNAL(settingsChanged()),
this, SLOT(updateConfiguration()) );
dialog->show();
And that's all it takes. You can have a look at KReversi and KMines code in the kdegames module to see a live example of KConfig XT!
Common Pitfalls and Tips
- Do not forget to add the "type" attribute to the "entry" tag in your .kcfg file.
- Always try to add both the <label>, <whatsthis> and <tooltip> tags to each entry.
- Putting the MemberVariables=public in your .kcfgc is usually a bad idea - you'll avoid accidental changes to those members by using the aggregation and forcing the use of the mutators.
- If your application doesn't have one central object (created before and destructed after all others) then always put the Singleton=true entry in your .kcfgs file.