Added explicit IndexRegister-PSI-Element. Major rework to support new DocumentationProvider on registers.

When asking for documentation on registers, a code flow analysis is done.

src/test/java/de/platon42/intellij/plugins/m68k/documentation/M68kInstructionDocumentationProviderTest.kt

@@ -17,8 +17,10 @@ internal class M68kInstructionDocumentationProviderTest : AbstractDocumentationP
  mo<caret>veq.l #40,d0
         """
         )
-        assertThat(generateDocumentation(myFixture)).isEqualTo(
-            """<div class="definition"><pre><b>Move Quick</b></pre></div><div class="content"><table class="sections"><tr><td class="section" valign="top">Mnemonic</td><td class="section" valign="top">Op1</td><td class="section" valign="top">Op2</td></tr><tr><td valign="top"><p>moveq.l</p></td><td valign="top"><p>#&lt;xxx&gt;</p></td><td valign="top"><p>Dn</p></td></tr><br/></table></div>"""
+        assertThat(generateDocumentation(myFixture)).isEqualToIgnoringWhitespace(
+            """
+<div class="definition"><pre><b>Move Quick</b></pre></div><div class="content"><table class="sections"><tr><td class="section" valign="top">Mnemonic</td><td class="section" valign="top">Op1</td><td class="section" valign="top">Op2</td></tr><tr><td valign="top"><div>moveq.l</div></td><td valign="top"><div>#&lt;xxx&gt;</div></td><td valign="top"><div>Dn</div></td></tr></table></div>
+"""
         )
     }
 
@@ -29,8 +31,32 @@ internal class M68kInstructionDocumentationProviderTest : AbstractDocumentationP
  bra.<caret>s label
         """
         )
-        assertThat(generateDocumentation(myFixture)).isEqualTo(
-            """<div class="definition"><pre><b>Branch</b></pre></div><div class="content"><table class="sections"><tr><td class="section" valign="top">Mnemonic</td><td class="section" valign="top">Op1</td><td class="section" valign="top">Op2</td></tr><tr><td valign="top"><p>bra.s</p><p>bra.b</p><p>bra.w</p></td><td valign="top"><p>(xxx).w|l</p></td><td valign="top"></td></tr><br/></table></div>"""
+        assertThat(generateDocumentation(myFixture)).isEqualToIgnoringWhitespace(
+            """
+<div class="definition">
+    <pre><b>Branch</b></pre>
+</div>
+<div class="content">
+    <table class="sections">
+        <tr>
+            <td class="section" valign="top">Mnemonic</td>
+            <td class="section" valign="top">Op1</td>
+            <td class="section" valign="top">Op2</td>
+        </tr>
+        <tr>
+            <td valign="top">
+                <div>bra.s</div>
+                <div>bra.b</div>
+                <div>bra.w</div>
+            </td>
+            <td valign="top">
+                <div>(xxx).w|l</div>
+            </td>
+            <td valign="top"></td>
+        </tr>
+    </table>
+</div>
+            """
         )
     }
 
@@ -41,9 +67,7 @@ internal class M68kInstructionDocumentationProviderTest : AbstractDocumentationP
  <caret>reset
         """
         )
-        assertThat(generateDocumentation(myFixture)).isEqualTo(
-            """<div class="definition"><pre><b>Reset External Devices</b></pre><p><font color="red">(privileged)</font></p></div><div class="content"><table class="sections"><tr><td class="section" valign="top">Mnemonic</td><td class="section" valign="top">Op1</td><td class="section" valign="top">Op2</td></tr><tr><td valign="top"><p>reset</p></td><td valign="top"></td><td valign="top"></td></tr><br/></table></div>"""
-        )
+        assertThat(generateDocumentation(myFixture)).contains("Reset External Devices", "(privileged)")
     }
 
     @Test

src/test/java/de/platon42/intellij/plugins/m68k/documentation/M68kRegisterFlowDocumentationProviderTest.kt

@@ -11,21 +11,93 @@ import org.junit.jupiter.api.extension.ExtendWith
 internal class M68kRegisterFlowDocumentationProviderTest : AbstractDocumentationProviderTest() {
 
     @Test
-    internal fun check_documentation_for_a_symbol_definition(@MyFixture myFixture: CodeInsightTestFixture) {
+    internal fun check_documentation_for_a_register_in_code_flow(@MyFixture myFixture: CodeInsightTestFixture) {
         myFixture.configureByText(
             "documentme.asm", """
 label
     moveq.l #0,d0
     add.w   #1,d0
+    move.l  d1,-(sp)
     move.w  d0,d1
     move.b  d2,d0
     addq.b  #1,d0
     move.w  d<caret>0,d1
     move.l  d0,d2
     move.w  d1,d2
+    clr.b   d0
+    moveq.l #0,d0
+    move.l  (sp)+,d1
     rts
+nextlabel
         """
         )
-        assertThat(generateDocumentation(myFixture)).isEqualTo("d0")
+        assertThat(generateDocumentation(myFixture))
+            .isEqualToIgnoringWhitespace(
+                """
+<div class="definition">move instruction reads d0.w</div>
+<table class="sections" style="padding-left: 8pt; padding-right: 8pt">
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>moveq.l #0,<font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>sets d0.l</i></td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>add.w #1,<font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>modifies d0.w</i></td>
+    </tr>
+    <tr>
+        <td valign="top">&nbsp;</td>
+        <td valign="top">
+            <div class="grayed">[...]</div>
+        </td>
+        <td valign="top">&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>move.w <font color="red">d0</font>,d1</code></td>
+        <td valign="top"> ; <i>reads d0.w</i></td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>move.b d2,<font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>sets d0.b</i></td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>addq.b #1,<font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>modifies d0.b</i></td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><b><code>move.w <font color="red">d0</font>,d1</code></b></td>
+        <td valign="top"> ; &lt;--</td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>move.l <font color="red">d0</font>,d2</code></td>
+        <td valign="top"> ; <i>reads d0.l</i></td>
+    </tr>
+    <tr>
+        <td valign="top">&nbsp;</td>
+        <td valign="top">
+            <div class="grayed">[...]</div>
+        </td>
+        <td valign="top">&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>clr.b <font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>sets d0.b</i></td>
+    </tr>
+    <tr>
+        <td valign="top"></td>
+        <td valign="top"><code>moveq.l #0,<font color="red">d0</font></code></td>
+        <td valign="top"> ; <i>sets d0.l</i></td>
+    </tr>
+</table>
+<div class="content"/>
+            """.trimIndent()
+            )
     }
 }

src/test/resources/parser/addressingmodes/complex_math_expression_in_displacement.txt

@@ -177,9 +177,10 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.AREG)('a0')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d0')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_L)('.l')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d0')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_L)('.l')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/pc_indirect_with_index_and_offset_new_syntax.txt

