Skip to content

Commit

Permalink
LT-21761 & LT-21674: Handle Before, Between, After and more (#29)
Browse files Browse the repository at this point in the history 
* LT-21761 & LT-21674: Handle Before, Between, After and more

Handle Before, Between, After, and DisplayInSeparateParagraphs.
Remaining tasks:
- Tables still need indenting.
- The first line after a table is shifted to the left. A new
‘continuation’ style is needed when we start a new paragraph.
- Before, Between, and After might need to use a different style.
  • Loading branch information
@mark-sil
mark-sil authored Apr 25, 2024
1 parent 81f697a commit 3e09448
Show file tree
Hide file tree
Showing 5 changed files with 181 additions and 65 deletions.
98 changes: 53 additions & 45 deletions Src/xWorks/ConfiguredLcmGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1410,8 +1410,12 @@ private static IFragment GenerateContentForCollection(object collectionField, Co
Debug.Assert(config.DictionaryNodeOptions == null,
"double calls to GenerateContentForLexEntryRefsByType don't play nicely with ListOptions. Everything will be generated twice (if it doesn't crash)");
// Display typeless refs
bool first = true;
foreach (var entry in lerCollection.Where(item => !item.ComplexEntryTypesRS.Any() && !item.VariantEntryTypesRS.Any()))
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, entry, collectionOwner, settings, lexEntryTypeNode));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, entry, collectionOwner, settings, first, lexEntryTypeNode));
first = false;
}
// Display refs of each type
GenerateContentForLexEntryRefsByType(config, lerCollection, collectionOwner, pubDecorator, settings, bldr, lexEntryTypeNode,
true); // complex
Expand All @@ -1421,8 +1425,12 @@ private static IFragment GenerateContentForCollection(object collectionField, Co
else
{
Debug.WriteLine("Unable to group " + config.FieldDescription + " by LexRefType; generating sequentially");
bool first = true;
foreach (var item in lerCollection)
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings, first));
first = false;
}
}
}
else if (config.FieldDescription.StartsWith("Subentries"))
Expand All @@ -1435,8 +1443,12 @@ private static IFragment GenerateContentForCollection(object collectionField, Co
}
else
{
bool first = true;
foreach (var item in collection)
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings, first));
first = false;
}
}
}

