Improve Merlin grammar

grammars/65816alt-opcodes.cson

@@ -0,0 +1,23 @@
+# Pseudo opcodes for the 65816 used by some assemblers
+
+scopeName: 'source.65816alt-opcodes'
+
+patterns: [
+  # The 65816 instruction set
+  {
+    include: '#mnemonics-65816alt'
+  }
+]
+
+# Respository starts here -----------------------------------------------------
+repository:
+
+  # 65816 instruction set
+  'mnemonics-65816alt':
+    patterns: [
+      # mnemonics
+      {
+        match:  '\\b(?i:tas|tsa|swa|tad|tda|blt|bge)\\b'
+        name:   'keyword.mnemonic.65816.65816alt-opcodes'
+      }
+    ]

grammars/merlin.cson

@@ -1,228 +1,217 @@
-'fileTypes': []
+scopeName: 'source.assembly.65816.merlin'
-'name': 'Merlin'
+fileTypes: []
-'patterns': [
+name: 'Merlin'
+patterns: [
+  { include: 'source.65c02-opcodes' }
+  { include: 'source.65816-opcodes' }
+  { include: 'source.65816l-opcodes' }
+  { include: 'source.65816alt-opcodes' }
+  { include: '#comments' }
+  { include: '#symbols' }
+  { include: '#directives' }
+  # registers
+  # TODO: fix registers
+  # {
+  #   'match': '(?<=,)([xXyYsS])\\b'
+  #   'name': 'variable.language.register'
+  # }
+]
+
+
+repository:
+
+  # comments
+  comments:
+    patterns: [
+      # asterisk line comment
       {
-    'include': '#M6502'
+        match: '^[*].*'
+        name: 'comment.line.asterisk.merlin'
       }
+      # semicolon line comment
       {
-    'include': '#M65C02'
+        match: ';.*$'
+        name: 'comment.line.semicolon.merlin'
       }
+    ]
+
+  # symbols
+  symbols:
+    patterns: [
+    # delimited strings
       {
-    'include': '#M65816'
+        begin: '[\'"]'
+        beginCaptures:
+          0: name: 'punctuation.definition.string.begin.merlin'
+        end: '[\'"]'
+        endCaptures:
+          0: name: 'punctuation.definition.string.end.merlin'
+        name: 'string.quoted.double.assembly.merlin'
       }
+    # TODO: highlight strings with all valid delimiters
+      # {
+      #   captures:
+      #     1: name: 'string.delimited.begin.merlin'
+      #     2: name: 'string.delimited.merlin'
+      #     3: name: 'string.delimited.end.merlin'
+      #   match: '\\b(\\S)(.*?)(\\1)\\b'
+      # }
+      # TODO: fix label scopes
+      # Variables
       {
-    'include': '#M65816L'
+        match:  '^][:-~][0-~]+'
+        # name:   'variable.named.merlin'
+        name:   'entity.name.function.label.merlin'
       }
+      # Local labels
       {
-    'include': '#hex_number'
+        match:  '^:[:-~][0-~]+'
+        name:   'entity.name.function.label.merlin'
       }
+      # Global labels
       {
-    'include': '#decimal_number'
+        match:  '^[:-~][0-~]+'
+        name:   'entity.name.function.merlin'
       }
+      # absolut address/number
       {
-    'match': '%[01][01_]*'
+        match: '\\#(\'.\'|[^\\s\']+)'
-    'name': 'constant.numeric.binary'
+        name: 'constant.numeric.hex.merlin'
       }
+      # hex, prefixed with ampersand($)
       {
-    'match': '\\b(?i:TAS|TSA|SWA|TAD|TDA|BLT|BGE)\\b'
+        match: '-?\\$[A-Fa-f0-9]+'
-    'name': 'keyword.mnemonic.65816.alt'
+        name: 'constant.numeric.hex.merlin'
       }
+      # octal, prefixed with @
       {
-    'match': '(?<=,)([xXyYsS])\\b'
+        match: '@([0-7]+)\\b'
-    'name': 'variable.language.register'
+        name: 'constant.numeric.octal.merlin'
       }
+      # binary
       {
-    'begin': '"'
+        match: '%[01]+'
-    'end': '"'
+        name: 'constant.numeric.binary.merlin'
-    'name': 'string.quoted.double'
       }
+      # decimal
       {
-    'begin': '\''
+        match: '\\b([0-9]+)\\b'
-    'end': '\''
+        name: 'constant.numeric.decimal.merlin'
-    'name': 'string.quoted.single'
       }
+    ]
+
+  # assembler directives
+  directives:
+    patterns: [
+      # file control
       {
-    'match': '^[*].*'
+        match: '\\b(?i:equ|ext|ent|org|rel|obj|var|typ|end|dum|dend|ast|dat|lstdo|pag|ttl|skp|chk|err|kbd|lup|--\\^|mx|pau|sw|usr|xc)\\b'
-    'name': 'comment.line'
+        name: 'keyword.directive.merlin'
       }
+      # data control
       {
-    'match': ';.*'
+        match: '\\b(?i:da|dw|ddb|db|dfb|adr|adrl|ds)\\b'
-    'name': 'comment.line'
+        name: 'support.function.pseudo.merlin'
       }
+      # conditional control
       {
-    'match': '^][0-~]*\\b'
+        match: '\\b(?i:do|else|if|fin)\\b'
-    'name': 'entity.name.label.variable'
+        name: 'keyword.control.conditional.merlin'
       }
+      # macro control
       {
-    'match': '^:[0-~]*\\b'
+        match: '\\b(?i:mac)\\b|<<<'
-    'name': 'entity.name.label.local'
+        name: 'support.function.pseudo.merlin'
+        # name: 'keyword.directive.macro.merlin'
       }
+      # operators
       {
-    'match': '^[:-~][0-~]*\\b'
+        match: '[-+/*^><|#\\[\\](),=.!&]'
-    'name': 'entity.name.function'
+        name: 'keyword.operator.merlin'
       }
+      # disk commands
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'string.quoted.other.path.merlin'
-      '2':
+        match: '\\b((?i:dsk|put|use|sav))\\s+(\\S*)'
-        'name': 'string.quoted.other.path'
+        name: 'meta.disk.directive.merlin'
-    'comment': 'eg: KEEP pathname'
-    'match': '\\b((?i)DSK|PUT|USE|SAV)\\s+(\\S*)'
-    'name': 'meta.path.directive'
       }
+      # cycle count
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'constant.language.merlin'
-      '2':
+        match: '\\b((?i:cyc))\\s+((?i:on|off|ave))\\b'
-        'name': 'constant.language'
+        name: 'meta.cyc.directive.merlin'
-    'comment': 'eg: KEEP pathname'
-    'match': '\\b((?i)CYC)\\s+((?i)ON|OFF|AVE)\\b'
-    'name': 'meta.cyc.directive'
       }