@@ -21,8 +21,9 @@ Assembly File: a.asm
         PsiElement(M68kTokenType.SEPARATOR)(',')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a0')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a0')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kProgramCounterIndirectWithIndexNewAddressingModeImpl(PROGRAM_COUNTER_INDIRECT_WITH_INDEX_NEW_ADDRESSING_MODE)
@@ -43,9 +44,10 @@ Assembly File: a.asm
         PsiElement(M68kTokenType.SEPARATOR)(',')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d5')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_L)('.l')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d5')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_L)('.l')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/pc_indirect_with_index_and_offset_old_syntax.txt

@@ -20,10 +20,11 @@ Assembly File: a.asm
         PsiElement(M68kTokenType.ROUND_L)('(')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d0')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_W)('.w')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d0')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_W)('.w')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kProgramCounterIndirectWithIndexOldAddressingModeImpl(PROGRAM_COUNTER_INDIRECT_WITH_INDEX_OLD_ADDRESSING_MODE)
@@ -43,7 +44,8 @@ Assembly File: a.asm
         PsiElement(M68kTokenType.ROUND_L)('(')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a3')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a3')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/pc_indirect_with_index_special_case_without_offset.txt

@@ -11,17 +11,19 @@ Assembly File: a.asm
         PsiElement(M68kTokenType.ROUND_L)('(')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d0')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_W)('.w')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d0')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_W)('.w')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kProgramCounterIndirectWithIndexNewAddressingModeImpl(PROGRAM_COUNTER_INDIRECT_WITH_INDEX_NEW_ADDRESSING_MODE)
         PsiElement(M68kTokenType.ROUND_L)('(')
         PsiElement(M68kTokenType.PC)('pc')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a3')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a3')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/register_indirect_with_index_and_offset_new_syntax.txt

@@ -22,8 +22,9 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.REG_SP)('sp')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a0')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a0')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kAddressRegisterIndirectWithIndexNewAddressingModeImpl(ADDRESS_REGISTER_INDIRECT_WITH_INDEX_NEW_ADDRESSING_MODE)
@@ -45,9 +46,10 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.AREG)('a1')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d5')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_L)('.l')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d5')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_L)('.l')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/register_indirect_with_index_and_offset_old_syntax.txt

@@ -21,10 +21,11 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.REG_SP)('sp')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d0')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_W)('.w')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d0')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_W)('.w')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kAddressRegisterIndirectWithIndexOldAddressingModeImpl(ADDRESS_REGISTER_INDIRECT_WITH_INDEX_OLD_ADDRESSING_MODE)
@@ -45,7 +46,8 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.AREG)('a1')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a3')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a3')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')

src/test/resources/parser/addressingmodes/register_indirect_with_index_special_case_without_offset.txt

@@ -12,10 +12,11 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.REG_SP)('sp')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kDataRegisterImpl(DATA_REGISTER)
-          PsiElement(M68kTokenType.DREG)('d0')
-        M68kDataWidthImpl(DATA_WIDTH)
-          PsiElement(M68kTokenType.OPSIZE_W)('.w')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kDataRegisterImpl(DATA_REGISTER)
+            PsiElement(M68kTokenType.DREG)('d0')
+          M68kDataWidthImpl(DATA_WIDTH)
+            PsiElement(M68kTokenType.OPSIZE_W)('.w')
         PsiElement(M68kTokenType.ROUND_R)(')')
       PsiElement(M68kTokenType.SEPARATOR)(',')
       M68kAddressRegisterIndirectWithIndexNewAddressingModeImpl(ADDRESS_REGISTER_INDIRECT_WITH_INDEX_NEW_ADDRESSING_MODE)
@@ -23,7 +24,8 @@ Assembly File: a.asm
         M68kAddressRegisterImpl(ADDRESS_REGISTER)
           PsiElement(M68kTokenType.AREG)('a1')
         PsiElement(M68kTokenType.SEPARATOR)(',')
-        M68kAddressRegisterImpl(ADDRESS_REGISTER)
-          PsiElement(M68kTokenType.AREG)('a3')
+        M68kIndexRegisterImpl(INDEX_REGISTER)
+          M68kAddressRegisterImpl(ADDRESS_REGISTER)
+            PsiElement(M68kTokenType.AREG)('a3')
         PsiElement(M68kTokenType.ROUND_R)(')')
   PsiElement(M68kTokenType.EOL)('\n')