Merge pull request #1553 from EvilBeaver/feature/1545-comment-after-directive

fixes #1545 Разрешено иметь комментарии в строке с директивами аннотации модуля

Author: EvilBeaver

src/OneScript.Language/ErrorPositionInfo.cs

@@ -10,7 +10,7 @@ namespace OneScript.Language
     public class ErrorPositionInfo
     {
         public const int OUT_OF_TEXT = -1;
-
+        
         public ErrorPositionInfo()
         {
             LineNumber = OUT_OF_TEXT;

src/OneScript.Language/LexicalAnalysis/DefaultLexer.cs

@@ -7,6 +7,9 @@ This Source Code Form is subject to the terms of the
 
 namespace OneScript.Language.LexicalAnalysis
 {
+    /// <summary>
+    /// Лексер, который выдает все, кроме комментариев.
+    /// </summary>
     public class DefaultLexer : FullSourceLexer
     {
         public override Lexem NextLexem()

src/OneScript.Language/LexicalAnalysis/ExpressionBasedLexer.cs

@@ -12,9 +12,9 @@ namespace OneScript.Language.LexicalAnalysis
 {
     public class ExpressionBasedLexer : ILexer
     {
-        private readonly Func<char, LexerState> _selector;
+        private readonly Func<SourceCodeIterator, char, LexerState> _selector;
 
-        internal ExpressionBasedLexer(Func<char, LexerState> selector)
+        internal ExpressionBasedLexer(Func<SourceCodeIterator, char, LexerState> selector)
         {
             _selector = selector;
         }
@@ -23,7 +23,7 @@ public Lexem NextLexem()
         {
             if (Iterator.MoveToContent())
             {
-                var state = _selector(Iterator.CurrentSymbol);
+                var state = _selector(Iterator, Iterator.CurrentSymbol);
                 if (state == default)
                 {
                     throw new SyntaxErrorException(Iterator.GetErrorPosition(),

src/OneScript.Language/LexicalAnalysis/LexerBuilder.cs

@@ -41,7 +41,7 @@ public ILexer Build()
             }
 
 
-            var lambda = Expression.Lambda<Func<char, LexerState>>(expr, charParam);  
+            var lambda = Expression.Lambda<Func<SourceCodeIterator, char, LexerState>>(expr, iteratorParam, charParam);  
             var func = lambda.Compile();
 
             return new ExpressionBasedLexer(func);

src/OneScript.Language/SyntaxAnalysis/ImportDirectivesHandler.cs

@@ -17,8 +17,10 @@ public class ImportDirectivesHandler : ModuleAnnotationDirectiveHandler
         public ImportDirectivesHandler(IErrorSink errorSink) : base(errorSink)
         {
             var builder = new LexerBuilder();
-            builder.Detect((cs, i) => !char.IsWhiteSpace(cs))
-                .HandleWith(new NonWhitespaceLexerState());
+            builder
+                .DetectComments()
+                .Detect((cs, i) => !char.IsWhiteSpace(cs))
+                    .HandleWith(new NonWhitespaceLexerState());
 
             _importClauseLexer = builder.Build();
         }
@@ -46,7 +48,7 @@ protected override void ParseAnnotationInternal(
             parserContext.AddChild(node);
 
             lex = _importClauseLexer.NextLexemOnSameLine();
-            if (lex.Type != LexemType.EndOfText)
+            if (lex.Type != LexemType.EndOfText && lex.Type != LexemType.Comment)
             {
                 ErrorSink.AddError(LocalizedErrors.UnexpectedOperation());
                 return;

src/OneScript.Language/SyntaxAnalysis/SingleWordModuleAnnotationHandler.cs

@@ -23,19 +23,25 @@ public class SingleWordModuleAnnotationHandler : ModuleAnnotationDirectiveHandle
 
         public SingleWordModuleAnnotationHandler(ISet<string> knownNames, IErrorSink errorSink) : base(errorSink)
         {
-            var builder = new LexerBuilder();
-            builder.Detect((cs, i) => !char.IsWhiteSpace(cs))
-                .HandleWith(new WordLexerState());
+            var builder = SetupLexerBuilder();
 
             _allLineContentLexer = builder.Build();
             _knownNames = knownNames;
         }
-        
-        public SingleWordModuleAnnotationHandler(ISet<BilingualString> knownNames, IErrorSink errorSink) : base(errorSink)
+
+        private static LexerBuilder SetupLexerBuilder()
         {
             var builder = new LexerBuilder();
-            builder.Detect((cs, i) => !char.IsWhiteSpace(cs))
+            builder
+                .DetectComments()
+                .Detect((cs, i) => !char.IsWhiteSpace(cs))
                 .HandleWith(new WordLexerState());
+            return builder;
+        }
+
+        public SingleWordModuleAnnotationHandler(ISet<BilingualString> knownNames, IErrorSink errorSink) : base(errorSink)
+        {
+            var builder = SetupLexerBuilder();
 
             _allLineContentLexer = builder.Build();
 
@@ -61,7 +67,7 @@ protected override void ParseAnnotationInternal(ref Lexem lastExtractedLexem, IL
             // после ничего не должно находиться
             var nextLexem = _allLineContentLexer.NextLexemOnSameLine();
             lastExtractedLexem = lexer.NextLexem(); // сдвиг основного лексера
-            if (nextLexem.Type != LexemType.EndOfText)
+            if (nextLexem.Type != LexemType.EndOfText && nextLexem.Type != LexemType.Comment)
             {
                 var err = LocalizedErrors.ExpressionSyntax();
                 err.Position = new ErrorPositionInfo

src/OneScript.Language/SyntaxErrorException.cs

@@ -14,7 +14,7 @@ public SyntaxErrorException(ErrorPositionInfo codeInfo, string message):base(cod
 
         }
 
-        internal SyntaxErrorException(CodeError error) : base(error.Position, error.Description)
+        internal SyntaxErrorException(CodeError error) : base(error.Position ?? new ErrorPositionInfo(), error.Description)
         {
 
         }

src/Tests/DocumenterTests/DocumenterTests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
+    <Import Project="$(MSBuildProjectDirectory)/../../oscommon.targets" />
     <PropertyGroup>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFramework>$(TargetFrameworkVersion)</TargetFramework>
         <IsPackable>false</IsPackable>
         <IsTestProject>true</IsTestProject>
         <LangVersion>8</LangVersion>

src/Tests/OneScript.Language.Tests/ParserTests.cs

@@ -958,6 +958,46 @@ public void  Check_AstDirectives_Creation()
             batch.NoMoreChildren();
         }
 
+        [Fact]
+        public void CanHaveCommentAfterUseStatement()
+        {
+            var code = @"
+            #Использовать Библиотека // Подключаем библиотеку
+            #Использовать ""Библиотека с кавычками"" // Подключаем библиотеку с кавычками
+            ";
+            
+            var defaultLex = new DefaultLexer();
+            defaultLex.Iterator = SourceCodeHelper.FromString(code).CreateIterator();
+            
+            var lexer = new PreprocessingLexer(defaultLex);
+            
+            lexer.Handlers = new PreprocessorHandlers(
+                new[] {new ImportDirectivesHandler(new ThrowingErrorSink())});
+            
+            var parser = new DefaultBslParser(
+                lexer,
+                new ListErrorSink(),
+                lexer.Handlers);
+
+            var moduleNode = parser.ParseStatefulModule();
+            moduleNode.Should().NotBeNull();
+            parser.Errors.Should().BeEmpty("the valid code is passed");
+            var firstChild = new SyntaxTreeValidator(new TestAstNode(moduleNode.Children.First()));
+            
+            var batch = new SyntaxTreeValidator(new TestAstNode(firstChild.CurrentNode.RealNode.Parent));
+            
+            var node = batch.NextChild();
+            node.Is(NodeKind.Import)
+                .Equal("Использовать");
+            node.NextChild().Is(NodeKind.AnnotationParameter)
+                .Equal("Библиотека");
+            
+            node = batch.NextChild();
+            node.Is(NodeKind.Import)
+                .Equal("Использовать");
+            node.NextChild().Is(NodeKind.AnnotationParameter)
+                .Equal("\"Библиотека с кавычками\"");
+        }
 
         [Fact]
         public void Check_No_Semicolon_In_If()

src/Tests/OneScript.Language.Tests/TestAstNode.cs

@@ -31,6 +31,7 @@ public TestAstNode(BslSyntaxNode node)
                     BinaryOperationNode binary => binary.Operation.ToString(),
                     UnaryOperationNode unary => unary.Operation.ToString(),
                     PreprocessorDirectiveNode preproc => preproc.DirectiveName,
+                    AnnotationParameterNode annParam => annParam.Value.Content,
                     _ => nonTerm.ToString()
                 };
             }