# yanncebron/m68kplugin architecture

> Architecture diagram of the GitHub repository yanncebron/m68kplugin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yanncebron/m68kplugin
- Repository: https://github.com/yanncebron/m68kplugin

## Overview

This is a JetBrains IDE plugin for Motorola 68000 assembly. The main workflow is opening an assembly file, tokenizing and parsing it into PSI, then using that language model for editing and IDE assistance. The graph also preserves README-documented completion, navigation, analysis, refactoring, and documentation capabilities, plus the Amiga hardware-documentation extension. Some capability implementations are not sampled, so their links are documented or left unverified rather than inferred from names alone.

Main entry points: [`gen/com/yanncebron/m68kplugin/lang/M68kParser.java`](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kParser.java) (Assembly parser), [`gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java`](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java) (Instruction grammar), [`gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java`](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java) (Directive grammar), [`gen/com/yanncebron/m68kplugin/lang/psi/M68kTypes.java`](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/psi/M68kTypes.java) (PSI element types)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_language["Language model"]
  node_filetype["Assembly file type<br/>[M68kFileType.java]"]
  node_lexer["Lexer<br/>[_M68kLexer.java]"]
  node_tokens["Token types"]
  node_parser["Assembly parser<br/>[M68kParser.java]"]
  node_instruction_parser["Instruction grammar"]
  node_directive_parser["Directive grammar"]
  node_expression_parser["Expression grammar"]
  node_psi_types["PSI element types<br/>[M68kTypes.java]"]
  node_psi_api["PSI contracts"]
  node_addressing["Addressing modes<br/>[M68kAdm.java]"]
  node_mnemonics["Mnemonic registry"]
end

subgraph group_ide["IDE assistance"]
  node_completion["Code completion"]
  node_navigation["Navigation and search"]
  node_analysis["Code analysis"]
  node_refactoring["Label refactoring"]
  node_structure_view["Structure view"]
  node_editor_actions["Editor actions"]
end

subgraph group_docs["Documentation"]
  node_doc_browser["Documentation browser"]
  node_doc_links["Documentation links"]
  node_amiga_docs["Amiga register docs"]
end

subgraph group_platform["Target platforms"]
  node_platform_detection["Target detection"]
  node_amiga_integration["Amiga integration"]
end

node_developer(("Assembly developer"))

node_developer -->|"opens source"| node_filetype
node_filetype -.->|"provides language input"| node_lexer
node_lexer -->|"emits tokens"| node_tokens
node_parser -->|"consumes tokens"| node_tokens
node_parser -->|"dispatches instructions"| node_instruction_parser
node_parser -->|"dispatches directives"| node_directive_parser
node_parser -->|"parses expressions"| node_expression_parser
node_directive_parser -->|"parses expressions"| node_expression_parser
node_instruction_parser -->|"creates PSI"| node_psi_types
node_directive_parser -->|"creates PSI"| node_psi_types
node_psi_types -.->|"implements contracts"| node_psi_api
node_developer -->|"requests completion"| node_completion
node_developer -->|"navigates symbols"| node_navigation
node_developer -->|"receives inspections"| node_analysis
node_developer -->|"renames labels"| node_refactoring
node_developer -.->|"browses structure"| node_structure_view
node_developer -.->|"edits source"| node_editor_actions
node_developer -->|"requests documentation"| node_doc_browser
node_doc_links -->|"routes links"| node_doc_browser
node_amiga_integration -.->|"provides register data"| node_amiga_docs
node_platform_detection -.->|"selects target"| node_amiga_integration
node_instruction_parser -.->|"uses mnemonic data"| node_mnemonics
node_editor_actions -->|"uses operand model"| node_addressing

