| 1 |
578 |
markom |
<HTML>
|
| 2 |
|
|
<HEAD>
|
| 3 |
|
|
<TITLE>Function Browser Help</TITLE>
|
| 4 |
|
|
</HEAD>
|
| 5 |
|
|
<BODY>
|
| 6 |
|
|
<CENTER><H1>The Function Browser</H1></CENTER>
|
| 7 |
|
|
<BR>The Function Browser may be used to search for specific functions
|
| 8 |
|
|
in the executable, allowing the user to easily browse through source
|
| 9 |
|
|
code and set and clear breakpoints at anywhere in the executable
|
| 10 |
|
|
with ease.
|
| 11 |
|
|
|
| 12 |
|
|
<H3><A HREF="#display">Function Browser Display</A></H3>
|
| 13 |
|
|
<UL>
|
| 14 |
|
|
<LI><A HREF="#display_search">Searching for a Function</A>
|
| 15 |
|
|
<LI><A HREF="#display_limit">Limiting the Search</A>
|
| 16 |
|
|
<LI><A HREF="#display_break">Toggling Breakpoints</A>
|
| 17 |
|
|
<LI><A HREF="#display_source">Viewing Source Code</A>
|
| 18 |
|
|
</UL></P>
|
| 19 |
|
|
|
| 20 |
|
|
<H2><A NAME="display">Function Browser Display</A></H2>
|
| 21 |
|
|
The Function Browser display shows all the current search
|
| 22 |
|
|
parameters specified by the user: search type, search expression,
|
| 23 |
|
|
and files to search.
|
| 24 |
|
|
|
| 25 |
|
|
<H4><A NAME="display_search">Searching for a Function</A></H4>
|
| 26 |
|
|
To search for a function, enter
|
| 27 |
|
|
the name of the function into the "Search for" field at the top
|
| 28 |
|
|
of the Function Browser and press the Enter key on the keyboard
|
| 29 |
|
|
or press the Search button in the lower right-hand corner. The
|
| 30 |
|
|
Function Browser searches through every file contained in the
|
| 31 |
|
|
executable (including libraries and included files) for the
|
| 32 |
|
|
specified function. If the function is found in the executable's
|
| 33 |
|
|
symbol table, the Functions listing will contain the function's
|
| 34 |
|
|
name.
|
| 35 |
|
|
|
| 36 |
|
|
<H4><A NAME="display_limit">Limiting the Search</A></H4>
|
| 37 |
|
|
Searches are not confined to one specific function. The Function
|
| 38 |
|
|
Browser is capable of searching for any function which matches
|
| 39 |
|
|
the expression entered into the "Search for" field. For example,
|
| 40 |
|
|
to list all functions which start with the letters c, y, and g,
|
| 41 |
|
|
enter "cyg" into the search field and press enter. Every function
|
| 42 |
|
|
which begins with these three letters is displayed. To search
|
| 43 |
|
|
for all functions which do <I>not</I> begin with the letters "a",
|
| 44 |
|
|
"b", and "c", enter the regular expression "^[^a-c]" into the search
|
| 45 |
|
|
field, click the "Use regular expression" checkbox, and then click
|
| 46 |
|
|
Search (or press the Enter key on the keyboard). The Browser returns
|
| 47 |
|
|
the names of all matching functions.
|
| 48 |
|
|
|
| 49 |
|
|
<P>Additionally, any search may be limited in two more ways:
|
| 50 |
|
|
the Browser may be configured to search only specified files and
|
| 51 |
|
|
list only static functions.</P>
|
| 52 |
|
|
|
| 53 |
|
|
<P>To search specific files only, select the files to be searched
|
| 54 |
|
|
using the Files list. To select all files for searching, click the
|
| 55 |
|
|
Select All button at the bottom of the Files listing. Note that
|
| 56 |
|
|
the Select All button changes to Select None, allowing the user to
|
| 57 |
|
|
deselect all selected files. With no files selected, the Browser
|
| 58 |
|
|
will search all files in the project.</P>
|
| 59 |
|
|
|
| 60 |
|
|
<P>To search for static functions only, click the "Only show
|
| 61 |
|
|
functions declared 'static'" before searching.</P>
|
| 62 |
|
|
|
| 63 |
|
|
<H4><A NAME="display_break">Toggling Breakpoints</A></H4>
|
| 64 |
|
|
There are numerous ways to toggle
|
| 65 |
|
|
breakpoints on functions using the Function Browser. To toggle the
|
| 66 |
|
|
breakpoint at all listed matches in the Functions list, press the
|
| 67 |
|
|
Toggle Breakpoint button. To toggle a breakpoint at some subset
|
| 68 |
|
|
of functions listed in the Functions list, click the right mouse
|
| 69 |
|
|
button on each function's name in the list. The last way to toggle
|
| 70 |
|
|
breakpoints using the function browser involves viewing the function's
|
| 71 |
|
|
source code.
|
| 72 |
|
|
|
| 73 |
|
|
<H4><A NAME="display_source">Viewing Source Code</A></H4>
|
| 74 |
|
|
To view the source code for a function,
|
| 75 |
|
|
select the function in the Functions list and click the "View Source"
|
| 76 |
|
|
dropdown (if it is not already dropped down). A Source Viewer
|
| 77 |
|
|
similar to the <A HREF="source.html#display">Source Window Display</A>
|
| 78 |
|
|
appears at the bottom. Toggle breakpoints as described in
|
| 79 |
|
|
<A HREF="source.html#setting_a_breakpoint">Setting a Breakpoint</A>
|
| 80 |
|
|
in <A HREF="source.html">Source Window Help</A>.
|
| 81 |
|
|
</BODY>
|
| 82 |
|
|
</HTML>
|
