scanner.cpp 13.2 KB
Newer Older
beder's avatar
beder committed
1
2
#include "scanner.h"
#include "token.h"
beder's avatar
beder committed
3
#include "exceptions.h"
beder's avatar
beder committed
4
#include <iostream>
beder's avatar
beder committed
5
6
7
8

namespace YAML
{
	Scanner::Scanner(std::istream& in)
9
		: INPUT(in), m_startedStream(false), m_endedStream(false), m_simpleKeyAllowed(false), m_flowLevel(0), m_column(0)
beder's avatar
beder committed
10
11
12
13
14
	{
	}

	Scanner::~Scanner()
	{
beder's avatar
beder committed
15
16
17
18
19
20
21
22
		while(!m_tokens.empty()) {
			delete m_tokens.front();
			m_tokens.pop();
		}

		// delete limbo tokens (they're here for RAII)
		for(std::set <Token *>::const_iterator it=m_limboTokens.begin();it!=m_limboTokens.end();++it)
			delete *it;
beder's avatar
beder committed
23
24
25
26
27
28
29
30
31
32
	}

	///////////////////////////////////////////////////////////////////////
	// Misc. helpers

	// GetChar
	// . Extracts a character from the stream and updates our position
	char Scanner::GetChar()
	{
		m_column++;
33
34
35
36
		char ch = INPUT.get();
		if(ch == '\n')
			m_column = 0;
		return ch;
beder's avatar
beder committed
37
38
	}

beder's avatar
beder committed
39
40
41
	// Eat
	// . Eats 'n' characters and updates our position.
	void Scanner::Eat(int n)
beder's avatar
beder committed
42
	{
beder's avatar
beder committed
43
44
45
46
47
48
		for(int i=0;i<n;i++) {
			m_column++;
			char ch = INPUT.get();
			if(ch == '\n')
				m_column = 0;
		}
beder's avatar
beder committed
49
50
	}

beder's avatar
beder committed
51
52
53
	// Peek
	// . Peeks at the next 'n' characters and returns them in a string.
	std::string Scanner::Peek(int n)
beder's avatar
beder committed
54
	{
beder's avatar
beder committed
55
56
		std::string ret;

57
58
		int pos = INPUT.tellg();
		for(int i=0;i<n;i++)
beder's avatar
beder committed
59
60
			ret += INPUT.get();

61
62
		INPUT.clear();
		INPUT.seekg(pos);
beder's avatar
beder committed
63
64

		return ret;
beder's avatar
beder committed
65
66
	}

beder's avatar
beder committed
67
	// GetLineBreak
beder's avatar
beder committed
68
	// . Eats with no checking
beder's avatar
beder committed
69
	void Scanner::EatLineBreak()
beder's avatar
beder committed
70
	{
beder's avatar
beder committed
71
72
		Eat(1);
		m_column = 0;
beder's avatar
beder committed
73
74
75
76
77
78
79
80
81
	}

	// IsWhitespaceToBeEaten
	// . We can eat whitespace if:
	//   1. It's a space
	//   2. It's a tab, and we're either:
	//      a. In the flow context
	//      b. In the block context but not where a simple key could be allowed
	//         (i.e., not at the beginning of a line, or following '-', '?', or ':')
beder's avatar
beder committed
82
	bool Scanner::IsWhitespaceToBeEaten(char ch)
beder's avatar
beder committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
	{
		if(ch == ' ')
			return true;

		if(ch == '\t' && (m_flowLevel >= 0 || !m_simpleKeyAllowed))
			return true;

		return false;
	}

	// IsDocumentStart
	bool Scanner::IsDocumentStart()
	{
		// needs to be at the start of a new line
		if(m_column != 0)
			return false;

100
		return Exp::DocStart.Matches(Peek(4));
beder's avatar
beder committed
101
102
103
104
105
106
107
108
109
	}

	// IsDocumentEnd
	bool Scanner::IsDocumentEnd()
	{
		// needs to be at the start of a new line
		if(m_column != 0)
			return false;

110
		return Exp::DocEnd.Matches(Peek(4));
beder's avatar
beder committed
111
112
	}

beder's avatar
beder committed
113
114
115
	// IsBlockEntry
	bool Scanner::IsBlockEntry()
	{
116
		return Exp::BlockEntry.Matches(Peek(2));
beder's avatar
beder committed
117
118
119
120
121
	}

