initial 2.13 commit

Author: John Hankinson

.vs/HJWasm/v14/.suo

@@ -0,0 +1,48 @@
+
+  Possible Enhancements for JWasm
+
+  1. support UNICODE strings. Similar to PoAsm? Most likely no,
+     since using the DB/DW directives to define such strings 
+     doesn't seem to be the best strategy. Might be better to 
+     have an extra type for unicode strings (tchar), in 
+     conjunction with a cmdline option to switch ansi/unicode.
+
+  2. [ done, was: option FPO (frame pointer omission); has
+     become option STACKBASE. ]
+
+  3. unnamed RECORD within a STRUCT. Record field names
+     will be local then and must be unique within the STRUCT. This
+     feature will ease converting C include files to ASM.
+
+     Syntax:
+
+     operator WIDTH: ok
+     operator MASK: ???
+
+     S1 STRUCT
+     f1  dd ?
+     RECORD bit0:1, bit1:1
+     S1  ends
+
+     mov eax, MASK S1.bit0
+     or v1.bit0 ???
+
+  4. [ done, was: native support for PE binaries ]
+
+  5. ASSUME extension
+
+     use ASSUME CS:[USE16|USE32|USE64] to change current offset size
+     without changing segments.
+
+  6. FOR extension
+
+     Preprocessor extension:
+
+     FOR EACH x IN [<struct>|<union>|<record>|<proc>]
+       ...
+     ENDM
+
+     - x is the loop variable, it's a text macro, its value will be
+       the name of the item.
+     - the "members" are enumerated. For PROCedures, these are the
+       parameters, local variables and local labels.

Doc/enh.txt

@@ -0,0 +1,26 @@
+
+  Issues in the source which should be fixed.
+
+  1. Backpatching
+
+  Currently backpatching handles JMPs and CALLs only. It
+  is unable to handle PUSHs ( and may be others as well).
+  So the backpatch routine calculates addresses wrong and
+  as a result an additional assembly pass is required.
+
+  2. Two Pass Minimum
+
+  Currently the generated code/data bytes aren't stored in
+  assembly pass one. So a second pass is always needed. 
+  With better backpatching capabilities, JWasm should be
+  able to virtually become a one-pass assembler.
+
+[ issue fixed in v2.06
+
+  3. Token Buffer
+
+  The token buffer is a global variable. This causes
+  a lot of problems. There are some workarounds implemented
+  to make the buffer reusable, but these hacks didn't
+  help to make the code more readable.
+]

Doc/fixes.txt

@@ -0,0 +1,21 @@
+
+  1. What is generated code
+
+  Some directives (and also instructions RET/IRET inside a procedure block)
+  will generate source lines. In the listing file, those generated
+  lines will be marked with a '*'.
+
+  2. Where is generated code used?
+
+  - INVOKE directive
+  - hll directives (.IF, .ELSE, .WHILE, .REPEAT, ...)
+  - .MODEL directive
+  - .STARTUP and .EXIT directives
+  - simplified segment directives (.CODE, .DATA, .CONST, ...)
+  - default PROC prologue and epilogue (when a RET/IRET is detected)
+  - ENDP ( in Win64, if procedure has FRAME attribute )
+  - END 
+    + if a segment opened by simplified segment directives is still open
+    + PE format: generates import/export data, MZ header
+  - [removed since v2.09: STRUCT data initialization (was slightly peculiar)]
+

Doc/gencode.txt

