@database PhxMacros.guide @author "Richard Körber" @(c) "1996 Richard Körber - all rights reserved" @$VER: phxmacros.guide V1.3 (21.10.96) [English] @wordwrap @width 80 @Node Main "PhxMacros: Table Of Contents" _ _ _ _ |_)|_ \\/ |\\/| /|/ |_)/\\(_ | | )/\\ | |/-|\\_| \\\\/ _) == TABLE OF CONTENTS == @{" General Notes " link General} @{" Copyright " link Copyright} @{" Meta Instructions " link Meta} @{" Assembler Compatibility " link AsmCompat} @{" Data Definitions " link DataDef} @{" String Operation " link StringOp} @{" Miscellaneous Macros " link Misc} @{" History " link History} © 1996 Richard Körber -- all rights reserved PhxAss is © 1991-96 by Frank Wille @EndNode @Node General "PhxMacros: General Notes" GENERAL NOTES *************** · This macro library REQUIRES some special abilities of PhxAss Version 4.33 or higher, for full functionality. Some macros may cause trouble or produce errors on other assemblers or older PhxAss versions. · The "peek" macro has been renamed to "top" ("peekm" is now called "topm"). The new name is commonly used in the computer world for this purpose. Please fix your sources if you've used this macro. @EndNode @Node Copyright "PhxMacros: Copyright" PhxMacros are © 1996 by Richard Körber. All Rights Reserved. This Macro collection is FreeWare! This archive may be distributed freely as long as the archive remains complete and unchanged. You are allowed to charge a maximum fee of DM 8 (or equivalent) to cover all costs including media. Otherwise written permission from the author is required. The package may be compressed by the usual (and free) programs (like lha, lzh, lzx). Single files of the package must not be compressed! I allow the Fred Fish library and AmiNet to include this package on their CDs. Permission is also granted to Frank Wille to include this package in his PhxAss package. The archive consists of the following files: · PhxMacros.i The macro library · PhxMacros.guide This guide file Usage for fascist or military purposes is FORBIDDEN! You use this package "as is" and at your own risk. The author (Richard Körber) is not responsible for any damage, including (but not limited to) hard- or software damages or data loss. Please delete this archive and all related files *NOW* if you do not agree with these copyright notes. For questions, bug reports, suggestions and all that jazz, please get in contact with me via E-Mail: shred@chessy.aworld.de If this E-Mail address should trouble, you can also try to reach me at: rkoerber@tfh.dssd.sub.org (international) shred@eratosth.dssd.sub.org (Germany only!) PhxAss is © Frank Wille (e.g. AmiNet) AmigaGuide is © Commodore-Amiga. (e.g. Fish Disk #920) @EndNode @Node Meta "PhxMacros: Meta Instructions" META INSTRUCTIONS ******************* Meta instructions (also called Pseudo Commands) behave like real 680x0 instructions, yet they are emulated by a macro. inc.? Increments the by one. Examples: inc.b d0 inc (a0) dec.? Decrements the by one. Examples: dec.b d0 dec (a0) push.? Pushes the to the stack. !!! Only .w or .l allowed !!! Examples: push d0 push.l (4,a0) top.? Read the top entry of the stack, without removing. Examples: peek d0 peek.l (a4) pop.? Pops from the stack. !!! Only .w or .l allowed !!! Examples: pop d0 pop.l (a3) pushm.? Pushes the register set to the stack. !!! Only .w or .l !!! Example: pushm.l d0-d3/a0-a3 topm.? Read the top register set of the stack, without removing. Example: peekm.l d0-d3 popm.? Pops a register set from the stack. !!! Only .w or .l !!! Example: popm.l d0-d3/a0-a3 store Stores the registers d0-d7 and a0-a6 on the stack. recall Restores the registers d0-d7 and a0-a6 from the stack. r Conditional rts. You may use all the standard condition codes. Examples: req rvs bsr.? Conditional branch to subroutine. You may use all the standard condition codes. Branch optimizer works here as usual. Examples: bsreq.b near_eq bsrvs vs_error bsrhi.l far_hi ; 68020+ only flip.? Flips the data register between big endian and little endian. Only .w or .l allowed. Examples: flip.l d0 flip d3 extbl Sign extends the data register from byte to longword. The extb.l instruction will be used by this macro if MACHINE 68020 or higher is set. Example: extbl d0 @EndNode @Node AsmCompat "PhxMacros: Assembler Compatibility" ASSEMBLER COMPATIBILITY ************************* These Macros provide compatibility to other assembler, like Seka, DevPac or AsmOne. Please note that they are obsoleted. Don't use them in new code! align Aligns the address counter to a multiple of . (Seka, DevPac, AsmOne) Example: align 4 ;Align to long word odd Opposite of 'even': aligns to an odd address. (Seka, DevPac, AsmOne) pushem.? Pushes the register set to the stack. !!! Only .w or .l !!! (DevPac) Example: pushm.l d0-d3/a0-a3 popem.? Pops a register set from the stack. !!! Only .w or .l !!! (DevPac) Example: popm.l d0-d3/a0-a3 @EndNode @Node DataDef "PhxMacros: Data Definitions" DATA DEFINITIONS ****************** The following macros will define strings or data in the DATA section. Note that all strings will automatically be 0 terminated. leastr , The string is created in the DATA section. A pointer to this string is provided in the address register . Example: leastr "dos.library",a1 peastr The string is created in the DATA section. A pointer to this string is provided on the stack. This is useful for e.g. taglist construction on stack. Example: peastr "TestWindow" pea WA_Title defstr