H y p e r C

A Hypertext C Source Code Browser






by

Nobuya Higashiyama





Version 1.1

April, 1990 Release









































Copyright (C) Nobuya Higashiyama 1990.
All rights reserved.


Disclaimer and License

YOUR FIRST USE OF HYPERC CONSTITUTES AGREEMENT TO THE FOLLOWING
PROVISIONS. IF YOU DO NOT AGREE TO THEM, PLEASE DO NOT USE THIS
PROGRAM!

HyperC is a copyrighted, proprietary program offered "as is",
without any warranty of merchantability or fitness for a
particular purpose, performance, or otherwise; all warranties are
expressly disclaimed. By using HyperC, you agree that the author
will not be liable for any use of (or inability to use) or
performance of this product, or for any damages whatsoever.

Now that we've got the legalise out of the way ...

This software is being distributed as a Freeware. You may use
this program freely. You may also copy and distribute this
program, as long as all the files are distributed intact in a
single archived file. You may not sell this program, and you may
charge only nominal fee for distribution not exceeding $5.00 a
copy.

I would appreciate any bug reports, comments or suggestions.
Please contact me at:

US Mail: Nobuya Higashiyama
642-D Residenz Parkway
Kettering, OH 45429
Phone: (513) 293-9320
CompuServe: 71570,533
Internet: [email protected]
UUCP: ...!uccba!mead!nxh

I hope this tool will be useful for all you C programmers out
there!
















HyperC Page 2 4/24/90








Introduction
------------

HyperC is a hypertext C source code browser. Some of the
features include:

1. Multiple windows that can be moved, stacked, and
resized. Up to 10 windows may be opened at one time.

2. Support for 25/30/43/50 line modes.

3. Ability to link to other source files via function
names, #defined macros and #include statements.

4. Full mouse support.

5. Fully configurable screen color attributes.

6. Regular expression search facility.



System Requirements
-------------------

HyperC requires an IBM PC, XT, AT, PS/2 or compatible computer
with 256K RAM or more. PC/MS-DOS 2.0 or greater is also
required.

HyperC includes support for all display devices. However, you
must have an MCGA card/monitor for 30-line mode, an EGA or VGA
card/monitor for 43-line mode and a VGA card/monitor for 50-line
mode.

HyperC also supports Microsoft-compatible mouse.



Installing HyperC
-----------------

