README

   1
   2 The goal of this assembler is to eventually not be simply an M68K
   3 assembler, but to be relatively easily retargetable.  Also, this
   4 assembler should be callable from other CL applications, as well as
   5 executable as a stand-alone program.
   6
   7
   8 The a.out object format supported here and by st-linker is not really
   9 quite exactly a.out.  It's close, though.
  10
  11
  12
  13 Things to add in the grammar/parser/lexer:
  14
  15 Support for ' (single ASCII character?) -- only because the
  16         book I have says it's part of Motorola's standard.  Should it
  17         behave like double-quotes or what?
  18 Support for floats (once FPU instructions are supported).
  19 Line continuations with "\".
  20 Literate input.
  21
  22
  23 Things to add in the assembler:
  24
  25 Checking ranges of types, signed indices, etc.
  26         Also, type checking information stored in the symbol table.
  27 Output listings (with cycle counts, et cetera).
  28 Support for later chips in the m68k line, and enabling/disabling
  29         allowance of their added instructions.
  30 Change lookup tables so that on load, they get converted to hash
  31         tables or whatever's appropriate.
  32 Nifty local labels a-la GNU as or similar.  (0f, 1b, etc)
  33 BRA.S (currently you have to say BRA.B).
  34 CL-style macros?  (that would be cool!)
  35 Debugger info.
  36 Output in object formats other than A.OUT.
  37 Optimizations/data flow analysis.
  38 Optional lispy object format.  (see st-linker README)
  39 ADDI instead of ADD in certain cases.
  40
  41
  42 THINGS TO DO BEFORE RELEASE
  43
  44 - remove debugging output.
  45 - add a decent warning/error display and logging system.
  46 - compile list of known issues, try to resolve.
  47 - put together a basic automated test suite.
  48   (once object format has settled down, start a set of regression files,
  49    with sane output verified by hand.)
  50 - skim all XXXs.
  51 - once a better warning system is in place, allow routines like
  52   MODIFIER-BITS to guess the size of underspecified operations, and warn
  53   about them at suitable warning levels.
  54 - test with sourcer68 output of various files.
  55 - Things to test about relocation:
  56         are 8-bit indirect displacements being relocated correctly?
  57         verify all possible relocation combinations.
  58 - Update dependencies in ASDF file so that it compiles without warnings.
  59 - *last-label* feels like a hack.  See if there's an alternative.
  60 - add raw binary output.  (also, to linker.)
  61 - DC needs some serious cleanups.
  62 - undo some of the intentional braindamage induced to make us closer
  63   to devpac.
  64 - various pseudo-ops need to work on list of operands rather than
  65   single operand.
  66
  67
  68
  69 KNOWN ISSUES
  70
  71 - macro parameters are broken.  At least, <foo> style ones are still
  72   broken.  [assembler]
  73 - size output is broken if ORG is used. [assembler]
  74 - no checking of vconstraints yet. [codegen]
  75 - Unfinished pseudo-ops:
  76         EQUR
  77         DCB
  78         END
  79         IFxx
  80 - branch-displacement-bits will behave badly in some unusual situations.
  81 - requires that the file end with a newline, and there is no warning
  82   that the last line is ignored.
  83
  84
  85 KNOWN MAJOR INCOMPATIBILITIES WITH DEVPAC
  86
  87 These are things which aren't likely to change soon.
  88
  89 Macros:
  90
  91 - we don't support < or > embedded in macro parameters which are
  92   already wrapped in < and >.  (eg: "<foo>>>>2>" => "foo>>2") [lexer]
  93
  94
  95 ENHANCEMENTS FROM DEVPAC
  96
  97 - We support EXTERN/GLOBAL as synonyms for XREF/XDEF,
  98   respectively.  Also ALIGN as a simple version of CNOP.
  99