@@ -0,0 +1,158 @@
+
+  A brief overview of JWasm's source code
+
+  1. Source files
+
+  file        comment
+  -----------------------------------------------------------------------
+  main.c      contains main()
+  cmdline.c   parse command line
+  assemble.c  assembler (generic)
+  input.c     read source file, 
+              preprocessor (generic)
+              calling preprocessor directives
+  expans.c    (text) macro expansion
+  tokenize.c  tokenizer, COMMENT directive
+  condasm.c   preprocessor conditional directives (IFx, ELSEx, ENDIF )
+  loop.c      preprocessor loop directives (FOR, FORC, REPT, WHILE, ...)
+  equate.c    (preprocessor) EQU and '=' directives
+  string.c    preprocessor string directives (TEXTEQU, CATSTR, SUBSTR, ...)
+  macro.c     preprocessor MACRO and PURGE directives
+  parser.c    parser (generic)
+  branch.c    parsing of branch instructions (JMP, Jcc, CALL, JxxxZ, LOOPx )
+  expreval.c  expression evaluator
+
+  assume.c    parsing of ASSUME directive
+  context.c   parsing of directives PUSHCONTEXT, POPCONTEXT
+  cpumodel.c  parsing of .MODEL and cpu (.8086, .80186, ...) directives
+  data.c      parsing of data directives (DB, DW, ... ), data labels
+              handles data generation (+fixups)
+  directiv.c  parsing of various directives which have no other home
+  end.c       parsing of END, .STARTUP and .EXIT directives
+  extern.c    parsing of EXTERN, EXTERNDEF, COMM, PUBLIC, PROTO
+  hll.c       parsing of hll directives (.IF, .ELSE, .WHILE, .REPEAT, ...)
+  invoke.c    parsing of INVOKE directive
+  labels.c    parsing of LABEL directive, code labels
+  listing.c   parsing of listing directives (.LIST, .CREF, ...)
+              writing of listing file
+  option.c    parsing of OPTION directive
+  posndir.c   parsing of ORG, ALIGN, EVEN directives
+  proc.c      parsing of PROC, ENDP, LOCAL directives
+              generates procedure prologues and epilogues
+  safeseh.c   parsing of .SAFESEH directive
+  segment.c   parsing of SEGMENT (+ENDS) and GROUP directives
+  simsegm.c   parsing of simplified segment directives (.CODE, .DATA, ...)
+  types.c     parsing of STRUCT (+ENDS), UNION, TYPEDEF, RECORD directives
+
+  omf.c       handles OMF output format
+  omffixup.c  handles OMF fixup generation
+  omfint.c    handles OMF I/O
+  coff.c      handles COFF output format (32- and 64-bit)
+  elf.c       handles ELF output format (32- and 64-bit)
+  bin.c       handles binary and DOS MZ output format
+  dbgcv.c     handles output of CodeView symbolic debugging info
+
+  reswords.c  handles access to table of reserved words
+  symbol.c    handles access to - global and local - symbol (hash) table
+  backptch.c  handles backpatching (jump distance optimization)
+  codegen.c   handles instruction code generation (+fixups)
+  fixup.c     fixup creation
+  fpfixup.c   16-bit floating-point fixup creation
+  errmsg.c    handles assembler error messages (non-fatal)
+  fatal.c     handles fatal assembler errors
+  memalloc.c  handles dynamic memory allocations
+  tbyte.c     handles TBYTE data format (10-byte floating-point format)
+  queue.c     handles internal queues
+  mangle.c    handles symbol name mangling (name decoration)
+  apiemu.c    handles C compiler peculiarities and bugs
+
+
+  2. Calling hierarchy
+
+  main
+  - main_init
+  - main_fini
+  - AssembleModule
+    - AssembleInit
+    - AssembleFini
+    - OnePass
+      - GetPreprocessedLine ( if pass == 1 )
+        - GetTextLine
+      - Tokenize ( if pass > 1 )
+      - ParseLine
+        - directive
+        - data_init
+          - EvalOperand
+        - EvalOperand()
+        - codegen()
+
+  1. main()
+
+  cmdline parsing, wildcards
+  calls AssembleModule() for each source module.
+
+  2. AssembleModule()
+
+  assembles one module in at least 2 passes.
+
+  3. OnePass()
+
+  Executes one pass for a module. Pass one is handled
+  differently than the others, because the preprocessed
+  lines are saved in this pass and then read in the
+  consecutive passes.
+
+  4. Tokenize()
+
+  The tokenizer. Scans a source line and detects reserved words,
+  numbers, IDs, operators, literals. Converts the items to tokens
+  stored in array tokenarray[].
+
+  5. GetPreprocessedLine()
+
+  This is the preprocessor. It 
+  - reads a line from the current source,
+  - converts in into tokens ( function Tokenize() )
+  - calls macro expansion.
+  - checks if the line contains a preprocessor directive
+    preprocessor directives are IF, WHILE, REPEAT, INCLUDE,
+    TEXTEQU, CATSTR, INSTR, ...
+  - if yes, handles the directive and returns 0.
+  - if no, returns the number of tokens found in the line
+
+  6. ParseLine()
+
+  The parser. It does:
+  - checks if first item is a code label (ID followed by ':'). If yes,
+    a label is created ( function LabelCreate() ).
+  - checks if current item is a directive. If yes, calls function
+    directive() or - if directive is a "data definition directive" -
+    function data_item()
+  - checks if current item is predefined type or an arbitrary type.
+    If yes, calls function data_item().
+  - if current item is an instruction, it calls the expression
+    evaluator ( function EvalOperand() ), up to 3 times, to get
+    the operands.
+  - if more than 1 operand has been read, function check_sizes()
+    is called, which verifies that the sizes of the operands will
+    "match".
+  - the code generator ( function codegen() ) is called.
+
+  7. codegen()
+
+  The code generator. This part 
+  - scans the instruction table to find an entry which matches
+    the number of operands and their types.
+  - if an entry is found, the code bytes and fixups are generated
+    and written into a buffer.
+
+  8. data_init()
+
+  Handles data lines. This is either a data directive ( DB, DW, DD, ...),
+  a predefined type ( BYTE, WORD, DWORD, ... ) or an arbitrary type, defined
+  with TYPEDEF, STRUCT, UNION, ....
+
+  9. GetTextLine()
+
+  Reads a line from the current source. This is either a macro, a source
+  file or the global line queue, which is used to store generated code.

