From 0cb90ff8d748c8771a0eff1cec4d4e180ff93943 Mon Sep 17 00:00:00 2001
From: chrisly42 <chrisly@platon42.de>
Date: Mon, 9 Aug 2021 12:14:02 +0200
Subject: [PATCH] 'END' directive stops parsing. Prepared next release.

---
 README.md                                     |  3 ++-
 build.gradle                                  |  3 ++-
 .../plugins/m68k/lexer/_M68kLexer.java        |  9 +++++--
 .../plugins/m68k/asm/AssemblerDirectives.kt   |  4 ++-
 .../intellij/plugins/m68k/lexer/LexerUtil.kt  |  3 +++
 .../plugins/m68k/lexer/_M68kLexer.flex        |  1 +
 .../plugins/m68k/parser/EndDirectiveTest.kt   | 22 ++++++++++++++++
 .../parser/directives/end_directive.txt       | 26 +++++++++++++++++++
 8 files changed, 66 insertions(+), 5 deletions(-)
 create mode 100644 src/test/java/de/platon42/intellij/plugins/m68k/parser/EndDirectiveTest.kt
 create mode 100644 src/test/resources/parser/directives/end_directive.txt

diff --git a/README.md b/README.md
index cfd0238..7a857b7 100644
--- a/README.md
+++ b/README.md
@@ -147,7 +147,7 @@ make it work with JUnit 5. Feel free to use the code (in package ```de.platon42.
 
 ## Changelog
 
-### V0.6 (unreleased)
+### V0.6 (09-Aug-21)
 
 - Enhancement: `opt` and several other directives (`printt`, `fail` etc.) no longer causes a syntax error when unquoted.
 - Enhancement: `include`, `incdir` and `incbin` and `output` with `<pathname>` quotes no longer cause syntax error.
@@ -155,6 +155,7 @@ make it work with JUnit 5. Feel free to use the code (in package ```de.platon42.
 - New: Code completion for local label definitions, suggesting undefined labels already referenced.
 - New: Added inspection suppression possibility and quickfix.
 - New: Added inspection for unresolved symbols, macros and labels.
+- Enhancement: 'END' directive stops parsing.
 
 ### V0.5 (06-Aug-21)
 
diff --git a/build.gradle b/build.gradle
index 8c6fc3f..fca299f 100644
--- a/build.gradle
+++ b/build.gradle
@@ -57,7 +57,7 @@ runPluginVerifier {
 
 patchPluginXml {
     setChangeNotes("""
-  <h4>V0.6 (unreleased)</h4>
+  <h4>V0.6 (09-Aug-21)</h4>
     <ul>
       <li>Enhancement: 'opt' and several other directives ('printt', 'fail' etc.) no longer causes a syntax error when unquoted.
       <li>Enhancement: 'include', 'incdir' and 'incbin' and 'output' with '&lt;pathname&gt;' quotes no longer cause syntax error.
@@ -65,6 +65,7 @@ patchPluginXml {
       <li>New: Code completion for local label definitions, suggesting undefined labels already referenced.
       <li>New: Added inspection suppression possibility and quickfix.
       <li>New: Added inspection for unresolved symbols, macros and labels.
+      <li>Enhancement: 'END' directive stops parsing.
     </ul>
   <h4>V0.5 (06-Aug-21)</h4>
     <ul>
diff --git a/src/main/gen/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.java b/src/main/gen/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.java
index 73b3d0b..987efed 100644
--- a/src/main/gen/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.java
+++ b/src/main/gen/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.java
@@ -624,11 +624,11 @@ public class _M68kLexer implements FlexLexer {
     /**
      * Refills the input buffer.
      *
-     * @return {@code false}, iff there was new input.
+     * @return {@code false}, iff there was NO new input.
      * @throws java.io.IOException if any I/O-Error occurs
      */
     private boolean zzRefill() throws java.io.IOException {
-        return true;
+        return !zzAtEOF;
     }
 
 
@@ -871,6 +871,11 @@ public class _M68kLexer implements FlexLexer {
                             yybegin(ASMINSTR);
                             return MNEMONIC;
                         }
+                        if (isEndDirective(yytext())) {
+                            yybegin(YYINITIAL);
+                            zzAtEOF = true;
+                            return null;
+                        }
                         if (isDataDirective(yytext())) {
                             startExpr(EXPR, EXPR_OP);
                             return DATA_DIRECTIVE;
diff --git a/src/main/java/de/platon42/intellij/plugins/m68k/asm/AssemblerDirectives.kt b/src/main/java/de/platon42/intellij/plugins/m68k/asm/AssemblerDirectives.kt
index 239c3df..79271d9 100644
--- a/src/main/java/de/platon42/intellij/plugins/m68k/asm/AssemblerDirectives.kt
+++ b/src/main/java/de/platon42/intellij/plugins/m68k/asm/AssemblerDirectives.kt
@@ -57,6 +57,8 @@ object AssemblerDirectives {
         "machine", "mc68000", "mc68010", "mc68020", "mc68030", "mc68040", "mc68060",
         "fpu",
 
-        "basereg", "endb", "far", "near", "initnear"
+        "basereg", "endb", "far", "near", "initnear",
+
+        "end"
     )
 }
\ No newline at end of file
diff --git a/src/main/java/de/platon42/intellij/plugins/m68k/lexer/LexerUtil.kt b/src/main/java/de/platon42/intellij/plugins/m68k/lexer/LexerUtil.kt
index 5db5551..fb5ff90 100644
--- a/src/main/java/de/platon42/intellij/plugins/m68k/lexer/LexerUtil.kt
+++ b/src/main/java/de/platon42/intellij/plugins/m68k/lexer/LexerUtil.kt
@@ -19,6 +19,9 @@ object LexerUtil {
             && text.dropLast(1).endsWith('.')
             && mnemonics.contains(text.dropLast(2).toString().lowercase())
 
+    @JvmStatic
+    fun isEndDirective(text: CharSequence) = text.contentEquals("end", ignoreCase = true)
+
     @JvmStatic
     fun isDataDirective(text: CharSequence) = AssemblerDirectives.dataDirectives.contains(text.toString().lowercase())
 
diff --git a/src/main/java/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.flex b/src/main/java/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.flex
index 3fc4322..c4878e1 100644
--- a/src/main/java/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.flex
+++ b/src/main/java/de/platon42/intellij/plugins/m68k/lexer/_M68kLexer.flex
@@ -117,6 +117,7 @@ PLAIN_MACRO_LINE=[^;\r\n]+
   {DIRECTIVE_KEYWORD} {
                         if(isAsmMnemonicWithSize(yytext())) { yybegin(ASMINSTR); yypushback(2); return MNEMONIC; }
                         if(isAsmMnemonic(yytext())) { yybegin(ASMINSTR); return MNEMONIC; }
+                        if(isEndDirective(yytext())) { yybegin(YYINITIAL); zzAtEOF = true; return null; }
                         if(isDataDirective(yytext())) { startExpr(EXPR, EXPR_OP); return DATA_DIRECTIVE; }
                         if(isPlainDirective(yytext())) { yybegin(PLAINPARAMS); return OTHER_DIRECTIVE; }
                         if(isOtherDirective(yytext())) { startExpr(EXPR, EXPR_OP); return OTHER_DIRECTIVE; }
diff --git a/src/test/java/de/platon42/intellij/plugins/m68k/parser/EndDirectiveTest.kt b/src/test/java/de/platon42/intellij/plugins/m68k/parser/EndDirectiveTest.kt
new file mode 100644
index 0000000..33a65f4
--- /dev/null
+++ b/src/test/java/de/platon42/intellij/plugins/m68k/parser/EndDirectiveTest.kt
@@ -0,0 +1,22 @@
+package de.platon42.intellij.plugins.m68k.parser
+
+import de.platon42.intellij.jupiter.MyTestCase
+import de.platon42.intellij.jupiter.ParsingTestExtension
+import de.platon42.intellij.jupiter.TestDataSubPath
+import org.junit.jupiter.api.Test
+
+@TestDataSubPath("directives")
+internal class EndDirectiveTest : AbstractParsingTest() {
+
+    @Test
+    internal fun end_directive(@MyTestCase testCase: ParsingTestExtension.IParsingTestCase) {
+        testGoodSyntax(
+            testCase, """
+ moveq.l #0,d0
+ rts
+ END narf
+ äöö#öä235r2352ou485742q3535p3ü
+"""
+        )
+    }
+}
\ No newline at end of file
diff --git a/src/test/resources/parser/directives/end_directive.txt b/src/test/resources/parser/directives/end_directive.txt
new file mode 100644
index 0000000..954fd58
--- /dev/null
+++ b/src/test/resources/parser/directives/end_directive.txt
@@ -0,0 +1,26 @@
+Assembly File: a.asm
+  PsiWhiteSpace('\n')
+  PsiWhiteSpace(' ')
+  M68kStatementImpl(STATEMENT)
+    M68kAsmInstructionImpl(ASM_INSTRUCTION)
+      M68kAsmOpImpl(ASM_OP)
+        PsiElement(M68kTokenType.MNEMONIC)('moveq')
+        M68kOperandSizeImpl(OPERAND_SIZE)
+          PsiElement(M68kTokenType.OPSIZE_L)('.l')
+      PsiWhiteSpace(' ')
+      M68kImmediateDataImpl(IMMEDIATE_DATA)
+        PsiElement(M68kTokenType.HASH)('#')
+        M68kLiteralExprImpl(LITERAL_EXPR)
+          PsiElement(M68kTokenType.DECIMAL)('0')
+      PsiElement(M68kTokenType.SEPARATOR)(',')
+      M68kDataRegisterDirectAddressingModeImpl(DATA_REGISTER_DIRECT_ADDRESSING_MODE)
+        M68kDataRegisterImpl(DATA_REGISTER)
+          PsiElement(M68kTokenType.DREG)('d0')
+  PsiElement(M68kTokenType.EOL)('\n')
+  PsiWhiteSpace(' ')
+  M68kStatementImpl(STATEMENT)
+    M68kAsmInstructionImpl(ASM_INSTRUCTION)
+      M68kAsmOpImpl(ASM_OP)
+        PsiElement(M68kTokenType.MNEMONIC)('rts')
+  PsiElement(M68kTokenType.EOL)('\n')
+  PsiWhiteSpace(' END narf\n äöö#öä235r2352ou485742q3535p3ü\n')
\ No newline at end of file