	// IsKey
	bool Scanner::IsKey()
	{
beder's avatar
beder committed
122
		std::string next = Peek(2);
123
124
125
		if(m_flowLevel > 0)
			return Exp::KeyInFlow.Matches(next);
		return Exp::Key.Matches(next);
beder's avatar
beder committed
126
127
128
129
130
	}

	// IsValue
	bool Scanner::IsValue()
	{
beder's avatar
beder committed
131
		std::string next = Peek(2);
132
133
134
		if(m_flowLevel > 0)
			return Exp::ValueInFlow.Matches(next);
		return Exp::Value.Matches(next);
beder's avatar
beder committed
135
136
137
138
139
140
	}

	// IsPlainScalar
	// . Rules:
	bool Scanner::IsPlainScalar()
	{
beder's avatar
beder committed
141
		std::string next = Peek(2);
142
143
144
		if(m_flowLevel > 0)
			return Exp::PlainScalarInFlow.Matches(next);
		return Exp::PlainScalar.Matches(next);
beder's avatar
beder committed
145
146
	}

beder's avatar
beder committed
147
148
149
	///////////////////////////////////////////////////////////////////////
	// Specialization for scanning specific tokens

beder's avatar
beder committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
	// ScanAndEnqueue
	// . Scans the token, then pushes it in the queue.
	// . Note: we also use a set of "limbo tokens", i.e., tokens
	//   that haven't yet been pushed. This way, if ScanToken()
	//   throws an exception, we'll be keeping track of 'pToken'
	//   somewhere, and it will be automatically cleaned up when
	//   the Scanner destructs.
	template <typename T> void Scanner::ScanAndEnqueue(T *pToken)
	{
		m_limboTokens.insert(pToken);
		m_tokens.push(ScanToken(pToken));
		m_limboTokens.erase(pToken);
	}

beder's avatar
beder committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
	// StreamStartToken
	template <> StreamStartToken *Scanner::ScanToken(StreamStartToken *pToken)
	{
		m_startedStream = true;
		m_simpleKeyAllowed = true;
		m_indents.push(-1);

		return pToken;
	}

	// StreamEndToken
	template <> StreamEndToken *Scanner::ScanToken(StreamEndToken *pToken)
	{
		// force newline
		if(m_column > 0)
			m_column = 0;

beder's avatar
beder committed
181
		PopIndentTo(-1);
beder's avatar
beder committed
182
183
184
		// TODO: "reset simple keys"

		m_simpleKeyAllowed = false;
185
		m_endedStream = true;
beder's avatar
beder committed
186
187
188
189
190
191
192

		return pToken;
	}

	// DocumentStartToken
	template <> DocumentStartToken *Scanner::ScanToken(DocumentStartToken *pToken)
	{
beder's avatar
beder committed
193
194
		PopIndentTo(m_column);
		// TODO: "reset simple keys"
beder's avatar
beder committed
195
196
197

		m_simpleKeyAllowed = false;

beder's avatar
beder committed
198
199
		// eat
		Eat(3);
beder's avatar
beder committed
200
201
202
203
204
205
		return pToken;
	}

	// DocumentEndToken
	template <> DocumentEndToken *Scanner::ScanToken(DocumentEndToken *pToken)
	{
206
		PopIndentTo(-1);
beder's avatar
beder committed
207
		// TODO: "reset simple keys"
beder's avatar
beder committed
208
209
210

		m_simpleKeyAllowed = false;

beder's avatar
beder committed
211
212
		// eat
		Eat(3);
beder's avatar
beder committed
213
214
215
		return pToken;
	}

beder's avatar
beder committed
216
217
218
219
220
221
222
223
	// FlowSeqStartToken
	template <> FlowSeqStartToken *Scanner::ScanToken(FlowSeqStartToken *pToken)
	{
		// TODO: "save simple key"
		// TODO: increase flow level

		m_simpleKeyAllowed = true;

224
225
		// eat
		Eat(1);
beder's avatar
beder committed
226
227
228
229
230
231
232
233
234
235
236
		return pToken;
	}

