forked from amorilia/nifskope
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nifxml.cpp
575 lines (521 loc) · 16.3 KB
/
nifxml.cpp
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
/***** BEGIN LICENSE BLOCK *****
BSD License
Copyright (c) 2005-2012, NIF File Format Library and Tools
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the NIF File Format Library and Tools project may not be
used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
***** END LICENCE BLOCK *****/
#include "nifmodel.h"
#include "niftypes.h"
#include <QtXml>
#include <QApplication>
#include <QMessageBox>
//! \file nifxml.cpp NifXmlHandler, NifModel XML
//! Set NifXmlHandler::errorStr and return
#define err( X ) { errorStr = X; return false; }
QReadWriteLock NifModel::XMLlock;
QList<quint32> NifModel::supportedVersions;
QHash<QString,NifBlock*> NifModel::compounds;
QHash<QString,NifBlock*> NifModel::blocks;
//! Parses nif.xml
class NifXmlHandler : public QXmlDefaultHandler
{
// Q_DECLARE_TR_FUNCTIONS(NifXmlHandler)
public:
//! XML block types
enum Tag
{
tagNone = 0,
tagFile,
tagVersion,
tagCompound,
tagBlock,
tagAdd,
tagBasic,
tagEnum,
tagOption,
tagBitFlag
};
//! i18n wrapper for various strings
/*!
* Note that we don't use QObject::tr() because that doesn't provide
* context. We also don't use the QCoreApplication Q_DECLARE_TR_FUNCTIONS()
* macro because that won't document properly.
*/
static inline QString tr( const char * key, const char * comment = 0 ) { return QCoreApplication::translate( "NifXmlHandler", key, comment ); }
//! Constructor
NifXmlHandler()
{
depth = 0;
tags.insert( "niftoolsxml", tagFile );
tags.insert( "version", tagVersion );
tags.insert( "compound", tagCompound );
tags.insert( "niobject", tagBlock );
tags.insert( "add", tagAdd );
tags.insert( "basic", tagBasic );
tags.insert( "enum", tagEnum );
tags.insert( "option", tagOption );
tags.insert( "bitflags", tagBitFlag );
blk = 0;
}
//! Current position on stack
int depth;
//! Tag stack
Tag stack[10];
//! Hashmap of tags
QHash<QString, Tag> tags;
//! Error string
QString errorStr;
//! Current type ID
QString typId;
//! Current type description
QString typTxt;
//! Current enumeration ID
QString optId;
//! Current enumeration value
QString optVal;
//! Current enumeration text
QString optTxt;
//! Block
NifBlock * blk;
//! Data
NifData data;
//! The current tag
Tag current() const
{
return stack[depth-1];
}
//! Add a tag to the stack
void push( Tag x )
{
stack[depth++] = x;
}
//! Get a tag from the stack
Tag pop()
{
return stack[--depth];
}
//! Reimplemented from QXmlContentHandler
/*!
* \param Namespace (unused)
* \param localName (unused)
* \param tagid Qualified name
* \param list Attributes
*/
bool startElement( const QString &, const QString &, const QString & tagid, const QXmlAttributes & list )
{
if ( depth >= 8 ) err( tr("error maximum nesting level exceeded") );
Tag x = tags.value( tagid );
if ( x == tagNone ) err( tr("error unknown element '%1'").arg(tagid) );
if ( depth == 0 )
{
if ( x != tagFile ) err( tr("this is not a niftoolsxml file") );
push( x );
return true;
}
switch ( current() )
{
case tagFile:
push( x );
switch ( x )
{
case tagCompound:
case tagBlock:
{
if ( ! list.value("nifskopetype").isEmpty() )
{
QString alias = list.value( "name" );
QString type = list.value( "nifskopetype" );
if ( alias != type )
if ( ! NifValue::registerAlias( alias, type ) )
err( tr("failed to register alias %1 for type %2").arg(alias).arg(type) );
typId = alias;
typTxt = QString();
}
else
{
QString id = list.value( "name" );
if ( x == tagCompound && NifValue::isValid( NifValue::type( id ) ) )
err( tr("compound %1 is already registered as internal type").arg( list.value( "name" ) ) );
if ( id.isEmpty() )
err( tr("compound and niblocks must have a name") );
if ( NifModel::compounds.contains( id ) || NifModel::blocks.contains( id ) )
err( tr("multiple declarations of %1").arg(id) );
if ( ! blk ) blk = new NifBlock;
blk->id = id;
blk->abstract = ( list.value( "abstract" ) == "1" );
if ( x == tagBlock )
{
blk->ancestor = list.value( "inherit" );
if ( ! blk->ancestor.isEmpty() )
{
if ( ! NifModel::blocks.contains( blk->ancestor ) )
err( tr("forward declaration of block id %1").arg(blk->ancestor) );
}
}
};
} break;
case tagBasic:
{
QString alias = list.value( "name" );
QString type = list.value( "nifskopetype" );
if ( alias.isEmpty() || type.isEmpty() )
err( tr("basic definition must have a name and a nifskopetype") );
if ( alias != type )
if ( ! NifValue::registerAlias( alias, type ) )
err( tr("failed to register alias %1 for type %2" ).arg(alias).arg(type) );
typId = alias;
typTxt = QString();
} break;
case tagEnum:
case tagBitFlag:
{
typId = list.value( "name" );
typTxt = QString();
QString storage = list.value( "storage" );
if ( typId.isEmpty() || storage.isEmpty() )
err( tr("enum definition must have a name and a known storage type") );
if ( ! NifValue::registerAlias( typId, storage ) )
err( tr("failed to register alias %1 for enum type %2").arg(storage).arg(typId) );
NifValue::EnumType flags = (x == tagBitFlag) ? NifValue::eFlags : NifValue::eDefault;
NifValue::registerEnumType(typId, flags);
} break;
case tagVersion:
{
int v = NifModel::version2number( list.value( "num" ).trimmed() );
if ( v != 0 && ! list.value( "num" ).isEmpty() )
NifModel::supportedVersions.append( v );
else
err( tr("invalid version tag") );
} break;
default:
err( tr("expected basic, enum, compound, niobject or version got %1 instead").arg(tagid) );
} break;
case tagVersion:
//err( tr("version tag must not contain any sub tags") );
break;
case tagCompound:
if ( x != tagAdd ) err( tr("only add tags allowed in compound type declaration") );
case tagBlock:
push( x );
switch ( x )
{
case tagAdd:
{
// ns type optimizers come here
// we really shouldn't be doing this
// but it will work for now until we find a better solution
QString type = list.value( "type" );
QString nstype = list.value( "nifskopetype" );
if (!nstype.isEmpty() && nstype != type) {
if ( NifValue::type( nstype ) == NifValue::tNone )
err( "failed to locate alias " + nstype );
type = nstype;
}
if ( type == "KeyArray" ) type = "ns keyarray";
else if ( type == "VectorKeyArray" ) type = "ns keyvecarray";
else if ( type == "TypedVectorKeyArray" ) type = "ns keyvecarraytyp";
else if ( type == "RotationKeyArray" ) type = "ns keyrotarray";
// now allocate
data = NifData(
list.value( "name" ),
type,
list.value( "template" ),
NifValue( NifValue::type( type ) ),
list.value( "arg" ),
list.value( "arr1" ),
list.value( "arr2" ),
list.value( "cond" ),
NifModel::version2number( list.value( "ver1" ) ),
NifModel::version2number( list.value( "ver2" ) ),
( list.value( "abstract" ) == "1" )
);
if ( data.isAbstract() )
{
data.value.setAbstract( true );
}
QString defval = list.value( "default" );
if ( ! defval.isEmpty() )
{
bool ok;
quint32 enumVal = NifValue::enumOptionValue( type, defval, &ok );
if( ok ) {
data.value.setCount( enumVal );
} else {
data.value.fromString( defval );
}
}
QString vercond = list.value( "vercond" );
QString userver = list.value( "userver" );
if ( ! userver.isEmpty() )
{
if ( ! vercond.isEmpty() )
vercond += " && ";
vercond += QString("(User Version == %1)").arg(userver);
}
QString userver2 = list.value( "userver2" );
if ( ! userver2.isEmpty() )
{
if ( ! vercond.isEmpty() )
vercond += " && ";
vercond += QString("(User Version 2 == %1)").arg(userver2);
}
if ( !vercond.isEmpty() )
{
data.setVerCond( vercond );
}
if ( data.name().isEmpty() || data.type().isEmpty() )
err( tr("add needs at least name and type attributes") );
} break;
default:
err( tr("only add tags allowed in block declaration") );
} break;
case tagEnum:
case tagBitFlag:
push( x );
switch ( x )
{
case tagOption:
optId = list.value( "name" );
optVal = list.value( "value" );
optTxt = QString();
if ( optId.isEmpty() || optVal.isEmpty() )
err( tr("option defintion must have a name and a value") );
bool ok;
optVal.toInt( &ok, 0 );
if ( ! ok )
err( tr("option value error (only integers please)") );
break;
default:
err( tr("only option tags allowed in enum declaration") );
} break;
default:
err( tr("error unhandled tag %1").arg(tagid) );
break;
}
return true;
}
//! Reimplemented from QXmlContentHandler
/*!
* \param Namespace (unused)
* \param localName (unused)
* \param tagid Qualified name
*/
bool endElement( const QString &, const QString &, const QString & tagid )
{
if ( depth <= 0 ) err( tr("mismatching end element tag for element %1").arg(tagid) );
Tag x = tags.value( tagid );
if ( pop() != x ) err( tr("mismatching end element tag for element %1").arg(tagid) );
switch ( x )
{
case tagCompound:
if ( blk && ! blk->id.isEmpty() && ! blk->text.isEmpty() )
NifValue::setTypeDescription( blk->id, blk->text );
else if ( !typId.isEmpty() && ! typTxt.isEmpty() )
NifValue::setTypeDescription( typId, typTxt );
case tagBlock:
if ( blk )
{
if ( blk->id.isEmpty() )
{
delete blk;
blk = 0;
err( tr("invalid %1 declaration: name is empty").arg(tagid) );
}
switch ( x )
{
case tagCompound:
NifModel::compounds.insert( blk->id, blk );
break;
case tagBlock:
NifModel::blocks.insert( blk->id, blk );
break;
default:
break;
}
blk = 0;
}
break;
case tagAdd:
if ( blk ) blk->types.append( data );
break;
case tagOption:
{
bool ok;
quint32 optValInt = optVal.toInt( &ok, 0 );
if ( ! ok || ! NifValue::registerEnumOption( typId, optId, optValInt, optTxt ) )
err( tr("failed to register enum option") );
}
break;
case tagBasic:
case tagEnum:
case tagBitFlag:
NifValue::setTypeDescription( typId, typTxt );
default:
break;
}
return true;
}
//! Reimplemented from QXmlContentHandler
/*!
* \param s The character data
*/
bool characters( const QString & s )
{
switch ( current() )
{
case tagVersion:
break;
case tagCompound:
case tagBlock:
if ( blk )
blk->text += s.trimmed();
else
typTxt += s.trimmed();
break;
case tagAdd:
data.setText( data.text() + s.trimmed() );
break;
case tagBasic:
case tagEnum:
case tagBitFlag:
typTxt += s.trimmed();
break;
case tagOption:
optTxt += s.trimmed();
break;
default:
break;
}
return true;
}
//! Checks that the type of the data is valid
bool checkType( const NifData & data )
{
return NifModel::compounds.contains( data.type() ) || NifValue::type( data.type() ) != NifValue::tNone || data.type() == "TEMPLATE";
}
//! Checks that a template type is valid
bool checkTemp( const NifData & data )
{
return data.temp().isEmpty() || NifValue::type( data.temp() ) != NifValue::tNone || data.temp() == "TEMPLATE" || NifModel::blocks.contains( data.temp() ) || NifModel::compounds.contains( data.temp() );
}
//! Reimplemented from QXmlContentHandler
bool endDocument()
{ // make a rough check of the maps
foreach ( QString key, NifModel::compounds.keys() )
{
NifBlock * c = NifModel::compounds.value( key );
foreach ( NifData data, c->types )
{
if ( ! checkType( data ) )
err( tr("compound type %1 refers to unknown type %2").arg(key).arg(data.type()) );
if ( ! checkTemp( data ) )
err( tr("compound type %1 refers to unknown template type %2").arg(key).arg(data.temp()) );
if ( data.type() == key )
err( tr("compound type %1 contains itself").arg(key) );
}
}
foreach ( QString key, NifModel::blocks.keys() )
{
NifBlock * blk = NifModel::blocks.value( key );
if ( ! blk->ancestor.isEmpty() && ! NifModel::blocks.contains( blk->ancestor ) )
err( tr("niobject %1 inherits unknown ancestor %2").arg(key).arg(blk->ancestor) );
if ( blk->ancestor == key )
err( tr("niobject %1 inherits itself").arg(key) );
foreach ( NifData data, blk->types )
{
if ( ! checkType( data ) )
err( tr("niobject %1 refers to unknown type %2").arg(key).arg(data.type()) );
if ( ! checkTemp( data ) )
err( tr("niobject %1 refers to unknown template type %2").arg(key).arg(data.temp()) );
}
}
return true;
}
//! Reimplemented from QXmlContentHandler
QString errorString() const
{
return errorStr;
}
//! Exception handler
bool fatalError( const QXmlParseException & exception )
{
if ( errorStr.isEmpty() ) errorStr = "Syntax error";
errorStr.prepend( tr( "XML parse error (line %1):<br>" ).arg( exception.lineNumber() ) );
return false;
}
};
// documented in nifmodel.h
bool NifModel::loadXML()
{
QDir dir( QApplication::applicationDirPath() );
QString fname = dir.filePath( "nif.xml" ); // last resort
// Try local copy first, docsys, relative from nifskope/release, relative from ../nifskope-build/release, linux data dir
QStringList xmlList( QStringList()
<< "nif.xml"
<< "docsys/nifxml/nif.xml"
<< "../docsys/nifxml/nif.xml"
<< "../../docsys/nifxml/nif.xml"
<< "../nifskope/docsys/nifxml/nif.xml"
<< "../../nifskope/docsys/nifxml/nif.xml"
<< "/usr/share/nifskope/nif.xml" );
foreach( QString str, xmlList )
{
if ( dir.exists( str ) )
{
fname = dir.filePath( str );
break;
}
}
QString result = NifModel::parseXmlDescription( fname );
if ( ! result.isEmpty() )
{
QMessageBox::critical( 0, "NifSkope", result );
return false;
}
return true;
}
// documented in nifmodel.h
QString NifModel::parseXmlDescription( const QString & filename )
{
QWriteLocker lck( &XMLlock );
qDeleteAll( compounds ); compounds.clear();
qDeleteAll( blocks ); blocks.clear();
supportedVersions.clear();
NifValue::initialize();
QFile f( filename );
if ( ! f.open( QIODevice::ReadOnly | QIODevice::Text ) )
return tr( "error: couldn't open xml description file: ") + filename;
NifXmlHandler handler;
QXmlSimpleReader reader;
reader.setContentHandler( &handler );
reader.setErrorHandler( &handler );
QXmlInputSource source( &f );
reader.parse( source );
if ( ! handler.errorString().isEmpty() )
{
qDeleteAll( compounds ); compounds.clear();
qDeleteAll( blocks ); blocks.clear();
supportedVersions.clear();
}
return handler.errorString();
}