click node_filetype "https://github.com/yanncebron/m68kplugin/blob/main/api/plugin-api/src/main/java/com/yanncebron/m68kplugin/lang/M68kFileType.java"
click node_lexer "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lexer/_M68kLexer.java"
click node_tokens "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kTokenTypes.java"
click node_parser "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kParser.java"
click node_instruction_parser "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java"
click node_directive_parser "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java"
click node_expression_parser "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kExpressionParser.java"
click node_psi_types "https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/psi/M68kTypes.java"
click node_psi_api "https://github.com/yanncebron/m68kplugin/blob/main/api/psi-api/src/main/java/com/yanncebron/m68kplugin/lang/psi/M68kPsiElement.java"
click node_addressing "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kAdm.java"
click node_mnemonics "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kMnemonicRegistry.java"
click node_completion "https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin"
click node_navigation "https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/resolve"
click node_analysis "https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/lang"
click node_refactoring "https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/resolve"
click node_structure_view "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/structureview/M68kRootStructureViewTreeElement.java"
click node_editor_actions "https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/editor"
click node_doc_browser "https://github.com/yanncebron/m68kplugin/blob/main/api/plugin-api/src/main/java/com/yanncebron/m68kplugin/browser/M68kBrowserPaneBase.java"
click node_doc_links "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/browser/M68kBrowserDocumentationLinkHandler.java"
click node_amiga_docs "https://github.com/yanncebron/m68kplugin/blob/main/platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga/hardware/M68kAmigaHardwareRegister.java"
click node_platform_detection "https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/settings/ide/M68kTargetPlatformDetectionProjectActivity.kt"
click node_amiga_integration "https://github.com/yanncebron/m68kplugin/tree/main/platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_filetype,node_lexer,node_tokens,node_parser,node_instruction_parser,node_directive_parser,node_expression_parser,node_psi_types,node_psi_api,node_addressing,node_mnemonics toneBlue
class node_completion,node_navigation,node_analysis,node_refactoring,node_structure_view,node_editor_actions toneAmber
class node_doc_browser,node_doc_links,node_amiga_docs toneMint
class node_platform_detection,node_amiga_integration toneRose
class node_developer toneIndigo
```

## Components

### Language model

- [Assembly file type](https://github.com/yanncebron/m68kplugin/blob/main/api/plugin-api/src/main/java/com/yanncebron/m68kplugin/lang/M68kFileType.java): `api/plugin-api/src/main/java/com/yanncebron/m68kplugin/lang/M68kFileType.java`
- [Lexer](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lexer/_M68kLexer.java): `gen/com/yanncebron/m68kplugin/lexer/_M68kLexer.java`
- [Token types](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kTokenTypes.java): `src/com/yanncebron/m68kplugin/lang/psi/M68kTokenTypes.java`
- [Assembly parser](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kParser.java): `gen/com/yanncebron/m68kplugin/lang/M68kParser.java`
- [Instruction grammar](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java): `gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java`
- [Directive grammar](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java): `gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java`
- [Expression grammar](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/M68kExpressionParser.java): `gen/com/yanncebron/m68kplugin/lang/M68kExpressionParser.java`
- [PSI element types](https://github.com/yanncebron/m68kplugin/blob/main/gen/com/yanncebron/m68kplugin/lang/psi/M68kTypes.java): `gen/com/yanncebron/m68kplugin/lang/psi/M68kTypes.java`
- [PSI contracts](https://github.com/yanncebron/m68kplugin/blob/main/api/psi-api/src/main/java/com/yanncebron/m68kplugin/lang/psi/M68kPsiElement.java): `api/psi-api/src/main/java/com/yanncebron/m68kplugin/lang/psi/M68kPsiElement.java`
- [Addressing modes](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kAdm.java): `src/com/yanncebron/m68kplugin/lang/psi/M68kAdm.java`
- [Mnemonic registry](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/lang/psi/M68kMnemonicRegistry.java): `src/com/yanncebron/m68kplugin/lang/psi/M68kMnemonicRegistry.java`

### IDE assistance

- [Code completion](https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin): `src/com/yanncebron/m68kplugin`
- [Navigation and search](https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/resolve): `src/com/yanncebron/m68kplugin/resolve`
- [Code analysis](https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/lang): `src/com/yanncebron/m68kplugin/lang`
- [Label refactoring](https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/resolve): `src/com/yanncebron/m68kplugin/resolve`
- [Structure view](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/structureview/M68kRootStructureViewTreeElement.java): `src/com/yanncebron/m68kplugin/structureview/M68kRootStructureViewTreeElement.java`
- [Editor actions](https://github.com/yanncebron/m68kplugin/tree/main/src/com/yanncebron/m68kplugin/editor): `src/com/yanncebron/m68kplugin/editor`

### Documentation

- [Documentation browser](https://github.com/yanncebron/m68kplugin/blob/main/api/plugin-api/src/main/java/com/yanncebron/m68kplugin/browser/M68kBrowserPaneBase.java): `api/plugin-api/src/main/java/com/yanncebron/m68kplugin/browser/M68kBrowserPaneBase.java`
- [Documentation links](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/browser/M68kBrowserDocumentationLinkHandler.java): `src/com/yanncebron/m68kplugin/browser/M68kBrowserDocumentationLinkHandler.java`
- [Amiga register docs](https://github.com/yanncebron/m68kplugin/blob/main/platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga/hardware/M68kAmigaHardwareRegister.java): `platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga/hardware/M68kAmigaHardwareRegister.java`

### Target platforms

- [Target detection](https://github.com/yanncebron/m68kplugin/blob/main/src/com/yanncebron/m68kplugin/settings/ide/M68kTargetPlatformDetectionProjectActivity.kt): `src/com/yanncebron/m68kplugin/settings/ide/M68kTargetPlatformDetectionProjectActivity.kt`
- [Amiga integration](https://github.com/yanncebron/m68kplugin/tree/main/platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga): `platforms/amiga/src/main/java/com/yanncebron/m68kplugin/amiga`

### Other components

- **Assembly developer**

## Connections

- Assembly developer → Assembly file type: opens source (evidence: `README.md`)
- Assembly file type → Lexer: provides language input
- Lexer → Token types: emits tokens (evidence: `gen/com/yanncebron/m68kplugin/lexer/_M68kLexer.java`)
- Assembly parser → Token types: consumes tokens (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kParser.java`)
- Assembly parser → Instruction grammar: dispatches instructions (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kParser.java`)
- Assembly parser → Directive grammar: dispatches directives (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kParser.java`)
- Assembly parser → Expression grammar: parses expressions (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kParser.java`)
- Directive grammar → Expression grammar: parses expressions (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java`)
- Instruction grammar → PSI element types: creates PSI (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kMnemonicsParser.java`)
- Directive grammar → PSI element types: creates PSI (evidence: `gen/com/yanncebron/m68kplugin/lang/M68kDirectivesParser.java`)
- PSI element types → PSI contracts: implements contracts
- Assembly developer → Code completion: requests completion (evidence: `README.md`)
- Assembly developer → Navigation and search: navigates symbols (evidence: `README.md`)
- Assembly developer → Code analysis: receives inspections (evidence: `README.md`)
- Assembly developer → Label refactoring: renames labels (evidence: `README.md`)
- Assembly developer → Structure view: browses structure
- Assembly developer → Editor actions: edits source
- Assembly developer → Documentation browser: requests documentation (evidence: `README.md`)
- Documentation links → Documentation browser: routes links (evidence: `src/com/yanncebron/m68kplugin/browser/M68kBrowserDocumentationLinkHandler.java`)
- Amiga integration → Amiga register docs: provides register data
- Target detection → Amiga integration: selects target
- Instruction grammar → Mnemonic registry: uses mnemonic data
- Editor actions → Addressing modes: uses operand model (evidence: `src/com/yanncebron/m68kplugin/editor/M68kMoveLeftRightHandler.java`)
