1GENREFLEX(1) General Commands Manual GENREFLEX(1)
2
6 genreflex - Generates the LCG dictionary file for each header file
7
9 genreflex headerfile1.h [headerfile2.h] [options] [preprocesor options]
10
12 Generates the LCG dictionary file for each header file
13
15 -s file, --selection_file=file
16 Class selection file to specify for which classes the dictionary
17 will be generated Format (XML):
18 <lcgdict>
20 [<selection>]
21 <class [name="classname"] [pattern="wildname"]
22 [file_name="filename"] [file_pattern="wildname"]
23 [id="xxxx"] [type="vector"]/>
24 <class name="classname" >
25 <field name="m_transient" transient="true"/>
26 <field name="m_anothertransient" transient="true"/>
27 <properties prop1="value1" [prop2="value2"]/>
28 </class>
29 <function [name="funcname"] [pattern="wildname"] />
30 <enum [name="enumname"] [patter="wildname"] />
31 <variable [name="varname"] [patter="wildname"] />
32 [</selection>]
33 <exclusion>
34 <class [name="classname"] [pattern="wildname"]>
35 <method name="unwanted" />
36 </class>
37 </exclusion>
38 ...
39 </lcgdict>
40 See also the section SELECTION FILE SYNTAX below.
42 -o file, --output file
44 Output file name. If an existing directory is specified instead
45 of a file, then a filename will be build using the name of the
46 input file and will be placed in the given directory. <header‐
47 file>_rflx.cpp
48 --pool Generate minimal dictionary required for POOL persistence
50 --deep Generate dictionary for all dependend classes
52 --split (OBSOLETE)
54 Generate separate file for stub functions. Option sometimes
55 needed on Windows.
56 --reflex (OBSOLETE)
58 Generate Reflex dictionaries.
59 --comments
61 Add end-of-line comments in data and functions members as a
62 property called "comment"
63 --no_membertypedefs
65 Disable the definition of class member typedefs
66 --fail_on_warnings
68 The genreflex command fails (retuns the value 1) if any warning
69 message is issued
70 --gccxmlpath=path
72 Path path where the gccxml(1) tool is installed. If not defined
73 the standard PATH environ variable is used
74 -c file, --capabilities=file
76 Generate the capabilities file to be used by the SEAL Plugin
77 Manager. This file lists the names of all classes for which the
78 reflection is formation is provided.
79 --rootmap=file
81 Generate the rootmap file to be used by ROOT/CINT. This file
82 lists the names of all classes for which the reflection is for‐
83 mation is provided.
84 --rootmap-lib=library
86 Library name for the rootmap file.
87 --debug
89 Print extra debug information while processing. Keep intermedi‐
90 ate files
91 --quiet
93 No not print informational messages
94 -h, --help
96 Print help
97 Try "genreflex --help" for more information.
99
101 <lcgdict>
102 Sub elements:
103 <selection> <exclusion> <class> <function>
104 Attributes:
106 none
107 The root element of the xml file. It has to be present.
109 <selection>
111 Sub elements:
112 <class> <function>
113 Attributes:
115 none
116 The selection element is only mandatory if the <exclusion> element is
118 used in the same file. Otherwise all sub-elements of <lcgdict> are sup‐
119 posed to be included in the dictionary.
120 <exclusion>
122 Sub elements:
123 <class> <function>
124 Attributes:
126 none
127 If a <selection> element is present it is also possible to exclude
129 types following the same patterns as for selection
130 <class>
132 Sub elements:
133 <field> <properties> <method>
134 Attributes:
136 name
138 The exact name of the class to be filtered pattern A
139 pattern matching a set of classes
140 file_name
142 The exact file name to be filtered. All classes contained
143 in the file will be selected
144 file_pattern
146 A pattern matching a set of files
147 id The class ID (used for POOL persistence)
149 type
151 The class type (used for POOL persistence)
152 All classes matching the patterns or names in the attributes will be
154 selected. The name, pattern, file_name, and file_pattern attributes are
155 mutual exclusive.
156 <function>
158 Sub elements:
159 none
160 Attributes:
162 name The exact name of the function
164 pattern
166 A pattern matching a set of functions
167 All function matching the attributes of the function element will be
169 selected and dictionaries will be created for them. The nameandpattern
170 attributes are mutual exclusive.
171 <field>
173 Sub elements:
174 none
175 Attributes:
177 name The exact name of the field
179 transient
181 If set to true a property (transient/true) will be set
182 for this member (used for POOL persistence)
183 The <field> element is mainly used for POOL persistence to mark if some
185 of the data members of a class shall be skipped when the class is writ‐
186 ten to a persistent medium
187 <method>
189 Sub elements:
190 none
191 Attributes:
193 name The name of the method to be excluded
195 The <method> element is used to exclude the dictionary generation from
197 classes which match the given attributes.
198
201 root(1), rootcint(1), gccxml(1)
202 See also the ROOT webpages: http://root.cern.ch
204
206 The ROOT team (see web page above):
207 Rene Brun and Fons Rademakers
208
210 This library is free software; you can redistribute it and/or modify it
211 under the terms of the GNU Lesser General Public License as published
212 by the Free Software Foundation; either version 2.1 of the License, or
213 (at your option) any later version.
214 This library is distributed in the hope that it will be useful, but
216 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
217 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
218 General Public License for more details.
219 You should have received a copy of the GNU Lesser General Public
221 License along with this library; if not, write to the Free Software
222 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
223 USA
224
226 This manual page was written by Christian Holm Christensen
227 <cholm@nbi.dk>, for the Debian GNU/Linux system (but may be used by
228 others).
229ROOT Version 5 GENREFLEX(1)