home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / TMTBL.LHA / debugger / RIDebugLib.doc < prev   
Encoding:
Text File  |  1995-01-15  |  5.8 KB  |  150 lines
  1. -----------------------------------------------------------------------------
  2. ====                   RI Debug Library V1.21 (C)1994/5                  ====
  3. -----------------------------------------------------------------------------
  4.  
  5.                         Written By Stephen McNamara
  6.                        ©1994/5 Leading Edge Software
  7.  
  8.  
  9. This library is an extension for the Blitz Basic runtime error debugger by
  10. Leading Edge Software.  It allows your program to give the debugger a set
  11. of simple instructions that are invaluable whilst debugging a program.  They
  12. can only be used in conjunction with version 1.9+ of Blitz Basic 2, and the
  13. updated Acid library debug.obj.
  14.  
  15. You should note that these commands can *ONLY* be used in amiga mode since
  16. they require the debugger to immediately respond to them.  When in Blitz
  17. mode, multitasking is disabled so the debugger is unable to react to the
  18. commands.  When compiling, Blitz will tell you if you try and use the
  19. commands in Blitz mode.
  20.  
  21. Additional commands in this library require the related update of the
  22. debugger.  Currently this libraries version number is 1.21, you should have
  23. a debugger version greater than or equal to this number.
  24.  
  25.  
  26. A note about variable tracing
  27. -----------------------------
  28.  
  29. Variable tracing is only performed whilst the debugger is either single
  30. stepping a blitz program, or TRACING a program.  When a program is running
  31. on its own, no update of any windows in the debugger is performed.
  32.  
  33. Command list:
  34.                AddvarTrace variable,variable$,display_mode
  35.                DelVarTrace variable$
  36.                VarTraceWindow
  37.                DisAsmWindow
  38.  
  39. New commands:
  40.                CopperTrace address[,offset]
  41.  
  42. New commands (V1.21):
  43.         ProcControl On/OFf
  44.  
  45.  
  46. Statement : AddVarTrace
  47. ------------------------------------------------------------------------------
  48. Modes  : Amiga
  49. Syntax : AddVarTrace var,variable$,display_mode
  50.  
  51. This command adds a variable trace to the debuggers list of traces.  The
  52. parameter 'var' is the actual variable to add to the list, variable$ is the
  53. name which will be printed in the variable window in the debugger (usually
  54. the same as the variable name) and display_mode is the prefered output mode
  55. for the variables value.
  56.  
  57. The string variable$ will be displayed inside the variable trace window.
  58. This will normally be the name of your variable, but on occasion you might
  59. want some extra info with the name.  In these cases, you can make the
  60. variable$ anything you like, for example "a (counter)" means that we're
  61. tracing variable a but we want to remember that is being used as a counter
  62. inside the program.
  63.  
  64. The output mode can take the following values, depending of course on the
  65. type of variable:
  66.  
  67. Bytes/Words/Longs:        0=nocare (default output will be selected)
  68.                           1=decimal
  69.                           2=hexadecimal
  70.                           3=binary
  71.  
  72. Quicks/Floats:            0=nocare
  73.                           1=decimal
  74.  
  75. Strings:                  0=nocare (defaults to no length/maxlen data)
  76.                           1=no length/maxlen data
  77.                           2=length/maxlen data displayed
  78.  
  79. The command will automatically work out the 'type' of your variable and
  80. ensure that the proper output mode is selected.
  81.  
  82. You should note that you can add the same variable more than once if you
  83. like.  This will be useful if you want to display a variables value in more
  84. than output mode.  For example, you could display the byte sized variable
  85. MYVAR in both decimal and hexadecimal by 'adding' it twice.
  86.  
  87.  
  88. Statement : DelVarTrace
  89. ------------------------------------------------------------------------------
  90. Modes  : Amiga
  91. Syntax : DelVarTrace variable$
  92.  
  93. This command instructs the debugger to remove a variable, identified by the
  94. string variable$, from its trace list.  The debugger will look for the name
  95. variable$ and delete *ALL* occurences of this name from the list.  If you
  96. added the variable trace with a different name from the actual name of the
  97. variable, you must ensure that the variable$ matchs that which you used to
  98. add the variable.
  99.  
  100.  
  101. Statement : VarTraceWindow
  102. ------------------------------------------------------------------------------
  103. Modes  : Amiga
  104. Syntax : VarTraceWindow
  105.  
  106. This command instructs the debugger to open its variable trace window.
  107. This can save the bother of going to the debugger separately and opening
  108. the window yourself.
  109.  
  110.  
  111. Statement : DisAsmWindow
  112. ------------------------------------------------------------------------------
  113. Modes  : Amiga
  114. Syntax : DisAsmWindow
  115.  
  116. This command instructs the debugger to open its disassembly window.  The
  117. disassembly window will open at the address of the command following
  118. DisAsmWindow.  This can be helpful in cases like statements/functions that
  119. are totally assembly since you cannot evaluate the address of a label thats
  120. inside a statement/function.
  121.  
  122.  
  123. Statement : CopperTrace
  124. ------------------------------------------------------------------------------
  125. Modes  : Amiga
  126. Syntax : CopperTrace address[,offset]
  127.  
  128. This command instructs the debugger to open its copper window.  If the
  129. offset parameter is passed with the command, the library assumes that
  130. 'address' points to a coplist object (e.g. address=addr coplist(0)), it
  131. then adds the offset and takes the longword at that address as the start
  132. position for the window.  Thus, if you wanted to open the copper window
  133. right at the start of coplist 0 you'd do:
  134.  
  135.         CopperTrace Addr Coplist(0),4
  136.  
  137. See the coplist object in the debugger for more information about offsets.
  138.  
  139.  
  140. Statement : ProcControl
  141. ------------------------------------------------------------------------------
  142. Modes  : Amiga
  143. Syntax : ProcControl On/Off
  144.  
  145.   This command allows you to switch the debuggers procedure control on or
  146. off.  If on, the debugger will not step/trace inside of statements and
  147. functions.  Instead it will execute them as single commands.
  148.   This command is actually the same as toggling the gadget on the debugger
  149. screen.
  150.