	// FlowMapStartToken
	template <> FlowMapStartToken *Scanner::ScanToken(FlowMapStartToken *pToken)
	{
		// TODO: "save simple key"
		// TODO: increase flow level

		m_simpleKeyAllowed = true;

237
238
		// eat
		Eat(1);
beder's avatar
beder committed
239
240
241
242
243
244
245
246
247
248
249
		return pToken;
	}

	// FlowSeqEndToken
	template <> FlowSeqEndToken *Scanner::ScanToken(FlowSeqEndToken *pToken)
	{
		// TODO: "remove simple key"
		// TODO: decrease flow level

		m_simpleKeyAllowed = false;

250
251
		// eat
		Eat(1);
beder's avatar
beder committed
252
253
254
255
256
257
258
259
260
261
262
		return pToken;
	}

	// FlowMapEndToken
	template <> FlowMapEndToken *Scanner::ScanToken(FlowMapEndToken *pToken)
	{
		// TODO: "remove simple key"
		// TODO: decrease flow level

		m_simpleKeyAllowed = false;

263
264
		// eat
		Eat(1);
beder's avatar
beder committed
265
266
267
268
269
270
271
272
273
274
		return pToken;
	}

	// FlowEntryToken
	template <> FlowEntryToken *Scanner::ScanToken(FlowEntryToken *pToken)
	{
		// TODO: "remove simple key"

		m_simpleKeyAllowed = true;

275
276
		// eat
		Eat(1);
beder's avatar
beder committed
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
		return pToken;
	}

	// BlockEntryToken
	template <> BlockEntryToken *Scanner::ScanToken(BlockEntryToken *pToken)
	{
		// we better be in the block context!
		if(m_flowLevel == 0) {
			// can we put it here?
			if(!m_simpleKeyAllowed)
				throw IllegalBlockEntry();

			PushIndentTo(m_column, true);	// , -1
		} else {
			// TODO: throw?
		}

		// TODO: "remove simple key"

		m_simpleKeyAllowed = true;

		// eat
beder's avatar
beder committed
299
		Eat(1);
beder's avatar
beder committed
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
		return pToken;
	}

	// KeyToken
	template <> KeyToken *Scanner::ScanToken(KeyToken *pToken)
	{
		// are we in block context?
		if(m_flowLevel == 0) {
			if(!m_simpleKeyAllowed)
				throw IllegalMapKey();

			PushIndentTo(m_column, false);
		}

		// TODO: "remove simple key"

		// can only put a simple key here if we're in block context
		if(m_flowLevel == 0)
			m_simpleKeyAllowed = true;
		else
			m_simpleKeyAllowed = false;

		// eat
beder's avatar
beder committed
323
		Eat(1);
beder's avatar
beder committed
324
325
326
327
328
329
330
331
332
		return pToken;
	}

	// ValueToken
	template <> ValueToken *Scanner::ScanToken(ValueToken *pToken)
	{
		// TODO: Is it a simple key?
		if(false) {
		} else {
beder's avatar
beder committed
333
334
335
336
337
338
339
340
341
342
			// If not, ...
			// are we in block context?
			if(m_flowLevel == 0) {
				if(!m_simpleKeyAllowed)
					throw IllegalMapValue();

				PushIndentTo(m_column, false);
			}
		}

beder's avatar
beder committed
343
344
345
346
		// can only put a simple key here if we're in block context
		if(m_flowLevel == 0)
			m_simpleKeyAllowed = true;
		else
beder's avatar
beder committed
347
348
349
350
			m_simpleKeyAllowed = false;

		// eat
		Eat(1);
beder's avatar
beder committed
351
352
353
354
355
		return pToken;
	}

