-
Notifications
You must be signed in to change notification settings - Fork 47
/
DefBlockSyntaxParser.h
887 lines (739 loc) · 24 KB
/
DefBlockSyntaxParser.h
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
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
#pragma once
#include <memory>
#include <vector>
#include <algorithm>
#include "string/tokeniser.h"
#include "string/join.h"
#include "string/trim.h"
namespace parser
{
// A snippet of the source text
// Can be strings, whitespace or comments
struct DefSyntaxToken
{
enum class Type
{
Nothing,
Whitespace,
BracedBlock, // starting with { and *maybe* ending with }
Token,
EolComment,
BlockComment,
};
// Token type
Type type;
// The raw string as parsed from the source text
std::string value;
DefSyntaxToken() :
DefSyntaxToken(Type::Nothing, "")
{}
DefSyntaxToken(Type type_, const std::string& value_) :
type(type_),
value(value_)
{}
void clear()
{
type = Type::Nothing;
value.clear();
}
};
// Represents an element of a parsed syntax tree.
// Each node can have 0 or more child nodes, grouping them
// into a meaningful structure.
class DefSyntaxNode
{
public:
using Ptr = std::shared_ptr<DefSyntaxNode>;
enum class Type
{
Root,
Whitespace,
Comment,
DeclType,
DeclName,
DeclBlock,
};
private:
// All child nodes of this node
std::vector<Ptr> _children;
Type _type;
public:
DefSyntaxNode(Type type) :
_type(type)
{}
Type getType() const
{
return _type;
}
const std::vector<Ptr>& getChildren() const
{
return _children;
}
void appendChildNode(Ptr&& node)
{
_children.emplace_back(node);
}
void removeChildNode(const Ptr& node)
{
auto existing = std::find(_children.begin(), _children.end(), node);
if (existing != _children.end())
{
_children.erase(existing);
}
}
virtual std::string getString() const
{
std::string value;
value.reserve(getChildren().size() * 10);
for (const auto& child : getChildren())
{
value += child->getString();
}
return value;
}
};
class DefWhitespaceSyntax :
public DefSyntaxNode
{
private:
DefSyntaxToken _token;
public:
using Ptr = std::shared_ptr<DefWhitespaceSyntax>;
DefWhitespaceSyntax(const DefSyntaxToken& token) :
DefSyntaxNode(Type::Whitespace),
_token(token)
{
assert(token.type == DefSyntaxToken::Type::Whitespace);
}
// Returns the number of line breaks this whitespace contains
std::size_t getNumberOfLineBreaks()
{
return std::count_if(_token.value.begin(), _token.value.end(), [](char c) { return c == '\n'; });
}
std::string getString() const override
{
return _token.value;
}
static Ptr Create(const std::string& whitespace)
{
return std::make_shared<DefWhitespaceSyntax>(
DefSyntaxToken(DefSyntaxToken::Type::Whitespace, whitespace)
);
}
};
class DefCommentSyntax :
public DefSyntaxNode
{
private:
DefSyntaxToken _token;
public:
DefCommentSyntax(const DefSyntaxToken& token) :
DefSyntaxNode(Type::Comment),
_token(token)
{
assert(token.type == DefSyntaxToken::Type::BlockComment || token.type == DefSyntaxToken::Type::EolComment);
}
std::string getString() const override
{
return _token.value;
}
};
class DefTypeSyntax :
public DefSyntaxNode
{
private:
DefSyntaxToken _token;
public:
using Ptr = std::shared_ptr<DefTypeSyntax>;
DefTypeSyntax(const DefSyntaxToken& token) :
DefSyntaxNode(Type::DeclType),
_token(token)
{
assert(token.type == DefSyntaxToken::Type::Token);
}
const DefSyntaxToken& getToken() const
{
return _token;
}
std::string getString() const override
{
return _token.value;
}
static Ptr Create(const std::string& typeName)
{
return std::make_shared<DefTypeSyntax>(
DefSyntaxToken(DefSyntaxToken::Type::Token, typeName)
);
}
};
class DefNameSyntax :
public DefSyntaxNode
{
private:
DefSyntaxToken _token;
public:
using Ptr = std::shared_ptr<DefNameSyntax>;
DefNameSyntax(const DefSyntaxToken& token) :
DefSyntaxNode(Type::DeclName),
_token(token)
{
assert(token.type == DefSyntaxToken::Type::Token);
}
const DefSyntaxToken& getToken() const
{
return _token;
}
std::string getString() const override
{
return _token.value;
}
static Ptr Create(const std::string& name)
{
return std::make_shared<DefNameSyntax>(
DefSyntaxToken(DefSyntaxToken::Type::Token, name)
);
}
};
class DefBlockSyntax :
public DefSyntaxNode
{
private:
DefSyntaxToken _blockToken;
std::vector<DefSyntaxNode::Ptr> _headerNodes;
DefTypeSyntax::Ptr _type;
DefNameSyntax::Ptr _name;
public:
using Ptr = std::shared_ptr<DefBlockSyntax>;
DefBlockSyntax(const DefSyntaxToken& blockToken, std::vector<DefSyntaxNode::Ptr>&& headerNodes,
int nameIndex = -1, int typeIndex = -1) :
DefSyntaxNode(Type::DeclBlock),
_blockToken(blockToken),
_headerNodes(headerNodes)
{
assert(_blockToken.type == DefSyntaxToken::Type::BracedBlock);
assert(nameIndex >= 0);
if (nameIndex != -1)
{
_name = std::static_pointer_cast<DefNameSyntax>(_headerNodes.at(nameIndex));
}
if (typeIndex != -1)
{
_type = std::static_pointer_cast<DefTypeSyntax>(_headerNodes.at(typeIndex));
}
}
// Returns the type identifier of this block (can be empty)
const DefTypeSyntax::Ptr& getType() const
{
return _type;
}
// Returns the name identifier of this block (can be empty)
const DefNameSyntax::Ptr& getName() const
{
return _name;
}
// Returns the raw block contents without the opening and closing braces
std::string getBlockContents() const
{
return string::trim_copy(_blockToken.value, "{}");
}
// Sets the raw block contents without the opening and closing braces
void setBlockContents(const std::string& contents)
{
_blockToken.value = "{" + contents + "}";
}
std::string getString() const override
{
std::string output;
output.reserve(_blockToken.value.size() + _headerNodes.size() * 50);
for (const auto& headerNode : _headerNodes)
{
if (!headerNode) continue;
output.append(headerNode->getString());
}
output.append(_blockToken.value);
return output;
}
static Ptr CreateTypedBlock(const std::string& type, const std::string& name)
{
std::vector<DefSyntaxNode::Ptr> headerNodes;
int typeIndex = -1;
if (!type.empty())
{
typeIndex = static_cast<int>(headerNodes.size());
headerNodes.emplace_back(DefTypeSyntax::Create(type));
headerNodes.emplace_back(DefWhitespaceSyntax::Create(" "));
}
int nameIndex = static_cast<int>(headerNodes.size());
headerNodes.emplace_back(DefNameSyntax::Create(name));
headerNodes.emplace_back(DefWhitespaceSyntax::Create("\n"));
DefSyntaxToken blockToken(DefSyntaxToken::Type::BracedBlock, "{}");
return std::make_shared<DefBlockSyntax>(blockToken, std::move(headerNodes), nameIndex, typeIndex);
}
};
class DefSyntaxTree
{
private:
DefSyntaxNode::Ptr _root;
public:
using Ptr = std::shared_ptr<DefSyntaxTree>;
DefSyntaxTree() :
_root(std::make_shared<DefSyntaxNode>(DefSyntaxNode::Type::Root))
{}
const DefSyntaxNode::Ptr& getRoot()
{
return _root;
}
void foreachBlock(const std::function<void(const DefBlockSyntax::Ptr&)>& functor)
{
for (const auto& node : getRoot()->getChildren())
{
if (node->getType() != DefSyntaxNode::Type::DeclBlock) continue;
auto blockNode = std::static_pointer_cast<DefBlockSyntax>(node);
functor(blockNode);
}
}
// Return the first block syntax node matching the given name (case-sensitive)
parser::DefBlockSyntax::Ptr findFirstNamedBlock(const std::string& name)
{
return findFirstBlock([&](const parser::DefBlockSyntax::Ptr& block)
{
return block->getName() && block->getName()->getString() == name;
});
}
// Find the first block matching the given predicate
parser::DefBlockSyntax::Ptr findFirstBlock(const std::function<bool(const parser::DefBlockSyntax::Ptr&)>& predicate)
{
parser::DefBlockSyntax::Ptr result;
foreachBlock([&](const parser::DefBlockSyntax::Ptr& block)
{
if (!result && predicate(block))
{
result = block;
}
});
return result;
}
std::string getString() const
{
return _root->getString();
}
};
/**
* Stateless tokeniser function cutting the incoming character range into
* qualified DefSyntaxTokens, returning one token at a time.
*/
class DefBlockSyntaxTokeniserFunc
{
// Enumeration of states
enum class State
{
Searching, // haven't found anything yet
Whitespace, // on whitespace
Token, // non-whitespace, non-control character
BracedBlock, // within a braced block
QuotedStringWithinBlock, // within a quoted string within a block
BlockComment, // within a /* block comment */
EolComment, // on an EOL comment starting with //
} _state;
constexpr static const char* const Delims = " \t\n\v\r";
constexpr static char OpeningBrace = '{';
constexpr static char ClosingBrace = '}';
static bool IsWhitespace(char c)
{
for (const char* curDelim = Delims; *curDelim != 0; ++curDelim)
{
if (*curDelim == c) return true;
}
return false;
}
public:
DefBlockSyntaxTokeniserFunc() :
_state(State::Searching)
{}
/**
* REQUIRED by the string::Tokeniser. The operator() will be invoked by the Tokeniser.
* This function must search for a token between the two iterators next and end, and if
* a token is found, set tok to the token, set next to position to start
* parsing on the next call, and return true. The function will return false,
* meaning it didn't find anything before reaching the end iterator.
*/
template<typename InputIterator>
bool operator() (InputIterator& next, const InputIterator& end, DefSyntaxToken& tok)
{
// Initialise state, no persistence between calls
_state = State::Searching;
// Clear out the token, no guarantee that it is empty
tok.clear();
std::size_t openedBlocks = 0;
while (next != end)
{
char ch = *next;
switch (_state)
{
case State::Searching:
if (IsWhitespace(ch))
{
_state = State::Whitespace;
tok.type = DefSyntaxToken::Type::Whitespace;
tok.value += ch;
++next;
continue;
}
if (ch == OpeningBrace)
{
_state = State::BracedBlock;
tok.type = DefSyntaxToken::Type::BracedBlock;
tok.value += ch;
openedBlocks = 1;
++next;
continue;
}
if (ch == '/')
{
// Token type not yet determined switch to forward slash mode
tok.value += ch;
++next;
// Check the next character, it determines what we have
if (next != end)
{
if (*next == '*')
{
_state = State::BlockComment;
tok.type = DefSyntaxToken::Type::BlockComment;
tok.value += '*';
++next;
continue;
}
if (*next == '/')
{
_state = State::EolComment;
tok.type = DefSyntaxToken::Type::EolComment;
tok.value += '/';
++next;
continue;
}
}
}
tok.type = DefSyntaxToken::Type::Token;
_state = State::Token;
tok.value += ch;
++next;
continue;
case State::BracedBlock:
// Add the character and advance in any case
tok.value += ch;
++next;
// Check for another opening brace
if (ch == OpeningBrace)
{
// another block within this block, ignore this
++openedBlocks;
}
else if (ch == ClosingBrace && --openedBlocks == 0)
{
// End of block content, we're done here
return true;
}
else if (ch == '"')
{
// An opening quote within the braced block, switch to a special block
// ignoring any control characters within that string
_state = State::QuotedStringWithinBlock;
}
continue;
case State::QuotedStringWithinBlock:
// Add the character and advance over anything
tok.value += ch;
++next;
if (ch == '"')
{
_state = State::BracedBlock;
}
continue;
case State::Whitespace:
if (IsWhitespace(ch))
{
tok.value += ch;
++next;
continue;
}
// Ran out of whitespace, return token
return true;
case State::BlockComment:
// Inside a delimited comment, we add everything to the token
// and check for the "*/" sequence.
tok.value += ch;
++next;
// If we just added an asterisk, check if we hit the end
if (ch == '*' && next != end && *next == '/')
{
// Add the slash and close this block comment
tok.value += '/';
++next;
return true;
}
continue; // carry on
case State::EolComment:
// This comment lasts until the end of the line.
if (ch == '\r' || ch == '\n')
{
// Stop here, leave next where it is
return true;
}
// Add to comment and continue
tok.value += ch;
++next;
continue;
case State::Token:
assert(!tok.value.empty());
if (ch == OpeningBrace || ch == ClosingBrace)
{
// Finalise the token and leave next where it is
return true;
}
else if (ch == '/')
{
auto nextChar = next != end ? next.peek() : '\0';
// Check for a block comment
if (nextChar == '*' || nextChar == '/')
{
// This ends our token
return true;
}
// Not starting a comment, continue
tok.value += ch;
++next;
continue;
}
else if (IsWhitespace(ch))
{
// Whitespace terminates our token
return true;
}
tok.value += ch;
++next;
continue;
}
}
// Return true if we have found a non-empty token
return !tok.value.empty();
}
};
namespace detail
{
// Traits class to retrieve the correct iterators for a given container type
template<typename ContainerType> struct SyntaxParserTraits
{};
// Specialisation on const std::string inputs
template<>
struct SyntaxParserTraits<const std::string>
{
struct StringIteratorAdapter
{
const std::string& container;
std::string::const_iterator wrapped;
StringIteratorAdapter(const std::string& container_, const std::string::const_iterator& iter) :
container(container_),
wrapped(iter)
{}
StringIteratorAdapter& operator++()
{
++wrapped;
return *this;
}
StringIteratorAdapter operator++(int) noexcept
{
StringIteratorAdapter temp = *this;
++(*this);
return temp;
}
char operator*() const
{
return *wrapped;
}
char peek() const
{
if (wrapped == container.end()) return '\0';
std::string::const_iterator copy = wrapped;
++copy;
return copy != container.end() ? *copy : '\0';
}
bool operator==(const StringIteratorAdapter& other) const
{
return wrapped == other.wrapped;
}
bool operator!=(const StringIteratorAdapter& other) const
{
return !(operator==(other));
}
};
typedef StringIteratorAdapter Iterator;
static Iterator GetStartIterator(const std::string& str)
{
return StringIteratorAdapter(str, str.begin());
}
static Iterator GetEndIterator(const std::string& str)
{
return StringIteratorAdapter(str, str.end());
}
};
// Specialisation on std::istream inputs
template<>
struct SyntaxParserTraits<std::istream>
{
struct StreamIteratorAdapter
{
std::istream& stream;
std::istream_iterator<char> wrapped;
StreamIteratorAdapter(std::istream& stream_, std::istream_iterator<char> iter) :
stream(stream_),
wrapped(iter)
{}
StreamIteratorAdapter(const StreamIteratorAdapter& other) :
stream(other.stream),
wrapped(other.wrapped)
{}
StreamIteratorAdapter& operator++()
{
++wrapped;
return *this;
}
StreamIteratorAdapter operator++(int) noexcept
{
StreamIteratorAdapter temp(*this);
++(*this);
return temp;
}
char operator*() const
{
return *wrapped;
}
char peek() const
{
return static_cast<char>(stream.peek());
}
bool operator==(const StreamIteratorAdapter& other) const
{
return wrapped == other.wrapped;
}
bool operator!=(const StreamIteratorAdapter& other) const
{
return !(operator==(other));
}
};
typedef StreamIteratorAdapter Iterator;
static Iterator GetStartIterator(std::istream& str)
{
str >> std::noskipws;
return StreamIteratorAdapter(str, std::istream_iterator<char>(str));
}
static Iterator GetEndIterator(std::istream& str)
{
return StreamIteratorAdapter(str, std::istream_iterator<char>());
}
};
}
/**
* Parses and cuts decl file contents into a syntax tree.
* Every syntax tree has a root node with 0..N children.
*/
template<typename ContainerType>
class DefBlockSyntaxParser
{
public:
// Internal tokeniser and its iterator
using Tokeniser = string::Tokeniser<DefBlockSyntaxTokeniserFunc,
typename detail::SyntaxParserTraits<ContainerType>::Iterator, DefSyntaxToken>;
private:
Tokeniser _tok;
typename Tokeniser::Iterator _tokIter;
public:
DefBlockSyntaxParser(ContainerType& str) :
_tok(detail::SyntaxParserTraits<ContainerType>::GetStartIterator(str),
detail::SyntaxParserTraits<ContainerType>::GetEndIterator(str),
DefBlockSyntaxTokeniserFunc()),
_tokIter(_tok.getIterator())
{}
// Parse the text stored in the container into a def syntax tree
// The returned syntax tree reference is never null
DefSyntaxTree::Ptr parse()
{
auto syntaxTree = std::make_shared<DefSyntaxTree>();
while (!_tokIter.isExhausted())
{
auto token = *_tokIter;
switch (token.type)
{
case DefSyntaxToken::Type::BlockComment:
case DefSyntaxToken::Type::EolComment:
syntaxTree->getRoot()->appendChildNode(std::make_shared<DefCommentSyntax>(token));
++_tokIter;
break;
case DefSyntaxToken::Type::Whitespace:
syntaxTree->getRoot()->appendChildNode(std::make_shared<DefWhitespaceSyntax>(token));
++_tokIter;
break;
case DefSyntaxToken::Type::BracedBlock:
rWarning() << "Unnamed block encountered: " << token.value << std::endl;
syntaxTree->getRoot()->appendChildNode(std::make_shared<DefBlockSyntax>(token, std::vector<DefSyntaxNode::Ptr>()));
++_tokIter;
break;
case DefSyntaxToken::Type::Token:
syntaxTree->getRoot()->appendChildNode(parseBlock());
break;
}
}
return syntaxTree;
}
private:
DefBlockSyntax::Ptr parseBlock()
{
std::vector<DefSyntaxNode::Ptr> headerNodes;
DefBlockSyntax::Ptr block;
int nameIndex = -1;
int typeIndex = -1;
// Check the next token
while (!block && !_tokIter.isExhausted())
{
auto token = *_tokIter++;
switch (token.type)
{
case DefSyntaxToken::Type::BlockComment:
case DefSyntaxToken::Type::EolComment:
headerNodes.push_back(std::make_shared<DefCommentSyntax>(token));
break;
case DefSyntaxToken::Type::Whitespace:
headerNodes.push_back(std::make_shared<DefWhitespaceSyntax>(token));
break;
case DefSyntaxToken::Type::BracedBlock:
// The braced block token concludes this decl block
block = std::make_shared<DefBlockSyntax>(token, std::move(headerNodes), nameIndex, typeIndex);
break;
case DefSyntaxToken::Type::Token:
if (nameIndex == -1)
{
// No name yet, assume this is the name
nameIndex = static_cast<int>(headerNodes.size());
headerNodes.emplace_back(std::make_shared<DefNameSyntax>(token));
continue;
}
// We already got a first string token, check if this is the second
if (typeIndex == -1)
{
// The first one is the type, change the node type
typeIndex = nameIndex;
auto oldName = std::static_pointer_cast<DefNameSyntax>(headerNodes.at(typeIndex));
headerNodes.at(typeIndex) = std::make_shared<DefTypeSyntax>(oldName->getToken());
// Append the name to the end of the vector
nameIndex = static_cast<int>(headerNodes.size());
headerNodes.emplace_back(std::make_shared<DefNameSyntax>(token));
continue;
}
rWarning() << "Invalid number of decl block headers, already got a name and type" << std::endl;
break;
}
}
return block;
}
};
}