Expand Down Expand Up @@ -1528,16 +1540,24 @@ private static IFragment GenerateContentForEntryRefCollection(ConfigurableDictio
if (typeNode.IsEnabled && typeNode.ReferencedOrDirectChildren != null && typeNode.ReferencedOrDirectChildren.Any(y => y.IsEnabled))
{
// Display typeless refs
bool first = true;
foreach (var entry in lerCollection.Where(item => !item.ComplexEntryTypesRS.Any() && !item.VariantEntryTypesRS.Any()))
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, entry, collectionOwner, settings, typeNode));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, entry, collectionOwner, settings, first, typeNode));
first = false;
}
// Display refs of each type
GenerateContentForLexEntryRefsByType(config, lerCollection, collectionOwner, pubDecorator, settings, bldr, typeNode, isComplex);
}
else
{
Debug.WriteLine("Unable to group " + config.FieldDescription + " by LexRefType; generating sequentially");
bool first = true;
foreach (var item in lerCollection)
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings, first));
first = false;
}
}
return bldr;
}
Expand All @@ -1561,11 +1581,13 @@ private static void GenerateContentForLexEntryRefsByType(ConfigurableDictionaryN
foreach (var typeGuid in lexEntryTypesFiltered)
{
var innerBldr = new StringBuilder();
bool first = true;
foreach (var lexEntRef in lerCollection)
{
if (isComplex ? lexEntRef.ComplexEntryTypesRS.Any(t => t.Guid == typeGuid) : lexEntRef.VariantEntryTypesRS.Any(t => t.Guid == typeGuid))
{
innerBldr.Append(GenerateCollectionItemContent(config, pubDecorator, lexEntRef, collectionOwner, settings, typeNode));
innerBldr.Append(GenerateCollectionItemContent(config, pubDecorator, lexEntRef, collectionOwner, settings, first, typeNode));
first = false;
}
}

Expand All @@ -1576,7 +1598,7 @@ private static void GenerateContentForLexEntryRefsByType(ConfigurableDictionaryN
var generateLexType = typeNode != null;
var lexTypeContent = generateLexType
? GenerateCollectionItemContent(typeNode, pubDecorator, lexEntryType,
lexEntryType.Owner, settings)
lexEntryType.Owner, settings, first)
: null;
var className = generateLexType ? settings.StylesGenerator.AddStyles(typeNode).Trim('.') : null;
var refsByType = settings.ContentGenerator.AddLexReferences(generateLexType,
Expand All @@ -1600,11 +1622,13 @@ private static void GenerateContentForSubentries(ConfigurableDictionaryNode conf
.Select(le => new Tuple<ILexEntryRef, ILexEntry>(EntryRefForSubentry(le, collectionOwner), le)).ToList();

// Generate any Subentries with no ComplexFormType
bool first = true;
for (var i = 0; i < subentries.Count; i++)
{
if (subentries[i].Item1 == null || !subentries[i].Item1.ComplexEntryTypesRS.Any())
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, subentries[i].Item2, collectionOwner, settings));
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, subentries[i].Item2, collectionOwner, settings, first));
first = false;
subentries.RemoveAt(i--);
}
}
Expand All @@ -1615,7 +1639,8 @@ private static void GenerateContentForSubentries(ConfigurableDictionaryNode conf
{
if (subentries[i].Item1.ComplexEntryTypesRS.Any(t => t.Guid == typeGuid))
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, subentries[i].Item2, collectionOwner, settings));
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, subentries[i].Item2, collectionOwner, settings, first));
first = false;
subentries.RemoveAt(i--);
}
}
Expand All @@ -1624,8 +1649,12 @@ private static void GenerateContentForSubentries(ConfigurableDictionaryNode conf
else
{
Debug.WriteLine("Unable to group " + config.FieldDescription + " by LexRefType; generating sequentially");
bool first = true;
foreach (var item in collection)
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings));
{
bldr.Append(GenerateCollectionItemContent(config, pubDecorator, item, collectionOwner, settings, first));
first = false;
}
}
}

