home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / hyprco.zip / HYPRCODE.HLP (.txt) < prev    next >
OS/2 Help File  |  1994-10-08  |  19KB  |  411 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Overview ΓòÉΓòÉΓòÉ
  3.  
  4. How many times have you been in this situation? 
  5.  
  6. There is a foot-thick program listing sitting ominously on your desk, post-it 
  7. notes sticking out everywhere.  Within the next 24 hours (and you'll probably 
  8. use most of them) you have to: 1) Figure out why it isn't working correctly. 2) 
  9. Come up with a solution. 3) Verify the solution with a user in order to ensure 
  10. that it will meet their needs. 4) Implement and test the fix. 
  11.  
  12. All of the time-consuming tasks listed above and more can be accomplished more 
  13. quickly and effectively by quickly getting to the heart of the code. 
  14.  
  15. CASEy COBOL HyperCode is a unique utility program that transforms any COBOL 
  16. program into a HyperText-linked OS/2 information file. 
  17.  
  18. This provides systems development organizations with a number of benefits, it: 
  19.  
  20. o Dramatically reduces the amount of time required in the discovery phase of 
  21.   system maintenance. 
  22. o Brings new programmers up to speed quickly by allowing them to view examples 
  23.   of standardized code.  The popup definitions can be used to clarify obscure 
  24.   programming commands and/or conventions. 
  25. o Provides programmers with the ability to more quickly (and thoroughly) desk 
  26.   check programs before intensive testing. 
  27. o Utilizes an organization's data dictionary to create a popup definition (in 
  28.   the HyperCode file) for each program variable or command. 
  29. o Acquaints systems professionals with the advantages of using the PC as an 
  30.   analysis tool.  This can open the door to utilizing many of the exceedingly 
  31.   powerful applications including PC compilers, CASE tools and client-server 
  32.   database applications.  HyperCode is a small, but potentially very useful 
  33.   step in this direction. 
  34.  
  35. Related Information: 
  36.  
  37. o Menu Options 
  38. o HyperCode Document Structure 
  39. o Example Session/Utilities 
  40. o Registration! 
  41.  
  42.  
  43. ΓòÉΓòÉΓòÉ 2. Menu options ΓòÉΓòÉΓòÉ
  44.  
  45. This section contains descriptions of the functions provided by the HyperCode 
  46. menus. 
  47.  
  48. Menu options: 
  49.  
  50. o File Menu Options 
  51. o Edit Menu Options 
  52. o Run Menu Options 
  53.  
  54. Related Information: 
  55.  
  56. o Overview 
  57. o HyperCode Document Structure 
  58. o Example Session/Utilities 
  59. o Registration! 
  60.  
  61.  
  62. ΓòÉΓòÉΓòÉ 2.1. File ΓòÉΓòÉΓòÉ
  63.  
  64. The File menu presents options for selecting which files to operate upon. 
  65.  
  66. Related Information: 
  67.  
  68. o Select COBOL Program 
  69. o Select Popup Definition File 
  70. o OS/2 Shell 
  71. o Exit 
  72.  
  73.  
  74. ΓòÉΓòÉΓòÉ 2.1.1. Select COBOL Program ΓòÉΓòÉΓòÉ
  75.  
  76. The File|Select COBOL Program option presents a file dialog box from which the 
  77. user can select a program to process with HyperCode.  The default extension is 
  78. .CBL but this can be overtyped if necessary. 
  79.  
  80.  
  81. ΓòÉΓòÉΓòÉ 2.1.2. Select Popup Definition File ΓòÉΓòÉΓòÉ
  82.  
  83. The File|Select Popup Definition File option presents a file dialog box from 
  84. which the user can select a file to be used to build popup definitions within 
  85. the HyperCode generated file.  This is not required in order to execute 
  86. HyperCode. 
  87.  
  88. The format for a popup definition file is as follows: 
  89.  
  90. $D$Label1 
  91. Definition Text Lines... 
  92. Definition Text Lines... 
  93. Definition Text Lines... 
  94. Definition Text Lines... 
  95. $D$Label2 
  96. Definition Text Lines... 
  97. Definition Text Lines... 
  98. Definition Text Lines... 
  99. Definition Text Lines... 
  100. Definition Text Lines... 
  101.  
  102. Each label is prefixed with a $D$ tag and the definition is placed on the 
  103. following lines until the next $D$ tag is encountered.  The text preceding the 
  104. first $D$ tag is ignored. Each occurrence of the text of the label in the code 
  105. is hyperlinked to the definition.  The only thing that will pre-empt a popup 
  106. definition hyperlink is a link to an identifier declaration. In this case, the 
  107. popup will be located within the declaration. 
  108.  
  109.  
  110. ΓòÉΓòÉΓòÉ 2.1.3. OS/2 Shell ΓòÉΓòÉΓòÉ
  111.  
  112. The File|OS/2 Shell option starts an OS/2 window session from which you can 
  113. manipulate files, execute programs, etc... 
  114.  
  115.  
  116. ΓòÉΓòÉΓòÉ 2.1.4. Exit ΓòÉΓòÉΓòÉ
  117.  
  118. The File|Exit option ends the current HyperCode session. 
  119.  
  120.  
  121. ΓòÉΓòÉΓòÉ 2.2. Edit ΓòÉΓòÉΓòÉ
  122.  
  123. The Edit menu contains selections for allowing the user to invoke an editor on 
  124. selected files. 
  125.  
  126. Related Information: 
  127.  
  128. o Edit COBOL Program 
  129. o Edit Popup Definition File 
  130.  
  131.  
  132. ΓòÉΓòÉΓòÉ 2.2.1. Edit COBOL Program ΓòÉΓòÉΓòÉ
  133.  
  134. The Edit|Edit COBOL Program option starts the user specified editor, loading 
  135. the currently selected COBOL program.  If no program is selected, the editor is 
  136. started without opening a file. 
  137.  
  138.  
  139. ΓòÉΓòÉΓòÉ 2.2.2. Edit Popup Definition File ΓòÉΓòÉΓòÉ
  140.  
  141. The Edit|Edit Popup Definition File option starts the user specified editor, 
  142. loading the currently selected popup definition file. If no file is selected, 
  143. the editor is started without opening a file. 
  144.  
  145.  
  146. ΓòÉΓòÉΓòÉ 2.3. Run ΓòÉΓòÉΓòÉ
  147.  
  148. The Run menu contains selections for allowing the user to select options or 
  149. execute HyperCode functions. 
  150.  
  151. Related Information: 
  152.  
  153. o Set Options 
  154. o Build IPF File 
  155. o Execute IPF Compiler 
  156. o View HyperCode Program 
  157.  
  158.  
  159. ΓòÉΓòÉΓòÉ 2.3.1. Set Options ΓòÉΓòÉΓòÉ
  160.  
  161. The Run|Set Options option brings up a dialog box that allows the user to 
  162. select various program options, including the program to use when editing 
  163. files. 
  164.  
  165. The Editor Program field allows the user to change the default editor used by 
  166. the Edit|Edit COBOL Program option and the Edit|Edit Popup Definition File 
  167. option.  The default editor installed by HyperCode is E.EXE, the OS/2 system 
  168. editor. 
  169.  
  170. The Copybook Search Path field allows the user to set the directory HyperCode 
  171. uses to look for a copybook file when it is not found in the same directory as 
  172. the program source code. 
  173.  
  174. The Max. Structure Chart Level spin button allows the user to select the 
  175. maximum level (depth) to generate structure charts for procedure division 
  176. paragraphs/sections.  The level is adjustable from 0 to 100 by using the up or 
  177. down arrows on the spin button or by typing a value directly in the field. 
  178. Most of the time, a 4-6 level structure chart is sufficient.  This keeps each 
  179. individual paragraph/section's structure chart relatively simple and you can go 
  180. deeper into the structure by going to a lower-level item (from the structure 
  181. chart) and bringing up the lower-level item's structure chart. 
  182.  
  183. The Keep expanded COBOL checkbox allows the user to tell HyperCode whether or 
  184. not to delete the expanded COBOL source code used by its parser.  You may wish 
  185. to use this expanded file with another application or editor.  The program 
  186. default installed by HyperCode is unchecked. 
  187.  
  188.  
  189. ΓòÉΓòÉΓòÉ 2.3.2. Build IPF File ΓòÉΓòÉΓòÉ
  190.  
  191. The Run|Build IPF File option invokes the HyperCode parser and creates an .IPF 
  192. source code file from the currently selected COBOL program.  If no program is 
  193. selected, an error message is displayed. 
  194.  
  195.  
  196. ΓòÉΓòÉΓòÉ 2.3.3. Execute IPF Compiler ΓòÉΓòÉΓòÉ
  197.  
  198. The Run|Execute IPF Compiler option invokes the OS/2 IPF compiler for a user 
  199. selected .IPF  file, this generates a .INF file which can be viewed using the 
  200. OS/2 VIEW utility. 
  201.  
  202.  
  203. ΓòÉΓòÉΓòÉ 2.3.4. View HyperCode Program ΓòÉΓòÉΓòÉ
  204.  
  205. The Run|View HyperCode Program option invokes the OS/2 VIEW utility for a user 
  206. selected .INF file, this is where the analysis of the program is done.  For 
  207. help on using the Information Presentation Facility, see the online help for 
  208. VIEW. 
  209.  
  210.  
  211. ΓòÉΓòÉΓòÉ 3. HyperCode Document Structure ΓòÉΓòÉΓòÉ
  212.  
  213. The HyperCode IPF document Table of Contents is divided into four main entries 
  214. representing the divisions of a COBOL program (IDENTIFICATION, ENVIRONMENT, 
  215. DATA, PROCEDURE).  These divisions can be expanded to show the sections that 
  216. are contained within them by clicking on the plus (+) sign in front of the 
  217. division name.  Likewise, the sections can be expanded to show any paragraphs, 
  218. "01" levels, FD, SD entries contained within them.  This provides a thumbnail 
  219. sketch of the high-level components of the program.  When an item is expanded, 
  220. the plus sign changes to a minus sign.  Expanded items can be contracted by 
  221. clicking on the minus sign. 
  222.  
  223. Every item in the Table of Contents can be double-clicked on to reveal the 
  224. actual source code contained within that item.  HyperCode also places hypertext 
  225. links on certain items to allow you to quickly pull up information on that item 
  226. or jump to its declaration within the program. 
  227.  
  228. If you use a popup definition file, any reference to a popup definition item in 
  229. the program text will be highlighted and the popup definition will appear in a 
  230. window when the highlight is double-clicked on. This allows you to include 
  231. definitions from a data dictionary or explanations of obscure programming 
  232. commands. 
  233.  
  234. In the procedure division, all references to data items are highlighted and 
  235. contain hypertext links to the "01" level in which they were declared.  This 
  236. allows you to quickly jump back to working storage in order to look at formats, 
  237. value statements, redefines etc...  If the data name is referenced with an "OF" 
  238. qualification, it is ignored, however the "OF" name will be linked and data 
  239. references take you back to the top of the "01" anyway.  The wide variety of 
  240. navigation and search functions built into the Information Presentation 
  241. Facility allow you to quickly find needed information. 
  242.  
  243. In the procedure division, all references (PERFORMs, GO TOs, etc...) to 
  244. paragraphs and/or sections are highlighted and contain hypertext links to the 
  245. actual paragraph/section in the document.  This allows you to quickly follow 
  246. program execution paths even when the paragraphs are hundreds of lines apart. 
  247.  
  248. Each section in the HyperCode document contains an editor icon that can be 
  249. double-clicked on in order to start the OS/2 Enhanced Editor and bring up the 
  250. appropriate source file, locating the cursor at the position where the section 
  251. begins.  This function locates the cursor at the source code line where the 
  252. section started at the time when the HyperCode document was generated.  If 
  253. lines are added or removed, the cursor will not be located exactly where the 
  254. section starts. In addition, all sections in the procedure division contain a 
  255. structure icon  which can be double-clicked on in order to bring up a footnote 
  256. window that contains a textual procedure structure chart.  The entries in the 
  257. structure chart can also be double-clicked on in order to jump to that section 
  258. in the document.  When all of these features are combined, the HyperCode 
  259. document becomes a very powerful analysis tool. 
  260.  
  261. Related Information: 
  262.  
  263. o Overview 
  264. o Menu Options 
  265. o Example Session/Utilities 
  266. o Registration! 
  267.  
  268.  
  269. ΓòÉΓòÉΓòÉ 4. Example Session/Utilities ΓòÉΓòÉΓòÉ
  270.  
  271. o 1. The fist step in creating a HyperCode document for a COBOL program is to 
  272.   download the program source code, as well as any copybooks that the program 
  273.   uses.  This task is aided by the HyperCode GETCOPY utility.  This program 
  274.   simplifies the process of downloading all copybooks for a COBOL program.  The 
  275.   command line for the GETCOPY utility is GETCOPY COBOLFile CommandFile where 
  276.   COBOLFile is a COBOL program and CommandFile is a .CMD or .BAT file that will 
  277.   be created.  This file will contain one line for each copybook in the 
  278.   program.  The format for the line is CALL DOWNLOAD Copybook.  This file can 
  279.   then be used in conjunction with a .CMD or .BAT file named DOWNLOAD that you 
  280.   create that will download a specified source member from your host.  An 
  281.   example DOWNLOAD.CMD file that we use is listed below. 
  282.  
  283.    DOWNLOAD.CMD - Your version will vary 
  284.    ------------- 
  285.    RCV 'CASEYDEV.CBL.COPYLIB(%1)' C:\SOURCE\%1.CPY ASCII CRLF 
  286.  
  287. In this release of HyperCode, all copybooks used by a program must have a .CPY 
  288. extension and must reside in the same directory as the COBOL program or in the 
  289. copybook search path specified using the Run|HyperCode Options menu option. 
  290.  
  291. o 2. The next step in building a HyperCode document is to specify the COBOL 
  292.   program to use with the File|Select COBOL Program menu option. 
  293.  
  294.  
  295. o 3. (Optional) After specifying the COBOL program to use, you may wish to 
  296.   create a Popup Definition File and select it using the File|Select Popup 
  297.   Definition File menu option. 
  298.  
  299.  
  300. o 4. The HyperCode parser is then executed using the Run|Build IPF File menu 
  301.   option.  This produces a .IPF source code file that can be compiled using the 
  302.   .IPF compiler to generate the HyperCode document. 
  303.  
  304.  
  305. o 5. The .IPF compiler can be executed using the Run|Execute IPF Compiler menu 
  306.   option.  This translates the .IPF file into a HyperCode document. 
  307.  
  308.  
  309. o 6. The HyperCode document can be viewed using the Run|View HyperCode Program 
  310.   menu option.  For information on the structure of the HyperCode document, see 
  311.   HyperCode Document Structure. 
  312.  
  313.  
  314. o 7. The COBOL program source code can be modified directly from the HyperCode 
  315.   document using the editor icon located at the beginning of each section in 
  316.   the document. 
  317.  
  318. Related Information: 
  319.  
  320. o Overview 
  321. o Menu Options 
  322. o HyperCode Document Structure 
  323. o Registration! 
  324.  
  325.  
  326. ΓòÉΓòÉΓòÉ 5. Registration! ΓòÉΓòÉΓòÉ
  327.  
  328.  
  329.    <<<<<<<<<< Print using Services|Print >>>>>>>>>> 
  330. =============================================================== 
  331.      CASEY HyperCode Registration and Order Form 
  332. =============================================================== 
  333.  
  334.  Name:____________________________  Company:________________ 
  335.  
  336.  Address:___________________________________________________ 
  337.  
  338.  City:______________________________________________________ 
  339.  
  340.  State/Province:________________  ZIP/Postal code:__________ 
  341.  
  342.  Country:_______________________  Telephone:________________ 
  343.  
  344. ================================================================ 
  345.         PRODUCT          QUANTITY  TOTAL 
  346.  
  347.  CASEy HyperCode Registration...$20 
  348.                         _____  _______ 
  349.  
  350.  
  351.  CASEy HyperCode Commercial 
  352.   (5 licenses)............................$59 
  353.                         _____  _______ 
  354.  
  355.  CASEy HyperCode Commercial Value Pack 
  356.   (site license, unlimited use)..$149 
  357.                         _____  _______ 
  358.  
  359.           TOTAL --------------------->_______ 
  360.  
  361. ------------------------------------------------------------ 
  362.   Disk size:   [ ] 5.25" 360k,  [ ] 3.5" 720k 
  363.   Compuserve File Transfer [ ] User ID: ______________ 
  364. =============================================================== 
  365.  
  366.   Mail this form w/check or money order to: 
  367.  
  368.      CASEy Software 
  369.      P.O. Box 934 
  370.      West Chester, OH 45071 
  371.  
  372. =============================================================== 
  373.  THANK YOU FOR YOUR ORDER, AND THANK YOU FOR REGISTERING. 
  374. =============================================================== 
  375.  
  376.  
  377. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  378.  
  379. The period of time spent looking at a program in order to determine how it is 
  380. structured and intended to operate 
  381.  
  382.  
  383. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  384.  
  385. CASEy Software is a publisher of value-added applications for use with CASE 
  386. tools, Re-Engineering and Legacy System Maintenance applications. Comments or 
  387. questions can be directed to CASEy software at Compuserve user id # 72274,1630 
  388. or write to: 
  389.  
  390.  CASEy Software 
  391.  P.O. Box 934 
  392.  West Chester, OH 
  393.  45071 
  394.  
  395.  
  396. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  397.  
  398. OS/2 is a trademark of thr IBM Corporation.  IPF, VIEW, EPM and E are 
  399. components of the OS/2 operating system. 
  400.  
  401.  
  402. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  403.  
  404. A repository containing descriptions of data elements used within an 
  405. organization. 
  406.  
  407.  
  408. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  409.  
  410. The Information Presentation Facility or IPF is the help engine for the OS/2 
  411. operating system.