Skip to content

Commit

Permalink
Merge pull request #78 from mhutch/completion-context
Browse files Browse the repository at this point in the history 
Add extensible context on XmlCompletionSource
  • Loading branch information
@mhutch
mhutch authored Oct 10, 2023
2 parents e7fd893 + 867f88e commit d6ae6b9
Show file tree
Hide file tree
Showing 5 changed files with 184 additions and 138 deletions.
3 changes: 2 additions & 1 deletion Core/Completion/XmlCompletionTriggering.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ public enum XmlTriggerReason
{
Invocation,
TypedChar,
Backspace
Backspace,
Unknown
}
}
25 changes: 9 additions & 16 deletions Editor.Tests/Completion/XmlCompletionTestSource.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
using MonoDevelop.Xml.Editor.Completion;
using MonoDevelop.Xml.Editor.Logging;
using MonoDevelop.Xml.Editor.Parsing;
using MonoDevelop.Xml.Parser;

namespace MonoDevelop.Xml.Editor.Tests.Completion
{
Expand All @@ -47,35 +48,24 @@ public IAsyncCompletionSource GetOrCreate (ITextView textView)
}
}

class XmlCompletionTestSource : XmlCompletionSource
class XmlCompletionTestSource : XmlCompletionSource<XmlCompletionTriggerContext>
{
public XmlCompletionTestSource (ITextView textView, ILogger logger, XmlParserProvider parserProvider) : base (textView, logger, parserProvider)
{
}

protected override Task<IList<CompletionItem>?> GetElementCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
bool includeBracket,
CancellationToken token)
protected override Task<IList<CompletionItem>?> GetElementCompletionsAsync (XmlCompletionTriggerContext context, bool includeBracket, CancellationToken token)
{
var item = new CompletionItem (includeBracket? "<Hello" : "Hello", this)
.AddKind (XmlCompletionItemKind.Element);
var items = new List<CompletionItem> () { item };
items.AddRange (GetMiscellaneousTags (triggerLocation, nodePath, includeBracket));
items.AddRange (GetMiscellaneousTags (context.TriggerLocation, context.NodePath, includeBracket));
return Task.FromResult<IList<CompletionItem>?> (items);
}

