1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: elements.hxx,v $
* $Revision: 1.13 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#if !defined INCLUDED_JVMFWK_ELEMENTS_HXX
#define INCLUDED_JVMFWK_ELEMENTS_HXX
#include <vector>
#include "jvmfwk/framework.h"
#include "fwkutil.hxx"
#include "rtl/ustring.hxx"
#include "rtl/byteseq.hxx"
#include "libxml/parser.h"
#include "boost/optional.hpp"
#define NS_JAVA_FRAMEWORK "http://openoffice.org/2004/java/framework/1.0"
#define NS_SCHEMA_INSTANCE "http://www.w3.org/2001/XMLSchema-instance"
namespace jfw
{
/** gets the value of the updated element from the javavendors.xml.
*/
rtl::OString getElementUpdated();
/** create the child elements within the root structure for each platform.
@param bNeedsSave
[out]If true then the respective structure of elements was added and the
document needs to be saved.
*/
void createSettingsStructure(
xmlDoc * document, bool * bNeedsSave);
/** represents the settings saved in the /java/javaInfo element.
It is used within class NodeJava which determines the settings
file.
*/
class CNodeJavaInfo
{
public:
CNodeJavaInfo();
~CNodeJavaInfo();
/** if true, then javaInfo is empty. When writeToNode is called
then all child elements are deleted.
*/
bool m_bEmptyNode;
/** Contains the value of the <updated> element of
the javavendors.xml after loadFromNode was called.
It is not used, when the javaInfo node is written.
see writeToNode
*/
::rtl::OString sAttrVendorUpdate;
/** contains the nil value of the /java/javaInfo@xsi:nil attribute.
Default is true;
*/
bool bNil;
/** contains the value of the /java/javaInfo@autoSelect attribute.
Default is true. If it is false then the user has modified the JRE
selection by actively choosing a JRE from the options dialog. That is,
the function jfw_setSelectedJRE was called. Contrary, the function
jfw_findAndSelectJRE sets the attribute to true.
*/
bool bAutoSelect;
::rtl::OUString sVendor;
::rtl::OUString sLocation;
::rtl::OUString sVersion;
sal_uInt64 nFeatures;
sal_uInt64 nRequirements;
::rtl::ByteSequence arVendorData;
/** reads the node /java/javaInfo.
If javaInfo@xsi:nil = true then member bNil is set to true
an no further elements are read.
*/
void loadFromNode(xmlDoc * pDoc,xmlNode * pJavaInfo);
/** The attribut nil will be set to false. The function gets the value
javaSettings/updated from the javavendors.xml and writes it to
javaInfo@vendorUpdate in javasettings.xml
*/
void writeToNode(xmlDoc * pDoc, xmlNode * pJavaInfo) const;
/** returns NULL if javaInfo is nil.
*/
JavaInfo * makeJavaInfo() const;
};
/** this class represents the java settings based on a particular
settings file.
Which settings file is used is determined by the value passed into the
constructo and the values of the bootstrap parameters UNO_JAVA_JFW_USER_DATA,
UNO_JAVA_JFW_SHARED_DATA,_JAVA_JFW_INSTALL_DATA.
If the value is USER_OR_INSTALL then it depends of the bootstrap parameter
UNO_JAVA_JFW_INSTALL_DATA. If it has as value then it is used. Otherwise the
value from UNO_JAVA_JFW_USER_DATA is used.
The method load reads the data from the settings file.
The method write stores the data into the settings file.
*/
class NodeJava
{
public:
enum Layer { USER_OR_INSTALL, USER, SHARED, INSTALL };
private:
/** creates settings file and fills it with default values.
When this function is called then it creates the
settings file at the possition determined by the bootstrap parameters
(UNO_JAVA_JFW_USER_DATA, UNO_JAVA_JFW_SHARED_DATA,
UNO_JAVA_JFW_INSTALL_DATA) and m_layer, unless the file already exists
(see createSettingsDocument).
@return
JFW_E_CONFIG_READWRITE
*/
void prepareSettingsDocument() const;
/** helper function for prepareSettingsDocument.
*/
void createSettingsDocument() const;
/** returns the system path to the data file which is to be used. The value
depends on
the the member m_layer and the bootstrap paramters UNO_JAVA_JFW_USER_DATA,
UNO_JAVA_JFW_SHARED_DATA and UNO_JAVA_JFW_INSTALL_DATA which this may be.
*/
::rtl::OString getSettingsPath() const;
/** returns the file URL to the data file which is to be used. See getSettingsPath.
*/
::rtl::OUString getSettingsURL() const;
/** Verifies if the respective settings file exist. In case UNO_JAVA_JFW_INSTALL_DATA
is used, the age is checked. If the file is too old then we assume that it does not
exist and wipe its contents. Then still FILE_DOES_NOT_EXIST is returned.
*/
jfw::FileStatus checkSettingsFileStatus() const;
/** Determines the layer for which the instance the loads and writes the
data.
*/
Layer m_layer;
/** User configurable option. /java/enabled
If /java/enabled@xsi:nil == true then the value will be uninitialized
after a call to load().
*/
boost::optional<sal_Bool> m_enabled;
/** User configurable option. /java/userClassPath
If /java/userClassPath@xsi:nil == true then the value is uninitialized
after a call to load().
*/
boost::optional< ::rtl::OUString> m_userClassPath;
/** User configurable option. /java/javaInfo
If /java/javaInfo@xsi:nil == true then the value is uninitialized
after a call to load.
*/
boost::optional<CNodeJavaInfo> m_javaInfo;
/** User configurable option. /java/vmParameters
If /java/vmParameters@xsi:nil == true then the value is uninitialized
after a call to load.
*/
boost::optional< ::std::vector< ::rtl::OUString> > m_vmParameters;
/** User configurable option. /java/jreLocations
If /java/jreLocaltions@xsi:nil == true then the value is uninitialized
after a call to load.
*/
boost::optional< ::std::vector< ::rtl::OUString> > m_JRELocations;
public:
NodeJava(Layer theLayer = USER_OR_INSTALL);
/** sets m_enabled.
/java/enabled@xsi:nil will be set to false when write is called.
*/
void setEnabled(sal_Bool bEnabled);
/** sets m_sUserClassPath. See setEnabled.
*/
void setUserClassPath(const ::rtl::OUString & sClassPath);
/** sets m_aInfo. See setEnabled.
@param bAutoSelect
true- called by jfw_setSelectedJRE
false called by jfw_findAndSelectJRE
*/
void setJavaInfo(const JavaInfo * pInfo, bool bAutoSelect);
/** sets the /java/vmParameters/param elements.
When this method all previous values are removed and replaced
by those in arParameters.
/java/vmParameters@xsi:nil will be set to true when write() is
called.
*/
void setVmParameters(rtl_uString * * arParameters, sal_Int32 size);
/** sets the /java/jreLocations/location elements.
When this method is called then all previous values are removed
and replaced by those in arParamters.
/java/jreLocations@xsi:nil will be set to true write() is called.
*/
void setJRELocations(rtl_uString * * arParameters, sal_Int32 size);
/** adds a location to the already existing locations.
Note: call load() before, then add the location and then call write().
*/
void addJRELocation(rtl_uString * sLocation);
/** writes the data to user settings.
*/
void write() const;
/** load the values of the settings file.
*/
void load();
/** returns the value of the element /java/enabled
*/
const boost::optional<sal_Bool> & getEnabled() const;
/** returns the value of the element /java/userClassPath.
*/
const boost::optional< ::rtl::OUString> & getUserClassPath() const;
/** returns the value of the element /java/javaInfo.
*/
const boost::optional<CNodeJavaInfo> & getJavaInfo() const;
/** returns the parameters from the element /java/vmParameters/param.
*/
const boost::optional< ::std::vector< ::rtl::OUString> > & getVmParameters() const;
/** returns the parameters from the element /java/jreLocations/location.
*/
const boost::optional< ::std::vector< ::rtl::OUString> > & getJRELocations() const;
};
/** merges the settings for shared, user and installation during construction.
The class uses a simple merge mechanism for the javasettings.xml files in share and
user. The following elements completly overwrite the corresponding elements
from share:
/java/enabled
/java/userClassPath
/java/vmParameters
/java/jreLocations
/java/javaInfo
In case of an installation, the shared and user settings are completely
disregarded.
The locations of the different settings files is obtained through the
bootstrap variables:
UNO_JAVA_JFW_USER_DATA
UNO_JAVA_JFW_SHARED_DATA
UNO_JAVA_JFW_INSTALL_DATA
The class also determines useful default values for settings which have not been made.
*/
class MergedSettings
{
private:
const MergedSettings& operator = (MergedSettings&);
MergedSettings(MergedSettings&);
void merge(const NodeJava & share, const NodeJava & user);
sal_Bool m_bEnabled;
::rtl::OUString m_sClassPath;
::std::vector< ::rtl::OUString> m_vmParams;
::std::vector< ::rtl::OUString> m_JRELocations;
CNodeJavaInfo m_javaInfo;
public:
MergedSettings();
virtual ~MergedSettings();
/** the default is true.
*/
sal_Bool getEnabled() const;
const ::rtl::OUString & getUserClassPath() const;
::std::vector< ::rtl::OString> getVmParametersUtf8() const;
/** returns a JavaInfo structure representing the node
/java/javaInfo. Every time a new JavaInfo structure is created
which needs to be freed by the caller.
If both, user and share settings are nil, then NULL is returned.
*/
JavaInfo * createJavaInfo() const;
/** returns the value of the attribute /java/javaInfo[@vendorUpdate].
*/
::rtl::OString const & getJavaInfoAttrVendorUpdate() const;
#ifdef WNT
/** returns the javaInfo@autoSelect attribute.
Before calling this function loadFromSettings must be called.
It uses the javaInfo@autoSelect attribute to determine
the return value;
*/
bool getJavaInfoAttrAutoSelect() const;
#endif
/** returns an array.
Caller must free the strings and the array.
*/
void getVmParametersArray(rtl_uString *** parParameters, sal_Int32 * size) const;
/** returns an array.
Caller must free the strings and the array.
*/
void getJRELocations(rtl_uString *** parLocations, sal_Int32 * size) const;
const ::std::vector< ::rtl::OUString> & getJRELocations() const;
};
class VersionInfo
{
::std::vector< ::rtl::OUString> vecExcludeVersions;
rtl_uString ** arVersions;
public:
VersionInfo();
~VersionInfo();
void addExcludeVersion(const ::rtl::OUString& sVersion);
::rtl::OUString sMinVersion;
::rtl::OUString sMaxVersion;
/** The caller DOES NOT get ownership of the strings. That is he
does not need to release the strings.
The array exists as long as this object exists.
*/
rtl_uString** getExcludeVersions();
sal_Int32 getExcludeVersionSize();
};
struct PluginLibrary
{
PluginLibrary()
{
}
PluginLibrary(rtl::OUString vendor,::rtl::OUString path) :
sVendor(vendor), sPath(path)
{
}
/** contains the vendor string which is later userd in the xml API
*/
::rtl::OUString sVendor;
/** File URL the plug-in library
*/
::rtl::OUString sPath;
};
} //end namespace
#endif
|