Skip to content

Commit 21864af

Browse files
johnml1135johnml1135
committed
Change terminology to Embedded and Style
1 parent ab480f1 commit 21864af

13 files changed

+107
-121
lines changed

‎src/SIL.Machine/Corpora/IUsfmParserHandler.cs‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,29 +69,24 @@ IReadOnlyList<UsfmAttribute> attributes
6969
void EndChar(UsfmParserState state, string marker, IReadOnlyList<UsfmAttribute> attributes, bool closed);
7070

7171
/// <summary>
72-
/// Start of a sub component - a note, figure or cross reference
72+
/// Start of an embedded - a note, figure or cross reference
7373
/// </summary>
74-
void StartSubComponent(UsfmParserState state, string marker, string caller, string category);
74+
void StartEmbedded(UsfmParserState state, string marker, string caller, string category);
7575

7676
/// <summary>
77-
/// End of a sub component
77+
/// End of an embedded
7878
/// </summary>
79-
void EndSubComponent(
80-
UsfmParserState state,
81-
string marker,
82-
IReadOnlyList<UsfmAttribute> attributes,
83-
bool closed
84-
);
79+
void EndEmbedded(UsfmParserState state, string marker, IReadOnlyList<UsfmAttribute> attributes, bool closed);
8580

8681
/// <summary>
87-
/// Start of a sub component text
82+
/// Start of an embedded text
8883
/// </summary>
89-
void StartSubComponentText(UsfmParserState state);
84+
void StartEmbeddedText(UsfmParserState state);
9085

9186
/// <summary>
92-
/// End of a sub component text
87+
/// End of an embedded text
9388
/// </summary>
94-
void EndSubComponentText(UsfmParserState state);
89+
void EndEmbeddedText(UsfmParserState state);
9590

9691
/// <summary>
9792
/// Start of a table

