support ---@module no-require

CppCXY · CppCXY · commit 2514e7943b8b · 2024-07-04T15:46:39.000+08:00
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/AttachDeclarationAnalyzer.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/AttachDeclarationAnalyzer.cs
@@ -65,6 +65,15 @@ private void AnalyzeGeneralDeclaration(LuaSyntaxElement attachedElement, List<Lu
                         declaration.Feature |= DeclarationFeature.Async;
                         break;
                     }
+                    case LuaDocTagMappingSyntax mappingSyntax:
+                    {
+                        if (mappingSyntax.Name is { RepresentText: { } name })
+                        {
+                            declaration.Name = name;
+                        }
+
+                        break;
+                    }
                 }
             }
         }
@@ -147,9 +156,9 @@ private IEnumerable<LuaDeclaration> FindDeclarations(LuaSyntaxElement element)
             {
                 switch (funcStatSyntax)
                 {
-                    case { IsLocal: true, LocalName.Name: { } name }:
+                    case { IsLocal: true, LocalName: { } name }:
                     {
-                        if (declarationContext.GetAttachedDeclaration(funcStatSyntax.LocalName) is { } luaDeclaration)
+                        if (declarationContext.GetAttachedDeclaration(name) is { } luaDeclaration)
                         {
                             yield return luaDeclaration;
                         }
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/DeclarationWalker.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/DeclarationWalker.cs
@@ -178,6 +178,11 @@ public void WalkIn(LuaSyntaxElement node)
                 AnalyzeSimpleTag(overloadSyntax);
                 break;
             }
+            case LuaDocTagMappingSyntax mappingSyntax:
+            {
+                AnalyzeSimpleTag(mappingSyntax);
+                break;
+            }
         }
     }
 
diff --git a/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/TagDocWalker.cs b/EmmyLua/CodeAnalysis/Compilation/Analyzer/DeclarationAnalyzer/DeclarationWalker/TagDocWalker.cs
@@ -172,6 +172,10 @@ private void AnalyzeTagModule(LuaDocTagModuleSyntax moduleSyntax)
         {
             Compilation.Workspace.ModuleManager.AddVirtualModule(DocumentId, moduleName);
         }
+        else if (moduleSyntax.Action is { Text: "no-require" })
+        {
+            Compilation.Workspace.ModuleManager.AddDisableRequire(DocumentId);
+        }
     }
 
     private void AnalyzeTagDiagnostic(LuaDocTagDiagnosticSyntax diagnosticSyntax)