Expand Down Expand Up @@ -1702,35 +1731,13 @@ private static IFragment GenerateContentForSenses(ConfigurableDictionaryNode con
var isThisSenseNumbered = ShouldThisSenseBeNumbered(filteredSenseCollection[0], config, filteredSenseCollection);
var bldr = settings.ContentGenerator.CreateFragment();

// TODO: Can handle separate sense paragraph styling here; likely will make the most sense to be handled wherever we deal with before/after content for senses.
// TODO: If handled here (or elsewhere w/in LcmGenerator), remove sense paragraph handling from the CssGenerator, otherwise sense paragraphs will be separated by two lines in the xhtml export.
/*// Only need to check once whether DisplayEachSenseInAParagraph is true -- value will be the same for each item in the loop
bool newParagraphPerSense;
if (senseNode?.DisplayEachSenseInAParagraph == true)
newParagraphPerSense = true;
else
newParagraphPerSense = false;
//If the first sense must be inline, we append the first sense without a preceding line break
int startSense = 0;
if (senseNode?.DisplayFirstSenseInline == true)
{
bldr.Append(GenerateSenseContent(config, publicationDecorator, filteredSenseCollection[startSense], isThisSenseNumbered, settings, isSameGrammaticalInfo, info));
startSense++;
}
for (int i = startSense; i < filteredSenseCollection.Count; i++)*/

bool first = true;
foreach (var item in filteredSenseCollection)
{
info.SenseCounter++;

// TODO: sense paragraphs
/*// If each sense belongs in a new paragraph, append a line break before the sense content.
if (newParagraphPerSense)
bldr.AppendBreak();*/

bldr.Append(GenerateSenseContent(config, publicationDecorator, item, isThisSenseNumbered, settings, isSameGrammaticalInfo, info));
bldr.Append(GenerateSenseContent(config, publicationDecorator, item, isThisSenseNumbered, settings,
isSameGrammaticalInfo, info, first));
first = false;
}
settings.StylesGenerator.AddStyles(config);
return bldr;
Expand Down Expand Up @@ -1876,7 +1883,7 @@ private static bool CheckIfAllGramInfoTheSame(ConfigurableDictionaryNode config,
}

private static IFragment GenerateSenseContent(ConfigurableDictionaryNode config, DictionaryPublicationDecorator publicationDecorator,
object item, bool isThisSenseNumbered, GeneratorSettings settings, bool isSameGrammaticalInfo, SenseInfo info)
object item, bool isThisSenseNumbered, GeneratorSettings settings, bool isSameGrammaticalInfo, SenseInfo info, bool first)
{
var senseNumberSpan = GenerateSenseNumberSpanIfNeeded(config, isThisSenseNumbered, ref info, settings);
var bldr = settings.ContentGenerator.CreateFragment();
Expand All @@ -1893,8 +1900,7 @@ private static IFragment GenerateSenseContent(ConfigurableDictionaryNode config,
if (bldr.Length() == 0)
return bldr;

return settings.ContentGenerator.AddSenseData(senseNumberSpan, IsBlockProperty(config), ((ICmObject)item).Owner.Guid,
bldr, GetCollectionItemClassAttribute(config));
return settings.ContentGenerator.AddSenseData(senseNumberSpan, ((ICmObject)item).Owner.Guid, config, bldr, first);
}

private static IFragment GeneratePictureContent(ConfigurableDictionaryNode config, DictionaryPublicationDecorator publicationDecorator,
Expand Down Expand Up @@ -1945,7 +1951,7 @@ private static IFragment GeneratePictureContent(ConfigurableDictionaryNode confi
}

private static IFragment GenerateCollectionItemContent(ConfigurableDictionaryNode config, DictionaryPublicationDecorator publicationDecorator,
object item, object collectionOwner, GeneratorSettings settings, ConfigurableDictionaryNode factoredTypeField = null)
object item, object collectionOwner, GeneratorSettings settings, bool first, ConfigurableDictionaryNode factoredTypeField = null)
{
if (item is IMultiStringAccessor)
return GenerateContentForStrings((IMultiStringAccessor)item, config, settings);
Expand Down Expand Up @@ -1979,7 +1985,7 @@ private static IFragment GenerateCollectionItemContent(ConfigurableDictionaryNod
if (bldr.Length() == 0)
return bldr;
var collectionContent = bldr;
return settings.ContentGenerator.AddCollectionItem(IsBlockProperty(config), GetCollectionItemClassAttribute(config), config, collectionContent);
return settings.ContentGenerator.AddCollectionItem(IsBlockProperty(config), GetCollectionItemClassAttribute(config), config, collectionContent, first);
}

private static void GenerateContentForLexRefCollection(ConfigurableDictionaryNode config,
Expand Down Expand Up @@ -2087,6 +2093,8 @@ private static IFragment GenerateCrossReferenceChildren(ConfigurableDictionaryNo
{
return settings.ContentGenerator.CreateFragment();
}

bool first = true;
foreach (var child in config.ReferencedOrDirectChildren.Where(c => c.IsEnabled))
{
switch (child.FieldDescription)
Expand All @@ -2097,7 +2105,8 @@ private static IFragment GenerateCrossReferenceChildren(ConfigurableDictionaryNo
{
var referenceItem = referenceListItem.Item2;
var targetItem = referenceListItem.Item1;
contentBldr.Append(GenerateCollectionItemContent(child, publicationDecorator, targetItem, referenceItem, settings));
contentBldr.Append(GenerateCollectionItemContent(child, publicationDecorator, targetItem, referenceItem, settings, first));
first = false;
}
if (contentBldr.Length > 0)
{
Expand Down Expand Up @@ -2252,7 +2261,7 @@ private static IFragment GenerateContentForICmObject(ICmObject propertyValue, Co
}

/// <summary>Write the class element in the span for an individual item in the collection</summary>
private static string GetCollectionItemClassAttribute(ConfigurableDictionaryNode config)
internal static string GetCollectionItemClassAttribute(ConfigurableDictionaryNode config)
{
var classAtt = CssGenerator.GetClassAttributeForCollectionItem(config);
if (config.ReferencedNode != null)
Expand Down Expand Up @@ -2487,8 +2496,7 @@ private static IFragment GenerateContentForValue(object field, object propertyVa
if (propertyValue is int)
{
var cssClassName = settings.StylesGenerator.AddStyles(config).Trim('.'); ;
return settings.ContentGenerator.AddProperty(cssClassName, false,
propertyValue.ToString());
return settings.ContentGenerator.AddProperty(cssClassName, false, propertyValue.ToString());
}
if (propertyValue is DateTime)
{
Expand Down
4 changes: 2 additions & 2 deletions Src/xWorks/ILcmContentGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ public interface ILcmContentGenerator
IFragment GenerateGramInfoBeforeSensesContent(IFragment content, ConfigurableDictionaryNode config);
IFragment GenerateGroupingNode(object field, string className, ConfigurableDictionaryNode config, DictionaryPublicationDecorator publicationDecorator, ConfiguredLcmGenerator.GeneratorSettings settings,
Func<object, ConfigurableDictionaryNode, DictionaryPublicationDecorator, ConfiguredLcmGenerator.GeneratorSettings, IFragment> childContentGenerator);
IFragment AddSenseData(IFragment senseNumberSpan, bool isBlockProperty, Guid ownerGuid, IFragment senseContent, string className);
IFragment AddCollectionItem(bool isBlock, string collectionItemClass, ConfigurableDictionaryNode config,IFragment content);
IFragment AddSenseData(IFragment senseNumberSpan, Guid ownerGuid, ConfigurableDictionaryNode config, IFragment senseContent, bool first);
IFragment AddCollectionItem(bool isBlock, string collectionItemClass, ConfigurableDictionaryNode config, IFragment content, bool first);
IFragment AddProperty(string className, bool isBlockProperty, string content);
IFragment CreateFragment();
IFragment CreateFragment(string str);
Expand Down
5 changes: 2 additions & 3 deletions Src/xWorks/LcmJsonGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public IFragment GenerateGroupingNode(object field, string className, Configurab
return new StringFragment();
}

public IFragment AddCollectionItem(bool isBlock, string className, ConfigurableDictionaryNode config,IFragment content)
public IFragment AddCollectionItem(bool isBlock, string className, ConfigurableDictionaryNode config,IFragment content, bool first)
{
var fragment = new StringFragment();
fragment.StrBuilder.Append(content.IsNullOrEmpty() ? string.Empty : $"{{{content}}},");
Expand Down Expand Up @@ -431,8 +431,7 @@ public IFragment GenerateErrorContent(StringBuilder badStrBuilder)
return new StringFragment($"\\u+0FFF\\u+0FFF\\u+0FFF{badStrBuilder}");
}

public IFragment AddSenseData(IFragment senseNumberSpan, bool isBlock, Guid ownerGuid,
IFragment senseContent, string className)
public IFragment AddSenseData(IFragment senseNumberSpan, Guid ownerGuid, ConfigurableDictionaryNode config, IFragment senseContent, bool first)
{
var bldr = new StringBuilder();
var fragment = new StringFragment(bldr);
Expand Down
Loading

0 comments on commit 3e09448

Please sign in to comment.