joshuawierenga / betterasmgeneration Goto Github PK

The current comma-separated tokens syntax is annoying to use and makes it more difficult to port existing assembly into. Ideally, this would be replaced with the more standard intel syntax.

I have started work on this in this branch which will support writing assembly in a string with custom syntax highlighting.

TODOs:

• Modify source generator to support assembly within a string
  • Add basic support: mnemonics, registers and immediates (9c52de2, AsmGenerator 0.1.0)
  • Add variable support (9c52de2, AsmGenerator 0.1.0)
  • Add label support (1b53480, AsmGenerator 0.7.0)
  • Add memory support (143e54d, AsmGenerator 0.8.0)
  • Remove reflection usage (a6d36b1 and 5b99a94, AsmGenerator 0.3.0)
  • Get both formats to agree on argument hashes so that the same code given in both formats uses the same generated code (75ee20a, 244cef3, AsmGenerator 0.5.0 & AsmLib 0.4.0)
• Put source generator into the extension if possible
• Get custom grammar to apply to .cs files or add an extension to change the file extension to .csasm whenever the user's cursor is inside of an asm block.

Changes to existing features:

• Remove the random blank line at the beginning of instruction functions (266901c, AsmGenerator 0.2.0)
• Make language flag optional for source generator
• Avoid duplicating cases between both AddInstructions functions (266901c, AsmGenerator 0.2.0)
• Fix string format assembly generating a different hash if the formatting changes (75ee20a, AsmGenerator & AsmLib 0.4.0)
• Only emit string format InHash to hashmap if variables were used (b04cbcc, AsmGenerator 0.7.2)
• Use intel style for register indirect addressing with string format (e5d8ad7, AsmGenerator 0.9.0)
• Support specifying the size of memory referred to by an indirect address (e5d8ad7, AsmGenerator 0.9.0 & AsmLib 0.6.0)

Once the string format option has at least matched the features of the params array format syntactically, it would be nice to support basic error detection. This could be done by replacing the exceptions in the source generator with Roslyn errors and then skipping the request.

This would also ensure that errors in one AddInstructions call within a project do not cause Visual Studio to complain about the function not existing.