support source tag

CppCXY · CppCXY · commit 5cb1d6b5007a · 2024-08-05T17:28:15.000+08:00
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/AttachDeclarationAnalyzer.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/AttachDeclarationAnalyzer.cs
@@ -73,6 +73,16 @@ private void AnalyzeGeneralDeclaration(LuaSyntaxElement attachedElement, List<Lu
                             declarationContext.Db.AddMapping(declaration.UniqueId, name);
                         }
 
+                        break;
+                    }
+                    case LuaDocTagSourceSyntax sourceSyntax:
+                    {
+                        if (sourceSyntax.Source is { Value: { } source })
+                        {
+                            declaration.Feature |= SymbolFeature.Source;
+                            declarationContext.Db.AddSource(declaration.UniqueId, source);
+                        }
+
                         break;
                     }
                 }
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/DeclarationWalker.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/DeclarationWalker.cs
@@ -193,6 +193,11 @@ public void WalkIn(LuaSyntaxElement node)
                 AnalyzeTagUsing(usingSyntax);
                 break;
             }
+            case LuaDocTagSourceSyntax sourceSyntax:
+            {
+                AnalyzeTagSource(sourceSyntax);
+                break;
+            }
         }
     }
 
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/TagDocWalker.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/TagDocWalker.cs
@@ -288,6 +288,11 @@ private void AnalyzeTagUsing(LuaDocTagUsingSyntax usingSyntax)
         }
     }
 
+    private void AnalyzeTagSource(LuaDocTagSourceSyntax sourceSyntax)
+    {
+        declarationContext.AttachDoc(sourceSyntax);
+    }
+
     private void AnalyzeSimpleTag(LuaDocTagSyntax tagSyntax)
     {
         declarationContext.AttachDoc(tagSyntax);
diff --git a/EmmyLua/CodeAnalysis/Compilation/Index/ProjectIndex.cs b/EmmyLua/CodeAnalysis/Compilation/Index/ProjectIndex.cs
@@ -31,6 +31,8 @@ public class ProjectIndex
 
     private Dictionary<LuaDocumentId, LuaDeclarationTree> DocumentDeclarationTrees { get; } = new();
 
+    private InFileIndex<SyntaxElementId, string> Source { get; } = new();
+
     private UniqueIndex<SyntaxElementId, string> MappingName { get; } = new();
 
     public void Remove(LuaDocumentId documentId)
@@ -43,6 +45,7 @@ public void Remove(LuaDocumentId documentId)
         InFiledReferences.Remove(documentId);
         InFiledDeclarations.Remove(documentId);
         DocumentDeclarationTrees.Remove(documentId);
+        Source.Remove(documentId);
     }
 
     #region Add
@@ -111,6 +114,11 @@ public void AddTableField(LuaDocumentId documentId, LuaTableFieldSyntax tableFie
         }
     }
 
+    public void AddSource(SyntaxElementId id, string source)
+    {
+        Source.Add(id.DocumentId, id, source);
+    }
+
     #endregion
 
     #region Query
@@ -195,5 +203,10 @@ public IEnumerable<LuaElementPtr<LuaExprSyntax>> QueryModuleReturns(LuaDocumentI
         return MappingName.Query(id);
     }
 
+    public string? QuerySource(SyntaxElementId id)
+    {
+        return Source.Query(id);
+    }
+
     #endregion
 }
diff --git a/EmmyLua/CodeAnalysis/Compilation/Symbol/LuaSymbol.cs b/EmmyLua/CodeAnalysis/Compilation/Symbol/LuaSymbol.cs
@@ -21,6 +21,7 @@ public enum SymbolFeature
     Global = 0x04,
     NoDiscard = 0x08,
     Async = 0x10,
+    Source = 0x20,
 }
 
 public enum SymbolVisibility