‎src/SIL.Machine/Corpora/ParatextProjectTextUpdaterBase.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public string UpdateUsfm(
2424
IReadOnlyList<(IReadOnlyList<ScriptureRef>, string)> rows,
2525
string fullName = null,
2626
UpdateUsfmTextBehavior textBehavior = UpdateUsfmTextBehavior.PreferExisting,
27-
UpdateUsfmIntraVerseMarkerBehavior subComponentBehavior = UpdateUsfmIntraVerseMarkerBehavior.Preserve,
28-
UpdateUsfmIntraVerseMarkerBehavior formattingBehavior = UpdateUsfmIntraVerseMarkerBehavior.Strip
27+
UpdateUsfmIntraVerseMarkerBehavior embeddedBehavior = UpdateUsfmIntraVerseMarkerBehavior.Preserve,
28+
UpdateUsfmIntraVerseMarkerBehavior styleBehavior = UpdateUsfmIntraVerseMarkerBehavior.Strip
2929
)
3030
{
3131
string fileName = _settings.GetBookFileName(bookId);
@@ -42,8 +42,8 @@ public string UpdateUsfm(
4242
rows,
4343
fullName is null ? null : $"- {fullName}",
4444
textBehavior,
45-
subComponentBehavior,
46-
formattingBehavior
45+
embeddedBehavior,
46+
styleBehavior
4747
);
4848
try
4949
{

‎src/SIL.Machine/Corpora/ScriptureRefUsfmParserHandlerBase.cs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ public enum ScriptureTextType
99
None,
1010
NonVerse,
1111
Verse,
12-
SubComponent,
13-
SubComponentText
12+
Embedded,
13+
EmbeddedText
1414
}
1515

1616
public abstract class ScriptureRefUsfmParserHandlerBase : UsfmParserHandlerBase
@@ -152,7 +152,7 @@ public override void EndSidebar(UsfmParserState state, string marker, bool close
152152
EndParentElement();
153153
}
154154

155-
public override void StartSubComponent(UsfmParserState state, string marker, string caller, string category)
155+
public override void StartEmbedded(UsfmParserState state, string marker, string caller, string category)
156156
{
157157
if (_curVerseRef.IsDefault)
158158
UpdateVerseRef(state.VerseRef, marker);
@@ -165,15 +165,15 @@ public override void StartSubComponent(UsfmParserState state, string marker, str
165165
}
166166
}
167167

168-
public override void StartSubComponentText(UsfmParserState state)
168+
public override void StartEmbeddedText(UsfmParserState state)
169169
{
170-
_curTextType.Push(ScriptureTextType.SubComponentText);
171-
StartSubComponentText(state, CreateNonVerseRef());
170+
_curTextType.Push(ScriptureTextType.EmbeddedText);
171+
StartEmbeddedText(state, CreateNonVerseRef());
172172
}
173173

174-
public override void EndSubComponentText(UsfmParserState state)
174+
public override void EndEmbeddedText(UsfmParserState state)
175175
{
176-
EndSubComponentText(state, CreateNonVerseRef());
176+
EndEmbeddedText(state, CreateNonVerseRef());
177177
_curTextType.Pop();
178178
}
179179

@@ -209,9 +209,9 @@ protected virtual void StartNonVerseText(UsfmParserState state, ScriptureRef scr
209209

210210
protected virtual void EndNonVerseText(UsfmParserState state, ScriptureRef scriptureRef) { }
211211

212-
protected virtual void StartSubComponentText(UsfmParserState state, ScriptureRef scriptureRef) { }
212+
protected virtual void StartEmbeddedText(UsfmParserState state, ScriptureRef scriptureRef) { }
213213

214-
protected virtual void EndSubComponentText(UsfmParserState state, ScriptureRef scriptureRef) { }
214+
protected virtual void EndEmbeddedText(UsfmParserState state, ScriptureRef scriptureRef) { }
215215

216216
private void StartVerseText(UsfmParserState state)
217217
{

‎src/SIL.Machine/Corpora/UpdateUsfmParserHandler.cs‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ public class UpdateUsfmParserHandler : ScriptureRefUsfmParserHandlerBase
2828
private readonly List<UsfmToken> _newTokens;
2929
private readonly string _idText;
3030
private readonly UpdateUsfmTextBehavior _textBehavior;
31-
private readonly UpdateUsfmIntraVerseMarkerBehavior _subComponentBehavior;
32-
private readonly UpdateUsfmIntraVerseMarkerBehavior _formattingBehavior;
31+
private readonly UpdateUsfmIntraVerseMarkerBehavior _embeddedBehavior;
32+
private readonly UpdateUsfmIntraVerseMarkerBehavior _styleBehavior;
3333
private readonly Stack<bool> _replace;
3434
private int _rowIndex;
3535
private int _tokenIndex;
@@ -38,8 +38,8 @@ public UpdateUsfmParserHandler(
3838
IReadOnlyList<(IReadOnlyList<ScriptureRef>, string)> rows = null,
3939
string idText = null,
4040
UpdateUsfmTextBehavior textBehavior = UpdateUsfmTextBehavior.PreferExisting,
41-
UpdateUsfmIntraVerseMarkerBehavior subComponentBehavior = UpdateUsfmIntraVerseMarkerBehavior.Preserve,
42-
UpdateUsfmIntraVerseMarkerBehavior formattingBehavior = UpdateUsfmIntraVerseMarkerBehavior.Strip
41+
UpdateUsfmIntraVerseMarkerBehavior embeddedBehavior = UpdateUsfmIntraVerseMarkerBehavior.Preserve,
42+
UpdateUsfmIntraVerseMarkerBehavior styleBehavior = UpdateUsfmIntraVerseMarkerBehavior.Strip
4343
)
4444
{
4545
_rows = rows ?? Array.Empty<(IReadOnlyList<ScriptureRef>, string)>();
@@ -48,8 +48,8 @@ public UpdateUsfmParserHandler(
4848
_idText = idText;
4949
_replace = new Stack<bool>();
5050
_textBehavior = textBehavior;
51-
_subComponentBehavior = subComponentBehavior;
52-
_formattingBehavior = formattingBehavior;
51+
_embeddedBehavior = embeddedBehavior;
52+
_styleBehavior = styleBehavior;
5353
}
5454

5555
public IReadOnlyList<UsfmToken> Tokens => _tokens;
@@ -196,31 +196,31 @@ bool closed
196196
base.EndChar(state, marker, attributes, closed);
197197
}
198198

199-
public override void StartSubComponent(UsfmParserState state, string marker, string caller, string category)
199+
public override void StartEmbedded(UsfmParserState state, string marker, string caller, string category)
200200
{
201201
// strip out notes in verses that are being replaced
202202
if (ReplaceWithNewTokens(state))
203203
SkipTokens(state);
204204
else
205205
CollectTokens(state);
206206

207-
base.StartSubComponent(state, marker, caller, category);
207+
base.StartEmbedded(state, marker, caller, category);
208208
}
209209

210-
public override void EndSubComponent(
210+
public override void EndEmbedded(
211211
UsfmParserState state,
212212
string marker,
213213
IReadOnlyList<UsfmAttribute> attributes,
214214
bool closed
215215
)
216216
{
217217
// strip out notes in verses that are being replaced
218-
if (ReplaceWithNewTokens(state, closed: closed, endSubComponent: true))
218+
if (ReplaceWithNewTokens(state, closed: closed, endEmbedded: true))
219219
SkipTokens(state);
220220
else
221221
CollectTokens(state);
222222

223-
base.EndSubComponent(state, marker, attributes, closed);
223+
base.EndEmbedded(state, marker, attributes, closed);
224224
}
225225

226226
public override void Ref(UsfmParserState state, string marker, string display, string target)
@@ -289,13 +289,13 @@ protected override void EndNonVerseText(UsfmParserState state, ScriptureRef scri
289289
PopNewTokens();
290290
}
291291

292-
protected override void StartSubComponentText(UsfmParserState state, ScriptureRef scriptureRef)
292+
protected override void StartEmbeddedText(UsfmParserState state, ScriptureRef scriptureRef)
293293
{
294294
IReadOnlyList<string> rowTexts = AdvanceRows(new[] { scriptureRef });
295295
PushNewTokens(rowTexts.Select(t => new UsfmToken(t + " ")));
296296
}
297297

298-
protected override void EndSubComponentText(UsfmParserState state, ScriptureRef scriptureRef)
298+
protected override void EndEmbeddedText(UsfmParserState state, ScriptureRef scriptureRef)
299299
{
300300
PopNewTokens();
301301
}
@@ -365,7 +365,7 @@ private void SkipTokens(UsfmParserState state)
365365
_tokenIndex = state.Index + 1 + state.SpecialTokenCount;
366366
}
367367

368-
private bool ReplaceWithNewTokens(UsfmParserState state, bool closed = true, bool endSubComponent = false)
368+
private bool ReplaceWithNewTokens(UsfmParserState state, bool closed = true, bool endEmbedded = false)
369369
{
370370
bool untranslatableParagraph =
371371
state.ParaTag?.Marker != null && UsfmStylesheet.IsUntranslatedParagraph(state.ParaTag.Marker);
@@ -379,11 +379,10 @@ private bool ReplaceWithNewTokens(UsfmParserState state, bool closed = true, boo
379379
}
380380

381381
bool newText = _replace.Count > 0 && _replace.Peek();
382-
bool inSubComponent = state.SubComponentTag != null || endSubComponent;
383-
bool inSubComponentText =
384-
CurrentTextType == ScriptureTextType.SubComponentText
385-
&& !UsfmStylesheet.IsSubComponentText(state.Token.Marker);
386-
bool isFormattingTag = state.Token.Marker != null && !UsfmStylesheet.IsSubComponentPart(state.Token.Marker);
382+
bool inEmbedded = state.EmbeddedTag != null || endEmbedded;
383+
bool inEmbeddedText =
384+
CurrentTextType == ScriptureTextType.EmbeddedText && !UsfmStylesheet.IsEmbeddedText(state.Token.Marker);
385+
bool isStyleTag = state.Token.Marker != null && !UsfmStylesheet.IsEmbeddedPart(state.Token.Marker);
387386

388387
bool existingText = state
389388
.Tokens.Skip(_tokenIndex)
@@ -394,7 +393,7 @@ private bool ReplaceWithNewTokens(UsfmParserState state, bool closed = true, boo
394393
!untranslatableParagraph
395394
&& newText
396395
&& (!existingText || _textBehavior == UpdateUsfmTextBehavior.PreferNew)
397-
&& (!inSubComponent || inSubComponentText);
396+
&& (!inEmbedded || inEmbeddedText);
398397

399398
if (useNewTokens)
400399
AddNewTokens();
@@ -404,20 +403,20 @@ private bool ReplaceWithNewTokens(UsfmParserState state, bool closed = true, boo
404403

405404
// figure out when to skip the existing text
406405
bool withinNewText = _replace.Any(r => r);
407-
if (withinNewText && inSubComponent)
406+
if (withinNewText && inEmbedded)
408407
{
409-
if (_subComponentBehavior == UpdateUsfmIntraVerseMarkerBehavior.Strip)
408+
if (_embeddedBehavior == UpdateUsfmIntraVerseMarkerBehavior.Strip)
410409
return true;
411410

412-
if (!inSubComponentText)
411+
if (!inEmbeddedText)
413412
return false;
414413
}
415414

416415
bool skipTokens = useNewTokens && closed;
417416

418-
if (newText && isFormattingTag)
417+
if (newText && isStyleTag)
419418
{
420-
skipTokens = _formattingBehavior == UpdateUsfmIntraVerseMarkerBehavior.Strip;
419+
skipTokens = _styleBehavior == UpdateUsfmIntraVerseMarkerBehavior.Strip;
421420
}
422421
return skipTokens;
423422
}

‎src/SIL.Machine/Corpora/UsfmParser.cs‎

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -245,18 +245,16 @@ public bool ProcessToken()
245245
if (paraTag != null && paraTag.TextType != UsfmTextType.VerseText && paraTag.TextType != 0)
246246
CloseAll();
247247
else
248-
CloseSubComponent();
248+
CloseEmbedded();
249249
break;
250-
case UsfmTokenType.SubComponent:
251-
CloseSubComponent();
250+
case UsfmTokenType.Embedded:
251+
CloseEmbedded();
252252
break;
253253
case UsfmTokenType.End:
254254
// If end marker for an active note
255-
if (
256-
State.Stack.Any(e => e.Type == UsfmElementType.SubComponent && (e.Marker + "*" == token.Marker))
257-
)
255+
if (State.Stack.Any(e => e.Type == UsfmElementType.Embedded && (e.Marker + "*" == token.Marker)))
258256
{
259-
CloseSubComponent(closed: true);
257+
CloseEmbedded(closed: true);
260258
break;
261259
}
262260

@@ -489,7 +487,7 @@ public bool ProcessToken()
489487
break;
490488
}
491489

492-
if (UsfmStylesheet.IsSubComponentPart(token.Marker))
490+
if (UsfmStylesheet.IsEmbeddedPart(token.Marker))
493491
CloseNoteText();
494492

495493
string actualMarker;
@@ -514,14 +512,14 @@ public bool ProcessToken()
514512
token.Attributes
515513
);
516514

517-
if (IsSubComponentText(token))
515+
if (IsEmbeddedText(token))
518516
{
519517
// Note text should be handled as a full segment
520-
State.Push(new UsfmParserElement(UsfmElementType.SubComponentText, token.Marker));
521-
Handler?.StartSubComponentText(State);
518+
State.Push(new UsfmParserElement(UsfmElementType.EmbeddedText, token.Marker));
519+
Handler?.StartEmbeddedText(State);
522520
}
523521
break;
524-
case UsfmTokenType.SubComponent:
522+
case UsfmTokenType.Embedded:
525523
// Look for category
526524
string noteCategory = null;
527525
if (
@@ -536,9 +534,9 @@ public bool ProcessToken()
536534
State.SpecialTokenCount += 3;
537535
}
538536

539-
State.Push(new UsfmParserElement(UsfmElementType.SubComponent, token.Marker, token.Attributes));
537+
State.Push(new UsfmParserElement(UsfmElementType.Embedded, token.Marker, token.Attributes));
540538

541-
Handler?.StartSubComponent(State, token.Marker, token.Data, noteCategory);
539+
Handler?.StartEmbedded(State, token.Marker, token.Data, noteCategory);
542540
break;
543541
case UsfmTokenType.Text:
544542
string text = token.Text;
@@ -608,15 +606,15 @@ public void CloseAll()
608606
private UsfmTokenType DetermineUnknownTokenType()
609607
{
610608
// Unknown inside notes are character
611-
if (State.Stack.Any(e => e.Type == UsfmElementType.SubComponent))
609+
if (State.Stack.Any(e => e.Type == UsfmElementType.Embedded))
612610
return UsfmTokenType.Character;
613611

614612
return UsfmTokenType.Paragraph;
615613
}
616614

617-
private void CloseSubComponent(bool closed = false)
615+
private void CloseEmbedded(bool closed = false)
618616
{
619-
if (State.Stack.Any(elem => elem.Type == UsfmElementType.SubComponent))
617+
if (State.Stack.Any(elem => elem.Type == UsfmElementType.Embedded))
620618
{
621619
UsfmParserElement elem;
622620
do
@@ -625,14 +623,14 @@ private void CloseSubComponent(bool closed = false)
625623
break;
626624

627625
elem = State.Peek();
628-
CloseElement(closed && elem.Type == UsfmElementType.SubComponent);
629-
} while (elem.Type != UsfmElementType.SubComponent);
626+
CloseElement(closed && elem.Type == UsfmElementType.Embedded);
627+
} while (elem.Type != UsfmElementType.Embedded);
630628
}
631629
}
632630

633631
private void CloseNoteText()
634632
{
635-
while (State.Stack.Count > 0 && State.Peek().Type == UsfmElementType.SubComponentText)
633+
while (State.Stack.Count > 0 && State.Peek().Type == UsfmElementType.EmbeddedText)
636634
CloseElement();
637635
}
638636

@@ -656,11 +654,11 @@ private void CloseElement(bool closed = false)
656654
case UsfmElementType.Char:
657655
Handler?.EndChar(State, element.Marker, element.Attributes, closed);
658656
break;
659-
case UsfmElementType.SubComponent:
660-
Handler?.EndSubComponent(State, element.Marker, element.Attributes, closed);
657+
case UsfmElementType.Embedded:
658+
Handler?.EndEmbedded(State, element.Marker, element.Attributes, closed);
661659
break;
662-
case UsfmElementType.SubComponentText:
663-
Handler?.EndSubComponentText(State);
660+
case UsfmElementType.EmbeddedText:
661+
Handler?.EndEmbeddedText(State);
664662
break;
665663
case UsfmElementType.Table:
666664
Handler?.EndTable(State);
@@ -694,9 +692,9 @@ private bool IsRef(UsfmToken token)
694692
&& (token.Marker == "ref");
695693
}
696694

697-
private bool IsSubComponentText(UsfmToken token)
695+
private bool IsEmbeddedText(UsfmToken token)
698696
{
699-
return UsfmStylesheet.IsSubComponentText(token.Marker) && State.SubComponentTag != null;
697+
return UsfmStylesheet.IsEmbeddedText(token.Marker) && State.EmbeddedTag != null;
700698
}
701699
}
702700
}

0 commit comments

Comments
 (0)