	// PlainScalarToken
	template <> PlainScalarToken *Scanner::ScanToken(PlainScalarToken *pToken)
beder's avatar
beder committed
356
357
358
359
360
361
	{
		// TODO: "save simple key"

		m_simpleKeyAllowed = false;

		// now eat and store the scalar
362
363
		std::string scalar, whitespace, leadingBreaks, trailingBreaks;
		bool leadingBlanks = false;
beder's avatar
beder committed
364
365
366
367
368
369
370

		while(INPUT) {
			// doc start/end tokens
			if(IsDocumentStart() || IsDocumentEnd())
				break;

			// comment
371
			if(Exp::Comment.Matches(INPUT.peek()))
beder's avatar
beder committed
372
373
374
				break;

			// first eat non-blanks
375
			while(INPUT && !Exp::BlankOrBreak.Matches(INPUT.peek())) {
beder's avatar
beder committed
376
377
378
				std::string next = Peek(2);

				// illegal colon in flow context
379
380
				if(m_flowLevel > 0 && Exp::IllegalColonInScalar.Matches(next))
					throw IllegalScalar();
beder's avatar
beder committed
381
382

				// characters that might end the scalar
383
				if(m_flowLevel > 0 && Exp::EndScalarInFlow.Matches(next))
beder's avatar
beder committed
384
					break;
385
				if(m_flowLevel == 0 && Exp::EndScalar.Matches(next))
beder's avatar
beder committed
386
387
					break;

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
				if(leadingBlanks) {
					if(!leadingBreaks.empty() && leadingBreaks[0] == '\n') {
						// fold line break?
						if(trailingBreaks.empty())
							scalar += ' ';
						else {
							scalar += trailingBreaks;
							trailingBreaks = "";
						}
					} else {
						scalar += leadingBreaks + trailingBreaks;
						leadingBreaks = "";
						trailingBreaks = "";
					}
				} else if(!whitespace.empty()) {
					scalar += whitespace;
					whitespace = "";
				}

				// finally, read the character!
beder's avatar
beder committed
408
409
410
				scalar += GetChar();
			}

411
412
413
414
			// did we hit a non-blank character that ended us?
			if(!Exp::BlankOrBreak.Matches(INPUT.peek()))
				break;

beder's avatar
beder committed
415
			// now eat blanks
416
417
			while(INPUT && Exp::BlankOrBreak.Matches(INPUT.peek())) {
				if(Exp::Blank.Matches(INPUT.peek())) {
beder's avatar
beder committed
418
419
420
					if(leadingBlanks && m_column <= m_indents.top())
						throw IllegalTabInScalar();

421
422
423
424
425
					// maybe store this character
					if(!leadingBlanks)
						whitespace += GetChar();
					else
						Eat(1);
beder's avatar
beder committed
426
				} else {
427
428
429
430
431
432
433
					// where to store this character?
					if(!leadingBlanks) {
						leadingBlanks = true;
						whitespace = "";
						leadingBreaks += GetChar();
					} else
						trailingBreaks += GetChar();
beder's avatar
beder committed
434
435
436
437
438
439
440
441
442
				}
			}

			// and finally break if we're below the indentation level
			if(m_flowLevel == 0 && m_column <= m_indents.top())
				break;
		}

		// now modify our token
443
		pToken->SetValue(scalar);
beder's avatar
beder committed
444
445
446
		if(leadingBlanks)
			m_simpleKeyAllowed = true;

beder's avatar
beder committed
447
448
449
		return pToken;
	}

beder's avatar
beder committed
450
451
452
	///////////////////////////////////////////////////////////////////////
	// The main scanning function

beder's avatar
beder committed
453
	void Scanner::ScanNextToken()
beder's avatar
beder committed
454
	{
455
456
457
		if(m_endedStream)
			return;

beder's avatar
beder committed
458
		if(!m_startedStream)
beder's avatar
beder committed
459
			return ScanAndEnqueue(new StreamStartToken);
beder's avatar
beder committed
460
461
462

		ScanToNextToken();
		// TODO: remove "obsolete potential simple keys"
beder's avatar
beder committed
463
		PopIndentTo(m_column);
beder's avatar
beder committed
464
465

		if(INPUT.peek() == EOF)
beder's avatar
beder committed
466
			return ScanAndEnqueue(new StreamEndToken);
beder's avatar
beder committed
467

beder's avatar
beder committed
468
		// are we at a document token?
beder's avatar
beder committed
469
		if(IsDocumentStart())
beder's avatar
beder committed
470
			return ScanAndEnqueue(new DocumentStartToken);
beder's avatar
beder committed
471
472

		if(IsDocumentEnd())
beder's avatar
beder committed
473
			return ScanAndEnqueue(new DocumentEndToken);
beder's avatar
beder committed
474

beder's avatar
beder committed
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
		// are we at a flow start/end/entry?
		if(INPUT.peek() == Keys::FlowSeqStart)
			return ScanAndEnqueue(new FlowSeqStartToken);

		if(INPUT.peek() == Keys::FlowSeqEnd)
			return ScanAndEnqueue(new FlowSeqEndToken);
		
		if(INPUT.peek() == Keys::FlowMapStart)
			return ScanAndEnqueue(new FlowMapStartToken);
		
		if(INPUT.peek() == Keys::FlowMapEnd)
			return ScanAndEnqueue(new FlowMapEndToken);

		if(INPUT.peek() == Keys::FlowEntry)
			return ScanAndEnqueue(new FlowEntryToken);

		// block/map stuff?
		if(IsBlockEntry())
			return ScanAndEnqueue(new BlockEntryToken);

		if(IsKey())
			return ScanAndEnqueue(new KeyToken);

		if(IsValue())
			return ScanAndEnqueue(new ValueToken);

		// TODO: alias/anchor/tag

		// TODO: special scalars
		if(INPUT.peek() == Keys::LiteralScalar && m_flowLevel == 0)
			return;

		if(INPUT.peek() == Keys::FoldedScalar && m_flowLevel == 0)
			return;

		if(INPUT.peek() == '\'')
			return;

		if(INPUT.peek() == '\"')
			return;

		// plain scalars
		if(IsPlainScalar())
			return ScanAndEnqueue(new PlainScalarToken);

		// don't know what it is!
		throw UnknownToken();
beder's avatar
beder committed
522
523
524
525
526
527
528
529
	}