diff --git a/EmmyLua/CodeAnalysis/Compilation/Declaration/LuaDeclaration.cs b/EmmyLua/CodeAnalysis/Compilation/Declaration/LuaDeclaration.cs
@@ -40,7 +40,7 @@ public class LuaDeclaration(
 )
     : IDeclaration
 {
-    public string Name { get; } = name;
+    public string Name { get; internal set; } = name;
 
     public LuaType Type => Info.DeclarationType ?? Builtin.Unknown;
 
diff --git a/EmmyLua/CodeAnalysis/Compilation/Infer/DeclarationInfer.cs b/EmmyLua/CodeAnalysis/Compilation/Infer/DeclarationInfer.cs
@@ -6,7 +6,6 @@ namespace EmmyLua.CodeAnalysis.Compilation.Infer;
 
 public static class DeclarationInfer
 {
-
     public static LuaType InferLocalName(LuaLocalNameSyntax localName, SearchContext context)
     {
         var symbol = context.FindDeclaration(localName);
diff --git a/EmmyLua/CodeAnalysis/Compile/Grammar/Doc/Tags.cs b/EmmyLua/CodeAnalysis/Compile/Grammar/Doc/Tags.cs
@@ -95,6 +95,10 @@ public static CompleteMarker Tag(LuaDocParser p)
             {
                 return TagModule(p);
             }
+            case LuaTokenKind.TkTagMapping:
+            {
+                return TagMapping(p);
+            }
             case LuaTokenKind.TkTagMeta:
             {
                 return SimpleTag(p, LuaSyntaxKind.DocMeta);
@@ -709,7 +713,19 @@ private static CompleteMarker TagModule(LuaDocParser p)
         p.Bump();
         try
         {
-            p.Expect(LuaTokenKind.TkString);
+            if (p.Current is LuaTokenKind.TkString)
+            {
+                p.Bump();
+            }
+            else if (p.Current is LuaTokenKind.TkName)
+            {
+                p.Bump();
+            }
+            else
+            {
+                throw new UnexpectedTokenException("expected <name> or <string>", p.Current);
+            }
+
             DescriptionParser.Description(p);
             return m.Complete(p, LuaSyntaxKind.DocModule);
         }
@@ -719,6 +735,23 @@ private static CompleteMarker TagModule(LuaDocParser p)
         }
     }
 
+    private static CompleteMarker TagMapping(LuaDocParser p)
+    {
+        p.SetState(LuaDocLexerState.Normal);
+        var m = p.Marker();
+        p.Bump();
+        try
+        {
+            p.Expect(LuaTokenKind.TkName);
+            DescriptionParser.Description(p);
+            return m.Complete(p, LuaSyntaxKind.DocMapping);
+        }
+        catch (UnexpectedTokenException e)
+        {
+            return m.Fail(p, LuaSyntaxKind.DocMapping, 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
@@ -48,14 +48,14 @@ private static LuaTokenKind ToTag(ReadOnlySpan<char> text)
             "async" => LuaTokenKind.TkTagAsync,
             "cast" => LuaTokenKind.TkTagCast,
             "deprecated" => LuaTokenKind.TkTagDeprecated,
-            "private" or "protected" or "public" or "package" => LuaTokenKind.TkTagVisibility,
-            // TODO internal
+            "private" or "protected" or "public" or "package" or "internal" => LuaTokenKind.TkTagVisibility,
             "diagnostic" => LuaTokenKind.TkTagDiagnostic,
             "meta" => LuaTokenKind.TkTagMeta,
             "version" => LuaTokenKind.TkTagVersion,
             "as" => LuaTokenKind.TkTagAs,
             "nodiscard" => LuaTokenKind.TkTagNodiscard,
             "operator" => LuaTokenKind.TkTagOperator,
+            "mapping" => LuaTokenKind.TkTagMapping,
             _ => LuaTokenKind.TkTagOther
         };
     }
@@ -64,7 +64,7 @@ private static LuaTokenKind ToVisibilityOrName(ReadOnlySpan<char> text)
     {
         return text switch
         {
-            "private" or "protected" or "public" or "package" => LuaTokenKind.TkDocVisibility,
+            "private" or "protected" or "public" or "package" or "internal" => LuaTokenKind.TkDocVisibility,
             _ => LuaTokenKind.TkName
         };
     }
diff --git a/EmmyLua/CodeAnalysis/Syntax/Kind/LuaSyntaxKind.cs b/EmmyLua/CodeAnalysis/Syntax/Kind/LuaSyntaxKind.cs
@@ -74,6 +74,7 @@ public enum LuaSyntaxKind : ushort
     DocNodiscard,
     DocOperator,
     DocModule,
+    DocMapping,
 
     DocDetailField,
     DocBody,
diff --git a/EmmyLua/CodeAnalysis/Syntax/Kind/LuaTokenKind.cs b/EmmyLua/CodeAnalysis/Syntax/Kind/LuaTokenKind.cs
@@ -111,6 +111,7 @@ public enum LuaTokenKind : ushort
     TkTagAs, // as
     TkTagNodiscard, // nodiscard
     TkTagOperator, // operator
+    TkTagMapping, // mapping
 
     TkDocOr, // |
     TkDocContinue, // ---
diff --git a/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxFactory.cs b/EmmyLua/CodeAnalysis/Syntax/Node/SyntaxFactory.cs
@@ -71,6 +71,7 @@ public static LuaSyntaxElement CreateSyntax(int index, LuaSyntaxTree tree)
                 LuaSyntaxKind.DocNodiscard => new LuaDocTagNodiscardSyntax(index, tree),
                 LuaSyntaxKind.DocOperator => new LuaDocTagOperatorSyntax(index, tree),
                 LuaSyntaxKind.DocMeta => new LuaDocTagMetaSyntax(index, tree),
+                LuaSyntaxKind.DocMapping => new LuaDocTagMappingSyntax(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
@@ -161,6 +161,13 @@ public class LuaDocTagMetaSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSynta
 public class LuaDocTagModuleSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSyntax(index, tree)
 {
     public LuaStringToken? Module => FirstChild<LuaStringToken>();
+
+    public LuaNameToken? Action => FirstChild<LuaNameToken>();
+}
+
+public class LuaDocTagMappingSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSyntax(index, tree)
+{
+    public LuaNameToken? Name => FirstChild<LuaNameToken>();
 }
 
 public class LuaDocAttributeSyntax(int index, LuaSyntaxTree tree) : LuaDocTagSyntax(index, tree)
diff --git a/EmmyLua/CodeAnalysis/Syntax/Tree/Token/TokenAnalyzer.cs b/EmmyLua/CodeAnalysis/Syntax/Tree/Token/TokenAnalyzer.cs
@@ -11,7 +11,7 @@ public static class TokenAnalyzer
 {
     public static void Analyze(int redCount, LuaSyntaxTree tree)
     {
-        for (int index = 0; index < redCount; index++)
+        for (var index = 0; index < redCount; index++)
         {
             switch (tree.GetTokenKind(index))
             {
diff --git a/EmmyLua/CodeAnalysis/Workspace/Module/ModuleManager.cs b/EmmyLua/CodeAnalysis/Workspace/Module/ModuleManager.cs
@@ -13,7 +13,9 @@ public class ModuleManager
 
     public Dictionary<string, List<LuaDocumentId>> ModuleNameToDocumentId { get; } = new();
 
-    public HashSet<LuaDocumentId> VirtualDocumentIds { get; } = [];
+    private HashSet<LuaDocumentId> VirtualDocumentIds { get; } = [];
+
+    private HashSet<LuaDocumentId> DisableRequires { get; } = [];
 
     private List<Regex> Pattern { get; } = [];
 
@@ -215,7 +217,7 @@ public void AddVirtualModule(LuaDocumentId documentId, string modulePath)
         {
             var documentId = moduleNode.Value.FindModule(modulePath);
 
-            if (documentId.HasValue)
+            if (documentId.HasValue && !IsDisableRequire(documentId.Value))
             {
                 return Workspace.GetDocument(documentId.Value);
             }
@@ -244,7 +246,7 @@ public void AddVirtualModule(LuaDocumentId documentId, string modulePath)
             {
                 if (DocumentIndex.TryGetValue(documentId, out var moduleIndex))
                 {
-                    if (moduleIndex.ModulePath.EndsWith(modulePath))
+                    if (moduleIndex.ModulePath.EndsWith(modulePath) && !IsDisableRequire(documentId))
                     {
                         return Workspace.GetDocument(documentId);
                     }
@@ -271,6 +273,11 @@ public List<ModuleInfo> GetCurrentModuleNames(string modulePath)
                     var uri = string.Empty;
                     if (child.Value.DocumentId.HasValue)
                     {
+                        if (IsDisableRequire(child.Value.DocumentId.Value))
+                        {
+                            continue;
+                        }
+
                         var document = Workspace.GetDocument(child.Value.DocumentId.Value);
                         uri = document?.Uri ?? string.Empty;
                     }
@@ -339,4 +346,19 @@ public List<ModuleIndex> GetAllModules()
         DocumentIndex.TryGetValue(documentId, out var moduleInfo);
         return moduleInfo;
     }
+
+    public bool AddDisableRequire(LuaDocumentId documentId)
+    {
+        if (DisableRequires.Add(documentId))
+        {
+            return true;
+        }
+
+        return false;
+    }
+
+    public bool IsDisableRequire(LuaDocumentId documentId)
+    {
+        return DisableRequires.Contains(documentId);
+    }
 }
diff --git a/EmmyLua/Resources/std/builtin.lua b/EmmyLua/Resources/std/builtin.lua
@@ -1,4 +1,5 @@
 ---@meta
+---@module no-require
 -- Copyright (c) 2018. tangzx(love.tangzx@qq.com)
 --
 -- Licensed under the Apache License, Version 2.0 (the "License"); you may not
diff --git a/EmmyLua/Resources/std/global.lua b/EmmyLua/Resources/std/global.lua
@@ -1,4 +1,5 @@
 ---@meta
+---@module no-require
 -- Copyright (c) 2018. tangzx(love.tangzx@qq.com)
 --
 -- Licensed under the Apache License, Version 2.0 (the "License"); you may not

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,15 @@ private void AnalyzeGeneralDeclaration(LuaSyntaxElement attachedElement, List<Lu`
`65`	`65`	`declaration.Feature \|= DeclarationFeature.Async;`
`66`	`66`	`break;`
`67`	`67`	`}`
	`68`	`+ case LuaDocTagMappingSyntax mappingSyntax:`
	`69`	`+ {`
	`70`	`+ if (mappingSyntax.Name is { RepresentText: { } name })`
	`71`	`+ {`
	`72`	`+ declaration.Name = name;`
	`73`	`+ }`
	`74`	`+`
	`75`	`+ break;`
	`76`	`+ }`
`68`	`77`	`}`
`69`	`78`	`}`
`70`	`79`	`}`
`@@ -147,9 +156,9 @@ private IEnumerable<LuaDeclaration> FindDeclarations(LuaSyntaxElement element)`
`147`	`156`	`{`
`148`	`157`	`switch (funcStatSyntax)`
`149`	`158`	`{`
`150`		`- case { IsLocal: true, LocalName.Name: { } name }:`
	`159`	`+ case { IsLocal: true, LocalName: { } name }:`
`151`	`160`	`{`
`152`		`- if (declarationContext.GetAttachedDeclaration(funcStatSyntax.LocalName) is { } luaDeclaration)`
	`161`	`+ if (declarationContext.GetAttachedDeclaration(name) is { } luaDeclaration)`
`153`	`162`	`{`
`154`	`163`	`yield return luaDeclaration;`
`155`	`164`	`}`
Original file line number	Diff line number	Diff line change
`@@ -178,6 +178,11 @@ public void WalkIn(LuaSyntaxElement node)`
`178`	`178`	`AnalyzeSimpleTag(overloadSyntax);`
`179`	`179`	`break;`
`180`	`180`	`}`
	`181`	`+ case LuaDocTagMappingSyntax mappingSyntax:`
	`182`	`+ {`
	`183`	`+ AnalyzeSimpleTag(mappingSyntax);`
	`184`	`+ break;`
	`185`	`+ }`
`181`	`186`	`}`
`182`	`187`	`}`
`183`	`188`
Original file line number	Diff line number	Diff line change
`@@ -172,6 +172,10 @@ private void AnalyzeTagModule(LuaDocTagModuleSyntax moduleSyntax)`
`172`	`172`	`{`
`173`	`173`	`Compilation.Workspace.ModuleManager.AddVirtualModule(DocumentId, moduleName);`
`174`	`174`	`}`
	`175`	`+ else if (moduleSyntax.Action is { Text: "no-require" })`
	`176`	`+ {`
	`177`	`+ Compilation.Workspace.ModuleManager.AddDisableRequire(DocumentId);`
	`178`	`+ }`
`175`	`179`	`}`
`176`	`180`
`177`	`181`	`private void AnalyzeTagDiagnostic(LuaDocTagDiagnosticSyntax diagnosticSyntax)`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public class LuaDeclaration(`
`40`	`40`	`)`
`41`	`41`	`: IDeclaration`
`42`	`42`	`{`
`43`		`- public string Name { get; } = name;`
	`43`	`+ public string Name { get; internal set; } = name;`
`44`	`44`
`45`	`45`	`public LuaType Type => Info.DeclarationType ?? Builtin.Unknown;`
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@ namespace EmmyLua.CodeAnalysis.Compilation.Infer;`
`6`	`6`
`7`	`7`	`public static class DeclarationInfer`
`8`	`8`	`{`
`9`		`-`
`10`	`9`	`public static LuaType InferLocalName(LuaLocalNameSyntax localName, SearchContext context)`
`11`	`10`	`{`
`12`	`11`	`var symbol = context.FindDeclaration(localName);`