******************************************************
	   *							*
	   *		   S   N   M   A    V1.39		*
	   *		   ~~~~~~~~~~~~~~~~~~~~~~		*
	   ******************************************************

      *****************************************************************
      * $Id: snma.doc,v 1.2 94/01/02 22:15:56 spn Exp Locker: spn $ *
      *****************************************************************


    SNMA is 680x0 conditional macro assembler.

    Copyright © 1993,1994 Samu Nuojua.

    This document is plain text conversion of the AmigaGuide version of the
    SNMA documents. AmigaGuide version (SNMA.guide) is recommended to be
    used as a SNMA document, if possible. This documents holds about the
    same things, expect that I have shortened some not so important parts
    of it.


    Contents of the SNMA.doc
    ~~~~~~~~~~~~~~~~~~~~~~~~

    1.	Introduction
	1.1 Copyright stuff
	1.2 Requirements
	1.3 How to Install
	1.4 Good & Bad things
    2.	Usage
    3.	Features
	3.1 Source code format
	3.2 Symbols
	3.3 Expressions
	3.4 Addressing modes
	3.5 Directives
	3.6 Data types
	3.7 Things to note
	    3.7.1 About Bcc
	    3.7.2 The Check of the data sizes
	3.8 Error Messages
    4. Author			How to contact


    To search chapter it is best to use the find feature of your reader (or
    whatever) and search the number of the chapter.

    Here we go... [insert your favorite solo here]


    1.Introduction to Samu Nuojua's Macro Assembler ,SNMA
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    SNMA is 680x0/6888x macro assembler. At present, it is used from the
    shell. SNMA requires AmigaDOS 2.0+. If you are familiar with the a68k
    you are at home with the SNMA (take a look at the "Features.Things to
    note").


    1.1 Copyright stuff
    ~~~~~~~~~~~~~~~~~~~

    SNMA stands for Samu Nuojua's Macro Assembler.

    SNMA is © copyright 1993,1994 by Samu Nuojua.

    All SNMA documents are © copyright 1993,1994 by Samu Nuojua.

    SNMA is FREEWARE. I reserve all rights to SNMA. You can copy it as
    long you don't ask payment (small fee is allowed to cover the expenses
    of the possible disk/postage fee). Permission is granted to upload
    SNMA to the bulletin boards and FTP sites. Also, you must provide all
    the files supplied when you are copying SNMA to somewhere/somebody
    (including all the documents).

    SNMA software and documents are provided 'as is'. No guarantee of
    any kind is given what SNMA does or that information in  files is
    correct in any way. You are using this software at your own risk,
    author of the SNMA is in NO WAY responsible for any losses or damage
    caused by SNMA.


    1.2 Requirements
    ~~~~~~~~~~~~~~~~

    What you need to use SNMA to produce stand alone programs.
				 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Required:
	    AmigaOS 2.04 or higher (V37)
	    Linker		   (to produce executables)
	    Text editor 	   (to write/edit programs)

	Recommended:
	    Hard Disk
	    Manuals, manuals ....
	    Time (heh)...
	    Debugger


    1.3 How to Install
    ~~~~~~~~~~~~~~~~~~

    Installing SNMA is not a difficult task. To use macro assembler I
    assume you have some  experience with the shell. Simply copy SNMA
    file somewhere which is under the search path (like c: directory).
    Documents you can put wherever you want. There is so little to copy
    that sure you can do it yourself, can't you ?

    1.4 Good & Bad things
    ~~~~~~~~~~~~~~~~~~~~~

    My personal view from this assembler. There are currently more bad
    things but I tend to be critical to me.

    Good:

	- It's free.
	- Most common directives are supported.
	- Macros are supported.
	- All 680x0, 6888x, 68851 and 68030 PMMU instructions are supported
	- Does normal optimizations, including forward branches.
	- It's not terribly slow.
	- It's coded with assembler. (See below, Bad things).
	- Enforcer was in duty all the time I coded, checked, debugged...
	- Supports all the data types of 680x0 6888x family (I think).
	  (FFP conversions not supported).
    Bad:

	- 68040 instructions (those couple of) are not yet supported.
	- Listing file not supported
	- Movem optimizing is not implemented (yet)
	- address to address(pc) optimizing not supported, yet.
	- All source files must fit to the memory at the same time.
	- Is not coded very space-effeciently. (Space versus time).
	- Is coded with assembler. 8>).(
	- Document sucks...(As always).
	- Code size is huge, especially because I coded this with the
	  assembler (a68k v2.71) (about 75kB).
	- Won't support any small data model.
	- Beginners help would be nice.
	- Only outputted format is Amiga object code.
	- No LINE DEBUG HUNK (how it is implemented ?).
	- This document is a translators nightmare!!!!
	  (From the one who tried to fix all the bugs in the english of this
	  document...)	(Hey! Don't accuse me........eeeee. Urgh.)

    Things to do:
	Some Bad things away
	arexx, gui     (may take some time)



    2.	How to use
    ~~~~~~~~~~~~~~

    SNMA is currently used from the shell. It parses its arguments using
    dos function ReadArgs().

    Command Line interface:

    SNMA    <source file>
	    [OBJ	<object file>]
	    [INCLUDE	<include dir list>]
	    [HEADER	<header file>]
	    [EQUATE	<equate file>]
	    [LISTING	<listing file>]    *
	    [Q] [P] [A] [B] [S]


    Where:

    <source file>	is the name of the source file

    <object file>	is the name of the object file.
			Shortcut: O <object file>.

    <include dir list>	is the list of the directories where INCLUDE
			directive searches include files
			Shortcut: I <dir list>.

    <header file>	is file to be included before any lines from
			source file are assembled. Only one is allowed.
			Shortcut: H <header file>

    <equate file>	is equate file name to be created. Empty string is
			allowed, produces name from the source file name.


    Q			Quick optimizing flag,	     default: on
    P			pc-relative optimizing,      default: off (not done)
    A			effective address optimizing default: on
    B			Auto-force (Bd,An)->(disp16,An) default: on
    S			Write symbol data hunk	     default: off


    *	Listing file is not implemented


    I have tried SNMA with the stack size of 4000 bytes without problems.
    If you have problems, try with the bigger stack. (I use stack size of
    20000 bytes because RevisonControlSystem requires it).


    3.	The features of the SNMA
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    This section covers all the features of the SNMA.


    3.1 Source code format
    ~~~~~~~~~~~~~~~~~~~~~~

    The format of the source code is 'standard'.

    Take a look for some assembly source code to examine what all the stuff
    below means in real life.

    One source code line may have following components:

    <Label>   <opcode>	<operands>  <comment>


    <Label>	Label must start from first column, or it must be the first
		non-blank character and it must end to the colon (':').

		Legal label chars are 'A-Z', 'a-z', '0-9', '_', '.'
		or codes 127-255 (chars like äöåÞÐ).

		First char must be: 'A-Z', 'a-z', codes 127-255, '_','.'
		After that digits (0-9) are legal, too.

		Local labels are supported. You have three alternatives
		to define local label:

		1)  add '.' in front of it. For example:  .local
		2)  add '\' in front of it.  For example:  \local
		3)  add '$' to the end of it. For example: local$

		Local label can start also with a digit (actual label part).
		(1$, .1,...)

    <opcode>	Opcode field is separated from the label field at least one
		space. Opcode can be:

			1)  MC680x0 operation code (instruction).
			2)  Assembler directive
			3)  Macro invocation

    <operands>	Operand field is separated from the opcode field at least
		one space. Operand field may contain 0 to 9 operands,
		depending  from what is in the opcode field. Operands are
		separated with comma (,).

    <comment>	Anything after the operand field is ignored and treated as
		comment. Note that those MC680x0 instructions which don't
		have operands ignore anything after the opcode field.
		Anything after the ";" mark is treated as comment. If the
		character in the first column is "*" entire line is
		comment.



    3.2 Symbols
    ~~~~~~~~~~~

    Symbols in SNMA have different meaning, depending on where they are
    used.


    3.2.1 Absolute symbols
    ~~~~~~~~~~~~~~~~~~~~~~

    Absolute symbols are defined with EQU or SET directive. Symbols may be
    local symbols same way as labels.See <label> definition.
    Absolute symbols refer to numerical values.


    3.2.2 Relative Symbols
    ~~~~~~~~~~~~~~~~~~~~~~

    Relative symbols are labels, or equates which have relative symbols
    in defining expression. Only exception to this is expression
    Relative-Relative which results absolute type. See expressions  for the
    restrictions with the relative symbols.

    "*" is special symbol and has value of the program counter (PC).

    For example:
     data    ds.b    100	    ; define space 100 bytes
     size    equ     *-data	    ; size gets value of 100 (abs type)



    3.2.3 Register Equates
    ~~~~~~~~~~~~~~~~~~~~~~

    Register equates are defined with equr directive. Register symbol
    refers to the register (Dn or An).


    3.2.4 Register lists
    ~~~~~~~~~~~~~~~~~~~~

    Register lists are only allowed in movem and fmovem instructions.
    They are defined with the reg directive. Register list refers to the
    list of registers.


    3.2.5 Macro symbols
    ~~~~~~~~~~~~~~~~~~~

    Macros are defined with the macro and the endm directives. Macro symbol
    refers to the defined macro.


    3.3 Expressions
    ~~~~~~~~~~~~~~~

    Expressions can be used almost anywhere where numerical
    component(s) is(are) needed. Only exception is floating point numbers
    which don't allow expressions.

    Expressions may have: 1) symbols, 2) constants, 3) operators,
			  4) parentheses.

    1) Symbols must be absolute or relative ones.

    2) Constants are numbers. They can be decimal, hexadecimal ($), or
       in binary (%) form. Sorry, I'm too lazy to do octal, but if
       somebody really needs it, I may do it (never,ever used
       it by myself).

    3) operators

	-		Unary minus
	~		logical not
	<< or < 	left shift
	>> or > 	right shift
	&		logical and
	! or |		logical or
	*		multiply
	/		divide	(integer)
	+		add
	-		subtract

    4) Parentheses are (). They can be nested.
       For example: 3*((12-6)/(2+2))

    Expressions are either absolute or relative, depending from the types
    of the symbols and operators. Relative symbols are allowed only to add
    and sub operands. Note: when expression is evaluated, it is divided to
    the sub-expressions down to stage <number operand number>, where number
    can be symbol. This sub-expression gets its own sub-type. Confusing ?
    See below.

    For example: (Rel2-Rel1)/4 is legal expression, because
		 the type of Rel2-Rel1 is absolute although they both
		 are relative symbols. See below.


    Following table tells types of expressions.
    A = Absolute , R = Relative, - = not allowed

    Operator		    operands
    ~~~~~~~		    ~~~~~~~~
			    A op A	A op R	  R op A    R op R
    +			      A 	  R	    R	      -
    -			      A 	  -	    R	      A
    *, /, &, !, <<, >>	      A 	  -	    -	      -


    3.4 Addressing modes
    ~~~~~~~~~~~~~~~~~~~~

    SNMA supports all the addressing modes of the 680x0.

    SNMA supports Motorola's new addressing mode format and the old one.
    Note that I don't have any of the Motorala's manuals, but I suppose the
    format is right (Base Displacement is inside parentheses).



    Forcing the size
    ~~~~~~~~~~~~~~~~
    In some places, you can force value to be either word or long word.
    This is generally used to force something to the  word size, but it
    can be used to force something to the long size, too. Forcing is
    implemented adding .w (for word) or .l (for long word) suffix to
    the symbol. For example, 'move.l  (4.w),a0'.

    Note1: Above addressing mode is optimized when using simple 'move.l
	   (4),a0'. 'move.l (4.l),a0' would not allow optimizing
	   because of the force suffix.

    Note2: SNMA won't complain mode (4).w, but it ignores the  forcing
	   suffix. Above mode is discouraged anyway if you take a look
	   to the new addressing mode syntax of Motorola.


    Base displacement modes (including Memory Indirect)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    You can force Base Displacement and  Outer Displacement to be a
    long word or word with .l (long) or .w (word) suffix.

    For example:    ([BD.w,A0,d1.w],OD.l)   where BD and OD are
					   symbols.


    SNMA will optimize addressing modes to the best possible ones.
    If certain components are omitted change to the quicker mode can
    be made. When you force some value with .l or .w, value must be
    within range and even if actual value would be optimized it is not,
    because it is forced.

    Example:

	jsr	(BD.w,a6)
    BD	equ	0

    ; Although BD is null, generated addressing mode will be disp16(An)
    ; because we forced BD to the word.

	tst.l (BD,a0)
    BD	equ   0

    ; This will generate addressing mode (An)
    ; end of example

    Same thing applies to the Outer Displacement, except that addressing
    mode is always Memory Indirect if there is OD.

    Don't care, if above is confusing. You don't have to force usually
    anything, SNMA optimizes best mode for you. If you want some value
    to be exactly specified size (when importing value, for example)
    forcing is handy feature.


    No Address Register in addressing mode
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    When address register is not part of address generation you have
    two ways to exclude it. First, just don't set it (like (d2.l) ).
    Then you can always use Zero Suppressed address register using name
    ZAn (n does not matter) instead of An. For example,

    (10,d3.l)       =       (10,za0,d3.l)
    (d1.l)          =       (za0,d1.l)
    no way	    =	    (10,za0,a2.w)   index register is An


    Immediate values
    ~~~~~~~~~~~~~~~~

    SNMA checks immediate values so that they are in range, depending
    from the size of the instruction. Immediate values can also be
    longer than 32 bits if instruction is some fpu/mmu instruction.
    FPU instructions allow real mode definition of the number like
    -11.13232e-2.


    Optimizing Address modes
    ~~~~~~~~~~~~~~~~~~~~~~~~
    Address modes are optimized very well in SNMA. Forward optimizing
    is also included. See OPT directive.
    See above for more information. I suggest that you keep E flag on.
    (I do, all the time).




    3.5 Directives
    ~~~~~~~~~~~~~~

    Following directives are supported:

    o	Cnop	    Conditional NOP
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	This directive is used to align data arbitrarily.

	CNOP	    offset,alignment

	Offset is value which is added to the alignment.
	Alignment is alignment boundary value.
	cnop 0,4    aligns pc to the long word boundary.
	cnop 2,8    align pc to the 8 byte boundary plus two bytes.


    o	Cpu	    Define CPU ID type
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	CPU	    <expression>

	Defines what instructions are legal. This is also used to FPU and
	MMU instructions.

	Expression is simple numerical value which is set to global
	variable cpuID. Pre-defined symbols (use these!):

	M68000
	M68010
	M68020
	M68040
	M68851	    MMU
	M68881	    FPU
	M68882	    FPU   same as M68881
	F040	    MC68040 floating point only
	M030	    68030 MMU


	CPU M68000		    enables 68000 instructions
	CPU M68000!M68010!M68020    enables instructions of those
	CPU M68020!M68030!M68881    enables FPU instruction also (020,030).

	This directive can be used so that if code is wanted to be run in
	M68000 machines you can check that there are no other instructions
	than those which MC68000 recognizes. All combinations are possible.
	CPU -1 enables all instructions to be assembled. SNMA sets cpuID
	to -1 before anything is assembled.

    o	Dc	    Define Constant
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	DC.n	<expression> or <single value>

	n is size of data.
	See Datatypes.

	dc.b	2+1	    reserves one byte and sets 3 to its value.
	dc.l	12	    reserves long word and sets 12 to its value
	dc.s	$FEEBD00D   reserves long word and sets it to $FEEBD00D
	dc.d	+12.9292e-2 reserves two long words and sets its value what
			    that number is in double format (binary).

	Note that expressions are only valid to the integers. Expressions
	with the floating point numbers are not allowed.
	If n is not defined, default is word.


    o	Dcb	    Define Constant Block
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	dcb.n	<abs expression>,<value>

	Reserves space for given data type (n). All entries are set to
	single value which is given as second argument.


    o	Ds	    Define Space
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	DS.n	    <abs expression>

	Defines storage for given  data type (n).

	<abs expression> must be evaluated and it cannot contain relative
	symbols (or undefined by far).
	All reserved space is set to null.

	See 3.6, datatypes.


    o	ElseIf	    Conditional assembly toggle
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	ELSEIF toggles conditional assembly. If assembly was off, it
	toggles it on and vice versa.
	I'm not sure does this work how it should.

    o	End	    End of source file
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	End directive ends assembly. It is not required to be in the end of
	source file. When source file ends it also ends assembly.
	Anything after END directive is not assembled.

    o	Endc	    End conditional assembly
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	ENDC (alias ENDIF)
	Toggles off conditional assembly if nest count match.

    o	Endif	    Alias for endc
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    o	Endm	    End macro definition
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Ends current macro definition.


    o	Equ	    Define symbol value
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	symbol EQU <expression>

	Sets the value of the symbol to <expression>. Symbol and
	<expression> are both required. = is equivalent to equ.

	Floating point numbers are supported by specifying size field to
	the EQU.

	See 3.6, datatypes.

	Note that only floating point data types are supported in equ
	if n suffix is there.

	When symbol is used as part of fpu instruction simple type checking
	is done.

    o	Equr	    Define register equate
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Equr allows register to be addressed as symbols.
	Register equates must de defined before used.

	Example:

	count	equr	d0
		move.l	#0,count	; means move.l #0,d0


    o	Even	    Ensure PC is even
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	EVEN aligns PC to be divisible by two if it is not already.
	It does same thing as cnop 0,2
	See CNOP.

    o	Fail	    User error
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	FAIL flags assembler to stop assembling. It is used to flag user
	errors. It may be used if macro call won't get enough parameters,
	for example.

    o	Idnt	    Set program unit name
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IDNT	    <name>

	Sets the name of the program unit to <name>.

    o	Ifc	    Assemble if strings equal
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IFC	    'string1','string2'

	If string1 = string2  DO assemble.


    o	IFcc	    Assemble if condition true
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IFcc	    <expression>

	IFcc is conditional assembly control directive.
	cc is condition. Expression is tested against the value of zero.

	directive			means
					~~~~~
	IFEQ	    <expression>	EQual
	IFNE	    <expression>	NEqual
	IFGT	    <expression>	Greater Than
	IFGE	    <expression>	Greater or Equal
	IFLT	    <expression>	Lower Than
	IFLE	    <expression>	Lower or Equal

	If condition is true, assembling is continued. If condition is false
	assembling is turned off. ENDC directive ends conditional
	assembling.



    o	Ifd	    Assemble if symbol defined
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IFD <symbol>

	Conditional assembly trigger.
	IF symbol is defined,  do assemble, else don't.

	See also  IFND.

    o	Ifnc	    Assemble if strings not equal
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IFNC	    'string1','string2'

	If string1 <> string2 DO assemble.


    o	Ifnd	    Assemble if symbol undefined
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	IFND	    <symbol>

	Conditional assembly trigger.
	IF symbol is not defined,  do assemble, else don't.


    o	Incbin	    Include Binary
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Incbin directive includes file to the code in its binary form.
	No assembling is done to the file.
	If you have file named bin and it contains following data in
	hex form (4 bytes long file):
	0BAD BEEF

	    IncBin bin
	would do same as
	    dc.l $0BADBEEF.

	If the length of the file is not even, extra null byte is added to
	the end of data when it is set to the produced code. This makes
	sure that the program counter stays aligned. This is just the same
	as the Incbin without this feature (with SNMA this feature is
	always on):

	    incbin  <file>
	    even

	Thus, above 'even' is done automatically (always) by 'incbin' and is
	unnecessary in SNMA.


    o	Incdir	    Include directory list
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	INCDIR directive adds directories to the directory list where
	INCLUDE files are searched from.

	INCDIR	<mydir1>[,mydir2,mydir3...]

	Note that INCBIN uses this list, too.


    o	Include     Include source file
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	INCLUDE <file>

	Starts to assemble <file>. After it has been assembled, continues
	assembling after INCLUDE directive.

	Include files are searched first from the current directory then
	from directory list which can be defined in command line or with
	the INCDIR directive. If include file is not found assembly is
	stopped right here (fatal error).


    o	Macro	    Start macro definition
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	<Symbol>    MACRO

	Starts macro defining. Code inside macro defining is not assembled
	yet. It is assembled when macro is called. NARG symbol is set to
	number of arguments passed to macro.

	Backlash ("\") has special meaning in macro definition.
	If character after it is:

	1)  1-9     insert argument number <number>
	2)  0	    insert size field of macro call
	3)  @<label> produces unique label (like local labels).

	simple example:

	Tee	 macro
		 move.\0    \1,\2
		 endm
		 Tee.b	    d0,d1	; produces move.b d0,d1

    o	MExit	    Exit from macro
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Exit from macro definition.
	Used usually in conditional macros.


    o	Opt	    Define options
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	OPT	    flag[,flag,flag...]

	where flags are:

	Q	Quick optimizing. Move->moveq, add->addq,sub->subq
		whenever possible.
		Default: on

	P	Absolute long addressing -> program counter relative
		whenever possible. (Not implemented yet).
		Default: off

	E	Effective address optmizing. 0(An)->(An), BD and OD
		optimizing if 0 or word. (BD,An)->dip16(An) if possible.
		Optimizes address modes as quick as they can be.
		Default: on

	B	Auto-force (BD,An) ->   disp16(An). This can be overridden
		disabling this flag or using .l suffix in the symbol.
		(BD.l,An) makes addressing mode always long, no matter of
		the B flag. This feature is there because routines of the
		run-time libraries can all be called by (disp16,An) mode.
		Often displacement is xref'd symbol which is solved during
		linking time. Because symbol is xref'd it must be treated
		like being 32 bit because in theory it can be so. All
		library calls however can use (disp16,An) mode. This method
		is provided so that you don't have to add .w extension to
		all calls. Default: on

	S	If flag is on, symbol hunks are written to the object file.
		This is handy when used with symbolic debuggers.
		Default: Off


	Example:

	OPT S,P+,B-

	Write symbol hunks, Optimize Absolute long -> pc-relative, Disable
	Auto-forcing of (BD,An).


    o	Reg	    Define register list
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Symbol	REG <reg-list>

	REG directive specifies register list used by movem instruction.
	List may contain symbolic register name defined by equr.
	Symbolic register lists must be defined before used.
	Symbols defined by REG	can be used only with movem instruction.
	<reg-list> may be omitted. If <reg-list> is empty, movem
	instruction, which uses empty list, is not generated.


    o	Section     Start new section
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	SECTION     <name>[,<type>[,<mem type>]]

	Start new section. Name of the section is set to <name>.
	Type of the section is one of these:
	CODE	CODE_C	CODE_F
	DATA	DATA_C	DATA_F
	BSS	BSS_C	BSS_F

	_C extension specifies mem type (C=CHIP, F=FAST).

	<mem type> specifies the type of the memory where hunk should be
	loaded. It can be specified with <type> field by extension or with
	separate third argument which is CHIP or FAST.

    o	Set	    Define SET value
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	<Symbol>    SET <number>

	With SET you can define symbol which value can be changed
	arbitrarily later on. You can 'equ' set symbol but then it becomes
	absolute symbol which cannot be changed anymore.


    o	xdef	    Export symbol
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	XDEF	    <symbol>[,<symbol>[,<symbol>...]]

	Define external symbol. Defines symbol value to be visible to other
	modules. (Export).

    o	xref	    Import symbol
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	XREF	<symbol>[,<symbol>[,<symbol>...]]

	External reference to symbol. Defines label to be imported from
	other modules.



    3.6 Data types
    ~~~~~~~~~~~~~~
    Supported data types.

    Note that not at all data types are supported by all instructions.

    Directives which support:
    DC.n
    DCB.n
    DS.n
    EQU.n (all integers are 32 bit values and they are  defined without
	   suffix).

    n is one of these.				   size
    ~~~~~~~~~~~~~~~~~				   ~~~~
    b = byte					 ( 1 byte )
    w = word					 ( 2 bytes)
    l = long word				 ( 4 bytes)
    s = single precision floating point number	 ( 4 bytes)
    d = double precision floating point number	 ( 8 bytes)
    x = extended precision floating point number (12 bytes)
    p = packed floating point number		 (12 bytes)
	Used K-factor is 17 with packed type.


    3.7 Things to note
    ~~~~~~~~~~~~~~~~~~

    There are few things to note when using SNMA (especially if you
    have used other assemblers).

    3.7.1 About Bcc
    ~~~~~~~~~~~~~~~

    When using Bcc instruction with EXTERNAL DEFINED label without
    providing specified size, it is treated as Bcc.l instruction. This
    differs from the a68k which don't allow long sizes at all in Bcc
    (020+ feature). So, when doing above use .w size specifier (bsr.w
    for example) or disable 020+ code generation with cpu directive
    (CPU M68000 will disable long branches).

    Currently, if symbol is xref'ed, bsr.l to the other module is not
    handled correctly. Symbol is handled like 'jsr address.l'  and
    relocation information assumes absolute long addressing mode
    instead pc-relative with bsr.l.


    3.7.2 The Check of the data sizes
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    SNMA checks that specified data fits where it is set.
    For example, if you have instruction move.w  #100000,d0 SNMA tells
    you that value won't fit to word. SNMA does signed value checks.

    Remember that when using NOT (~) operation all 32 bits are affected,
    not only parts of it.

    Range check can be annoying if you are using NOTs with bit masks
    and other sizes than long word. (Hint: you can mask values with
    AND). The check of the ranges of the SNMA has revealed some bugs
    (value too big to fit in byte) which passed unnoticed when using
    a68k, so I think it is useful feature.

    3.8 Error Messages
    ~~~~~~~~~~~~~~~~~~

    The error messages of the SNMA are quite self-explaining. Error may be
    "DEAD END" error which means that assembling cannot be continued.
    Object file is NOT produced if there is even one error. There are
    couple of warnings also, but they are...well, just warnings.
    Grammar of the error messages is quite awful, by the way, but I hope
    you get an idea what caused error.


    4.	Author
    ~~~~~~~~~~

	INTERNET: snuojua@cc.helsinki.fi

	mail:	Samu Nuojua
		Harustie 8 B 15
		00980 Helsinki
		FINLAND

	Bug reports welcome (fixed bug better bug).