home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / basic / tools / readsub / readsub.doc < prev    next >
Text File  |  1992-06-21  |  6KB  |  117 lines
  1. =-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  2.            READSUB - A QuickBasic/ MS Professional Basic Utility
  3. =-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  4.  
  5.                    Version 4    Release Date: 06/22/92
  6.  
  7.  
  8. INTRODUCTION: ReadSub is a utility which parses uncompiled Basic programs
  9.  (source code) written in QuickBasic, Professional Basic and some other
  10.  brands of Basic. It takes every subroutine and function (or just one
  11.  specified sub or function) in the chosen program and creates a separate
  12.  Basic file for each one. The purpose of ReadSub is to enable the Basic
  13.  programmer to use these parsed subroutines and functions from one Basic
  14.  program in others. For those who haven't yet done it, to "import" a
  15.  subroutine or function into an ongoing basic program, name and create
  16.  the subroutine or function, go to that area, and choose ALT/F, then "M"
  17.  (for merge). You'll see a directory of all .bas programs; you'll have
  18.  the option to change directories. When you find the .bas you want to
  19.  load as the routine, highlight it and press Enter: it will be imported
  20.  into that routine's area (at the cursor location). Calling ReadSub
  21.  without command line options will list all Basic source programs in the
  22.  current directory.
  23.  
  24. SHAREWARE / WARRANTY STATEMENT: ReadSub is marketed as shareware. You may
  25.  use the program for up to one month, and if you like it and choose to 
  26.  continue using it, you are legally and ethically required to pay for it.
  27.  The cost to register ReadSub is a miniscule $7, and you'll be able to 
  28.  sleep better at night! Re warranty, there is NO warranty for ReadSub:
  29.  you use this program entirely at your own risk (we gotta say that).
  30.  
  31. INCLUDED FILES: 
  32.            Readsub.exe    The executable program
  33.            Register.frm ReadSub registration form
  34.            Readsub.doc  The documentation you're currently reading
  35.                    Diag.bas     QuickBasic diagnostic source code program
  36.                    Diag.bat     Batch file to run diag.bas
  37.  
  38. USING READSUB: Put Readsub.exe and the basic program (which must have the
  39.  .bas extension) in the same subdirectory. You now have two options:
  40.  
  41.  1) Call readsub by just typing "readsub" (and hit the ENTER key). When
  42.     prompted, enter the name of the Basic program (either with or without
  43.     the .bas extension). You can choose any Basic program listed.
  44.     
  45.  2) Call ReadSub, and include the basic program's name on the command
  46.     line, as (for example):    readsub program.bas
  47.     (The  '.bas' is optional, though the name of the basic program to
  48.     be extracted must end in .bas), as:     readsub program
  49.  
  50.  Each subroutine and function will be extracted into a separate .bas file,
  51.  using the name of the sub or function. If its name is more than eight
  52.  characters, its filename will be the first eight "legal" characters of the
  53.  sub or function. If the sub or function contains a nonvalid filename
  54.  character, the filename will not include that character (unless our
  55.  parser misses that character, in which case the program will terminate,
  56.  but all subs and functions up to that point will still have been saved).
  57.  
  58.  Keep in mind that the subs and functions you extract will most probably
  59.  include constants and variables which were originally defined in the
  60.  program's main module and/or processed by other modules. You'll have to
  61.  take into account the fact that any new Basic program using these
  62.  extracted routines may need to properly define these constants and
  63.  variables.
  64.  
  65. OPTIONS: You may choose to extract ONE subroutine or function from your
  66.  source file. just add a space (or a slash ["/"]) and the name of the sub
  67.  you wish extracted. 
  68.  
  69.         Here's an example command line:  readsub program.bas onesub
  70.  
  71.  The ".bas" extension need not be used, so for most efficient calling,
  72.  this example illustrates:               readsub program onesub
  73.  
  74. CAUTIONS: (1) Be sure the .bas program was saved in ASCII (text) mode.
  75.           (2) It's safest to have readsub.exe in the same directory
  76.               as your source code file, and BE in that directory when
  77.               calling readsub. 
  78.           (3) Although tested on a wide variety of source code, it is
  79.               possible that unique sub or function names could cause
  80.               a problem. If this could be the case, consider changing
  81.               a sub or function name from, e.g., "xf_s*.0@" to, 
  82.               perhaps, "trnsfrmx"
  83.  
  84. MISCELLANEOUS: ReadSub is now "well-behaved" under DesqView or Windows;
  85.  all screen writes use ANSI codes through the PC BIOS (you must have
  86.  ANSI.SYS loaded in your config.sys file).
  87.  
  88. DIAGNOSTICS: Included are two diagnostic files, which need only be used
  89.  if you're having problems running ReadSub. Include these files in the
  90.  same directory as readsub.exe, and run diag.bat by typing "diag". This
  91.  diagnostic program will extract one subroutine, and if successful, then
  92.  extract all subs and functions from diag.bas. If the total extraction
  93.  is also successful, you will be informed, and the extracted files will
  94.  be deleted. If successful, and you're still having problems, attempt
  95.  to run ReadSub on Diag.bas manually, by typing:  readsub diag oops
  96.  (to extract the "oops" sub), and then:  readsub diag   (to extract all
  97.  subs and functions [ 5 of them ] from diag.bas). If these tests are
  98.  successful and you're STILL having a problem, or if these tests are 
  99.  not successful, call our Support BBS for assistance. 
  100.  
  101. SUPPORT: Registered and NON-registered users may receive assistance by
  102.  calling the Suncoast Software Systems support BBS, Suncoast City BBS,
  103.  at 813-953-5505 (12/9600 baud, soon to be 9600 baud v.32/42, 24 hrs).
  104.  Suggestions for improvements are also welcome!
  105.  
  106.  HISTORY:
  107.  
  108.      6/22/92 vers. 4: Major rewrite in (Prof. Basic 7.1)
  109.      9/08/91 vers. 3: Added a couple of new features
  110.      8/24/91 vers. 2: Added single sub/function extraction: debugged
  111.              a couple of nasty ones; added diagnostic utility
  112.      8/02/91 Version 1.1: Sharpened algorithms, added file listing
  113.      7/31/91 Version 1.0: First Release
  114.  
  115.  
  116. =-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  117.