home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / skeleton.zip / Skeleton.pkg < prev    next >
Text File  |  1995-08-03  |  5KB  |  109 lines
  1. Title: REXX Skeleton Service Provider v1.0
  2.  
  3. Keywords: OS/2 REXX SKELETON TRAP ERROR HANDLER DEBUG TRACE
  4.  
  5. Author: Bob Rice - CompuServe: 72421,3916
  6.  
  7. Copyright: Copyright (c) 1995 Empirical Heuristics
  8.  
  9.  
  10. Abstract:
  11.  
  12. Extremely simple to use, the REXX Skeleton provides: display
  13. or extraction of embedded help code, automatic external
  14. function registration, automatic initialization of useful
  15. "global" variables, automatic trapping of REXX execution
  16. time events and errors with dump file generation containing
  17. variables and queues, and debug assistance.  Needs only the
  18. standard OS/2 REXX but has more function with REXXLIB.
  19. Great for beginning REXX programmers as well as more
  20. advanced programmers.  This is Zero-cost Shareware uploaded
  21. by the author, Bob Rice.  r4
  22.  
  23.  
  24. Description:
  25.  
  26. Skeleton provides these features and services:
  27.  
  28. *  Display of embedded help code at several levels:
  29.    +  Brief abstract and syntax only
  30.    +  The above with description of syntax and inclusion of usage
  31.       notes
  32.    +  The above with the addition of technical information
  33.  
  34. *  Extraction of embedded help code to a file (possibly for later use
  35.    in the construction of a compendium of all your REXX programs).
  36.  
  37. *  Automatic initialization of several "global" variables with values
  38.    specific to the particular program being run and the environment
  39.    in which it is running.  These may be used by your program to
  40.    simplify your own code.
  41.  
  42. *  Automatic external function registration.
  43.  
  44. *  Automatic trapping of REXX execution time events and errors:
  45.    +  Events include error, failure, halt, novalue, and certain
  46.       syntax errors
  47.    +  Organized display of event information including the:
  48.       -  name of the program experiencing the event or error
  49.       -  type of event or error
  50.       -  REXX interpreter error code
  51.       -  description of the error code
  52.       -  name of the dump file generated as a result of the event
  53.       -  source line responsible for the event or error
  54.       -  optional elaboration of the error code description
  55.    +  Generation of a dump file showing:
  56.       -  an optionally sorted list of the names and values of all
  57.          variables visible to the program at the time of the event
  58.       -  the contents of the current data queue, and the SESSION
  59.          queue as well, if they are not the same
  60.    +  Automatic display of the dump file and the program file with:
  61.       -  Automatic positioning of the editor cursor on the source
  62.          line causing the error in the program file
  63.       -  Ability to specify your favorite file editor and file viewer
  64.  
  65. *  Debug assistance:
  66.    +  Sensitivity to the value of the TRACE environment variable or
  67.       the /TRACE parameter to provide code tracing without having to
  68.       edit the program.
  69.    +  Sensitivity to the value of the DEBUG environment variable or
  70.       the /DEBUG parameter to provide a "global" debug flag which you
  71.       can use to selectively execute portions of your code.
  72.    +  A handy debug procedure to dump all or selected variables and
  73.       their values to a file for examination when problems arise.
  74.  
  75.  
  76. Availability:
  77.  
  78.   CompuServe: PCVENA forum library 11 (Quercus Systems)     as Skeleton.zip
  79.   CompuServe: OS2DF1 forum library  6 (REXX/Other Language) as Skeleton.zip
  80.  
  81. $Revision:   1.0  $
  82.     $Date:   03 Aug 1995 20:11:30  $
  83.      $Log:   Q:/rxdv/skeleton/vcs/skeleton.pk!  $
  84.  
  85.    Rev 1.0   03 Aug 1995 20:11:30
  86. Initial revision.
  87. _______________________________________________________________________________
  88.  
  89. Files:
  90.  
  91. ; The main Skeleton code:
  92.   Skeleton .cmd  ; The basis for the whole package.
  93.   SkelTest .cmd  ; Test case to demonstrate some of the Skeleton features.
  94.   Skeleton .doc  ; Documentation for the package.
  95.   Skeleton .pkg  ; Packaging information for this package.
  96.  
  97. ; Error handler support files:
  98.   ErhTrap  .cmd  ; Provides organized error display and processing.
  99.   ErhEdit  .cmd  ; Allows user to specify favorite editor.
  100.   ErhView  .cmd  ; Allows user to specify favorite file viewer.
  101.  
  102. ; General purpose programming utilities used by the Skeleton:
  103.   AskUser  .cmd  ; Prompts user for single key responses.
  104.   Exist    .cmd  ; Check for the existence of files and/or directories.
  105.   FuncReg  .cmd  ; Registers external REXX function libraries.
  106.   QueCmd   .cmd  ; Places OS/2 command output in the REXX data queue.
  107.   QueDump  .cmd  ; Captures the REXX data queue in a file.
  108.   TellHelp .cmd  ; Provides embedded help text display and extraction.
  109.