***************************************************************************** * Example Macros V1.00 ©1994 The Puzzle Factory, Inc. * * This macro file may be freely redistributed as long as this * * copyright notice is not removed. * * * * The contents of this file is provided without warrantee of any kind * * and the entire responsibility for use is assumed by the end user. * ***************************************************************************** ;>>> PLEASE READ THIS FILE BEFORE USING THE RS.MACROS FILE <<< ; ;This file contains a number of example macros which you may use to do useful ;things, to learn more about your Amiga, or to better understand haw to write ;your own ReSource macros. ; ;IMPORTANT NOTE IMPORTANT NOTE ;It is not possible to provide standard macros that may be freely used in all ;situations with a tool such as ReSource. Because the macro itself can't ;know what sort of code or data it is being used on, it it up to the user to ;ensure that it will be used with some degree of intelligence. The following ;example will, perhaps, illustrate the problem. ; ;Suppose that there exists in your code, a NewWindow structure. After ;disassembly, but before using the "NewWindow" macro, it looks like this: ; ;lbL000A54 dl 0 ; dl $12D0077 ; dl $FFFF0000 ; dl $2200002 ; dw $140E ; dl lbL000A84 ; dw 0 ; dw 0 ; dl MyTitle.MSG ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 1 ; ;After using the "NewWindow" macro, it looks like this: ; ;lbW000A54 dw 0,0,301,119 ; db $FF,$FF ; dl (IDCMP_GADGETDOWN|IDCMP_CLOSEWINDOW) ; dl (WFLG_DRAGBAR|WFLG_DEPTHGADGET|WFLG_CLOSEGADGET|WFLG_SMART_REFRESH|WFLG_GIMMEZEROZERO|WFLG_ACTIVATE|WFLG_NOCAREREFRESH) ; dl lbL000A84 ; dl 0 ; dl MyTitle.MSG ; dl 0 ; dl 0 ; dw 0,0,0,0 ; dw WBENCHSCREEN ; ;This is all well and good, and you are, hopefully, happy with the result. ; ;But suppose that in this particular program the programmer decided to access ;some variables in the NewWindow structure, and the C compiler that produced ;the executable put labels in the middle of structure fields, rather than ;using offsets from the structure beginning (this actually happens quite ;frequently). Now the disassembled, but unstructured data will look like ;this: ; ;lbW000A54 dw 0 ;lbW000A56 dw 0 ;nw_TopEdge ;lbW000A58 dw $12D ;nw_Width ;lbL000A5A dl $77FFFF ;nw_Height ; dl $220 ; dw 2 ;lbW000A64 dw $140E ;nw_Flags+2 (word) ; dl lbL000A84 ; dw 0 ; dw 0 ; dl MyTitle.MSG ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 0 ; dw 1 ; ;And after using the "NewWindow" macro, it looks like this: ; ;lbW000A54 dw 0 ;lbW000A56 dw 0 ;nw_TopEdge ;lbW000A58 dw $12D ;nw_Width ;lbL000A5A dl $77FFFF ;nw_Height ; db 0,0 ; dl (IDCMP_NEWSIZE|IDCMP_VANILLAKEY|IDCMP_CHANGEWINDOW) ;lbW000A64 dw (WFLG_DRAGBAR|WFLG_SIZEBRIGHT|WFLG_SMART_REFRESH|WFLG_BACKDROP|WFLG_REPORTMOUSE|WFLG_GIMMEZEROZERO|WFLG_NOCAREREFRESH|WFLG_NW_EXTENDED|WFLG_WINDOWTICKED|WFLG_ZOOMED|$80000) ; dl lbL000A84 ; dw 0 ; dw 0 ; dl MyTitle.MSG ; dw 0 ; dw 0,0,0,0 ; dw 0 ; dw 0 ; dw 0 ; dw 1 ; ;As you can see, the addition of the labels into the middle of this data, ;caused the macro to completely mess up the NewWindow structure. Depending ;on your assembler, this may still assemble correctly, but I wouldn't count ;on it. About the only thing one can do in a case like this is to not use ;the macro, or to write a very long and very complicated macro that attempts ;to be all things to all programs. What should really happen is to change ;the assembly source so that, after finishing the disassembly, so that ;"lbW000A64" for example, is referenced as "lbW000A62+2", or better, as ;"_NewWindow+nw_Flags+2". ; ;Because of these problems, it is very important to cast a discerning eye at ;any code or data you plan on converting with a ReSource macro. ; ;WHY NOT JUST IMPROVE RESOURCE MACROS? ;Macros were not ever intended to be used for this purpose. ReSource Macros ;were intended to be used to do simple repetitive tasks. ReSource Command ;Language (RCL) was intended for tasks where complex decisions are needed to ;be made about the code being disassembled. We have plans to release a ;variety of RCL scripts in the future. Stay tuned for announcements. ; ; ---------------/--------------- ;NOTES ;All the macros in this file that operate on structures, place a blank line ;at the beginning of the structure, and none at the end. This is an important ;consideration because otherwise it is possible that multiple blank lines will ;be inserted between structures. ; ;Each macro comes with instructions on its use. Please read these in order ;to know what assumptions are present in the macro so that you may get good ;use from them. ; ;TPF ;Set tabs: | | | | | | ifd __m68 CAPE set 1 ENDC ifd CAPE bnryonly endc dc.l $BABEF00F ; ReSource macros identifier dc.l 0 ; number of words of user data following dc.b ' - General Macros - ' ; User-defined name #1. dc.b ' - Intuition Macros - ' ; User-defined name #2. dc.b '- Miscellaneous Macros -' ; User-defined name #3. ************************************************************************ ;Whenever the disassembly shows location 4 (AbsExecBase), use this macro to ;rename it to something more meaningful. This macro only calls a symbol ;base, but you may find it more convenient to just hit KP-1. dc.l 1 ; Macro number 1 dc.l macroend01-macrostart01 macnamestart01 dc.b 'Conv. 4 -> AbsExecBase ' ifgt 24-(*-macnamestart01) dcb.b 24-(*-macnamestart01),0 endc macrostart01 dc.w $0177 ; SYMBOLS/Trap Vectors dc.w 0 ; reserved macroend01: ************************************************************************ ;This macro will search for "jsr_LVO" or "jmp_LVO" and rename the ;preceeding label with the name of the system call preceeded by an underscore. ;So "jsr_LVOOpenWindow" will produce a label named "_OpenWindow". ;This is very useful for those annoying little C language stubs. ;The actual library calls must have already been parsed and named before ;using this macro. This macro works with old syntax. dc.l 2 ; Macro number 2 dc.l macroend02-macrostart02 macnamestart02 dc.b 'SysCalls: Old syntax ' ifgt 24-(*-macnamestart02) dcb.b 24-(*-macnamestart02),0 endc macrostart02 dc.w $0677 ; CURSOR/Pattern search/Set pattern string dc.w (2$-1$) 1$ dc.b 'j(mp|sr) _LVO',0,1 cnop 0,2 2$ dc.w $004E ; CURSOR/Pattern search/Find next occurrence dc.w $020A ; STRINGS/Get/Symbol dc.w $0205 ; STRINGS/Edit functions/Clip start dc.w (4$-3$) 3$ dc.b '_LVO',0,1 cnop 0,2 4$ dc.w $0207 ; STRINGS/Edit functions/Prepend dc.w (6$-5$) 5$ dc.b '_',0,1 cnop 0,2 6$ dc.w $0187 ; CURSOR/Relative/Previous label dc.w $0213 ; STRINGS/Put/Label dc.w $0186 ; CURSOR/Relative/Next label dc.w 0 ; reserved macroend02: ************************************************************************ ;This macro is identical to the one directly above, but works with new syntax. dc.l 3 ; Macro number 3 dc.l macroend03-macrostart03 macnamestart03 dc.b 'SysCalls: New syntax ' ifgt 24-(*-macnamestart03) dcb.b 24-(*-macnamestart03),0 endc macrostart03 dc.w $0677 ; CURSOR/Pattern search/Set pattern string dc.w (2$-1$) 1$ dc.b 'j(mp|sr) ''(_LVO',0,1 cnop 0,2 2$ dc.w $004E ; CURSOR/Pattern search/Find next occurrence dc.w $020A ; STRINGS/Get/Symbol dc.w $0205 ; STRINGS/Edit functions/Clip start dc.w (4$-3$) 3$ dc.b '_LVO',0,1 cnop 0,2 4$ dc.w $0207 ; STRINGS/Edit functions/Prepend dc.w (6$-5$) 5$ dc.b '_',0,1 cnop 0,2 6$ dc.w $0187 ; CURSOR/Relative/Previous label dc.w $0213 ; STRINGS/Put/Label dc.w $0186 ; CURSOR/Relative/Next label dc.w 0 ; reserved macroend03: ************************************************************************ ;This macro is useful when you have a number of labels in a program that jump ;to the C stubs converted by the 2 macros directly above. Position the line ;with the "JMP" instruction on the cursor line, and execute this macro. ;The label on the "JMP" line will be converted to "