+      # expand control
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'constant.language.merlin'
-      '2':
+        match: '\\b((?i:exp))\\s+((?i:on|off|only))\\b'
-        'name': 'constant.language'
+        name: 'meta.exp.directive.merlin'
-    'comment': 'eg: KEEP pathname'
-    'match': '\\b((?i)EXP)\\s+((?i)ON|OFF|ONLY)\\b'
-    'name': 'meta.exp.directive'
       }
+      # list control
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'constant.language.merlin'
-      '2':
+        match: '\\b((?i:lst))\\s+((?i:off))\\b'
-        'name': 'constant.language'
+        name: 'meta.exp.directive.merlin'
-    'comment': 'eg: KEEP pathname'
-    'match': '\\b((?i)LST)\\s+((?i)ON|OFF|RTN)\\b'
-    'name': 'meta.lst.directive'
       }
+      # truncation control
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'constant.language.merlin'
-      '2':
+        match: '\\b((?i:tr))\\s+((?i:on|off|adr))\\b'
-        'name': 'constant.language'
+        name: 'meta.tr.directive.merlin'
-    'comment': 'eg: KEEP pathname'
-    'match': '\\b((?i)LST)\\s+((?i)OFF)\\b'
-    'name': 'meta.lstdo.directive'
       }
+      # string command
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive'
+          2: name: 'string.delimited.begin.merlin'
-      '2':
+          3: name: 'string.delimited.merlin'
-        'name': 'constant.language'
+          4: name: 'string.delimited.end.merlin'
-    'comment': 'eg: KEEP pathname'
+          5: name: 'constant.numeric.hex.merlin'
-    'match': '\\b((?i)TR)\\s+((?i)ON|OFF|ADR)\\b'
+        match: '\\b((?i:asc|dci|inv|fls|str))\\s+(\\S)(.*?)(\\2|\\S),([a-fA-F0-9]+)?'
-    'name': 'meta.tr.directive'
       }
+      # reverse command
       {
-    'captures':
+        captures:
-      '1':
+          1: name: 'support.function.pseudo.merlin'
-        'name': 'keyword.directive.string'
+          2: name: 'string.delimited.begin.merlin'
-      '2':
+          3: name: 'string.delimited.merlin'
-        'name': 'string.delimited.begin'
+          4: name: 'string.delimited.end.merlin'
-      '3':
+        match: '\\b((?i:rev))\\s+(\\S)(.*?)(\\2|$)'
-        'name': 'string.delimited'
-      '4':
-        'name': 'string.delimited.end'
-      '5':
-        'name': 'keyword.operator'
-      '6':
-        'name': 'constant.numeric.hexadecimal'
-    'comment': 'optional trailing hex data'
-    'match': '\\b((?i)ASC|DCI|INV|FLS|STR)\\s+(\\S)(.*?)(\\2|$)(,([0-9A-Fa-f]+))?'
-    'name': 'meta.string.delimited'
       }