protected override Task<IList<CompletionItem>?> GetAttributeCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
IAttributedXObject attributedObject,
Dictionary<string, string> existingAtts,
CancellationToken token)
protected override Task<IList<CompletionItem>?> GetAttributeCompletionsAsync (XmlCompletionTriggerContext context, IAttributedXObject attributedObject, Dictionary<string, string> existingAtts, CancellationToken token)
{
if (nodePath.LastOrDefault () is XElement xel && xel.NameEquals ("Hello", true)) {
if (context.NodePath.LastOrDefault () is XElement xel && xel.NameEquals ("Hello", true)) {
var item = new CompletionItem ("There", this)
.AddKind (XmlCompletionItemKind.Attribute);
var items = new List<CompletionItem> () { item };
Expand All @@ -84,5 +74,8 @@ public XmlCompletionTestSource (ITextView textView, ILogger logger, XmlParserPro

return Task.FromResult<IList<CompletionItem>?> (null);
}

protected override XmlCompletionTriggerContext CreateTriggerContext (IAsyncCompletionSession session, CompletionTrigger trigger, XmlSpineParser spineParser, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan)
=> new (session, triggerLocation, spineParser, trigger, applicableToSpan);
}
}
2 changes: 1 addition & 1 deletion Editor.Tests/XmlTestEnvironment.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ protected virtual async Task OnInitialize ()

protected virtual IEnumerable<string> GetAssembliesToCompose () => new[] {
typeof (XmlParser).Assembly.Location,
typeof (XmlCompletionSource).Assembly.Location,
typeof (XmlCompletionSource<>).Assembly.Location,
typeof (XmlTestEnvironment).Assembly.Location
};

Expand Down
198 changes: 78 additions & 120 deletions Editor/Completion/XmlCompletionSource.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@

using MonoDevelop.Xml.Dom;
using MonoDevelop.Xml.Editor.Parsing;
using MonoDevelop.Xml.Logging;
using MonoDevelop.Xml.Parser;

namespace MonoDevelop.Xml.Editor.Completion
{
public abstract partial class XmlCompletionSource : IAsyncCompletionSource
public abstract partial class XmlCompletionSource<TCompletionTriggerContext> : IAsyncCompletionSource where TCompletionTriggerContext : XmlCompletionTriggerContext
{
protected XmlParserProvider XmlParserProvider { get; }

Expand All @@ -42,7 +43,7 @@ protected XmlCompletionSource (ITextView textView, ILogger logger, XmlParserProv
XmlParserProvider = parserProvider;
TextView = textView;
Logger = logger;
InitializeBuiltinItems ();
InitializeBuiltInItems ();
}

protected XmlBackgroundParser GetParser (ITextBuffer textBuffer) => XmlParserProvider.GetParser (textBuffer);
Expand All @@ -54,11 +55,23 @@ protected XmlSpineParser GetSpineParser (SnapshotPoint snapshotPoint)
return spineParser;
}

public async virtual Task<CompletionContext> GetCompletionContextAsync (IAsyncCompletionSession session, CompletionTrigger trigger, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan, CancellationToken token)
public Task<CompletionContext> GetCompletionContextAsync (IAsyncCompletionSession session, CompletionTrigger trigger, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan, CancellationToken token)
=> Logger.InvokeAndLogExceptions (() => GetCompletionContextAsyncInternal (session, trigger, triggerLocation, applicableToSpan, token));

async Task<CompletionContext> GetCompletionContextAsyncInternal (IAsyncCompletionSession session, CompletionTrigger trigger, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan, CancellationToken token)
{
var tasks = GetCompletionTasks (session, trigger, triggerLocation, applicableToSpan, token).ToList ();
var spineParser = GetSpineParser (triggerLocation);
var triggerContext = CreateTriggerContext (session, trigger, spineParser, triggerLocation, applicableToSpan);

if (!triggerContext.IsSupportedTriggerReason) {
return CompletionContext.Empty;
}

await Task.WhenAll (tasks);
await triggerContext.InitializeNodePath (Logger, token).ConfigureAwait (false);

var tasks = GetCompletionTasks (triggerContext, token).ToList ();

await Task.WhenAll (tasks).ConfigureAwait (false);

var allItems = ImmutableArray<CompletionItem>.Empty;
foreach (var task in tasks) {
Expand All @@ -76,89 +89,83 @@ public async virtual Task<CompletionContext> GetCompletionContextAsync (IAsyncCo
return new CompletionContext (allItems, null, InitialSelectionHint.SoftSelection);
}

IEnumerable<Task<IList<CompletionItem>?>> GetCompletionTasks (IAsyncCompletionSession session, CompletionTrigger trigger, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan, CancellationToken cancellationToken)
{
yield return GetAdditionalCompletionsAsync (session, trigger, triggerLocation, applicableToSpan, cancellationToken);

var reason = ConvertReason (trigger.Reason, trigger.Character);
if (reason == null) {
yield break;
}

var parser = GetSpineParser (triggerLocation);

// FIXME: cache the value from InitializeCompletion somewhere?
var kind = XmlCompletionTriggering.GetTrigger (parser, reason.Value, trigger.Character);
/// <summary>
/// Construct a context that gathers computed information about the current completion trigger point.
/// </summary>
protected abstract TCompletionTriggerContext CreateTriggerContext (IAsyncCompletionSession session, CompletionTrigger trigger, XmlSpineParser spineParser, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan);

if (kind == XmlCompletionTrigger.None) {
yield break;
}
IEnumerable<Task<IList<CompletionItem>?>> GetCompletionTasks (TCompletionTriggerContext triggerContext, CancellationToken cancellationToken)
{
yield return GetAdditionalCompletionsAsync (triggerContext, cancellationToken);

if (!parser.TryGetNodePath (triggerLocation.Snapshot, out List<XObject>? nodePath, cancellationToken: cancellationToken)) {
if (triggerContext.XmlTriggerKind == XmlCompletionTrigger.None) {
yield break;
}

session.Properties.AddProperty (typeof (XmlCompletionTrigger), kind);
// this is used by XmlCompletionCommitManager.ShouldCommitCompletion to determine whether XmlCompletionSource participated in the session and how the completion should be committed
triggerContext.Session.Properties[typeof (XmlCompletionTrigger)] = triggerContext.XmlTriggerKind;

switch (kind) {
switch (triggerContext.XmlTriggerKind) {
case XmlCompletionTrigger.ElementValue:
yield return GetElementValueCompletionsAsync (session, triggerLocation, nodePath, cancellationToken);
yield return GetElementValueCompletionsAsync (triggerContext, cancellationToken);
goto case XmlCompletionTrigger.Tag;

case XmlCompletionTrigger.Tag:
case XmlCompletionTrigger.ElementName:
// if we're completing an existing element, remove it from the path
// so we don't get completions for its children instead
if (nodePath.Count > 0) {
if (nodePath[nodePath.Count - 1] is XElement leaf && leaf.Name.Length == applicableToSpan.Length) {
nodePath.RemoveAt (nodePath.Count - 1);
}
}
//TODO: if it's on the first or second line and there's no DTD declaration, add the DTDs, or at least <!DOCTYPE
//TODO: add snippets // MonoDevelop.Ide.CodeTemplates.CodeTemplateService.AddCompletionDataForFileName (DocumentContext.Name, list);
yield return GetElementCompletionsAsync (session, triggerLocation, nodePath, kind != XmlCompletionTrigger.ElementName, cancellationToken);
yield return GetElementCompletionsAsync (triggerContext, triggerContext.XmlTriggerKind != XmlCompletionTrigger.ElementName, cancellationToken);
break;

case XmlCompletionTrigger.AttributeName:
if (parser.Spine.TryFind<IAttributedXObject> (maxDepth: 1) is not IAttributedXObject attributedOb) {
if (triggerContext.SpineParser.Spine.TryFind<IAttributedXObject> (maxDepth: 1) is not IAttributedXObject attributedOb) {
throw new InvalidOperationException ("Did not find IAttributedXObject in stack for XmlCompletionTrigger.Attribute");
}
parser.Clone ().AdvanceUntilEnded ((XObject)attributedOb, triggerLocation.Snapshot, 1000);
triggerContext.SpineParser.Clone ().AdvanceUntilEnded ((XObject)attributedOb, triggerContext.TriggerLocation.Snapshot, 1000);
var attributes = attributedOb.Attributes.ToDictionary (StringComparer.OrdinalIgnoreCase);
yield return GetAttributeCompletionsAsync (session, triggerLocation, nodePath, attributedOb, attributes, cancellationToken);
yield return GetAttributeCompletionsAsync (triggerContext, attributedOb, attributes, cancellationToken);
break;

case XmlCompletionTrigger.AttributeValue:
if (parser.Spine.TryPeek (out XAttribute? att) && parser.Spine.TryPeek (1, out IAttributedXObject? attributedObject)) {
yield return GetAttributeValueCompletionsAsync (session, triggerLocation, nodePath, attributedObject, att, cancellationToken);
if (triggerContext.SpineParser.Spine.TryPeek (out XAttribute? att) && triggerContext.SpineParser.Spine.TryPeek (1, out IAttributedXObject? attributedObject)) {
yield return GetAttributeValueCompletionsAsync (triggerContext, attributedObject, att, cancellationToken);
}
break;

case XmlCompletionTrigger.Entity:
yield return GetEntityCompletionsAsync (session, triggerLocation, nodePath, cancellationToken);
yield return GetEntityCompletionsAsync (triggerContext, cancellationToken);
break;

case XmlCompletionTrigger.DocType:
case XmlCompletionTrigger.DeclarationOrCDataOrComment:
yield return GetDeclarationCompletionsAsync (session, triggerLocation, nodePath, cancellationToken);
yield return GetDeclarationCompletionsAsync (triggerContext, cancellationToken);
break;
}
}

public virtual Task<object> GetDescriptionAsync (IAsyncCompletionSession session, CompletionItem item, CancellationToken token) => item.GetDocumentationAsync (session, token);
public Task<object> GetDescriptionAsync (IAsyncCompletionSession session, CompletionItem item, CancellationToken token)
=> Logger.InvokeAndLogExceptions (() => item.GetDocumentationAsync (session, token));

public virtual CompletionStartData InitializeCompletion (CompletionTrigger trigger, SnapshotPoint triggerLocation, CancellationToken token)
public CompletionStartData InitializeCompletion (CompletionTrigger trigger, SnapshotPoint triggerLocation, CancellationToken token)
=> Logger.InvokeAndLogExceptions (
() => {
var spine = GetSpineParser (triggerLocation);
return InitializeCompletion (trigger, triggerLocation, spine, token);
});

/// <summary>
/// Determine whether the current location is a completion trigger point, and what its span is. Runs on the UI thread so must be fast.
/// </summary>
protected virtual CompletionStartData InitializeCompletion (CompletionTrigger trigger, SnapshotPoint triggerLocation, XmlSpineParser spineParser, CancellationToken token)
{
var reason = ConvertReason (trigger.Reason, trigger.Character);
if (reason == null) {
var reason = XmlCompletionTriggerContext.ConvertReason (trigger.Reason, trigger.Character);
if (reason == XmlTriggerReason.Unknown) {
return CompletionStartData.DoesNotParticipateInCompletion;
}

var spine = GetSpineParser (triggerLocation);

LogAttemptingCompletion (Logger, spine.CurrentState, spine.CurrentStateLength, trigger.Character, trigger.Reason);
LogAttemptingCompletion (Logger, spineParser.CurrentState, spineParser.CurrentStateLength, trigger.Character, trigger.Reason);

var (kind, spanStart, spanLength) = XmlCompletionTriggering.GetTriggerAndSpan (spine, reason.Value, trigger.Character, new SnapshotTextSource (triggerLocation.Snapshot));
var (kind, spanStart, spanLength) = XmlCompletionTriggering.GetTriggerAndSpan (spineParser, reason, trigger.Character, new SnapshotTextSource (triggerLocation.Snapshot));

if (kind != XmlCompletionTrigger.None) {
return new CompletionStartData (CompletionParticipation.ProvidesItems, new SnapshotSpan (triggerLocation.Snapshot, spanStart, spanLength));
Expand All @@ -172,83 +179,34 @@ public virtual CompletionStartData InitializeCompletion (CompletionTrigger trigg
[LoggerMessage (EventId = 2, Level = LogLevel.Trace, Message = "Attempting completion for state '{state}'x{currentSpineLength}, character='{triggerChar}', trigger='{triggerReason}'")]
static partial void LogAttemptingCompletion (ILogger logger, XmlParserState state, int currentSpineLength, char triggerChar, CompletionTriggerReason triggerReason);

protected virtual Task<IList<CompletionItem>?> GetElementCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
bool includeBracket,
CancellationToken token
)
=> Task.FromResult<IList<CompletionItem>?> (null);

protected virtual Task<IList<CompletionItem>?> GetAttributeCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
IAttributedXObject attributedObject,
Dictionary<string, string> existingAtts,
CancellationToken token
)
=> Task.FromResult<IList<CompletionItem>?> (null);

protected virtual Task<IList<CompletionItem>?> GetAttributeValueCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
IAttributedXObject attributedObject,
XAttribute attribute,
CancellationToken token
)
=> Task.FromResult<IList<CompletionItem>?> (null);

protected virtual Task<IList<CompletionItem>?> GetEntityCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
CancellationToken token
)
=> Task.FromResult<IList<CompletionItem>?> (null);

protected virtual Task<IList<CompletionItem>?> GetDeclarationCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
CancellationToken token
)
=> Task.FromResult<IList<CompletionItem>?> (
nodePath.Any (n => n is XElement)
protected virtual Task<IList<CompletionItem>?> GetElementCompletionsAsync (TCompletionTriggerContext context, bool includeBracket, CancellationToken token)
=> TaskCompleted (null);

protected virtual Task<IList<CompletionItem>?> GetAttributeCompletionsAsync (TCompletionTriggerContext context, IAttributedXObject attributedObject, Dictionary<string, string> existingAttributes, CancellationToken token)
=> TaskCompleted (null);

protected virtual Task<IList<CompletionItem>?> GetAttributeValueCompletionsAsync (TCompletionTriggerContext context, IAttributedXObject attributedObject, XAttribute attribute, CancellationToken token)
=> TaskCompleted (null);

protected virtual Task<IList<CompletionItem>?> GetEntityCompletionsAsync (TCompletionTriggerContext context, CancellationToken token)
=> TaskCompleted (null);

protected virtual Task<IList<CompletionItem>?> GetDeclarationCompletionsAsync (TCompletionTriggerContext context, CancellationToken token)
=> TaskCompleted (
context.NodePath.Any (n => n is XElement)
? new [] { cdataItemWithBracket, commentItemWithBracket }
: new [] { commentItemWithBracket }
);

protected virtual Task<IList<CompletionItem>?> GetElementValueCompletionsAsync (
IAsyncCompletionSession session,
SnapshotPoint triggerLocation,
List<XObject> nodePath,
CancellationToken token) => Task.FromResult<IList<CompletionItem>?> (null);
protected virtual Task<IList<CompletionItem>?> GetElementValueCompletionsAsync (TCompletionTriggerContext context, CancellationToken token)
=> TaskCompleted (null);

protected virtual Task<IList<CompletionItem>?> GetAdditionalCompletionsAsync (
IAsyncCompletionSession session,
CompletionTrigger trigger,
SnapshotPoint triggerLocation,
SnapshotSpan applicableToSpan,
CancellationToken token) => Task.FromResult<IList<CompletionItem>?> (null);
/// <summary>
/// Get additional completions that are not handled by the XmlCompletionSource.
protected virtual Task<IList<CompletionItem>?> GetAdditionalCompletionsAsync (TCompletionTriggerContext context, CancellationToken token)
=> TaskCompleted (null);

static XmlTriggerReason? ConvertReason (CompletionTriggerReason reason, char typedChar)
{
switch (reason) {
case CompletionTriggerReason.Insertion:
if (typedChar != '\0')
return XmlTriggerReason.TypedChar;
break;
case CompletionTriggerReason.Backspace:
return XmlTriggerReason.Backspace;
case CompletionTriggerReason.Invoke:
case CompletionTriggerReason.InvokeAndCommitIfUnique:
return XmlTriggerReason.Invocation;
}
return null;
}
static Task<IList<CompletionItem>?> TaskCompleted (IList<CompletionItem>? items) => Task.FromResult (items);

CompletionItem cdataItem, commentItem, prologItem;
CompletionItem cdataItemWithBracket, commentItemWithBracket, prologItemWithBracket;
Expand All @@ -258,7 +216,7 @@ CancellationToken token
nameof (cdataItem), nameof (commentItem), nameof (prologItem),
nameof (cdataItemWithBracket), nameof (commentItemWithBracket), nameof (prologItemWithBracket),
nameof (entityItems))]
void InitializeBuiltinItems ()
void InitializeBuiltInItems ()
{
cdataItem = new CompletionItem ("![CDATA[", this, XmlImages.CData)
.AddDocumentation ("XML character data")
Expand Down
Loading

0 comments on commit d6ae6b9

Please sign in to comment.