-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
UsfmParser.cs
686 lines (612 loc) · 27.1 KB
/
UsfmParser.cs
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
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using SIL.Scripture;
namespace SIL.Machine.Corpora
{
/// <summary>
/// Parser for USFM. Sends parse information to an optional sink.
/// The parser parses one token at a time, looking ahead as necessary
/// for such elements as figures, links and alternate verses and chapters.
///
/// The parser first updates the UsfmParserState and then calls the
/// parser handler as necessary.
/// </summary>
public class UsfmParser
{
public static void Parse(
string usfm,
IUsfmParserHandler handler,
string stylesheetFileName = "usfm.sty",
ScrVers versification = null,
bool preserveWhitespace = false
)
{
Parse(usfm, handler, new UsfmStylesheet(stylesheetFileName), versification, preserveWhitespace);
}
public static void Parse(
string usfm,
IUsfmParserHandler handler,
UsfmStylesheet stylesheet,
ScrVers versification = null,
bool preserveWhitespace = false
)
{
var parser = new UsfmParser(
usfm,
handler,
stylesheet ?? new UsfmStylesheet("usfm.sty"),
versification,
preserveWhitespace
);
parser.ProcessTokens();
}
private static readonly Regex OptBreakSplitter = new Regex("(//)", RegexOptions.Compiled);
public UsfmParser(
IReadOnlyList<UsfmToken> tokens,
IUsfmParserHandler handler = null,
string stylesheetFileName = "usfm.sty",
ScrVers versification = null,
bool tokensPreserveWhitespace = false
)
: this(tokens, handler, new UsfmStylesheet(stylesheetFileName), versification, tokensPreserveWhitespace) { }
public UsfmParser(
IReadOnlyList<UsfmToken> tokens,
IUsfmParserHandler handler,
UsfmStylesheet stylesheet,
ScrVers versification = null,
bool tokensPreserveWhitespace = false
)
: this(
new UsfmParserState(
stylesheet ?? new UsfmStylesheet("usfm.sty"),
versification ?? ScrVers.English,
tokens
),
handler,
tokensPreserveWhitespace
) { }
public UsfmParser(
string usfm,
IUsfmParserHandler handler = null,
string stylesheetFileName = "usfm.sty",
ScrVers versification = null,
bool tokensPreserveWhitespace = false
)
: this(usfm, handler, new UsfmStylesheet(stylesheetFileName), versification, tokensPreserveWhitespace) { }
public UsfmParser(
string usfm,
IUsfmParserHandler handler,
UsfmStylesheet stylesheet,
ScrVers versification = null,
bool tokensPreserveWhitespace = false
)
: this(
new UsfmParserState(
stylesheet ?? new UsfmStylesheet("usfm.sty"),
versification ?? ScrVers.English,
GetTokens(stylesheet, usfm, tokensPreserveWhitespace)
),
handler,
tokensPreserveWhitespace
) { }
private UsfmParser(UsfmParserState state, IUsfmParserHandler handler, bool tokensPreserveWhitespace)
{
State = state;
Handler = handler;
TokensPreserveWhitespace = tokensPreserveWhitespace;
}
private static IReadOnlyList<UsfmToken> GetTokens(
UsfmStylesheet stylesheet,
string usfm,
bool preserveWhitespace
)
{
var tokenizer = new UsfmTokenizer(stylesheet);
return tokenizer.Tokenize(usfm, preserveWhitespace);
}
public IUsfmParserHandler Handler { get; }
public bool TokensPreserveWhitespace { get; }
/// <summary>
/// Gets the current parser state. Note: Will change with each token parsed
/// </summary>
public UsfmParserState State { get; private set; }
/// <summary>
/// Processes all tokens
/// </summary>
public void ProcessTokens()
{
while (ProcessToken()) { }
}
/// <summary>
/// Processes a single token
/// </summary>
/// <returns>false if there were no more tokens process</returns>
public bool ProcessToken()
{
// If past end
if (State.Index >= State.Tokens.Count - 1)
{
Handler?.EndUsfm(State);
return false;
}
else if (State.Index < 0)
{
Handler?.StartUsfm(State);
}
// Move to next token
State.Index++;
// Update verse offset with previous token (since verse offset is from start of current token)
if (State.PrevToken != null)
State.VerseOffset += State.PrevToken.GetLength(addSpaces: !TokensPreserveWhitespace);
// Skip over tokens that are to be skipped, ensuring that
// SpecialToken state is true.
if (State.SpecialTokenCount > 0)
{
State.SpecialTokenCount--;
State.SpecialToken = true;
return true;
}
// Reset special token and figure status
State.SpecialToken = false;
UsfmToken token = State.Token;
// Switch unknown types to either character or paragraph
UsfmTokenType tokenType = token.Type;
if (tokenType == UsfmTokenType.Unknown)
tokenType = DetermineUnknownTokenType();
if (Handler != null && !string.IsNullOrEmpty(token.Marker))
Handler.GotMarker(State, token.Marker);
// Close open elements
switch (tokenType)
{
case UsfmTokenType.Book:
case UsfmTokenType.Chapter:
CloseAll();
break;
case UsfmTokenType.Paragraph:
// Handle special case of table rows
if (token.Marker == "tr")
{
// Close all but table and sidebar
while (
State.Stack.Count > 0
&& State.Peek().Type != UsfmElementType.Table
&& State.Peek().Type != UsfmElementType.Sidebar
)
CloseElement();
break;
}
// Handle special case of sidebars
if (token.Marker == "esb")
{
// Close all
CloseAll();
break;
}
// Close all but sidebar
while (State.Stack.Count > 0 && State.Peek().Type != UsfmElementType.Sidebar)
CloseElement();
break;
case UsfmTokenType.Character:
// Handle special case of table cell
if (IsCell(token))
{
// Close until row
while (State.Peek().Type != UsfmElementType.Row)
CloseElement();
break;
}
// Handle refs
if (IsRef(token))
{
// Refs don't close anything
break;
}
// If non-nested character style, close all character styles
if (!token.Marker.StartsWith("+"))
CloseCharStyles();
break;
case UsfmTokenType.Verse:
UsfmTag paraTag = State.ParaTag;
if (paraTag != null && paraTag.TextType != UsfmTextType.VerseText && paraTag.TextType != 0)
CloseAll();
else
CloseNote();
break;
case UsfmTokenType.Note:
CloseNote();
break;
case UsfmTokenType.End:
// If end marker for an active note
if (State.Stack.Any(e => e.Type == UsfmElementType.Note && (e.Marker + "*" == token.Marker)))
{
CloseNote(closed: true);
break;
}
// If end marker for a character style on stack, close it
// If no matching end marker, close all character styles on top of stack
UsfmParserElement elem;
bool unmatched = true;
while (State.Stack.Count > 0)
{
elem = State.Peek();
if (elem.Type != UsfmElementType.Char)
break;
// Determine if a + prefix is needed to close it (was nested char style)
bool plusPrefix =
State.Stack.Count > 1 && State.Stack[State.Stack.Count - 2].Type == UsfmElementType.Char;
// If is a match
if ((plusPrefix ? "+" : "") + elem.Marker + "*" == token.Marker)
{
CloseElement(closed: true);
unmatched = false;
break;
}
else
{
CloseElement();
}
}
// Unmatched end marker
if (unmatched)
if (Handler != null)
Handler.Unmatched(State, token.Marker);
break;
}
VerseRef vref;
// Handle tokens
switch (tokenType)
{
case UsfmTokenType.Book:
State.Push(new UsfmParserElement(UsfmElementType.Book, token.Marker));
// Code is always upper case
string code = token.Data.ToUpperInvariant();
vref = State.VerseRef;
// Update verse ref. Leave book alone if not empty to prevent parsing errors
// on books with bad id lines.
if (vref.Book == "" && Canon.BookIdToNumber(code) != 0)
vref.Book = code;
vref.ChapterNum = 1;
vref.VerseNum = 0;
State.VerseRef = vref;
State.VerseOffset = 0;
// Book start.
if (Handler != null)
Handler.StartBook(State, token.Marker, code);
break;
case UsfmTokenType.Chapter:
// Get alternate chapter number
string altChapter = null;
string pubChapter = null;
if (
State.Index < State.Tokens.Count - 3
&& State.Tokens[State.Index + 1].Marker == "ca"
&& State.Tokens[State.Index + 2].Text != null
&& State.Tokens[State.Index + 3].Marker == "ca*"
)
{
altChapter = State.Tokens[State.Index + 2].Text.Trim();
State.SpecialTokenCount += 3;
// Skip blank space after if present
if (
State.Index + State.SpecialTokenCount < State.Tokens.Count - 1
&& State.Tokens[State.Index + State.SpecialTokenCount + 1].Text != null
&& State.Tokens[State.Index + State.SpecialTokenCount + 1].Text.Trim().Length == 0
)
State.SpecialTokenCount++;
}
// Get publishable chapter number
if (
State.Index + State.SpecialTokenCount < State.Tokens.Count - 2
&& State.Tokens[State.Index + State.SpecialTokenCount + 1].Marker == "cp"
&& State.Tokens[State.Index + State.SpecialTokenCount + 2].Text != null
)
{
pubChapter = State.Tokens[State.Index + State.SpecialTokenCount + 2].Text.Trim();
State.SpecialTokenCount += 2;
}
// Chapter
vref = State.VerseRef;
vref.Chapter = token.Data;
vref.VerseNum = 0;
State.VerseRef = vref;
// Verse offset is not zeroed for chapter 1, as it is part of intro
if (State.VerseRef.ChapterNum != 1)
State.VerseOffset = 0;
if (Handler != null)
Handler.Chapter(State, token.Data, token.Marker, altChapter, pubChapter);
break;
case UsfmTokenType.Verse:
string pubVerse = null;
string altVerse = null;
if (
State.Index < State.Tokens.Count - 3
&& State.Tokens[State.Index + 1].Marker == "va"
&& State.Tokens[State.Index + 2].Text != null
&& State.Tokens[State.Index + 3].Marker == "va*"
)
{
// Get alternate verse number
altVerse = State.Tokens[State.Index + 2].Text.Trim();
State.SpecialTokenCount += 3;
}
if (
State.Index + State.SpecialTokenCount < State.Tokens.Count - 3
&& State.Tokens[State.Index + State.SpecialTokenCount + 1].Marker == "vp"
&& State.Tokens[State.Index + State.SpecialTokenCount + 2].Text != null
&& State.Tokens[State.Index + State.SpecialTokenCount + 3].Marker == "vp*"
)
{
// Get publishable verse number
pubVerse = State.Tokens[State.Index + State.SpecialTokenCount + 2].Text.Trim();
State.SpecialTokenCount += 3;
}
// Verse
vref = State.VerseRef;
vref.Verse = token.Data;
State.VerseRef = vref;
State.VerseOffset = 0;
if (Handler != null)
Handler.Verse(State, token.Data, token.Marker, altVerse, pubVerse);
break;
case UsfmTokenType.Paragraph:
// Handle special case of table rows
if (token.Marker == "tr")
{
// Start table if not open
if (State.Stack.All(e => e.Type != UsfmElementType.Table))
{
State.Push(new UsfmParserElement(UsfmElementType.Table, null));
if (Handler != null)
Handler.StartTable(State);
}
State.Push(new UsfmParserElement(UsfmElementType.Row, token.Marker));
// Row start
if (Handler != null)
Handler.StartRow(State, token.Marker);
break;
}
// Handle special case of sidebars
if (token.Marker == "esb")
{
State.Push(new UsfmParserElement(UsfmElementType.Sidebar, token.Marker));
// Look for category
string sidebarCategory = null;
if (
State.Index < State.Tokens.Count - 3
&& State.Tokens[State.Index + 1].Marker == "cat"
&& State.Tokens[State.Index + 2].Text != null
&& State.Tokens[State.Index + 3].Marker == "cat*"
)
{
// Get category
sidebarCategory = State.Tokens[State.Index + 2].Text.Trim();
State.SpecialTokenCount += 3;
}
if (Handler != null)
Handler.StartSidebar(State, token.Marker, sidebarCategory);
break;
}
// Close sidebar if in sidebar
if (token.Marker == "esbe")
{
if (State.Stack.Any(e => e.Type == UsfmElementType.Sidebar))
{
while (State.Stack.Count > 0)
CloseElement(State.Peek().Type == UsfmElementType.Sidebar);
}
else if (Handler != null)
{
Handler.Unmatched(State, token.Marker);
}
break;
}
State.Push(new UsfmParserElement(UsfmElementType.Para, token.Marker));
// Paragraph opening
if (Handler != null)
Handler.StartPara(State, token.Marker, token.Type == UsfmTokenType.Unknown, token.Attributes);
break;
case UsfmTokenType.Character:
// Handle special case of table cells (treated as special character style)
if (IsCell(token))
{
string align = "start";
if (token.Marker.Length > 2 && token.Marker[2] == 'c')
align = "center";
else if (token.Marker.Length > 2 && token.Marker[2] == 'r')
align = "end";
UsfmStylesheet.IsCellRange(token.Marker, out string baseMarker, out int colspan);
State.Push(new UsfmParserElement(UsfmElementType.Cell, baseMarker));
if (Handler != null)
Handler.StartCell(State, baseMarker, align, colspan);
break;
}
if (IsRef(token))
{
// xrefs are special tokens (they do not stand alone)
State.SpecialToken = true;
ParseDisplayAndTarget(out string display, out string target);
State.SpecialTokenCount += 2;
if (Handler != null)
Handler.Ref(State, token.Marker, display, target);
break;
}
string actualMarker;
bool invalidMarker = false;
if (token.Marker.StartsWith("+"))
{
// Only strip + if properly nested
UsfmTag charTag = State.CharTag;
actualMarker = charTag != null ? token.Marker.TrimStart('+') : token.Marker;
invalidMarker = charTag == null;
}
else
actualMarker = token.Marker;
State.Push(new UsfmParserElement(UsfmElementType.Char, actualMarker, token.Attributes));
if (Handler != null)
{
Handler.StartChar(
State,
actualMarker,
token.Type == UsfmTokenType.Unknown || invalidMarker,
token.Attributes
);
}
break;
case UsfmTokenType.Note:
// Look for category
string noteCategory = null;
if (
State.Index < State.Tokens.Count - 3
&& State.Tokens[State.Index + 1].Marker == "cat"
&& State.Tokens[State.Index + 2].Text != null
&& State.Tokens[State.Index + 3].Marker == "cat*"
)
{
// Get category
noteCategory = State.Tokens[State.Index + 2].Text.Trim();
State.SpecialTokenCount += 3;
}
State.Push(new UsfmParserElement(UsfmElementType.Note, token.Marker));
if (Handler != null)
Handler.StartNote(State, token.Marker, token.Data, noteCategory);
break;
case UsfmTokenType.Text:
string text = token.Text;
// If last token before a paragraph, book or chapter, esb, esbe (both are paragraph types),
// or at very end, strip final space
// This is because USFM requires these to be on a new line, therefore adding whitespace
if (
(
State.Index == State.Tokens.Count - 1
|| State.Tokens[State.Index + 1].Type == UsfmTokenType.Paragraph
|| State.Tokens[State.Index + 1].Type == UsfmTokenType.Book
|| State.Tokens[State.Index + 1].Type == UsfmTokenType.Chapter
)
&& text.Length > 0
&& text[text.Length - 1] == ' '
)
{
text = text.Substring(0, text.Length - 1);
}
if (Handler != null)
{
// Replace ~ with nbsp
text = text.Replace('~', '\u00A0');
// Replace // with <optbreak/>
foreach (string str in OptBreakSplitter.Split(text))
{
if (str == "//")
Handler.OptBreak(State);
else
Handler.Text(State, str);
}
}
break;
case UsfmTokenType.Milestone:
case UsfmTokenType.MilestoneEnd:
// currently, parse state doesn't need to be update, so just inform the handler about the milestone.
Handler?.Milestone(State, token.Marker, token.Type == UsfmTokenType.Milestone, token.Attributes);
break;
}
return true;
}
private void ParseDisplayAndTarget(out string display, out string target)
{
display = State.Tokens[State.Index + 1].Text.Substring(0, State.Tokens[State.Index + 1].Text.IndexOf('|'));
target = State.Tokens[State.Index + 1].Text.Substring(State.Tokens[State.Index + 1].Text.IndexOf('|') + 1);
}
/// <summary>
/// Closes all open elements on stack
/// </summary>
public void CloseAll()
{
while (State.Stack.Count > 0)
CloseElement();
}
/// <summary>
/// Determine type that an unknown token should be treated as
/// </summary>
/// <returns>character or paragraph type</returns>
private UsfmTokenType DetermineUnknownTokenType()
{
// Unknown inside notes are character
if (State.Stack.Any(e => e.Type == UsfmElementType.Note))
return UsfmTokenType.Character;
return UsfmTokenType.Paragraph;
}
private void CloseNote(bool closed = false)
{
if (State.Stack.Any(elem => elem.Type == UsfmElementType.Note))
{
UsfmParserElement elem;
do
{
if (State.Stack.Count == 0)
break;
elem = State.Peek();
CloseElement(closed && elem.Type == UsfmElementType.Note);
} while (elem.Type != UsfmElementType.Note);
}
}
private void CloseCharStyles()
{
while (State.Stack.Count > 0 && State.Peek().Type == UsfmElementType.Char)
CloseElement();
}
private void CloseElement(bool closed = false)
{
UsfmParserElement element = State.Pop();
switch (element.Type)
{
case UsfmElementType.Book:
if (Handler != null)
Handler.EndBook(State, element.Marker);
break;
case UsfmElementType.Para:
if (Handler != null)
Handler.EndPara(State, element.Marker);
break;
case UsfmElementType.Char:
if (Handler != null)
Handler.EndChar(State, element.Marker, element.Attributes, closed);
break;
case UsfmElementType.Note:
if (Handler != null)
Handler.EndNote(State, element.Marker, closed);
break;
case UsfmElementType.Table:
if (Handler != null)
Handler.EndTable(State);
break;
case UsfmElementType.Row:
if (Handler != null)
Handler.EndRow(State, element.Marker);
break;
case UsfmElementType.Cell:
if (Handler != null)
Handler.EndCell(State, element.Marker);
break;
case UsfmElementType.Sidebar:
if (Handler != null)
Handler.EndSidebar(State, element.Marker, closed);
break;
}
}
private bool IsCell(UsfmToken token)
{
return token.Type == UsfmTokenType.Character
&& (token.Marker.StartsWith("th") || token.Marker.StartsWith("tc"))
&& State.Stack.Any(elem => elem.Type == UsfmElementType.Row);
}
private bool IsRef(UsfmToken token)
{
return (State.Index < State.Tokens.Count - 2)
&& (State.Tokens[State.Index + 1].Text != null)
&& (State.Tokens[State.Index + 1].Text.Contains("|"))
&& (State.Tokens[State.Index + 2].Type == UsfmTokenType.End)
&& (State.Tokens[State.Index + 2].Marker == token.EndMarker)
&& (token.Marker == "ref");
}
}
}