home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR36 / KEXX.ZIP / BROWSE.DOC next >
Text File  |  1992-12-29  |  4KB  |  114 lines
  1.                BROWSE.KEX Version 2.1 - December, 1992
  2.  
  3. Description:
  4.  
  5. BROWSE.KEX makes it easy to locate symbol definitions and references in
  6. your C source files.  It finds definitions and references via the
  7. browser libraries (.BSC files) created by the PWBRMAKE utility
  8. distributed with Microsoft C version 6.0 or Microsoft C/C++ 7.0.
  9.  
  10. BROWSE is similar to the older CTAGS, but has two important advantages:
  11.  
  12. 1) It works on variables, macros, and types in addition to functions.
  13. 2) It finds all references to a symbol in addition to the definition.
  14.  
  15. The disadvantage is that it works only with the Microsoft C compilers,
  16. and not with other vendor's compilers. (Note that only C programs are
  17. supported, and not C++ programs.)
  18.  
  19. Prerequisites:
  20.  
  21. - KEDIT 5.00 or later.
  22.  
  23. - The RUNCMD, POP, PUSH, and PRGLINES macros (all distributed as part
  24.   of this package in the \COMMON subdirectory) must be in your KEDIT
  25.   macropath.
  26.  
  27. - BROWSE.EXE must be in your path. This is a family mode
  28.   application that will run under either DOS or OS/2.
  29.  
  30.   NOTE: Because Microsoft changed the format of their browser
  31.   libraries for C/C++ 7.0, different BROWSE.EXE programs are supplied.
  32.   One for each version of the compiler: BROWSE.EXE is for C/C++ 7.0,
  33.   and BROWSE6.EXE, which must be renamed to BROWSE.EXE before you use it,
  34.   is for C 6.0.
  35.  
  36. - BROWSE.KEX must be run from the directory containing your source
  37.   files.
  38.  
  39. - Only one .BSC file can be in your current directory.  Alternately you
  40.   can set the BROWSEFILE editv variable as described below.
  41.  
  42. Using BROWSE:
  43.  
  44. (Remember that only C programs are supported, and not C++ programs.)
  45.  
  46. Add the following three commands to your KEDIT profile:
  47.  
  48.     'define ctrl-d "macro browse -d"'
  49.     'define ctrl-r "macro browse -r"'
  50.     'define ctrl-b "macro browse -b"'
  51.  
  52. Then rerun your profile.  If you've created a .BSC file as described
  53. below, you can now press one of the following keys:
  54.  
  55.     ctrl-d  to list all definitions of the symbol at the cursor position
  56.     ctrl-r  to list all references to the symbol at the cursor position
  57.     ctrl-b  to back up to the point at which BROWSE was last started
  58.  
  59. Note: the ctrl-r definition overrides the default ctrl-r definition.
  60.       You can, of course, use another key instead of ctrl-r if you
  61.       prefer.
  62.  
  63. Each time you invoke BROWSE to find either symbol references or
  64. definitions in your source files, the macro creates a new BROWSE
  65. level. Each level uses a number of EDITV variables and POINT settings
  66. to remember the filenames and the lines that contain references (or
  67. definitions) to a particular symbol.
  68.  
  69. Backing up a level (BROWSE -B) removes the EDITV variables and line
  70. names associated with the top browse level, and tries to return you to
  71. the location you were at prior to issuing the latest BROWSE command.
  72. This makes it easy to look up the definition of a variable or
  73. procedure, and later return to the place you were editing -- knowing
  74. more about whatever it was that you just looked up.
  75.  
  76. Keep in mind though, that each level requires some of your PC's memory
  77. to hold the information associated with it. Repeated BROWSEs without
  78. backups may continue to fill up memory until no more can be done until
  79. you do some backups.
  80.  
  81. Creating .BSC files:
  82.  
  83. BROWSE uses the .BSC files created by the PWBRMAKE utility distributed
  84. with Microsoft C 6.0 or C/C++ 7.0.  Two steps, both typically handled
  85. by NMAKE files, are involved in setting up a .BSC file:
  86.  
  87. 1) Always use the /FR options when you compile (this creates the .SBR
  88.    files that PWBRMAKE uses as input).  For example,
  89.  
  90.  cl /c /FR mainrtn.c
  91.  cl /c /FR subrtn.c
  92.  
  93. 2) Issue the BSCMAKE command (if you are using C/C++ 7.0; with C 6.0,
  94.    the command is PWBRMAKE) after compiling all your source files. A good
  95.    time to do this is right after you run LINK. For example,
  96.  
  97.   link mainrtn+subrtn, myprog;
  98.   bscmake /o myprog *.sbr
  99.  
  100. Setting the BROWSEFILE editv variable:
  101.  
  102. If you have multiple .BSC files in your current directory, you have to
  103. tell BROWSE.KEX which one to use by setting the BROWSEFILE editv
  104. variable.  For example,
  105.  
  106.  EDITV SET BROWSEFILE other.bsc
  107.  
  108. Feedback:
  109.  
  110.    Questions, suggestions, comments, bug reports, etc. are welcome.
  111.    Feel free to leave messages regarding BROWSE on the Mansfield
  112.    Software Group BBS (203-429-3784), or section 2 of the PCVENA forum
  113.    on CompuServe.
  114.