home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / RiscOS / APP / DEVS / LIB / BREAKP.ZIP / BreakPt / BreakPHlp next >
Text File  |  1996-07-06  |  3KB  |  90 lines
  1.                                    BreakPt
  2.                                 Thomas Leonard
  3.  
  4. Needs RISCOS 3
  5. 2.01 (06-Jul-1996)
  6.  
  7. Brief
  8. ~~~~~
  9. This is a programmer's utility which intercepts calls to the SWI OS_BreakPt.
  10. It offers several advantages over the standard call:
  11.  
  12.  Å Logging of as many calls as memory allows
  13.  Å Log displayed in a window on the desktop
  14.  Å Log can be saved to disk
  15.  Å BreakPt can be set to:
  16.      Always quit your program when called (like the standard call)
  17.      Always return control to your program when called
  18.      Return a definable number of times, then quit
  19.  
  20.  
  21. Conditions
  22. ~~~~~~~~~~
  23. This program is FREEWARE, so you can copy it and pass it around as much as
  24. you like.
  25.  
  26. There is no warranty, but please report any bugs you find (it's been very
  27. reliable while I've been using it).
  28.  
  29.  
  30. How to use it
  31. ~~~~~~~~~~~~~
  32. Put BreakPt in your startup sequence along with the other wimp tasks (ie
  33. load it after the desktop - it's not a proper module task).
  34.  
  35. Now when you call OS_BreakPt your program will quit without displaying the
  36. usual message, but upon returning to the desktop a window will open showing
  37. the register dump. The first line shows regs R0 to R7 from left to right, the
  38. second shows R8-R15. The NCV and Z flags, if set, are shown by letters beside
  39. the log entry.
  40.  
  41. You can change the way BreakPt returns using a star command:
  42.  
  43.   *BreakPt_ExitAfter <number>
  44.  
  45. Where <number> is zero to always return (never call OS_Exit), one to always
  46. call OS_Exit or any other positive number for the number of calls which can
  47. be made before BreakPt calls OS_Exit.
  48.  
  49. You can put this in your boot sequence too!
  50.  
  51. BreakPt has three other star commands:
  52.  
  53.   *BreakPt_Open                     Opens the log window
  54.   *BreakPt_Close                    Closes the log window
  55.   *BreakPt_Clear                    Clears the log, freeing all memory used
  56.   *BreakPt_Save  <pathname>         Dumps the whole log as a text file
  57.  
  58. If you click select or adjust over the log window, it does *BreakV_Click.
  59. You can use Set Alias$BreakV_Click to make BreakPt close, save or clear its
  60. log.
  61.  
  62. Only call OS_BreakPt from user mode.
  63.  
  64. If you click menu over the log BreakPt brings up its menu, which may be
  65. quicker than using the star commands.
  66.  
  67. History
  68. ~~~~~~~
  69. Changes from version 1.00
  70.   The buffer size no longer has to be specified on loading the module, but
  71.   claims memory as needed.
  72.   Regs R4-R7 and R8-R11 are shaded to make it easier to find the right reg.
  73.   R15 flags CVN and Z are now shown as letters beside the log entry.
  74.   Removed menus in favour of calling star commands.
  75. Changes from version 2.00
  76.   Put menu back in so you don't need to use Director.
  77.  
  78. How to improve it
  79. ~~~~~~~~~~~~~~~~~
  80. Write to me with suggestions, bug reports, praise, money, or just to tell
  81. me that you use the module and didn't find any bugs.
  82.  
  83. BBS :        Tal at Furzefield Hq
  84.                      01494 681711
  85.  
  86. Mail:              Thomas Leonard
  87.                  48 Copthall Lane
  88.                Chalfont St. Peter
  89.                             Bucks
  90.                           SL9 ODJ