home *** CD-ROM | disk | FTP | other *** search
/ Amiga ACS 1998 #6 / amigaacscoverdisc1998-061998.iso / games / descent / source / lib / psmacros.inc < prev    next >
Text File  |  1998-06-08  |  9KB  |  386 lines
  1. ;THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
  2. ;SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
  3. ;END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
  4. ;ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
  5. ;IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
  6. ;SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
  7. ;FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
  8. ;CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  9. ;AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
  10. ;COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  11. ;
  12. ; $Source: f:/miner/source/includes/rcs/psmacros.inc $
  13. ; $Revision: 1.12 $
  14. ; $Author: matt $
  15. ; $Date: 1994/12/06 14:32:19 $
  16. ;
  17. ; Useful macros.  Everyone should use these.
  18. ;
  19. ; $Log: psmacros.inc $
  20. ; Revision 1.12  1994/12/06  14:32:19  matt
  21. ; Made mprintf turn off if NMONO set
  22. ; 
  23. ; Revision 1.11  1994/11/27  23:18:19  matt
  24. ; Made mprintf go away when debugging turned off
  25. ; 
  26. ; Revision 1.10  1994/03/25  18:00:34  matt
  27. ; Added imulc of 6
  28. ; 
  29. ; Revision 1.9  1994/02/10  18:00:58  matt
  30. ; Changed 'if DEBUG_ON' to 'ifndef NDEBUG'
  31. ; 
  32. ; Revision 1.8  1993/11/22  23:47:06  matt
  33. ; debug macros were trashing eax
  34. ; 
  35. ; Revision 1.7  1993/11/04  12:39:25  mike
  36. ; Modify imulc macro to support fast multiply by 36
  37. ; and multiply anything using imul, but give warning.
  38. ; 
  39. ; Revision 1.6  1993/10/19  21:17:31  matt
  40. ; Added abs_eax macro
  41. ; 
  42. ; Revision 1.5  1993/09/26  22:28:21  matt
  43. ; Removed extra register pushes in mprintf
  44. ; Make DEBUG_ON all uppercase since we seem to have case sensitivity on
  45. ; 
  46. ; Revision 1.4  1993/09/26  19:22:30  matt
  47. ; Added imulc macro, to multiply a register by a constant.  It does not
  48. ; at this time support arbitrary constants, only 0,1,3,5,9, and powers of 2
  49. ; 
  50. ; Revision 1.3  1993/09/13  11:50:57  matt
  51. ; Added 'b' & 'w', aliases for 'byte ptr' and 'word ptr'
  52. ; 
  53. ; Revision 1.2  1993/09/03  19:00:03  matt
  54. ; Added breakpoint macros
  55. ; 
  56. ; Revision 1.1  1993/08/24  12:51:52  matt
  57. ; Initial revision
  58. ; 
  59. ;
  60. ;
  61.  
  62. ;Shortcuts for casting
  63.  
  64. w equ word ptr
  65. b equ byte ptr
  66.  
  67.  
  68. ;The macros @ArgCount() & @ArgRev() are from the file MACROS.INC, provided 
  69. ;with MASM.  I have included them here because MACROS.INC has bugs, so I 
  70. ;couldn't just include it.
  71.  
  72. ; Utility Macros - Version 1.0 - for Microsoft Macro Assembler 6.0
  73. ; (C) Copyright Microsoft Corporation, 1987,1988,1989,1990
  74.  
  75. ;* @ArgCount - Macro function returns the number of arguments in a
  76. ;* VARARG list.
  77. ;*
  78. ;* Params:  arglist - arguments to be counted
  79.  
  80. @ArgCount MACRO arglist:VARARG
  81.     LOCAL count
  82.     count = 0
  83.     FOR arg, <arglist>
  84.     count = count + 1
  85.     ENDM
  86.     EXITM %count
  87. ENDM
  88.  
  89. ;* @ArgRev - Macro function returns a reversed order version of a
  90. ;* VARARG list.
  91. ;*
  92. ;* Shows:   Operators           - <>         !        %
  93. ;*          String directive    - SUBSTR
  94. ;*          Predefined function - @SizeStr
  95. ;*
  96. ;* Params:  arglist - arguments to be reversed
  97.  
  98. @ArgRev MACRO arglist:vararg
  99.     LOCAL txt, arg
  100.     txt TEXTEQU <>
  101. %   FOR arg, <arglist>
  102.     txt CATSTR <arg>, <!,>, txt
  103.     ENDM
  104.  
  105.     txt SUBSTR  txt, 1, @SizeStr( %txt ) - 1
  106.     txt CATSTR  <!<>, txt, <!>>
  107.     EXITM txt
  108. ENDM
  109.  
  110. ;These macros are used for decalaring external vars and functions
  111.  
  112. ;this macro is used to declare several symbols of the same type
  113. ;usage is:  extdef  type,sym0,sym1,...
  114. extdef  macro   type,syms:vararg
  115.     for     sym,<syms>
  116.      externdef sym:type
  117.     endm
  118.     endm
  119.  
  120. ;this macro is used to generate ext<type> macros 
  121. extgen  macro   type,id
  122. ext&id  macro   syms:vararg
  123.     extdef  type,syms
  124.     endm
  125.     endm
  126.  
  127. ;macros for common types, such as word (extw), byte (extb), & near (extn)
  128.  
  129.     extgen  word,w
  130.     extgen  byte,b
  131.     extgen  dword,d
  132.     extgen  near,n
  133.  
  134.  
  135. ;compute the absolute value of eax.  afterwards, edx=sign (0 or -1)
  136. abs_eax macro
  137.     cdq
  138.     xor     eax,edx
  139.     sub     eax,edx
  140.     endm
  141.  
  142. ;PUSHM & POPM are used for multiple registers.  Note that POPM pops in the
  143. ;reverse order from PUSHM, so the list of regs shouls be the same for both.
  144. ;You can also define a constant which is a register list, and use it as the
  145. ;argument to both macros.
  146.  
  147. ;push multiple registers
  148. pushm   macro   args:vararg
  149.     local   arg
  150.     for     arg,<args>
  151.      push   arg
  152.     endm
  153.     endm
  154.  
  155. ;pop multiple registers
  156. popm    macro   args:vararg
  157.     local   arg
  158. %       for     arg,@ArgRev(args)
  159.      pop    arg
  160.     endm
  161.     endm
  162.  
  163. ;PUSHLONG pushes a long, zero extending the argument if necessary
  164. ;it trashes no registers
  165. pushlong        macro   arg
  166.     local   s
  167. s = TYPE arg
  168.     if      s EQ 0  ;constant, I think
  169.      push   arg
  170.     elseif  s LT 4
  171.      push   eax
  172.      movzx  eax,arg
  173.      xchg   eax,[esp]
  174.     else
  175.      push   arg
  176.     endif
  177.  
  178.     endm
  179.  
  180. ;PUSHML is pushm using pushlong
  181. pushml  macro   args:vararg
  182.     local   arg
  183.     for     arg,<args>
  184.      pushlong       arg
  185.     endm
  186.     endm
  187.  
  188.  
  189. ;DBSTR stores a string with occurances of \n converted to newlines
  190. ;this macro expects quotes around the string
  191. ;
  192. ;note the 'fudge' variable.  This fixes an odd problem with the way
  193. ;the string macros deal with backslashes - @InStr() treats them like
  194. ;any other character, but @SubStr() ignores them
  195. dbstr   macro   str
  196.  
  197.     local   pos,oldpos,len,fudge
  198.     oldpos = 2      ;skip initial quote
  199.     fudge = 0
  200.     len = @SizeStr(str)
  201.  
  202.     pos = @InStr(oldpos,str,<\n>)
  203.  
  204.     while   pos GE oldpos
  205.  
  206.      if     pos GT oldpos
  207.       %db   '&@SubStr(<&str>,&oldpos-&fudge,&pos-&oldpos)'
  208.      endif
  209.      db     10
  210.      oldpos = pos+2
  211.      fudge = fudge+1
  212.  
  213.      pos = @InStr(oldpos,<str>,<\n>)
  214.  
  215.     
  216.     endm
  217.     if      oldpos LT len
  218.     
  219. ;;;      %db    '&@SubStr(&str,&oldpos-&fudge,&len-&oldpos-1)'
  220.      %db    '&@SubStr(&str,&oldpos-&fudge,&len-&oldpos)'
  221.     endif
  222.  
  223. endm
  224.  
  225.  
  226. ;MPRINTF is a macro interface to the mprintf funcion.  It puts the format
  227. ;string in the code segment at the current location, pushes the args, and
  228. ;calls mprintf. If window is not specified, zero is assumed
  229. mprintf macro   window:=<0>,format:req,args:vararg
  230.     local   string,skip
  231.     ifndef  NDEBUG
  232.     ifndef  NMONO
  233.     extn    _mprintf_
  234.     jmp     skip
  235. string  label   byte
  236.     dbstr   format
  237.     db      0
  238. skip:
  239.     ifnb    <args>
  240. %        pushml @ArgRev(args)
  241.     endif
  242.     pushml  offset string,window
  243.     call    _mprintf_
  244.     add     esp,(@ArgCount(args)+2)*4       ;fix stack
  245.     endif
  246.     endif
  247.     endm
  248.  
  249.  
  250. ;MPRINTF_AT - version of mprintf with coordinates
  251. mprintf_at      macro   window:=<0>,row,col,format:req,args:vararg
  252.     local   string,skip
  253.     ifndef  NDEBUG
  254.     ifndef  NMONO
  255.     extn    _mprintf_at_
  256.     jmp     skip
  257. string  label   byte
  258.     dbstr   format
  259.     db      0
  260. skip:
  261.     ifnb    <args>
  262. %        pushml @ArgRev(args)
  263.     endif
  264.     pushml  offset string,col,row,window
  265.     call    _mprintf_at_
  266.     add     esp,(@ArgCount(args)+4)*4       ;fix stack
  267.     endif
  268.     endif
  269.     endm
  270.  
  271.  
  272. ;DEBUG calls mprintf with window 0, preserving all registers and flags
  273. ;is is conditionall assembled based on the DEBUG_ON flags
  274. debug   macro   format:req,args:vararg
  275.     ifndef  NDEBUG
  276.      pushf          ;save flags
  277.      push   eax     ;mprintf trashes eax
  278.      mprintf        ,format,args
  279.      pop    eax
  280.      popf
  281.     endif
  282.     endm
  283.  
  284. ;DEBUG_AT - version of debug with coordinates
  285. debug_at        macro   row,col,format:req,args:vararg
  286.     ifndef  NDEBUG
  287.      pushf          ;save flags
  288.      push   eax     ;mprintf trashes eax
  289.      mprintf_at ,row,col,format,args
  290.      pop    eax
  291.      popf
  292.     endif
  293.     endm
  294.  
  295. ;Debugging breakpoint macros
  296.  
  297. ;print a message, and do an int3 to pop into the debugger  
  298. debug_brk       macro   str
  299.     endm;added by KRB also. commented out this macro 
  300.     
  301. ;    ifndef  NDEBUG
  302. ;     debug  str
  303. ;     int    3
  304. ;    endif
  305. ;    endm
  306.  
  307. break_if        macro   cc,str
  308.     endm;Added by KRB - below code doesn't compile..
  309. ;    local   skip,yes_break
  310. ;    ifndef  NDEBUG
  311. ;     j&cc   yes_break
  312. ;     jmp    skip
  313. ;yes_break:       debug_brk str
  314. ;skip:
  315. ;    endif
  316. ;    endm
  317.  
  318. ;returns the bit number of the highest bit
  319. @HighBit        macro   n
  320.     local   t,c
  321.     if      n EQ 0
  322.      exitm  <-1>    ;error!
  323.     else
  324.      t = n
  325.      c = 0
  326.      while  t GT 1
  327.       t = t SHR 1
  328.       c = c+1
  329.      endm
  330.      exitm  <c>
  331.     endif
  332.     endm
  333.  
  334. ;returns the bit number of the lowest bit
  335. @LowBit macro   n
  336.     ;local  t,c
  337.     local   c
  338.     if      n EQ 0
  339.      exitm  <-1>    ;error!
  340.     else
  341.      t = n
  342.      c = 0
  343.      while  (t and 1) EQ 0
  344.       t = t SHR 1
  345.       c = c+1
  346.      endm
  347.      exitm  <c>
  348.     endif
  349.     endm
  350.  
  351.  
  352. ;"multiply" the given register by a constant, using whatever method is
  353. ;best for the given constant
  354. imulc   macro   reg,c
  355.     local   low,high
  356.  
  357.     if      c EQ 0
  358.      xor    reg,reg
  359.     elseif  c EQ 1
  360.     elseif  c EQ 3
  361.      lea    reg,[reg*2+reg]
  362.     elseif  c EQ 5
  363.      lea    reg,[reg*4+reg]
  364.     elseif  c EQ 6
  365.      lea    reg,[reg*2+reg] ;*3
  366.      shl    reg,1   ;*6
  367.     elseif  c EQ 9
  368.      lea    reg,[reg*8+reg]
  369.     elseif  c EQ 36
  370.      lea    reg,[reg*8+reg]
  371.      sal    reg,2
  372.     else
  373.      low = @LowBit(c)
  374.      high = @HighBit(c)
  375.      if     low EQ high
  376.       shl   reg,@LowBit(c)
  377.      else
  378.       imul  reg,c
  379.       echo  Warning: Using imul, to perform multiply by &c
  380.       ;; .err
  381.      endif
  382.     endif
  383.  
  384.     endm
  385.  
  386.