@@ -57,6 +58,8 @@ public class LuaSymbol(
 
     public bool IsNoDiscard => Feature.HasFlag(SymbolFeature.NoDiscard);
 
+    public bool HasSource => Feature.HasFlag(SymbolFeature.Source);
+
     public SymbolVisibility Visibility { get; internal set; } = visibility;
 
     public bool IsPublic => Visibility == SymbolVisibility.Public;
@@ -132,6 +135,30 @@ public bool ValidateFrameworkVersions(List<FrameworkVersion> versions)
 
     public virtual LuaLocation? GetLocation(SearchContext context)
     {
+        if (HasSource)
+        {
+            var source = context.Compilation.Db.QuerySource(UniqueId);
+            if (source is not null)
+            {
+                var parts = source.Split('#');
+                var uri = string.Empty;
+                var line = 0;
+                if (parts.Length == 2)
+                {
+                    uri = parts[0];
+                    if (!int.TryParse(parts[1], out line))
+                    {
+                        return null;
+                    }
+                }
+
+                if (uri.Length > 0)
+                {
+                    return new LuaLocation(line, 0, line, 0, uri);
+                }
+            }
+        }
+
         var document = context.Compilation.Project.GetDocument(Info.Ptr.DocumentId);
         if (document is not null)
         {
diff --git a/EmmyLua/CodeAnalysis/Compile/Grammar/Doc/Tags.cs b/EmmyLua/CodeAnalysis/Compile/Grammar/Doc/Tags.cs
@@ -107,6 +107,10 @@ public static CompleteMarker Tag(LuaDocParser p)
             {
                 return TagUsing(p);
             }
+            case LuaTokenKind.TkTagSource:
+            {
+                return TagSource(p);
+            }
             case LuaTokenKind.TkTagMeta:
             {
                 return SimpleTag(p, LuaSyntaxKind.DocMeta);
@@ -794,6 +798,22 @@ private static CompleteMarker TagUsing(LuaDocParser p)
         }
     }
 
+    private static CompleteMarker TagSource(LuaDocParser p)
+    {
+        p.SetState(LuaDocLexerState.Normal);
+        var m = p.Marker();
+        p.Bump();
+        try
+        {
+            p.Expect(LuaTokenKind.TkString);
+            return m.Complete(p, LuaSyntaxKind.DocSource);
+        }
+        catch (UnexpectedTokenException e)
+        {
+            return m.Fail(p, LuaSyntaxKind.DocSource, e.Message);
+        }
+    }
+
     private static void ExtensionTypeList(LuaDocParser p)
     {
         p.Bump();
diff --git a/EmmyLua/CodeAnalysis/Compile/Lexer/LuaDocLexer.cs b/EmmyLua/CodeAnalysis/Compile/Lexer/LuaDocLexer.cs
@@ -58,6 +58,7 @@ private static LuaTokenKind ToTag(ReadOnlySpan<char> text)
             "mapping" => LuaTokenKind.TkTagMapping,
             "namespace" => LuaTokenKind.TkTagNamespace,
             "using" => LuaTokenKind.TkTagUsing,
+            "source" => LuaTokenKind.TkTagSource,
             _ => LuaTokenKind.TkTagOther
         };
     }
diff --git a/EmmyLua/CodeAnalysis/Syntax/Kind/LuaSyntaxKind.cs b/EmmyLua/CodeAnalysis/Syntax/Kind/LuaSyntaxKind.cs
@@ -77,6 +77,7 @@ public enum LuaSyntaxKind : ushort
     DocMapping,
     DocNamespace,
     DocUsing,
+    DocSource,
 
     DocDetailField,
     DocBody,
diff --git a/EmmyLua/CodeAnalysis/Syntax/Kind/LuaTokenKind.cs b/EmmyLua/CodeAnalysis/Syntax/Kind/LuaTokenKind.cs
@@ -114,6 +114,7 @@ public enum LuaTokenKind : ushort
     TkTagMapping, // mapping
     TkTagNamespace, // namespace
     TkTagUsing, // using
+    TkTagSource, // source
 
     TkDocOr, // |
     TkDocContinue, // ---
diff --git a/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxFactory.cs b/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxFactory.cs
@@ -74,6 +74,7 @@ public static LuaSyntaxElement CreateSyntax(int index, LuaSyntaxTree tree)
                 LuaSyntaxKind.DocMapping => new LuaDocTagMappingSyntax(index, tree),
                 LuaSyntaxKind.DocNamespace => new LuaDocTagNamespaceSyntax(index, tree),
                 LuaSyntaxKind.DocUsing => new LuaDocTagUsingSyntax(index, tree),
+                LuaSyntaxKind.DocSource => new LuaDocTagSourceSyntax(index, tree),
                 LuaSyntaxKind.TypeArray => new LuaDocArrayTypeSyntax(index, tree),
                 LuaSyntaxKind.TypeUnion => new LuaDocUnionTypeSyntax(index, tree),
                 LuaSyntaxKind.TypeFun => new LuaDocFuncTypeSyntax(index, tree),
diff --git a/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxNodes/DocTag.cs b/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxNodes/DocTag.cs
@@ -186,3 +186,8 @@ public class LuaDocTagUsingSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSynt
 {
     public LuaNameToken? Using => FirstChild<LuaNameToken>();
 }
+
+public class LuaDocTagSourceSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSyntax(index, tree)
+{
+    public LuaStringToken? Source => FirstChild<LuaStringToken>();
+}
diff --git a/EmmyLuaAnalyzer.sln.DotSettings.user b/EmmyLuaAnalyzer.sln.DotSettings.user
@@ -12,6 +12,7 @@
 	<s:String x:Key="/Default/CodeInspection/ExcludedFiles/FilesAndFoldersToSkip2/=7020124F_002D9FFC_002D4AC3_002D8F3D_002DAAB8E0240759_002Ff_003ATask_002Ecs_002Fl_003A_002E_002E_003F_002E_002E_003F_002E_002E_003FAppData_003FLocal_003FSymbols_003Fsrc_003Fdotnet_003Fruntime_003Fa5cc707d976a14495462c9c492a921ff0927b8f5_003Fsrc_003Flibraries_003FSystem_002EPrivate_002ECoreLib_003Fsrc_003FSystem_003FThreading_003FTasks_003FTask_002Ecs/@EntryIndexedValue">ForceIncluded</s:String>
 	<s:String x:Key="/Default/CodeInspection/ExcludedFiles/FilesAndFoldersToSkip2/=7020124F_002D9FFC_002D4AC3_002D8F3D_002DAAB8E0240759_002Ff_003ATask_002Ecs_002Fl_003A_002E_002E_003F_002E_002E_003F_002E_002E_003FAppData_003FRoaming_003FJetBrains_003FRider2024_002E2_003Fresharper_002Dhost_003FDecompilerCache_003Fdecompiler_003Fbbd9fa7e8a144347ab86a6809b8a3a35d888b0_003Fb4_003Fb43d260d_003FTask_002Ecs/@EntryIndexedValue">ForceIncluded</s:String>
 	<s:String x:Key="/Default/CodeInspection/ExcludedFiles/FilesAndFoldersToSkip2/=7020124F_002D9FFC_002D4AC3_002D8F3D_002DAAB8E0240759_002Ff_003AThrowHelper_002Ecs_002Fl_003A_002E_002E_003F_002E_002E_003F_002E_002E_003FAppData_003FRoaming_003FJetBrains_003FRider2024_002E2_003Fresharper_002Dhost_003FSourcesCache_003Ff1f9ab578012cc3dceb8f59c6638f4d6c55ba5fd7ec6a6e11919f76fdfc2d8_003FThrowHelper_002Ecs/@EntryIndexedValue">ForceIncluded</s:String>
+	<s:String x:Key="/Default/CodeInspection/ExcludedFiles/FilesAndFoldersToSkip2/=7020124F_002D9FFC_002D4AC3_002D8F3D_002DAAB8E0240759_002Ff_003AUriExt_002Ecs_002Fl_003A_002E_002E_003F_002E_002E_003F_002E_002E_003FAppData_003FLocal_003FSymbols_003Fsrc_003Fdotnet_003Fruntime_003Fa5cc707d976a14495462c9c492a921ff0927b8f5_003Fsrc_003Flibraries_003FSystem_002EPrivate_002EUri_003Fsrc_003FSystem_003FUriExt_002Ecs/@EntryIndexedValue">ForceIncluded</s:String>
 	<s:Boolean x:Key="/Default/CodeStyle/Naming/CSharpNaming/ApplyAutoDetectedRules/@EntryValue">False</s:Boolean>
 	<s:String x:Key="/Default/Environment/AssemblyExplorer/XmlDocument/@EntryValue">&lt;AssemblyExplorer&gt;&#xD;
   &lt;Assembly Path="C:\Users\zc\.nuget\packages\newtonsoft.json\13.0.3\lib\net6.0\Newtonsoft.Json.dll" /&gt;&#xD;

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,16 @@ private void AnalyzeGeneralDeclaration(LuaSyntaxElement attachedElement, List<Lu`
`73`	`73`	`declarationContext.Db.AddMapping(declaration.UniqueId, name);`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ break;`
	`77`	`+ }`
	`78`	`+ case LuaDocTagSourceSyntax sourceSyntax:`
	`79`	`+ {`
	`80`	`+ if (sourceSyntax.Source is { Value: { } source })`
	`81`	`+ {`
	`82`	`+ declaration.Feature \|= SymbolFeature.Source;`
	`83`	`+ declarationContext.Db.AddSource(declaration.UniqueId, source);`
	`84`	`+ }`
	`85`	`+`
`76`	`86`	`break;`
`77`	`87`	`}`
`78`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,6 +193,11 @@ public void WalkIn(LuaSyntaxElement node)`
`193`	`193`	`AnalyzeTagUsing(usingSyntax);`
`194`	`194`	`break;`
`195`	`195`	`}`
	`196`	`+ case LuaDocTagSourceSyntax sourceSyntax:`
	`197`	`+ {`
	`198`	`+ AnalyzeTagSource(sourceSyntax);`
	`199`	`+ break;`
	`200`	`+ }`
`196`	`201`	`}`
`197`	`202`	`}`
`198`	`203`
Original file line number	Diff line number	Diff line change
`@@ -288,6 +288,11 @@ private void AnalyzeTagUsing(LuaDocTagUsingSyntax usingSyntax)`
`288`	`288`	`}`
`289`	`289`	`}`
`290`	`290`
	`291`	`+ private void AnalyzeTagSource(LuaDocTagSourceSyntax sourceSyntax)`
	`292`	`+ {`
	`293`	`+ declarationContext.AttachDoc(sourceSyntax);`
	`294`	`+ }`
	`295`	`+`
`291`	`296`	`private void AnalyzeSimpleTag(LuaDocTagSyntax tagSyntax)`
`292`	`297`	`{`
`293`	`298`	`declarationContext.AttachDoc(tagSyntax);`
Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,10 @@ public static CompleteMarker Tag(LuaDocParser p)`
`107`	`107`	`{`
`108`	`108`	`return TagUsing(p);`
`109`	`109`	`}`
	`110`	`+ case LuaTokenKind.TkTagSource:`
	`111`	`+ {`
	`112`	`+ return TagSource(p);`
	`113`	`+ }`
`110`	`114`	`case LuaTokenKind.TkTagMeta:`
`111`	`115`	`{`
`112`	`116`	`return SimpleTag(p, LuaSyntaxKind.DocMeta);`
`@@ -794,6 +798,22 @@ private static CompleteMarker TagUsing(LuaDocParser p)`
`794`	`798`	`}`
`795`	`799`	`}`
`796`	`800`
	`801`	`+ private static CompleteMarker TagSource(LuaDocParser p)`
	`802`	`+ {`
	`803`	`+ p.SetState(LuaDocLexerState.Normal);`
	`804`	`+ var m = p.Marker();`
	`805`	`+ p.Bump();`
	`806`	`+ try`
	`807`	`+ {`
	`808`	`+ p.Expect(LuaTokenKind.TkString);`
	`809`	`+ return m.Complete(p, LuaSyntaxKind.DocSource);`
	`810`	`+ }`
	`811`	`+ catch (UnexpectedTokenException e)`
	`812`	`+ {`
	`813`	`+ return m.Fail(p, LuaSyntaxKind.DocSource, e.Message);`
	`814`	`+ }`
	`815`	`+ }`
	`816`	`+`
`797`	`817`	`private static void ExtensionTypeList(LuaDocParser p)`
`798`	`818`	`{`
`799`	`819`	`p.Bump();`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ private static LuaTokenKind ToTag(ReadOnlySpan<char> text)`
`58`	`58`	`"mapping" => LuaTokenKind.TkTagMapping,`
`59`	`59`	`"namespace" => LuaTokenKind.TkTagNamespace,`
`60`	`60`	`"using" => LuaTokenKind.TkTagUsing,`
	`61`	`+ "source" => LuaTokenKind.TkTagSource,`
`61`	`62`	`_ => LuaTokenKind.TkTagOther`
`62`	`63`	`};`
`63`	`64`	`}`