Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lt 21728c: Parse Prioritizer #97

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Lt 21728c: Parse Prioritizer #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
695947b
Refactor code to guess occurrences rather than analyses
jtmaxwell3 Jul 2, 2024
9517fb2
Make InterlinViewDataCache be a guess cache reather than a decorator
jtmaxwell3 Jul 3, 2024
ab8fc82
Minor code maintenence improvement in InterlinViewDataCache
jasonleenaylor Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions Src/LexText/Interlinear/InterlinDocForAnalysis.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ void InterlinDocForAnalysis_RightMouseClickedEvent(SimpleRootSite sender, FwRigh

internal void SuppressResettingGuesses(Action task)
{
Vc.Decorator.SuppressResettingGuesses(task);
Vc.GuessCache.SuppressResettingGuesses(task);
}

public override void PropChanged(int hvo, int tag, int ivMin, int cvIns, int cvDel)
Expand Down Expand Up @@ -1473,9 +1473,10 @@ public void OnAddWordGlossesToFreeTrans(object arg)
ITsStrBldr bldr = TsStringUtils.MakeStrBldr();
bool fOpenPunc = false;
ITsString space = TsStringUtils.MakeString(" ", ws);
foreach (var analysis in seg.AnalysesRS)
for (var i = 0; i < seg.AnalysesRS.Count; i++)
{
ITsString insert = null;
var analysis = seg.AnalysesRS[i];
if (analysis.Wordform == null)
{
// PunctForm...insert its text.
Expand Down Expand Up @@ -1511,7 +1512,7 @@ public void OnAddWordGlossesToFreeTrans(object arg)
else if (analysis is IWfiAnalysis || analysis is IWfiWordform)
{
// check if we have a guess cached with a gloss. (LT-9973)
int guessHvo = Vc.GetGuess(analysis);
int guessHvo = Vc.GetGuess(analysis, new AnalysisOccurrence(seg, i));
if (guessHvo != 0)
{
var guess = Cache.ServiceLocator.ObjectRepository.GetObject(guessHvo) as IWfiGloss;
Expand Down Expand Up @@ -2244,6 +2245,13 @@ public void AddNote(Command command)
Focus(); // So we can actually see the selection we just made.
}

internal InterlinViewDataCache GetGuessCache()
{
if (Vc != null)
return Vc.GuessCache;
return null;
}

internal void RecordGuessIfNotKnown(AnalysisOccurrence selected)
{
if (Vc != null) // I think this only happens in tests.
Expand Down Expand Up @@ -2308,7 +2316,7 @@ public void ApproveAllSuggestedAnalyses(Command cmd)
IAnalysis occAn = occ.Analysis; // averts “Access to the modified closure” warning in resharper
if (occAn is IWfiAnalysis || occAn is IWfiWordform)
{ // this is an analysis or a wordform
int hvo = Vc.GetGuess(occAn);
int hvo = Vc.GetGuess(occAn, occ);
if (occAn.Hvo != hvo)
{
// Move the sandbox to the next AnalysisOccurrence, then do the approval (using the sandbox data).
Expand Down
8 changes: 1 addition & 7 deletions Src/LexText/Interlinear/InterlinDocRootSiteBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ internal virtual void UpdateGuesses(HashSet<IWfiWordform> wordforms)
private void UpdateGuesses(HashSet<IWfiWordform> wordforms, bool fUpdateDisplayWhereNeeded)
{
// now update the guesses for the paragraphs.
var pdut = new ParaDataUpdateTracker(Vc.GuessServices, Vc.Decorator);
var pdut = new ParaDataUpdateTracker(Vc.GuessServices, Vc.GuessCache);
if (wordforms != null)
// The user may have changed the analyses for wordforms. (LT-21814)
foreach (var wordform in wordforms)
Expand Down Expand Up @@ -991,12 +991,6 @@ public IVwRootBox GetRootBox()
/// </summary>
protected virtual void AddDecorator()
{
// by default, just use the InterinVc decorator.
if (m_rootb != null)
{
m_rootb.DataAccess = Vc.Decorator;
}

}

protected virtual void SetRootInternal(int hvo)
Expand Down
8 changes: 0 additions & 8 deletions Src/LexText/Interlinear/InterlinTaggingChild.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,6 @@ protected override void MakeVc()
m_segRepo = m_cache.ServiceLocator.GetInstance<ISegmentRepository>();
}

/// <summary>
/// This causes all rootbox access to go through our Tagging Decorator.
/// </summary>
protected override void AddDecorator()
{
m_rootb.DataAccess = (Vc as InterlinTaggingVc).Decorator;
}

#region SelectionMethods

bool m_fInSelChanged;
Expand Down
97 changes: 51 additions & 46 deletions Src/LexText/Interlinear/InterlinVc.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public InterlinVc(LcmCache cache) : base(cache.DefaultAnalWs)
StTxtParaRepository = m_cache.ServiceLocator.GetInstance<IStTxtParaRepository>();
m_wsAnalysis = cache.DefaultAnalWs;
m_wsUi = cache.LanguageWritingSystemFactoryAccessor.UserWs;
Decorator = new InterlinViewDataCache(m_cache);
GuessCache = new InterlinViewDataCache(m_cache);
PreferredVernWs = cache.DefaultVernWs;
m_selfFlid = m_cache.MetaDataCacheAccessor.GetFieldId2(CmObjectTags.kClassId, "Self", false);
m_tssMissingAnalysis = TsStringUtils.MakeString(ITextStrings.ksStars, m_wsAnalysis);
Expand All @@ -195,7 +195,7 @@ public InterlinVc(LcmCache cache) : base(cache.DefaultAnalWs)
LangProjectHvo = m_cache.LangProject.Hvo;
}

internal InterlinViewDataCache Decorator { get; set; }
internal InterlinViewDataCache GuessCache { get; set; }

private IStTxtParaRepository StTxtParaRepository { get; set; }

Expand Down Expand Up @@ -554,12 +554,12 @@ private void SetGuessing(IVwEnv vwenv)
/// </summary>
/// <param name="analysis"></param>
/// <returns></returns>
internal int GetGuess(IAnalysis analysis)
internal int GetGuess(IAnalysis analysis, AnalysisOccurrence occurrence)
{
if (Decorator.get_IsPropInCache(analysis.Hvo, InterlinViewDataCache.AnalysisMostApprovedFlid,
if (GuessCache.get_IsPropInCache(occurrence, InterlinViewDataCache.AnalysisMostApprovedFlid,
(int)CellarPropertyType.ReferenceAtomic, 0))
{
var hvoResult = Decorator.get_ObjectProp(analysis.Hvo, InterlinViewDataCache.AnalysisMostApprovedFlid);
var hvoResult = GuessCache.get_ObjectProp(occurrence, InterlinViewDataCache.AnalysisMostApprovedFlid);
if(hvoResult != 0 && Cache.ServiceLocator.IsValidObjectId(hvoResult))
return hvoResult; // may have been cleared by setting to zero, or the Decorator could have stale data
}
Expand Down Expand Up @@ -1718,12 +1718,12 @@ public void Run(bool showMultipleAnalyses)
{
case WfiWordformTags.kClassId:
m_hvoWordform = wag.Wordform.Hvo;
m_hvoDefault = m_this.GetGuess(wag.Wordform);
m_hvoDefault = m_this.GetGuess(wag.Wordform, m_analysisOccurrence);
break;
case WfiAnalysisTags.kClassId:
m_hvoWordform = wag.Wordform.Hvo;
m_hvoWfiAnalysis = wag.Analysis.Hvo;
m_hvoDefault = m_this.GetGuess(wag.Analysis);
m_hvoDefault = m_this.GetGuess(wag.Analysis, m_analysisOccurrence);
break;
case WfiGlossTags.kClassId:
m_hvoWfiAnalysis = wag.Analysis.Hvo;
Expand Down Expand Up @@ -1823,7 +1823,7 @@ private void DisplayMorphemes()
{
// Real analysis isn't what we're displaying, so morph breakdown
// is a guess. Is it a human-approved guess?
bool isHumanGuess = m_this.Decorator.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid) !=
bool isHumanGuess = m_this.GuessCache.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid) !=
(int) AnalysisGuessServices.OpinionAgent.Parser;
m_this.SetGuessing(m_vwenv, isHumanGuess ? ApprovedGuessColor : MachineGuessColor);
// Let the exporter know that this is a guessed analysis.
Expand Down Expand Up @@ -1867,7 +1867,7 @@ private void DisplayWordGloss(InterlinLineSpec spec, int choiceIndex)
{
// Real analysis isn't what we're displaying, so morph breakdown
// is a guess. Is it a human-approved guess?
bool isHumanGuess = m_this.Decorator.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid) !=
bool isHumanGuess = m_this.GuessCache.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid) !=
(int)AnalysisGuessServices.OpinionAgent.Parser;
m_this.SetGuessing(m_vwenv, isHumanGuess ? ApprovedGuessColor : MachineGuessColor);
}
Expand Down Expand Up @@ -1919,7 +1919,7 @@ private void DisplayWordPOS(int choiceIndex)
if (m_hvoDefault != m_hvoWordBundleAnalysis)
{
// Real analysis isn't what we're displaying, so POS is a guess.
bool isHumanApproved = m_this.Decorator.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid)
bool isHumanApproved = m_this.GuessCache.get_IntProp(m_hvoDefault, InterlinViewDataCache.OpinionAgentFlid)
!= (int)AnalysisGuessServices.OpinionAgent.Parser;

m_this.SetGuessing(m_vwenv, isHumanApproved ? ApprovedGuessColor : MachineGuessColor);
Expand Down Expand Up @@ -2287,7 +2287,7 @@ private void EnsureLoader()

internal virtual IParaDataLoader CreateParaLoader()
{
return new InterlinViewCacheLoader(new AnalysisGuessServices(m_cache), Decorator);
return new InterlinViewCacheLoader(new AnalysisGuessServices(m_cache), GuessCache);
}

internal void RecordGuessIfNotKnown(AnalysisOccurrence selected)
Expand Down Expand Up @@ -2413,23 +2413,24 @@ public interface IParaDataLoader
void RecordGuessIfNotKnown(AnalysisOccurrence occurrence);
IAnalysis GetGuessForWordform(IWfiWordform wf, int ws);
AnalysisGuessServices GuessServices { get; }
InterlinViewDataCache GuessCache { get; }
}

public class InterlinViewCacheLoader : IParaDataLoader
{
private InterlinViewDataCache m_sdaDecorator;
private InterlinViewDataCache m_guessCache;
public InterlinViewCacheLoader(AnalysisGuessServices guessServices,
InterlinViewDataCache sdaDecorator)
InterlinViewDataCache guessCache)
{
GuessServices = guessServices;
m_sdaDecorator = sdaDecorator;
m_guessCache = guessCache;
}

/// <summary>
///
/// </summary>
public AnalysisGuessServices GuessServices { get; private set; }
protected InterlinViewDataCache Decorator { get { return m_sdaDecorator; } }
public InterlinViewDataCache GuessCache { get { return m_guessCache; } }

#region IParaDataLoader Members

Expand Down Expand Up @@ -2470,7 +2471,7 @@ internal void LoadAnalysisData(IStTxtPara para, HashSet<IWfiWordform> wordforms)

public void RecordGuessIfNotKnown(AnalysisOccurrence occurrence)
{
if (m_sdaDecorator.get_ObjectProp(occurrence.Analysis.Hvo, InterlinViewDataCache.AnalysisMostApprovedFlid) == 0)
if (m_guessCache.get_ObjectProp(occurrence, InterlinViewDataCache.AnalysisMostApprovedFlid) == 0)
RecordGuessIfAvailable(occurrence);
}

Expand All @@ -2494,16 +2495,16 @@ private void RecordGuessIfAvailable(AnalysisOccurrence occurrence)
// next get the best guess for wordform or analysis

IAnalysis wag = occurrence.Analysis;
IAnalysis wagGuess = GuessServices.GetBestGuess(occurrence, false, false);
IAnalysis wagGuess = GuessServices.GetBestGuess(occurrence, false);
// now record the guess in the decorator.
if (!(wagGuess is NullWAG))
{
SetObjProp(wag.Hvo, InterlinViewDataCache.AnalysisMostApprovedFlid, wagGuess.Hvo);
SetObjProp(occurrence, InterlinViewDataCache.AnalysisMostApprovedFlid, wagGuess.Hvo);
SetInt(wagGuess.Analysis.Hvo, InterlinViewDataCache.OpinionAgentFlid, (int)GuessServices.GetOpinionAgent(wagGuess.Analysis));
}
else
{
SetObjProp(wag.Hvo, InterlinViewDataCache.AnalysisMostApprovedFlid, 0);
SetObjProp(occurrence, InterlinViewDataCache.AnalysisMostApprovedFlid, 0);
}
}

Expand All @@ -2512,15 +2513,9 @@ public IAnalysis GetGuessForWordform(IWfiWordform wf, int ws)
return GuessServices.GetBestGuess(wf, ws);
}

/// <summary>
/// this is so we can subclass the loader to test whether values have actually changed.
/// </summary>
/// <param name="hvo"></param>
/// <param name="flid"></param>
/// <param name="objValue"></param>
protected virtual void SetObjProp(int hvo, int flid, int objValue)
protected virtual void SetObjProp(AnalysisOccurrence occurrence, int flid, int objValue)
{
m_sdaDecorator.SetObjProp(hvo, flid, objValue);
m_guessCache.SetObjProp(occurrence, flid, objValue);
}

/// <summary>
Expand All @@ -2531,7 +2526,7 @@ protected virtual void SetObjProp(int hvo, int flid, int objValue)
/// <param name="n"></param>
protected virtual void SetInt(int hvo, int flid, int n)
{
m_sdaDecorator.SetInt(hvo, flid, n);
m_guessCache.SetInt(hvo, flid, n);
}

#region IParaDataLoader Members
Expand All @@ -2541,8 +2536,8 @@ public void ResetGuessCache()
{
// recreate the guess services, so they will use the latest FDO data.
GuessServices.ClearGuessData();
// clear the Decorator cache for the guesses, so it won't have any stale data.
m_sdaDecorator.ClearPropFromCache(InterlinViewDataCache.AnalysisMostApprovedFlid);
// clear the cache for the guesses, so it won't have any stale data.
m_guessCache.ClearPropFromCache(InterlinViewDataCache.AnalysisMostApprovedFlid);
}

/// <summary>
Expand All @@ -2552,7 +2547,7 @@ public bool UpdatingOccurrence(IAnalysis oldAnalysis, IAnalysis newAnalysis)
{
var result = GuessServices.UpdatingOccurrence(oldAnalysis, newAnalysis);
if (result)
m_sdaDecorator.ClearPropFromCache(InterlinViewDataCache.AnalysisMostApprovedFlid);
m_guessCache.ClearPropFromCache(InterlinViewDataCache.AnalysisMostApprovedFlid);
return result;
}

Expand All @@ -2566,11 +2561,12 @@ public bool UpdatingOccurrence(IAnalysis oldAnalysis, IAnalysis newAnalysis)
internal class ParaDataUpdateTracker : InterlinViewCacheLoader
{
private HashSet<AnalysisOccurrence> m_annotationsChanged = new HashSet<AnalysisOccurrence>();
private HashSet<AnalysisOccurrence> m_annotationsUnchanged = new HashSet<AnalysisOccurrence>();
private AnalysisOccurrence m_currentAnnotation;
HashSet<int> m_analysesWithNewGuesses = new HashSet<int>();

public ParaDataUpdateTracker(AnalysisGuessServices guessServices, InterlinViewDataCache sdaDecorator) :
base(guessServices, sdaDecorator)
public ParaDataUpdateTracker(AnalysisGuessServices guessServices, InterlinViewDataCache guessCache) :
base(guessServices, guessCache)
{
}

Expand Down Expand Up @@ -2598,32 +2594,41 @@ private void MarkCurrentAnnotationAsChanged()
/// </summary>
internal IList<AnalysisOccurrence> ChangedAnnotations
{
get { return m_annotationsChanged.ToArray(); }
get
{
// Include occurrences that are unchanged but might add a yellow background.
foreach (var unchangedAnnotation in m_annotationsUnchanged)
{
if (m_analysesWithNewGuesses.Contains(unchangedAnnotation.Analysis.Hvo))
{
m_annotationsChanged.Add(unchangedAnnotation);
}
}
return m_annotationsChanged.ToArray();
}
}

protected override void SetObjProp(int hvo, int flid, int newObjValue)
protected override void SetObjProp(AnalysisOccurrence occurrence, int flid, int newObjValue)
{
int oldObjValue = Decorator.get_ObjectProp(hvo, flid);
int oldObjValue = GuessCache.get_ObjectProp(occurrence, flid);
if (oldObjValue != newObjValue)
{
base.SetObjProp(hvo, flid, newObjValue);
m_analysesWithNewGuesses.Add(hvo);
base.SetObjProp(occurrence, flid, newObjValue);
m_annotationsChanged.Add(occurrence);
m_analysesWithNewGuesses.Add(occurrence.Analysis.Hvo);
MarkCurrentAnnotationAsChanged();
return;
}
// If we find more than one occurrence of the same analysis, only the first time
// will its guess change. But all of them need to be updated! So any occurrence whose
// guess has changed needs to be marked as changed.
if (m_currentAnnotation != null && m_currentAnnotation.Analysis !=null
&& m_analysesWithNewGuesses.Contains(m_currentAnnotation.Analysis.Hvo))
else
{
MarkCurrentAnnotationAsChanged();
// We will want to redisplay these with a yellow background
// if the number of possibilities change.
m_annotationsUnchanged.Add(occurrence);
}
}

protected override void SetInt(int hvo, int flid, int newValue)
{
int oldValue = Decorator.get_IntProp(hvo, flid);
int oldValue = GuessCache.get_IntProp(hvo, flid);
if (oldValue != newValue)
{
base.SetInt(hvo, flid, newValue);
Expand Down
Loading
Loading