home *** CD-ROM | disk | FTP | other *** search
/ The Developer Connection…ice Driver Kit for OS/2 3 / DEV3-D1.ISO / devtools / sbl / sbledit.ipf < prev    next >
Encoding:
Information Presentation Facility markup  |  1993-03-31  |  12.8 KB  |  171 lines
  1. :userdoc.
  2. :h1 res=8.Introduction
  3. :i1 id=ix1.Introduction
  4. :sl compact.
  5. :li.
  6. :li.
  7. :font facename='Arial' size=12x8.:hp2.Introduction:ehp2.:font facename=default size=0x0.
  8. :li.
  9. :li.
  10. :font facename='Arial' size=10x6.SblEdit is a text editor that runs under Presentation Manager environment and 
  11. allows you to edit, compile, debug and run SBL modules&per.:font facename=default size=0x0.
  12. :li.
  13. :li.
  14. :font facename='Arial' size=10x6.SblEdit behaves much like the OS/2 System Editor application&per.  This document 
  15. assumes that you are familiar with the System Editor, and does not document the 
  16. text editing capabilities&per.:font facename=default size=0x0.
  17. :li.
  18. :li.
  19. :font facename='Arial' size=10x6.SblEdit includes a built-in Help function to provide a quick reference to the 
  20. SBL language&per.:font facename=default size=0x0.
  21. :li.
  22. :li.
  23. :font facename='Arial' size=10x6.SblEdit has buttons on its main window that can be selected in the standard way 
  24. with the mouse or by holding down the Ctrl key and hitting the letter 
  25. underlined on the button&per.  The Esc key can also be used to Stop program 
  26. execution (in either run or debug mode)&per.:font facename=default size=0x0.
  27. :li.
  28. :li.
  29. :font facename='Arial' size=10x6.SblEdit is a sample program which Softbridge has developed to test SBL&per.  While 
  30. we attempt to make it solid and useful, it is not "product-quality"&per.  We do not 
  31. include source for SblEdit as part of a SBL source license&per.  We include it as 
  32. part of the SBL runtime for the convenience to our customers (and because we 
  33. use it as the basis of our test suite)&per.:font facename=default size=0x0.
  34. :li.
  35. :li.
  36. :li.
  37. :font facename='Arial' size=12x8.:hp2.Edit Mode:ehp2.:font facename=default size=0x0.
  38. :li.
  39. :li.
  40. :font facename='Arial' size=10x6.When editing a program, SBL behaves much like Notepad&per.  There are three buttons 
  41. visible on the screen&colon.  :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.C:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ompile, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.R:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.un and :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.D:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ebug&per.  See below for details on 
  42. Compiling, Running, and Debugging programs&per.:font facename=default size=0x0.
  43. :li.
  44. :li.
  45. :li.
  46. :font facename='Arial' size=12x8.:hp2.Using the Help Facility:ehp2.:font facename=default size=0x0.
  47. :li.
  48. :li.
  49. :font facename='Arial' size=10x6.You can access the help facility by either using the Help menu directly or by 
  50. positioning the edit caret over a keyword and hitting the F1 key&per.  If the F1 
  51. key is used, SblEdit will attempt to find the specified keyword within the SBL 
  52. help document&per.  The SBL help document (including source and make file) is 
  53. included as part of the SBL Runtime License&per.:font facename=default size=0x0.
  54. :li.
  55. :li.
  56. :li.
  57. :font facename='Arial' size=12x8.:hp2.Compiling a Program:ehp2.:font facename=default size=0x0.
  58. :li.
  59. :li.
  60. :font facename='Arial' size=10x6.When in edit mode you can explicitly compile a SBL program, using either the 
  61. button or menu pick&per.  If the current file has not been saved, it will 
  62. automatically be saved before compiling&per.  The autosave feature can be cleared 
  63. by removing the check on the Auto Save and Compile menu pick under Compiler 
  64. Options&per.:font facename=default size=0x0.
  65. :li.
  66. :li.
  67. :font facename='Arial' size=10x6.SblEdit will highlight lines containing warnings and errors&per.  Warnings can be 
  68. ignored by clearing the check on the Report Warnings menu pick under Compiler 
  69. Options&per.  If there are warnings or errors, two additional buttons (:font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.N:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ext Error 
  70. and :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.P:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.rev Error) will be displayed which allow you to step over the errors&per.:font facename=default size=0x0.
  71. :li.
  72. :li.
  73. :li.
  74. :font facename='Arial' size=12x8.:hp2.Running a Program:ehp2.:font facename=default size=0x0.
  75. :li.
  76. :li.
  77. :font facename='Arial' size=10x6.When you ask SblEdit to run a module (through either a Run or Debug request) 
  78. SblEdit will automatically compile the program if necessary&per.  Next, SblEdit 
  79. will look for a :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp2.Sub Main:ehp2.:font facename=default size=0x0.:font facename='Arial' size=10x6.&per.  If there is no :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp2.Sub Main:ehp2.:font facename=default size=0x0.:font facename='Arial' size=10x6. in the module, SblEdit will 
  80. report an error&per.  Note that this is not required by SBL itself; this is just 
  81. the way SblEdit makes use of SBL&per.:font facename=default size=0x0.
  82. :li.
  83. :li.
  84. :font facename='Arial' size=10x6.When running a program, SblEdit will display a single button&colon. Stop&per.  This 
  85. button can be hit using the mouse, or you may use the Esc key&per.  If you hit this 
  86. button, you will enter Debug mode&per.:font facename=default size=0x0.
  87. :li.
  88. :li.
  89. :font facename='Arial' size=10x6.If a :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp2.Stop:ehp2.:font facename=default size=0x0.:font facename='Arial' size=10x6. statement is executed, an :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp2.Assert:ehp2.:font facename=default size=0x0.:font facename='Arial' size=10x6. statement fails, or an untrapped 
  90. error occurs within the running program, the program will stop executing, and 
  91. SblEdit will enter debug mode&per.:font facename=default size=0x0.
  92. :li.
  93. :li.
  94. :li.
  95. :font facename='Arial' size=12x8.:hp2.Debugging a Program:ehp2.:font facename=default size=0x0.
  96. :li.
  97. :li.
  98. :font facename='Arial' size=10x6.When you are in debugging mode, the SblEdit button bar displays buttons for 
  99. Step :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.I:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.nto, Step :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.O:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ver, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.C:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ontinue, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.B:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.reakpoint, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.E:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.xit, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.V:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ars, :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.A:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.nimate, and Ca:font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.l:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ls&per.  
  100. The line of code which will execute next is displayed with foreground and 
  101. background colors reversed (white on black)&per.  :font facename=default size=0x0.
  102. :li.
  103. :li.
  104. :font facename='Arial' size=10x6.SblEdit provides a wide variety of debugging capabilities, all of which are 
  105. implemented using the standard SBL API&per.  Two kinds of single step are included&colon. 
  106. Step :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.I:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.nto, which steps into called procedures and Step :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.O:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ver, which steps over 
  107. called procedures&per.  The :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.C:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ontinue button switches SblEdit back to running mode&per.  :font facename=default size=0x0.
  108. :li.
  109. :li.
  110. :font facename='Arial' size=10x6.Breakpoints can be set on any executable line of code&per.  To set a breakpoint 
  111. with the mouse double-click on the line; to clear the breakpoint, double-click 
  112. the mouse again&per.  To set (or clear) a breakpoint with the keyboard, move the 
  113. caret to the desired line and hit the Breakpoint button (Ctrl-B or use the 
  114. mouse)&per.  Finally, the F9 key can set and clear breakpoints&per.  Breakpoints are 
  115. indicated by a red highlight&per.  :font facename=default size=0x0.
  116. :li.
  117. :li.
  118. :font facename='Arial' size=10x6.The :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.E:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.xit button halts execution of the program being edited and returns you to 
  119. edit mode&per.:font facename=default size=0x0.
  120. :li.
  121. :li.
  122. :font facename='Arial' size=10x6.The :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.V:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ars button controls the display of the Variables window&per.  It acts as a 
  123. toggle, causing the window to appear and disappear&per.  SblEdit allows you to 
  124. select which variables should be displayed by using the ":font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.V:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ariables to 
  125. Display&per.&per.&per." option under the :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.O:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ptions menu pick&per.  The Variables window will be 
  126. updated after each statement is executed during single step or animate modes&per.:font facename=default size=0x0.
  127. :li.
  128. :li.
  129. :font facename='Arial' size=10x6.The :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.A:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.nimate button causes SblEdit to execute the program, and to automatically 
  130. highlight each line of code before it is executed&per.  The speed of execution can 
  131. be controlled by the ":font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.S:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.peed of Animated Run" option under the :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.O:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.ptions menu pick&per.:font facename=default size=0x0.
  132. :li.
  133. :li.
  134. :font facename='Arial' size=10x6.The :font facename=default size=0x0.:font facename='Arial' size=10x6.:hp5.C:ehp5.:font facename=default size=0x0.:font facename='Arial' size=10x6.alls button controls the display of the Calls window&per.  It acts as a 
  135. toggle, causing the window to appear and disappear&per.  The Calls window displays 
  136. the call frame stack of the currently nested procedures&per.  The most 
  137. deeply-nested procedure is listed at the top of the window&per.  If you click on a 
  138. procedure with the mouse, SblEdit will switch the focus to the main display 
  139. window, and highlight the next statement to be executed in the selected 
  140. procedure&per.:font facename=default size=0x0.
  141. :li.
  142. :li.
  143. :li.
  144. :font facename='Arial' size=12x8.:hp2.Options:ehp2.:font facename=default size=0x0.
  145. :li.
  146. :li.
  147. :font facename='Arial' size=10x6.The editor options are reasonably self-evident, and are not covered here&per.  :font facename=default size=0x0.
  148. :li.
  149. :li.
  150. :font facename='Arial' size=10x6.The Compiler Option "Dump After Compile" causes SblEdit to create a text dump 
  151. of the &per.SBX file after compilation of each program&per.  The text dump file will 
  152. have an extension of &per.SBM&per.  This is mostly of interest when trouble-shooting 
  153. compiler bugs, or when considering optimizations, and so will most likely be 
  154. only of marginal interest&per.:font facename=default size=0x0.
  155. :li.
  156. :li.
  157. :font facename='Arial' size=10x6.The other Compiler Options are documented above&per.:font facename=default size=0x0.
  158. :li.
  159. :li.
  160. :font facename='Arial' size=10x6.You can use the Runtime Option "Modify Command$ &per.&per.&per." to specify the value which 
  161. SBL will return when the Command$ function is called&per. Selecting  "Clear All 
  162. Breakpoints" will clear all the breakpoints in the current module&per.  When "Print 
  163. to sbledit&per.log" is checked, all print statements will print to file sbledit&per.log 
  164. as well as to the status bar&per.  :font facename=default size=0x0.
  165. :li.
  166. :li.
  167. :font facename='Arial' size=10x6.The other Runtime Options are documented above&per.:font facename=default size=0x0.
  168. :li.
  169. :esl.
  170. :euserdoc.
  171.