RGBFMT tool to fix code formatting

[Rangi42]

Modern programming languages tend to have auto-formatters. It would be worthwhile to have one for RGBASM as well, supporting users' various preferred styles.

Configurable options (not meant as a complete list):

• Indentation: tabs or N spaces
• Max line length: backslash line continuations could apply for long lines (0 = no limit)
• Case: lower or UPPER, separately configurable for:
  • hex digits
  • instructions/registers/conditions
  • directives/keywords
  • plus a way to special-case some (e.g. lowercase everything except MACRO/ENDM and SECTION/ENDSECTION)
• Instructions: some instructions have alternatives
  • the optional a argument for add, sub, cpl, etc
  • ld [hli/hld] vs ld [hl+/hl-] vs ldi/ldd [hl]
  • ldh [c] vs ld [$ff00+c]
  • nz/nc vs !z/!c
• Blank lines: configure how many blank lines to put:
  • before global labels
  • before new sections
  • before other directives
• Anonymous labels: put : on its own line, or on the same line as the subsequent instruction
• Macros: indent macro invocations or not (or e.g. indent all of them except mycol1macro)

[aaaaaa123456789]

• Spaces around operators (wFoo + 1 vs. wFoo+1, ~STUFF vs. ~ STUFF)
• Pad non-decimal constants to length (%101 vs. %00000101, $ac3 vs. $0ac3)
• Labels on the same line (allow/forbid Foo: db 1, same for locals)
• Data definitions (db vs. ds 1 vs. allow both)
• Indentation: what is indented (which directlves, etc.)
• Nested indentation (when to use it)
• Comments: allow inline comments vs. put them above or below
• Spacing in instructions (ld a, 1 vs. ld a,1; ld a, 1 vs. ld<tab>a, 1)
• Any deprecated features that can be detected and/or fixed

[dmitry-shechtman]

• ld a, \[h[A-Z0-9].+\]
• ld \[h[A-Z0-9].+\],a
• Similar rules for r would require parsing hardware.inc. Complicated, but not unfeasible

[Rangi42]

A formatting tool should never change the meaning of code or what gets output into ROM. Those are ideas for a different tool (rgboptimize?).

[dmitry-shechtman]

Those are ideas for a different tool (rgboptimize?).

Sounds like a plan!