+      # hex command
       {
-    'captures':
+        begin: '\\b((?i:hex))\\b'
-      '1':
+        captures:
-        'name': 'keyword.directive.string'
+          1:
-      '2':
+            name: 'support.function.pseudo.merlin'
-        'name': 'string.delimited.begin'
+        end: '$'
-      '3':
+        name: 'meta.hex.directive.merlin'
-        'name': 'string.delimited'
+        patterns: [
-      '4':
+          # hex without $
-        'name': 'string.delimited.end'
+          {
-    'match': '\\b((?i)REV)\\s+(\\S)(.*?)(\\2|$)'
+            match: '\\b[a-fA-F0-9]{1,2}\\b'
-    'name': 'meta.string.delimited.rev'
+            name: 'constant.numeric.hex.merlin'
           }
+          # semicolon comments
           {
-    'begin': '\\b((?i)HEX)\\b'
+            match: ';.*'
-    'captures':
+            name: 'comment.line.semicolon.merlin'
-      '1':
-        'name': 'keyword.directive.data'
-    'comment': 'HEX has a list of hex bytes w/o the $'
-    'end': '$'
-    'name': 'meta.hex'
-    'patterns': [
-      {
-        'match': '\\b[0-9A-Fa-f]{1,2}\\b'
-        'name': 'constant.numeric.hex'
           }
+          # number check
           {
-        'match': ';.*$'
+            match: '(?!,)\\S'
-        'name': 'comment.line'
+            name: 'invalid.illegal.merlin'
-      }
-      {
-        'match': ','
-        'name': 'keyword.operator'
-      }
-      {
-        'match': '\\S'
-        'name': 'invalid.illegal'
           }
         ]
       }
-  {
-    'match': '\\b(?i:DSK|EQU|EXT|ENT|ORG|REL|OBJ|PUT|USE|VAR|SAV|TYP|END|DUM|DEND|AST|CYC|DAT|EXP|LST|LSTDO|PAG|TTL|SKP|TR|CHK|ERR|KBD|LUP|--\\^|MX|PAU|SW|USR|XC)\\b'
-    'name': 'keyword.directive'
-  }
-  {
-    'match': '\\b(?i:DA|DW|DDB|DB|DFB|ADR|ADRL|HEX|DS|ASC|DCI|INV|FLS|REV|STR)\\b'
-    'name': 'keyword.directive.data'
-  }
-  {
-    'match': '\\b(?i:DO|ELSE|IF|FIN)\\b'
-    'name': 'keyword.control.conditional'
-  }
-  {
-    'match': '\\b(?i:MAC)\\b|<<<'
-    'name': 'keyword.directive.macro'
-  }
-  {
-    'match': '[-+/*^><|#\\[\\](),=.!&]'
-    'name': 'keyword.operator'
-  }
     ]
-'repository':
-  'M6502':
-    'match': '\\b(?i:ADC|AND|ASL|BCC|BCS|BEQ|BIT|BMI|BNE|BPL|BRK|BVC|BVS|CLC|CLD|CLI|CLV|CMP|CPX|CPY|DEC|DEX|DEY|EOR|INC|INX|INY|JMP|JSR|LDA|LDX|LDY|LSR|NOP|ORA|PHA|PHP|PLA|PLP|ROL|ROR|RTI|RTS|SBC|SEC|SED|SEI|STA|STX|STY|TAX|TAY|TSX|TXA|TXS|TYA)\\b'
-    'name': 'keyword.mnemonic.6502'
-  'M65816':
-    'match': '\\b(?i:BRL|COP|JML|JSL|MVN|MVP|PEA|PEI|PER|PHB|PHD|PHK|PLB|PLD|REP|RTL|SEP|TCD|TCS|TDC|TSC|TXY|TYX|WDM|XBA|XCE)\\b'
-    'name': 'keyword.mnemonic.65816'
-  'M65816L':
-    'match': '\\b(?i:ADCL|ANDL|CMPL|EORL|LDAL|ORAL|SBCL|STAL)\\b'
-    'name': 'keyword.mnemonic.65816.long'
-  'M65C02':
-    'match': '\\b(?i:BRA|PHX|PHY|PLX|PLY|STP|STZ|TRB|TSB|WAI)\\b'
-    'name': 'keyword.mnemonic.65c02'
-  'binary_number':
-    'match': '%[01]+'
-    'name': 'constant.numeric.binary'
-  'decimal_number':
-    'match': '\\b([0-9]+)\\b'
-    'name': 'constant.numeric.decimal'
-  'hex_number':
-    'match': '\\$[A-Fa-f0-9]+'
-    'name': 'constant.numeric.hex'
-  'octal_number':
-    'match': '@([0-7]+)\\b'
-    'name': 'constant.numeric.octal'
-'scopeName': 'source.assembly.65816.merlin'

grammars/merlin_old.cson

@@ -225,4 +225,4 @@
   'octal_number':
     'match': '@([0-7]+)\\b'
     'name': 'constant.numeric.octal'
-'scopeName': 'source.assembly.65816.merlin'
+'scopeName': 'source.assembly.65816.merlinold'