The ROM filter provides a ROM module that depends on the content
of other ROM modules. Its designated use is the dynamic switching between
configuration variants dependent on the state of the system. For example,
the configuration of the window decorator may be toggled depending on whether
nitpicker's X-ray mode is active or not.
Configuration
~~~~~~~~~~~~~
The configuration consists of two parts. The first part is the declaration of
input values that are taken into the account. The input values are obtained
from ROM modules that contain XML-formatted data.
Each input value is represented by an '<input>' node with a unique 'name'
attribute. The 'rom' attribute specifies the ROM module to take the input
from. If not specified, the 'name' is used as the ROM name. The type of the
top-level XML node can be specified via the 'node' attribute. If not present,
the top-level XML node is expected to correspond to the 'name' attribute.
The '<input>' node may contain a hierarchy of '<node type="type">' nodes that
denote a path within the XML input. If specified, the optional attributes
'attribute' and 'value' constrain the selection of the input depending of the
presence and the value of the specified attribute.
The second part of the configuration defines the output via an '<output>' node.
The type of the top-level XML node must be specified via the 'node' attribute.
The '<output>' node can contain the following sub nodes:
:'<inline>':
Contains content to be written to the output.
:'<if>':
Produces output depending on a condition (see below). If the condition
is satisfied, the '<then>' sub node is evaluated. Otherwise, the '<else>'
sub node is evaluated. Each of those sub nodes can contain the same
nodes as the '<output>' node.
:'<input>':
Copies the content of the input specified by the 'name' attribute to the
output node.
:'<attribute>':
Adds an attribute with the specified 'name' and 'value'. If the node
has an 'input' attribute, the content of the specified input is taken
as attribute value.
Conditions
----------
The '<has_value>' condition compares an input value (specified as 'input'
attribute) with a predefined value (specified as 'value' attribute). The
condition is satisfied if both values are equal.
Example
~~~~~~~
For an example that illustrates the use of the component, please refer to the
_os/run/rom_filter.run_ script.
