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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
|
/*
Ousía
Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <algorithm>
#include <core/common/RttiBuilder.hpp>
#include <core/common/Utils.hpp>
#include <core/common/VariantReader.hpp>
#include <core/model/Document.hpp>
#include <core/model/Ontology.hpp>
#include <core/model/Project.hpp>
#include <core/model/Typesystem.hpp>
#include <core/parser/utils/TokenizedData.hpp>
#include <core/parser/ParserScope.hpp>
#include <core/parser/ParserContext.hpp>
#include "DocumentHandler.hpp"
#include "State.hpp"
namespace ousia {
namespace parser_stack {
/* DocumentHandler */
bool DocumentHandler::startCommand(Variant::mapType &args)
{
Rooted<Document> document =
context().getProject()->createDocument(args["name"].asString());
document->setLocation(location());
scope().push(document);
scope().setFlag(ParserFlag::POST_HEAD, false);
scope().setFlag(ParserFlag::POST_USER_DEFINED_TOKEN_REGISTRATION, false);
return true;
}
void DocumentHandler::end() { scope().pop(logger()); }
/* DocumentField */
Rooted<FieldDescriptor> DocumentField::getDescriptor()
{
// Fetch the FieldDescriptor from the parent node. The parent node should
// either be a structured entity or an annotation entity
Rooted<Managed> parent = getParent();
if (parent->isa(&RttiTypes::StructuredEntity)) {
return parent.cast<StructuredEntity>()
->getDescriptor()
->getFieldDescriptor(fieldIdx);
} else if (parent->isa(&RttiTypes::AnnotationEntity)) {
return parent.cast<AnnotationEntity>()
->getDescriptor()
->getFieldDescriptor(fieldIdx);
}
// Well, we never should get here
// TODO: Introduce macro for unreachable code?
assert(!"This should never be reached");
return nullptr;
}
/* DocumentChildHandler */
DocumentChildHandler::DocumentChildHandler(const HandlerData &handlerData)
: Handler(handlerData), isExplicitField(false)
{
// Register all user defined tokens if this has not yet been done
if (!scope().getFlag(ParserFlag::POST_USER_DEFINED_TOKEN_REGISTRATION)) {
registerUserDefinedTokens();
}
}
void DocumentChildHandler::registerUserDefinedTokens()
{
// Set the POST_USER_DEFINED_TOKEN_REGISTRATION flag, to prevent this method
// from being called again
scope().setFlag(ParserFlag::POST_USER_DEFINED_TOKEN_REGISTRATION, true);
// Fetch the underlying document and all ontologies registered in the
// document and register all user defined tokens in the parser
Rooted<Document> doc = scope().selectOrThrow<Document>();
for (Rooted<Ontology> ontology : doc->getOntologies()) {
std::vector<TokenDescriptor *> tokens =
ontology->getAllTokenDescriptors();
for (TokenDescriptor *token : tokens) {
if (!token->special) {
token->id = registerToken(token->token);
}
}
}
}
void DocumentChildHandler::preamble(Rooted<Node> &parentNode, size_t &fieldIdx,
DocumentEntity *&parent)
{
// Check if the parent in the structure tree was an explicit field
// reference.
if (parentNode->isa(&RttiTypes::DocumentField)) {
fieldIdx = parentNode.cast<DocumentField>()->fieldIdx;
parentNode = scope().selectOrThrow(
{&RttiTypes::StructuredEntity, &RttiTypes::AnnotationEntity});
}
// Reference the parent entity explicitly.
parent = nullptr;
if (parentNode->isa(&RttiTypes::StructuredEntity)) {
parent = static_cast<DocumentEntity *>(
parentNode.cast<StructuredEntity>().get());
} else if (parentNode->isa(&RttiTypes::AnnotationEntity)) {
parent = static_cast<DocumentEntity *>(
parentNode.cast<AnnotationEntity>().get());
}
}
void DocumentChildHandler::pushScopeTokens()
{
// List containing the unfiltered syntax descriptors
std::vector<SyntaxDescriptor> descrs;
// Fetch the current scope stack and search the first non-transparent field
// or structure
const NodeVector<Node> &stack = scope().getStack();
for (auto sit = stack.crbegin(); sit != stack.crend(); sit++) {
Rooted<Node> nd = *sit;
// TODO: Why can't this functionality be in a common base class?
// Check whether the field is transparent, if not, fetch the tokens
if (nd->isa(&RttiTypes::DocumentField)) {
Rooted<DocumentField> field = nd.cast<DocumentField>();
if (!field->transparent) {
descrs = field->getDescriptor()->getPermittedTokens();
break;
}
}
// Check whether the sturcture is transparent, if not, fetch the tokens
if (nd->isa(&RttiTypes::StructuredEntity)) {
Rooted<StructuredEntity> entity = nd.cast<StructuredEntity>();
if (!entity->isTransparent()) {
descrs = entity->getDescriptor()->getPermittedTokens();
break;
}
}
}
// Push the filtered tokens onto the stack
pushTokens(descrs);
}
void DocumentChildHandler::pushDocumentField(Handle<Node> parent,
Handle<FieldDescriptor> fieldDescr,
size_t fieldIdx, bool transparent)
{
// Push the field onto the scope
Rooted<DocumentField> field =
new DocumentField(manager(), parent, fieldIdx, transparent);
field->setLocation(location());
scope().push(field);
}
void DocumentChildHandler::popDocumentField()
{
// Pop the field from the scope, make sure it actually is a DocumentField
assert(scope().getLeaf()->isa(&RttiTypes::DocumentField));
scope().pop(logger());
}
void DocumentChildHandler::createPath(const NodeVector<Node> &path,
DocumentEntity *&parent, size_t p0)
{
size_t S = path.size();
for (size_t p = p0; p < S; p = p + 2) {
// add the field.
const ssize_t fieldIdx =
parent->getDescriptor()->getFieldDescriptorIndex();
const Rooted<FieldDescriptor> fieldDescr =
parent->getDescriptor()->getFieldDescriptor(fieldIdx);
pushDocumentField(scope().getLeaf(), fieldDescr, fieldIdx, true);
// add the transparent/implicit structure element.
Rooted<StructuredEntity> transparent =
parent->createChildStructuredEntity(path[p].cast<StructuredClass>(),
Variant::mapType{},
path[p - 1]->getName(), "");
transparent->setLocation(location());
transparent->setTransparent(true);
scope().push(transparent);
parent = static_cast<DocumentEntity *>(transparent.get());
}
// add the field.
const ssize_t fieldIdx = parent->getDescriptor()->getFieldDescriptorIndex();
const Rooted<FieldDescriptor> fieldDescr =
parent->getDescriptor()->getFieldDescriptor(fieldIdx);
pushDocumentField(scope().getLeaf(), fieldDescr, fieldIdx, true);
// Generally allow explicit fields in the new field
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, false);
}
void DocumentChildHandler::createPath(const size_t &firstFieldIdx,
const NodeVector<Node> &path,
DocumentEntity *&parent)
{
// Add the first element
Rooted<StructuredEntity> transparent = parent->createChildStructuredEntity(
path[0].cast<StructuredClass>(), firstFieldIdx);
transparent->setLocation(location());
transparent->setTransparent(true);
scope().push(transparent);
parent = static_cast<DocumentEntity *>(transparent.get());
createPath(path, parent, 2);
// Generally allow explicit fields in the new field
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, false);
}
void DocumentChildHandler::rollbackPath()
{
// Remove the topmost field
popDocumentField();
// Pop all remaining transparent elements.
while (scope().getLeaf()->isa(&RttiTypes::StructuredEntity) &&
scope().getLeaf().cast<StructuredEntity>()->isTransparent()) {
// Pop the transparent element.
scope().pop(logger());
// Pop the transparent field.
popDocumentField();
}
}
static std::string extractNameAttribute(Variant::mapType &args)
{
// Extract the special "name" attribute from the input arguments.
// The remaining attributes will be forwarded to the newly constructed
// element.
std::string res;
auto it = args.find("name");
if (it != args.end()) {
res = it->second.asString();
args.erase(it);
}
return res;
}
bool DocumentChildHandler::startCommand(Variant::mapType &args)
{
std::string nameAttr = extractNameAttribute(args);
scope().setFlag(ParserFlag::POST_HEAD, true);
while (true) {
Rooted<Node> parentNode = scope().getLeaf();
Rooted<StructuredEntity> entity;
// handle the root note specifically.
if (parentNode->isa(&RttiTypes::Document)) {
// if we already have a root node, stop.
if (parentNode.cast<Document>()->getRoot() != nullptr) {
logger().warning(
"This document already has a root node. The additional "
"node is ignored.",
location());
return false;
}
Rooted<StructuredClass> strct = scope().resolve<StructuredClass>(
Utils::split(name(), ':'), logger());
if (strct == nullptr) {
// if we could not resolve the name, throw an exception.
throw LoggableException(
std::string("\"") + name() + "\" could not be resolved.",
location());
}
entity = parentNode.cast<Document>()->createRootStructuredEntity(
strct, args, nameAttr);
} else {
assert(parentNode->isa(&RttiTypes::DocumentField));
size_t fieldIdx;
DocumentEntity *parent;
preamble(parentNode, fieldIdx, parent);
/*
* Try to find a FieldDescriptor for the given tag if we are not in
* a field already. This does _not_ try to construct transparent
* paths in between.
*/
{
ssize_t newFieldIdx =
parent->getDescriptor()->getFieldDescriptorIndex(name());
if (newFieldIdx != -1) {
// Check whether explicit fields are allowed here, if not
if (scope().getFlag(ParserFlag::POST_EXPLICIT_FIELDS)) {
logger().note(
std::string(
"Data or structure commands have already been "
"given, command \"") +
name() +
std::string(
"\" is not interpreted as explicit "
"field. Move explicit field "
"references to the beginning."),
location());
} else {
pushDocumentField(
parentNode,
parent->getDescriptor()->getFieldDescriptor(
newFieldIdx),
newFieldIdx, false);
pushScopeTokens();
isExplicitField = true;
return true;
}
}
}
// Otherwise create a new StructuredEntity
Rooted<StructuredClass> strct = scope().resolve<StructuredClass>(
Utils::split(name(), ':'), logger());
if (strct == nullptr) {
// if we could not resolve the name, throw an exception.
throw LoggableException(
std::string("\"") + name() + "\" could not be resolved.",
location());
}
// calculate a path if transparent entities are needed in between.
Rooted<FieldDescriptor> field =
parent->getDescriptor()->getFieldDescriptor(fieldIdx);
size_t lastFieldIdx = fieldIdx;
auto pathRes = field->pathTo(strct, logger());
if (!pathRes.second) {
if (scope().getLeaf().cast<DocumentField>()->transparent) {
// if we have transparent elements above us in the structure
// tree we try to unwind them before we give up.
// pop the implicit field.
popDocumentField();
// pop the implicit element.
scope().pop(logger());
continue;
}
throw LoggableException(
std::string("An instance of \"") + strct->getName() +
"\" is not allowed as child of field \"" +
field->getNameOrDefaultName() + "\" of descriptor \"" +
parent->getDescriptor()->getName() + "\"",
location());
}
if (!pathRes.first.empty()) {
createPath(lastFieldIdx, pathRes.first, parent);
lastFieldIdx =
parent->getDescriptor()->getFieldDescriptorIndex();
}
// create the entity for the new element at last.
entity = parent->createChildStructuredEntity(strct, lastFieldIdx,
args, nameAttr);
}
// We're past the region in which explicit fields can be defined in the
// parent structure element
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, true);
// Push the entity onto the stack
entity->setLocation(location());
scope().push(entity);
pushScopeTokens();
return true;
}
}
bool DocumentChildHandler::startAnnotation(Variant::mapType &args)
{
std::string nameAttr = extractNameAttribute(args);
scope().setFlag(ParserFlag::POST_HEAD, true);
size_t fieldIdx;
DocumentEntity *parent;
while (true) {
Rooted<Node> parentNode = scope().getLeaf();
// Make sure the parent node is a DocumentField
if (parentNode->isa(&RttiTypes::Document)) {
logger().error(
"Cannot start or end annotation at the document level.",
location());
return false;
}
assert(parentNode->isa(&RttiTypes::DocumentField));
preamble(parentNode, fieldIdx, parent);
if (!parent->getDescriptor()
->getFieldDescriptor(fieldIdx)
->isPrimitive()) {
break;
}
// If we are inside a primitive field and have transparent elements on
// the stack we unwind the stack until we are inside
// a non-primitive field.
if (scope().getLeaf().cast<DocumentField>()->transparent) {
// if we have transparent elements above us in the structure
// tree we try to unwind them before we give up.
// pop the implicit field.
popDocumentField();
// pop the implicit element.
scope().pop(logger());
continue;
} else {
logger().error(
"Cannot start or end annotation within the primitive field \"" +
parent->getDescriptor()
->getFieldDescriptor(fieldIdx)
->getNameOrDefaultName() +
"\" of descriptor \"" + parent->getDescriptor()->getName() +
"\".",
location());
return false;
}
}
// Create the anchor
Rooted<Anchor> anchor = parent->createChildAnchor(fieldIdx);
anchor->setLocation(location());
// Resolve the AnnotationClass
Rooted<AnnotationClass> annoClass;
if (!name().empty()) {
annoClass = scope().resolve<AnnotationClass>(Utils::split(name(), ':'),
logger());
}
switch (type()) {
case HandlerType::ANNOTATION_START: {
// Create the AnnotationEntity itself.
if (annoClass == nullptr) {
// if we could not resolve the name, throw an exception.
throw LoggableException(
std::string("\"") + name() + "\" could not be resolved.",
location());
}
Rooted<Document> doc = scope().selectOrThrow<Document>();
Rooted<AnnotationEntity> anno = doc->createChildAnnotation(
annoClass, anchor, nullptr, args, nameAttr);
// Push the entity onto the stack
anno->setLocation(location());
scope().push(anno);
break;
}
case HandlerType::ANNOTATION_END: {
// if we want to end an annotation, look for the matching start
// Anchor ...
Rooted<Anchor> start =
parent->searchStartAnchor(fieldIdx, annoClass, nameAttr);
if (start == nullptr) {
logger().error(
"Did not find matching annotation start for annotation "
"end.",
*anchor);
parent->removeStructureNodeFromField(anchor, fieldIdx);
return false;
}
// ... and set the end Anchor.
start->getAnnotation()->setEnd(anchor);
break;
}
default:
throw OusiaException(
"Internal Error: Invalid handler type in startAnnotation");
}
// We're past the region in which explicit fields can be defined in the
// parent structure element
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, true);
return true;
}
bool DocumentChildHandler::startToken(Handle<Node> node)
{
bool isStruct = node->isa(&RttiTypes::StructuredClass);
// bool isField = node->isa(&RttiTypes::FieldDescriptor);
// bool isAnnotation = node->isa(&RttiTypes::AnnotationClass);
if (!isStruct) {
// TODO: Implement
return false;
}
Rooted<StructuredClass> strct = node.cast<StructuredClass>();
scope().setFlag(ParserFlag::POST_HEAD, true);
while (true) {
// Make sure the parent node is not the document
Rooted<Node> parentNode = scope().getLeaf();
if (parentNode->isa(&RttiTypes::Document)) {
logger().error(
"Tokens are not allowed on the root document level.");
return false;
}
assert(parentNode->isa(&RttiTypes::DocumentField));
// TODO: Move this to more generic method
// Fetch the parent document entity and the parent field index
size_t fieldIdx;
DocumentEntity *parent;
preamble(parentNode, fieldIdx, parent);
// Calculate a path if transparent entities are needed in between.
Rooted<FieldDescriptor> field =
parent->getDescriptor()->getFieldDescriptor(fieldIdx);
size_t lastFieldIdx = fieldIdx;
auto pathRes = field->pathTo(strct, logger());
if (!pathRes.second) {
// If we have transparent elements above us in the structure tree,
// try to unwind them before we give up.
if (scope().getLeaf().cast<DocumentField>()->transparent) {
// Pop the implicit field.
popDocumentField();
// Pop the implicit element.
scope().pop(logger());
continue;
}
throw LoggableException(
std::string("An instance of \"") + strct->getName() +
"\" is not allowed as child of field \"" +
field->getNameOrDefaultName() + "\" of descriptor \"" +
parent->getDescriptor()->getName() + "\"",
location());
}
// Create the path (if one is available)
if (!pathRes.first.empty()) {
createPath(lastFieldIdx, pathRes.first, parent);
lastFieldIdx = parent->getDescriptor()->getFieldDescriptorIndex();
}
// Create the entity for the new element at last.
Rooted<StructuredEntity> entity = parent->createChildStructuredEntity(
strct, lastFieldIdx, Variant::mapType{}, "");
// We're past the region in which explicit fields can be defined in the
// parent structure element
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, true);
// Push the entity onto the stack
entity->setLocation(location());
scope().push(entity);
pushScopeTokens();
return true;
}
}
DocumentChildHandler::EndTokenResult DocumentChildHandler::endToken(
const Token &token, Handle<Node> node)
{
// Iterate over the transparent elements in the scope stack
const NodeVector<Node> &stack = scope().getStack();
ssize_t depth = -1;
for (auto sit = stack.crbegin(); sit != stack.crend(); sit++, depth++) {
Rooted<Node> leaf = *sit;
if (leaf->isa(&RttiTypes::DocumentField)) {
Rooted<DocumentField> field = leaf.cast<DocumentField>();
if (field->getDescriptor() == node) {
// If the field is transparent, end it by incrementing the depth
// counter -- both the field itself and the consecutive element
// need to be removed
if (field->transparent) {
depth += 2;
break;
}
return EndTokenResult::ENDED_THIS;
}
// Abort if the field is explicit
if (!field->transparent) {
return EndTokenResult::ENDED_NONE;
}
}
if (leaf->isa(&RttiTypes::StructuredEntity)) {
Rooted<StructuredEntity> entity = leaf.cast<StructuredEntity>();
if (entity->getDescriptor() == node) {
// If the entity is transparent, end it by incrementing the
// depth counter and aborting
if (entity->isTransparent()) {
depth++;
break;
}
return EndTokenResult::ENDED_THIS;
}
// Abort if this entity is explicit
if (!entity->isTransparent()) {
return EndTokenResult::ENDED_NONE;
}
}
// TODO: End annotations!
}
// End all elements that were marked for being closed
for (ssize_t i = 0; i <= depth; i++) {
scope().pop(logger());
}
return (depth >= 0) ? EndTokenResult::ENDED_HIDDEN
: EndTokenResult::ENDED_NONE;
}
void DocumentChildHandler::end()
{
// Distinguish the handler type
switch (type()) {
case HandlerType::COMMAND:
case HandlerType::ANNOTATION_START:
case HandlerType::TOKEN:
if (!isExplicitField) {
// pop the "main" element.
scope().pop(logger());
} else {
// in case of explicit fields, roll back.
rollbackPath();
}
break;
case HandlerType::ANNOTATION_END:
// We have nothing to pop from the stack
break;
}
}
bool DocumentChildHandler::fieldStart(bool &isDefault, size_t fieldIdx)
{
if (isExplicitField) {
// In case of explicit fields we do not want to create another field.
isDefault = true;
return fieldIdx == 0;
}
Rooted<Node> parentNode = scope().getLeaf();
assert(parentNode->isa(&RttiTypes::StructuredEntity) ||
parentNode->isa(&RttiTypes::AnnotationEntity));
size_t dummy;
DocumentEntity *parent;
preamble(parentNode, dummy, parent);
NodeVector<FieldDescriptor> fields =
parent->getDescriptor()->getFieldDescriptors();
if (isDefault) {
if (fields.empty()) {
return false;
}
fieldIdx = fields.size() - 1;
} else {
if (fieldIdx >= fields.size()) {
return false;
}
isDefault = fieldIdx == fields.size() - 1;
}
// push the field on the stack.
pushDocumentField(parentNode, fields[fieldIdx], fieldIdx, false);
pushScopeTokens();
// Generally allow explicit fields in the new field
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, false);
return true;
}
void DocumentChildHandler::fieldEnd()
{
if (!isExplicitField) {
popTokens();
rollbackPath();
}
}
bool DocumentChildHandler::convertData(Handle<FieldDescriptor> field,
Variant &data, Logger &logger)
{
bool valid = true;
Rooted<Type> type = field->getPrimitiveType();
// If the content is supposed to be of type string, we only need to check
// for "magic" values -- otherwise just call the "parseGenericString"
// function on the string data
if (type->isa(&RttiTypes::StringType)) {
const std::string &str = data.asString();
// TODO: Referencing constants with "." separator should also work
if (Utils::isIdentifier(str)) {
data.markAsMagic();
}
} else {
// Parse the string as generic string, assign the result
auto res = VariantReader::parseGenericString(
data.asString(), logger, data.getLocation().getSourceId(),
data.getLocation().getStart());
data = res.second;
}
// Now try to resolve the value for the primitive type
return valid && scope().resolveValue(data, type, logger);
}
bool DocumentChildHandler::data()
{
// We're past the region in which explicit fields can be defined in the
// parent structure element
scope().setFlag(ParserFlag::POST_EXPLICIT_FIELDS, true);
Rooted<Node> parentField = scope().getLeaf();
assert(parentField->isa(&RttiTypes::DocumentField));
size_t fieldIdx;
DocumentEntity *parent;
preamble(parentField, fieldIdx, parent);
Rooted<Descriptor> desc = parent->getDescriptor();
// Retrieve the actual FieldDescriptor
Rooted<FieldDescriptor> field = desc->getFieldDescriptor(fieldIdx);
// If it is a primitive field directly, try to parse the content.
if (field->isPrimitive()) {
// Add it as primitive content.
Variant text = readData(); // TODO: Eliminate readData method
if (!convertData(field, text, logger())) {
return false;
}
parent->createChildDocumentPrimitive(text, fieldIdx);
return true;
}
// Search through all permitted default fields of the parent class that
// allow primitive content at this point and could be constructed via
// transparent intermediate entities.
NodeVector<FieldDescriptor> defaultFields = field->getDefaultFields();
// Try to parse the data using the type specified by the respective field.
// If that does not work we proceed to the next possible field.
std::vector<LoggerFork> forks;
for (auto primitiveField : defaultFields) {
// Then try to parse the content using the type specification.
forks.emplace_back(logger().fork());
// Try to parse the data
Variant text = readData(); // TODO: Eliminate readData method
if (!convertData(primitiveField, text, forks.back())) {
continue;
}
// The conversion worked, commit any possible warnings
forks.back().commit();
// Construct the necessary path
NodeVector<Node> path = field->pathTo(primitiveField, logger());
createPath(fieldIdx, path, parent);
// Then create the primitive element
parent->createChildDocumentPrimitive(text);
return true;
}
// No field was found that might take the data -- dump the error messages
// from the loggers -- or, if there were no primitive fields, clearly state
// this fact
Variant text = readData();
if (defaultFields.empty()) {
logger().error("Got data, but field \"" +
field->getNameOrDefaultName() +
"\" of structure \"" + name() +
"\" does not have any primitive field",
text);
} else {
logger().error("Could not read data with any of the possible fields:",
text);
size_t f = 0;
for (auto field : defaultFields) {
logger().note(std::string("Field ") +
Utils::join(field->path(), ".") +
std::string(":"),
SourceLocation{}, MessageMode::NO_CONTEXT);
forks[f].commit();
f++;
}
}
return false;
}
namespace States {
const State Document = StateBuilder()
.parent(&None)
.createdNodeType(&RttiTypes::Document)
.elementHandler(DocumentHandler::create)
.arguments({Argument::String("name", "")});
const State DocumentChild = StateBuilder()
.parents({&Document, &DocumentChild})
.createdNodeTypes({&RttiTypes::StructureNode,
&RttiTypes::AnnotationEntity,
&RttiTypes::DocumentField})
.elementHandler(DocumentChildHandler::create)
.supportsAnnotations(true)
.supportsTokens(true);
}
}
namespace RttiTypes {
const Rtti DocumentField = RttiBuilder<ousia::parser_stack::DocumentField>(
"DocumentField").parent(&Node);
}
}
|