	// ScanToNextToken
	// . Eats input until we reach the next token-like thing.
	void Scanner::ScanToNextToken()
	{
		while(1) {
			// first eat whitespace
beder's avatar
beder committed
530
531
			while(IsWhitespaceToBeEaten(INPUT.peek()))
				Eat(1);
beder's avatar
beder committed
532
533

			// then eat a comment
534
			if(Exp::Comment.Matches(INPUT.peek())) {
beder's avatar
beder committed
535
				// eat until line break
536
				while(INPUT && !Exp::Break.Matches(INPUT.peek()))
beder's avatar
beder committed
537
					Eat(1);
beder's avatar
beder committed
538
539
540
			}

			// if it's NOT a line break, then we're done!
541
			if(!Exp::Break.Matches(INPUT.peek()))
beder's avatar
beder committed
542
543
544
545
546
547
548
549
550
551
552
				break;

			// otherwise, let's eat the line break and keep going
			EatLineBreak();

			// new line - we may be able to accept a simple key now
			if(m_flowLevel == 0)
				m_simpleKeyAllowed = true;
        }
	}

beder's avatar
beder committed
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
	// PushIndentTo
	// . Pushes an indentation onto the stack, and enqueues the
	//   proper token (sequence start or mapping start).
	void Scanner::PushIndentTo(int column, bool sequence)
	{
		// are we in flow?
		if(m_flowLevel > 0)
			return;

		// is this actually an indentation?
		if(column <= m_indents.top())
			return;

		// now push
		m_indents.push(column);
		if(sequence)
			m_tokens.push(new BlockSeqStartToken);
		else
			m_tokens.push(new BlockMapStartToken);
	}

	// PopIndentTo
	// . Pops indentations off the stack until we reach 'column' indentation,
	//   and enqueues the proper token each time.
	void Scanner::PopIndentTo(int column)
	{
		// are we in flow?
		if(m_flowLevel > 0)
			return;

		// now pop away
		while(!m_indents.empty() && m_indents.top() > column) {
			m_indents.pop();
			m_tokens.push(new BlockEndToken);
		}
	}

beder's avatar
beder committed
590
591
592
	// temporary function for testing
	void Scanner::Scan()
	{
593
		while(1) {
beder's avatar
beder committed
594
			ScanNextToken();
595
596
			if(m_tokens.empty())
				break;
beder's avatar
beder committed
597
598
599
600
601
602
603
604

			while(!m_tokens.empty()) {
				Token *pToken = m_tokens.front();
				m_tokens.pop();
				std::cout << typeid(*pToken).name() << std::endl;
				delete pToken;
			}
		}
beder's avatar
beder committed
605
606
	}
}