Doc/overview.txt

@@ -0,0 +1,66 @@
+
+JWasm originally was a fork of Wasm. The old Open Watcom Wasm source 
+was released under the Sybase license (S).
+
+In the meantime, a part of the source contain no lines of
+Wasm anymore - they are new or have been completely rewritten. The license
+for these files is Public Domain (P).
+
+apiemu.c           P
+assemble.c         P
+assume.c           S
+atofloat.c         P
+backptch.c         S
+bin.c              P
+branch.c           S
+cmdline.c          S
+codegen.c          S
+coff.c             P
+condasm.c          S
+context.c          P
+cpumodel.c         P
+data.c             S
+dbgcv.c            P
+directiv.c         P
+elf.c              P
+end.c              P
+equate.c           P
+errmsg.c           S
+expans.c           P
+expreval.c         S
+extern.c           P
+fastpass.c         P
+fixup.c            S
+fpfixup.c          S
+hll.c              P
+input.c            S
+invoke.c           P
+label.c            S
+linnum.c           P
+listing.c          P
+loop.c             P
+lqueue.c           P
+macro.c            P
+main.c             P
+mangle.c           S
+memalloc.c         P
+msgtext.c          P
+omf.c              S
+omffixup.c         S
+omfint.c           S
+option.c           P
+parser.c           S
+posndir.c          S
+preproc.c          P
+proc.c             P
+queue.c            S
+reswords.c         P
+safeseh.c          P
+segment.c          S
+simsegm.c          P
+string.c           P
+symbols.c          S
+tbyte.c            S
+tokenize.c         S
+trmem.c            S
+types.c            P

Doc/srclic.txt

@@ -0,0 +1,53 @@
+
+# This makefile creates the HJWasm 32-bit DOS binary with DJGPP.
+#  'make -f GccDos.mak'
+
+name = hjwasm
+
+ifndef DEBUG
+DEBUG=0
+endif
+
+inc_dirs  = -IH
+
+#cflags stuff
+
+ifeq ($(DEBUG),1)
+extra_c_flags = -DDEBUG_OUT -g
+OUTD=DJGPPd
+else
+extra_c_flags = -DNDEBUG -O2
+OUTD=DJGPPr
+endif
+
+c_flags = $(extra_c_flags)
+
+CC=gcc.exe -c $(inc_dirs) $(c_flags)
+
+$(OUTD)/%.o: %.c
+	$(CC) -o $(OUTD)/$*.o $<
+
+include gccmod.inc
+
+TARGET1=$(OUTD)/$(name).exe
+
+ALL: $(OUTD) $(TARGET1)
+
+$(OUTD):
+	mkdir $(OUTD)
+
+$(OUTD)/$(name).exe : $(OUTD)/main.o $(proj_obj)
+	gcc.exe $(OUTD)/main.o $(proj_obj) -s -o $(OUTD)/$(name).exe -Wl,-Map,$(OUTD)/$(name).map
+
+$(OUTD)/msgtext.o: msgtext.c H/msgdef.h H/globals.h
+	$(CC) -o $(OUTD)/msgtext.o msgtext.c
+
+$(OUTD)/reswords.o: reswords.c H/instruct.h H/special.h H/directve.h
+	$(CC) -o $(OUTD)/reswords.o reswords.c
+
+######
+
+clean:
+	@erase $(OUTD)\*.exe
+	@erase $(OUTD)\*.obj
+	@erase $(OUTD)\*.map