/usr/src/castle-game-engine-4.1.1/base/castlexmlconfig.pas is in castle-game-engine-src 4.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | {
Copyright 2006-2013 Michalis Kamburelis.
This file is part of "Castle Game Engine".
"Castle Game Engine" is free software; see the file COPYING.txt,
included in this distribution, for details about the copyright.
"Castle Game Engine" 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.
----------------------------------------------------------------------------
}
{ Storing configuration files in XML (TCastleConfig). }
unit CastleXMLConfig;
{ In new FPC versions, XMLConf unit is advised and XMLCfg is deprecated.
See e.g. [http://www.mail-archive.com/lazarus@lists.lazarus.freepascal.org/msg09489.html].
But XMLConf requires adding units to your uses clause that are otherwise
not needed:
This binary has no unicodestrings support compiled in.
Recompile the application with a unicodestrings-manager in the program uses clause.
So we keep using XMLCfg for now. Undefine USE_OLD_XMLCFG if you wish
to use XMLConf. }
{$define USE_OLD_XMLCFG}
interface
uses CastleUtils, {$ifdef USE_OLD_XMLCFG} XMLCfg {$else} XMLConf {$endif}, DOM,
CastleVectors, CastleKeysMouse, CastleGenericLists, SysUtils, Classes;
type
EMissingAttribute = class(Exception);
TCastleConfig = class;
TCastleConfigEvent = procedure (const Config: TCastleConfig) of object;
TCastleConfigEventList = class(specialize TGenericStructList<TCastleConfigEvent>)
public
{ Call all items. }
procedure ExecuteAll(const Config: TCastleConfig);
end;
{ Store configuration in XML format.
This is a descendant of TXMLConfig that adds various small extensions:
float types (GetFloat, SetFloat, SetDeleteFloat),
vector types, key (TKey) types,
PathElement utility. }
TCastleConfig = class(TXMLConfig)
private
FOnLoad, FOnSave: TCastleConfigEventList;
procedure SetMyURL(const Value: string);
function GetMyURL: string;
public
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
{ Internal notes: At the beginning I made the float methods
to overload existing names (GetValue, SetValue etc.).
But this turned out to be a *very* bad idea: integers are
casted to floats automatically, and this means that it's too
easy to use integer getter to read a value that may be float.
Consider that default value for some float parameter is of integer type
(e.g. because it was declared as an integer, because you forget to
write "0.0" instead of "0" etc.). Then
MyValue := GetValue('float_param', 0);
will choose GetValue that interprets given value as an integer.
If you perviously stored a float value there
(like by SetValue('float_param', 3.14)) then the GetValue above
will compile but fail miserably at runtime }
{ }
function GetFloat(const APath: string;
const ADefaultValue: Float): Float;
procedure SetFloat(const APath: string;
const AValue: Float);
procedure SetDeleteFloat(const APath: string;
const AValue, ADefaultValue: Float);
function GetValue(const APath: string;
const ADefaultValue: TVector3Single): TVector3Single; overload;
procedure SetValue(const APath: string;
const AValue: TVector3Single); overload;
procedure SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TVector3Single); overload;
function GetValue(const APath: string;
const ADefaultValue: TVector4Single): TVector4Single; overload;
procedure SetValue(const APath: string;
const AValue: TVector4Single); overload;
procedure SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TVector4Single); overload;
function GetValue(const APath: string;
const ADefaultValue: TKey): TKey; overload;
procedure SetValue(const APath: string;
const AValue: TKey); overload;
procedure SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TKey); overload;
{ For a given path, return corresponding DOM element of XML tree.
This is useful if you want to mix XMLConfig style operations
on the file and then use some real DOM functions to more directly
operate/read on XML document.
Note that for paths that you pass to various SetValue versions,
the last path component is the attribute name. You do not pass
this here. Path passed here should end with the name of final
element.
Path passed here may but doesn't have to be terminated by a final slash.
In fact, for now the path is just splitted using slash character
as a separator, so a path like @code(/some////path/) is equivalent
to a path like (some/path). But don't depend on this behavior.
Returns nil if there is no such element.
Remember that XMLConfig idea of XML document is limited.
That's intentional (XMLConfig is supposed to offer only a simple limited
XML access), and this means that some XML trees may confuse XMLConfig.
For example, if there are two elements with the same TagName as a children
of the same element: XMLConfig will (probably ?) just always ignore
the second one. Which means that if you use this method to change
some XML content, you should be careful when accessing this content
from regular XMLConfig Get/SetValue methods. }
function PathElement(const APath: string): TDOMElement;
{ Read an URL from an XML attribute.
The attribute in an XML file may be an absolute or relative URL,
(we will look at own TXMLConfig.FileName directory to resolve relative
URLs). The returned URL is always an absolute URL.
If EmptyIfNoAttribute, then this will just set URL to ''
if appropriate XML attribute not found. Otherwise
(when EmptyIfNoAttribute = @false, this is default),
error will be raised.
@raises(EMissingAttribute If EmptyIfNoAttribute = @false and no such attribute.) }
function GetURL(const APath: string;
const EmptyIfNoAttribute: boolean = false): string;
{ Get a value, as a string. Value must exist and cannot be empty in XML file.
@raises(EMissingAttribute If value doesn't exist or is empty in XML file.) }
function GetNonEmptyValue(const APath: string): string;
procedure NotModified;
{ Called at @link(Load). }
property OnLoad: TCastleConfigEventList read FOnLoad;
{ Called at @link(Save). }
property OnSave: TCastleConfigEventList read FOnSave;
{ The URL from which to load and save configuration, always absolute.
This is converted underneath to ancestor TXMLConfig.FileName,
so in fact we only support local files here for now. }
property URL: string read GetMyURL write SetMyURL;
{ Load the current configuration of the engine components.
Sets @link(URL) and FileName, loading the appropriate file to our properties,
and then calls the OnLoad callbacks to allow all engine components
read their settings.
Accepts URL as parameter, converting it to a local filename
under the hood.
The overloaded version without AURL chooses
a suitable filename for storing per-program user preferences.
It uses ApplicationName to pick a filename that is unique
to your application (usually you want to assign OnGetApplicationName
callback to set your name, unless you're fine with default determination
that looks at stuff like ParamStr(0)).
See FPC OnGetApplicationName docs.
It uses @link(ApplicationConfig) to determine location of this file.
@groupBegin }
procedure Load(const AURL: string);
procedure Load;
{ @groupEnd }
{ Save the configuration of all engine components.
Calls the OnSave callbacks to allow all engine components
to store their settings in our properties, and then flushes
them to disk (using FileName property, synchronized with @link(URL) property)
by inherited Flush method. }
procedure Save;
end;
procedure Register;
implementation
uses CastleStringUtils, CastleFilesUtils, CastleLog, CastleURIUtils;
procedure Register;
begin
RegisterComponents('Castle', [TCastleConfig]);
end;
{ TCastleConfigEventList ----------------------------------------------------- }
procedure TCastleConfigEventList.ExecuteAll(const Config: TCastleConfig);
var
I: Integer;
begin
for I := 0 to Count - 1 do
Items[I](Config);
end;
{ TCastleConfig -------------------------------------------------------------- }
constructor TCastleConfig.Create(AOwner: TComponent);
begin
inherited;
FOnLoad := TCastleConfigEventList.Create;
FOnSave := TCastleConfigEventList.Create;
end;
destructor TCastleConfig.Destroy;
begin
FreeAndNil(FOnLoad);
FreeAndNil(FOnSave);
inherited;
end;
function TCastleConfig.GetFloat(const APath: string;
const ADefaultValue: Float): Float;
var
ResultString: string;
begin
ResultString := GetValue(APath, FloatToStr(ADefaultValue));
Result := StrToFloatDef(ResultString, ADefaultValue);
end;
procedure TCastleConfig.SetFloat(const APath: string;
const AValue: Float);
begin
SetValue(APath, FloatToStr(AValue));
end;
procedure TCastleConfig.SetDeleteFloat(const APath: string;
const AValue, ADefaultValue: Float);
begin
SetDeleteValue(APath, FloatToStr(AValue), FloatToStr(ADefaultValue));
end;
const
VectorComponentPaths: array [0..3] of string =
('/x', '/y', '/z', '/w');
function TCastleConfig.GetValue(const APath: string;
const ADefaultValue: TVector3Single): TVector3Single;
var
I: Integer;
begin
for I := 0 to 2 do
Result[I] := GetFloat(APath + VectorComponentPaths[I], ADefaultValue[I]);
end;
procedure TCastleConfig.SetValue(const APath: string;
const AValue: TVector3Single);
var
I: Integer;
begin
for I := 0 to 2 do
SetFloat(APath + VectorComponentPaths[I], AValue[I]);
end;
procedure TCastleConfig.SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TVector3Single);
var
I: Integer;
begin
for I := 0 to 2 do
SetDeleteFloat(APath + VectorComponentPaths[I], AValue[I], ADefaultValue[I]);
end;
function TCastleConfig.GetValue(const APath: string;
const ADefaultValue: TVector4Single): TVector4Single;
var
I: Integer;
begin
for I := 0 to 3 do
Result[I] := GetFloat(APath + VectorComponentPaths[I], ADefaultValue[I]);
end;
procedure TCastleConfig.SetValue(const APath: string;
const AValue: TVector4Single);
var
I: Integer;
begin
for I := 0 to 3 do
SetFloat(APath + VectorComponentPaths[I], AValue[I]);
end;
procedure TCastleConfig.SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TVector4Single);
var
I: Integer;
begin
for I := 0 to 3 do
SetDeleteFloat(APath + VectorComponentPaths[I], AValue[I], ADefaultValue[I]);
end;
function TCastleConfig.GetValue(const APath: string;
const ADefaultValue: TKey): TKey;
begin
Result := StrToKey(GetValue(APath, KeyToStr(ADefaultValue)), ADefaultValue);
end;
procedure TCastleConfig.SetValue(const APath: string;
const AValue: TKey);
begin
SetValue(APath, KeyToStr(AValue));
end;
procedure TCastleConfig.SetDeleteValue(const APath: string;
const AValue, ADefaultValue: TKey);
begin
SetDeleteValue(APath, KeyToStr(AValue), KeyToStr(ADefaultValue));
end;
function TCastleConfig.PathElement(const APath: string): TDOMElement;
{ Find a children element, nil if not found. }
function FindElementChildren(Element: TDOMElement;
const ElementName: string): TDOMElement;
var
Node: TDOMNode;
begin
Node := Element.FindNode(ElementName);
if (Node <> nil) and (Node.NodeType = ELEMENT_NODE) then
Result := Node as TDOMElement else
Result := nil;
end;
var
SeekPos: Integer;
PathComponent: string;
begin
Result := Doc.DocumentElement;
SeekPos := 1;
while Result <> nil do
begin
PathComponent := NextToken(APath, SeekPos, ['/']);
if PathComponent = '' then break;
Result := FindElementChildren(Result, PathComponent);
end;
end;
function TCastleConfig.GetURL(const APath: string;
const EmptyIfNoAttribute: boolean): string;
begin
Result := GetValue(APath, '');
if Result = '' then
begin
if not EmptyIfNoAttribute then
raise EMissingAttribute.CreateFmt('Missing attribute "%s" in XML file', [APath]);
end else
Result := CombineURI(URL, Result);
end;
function TCastleConfig.GetNonEmptyValue(const APath: string): string;
begin
Result := GetValue(APath, '');
if Result = '' then
raise EMissingAttribute.CreateFmt('Missing attribute "%s" in XML file', [APath]);
end;
procedure TCastleConfig.NotModified;
begin
FModified := false;
end;
procedure TCastleConfig.SetMyURL(const Value: string);
var
F: string;
begin
F := URIToFilenameSafe(Value);
if F = '' then
raise Exception.CreateFmt('Cannot load local file from "%s", TCastleConfig for now supports only local files', [Value]);
FileName := F;
end;
function TCastleConfig.GetMyURL: string;
begin
Result := FilenameToURISafe(FileName);
end;
procedure TCastleConfig.Load(const AURL: string);
begin
URL := AURL;
OnLoad.ExecuteAll(Self);
{ This is used for various files (not just user preferences,
also resource.xml files), and logging this gets too talkative for now.
if Log then
WritelnLog('Config', 'Loading configuration from "%s"', [AURL]); }
end;
procedure TCastleConfig.Load;
begin
Load(ApplicationConfig(ApplicationName + '.conf'));
end;
procedure TCastleConfig.Save;
begin
OnSave.ExecuteAll(Self);
Flush;
if Log and (FileName <> '') then
WritelnLog('Config', 'Saving configuration to "%s"', [FileName]);
end;
end.
|