If you have received this program in an archived file format,
simply unpack the archive file into a directory (for our example,
we'll use C:\HYPERC). If you have received this program in a
diskette form, simply copy all files to a desired directory.

An environment variable "HYPERC" must be set to point to this
directory. The easiest way to do this is to insert the following
line in your AUTOEXEC.BAT file:

SET HYPERC=C:\HYPERC (or whatever your directory name is)

Also, you may wish to add HYPERC directory to your PATH variable
list.



HyperC Page 3 4/24/90









Next, HyperC configuration file must be created. This file
should contain a list of directories containing source and header
files which are to be scanned. Using any ASCII editor, create a
file HYPERC.CFG, either in the current directory or the directory
specified by the environment variable HYPERC. List the
directories to be scanned, one directory per line. Here is a
possible example:

c:\myproject\source
c:\myproject\include
c:\msc\include
c:\msc\include\sys

When HyperC is invoked, it first looks for HYPERC.CFG file in the
current directory. If not found, it looks for it in the
directory specified by environment variable HYPERC. If still not
found, it terminates with a diagnostic message. Note that this
allows different configuration file to be set up for each project
directory.



HyperC Files
------------

The following files are used by HyperC:

HYPERC.EXE - This is the program file.

HYPERC.DAT - This file contains setup data for HyperC. This
file should be located in the directory
specified by the environment variable HYPERC.
This file will be created upon the first
invocation of HyperC.

HYPERC.HLP - This is the help file for HyperC. This file
should be located in the directory specified by
the environment variable HYPERC. This file
should be part of the distribution file.

HYPERC.CFG - This file contains the list of directories
which will be scanned by HyperC. This file
should be created before the first invocation
of HyperC.

HYPERC.SI - This file contains directory/file/symbol
information database used by HyperC. This file
is created by HyperC automatically. It will be
located in the same directory as HYPERC.CFG
file from which this database file is created.






HyperC Page 4 4/24/90








Command Line Parameters
-----------------------

HyperC may be invoked without any arguments. You may also supply
a single argument, which should be the name of a file to be
browsed.



Source Code Scan Cycle
----------------------

When HyperC is invoked, it will first display the copyright
legend, and then proceed to scan all ".c" and ".h" files
contained in the current directory, followed by directories
specified in the HYPERC.CFG file. Progress of the scan cycle is
displayed on the status line at the bottom of the screen.

After the first invocation of HyperC, it will from then on scan
only the files that have changed. HyperC uses the file date/time
stamp to determine if a file needs to be re-scanned or not.

Scanner built into HyperC knows about C, so when it attempts to
scan a file which has invalid C syntax (it is especially
sensitive to mismatched braces), it may display a "Parser error"
message. This results in any function definitions contained in
the erroneous file to be ignored.

Due to the fact that the scanner does not perform C preprocessing
function, some C code constructs can cause the parser to fail
even though a C compiler may accept it. Take the following
example:

#ifdef UNIX
{
int var1;
#else
{
long var1;
#endif
...
}

HyperC sees the mismatched braces, and the result will b a
parsing error.












HyperC Page 5 4/24/90








Screen Layout
-------------

The screen is composed of two parts; the status line (displayed
at the bottom of the screen) and the window area. Each window
contains a title area showing the file path; in addition, the
active window (there can be only one active window at one time)
will have a double-line border while inactive windows will have a
single-line border.



Concept of "Stack"
------------------

Source files that are being browsed are organized as a "stack".
That is, the first window to be opened is considered to be the
bottom of the stack, and the last window to be opened is
considered to be the top of the stack. While any window may be
activated for browsing, certain functions can be performed only
to the top window. This includes Close Window and Link.



Browsing
--------

The following keys can be used to browse a source file.

Page Up - Scroll the source file up one window full.

Page Down - Scroll the source file down one window full.

Home - Go to the start of the file.

End - Go to the end of the file.

Up Arrow - Move the cursor up one line. If the cursor
is at the top of the window, the window will
be scrolled down one line.

Down Arrow - Move the cursor down one line. If the cursor
is at the bottom of the window, the window
will be scrolled up one line.

Left Arrow - Move the cursor left one space.

Right Arrow - Move the cursor right one space.

^ Up Arrow - Scroll the window up.

^ Down Arrow - Scroll the window down.





HyperC Page 6 4/24/90








Enter - Move the cursor to the start of the next
line.



Commands
--------

The following commands are available.

File-Related Commands

Open File (Alt-O)

This command is used to open another window.
HyperC will prompt for the name of the source file
to be opened. You may supply a simple file name
or a full pathname.

Exit (Alt-X)

This command is used to exit HyperC.

Stack-Related Commands

Next (Alt-N)

This command is used to make the window just above
the current window active. If the current window
is the top window, this command is ignored.

Previous (Alt-P)

This command is used to make the window just below
the current window active. If the current window
is the bottom window, this command is ignored.

Top (Alt-T)

This command is used to make the top window of the
stack active.

Bottom (Alt-B)

This command is used to make the bottom window of
the stack active.











HyperC Page 7 4/24/90








Window-Related Commands

Move (Alt-M)

This command is used to move the active window.
Use the arrow keys to move the window as desired.
When the window is at the desired position, press
the Escape key.

Resize (Alt-R)

This command is used to resize the active window.
Arrow keys control the position of the right
bottom corner of the window. Use the arrow keys
to resize the window as desired. Note that you
will not be able to shrink the window beyond a
certain set point. When finished, press the
Escape key.

Close (Alt-C)

This command is used to close the active window.
Note that only the top window of the stack may be
closed; if the active window is not the top
window, an error message will be displayed.

Zoom (Alt-Z)

This command causes the active window to be
resized to fill the screen. If the current window
is already at maximum allowed size, this command
is ignored. This command is used to temporarily
zoom a window, and thus only certain operations
are allowed while in Zoom mode. This includes
Exit, Close, Unzoom, Setup, Help, and Search.

Unzoom (Alt-U)

This command causes a zoomed window to be resized
to the original size. This command has no effect
on a window which has not been Zoomed.

Search-Related Commands

Search Forward (Ctrl-F)

This command is used to search forward for a
regular expression in the active window.

Search Backward (Ctrl-B)

This command is used to search backward for a
regular expression in the active window.




HyperC Page 8 4/24/90








Search Again (Ctrl-A)

This command is used to search for the next
occurrence of a regular expression previously
searched via Search Forward or Search Backward
command.

Link-Related Commands

Link (Alt-L)

This command is used to link to another source
file. There are three types of links that are
available in this version of HyperC; a function, a
#defined macro and a #include file.

HyperC looks at the expression pointed by the
cursor in the active window. If it is a function
invocation, it scans the source file database for
a match. If a source file containing definition
for the specified function is found, another
window is opened and the new window becomes
active.

If the cursor line contains a #include statement,
it will attempt to locate the header file
specified by the statement.

You may link to another file only if the top
window is active.

Layout-Related Commands

2-Window Horizontal Layout (Shift-F1)

This command is used to change the screen layout
so that two windows are displayed, one on top of
another. If more than two windows are currently
being displayed, an error message is displayed.

2-Window Vertical Layout (Shift-F2)

This command is used to change the screen layout
so that two windows are displayed side by side.
If more than two windows are currently being
displayed, an error message is displayed.

3-Window Horizontal Layout (Shift-F3)

This command is used to change the screen layout
so that three windows are displayed, stacked on
top of each other. If more than three windows are
currently being displayed, an error message is
displayed.



HyperC Page 9 4/24/90








3-Window Vertical Layout (Shift-F4)

This command is used to change the screen layout
so that three windows are displayed side by side.
If more than three windows are currently being
displayed, an error message is displayed.

3-Window Horizontal/Vertical Layout (Shift-F5)

This command is used to change the screen layout
so that three windows are displayed, two on top
half of the screen and the third on the bottom.
If more than three windows are currently being
displayed, an error message is displayed.

4-Window Horizontal Layout (Shift-F6)

This command is used to change the screen layout
so that four windows are displayed, stacked on top
of each other. If more than four windows are
currently being displayed, an error message is
displayed.

4-Window Vertical Layout (Shift-F7)

This command is used to change the screen layout
so that four windows are displayed side by side.
If more than four windows are currently being
displayed, an error message is displayed.

4-Window Horizontal/Vertical Layout (Shift-F8)

This command is used to change the screen layout
so that four windows are displayed, two on top
half of the screen and two on the bottom. If more
than four windows are currently being displayed,
an error message is displayed.

Screen-Related Commands

25-Line Mode (Alt-2)

This command is used to set the display to 25-line
mode.

30-Line Mode (Alt-3)

This command is used to set the display to 30-line
mode. This video mode is supported only by MCGA
monitors.







HyperC Page 10 4/24/90








43-Line Mode (Alt-4)

This command is used to set the display to 43-line
mode. This video mode is supported only by EGA
and VGA monitors.

50-Line Mode (Alt-5)

This command is used to set the display to 50-line
mode. This video mode is supported only by VGA
monitors.

Setup-Related Commands

Setup (Alt-S)

This command is used to change the settings for
HyperC. Screen colors and number of lines per
screen can be adjust via this option.

Setup-Related Commands

Help (Alt-H)

This command invokes an on-line help facility.



Menu
----

Main menu can be called up by pressing F1. All the commands
described above are available through menu selections. Selection
bar can be moved via arrow keys, and an item is selected by
pressing the Enter key. Escape key is used to abort out of the
menu. If a particular function is not currently available (for
example, Unzoom function when the current window is not zoomed),
the selection is marked with special screen attribute.



















HyperC Page 11 4/24/90








Mouse Support
-------------

HyperC supports Microsoft-compatible mouse for most operations.
It can be used to scroll the windows, move the cursor, link to
another file, and select menu items.

Placing the mouse cursor anywhere in an inactive window and
clicking the left button causes that window to become active.

Placing the mouse cursor in an active window and clicking the
left button causes the cursor to move to the location of the
mouse cursor. If clicked again, it has the effect of invoking
the Link function. In effect, clicking twice on a function name
(or a #include file name) without moving the mouse will open
another window (as long as that function is located in one of the
scanned files).

Each window has scroll gadgets in the window borders. Placing
the mouse cursor in the gadget and holding down the left button
causes the window to scroll in the indicated direction.

Also, placing the mouse cursor on the upper left corner of the
border and clicking the left button closes the window. Only the
top window can be closed.

Clicking the right button causes the main menu to be displayed.
To select an item, place the mouse cursor on the desired item and
click the left button twice. In order to abort from a menu,
place the mouse cursor outside the menu and click the left button
once.



Modification History
--------------------

April 25, 1990 - Release of Version 1.1
Numerous bug fixes

April 22, 1990 - Release of Version 1.0
















HyperC Page 12 4/24/90