5 FUSE Messages

This chapter provides an alphabetic listing of all available FUSE messages for integrating your tool with FUSE

Refer to the previous chapters for information about EnCASE, its components, how to use each of its components, and reference information for the TIL file syntax and the EnCASE interfaces

When using fixed strings in FUSE messages, both upper and lowercase letters are acceptable. However, if you include in your source file the header file $FUSE_TOP/includes/DFencase.h, which defines the constants used by each message, you can use defined constants instead of string values.

5.1 Message Listing

5.1.1 char AddToFilterList(char target, char *filter_pattern );

Adds a new filter to the current set of diagnostic filters. The Builder receives this message

filter_pattern

Specifies the text of the filter. This can be any regular expression.

Return value

"SUCCESS"

"FAILURE" is returned when the Builder was unable to add the filter.

5.1.2 trigger char Build(char target, char reserved1, char reserved2);

Starts a build. The Builder receives this message.

target

Specifies the full pathname of the target or source file to be built. If the target is a source file with an extension such as .c, .p, and so on, the Builder attempts to build the appropriate .o file.

reserved1 and reserved 2

Reserved for future use and must be specified as NULL.

Return value

Specifies whether the build was successfully started. It can be one of the following values:

"SUCCESS"
"WARNING"

5.1.3 void BuilderFinish(char target, char makefile, char *outputfile, int status);

Sends notification about whether a build process completed. The build process is complete even when errors are discovered. Information about errors is not sent in this message. This notification is sent for builds started interactively from the Builder or from a Build message. Only the Builder can send this message.

target	Specifies the target of attempted build.
makefile	Specifies the full pathname of the makefile used in the build.
outputfile	Specifies the full pathname of the build transcript file, which is usually in the `/tmp` directory.
status	Specifies the status of the build process completion: 0 indicates that the build process completed, even if there were errors in the build. 1 indicates that the build process did not complete. When 1 is returned, it is likely that the build process was abnormally terminated.

5.1.4 char BuilderGetSelection(char reserved1);

Returns the currently selected target in the Builder graph. The Builder receives this message.

reserved1

Reserved for future use and must be specified as NULL.

Return value

The currently selected target is returned in the following format:

"SUCCESS Current target
selection is: target"

If no target is currently selected, target is blank.

5.1.5 char *BuilderGraphUpdate();

Updates the makefile graph, using the existing configuration information, with the most recent version of the makefile. The Builder receives this message.

5.1.6 char BuilderSetSelection(char target);

Sets the current selection in the makefile graph. The Builder receives this message.

target

The name of the target to be selected. If the specified target does not exist in the makefile graph, a target is created for it. To create a target, make sure you edit the makefile to include the new target.

Return value

The selected target is returned in the following format:

"SUCCESS Target selection
set is: target"

5.1.7 char BuildTarget(char target, char makefile, char options, char engine, char reserved1, char *reserved2);

Builds a target in a makefile.

target	Specifies the pathname of the target or source file to build.
makefile	Specifies the name of the makefile to execute.
options	Optional. Specifies the make options to use.
engine	Optional. Specifies the make engine to use. The default engine is gnumake.
reserved1 and reserved2	Reserved for future use and must be specifed as NULL.
Return value	"SUCCESS" "WARNING - No target given" "WARNING - Not yet implemented"

5.1.8 char CallGraphActOnSelection(char action);

Specifies the action to take on the currently selected node. A node should already be selected before sending this message. The Call Graph Browser receives this message

action

Specifies the action and can be one of the following:

        "clear" - Clears the selected node if there is one; otherwise no action is taken.
        "compact" - Compacts the selected node if there is one; otherwise no action is taken.
        "expand_all" - Expands all nodes under the selected node to display routines. If a node is not selected, no action is taken.
        "expand_exclusive" - Exclusively expands the selected node if there is one and the node is not a routine; otherwise no action is taken.
        "expand_inclusive" - Inclusively expands the selected node, if there is one and the node is not a routine; otherwise no action is taken.
        "ignore" - Ignores the selected node if there is one; otherwise no action is taken.
        "ignore_all" - Ignores all nodes.
        "ignore_none" - Makes all ignored nodes available.
        "info" - Displays in the transcript detailed information about the selected node. If no node is selected, no action is taken.
        "siblings_exclusive" - Places the local root above the selected node if there is one; otherwise no action is taken.

Return value

        SUCCESS:%action is completed successfully% - This value is returned upon successful completion of operation.
        WARNING:%action is not allowed on function% - This value is returned when the specified action is not allowed.
        WARNING:%no selection% - This value is returned when no node is currently selected.
        WARNING:%tool cannot process% - This value is returned when the operation has failed on a selected node.
        FAIL:%no action specified% - This value is returned when no node was specified.
        FAIL:%unrecognized action% - The action specified is not recognized.

5.1.9 char CallGraphCommand(char action, int action_qualifier);

Manages the call graph. The Call Graph Browser receives this message.

action

Specifies the action to take and can be one of the following:

        "expand_all" - Expands all nodes to the routine level.
        "ignore_all" - Ignores all nodes, thereby clears the call graph.
        "ignore_none" - Includes all ignored nodes in the graph.
        "original" - Displays the graph as it appeared at startup.
        "reset" - Resets the graph with all nodes compacted and the current selection maintained.
        "restart" - Restarts the graph with all nodes compacted, ignored nodes included, and the current selection maintained.
        "update" - Requeries the database associated with the current target. All current selections are lost. If this action fails, the database must be recreated by using the FUSE static analysis database manager.

action_qualifier

Specifies variations to the action specified in action and has the following effects:

        For the "expand_all" action, a value of zero expands all nodes fully and a nonzero value expands only the selected node.
        For the "ignore_none" action, action_qualifier is ignored.
        For the "original" action, action_qualifier is ignored.
        For the "reset" action, a value of zero displays the call graph in its original display except that ignored nodes remain ignored; a nonzero value clears the selection and displays the original graph.
        For the "restart" action, a value of zero leaves the selection unmodified and displays the graph with all ignored modes returned; a nonzero value clears the selection and displays the graph with all ignored nodes returned to the graph.
        For the "update" action, action_qualifier is not applicable.

Return value

        SUCCESS:%action is completed successfully% - This value is returned upon successful completion of operation.
        WARNING:%target is not a binary% - This value is returned when an invalid target was selected.
        WARNING:%tool cannot process% - This value is returned when the operation has failed.
        FAIL:%no action specified% - This value is returned when no action was specified.
        FAIL:%unrecognized action% - This value is returned when the specified action is unrecognized (invalid).

5.1.10 void CallGraphHighlightNotification(char highlighted_type, char node_type, char node_name, char node_path, int node_line, char called_node_ type, char called_node_name, char *called_node_path, int called_node_line);

Sends notification about a node that has been highlighted. The Call Graph Browser sends this message.

highlighted_type	Specifies whether the highlighted object is a node or a call: "node" "call"
node_type	Specifies the type of node highlighted: "directory" "file" "function"
node_name	Specifies the name of the highlighted node.
node_path	Specifies the full pathname of the highlighted node.
node_line	Specifies the source file line number where the highlighted node is defined.
called_node_type	Specifies the type of node that is called by the highlighted node: "directory" "file" "function"
called_node_name	Specifies the name of the node called by the highlighted node.
called_node_path	Specifies the full pathname of the node called by the highlighted node.
called_node_line	Specifies the source file line number where the node called by the highlighted node is defined.

5.1.11 trigger char CallGraphSelect(char node_type, char name, char path);

Selects a node in the call graph. The Call Graph Browser receives this message.

node_type	Specifies the type of node to be selected: "directory" "file" "function"
name	Specifies the name of the function when "function" is specified in `node_type`. When "directory" or "file" is specified in `node_type`, this value is not applicable.
path	Specifies the path of the directory, file, or function to select.
Return value	The return value can be one of the following: SUCCESS (%ok%) - The arguments are valid and the selection was completed. WARNING:%selected type does not show in the display.% WARNING:%tool cannot process% FAIL (%bad name%) - The specified function could not be located in the current call graph. FAIL (%bad path%) - The specified file could not be located in the current call graph. FAIL:%unrecognized node type% - This value is returned when the value specified in node_type is not a valid keyword. FAIL:%could not find% - This value is returned when no match could be found. FAIL:%no action specified% - This value is returned when no action was specified. FAIL:%no function specified% - This value is returned when no function was specified when the `node_type` is function. FAIL:%unrecognized node type% - This value is returned when the value specified in `node_type` is not a valid keyword.

5.1.12 char CallGraphSelectFunctionFile(char name);

Highlights and selects the specified function in the call graph in which it is visible. Otherwise, it selects the file or directory containing the specified function. The Call Graph Browser receives this message.

name

Specifies the name of the function to be selected.

Return value

The return value can be one of the following:

        "function_selected" - The function was selected.
        "file_selected" - The file or directory containing the function was selected.
        "FAIL" - The specified function could not be located in the current call graph.

5.1.13 void CallGraphSelectionNotification(char selection_type, char node_type, char node_name, char node_path, int node_line, char called_node_type, char called_node_name, char *called_node_path, int called_node_line);

Sends notification about a node that has been selected. The Call Graph Browser sends this message only when the node has been successfully selected and highlighted.

selection_type	Specifies whether the selected object is a node or call: "node" "call"
node_type	Specifies the type of node: "directory" "file" "function"
node_name	Specifies the name of the selected node.
node_path	Specifies the full pathname of the selected node.
node_line	Specifies the source file line number where the selected node is defined.
called_node_type	Specifies the type of node that is called by the selected node: "directory" "file" "function"
called_node_name	Specifies the name of the node called by the selected node.
called_node_path	Specifies the full pathname of the node called by the selected node.
called_node_line	Specifies the source file line number where the node called by the selected node is defined.

5.1.14 trigger char CancelLock(char libraryname, char filename, char revision);

Cancels a lock on a file in a code management library without using a dialog box. The Code Manager receives this message.

libraryname	Can be one of the following: NULL - Defaults to the current library. Full pathname of the library file.
filename	Specifies the full file name of the file whose lock should be canceled.
revision	Specifies the revision number of the file. The value can be NULL, in which case the revision number is as follows: "1.1" - When performing a Create operation Next highest revision - When performing Checkout and Checkin
Return value	"SUCCESS" "FAIL - Library does not exist" "FAIL - File is not in the Library" "FAIL - Revision does not exist" "FAIL - Revision is not locked"

5.1.15 trigger char CancelLockDialog(char libraryname, char filename, char revision);

Cancels a lock on a file in a code management library interactively, using a dialog box. The Code Manager receives this message.

libraryname	Can be one of the following: NULL - Defaults to the current library. Full pathname of the library file.
filename	Specifies the full file name of the file whose lock should be canceled.
revision	Specifies the revision number of the file. The value can be NULL, in which case the revision number is as follows: "1.1" - When performing a Create operation Next highest revision - When performing Checkout and Checkin
Return value	"SUCCESS" "FAIL - Library does not exist" "FAIL - File is not in the Library" "FAIL - Revision does not exist" "FAIL - Revision is not locked"

5.1.16 void CancelLockNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int *status);

Sends notification about a cancel lock action. The Code Manager sends this message.

instance_id	Specifies the instance ID of the tool requesting the lock cancellation.
libraryname	Can be one of the following: NULL - Defaults to the current library. Full pathname of the library file.
filename	Specifies the full file name of the file whose lock should be canceled.
revision	Specifies the revision number of the file. The value can be NULL, in which case the revision number is as follows: "1.1" - When performing a Create operation Next highest revision - When performing Checkout and Checkin
workdir	Specifies the working directory.
status	Specifies the status of the cancel lock operation. It can be one of the following: 0 - All locks are successsfully canceled. 1 - At least one lock was not canceled.

5.1.17 trigger char CheckIn(char libraryname, char filename, char revision, char *comment, int keepfile, int filemode);

Checks a file into a code management library without using a dialog box. The Code Manager receives this message.

libraryname	Specifies the library or NULL to use the current library.
filename	Specifies the file to be checked into the library.
revision	Specifies the revision number of the file.
comment	Specifies a comment to be stored with the file.
keepfile	Specifies whether to keep a copy of the file in your working directory. It can be one of the following: 0 - Keeps file. 1 - Does not keep file.
filemode	Specifies whether the file is stored as writable or read only. It can be one of the following: 0 - Writable 1 - Read only
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.18 trigger char CheckInDialog(char libraryname, char filename, char revision);

Checks a file into a code management library using a dialog box. The Code Manager receives this message.

libraryname	Specifies the library or NULL to use the current library.
filename	Specifies the file to be checked into the library.
revision	Specifies the revision number of the file.
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.19 void CheckInNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

Sends notification about a file check in action. Only the Code Manager sends this message.

instance_id	Specifies the instance ID of the tool requesting the checkin.
libraryname	Specifies the name of the library.
filename	Specifies the file name of the file checked in.
revision	Specifies the revision value of the file.
workdir	Specifies the working directory.
status	Specifies the status of the checkin operation. It can be one of the following: 0 - All files successfully checked in. 1 - At least one file checkin failed.

5.1.20 trigger char CheckOut(char libraryname, char filename, char revision, int withlock, int overwrite);

Checks a file out of a code management library without using a dialog box. The Code Manager receives this message.

libraryname	Specifies the library or NULL to use the current library.
filename	Specifies the file to be checked into the library.
revision	Specifies the revision number of the file.
withlock	Specifies whether to lock the file for editing, as follows: 0 - Without lock 1 - With lock If checking out the file for reading and compiling, the file does not need to be locked.
overwrite	Specifies whether to overwrite a file in the working directory that has the same name as the file being retrieved, as follows: 0 - Do not overwrite Overwrite
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.21 trigger char CheckOutDialog(char libraryname, char filename, char revision);

Checks a file out of a code management library using a dialog box. The Code Manager receives this message.

libraryname	Specifies the library or NULL to use the current library.
filename	Specifies the file to be checked out of the library.
revision	Specifies the revision number of the file and is required.
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.22 void CheckOutNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

Sends notification about a file checkout action. Only the Code Manager sends this message.

instance_id	Specifies the instance ID of the tool requesting the checkout.
libraryname	Specifies the name of the library.
filename	Specifies the file name of the file checkedout.
revision	Specifies the revision value of the file checked out.
workdir	Specifies the working directory.
status	Specifies the status of the checkout operation. It can be one of the following: 0 - All files successfully checked out. 1 - At least one file checkout failed.

5.1.23 trigger char ClassBrowserSelectClass(char class);

Displays and highlights the specified class. The C++ Class Browser receives this message.

class

Specifies the name of the class.

Return value

The return value can be one of the following:

"SUCCESS" for success
"FAIL" for failure

5.1.24 char CompareCommand(char window_id, char command, char position);

Starts a compare operation and finds the next or previous difference. This message is also used for the merge operation. FUSE-Compare receives this message.

window_id	Specifies the difference window where the file comparison is to be performed. The value specified can be a positive integer from 0 to n, supplied as a string. If the requested window does not exist, an error is returned.
command	Specifies one of the following three commands: "do" - Starts the difference operation. "domerge - Starts the merge operation. "next" - Locates the next difference. "previous" - Locates the previous difference.
position	Specifies the position where the browsed file is displayed in the difference window: "left" - Display file in left side of window. "right" - Display file in right side of window. This parameter is not used when `command` is specified as "do".
Return value	The return value can be one of the following: "SUCCESS" - A difference has been detected. "NO MORE DIFFERENCES" - No difference has been detected. "FAIL: Invalid <parameter_name>" - An invalid parameter value was specified (parameter name is returned between angle brackets).

5.1.25 trigger char CompareLoadFile(char window_id, char file_ name, char position);

Loads a file into a difference window in a specified position. FUSE-Compare receives this message. If FUSE-Compare is already running, either the nth difference window is used (the window_id equals the order number of the window), or a new difference window is opened (a new window_id is generated).

If a parameter value is invalid (for example, a specified file does not exist), the operation is aborted and an error status is returned.

window_id	Specifies the difference window where the file comparison is to be performed. This parameter, together with the return status, allows an external tool to establish which window was used to load the file to be compared, and to reuse it to load other files if needed. window_id can have the following values: A positive integer from 0 to n, supplied as a string. If the requested window does not exist, a new window is opened. "new" - A new difference window is opened. "main" - If FUSE-Compare is already running, the main window is used.
file_name	Specifies the full path name of the file to be loaded. If it is equal to NULL, a file selection dialog box is displayed and the user should enter the missing file. The file need not reside in the working directory. This directory is used only as a default setting when the user wishes to open the left/right file.
position	Specifies the position where the file is displayed in the difference window: "left" - Display file in left side of window. "right" - Display file in right side of window. "ancestor" - Specifies the common ancestor file for a merge operation. "output" - Specifies the output file name to be used as displayed in the output file window during a merge operation. The position parameter is not used when the command parameter for the CompareCommand message is specified as "do".
Return value	"<window_id>" - Directories or files have been successfully loaded. The identifier of the difference window used is returned. "FAIL: Invalid <parameter_name>" - Invalid parameter values were supplied (for example, an invalid file path). "FAIL: Cannot create window" - A new difference window cannot be created.

5.1.26 void ConfirmReplaceFinished(char *query_id, int action);

Notifies other tools that the editor has finished a confirm replace operation. FUSE-Search receives this message.

query_id

Specifies an identifier for the confirm replace operation.

action

Specifies one of the following three actions to be performed on subsequent files:

        DF_BRING_NEXT_FILE - Calls in the next file.
        DF_REPLACE_NO_CNFRM - Replaces all instances of the search string without confirmation.
        DF_QUIT_CNFRM_REPLACE - Quits the replace operation.

5.1.27 char ControlPanelCommand(char req, char *param);

Saves or recalls a configuration file, or exits from the Control Panel. This message is received by the Control Panel.

req

Specifies the action to take and can be one of the following:

        "SAVE_CONFIG" - Saves a configuration file.
        "RECALL_CONFIG" - Recalls a configuration file.
        "QUIT" - Exits. If specified, param is omitted.

param

Specifies the configuration file to save or recall.

Return value

The return value can be one of the following:

        SUCCESS"
        "FAIL - Cannot write to file" is returned when param is specified as "SAVE_CONFIG" and the message failed.
        "FAIL - Error in configuration file" is returned when param is specified as "RECALL_CONFIG" and the message failed.
        "FAIL - Unknown request" is returned when the value specified param is invalid.

5.1.28 char ControlPanelQuery(char query, char tool_class, int tool_id, char *tool_group);

Requests information about a project (formerly tool group). The Control Panel receives this message.

query	Specifies the information to be returned. It can be one of the following: tool_is_of_class - Returns "SUCCESS" if the class specified in `tool_class` is correct for the tool specified in `tool_id`. WARNING is returned if the tool specified in `tool_id` is not in the group specified in tool_group and the tool class is correct. Otherwise, "FAIL" is returned. tool_is_in_group - Returns "SUCCESS" if the tool specified in `tool_id` is in the group specified in `tool_group`. WARNING is returned if the tool specified in `tool_id` is not of the class specified in `tool_class`. FAIL is returned if the tool is not in the specified project (formerly tool group) or if the tool is not found. tool_classes_in - Returns a string containing a space- separated list of the tool classes of all tools in the project (formerly tool group) specified in `tool_group`. If the specified project does not exist, "FAIL" is returned. tools_in - Returns a space-separated string listing the tools in the project (formerly tool group) specified in `tool_group`, in the form "class_id." If the specified project (formerly tool group) does not exist, "FAIL" is returned. working_data_of - Returns the working data for the tool specified in `tool_id` in the form:`{working_dir} {target_dir} {target} {other-info}` If the specified project (formerly tool group) or tool class does not match that for the specified tool, "FAIL" is returned. tool_group_of - Returns the project (formerly tool group) for the tool specified in `tool_id`. If the tool class does not match that for the specified tool, "FAIL" is returned. tool_class_of - Returns the tool class for the tool specified in `tool_id`. If the project (formerly tool group) does not match that for the specified tool, "FAIL" is returned.
tool_class	Specifies the tool class of the tool specified by `tool_id`.
tool_id	Specifies the tool identifier.
tool_group	Specifies the name of the project (formerly tool group).
Return value	"SUCCESS" "WARNING - Tool is not in specified group" "FAIL - Tool not of specified class" "FAIL - Tool not found" "FAIL - Project (formerly tool group) not found" "FAIL - Unknown query"

5.1.29 void DebuggerBreakActivated(char target, char source_ file, char *routine, int line_number, int break_id);

Notifies a tool that the specified breakpoint has been activated. The debugger sends this message.

target	Specifies the target that is currently being debugged. A cooperating tool must check this parameter to distinguish between multiple debugging sessions.
source_file (optional)	Specifies the source file where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
routine (optional)	Specifies the routine where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
line_number (optional)	Specifies the line where the breakpoint existed. The line number is counted from the beginning of the source file, with the first line being line number 1. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
break_id	Specifies an identifier assigned to the breakpoint.

5.1.30 void DebuggerBreakDeactivated(char target, char source_ file, char *routine, int line_number, int break_id);

Notifies a tool that the specified breakpoint has been deactivated. The debugger sends this message.

target	Specifies the target that is currently being debugged. A cooperating tool must check this parameter to distinguish between multiple debugging sessions.
source_file (optional)	Specifies the source file where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
routine (optional)	Specifies the routine where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
line_number (optional)	Specifies the line where the breakpoint existed. The line number is counted from the beginning of the source file, with the first line being line number 1. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
break_id	Specifies an identifier assigned to the breakpoint.

5.1.31 void DebuggerBreakDeleted(char target, char source_file, char *routine, int line_number, int break_id);

Notifies a tool that the specified breakpoint has been deleted. The debugger sends this message.

target	Specifies the target that is currently being debugged. A cooperating tool must check this parameter to distinguish between multiple debugging sessions.
source_file (optional)	Specifies the source file where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
routine (optional)	Specifies the routine where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
line_number (optional)	Specifies the line where the breakpoint existed. The line number is counted from the beginning of the source file, with the first line being line number 1. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
break_id	Specifies an identifier assigned to the breakpoint.

5.1.32 char DebuggerBreakSet(char target, char source_file, char routine, int line_number, int break_id );

Notifies a tool that the Debugger has set a breakpoint. The Debugger sends this message.

target	Specifies the target that that is currently being debugged. A cooperating tool must check this parameter to distinguish between multiple debugging sessions.
source_file (optional)	Specifies the source file containing the breakpoint. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
routine (optional)	Specifies the routine where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
line_number (optional)	Specifies the line where the breakpoint existed. The line number is counted from the beginning of the source file, with the first line being line number 1. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
break_id	Specifies an identifier assigned to the breakpoint.

5.1.33 char DebuggerDeleteBreak(char target, char source_file, char routine, int line_number, int break_id );

Requests that the debugger delete the specified breakpoint. The debugger receives this message.

Individual breakpoints are uniquely identified by the target and break_id parameters.

If the specified breakpoint is in a different target than the one currently being debugged, the request is ignored. If the specified target is the same but no breakpoint makes the request, an error is generated.

If only the target parameter is defined, all the breakpoints are deleted. No error is generated if no breakpoints exist.

If the debugger is executing the target program, it might delay deleting the breakpoint until the next time the debugger reaches a defined processing state. The requester should make no assumptions about when the breakpoint actually is deleted. The debugger might stop at a breakpoint even though a request to delete that breakpoint is outstanding. In this case, the debugger will stop at the breakpoint, send out the DebuggerBreakHit message, delete the breakpoint, and send out the DebuggerBreakDeleted message.

target	Specifies the target that the requesting tool is currently working on. The debugger checks that target against the one that is currently being debugged. If it is different, this message is ignored.
source_file (optional)	Specifies the source file containing the breakpoint. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
routine (optional)	Specifies the routine where the breakpoint existed. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
line_number (optional)	Specifies the line where the breakpoint existed. The line number is counted from the beginning of the source file, with the first line being line number 1. This is always specified if the debugger knows the information; otherwise, the null value "-1" is sent.
break_id	Specifies an identifier assigned to the breakpoint.
Return value	The return value can be one of the following: SUCCESS: %breakpoint deleted% - The breakpoint was successfully deleted. FAIL: %Break_ID not understood% - The target specified is being debugged, but the debugger does not recognize the `break_id` specified. No action is taken.

5.1.34 char DebuggerSetBreak(char target, char source_file, char routine, int line_number);

Requests the debugger to set a breakpoint at the specified location. The debugger receives this message.

target	Specifies the target that is currently being debugged. A cooperating tool must check this parameter to distinguish between multiple debugging sessions.
source_file	Specifies the source file where the breakpoint is to be set.
routine (optional)	Specifies the routine where the breakpoint is to be set. If the routine is specified, the debugger tries to use this information when setting the breakpoint. If the first attempt to create the breakpoint fails, the debugger tries to set the breakpoint without using the routine name.
line_number (optional)	Specifies the line where the breakpoint is to be set. The line number is counted from the beginning of the source file, with the first line being line number 1.
Return value	The return value can be one of the following: SUCCESS: %break_id=<int>. source_file="str", routine="str", line_number=<int% If the message is successfully created, the information about the actual location of the breakpoint is returned. These fields follow the same rules as the values specified in the DebuggerBreakSet message. That is, a cooperating tool should check the values for source_ file, routine, and line_number before using them as these parameters might be null. FAIL: %source file unknown% - The breakpoint cannot be created because the specified module cannot be found. FAIL: %routine not found in source file% - The breakpoint cannot be created because the specified routine cannot be found within the source file specified. FAIL: %line number not found% - The breakpoint cannot be created because the line number is outside the bounds of the source file. FAIL: %debug engine returned "str"% - The debugger engine's error message is returned if the debugger fails to set the breakpoint for any other reason.

5.1.35 void DiagnosticShown(char display_diagnostic_text, char full_diagnostic_text, char file_filter_pattern char everywhere_filter_pattern, char help_topic, int next, int previous, char reserved1, char *reserved2,);

Provides information about the Builder's current diagnostic message. The Builder sends this message.

display_diagnostic_text	Specifies the text that the FUSE editor displays to the user in its information window. The Emacs editor displays this text in the mini buffer.
full_diagnostic_text	Specifies the entire text of the diagnostic as given by the compiler.
file_filter_pattern	Specifies the text of the diagnostic which contains no line information.
everywhere_filter_pattern	Specifies the text of the diagnostic which contains no line and file information.
help_topic	The help topic associated with the diagnostic.
next	Used by the FUSE editor to set the sensitivity of its Next menu item on the Diagnostics menu. If there is a diagnostic in the forward direction, the value is specified as 1; if not, the value is specified as 0. If the diagnostic is from a previous build, this value is specified as -1.
previous	Used by the FUSE editor to set the sensitivity of its Previous menu item on the Diagnostics menu. If there is a diagnostic in the backward direction, the value is specified as 1; if not, the value is specified as 0.
reserved1 and reserved2	Reserved for future use and must be specified as NULL.

5.1.36 char EditorAddLine(char option, int linenum, char *text );

Adds a line to the current buffer. The FUSE Editor receives this message.

option	Specifies where to add the line. It can be one of the following: "before" - Add a line before the specified line. "after" - Add a line after the specified line.
linenum	Specifies the line number in the buffer where the line is to be added. A value of -1 specifies the end of the file.
text	Specifies the text to be inserted.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid.

5.1.37 char EditorAnnotate(char direction, char option, char symbol, char *buffer, int linenum);

Specifies an action to take on an annotation in the Editor annotation area. This message should be used to set unique annotations. The editor annotates the specified buffer and positions the cursor to the line of the annotation. The FUSE Editor, emacs, and vi receive this message.

direction	Specifies where to place the annotation and currently can only be "auto."
option	Specifies the action to take on the annotation and can be one of the following: "set" - Sets the annotation. "unset" - Removes the annotation. "clear" - Clears all annotations. "list_symbol" - Returns a list of all annotation symbols that are supported by this message.
symbol	Specifies the icon to be displayed for the annotation. Use one of the following icons (which can appear more than once in the annotation area): "default1" - T1 "default2" - T2 "default3" - T3 "default4" - T4 "cross_referencer" - X "call_graph" - C "profiler" - P "builder" - B "error" - Skull "warning" - Exclamation mark "info" - Check mark "compareleft" - Small left arrow "compareright" - Small right arrow "search" - S
buffer	Specifies the buffer where the annotation action is to take place. The full pathname of the file must be specified.
linenum	Specifies the line number within the buffer where the annotation action is to be taken.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open.

5.1.38 char EditorAnnotateLines(char direction, char option, char symbol, char buffer, char lines, char *text);

Specifies an action to take on an annotation in the Editor annotation area. This message should be used to set multiple occurrences of the same annotation. No positioning is done by the Editor when it receives this message. The FUSE Editor receives this message.

direction	Specifies where to place the annotation and currently can only be "auto."
option	Specifies the action to take on the annotation and can be one of the following: "set" - Sets the annotation. "unset" - Removes the annotation. "clear" - Clears all annotations. "list_symbol" - Returns a list of all annotation symbols that are supported by this message.
symbol	Specifies the icon to be displayed for the annotation. Use one of the following icons (which can appear more than once in the annotation area): "error" - Skull "warning" - Exclamation mark "info" - Check mark "compareleft" - Small left arrow "compareright" - Small right arrow "search" - S
buffer	Specifies the full pathname of the file to annotate.
lines	Specifies a space-separated string containing the line numbers to annotate. These numbers can include ranges, which are separated by hyphens. For example, "10 15 20-35". The first line is line 1. Numbers do not need to be sorted.
text	Specifies descriptive text about the annotation. This parameter is not implemented in DEC FUSE Version 2.0. However, you must specify it.
Return value	The return value is one of the following: A list of annotation symbols (if the requester specified "list_symbol") "SUCCESS" - The requested action was successfully completed. "FAIL": Invalid line number specified" "FAIL": Bad arguments "FAIL": Internal error

5.1.39 char EditorAppendLine(char option, int linenum, char *text );

Appends a line to the current buffer. The FUSE Editor receives this message.

option	Specifies whether to use a linefeed or not. It can be one of the following: linefeed" - Uses a linefeed. no_linefeed" - Does not use a linefeed.
linenum	Specifies the number of the line within the buffer where the line is to be appended; 0 to specify the start of the file; or -1 to specify the end of the file.
text	Specifies the text to be appended.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid.

5.1.40 char EditorBufferCommand(char option, *char buffer);

Manages a buffer. The FUSE Editor receives this message.

option

Specifies the action to be taken with the buffer. It can be one of the following:

        "save" - Saves the buffer using the current name.
        "saveas" - Pops up a dialog box allowing the user to specify a different file name for saving the buffer.
        "switch" - Changes buffers.
        "clear" - Clears the buffer.
        "close" - Closes the buffer.
        "revert" - Reverts the buffer to the last saved state.

buffer

Specifies the buffer to be managed, or NULL to specify the current buffer.

Return value

The return value is one of the following:

        "SUCCESS" - The requested action was successfully completed.
        "FAIL: Editor context is empty" - No buffer was open.
        "FAIL: Cannot close buffer" - When "close" is specified for option and the specified buffer cannot be closed.
        "FAIL: Cannot switch file" - When "switch" is specified for option and the specified buffer cannot be switched.

5.1.41 char EditorDeleteLine(char option, int from, int to);

Deletes a line in the current buffer. The FUSE Editor receives this message.

option	Specifies what to delete. It can be one of the following: "top" - Deletes from the current cursor position to the top of the file. "bottom" - Deletes from the current cursor position to the bottom of the file. "begin" - Deletes from the current cursor position to the beginning of the line. "end" - Deletes from the current cursor position to the end of the line. "all" - Deletes all text in the current buffer. "line" - Deletes specific lines. When this value is specified, the from and to values must be specified.
from	When "line" is specified in option, specifies where to start deleting. If "line" is not specified in option, NULL must be specified.
to	When "line" is specified in option, specifies where to end deleting. If "line" is not specified in option, NULL must be specified.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid.

5.1.42 void EditorFileClosed(char *file-name);

Sends notification that a file has been closed. Only the FUSE Editor can send this message.

file-name

Specifies the name of the file that has been closed.

5.1.43 void EditorFileReverted(char *file-name);

Sends notification that a file has been reverted. Only the FUSE Editor can send this message.

file-name

Specifies the name of the file that has been reverted.

5.1.44 void EditorFileSaved(char *file-name);

Sends notification that a file has been saved.

file-name

Specifies the name of the file that has been saved.

5.1.45 char EditorGotoLine(char option, int linenum);

Moves to a line in the current buffer. The FUSE Editor, emacs, and vi receive this message.

option

Specifies the direction of the move. It can be one of the following:

        "top" - Moves to the top of the buffer.
        "bottom" - Moves to the bottom of the buffer.
        "line" - Moves to a specific line in the buffer. When this value is specified, the linenum value must be specified.

linenum

When "line" is specified in option, specifies the line number to go to. If "line" is not specified in option, NULL must be specified.

Return value

The return value is one of the following:

        "SUCCESS" - The requested action was successfully completed.
        "FAIL: Editor context is empty" - No buffer was open.
        "FAIL: Bad arguments" - The value specified for option is invalid.
        "WARNING: Invalid specified line number" - The specified line number does not exist in the current buffer.

5.1.46 char EditorHighlightLine(char option, int from, int to);

Highlights or removes highlighting from lines in the current buffer. The FUSE Editor receives this message.

option	Specifies whether to highlight. It can be one of the following: "on""all_off"
from	Specifies where to start highlighting or highlight removal.
to	Specifies where to end highlighting or highlight removal.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid. "WARNING: Invalid specified line number" - The specified line number does not exist in the current buffer.

5.1.47 char* EditorInsertFile(char option, char filename);

Inserts a file into the current buffer. The FUSE Editor receives this message.

option

Specifies where to insert the file and can be one of the following:

        "top" - Inserts the file at the top of the buffer.
        "bottom" - Inserts the file at the bottom of the buffer.
        "current" - Inserts the file at the current cursor position.

filename

Specifies the file to be inserted.

Return value

The return value is one of the following:

        "SUCCESS" - The requested action was successfully completed.
        "FAIL: Editor context is empty" - No buffer was open.
        "FAIL: Bad arguments" - The value specified for option is invalid.

5.1.48 char EditorNavigate(char direction, char *option);

Moves within a buffer. The FUSE Editor receives this message.

direction

Specifies whether to move forward or backward within the buffer. It can be one of the following:

"next" - Moves forward.
"previous" - Moves backward.

option

Specifies the increment of the move and can be one of the following:

        "word" - Moves one word.
        "line" - Moves one line.
        "paragraph" - Moves one paragraph.
        "page" - Moves one page.

Return value

The return value is one of the following:

        "SUCCESS" - The requested action was successfully completed.
        "FAIL: Editor context is empty" - No buffer was open.
        "FAIL: Bad arguments" - The value specified for option is invalid.

5.1.49 trigger char EditorOpenFile(char filename);

Opens a file. The FUSE Editor, emacs, and vi receive this message.

filename

Specifies the name of the file to open.

Return value

The return value is one of the following:

"SUCCESS" - The requested action was successfully completed.
"FAIL: Editor context is empty" - No buffer was open.

5.1.50 char EditorQuery(char query_type, char *buffer);

Obtains information from the Editor. The FUSE Editor receives this message.

query_type

Specifies the information to be returned. It can be one of the following:

        "list_type" - Returns a list of the queries that can be made.
        "access_mode" - Returns whether the buffer is read only or writable.
        "line_number" - Returns the line number of the current cursor position.
        "number_of_lines" - Returns the total number of lines in the buffer.
        "buffer_name" - Returns the name of the current buffer.

buffer

Specifies the buffer to obtain information about.

Return value

        For the "list_type" query, a space-separated list of supported query commands is returned.
        For the "access_mode" query, "writable" or "read_only" is returned.
        For the "line_number" query, the current line number is returned.
        For the "number_of_lines" query, the total number of lines in the current buffer is returned.
        For the "buffer_name" query, the name of the current buffer is returned.
        "FAIL: Editor context is empty" - No buffer was open.
        "FAIL: Bad query type" - The value specified in query_ type is invalid.

5.1.51 char EditorReplace(char direction, char option,char old_text, char *new_text);

Replaces text in the current buffer. The FUSE Editor receives this message.

direction	Specifies whether to move forward or backward within the buffer. It can be one of the following: "next" - Moves forward. "previous" - Moves backward.
option	Specifies the occurrence to search for. It can be one of the following: "first" - Replaces the first occurrence of the text in the buffer. "next" - Replaces the next occurrence, from the current cursor position, of the text in the buffer. "last" - Replaces the last occurrence of the text in the buffer. "all" - Replaces all occurrences of the text in the buffer.
old_text	Specifies the text to be replaced.
new_text	Specifies the replacement text.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid. "FAIL: Search failed" - The editor was unable to find the string.

5.1.52 char EditorSearch(char direction, char option, char text);

Searches for text in the current buffer. The FUSE Editor receives this message.

direction	Specifies whether to move forward or backward within the buffer. It can be one of the following: "next" - Moves forward. "previous" - Moves backward.
option	Specifies the occurrence to search for. It can be one of the following: "first" - Replaces the first occurrence of the text in the buffer. "next" - Replaces the next occurrence, from the current cursor position, of the text in the buffer. "last" - Replaces the last occurrence of the text in the buffer.
text	Specifies the text to search for.
Return value	The return value is one of the following: "SUCCESS" - The requested action was successfully completed. "FAIL: Editor context is empty" - No buffer was open. "FAIL: Bad arguments" - The value specified for option is invalid. "FAIL: Search failed" - The editor was unable to find the string.

5.1.53 trigger void HelpShowTopic(char product, char mode, char *topic);

Requests Help information. The Helper Tool receives this message. All other tools send this message as part of a group of messages titled HELP_RECVS.

product

Specifies the product name (for example, DEC FUSE).

mode

Can have one of the following values:

"show" - Indicates a specific request for Help information.
"auto" - Indicates that the Help information should be shown automatically.

topic

Specifies the topic hierarchy path for the help widget.

5.1.54 trigger char InsertVersionedElement(char libraryname, char librarytype, char filename, char revision, char comment, char *descname);

Inserts a file into a code management library without using a dialog box. The Code Manager receives this message.

libraryname	Specifies the name of the library, or NULL to use the current library.
librarytype	Specifies the library type. It can be one of the following: "SCCS" "RCS" NULL (to use the default library type)
filename	Specifies the file to be inserted into the library.
revision	Specifies the revision number of the file, or NULL to use the default revision.
comment	Specifies a comment to be stored with the file.
descname	Specifies a text description file to be associated with the source file in the library.
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.55 trigger char InsertVersionedElementDialog(char libraryname, char librarytype, char filename, char *revision);

Inserts a file into a code management library using a dialog box. The Code Manager receives this message.

libraryname	Specifies the name of the library, or NULL to use the current library.
librarytype	Specifies the library type. It can be one of the following: "SCCS" "RCS" NULL (to use the default library type)
filename	Specifies the file to be inserted into the library.
revision	Specifies the revision number of the file, or NULL to use the default revision.
comment	Specifies a comment to be stored with the file.
Return value	The return value is either "SUCCESS message" or "FAIL message." The message describes the successful completion of the message service or the reason for failure.

5.1.56 void InsertVersionedElementNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

Sends notification about a file insertion. Only the Code Manager sends this message.

instance_id	Specifies the instance identifier of the tool requesting the file insertion.
libraryname	Specifies the name of the library.
workdir	Specifies the working directory.
filename	Specifies the name of the file inserted.
revision	Specifies the revision value of the file inserted.
status	Specifies the status of the file insert operation. It can be one of the following: 0 - All files successfully inserted. 1 - At least one file insertion failed.

5.1.57 trigger char LocateFunctionInLibraries(char function_name, char *match_type);

Locates the specified function call in a list of libraries. The Search Libraries box is displayed.

function_name

The name of the function for which to search

match_type

Specifies the type of the function name. It can be the following:

        "anycase"
        "identifier"
        "literal"

Return value

The return value can be one of the following:

SUCCESS - The request was received.
FAILURE - Unable to service the request.

5.1.58 trigger char Lock(char libraryname, char filename, char revision);

Locks a file in a code management library without using a dialog box. The Code Manager receives this message.

libraryname	Can be one of the following: Full pathname of the library file. NULL - Defaults to the current library.
filename	Specifies the full file name of the file to lock.
revision	Specifies the revision number of the file. The value can be NULL, in which case the revision number is next highest revision.
Return value	The return value can be one of the following: "SUCCESS" "FAIL - Library does not exist" "FAIL - File is not in the Library" "FAIL - Revision does not exist"

5.1.59 trigger char LockDialog(char libraryname, char filename, char revision);

Locks a file in a code management library interactively, using a dialog box. The Code Manager receives this message.

libraryname	Can be one of the following: Full pathname of the library file. NULL - Defaults to the current library.
filename	Specifies the full file name of the file to lock.
revision	Specifies the revision number of the file. The value can be NULL, in which case the revision number is next highest revision.
Return value	The return value can be one of the following: "SUCCESS" "FAIL - Library does not exist" "FAIL - File is not in the Library" "FAIL - Revision does not exist"

5.1.60 void LockNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int *status);

Sends notification about a lock action. The Code Manager sends this message.

instance_id	Specifies the instance identifier of the tool requesting the lock cancellation.
libraryname	Full pathname of the library file.
workdir	Specifies the working directory.
filename	Specifies the full file name of the file being locked.
revision	Specifies the revision value of the file.
status	Specifies the status of the file lock operation. It can be one of the following: 0 - All files successfully locked. 1 - At least one file was not locked.

5.1.61 trigger char LookupFunction (char keywords, char keywords_options, char function_type, char *reserved);

Invokes the Function Lookup dialog box and fills the keywords field. The user must click on the Lookup function button to start the query.

keywords	The list of keywords to look for.
keyword_options	Options for the query. Supported values: ANY: match all functions that use any of these keywords. ALL: match all functions that use all f these keywords.
function_type	The type of function to look for. Supported values: DXML: Digital eXtended Math Library. ANY: any type of function.
reserved	Reserved for future use.
Return value	The return value can be one of the following: SUCCESS: The Function Lookup dialog box was displayed. FAIL: Unable to perform the operation.

5.1.62 trigger char ManShowTopic(char topic, char *section);

Displays a reference (man) page in a window. It is a trigger message; therefore, if no reference page display is running, it will be invoked. The Man Page Browser receives this message.

topic

The topic for which to display the reference page information.

section

The section specifier for the specified reference page.

Return value

The return value can be one of the following:

SUCCESS-The message was received.
FAIL-Unable to process the message.

5.1.63 trigger char ManShowTopicAtSearchString(char topic, char section, char searchstring);

Displays a reference (man) page in a window and searches for the specified string. The reference page is positioned at the first occurrence of the search string. It is a trigger message; therefore, if no reference page display is running, it will be invoked. The Manual Browser receives this message.

topic	The topic for which to display the reference page information.
section	The section specifier for the specified reference page.
searchstring	The string for which to search in the specified reference page.
Return value	The return value can be one of the following: SUCCESS - Specified reference page is displayed. FAIL - No such reference page found.

5.1.64 char *ManShowWhatis(char keyword);

Displays a list of reference pages whose name or description contains the specified keyword in the whatis database.

keyword

The keyword for which to search.

Return value

The return value can be one of the following:

SUCCESS-A list of references pages is displayed.
FAILURE-No keyword was specified.

5.1.65 trigger char *PrepareForConfirmReplace( );

Requests the editor to prepare to start a confirm replace operation. The FUSE Editor and emacs receive this message.

Return value

The return value can be one of the following:

SUCCESS-Specified reference page is displayed.
FAIL-Confirm Replace in progress.

5.1.66 void ProjectDataUpdatedNotification(char *project_file);

Requests tools in the current project to update their project information. Sent by the Control Panel whenever there is a change to the project information.

project_file

Name of the temporary file that the tools read to get the project information.

5.1.67 char QuerySystemInformation(char info);

Requests FUSE session information. The Control Panel receives this message.

info

Specifies the requested information. It can be one of the following:

"TOOL_GROUPS" - Returns the name of a file that lists information about each project (formerly tool group) using the following format:

tool-group-name
color tool-name tool-instance-id

"TOOLS" - Returns the name of a file that lists information about each tool using one line for each tool, as follows:

tool-name
tool-group working-data-index visible|icon

working-data-index1
working data

working-data-index2
working data

"SYSTEM_MENU" - Returns the name of a file that lists information about each active tool using one line for each tool, as follows:

tool-name keyboard-equivalent
schema-file

"PROJECT_INFO" - Returns the name of a temporary file that lists information needed by the project. Each tool processes this file to get startup information.

Return value

The return value can be one of the following:

        The name of the file containing the requested information.
        FAIL - Invalid option.
        FAIL - Can't open temporary file.

5.1.68 char RaiseProjectManager(char tool_option, Boolean target_needed, Boolean makefile_needed, Boolean libraries_needed, char reserved1, char reserved2);

Invokes the Project Manager prepopulated with project information. The project is the same as that of the tool. This message is sent by tools to the Control Panel.

tool_option	Informs the Control Panel which of the command buttons should be sensitive. It can be one of the following values: DF_ALL_TOOLS: Specifies that all command buttons are available. DF_BUILDER_ONLY: Specifies that only the Builder-specific command button is active. DF_COM_ONLY: Specifies that only the Code Manager-specific command button is active. DF_DATABASE_ONLY: Specifies that only the Database-specific command button is active. DF_NO_TOOLS: Specifies that none of the three command buttons is active.
target_needed	Indicates whether the target field entry in the Project Manager is required. This field is checked only if the value of the tool_option is `DF_ALL_TOOLS`. TRUE: User must enter a valid target in this field before dismissing the box. FALSE: User can dismiss box without entering a valid target.
makefile_needed	Indicates whether the makefile field entry in the Project Manager is required. This field is checked only if the value of the tool_option is `DF_ALL_TOOLS`. TRUE: User must enter a makefile in this field before dismissing the box. FALSE: User can dismiss box without entering a makefile.
libraries_needed	Indicates whether the list of libraries to open is required. This field is checked only if the value of the tool_option is `DF_ALL_TOOLS`. TRUE: User must select a list of libraries to open before dismissing the box. FALSE: User can dismiss box without selecting a list of libraries to open.
reserved1 & reserved2	Reserved for future use.
Return value	The return value can be one of the following: FUSEMSG_RECV_SUCCESS: The Project Manager raised successfully. FUSEMSG_RECV_FAIl: Failed to raise the Project Manager.

5.1.69 char RaiseToolSpecificDialog(char dialog, char *reserved);

Brings up a pre-populated tool-specific dialog box for use by the Builder, Code Manager, static analysis toos, Database Manager, and Database transcript window.

dialog

Name of the dialog box to invoke as follows:

        DF_BUILDER_DIALOG: Brings up the Builder Properties dialog box.
        DF_CM_DIALOG: Brings up the Code Manager Properties dialog box.
        DF_DATABASE_DIALOG: Invokes the Browser Tools Properties dialog box.

reserved

Reserved for future use.

Return value

The return value can be one of the following:

FUSEMSG_RECV_SUCCESS: Dialog box was invoked successfully.
FUSEMSG_RECV_FAIL: Failed to invoke the required dialog box.

5.1.70 char ShowDiagnostic(int direction);

Informs the Builder to move to the first, next, previous, or last diagnostic. The Builder receives this message from the editors.

direction

Indicates the diagnostic message to move to when the user clicks on the First, Next, Previous, or Last Diagnostic menu items. It is specified as the constants defined for the first, next, previous, and last directions in the DFEncase.h file. The constants can be the following:

        "DF_SHOW_DIAG_PREV"
        "DF_SHOW_DIAG_NEXT"
        "DF_SHOW_DIAG_FIRST"
        "DF_SHOW_DIAG_LAST"

Return value

The return value can be one of the following:

        SUCCESS
        FAILURE - No previous error.
        FAILURE - No next error.
        FAILURE - No errors exist.
        FAILURE - Invalid direction.

5.1.71 trigger char SearchFiles(char search_directory, char file_pattern, char search_for_expression, char match, char case, char line_matching_mode, char *dir_scan_mode);

Searches the files in the search directory or in the overall directory for a regular expression or string. If the expression or string is found, files and lines are displayed in the FUSE-Search Main Window. FUSE-Search receives this message.

search_directory	Specifies the directory or the root of the directory tree in which the search is to be conducted (wildcards are accepted). If the working directory parameter is void, FUSE-Search uses either the working directory value currently stored in the FUSE configuration database for FUSE-Search, or the FUSE working directory if FUSE-Search was not previously activated.
file_pattern	Specifies a regular expression that identifies a set of files located in the target directory (tree) on which the search will be performed. If the parameter value is void, the Files field in the Main Window must be filled before starting the search operation.
search_for_expression	Specifies a regular expression or string to be located in the specified working directory (tree) and files. The way it is used depends on the match parameter value. If the parameter value is void, the Search For field in the Main Window must be filled before starting the search operation.
match	Specifies the way the search_for_expression parameter should be managed. It can be one of the following: "expression" - Regular expression to be interpreted with the grep utility. "extended" - Extended regular expression to be interpreted with the egrep utility. "literal" - String to be interpreted literally by calling the fgrep utility. "current" - Value currently set in the Match option menu (this value is meaningful only if FUSE-Search is already running; otherwise, "expression" is assumed). If void, "expression" is assumed.
case	Specifies one of the following: "any_case" - Search is not case sensitive. "case_matching" - Search is case sensitive. "current" - Current setting of the Any Case toggle is used (this value is meaningful only if FUSE-Search is already running; otherwise, "case_matching" is assumed). If void, "case_matching" is assumed.
line_matching_mode	Specifies one of the following: "line_matching" - Matching lines are retrieved. "line_not_matching" - Nonmatching lines are retrieved. "current" - Current setting of the Lines Not Matching toggle is used (this value is meaningful only if FUSE- Search is already running; otherwise, "line_matching" is assumed). If void, "line_matching" is assumed.
dir_scan_mode	Specifies one of the following: "scan_dir" - Search is performed only in the search directory. "scan_dir_tree" - Entire directory tree from search directory downwards is scanned. "current" - Current setting of the Scan Dir Tree toggle is used (this value is meaningful only if FUSE-Search is already running; otherwise, "scan_dir" is assumed). If void, "scan_dir" is assumed.
Return value	The return value can be one of the following: SUCCESS - The search request has been accepted by FUSE- Search. FAIL - Invalid or incompatible parameters (for example, case=case_matching not supported with match="extended").

5.1.72 char StartConfirmReplace(char query_id, char file, char search_string, char *replace_string, int line, int any_case, int match_option, int more_files);

Searches the specified file for the specified string and then prompts the user to confirm whether to replace the string with the specified replacement string. The FUSE editor and emacs receive this message.

query_id	Identifer for the confirm replace operation.
file	The file to search for the search string.
search_string	The string for which to search.
replace_string	The string with which to replace the search string.
line	The line from which to start the search.
any_case	Indicates whether to perform a case sensitive or case nonsensitive search. This can be one of the following: 0 - Performs a case sensitive search. 1 - Performs a case insensitive search.
match_option	Indicates the type of search and can be one of the following: DF_LITERAL - Indicates a literal search. DF_REGULAR - Indicates a regular expression search. DF_EXTENDED - Indicates an extended expression search. These three constants are defined in the DFencase.h file.
more_files	Indicates whether additional files must be searched after file specified in the file parameter. 0 - Indicates that there are no additional files to search. 1 - Indicates that there are additional files to search.
Return value	The return value can be one of the following: SUCCESS - The editor started the confirm replace. FAILURE - The editor was unable to start the confirm replace.

5.1.73 void ToolControlCommand(char command, char param);

Takes an action on a tool. The Control Panel sends this message. Use the FUSE_set_dest function or the fusescript -set_dest command to direct this message to the correct tool.

command	Specifies the action to take, which can only be STOP.
param	Reserved for future use.

5.1.74 void ToolControlNotification(char *event);

Sends information about a tool stop or stop cancellation. The Control Panel receives this message.

event

Specifies how the tool was canceled and can be one of the following:

"CANCEL_STOP" - This event specifies that an attempt by the Control Panel to stop the tool has been interrupted by the user. For example, if an editor has unsaved buffers, the user has the option to save the buffers before exiting.
"STOP" - This event specifies that a tool is about to exit.

5.1.75 void ToolDisplayCommand(char command, char param);

Changes tool display. The Control Panel sends this message using the FUSE_set_dest function.

command

Specifies the action to take on the tool display. It can be one of the following:

        "ICONIFY" - Iconifies (minimizes) the tool. If specified, param is omitted.
        "DEICONIFY" - Deiconifies (restores) the tool. If specified, param is omitted.
        "RAISE" - Raises the tool window to the top.
        "SET_COLOR" - Changes the color of the tool's project (formerly tool group).
        "ACTIVATE_CLASS" - Allows the user to start the tool.
        "DEACTIVATE_CLASS" - Disallows the user from starting the tool.
        "ADD_CLASS" - Adds an entry for the tool in the Tools menu.
        "REMOVE_CLASS" - Removes the tool's entry from the Tools menu.

parameter

Provides additional information for some values of command, as follows:

If command is specified as "SET_COLOR", param specifies the color.
If command is specified as "ACTIVATE_CLASS", "DEACTIVATE_CLASS", "ADD_CLASS" or "REMOVE_CLASS", param specifies the tool class name.

5.1.76 void ToolDisplayNotification(char *event);

Sends notification of a tool display change. The Control Panel receives this message.

event

Specifies the tool display change and can be one of the following:

        "ICONIFY"
        "DEICONIFY"
        "RAISE"
        "STOP"
        "CANCEL_STOP"

5.1.77 char ToolStartNotification(char class, long sid, char *hostname, int pid);

Sends notification about a tool start. The Control Panel receives this message.

class	Specifies the name of the tool class that was started.
sid	Specifies the unique integer assigned to each tool start, which is passed in the FUSE_SID environment variable.
hostname	Specifies the name of the workstation where the tool was started.
pid	Specifies the process identifier of the tool that was started.
Return value	The return value is the name of the project (formerly tool group) that the tool is joining.

5.1.78 trigger char VerifyVersionedElement(char libraryname, char filename, char revision );

Sends information about a file in a code management library. The Code Manager receives this message.

libraryname	Specifies the name of the code management library.
filename	Specifies the name of the file.
revision	Specifies the file's revision value or NULL.
Return value	The return value can be one of the following: "0 File is not in the library." "1 Revision does not exist." "2 Revision is locked." "3 Revision is not locked." "FAIL - Library does not exist."

5.1.79 uint VisualizeDataSet(char filespec, uint clearFlag, uint deleteFlag, uint reserved );

Visualizes the data in the specified file. The Program Visualizer receives this message.

filespec	Specifies the name of the dataset file to visualize.
clearFlag	Specifies whether or not to clear the view before displaying the file. The value can be one of the following: "1" - Clears the view before displaying the visualized file. "0" - Does not clear the view before displaying the visualized file, but merges the display with the current display.
deleteFlag	Specifies whether to delete the file upon completion. The value can be one of the following: "1" - Deletes the file. "0" - Does not delete the file.
reserved	Reserved for future use. The value must be set to 0 (zero).
Return value	The return value can be one of the following: "0-file read OK" "1-error accessing file" "2-wrong file format"

5.1.80 trigger char XrefDatabaseCommand(char target, char *command );

Starts an action on a static analysis database. The static analysis database server receives this message.

target

Specifies the absolute pathname of the target.

command

Specifies the action to take. It can be one of the following:

        "new" - Reloads or updates the database if it is not already running. The return value when this is specified can be "invalid_target", "illegal", or "loading".
        "regardless" - If the database is running, uses it; if it is not running, reloads (and updates, if necessary) and uses it. The return value when this is specified can be "invalid_target", "already", "ready", or "loading".
        "relinquish" - Relinquishes use of the database. The return value when this is specified can be "invalid_ target", "illegal", or "ready".
        "remove" - Removes the database file associated with the target. The return value can be "invalid_target", "illegal", "failed", "in_use", or "ready". This does not remove the transcript file associated with the static analysis database.
        "running" - Uses the database if it is running. The return value when this is specified can be "invalid_ target", "illegal", or "reloading".
        "status" - Returns a string specifying whether the database is running; the pathnames of the associated database file, resource file, and transcript file; and whether each of the associated database files exist. The return value when this is specified can be "invalid_ target", "running", and "not_running." When "running" or "not_running" is returned, the following format is used:
        "[not_]running\[*|-] TargetPath\[*|-] RcFilePath\[*|-] TranscriptFilePath\"
        An asterisk (*) indicates that the file exists; a minus sign indicates the file does not exist.
        "shutdown" - Closes the database and disconnects it from the server, if the database is running. The return value can be "invalid_target," "illegal," or "shutdown."
        "update" - Updates the database if the database is already running. The return value when this is specified can be "invalid_target," "illegal", or "reloading."

Return value

The return value can be one of the following:

        "invalid target"
        "loading"
        "illegal"
        "already"
        "ready"
        "in use"
        "shutdown"
        "reloading"
        "bad database command"
        "running..."
        "not running..."

5.1.81 void XrefDatabaseNotification(char target, char information );

Sends notification of database activity. Only the static analysis database server can send this message.

target

Specifies the absolute pathname of the target

information

Specifies the database activity information. It can be one of the following:

        "created" - The database has been created.
        "removed" - The database file has been removed.
        "shut_down" - The database has been closed.
        "updated" - The database has been updated.
        "update_unnecessary" - The database has been reloaded and an update was not necessary.

5.1.82 trigger char XrefDatabaseQuery(char target, char query_ type, char name, char name_match_type, char file, char line, char call_from, char call_from_match_type, char data_type, char data_type_match_type, char class_ specifier);

Sends a query to the database. The static analysis database server receives this message.

target	Specifies the full pathname of the target
query_type	Specifies the entity to be queried for. It can be one of the following: "reference" "assignment" "function" "call" "declaration" "unsupported": if used, the file, line, call_from, call_from_match_type, data_type, data_type_match_type, and class_specifier arguments are ignored.
name	Specifies the string to locate and can be an identifier, a literal, or a regular expression. It can also be specified as NULL.
name_match_type	Specifies the type of expression in name. It can be one of the following: "anycase" "identifier" "literal" "regex"
file	Specifies the file to be searched. It can also be specified as NULL.
line	Specifies the line number to be searched. It can also be specified as NULL.
call_from	Specifies the name of a function, if query_type is specified as a function. It can be either a literal or a regular expression. It can also be specified as NULL.
call_from_match_type	Specifies the type of expression in call_from. It can be one of the following: "anycase" "identifier" "literal" "regex"
data_type	Specifies the data type if query_type is specified as declaration. It can be either an identifier, a literal, or regular expression. It can also be specified as NULL.
data_type_match_type	Specifies the type of expression in data_type. It can be one of the following: "anycase" "identifier" "literal" "regex"
class_specifier	Specifies the class to be searched and can be specified only when query_type is "declaration." It can be one of the following (and can also be specified as NULL): General class specifiers: Using one of the following class specifiers is equivalent to using all possible language-specific class specifiers of that category: "any" "constant" "macro_def" "routine" "routine_param" "variable" "type" Ada-specific class specifiers: "ada_any" "ada_accept" "ada_compil_unit" "ada_entry" "ada_enum_literal" "ada_exception" "ada_function" "ada_generic" "ada_label" "ada_named_number" "ada_package" "ada_parameter" "ada_procedure" "ada_record_comp" "ada_task" "ada_type" "ada_variable" C-specific class specifiers: "cc_any" "cc_enum_constant" "cc_function" "cc_label" "cc_parameter" "cc_struct_field" "cc_named_constant" "cc_type" "cc_typedef" "cc_variable" C++-specific class specifiers: "c++_any" "c++_cb_class" "c++_class_member" "c++_enum_constant" "c++_exception" "c++_friend" "c++_function" "c++_label" "c++_parameter" "c++_named_constant" "c++_template" "c++_type" "c++_typedef" "c++_variable" Cobol-specific class specifiers: "cobol_any" "cobol_alphabet" "cobol_argument" "cobol_class" "cobol_condition_name" "cobol_file" "cobol_function" "cobol_group" "cobol_group_item" "cobol_item" "cobol_paragraph" "cobol_program" "cobol_switch" "cobol_symbolic_chart" Fortran 77-specific class specifiers: "f77_any" "f77_common_block" "f77_entry_point" "f77_equiv_entity" "f77_function" "f77_label" "f77_namelist_group" "f77_param_constant" "f77_program" "f77_record_field" "f77_stmt_function" "f77_subp_argument" "f77_subroutine" "f77_type" "f77_variable" Pascal-specific class specifiers: "pascal_any" "pascal_compil_unit" "pascal_discrim" "pascal_enum_literal" "pascal_function" "pascal_label" "pascal_parameter" "pascal_procedure" "pascal_record_field" "pascal_symb_const" "pascal_type" "pascal_variable" Fortran 90-specific class specifiers: "f90_any" "f90_block_data" "f90_common_block" "f90_entry_point" "f90_equiv_entity" "f90_function" "f90_generic_name" "f90_hpf_directive" "f90_label" "f90_module" "f90_namelist_group" "f90_param_constant" "f90_program" "f90_record_field" "f90_stmt_function" "f90_subp_argument" "f90_subroutine" "f90_type" "f90_variable"
Return value	The return value can be one of the following: "not_running" "not_client" "failed"

5.1.83 trigger char XrefGoToDeclaration(char name, char name_match_type, char class_specifier );

Makes a query to the currently configured target and displays the results. If the declaration specified is unique, loads it into the editor. The static analysis database server receives this message.

name	Specifies the string to locate and can be an identifier, a literal, or a regular expression. It can also be specified as NULL.
name_match_type	Specifies the type of expression in name. It can be one of the following: "anycase" "identifier" "literal" "regex"
class_specifier	See the description of the `class_specifier` parameter for the `XrefDatabaseQuery` message.
Return value	The return value can be one of the following: "SUCCESS - The parameters were valid and the query was issued. "illegal" - Illegal parameter values or combination of parameters. "busy" - Cannot process the query request.

5.1.84 trigger char XrefShowQuery(char query_type, char name, char name_match_type, char file, char line, char call_from, char call_from_match_type, char data_type, char data_type_match_type, char *class_specifier );

Instructs the cross-referencer to query the static analysis database server, using the currently configured target, and to display the results of the query. The cross-referencer receives this message.

querytype	Specifies the entity to be queried for. It can be one of the following: "reference" "assignment" "function" "call" "declaration" "unsupported" - if used, the file, line, call_from, call_from_match_type, data_type, data_type_match_type, and class_specifier arguments are ignored.
name	Specifies the string to locate and can be an identifier, a literal, or a regular expression. It can also be specified as NULL.
name_match_type	Specifies the type of expression in name. It can be one of the following: "anycase" "identifier" "literal" "regex"
file	Specifies the file to be searched. It can also be specified as NULL.
line	Specifies the line number to be searched. It can also be specified as NULL.
call_from	Specifies the name of a function, if query_type is specified as a function. It can be either a literal or a regular expression. It can also be specified as NULL.
call_from_match_type	Specifies the type of expression in call_from. It can be one of the following: "anycase" "identifier" "literal" "regex"
data_type	Specifies the data type if query_type is specified as declaration. It can be either an identifier, a literal, or regular expression. It can also be specified as NULL.
data_type_match_type	Specifies the type of expression in data_type. It can be one of the following: "anycase" "identifier" "literal" "regex"
class_specifier	See the description of the class_specifier parameter for the `XrefDatabaseQuery` message.
Return value	The return value can be one of the following: "SUCCESS" - The query file was displayed. "illegal" - Invalid parameter values.

5 FUSE Messages

5.1 Message Listing

5.1.1 char *AddToFilterList(char *target, char *filter_pattern );

5.1.2 trigger char *Build(char *target, char *reserved1, char *reserved2);

5.1.3 void BuilderFinish(char *target, char *makefile, char *outputfile, int status);

5.1.4 char *BuilderGetSelection(char *reserved1);

5.1.5 char *BuilderGraphUpdate();

5.1.6 char *BuilderSetSelection(char *target);

5.1.7 char *BuildTarget(char *target, char *makefile, char *options, char *engine, char *reserved1, char *reserved2);

5.1.8 char *CallGraphActOnSelection(char *action);

5.1.9 char *CallGraphCommand(char *action, int action_qualifier);

5.1.10 void CallGraphHighlightNotification(char *highlighted_type, char *node_type, char *node_name, char *node_path, int node_line, char *called_node_ type, char *called_node_name, char *called_node_path, int called_node_line);

5.1.11 trigger char *CallGraphSelect(char *node_type, char *name, char *path);

5.1.12 char *CallGraphSelectFunctionFile(char *name);

5.1.13 void CallGraphSelectionNotification(char *selection_type, char *node_type, char *node_name, char *node_path, int node_line, char *called_node_type, char *called_node_name, char *called_node_path, int called_node_line);

5.1.14 trigger char *CancelLock(char *libraryname, char *filename, char *revision);

5.1.15 trigger char *CancelLockDialog(char *libraryname, char *filename, char *revision);

5.1.16 void CancelLockNotification(int instance_id, char *libraryname, char *workdir, char *filename, char *revision, int *status);

5.1.17 trigger char *CheckIn(char *libraryname, char *filename, char *revision, char *comment, int keepfile, int filemode);

5.1.18 trigger char *CheckInDialog(char *libraryname, char *filename, char *revision);

5.1.19 void CheckInNotification(int instance_id, char *libraryname, char *workdir, char *filename, char *revision, int status);

5.1.20 trigger char *CheckOut(char *libraryname, char *filename, char *revision, int withlock, int overwrite);

5.1.21 trigger char *CheckOutDialog(char *libraryname, char *filename, char *revision);

5.1.22 void CheckOutNotification(int instance_id, char *libraryname, char *workdir, char *filename, char *revision, int status);

5.1.23 trigger char *ClassBrowserSelectClass(char *class);

5.1.24 char *CompareCommand(char *window_id, char *command, char *position);

5.1.25 trigger char *CompareLoadFile(char *window_id, char *file_ name, char *position);

5.1.26 void ConfirmReplaceFinished(char *query_id, int action);

5.1.27 char *ControlPanelCommand(char *req, char *param);

5.1.28 char *ControlPanelQuery(char *query, char *tool_class, int *tool_id, char *tool_group);

5.1.29 void DebuggerBreakActivated(char *target, char *source_ file, char *routine, int line_number, int break_id);

5.1.30 void DebuggerBreakDeactivated(char *target, char *source_ file, char *routine, int line_number, int break_id);

5.1.31 void DebuggerBreakDeleted(char *target, char *source_file, char *routine, int line_number, int break_id);

5.1.32 char *DebuggerBreakSet(char *target, char *source_file, char *routine, int line_number, int break_id );

5.1.33 char *DebuggerDeleteBreak(char *target, char *source_file, char *routine, int line_number, int break_id );

5.1.34 char *DebuggerSetBreak(char *target, char *source_file, char *routine, int line_number);

5.1.35 void DiagnosticShown(char *display_diagnostic_text, char *full_diagnostic_text, char *file_filter_pattern char *everywhere_filter_pattern, char *help_topic, int *next, int *previous, char *reserved1, char *reserved2,);

5.1.36 char *EditorAddLine(char *option, int linenum, char *text );

5.1.37 char *EditorAnnotate(char *direction, char *option, char *symbol, char *buffer, int linenum);

5.1.38 char *EditorAnnotateLines(char *direction, char *option, char *symbol, char *buffer, char *lines, char *text);

5.1.39 char *EditorAppendLine(char *option, int linenum, char *text );

5.1.40 char *EditorBufferCommand(char *option, *char buffer);

5.1.41 char *EditorDeleteLine(char *option, int from, int to);

5.1.42 void EditorFileClosed(char *file-name);

5.1.43 void EditorFileReverted(char *file-name);

5.1.44 void EditorFileSaved(char *file-name);

5.1.45 char *EditorGotoLine(char *option, int linenum);

5.1.46 char *EditorHighlightLine(char *option, int from, int to);

5.1.47 char* EditorInsertFile(char *option, char *filename);

5.1.48 char *EditorNavigate(char *direction, char *option);

5.1.49 trigger char *EditorOpenFile(char *filename);

5.1.50 char *EditorQuery(char *query_type, char *buffer);

5.1.51 char *EditorReplace(char *direction, char *option,char *old_text, char *new_text);

5.1.52 char *EditorSearch(char *direction, char *option, char *text);

5.1.53 trigger void HelpShowTopic(char *product, char *mode, char *topic);

5.1.54 trigger char *InsertVersionedElement(char *libraryname, char *librarytype, char *filename, char *revision, char *comment, char *descname);

5.1.55 trigger char *InsertVersionedElementDialog(char *libraryname, char *librarytype, char *filename, char *revision);

5.1.56 void InsertVersionedElementNotification(int instance_id, char *libraryname, char *workdir, char *filename, char *revision, int status);

5.1.57 trigger char *LocateFunctionInLibraries(char *function_name, char *match_type);

5.1.58 trigger char *Lock(char *libraryname, char *filename, char *revision);

5.1.59 trigger char *LockDialog(char *libraryname, char *filename, char *revision);

5.1.60 void LockNotification(int instance_id, char *libraryname, char *workdir, char *filename, char *revision, int *status);

5.1.61 trigger char *LookupFunction (char *keywords, char *keywords_options, char *function_type, char *reserved);

5.1.62 trigger char *ManShowTopic(char *topic, char *section);

5.1.63 trigger char *ManShowTopicAtSearchString(char *topic, char *section, char *searchstring);

5.1.64 char *ManShowWhatis(char keyword);

5.1.65 trigger char *PrepareForConfirmReplace( );

5.1.66 void ProjectDataUpdatedNotification(char *project_file);

5.1.67 char *QuerySystemInformation(char *info);

5.1.68 char *RaiseProjectManager(char *tool_option, Boolean target_needed, Boolean makefile_needed, Boolean libraries_needed, char *reserved1, char *reserved2);

5.1.69 char *RaiseToolSpecificDialog(char *dialog, char *reserved);

5.1.70 char *ShowDiagnostic(int *direction);

5.1.71 trigger char *SearchFiles(char *search_directory, char *file_pattern, char *search_for_expression, char *match, char *case, char line_matching_mode, char *dir_scan_mode);

5.1.72 char *StartConfirmReplace(char *query_id, char *file, char *search_string, char *replace_string, int line, int any_case, int match_option, int more_files);

5.1.73 void ToolControlCommand(char *command, char *param);

5.1.74 void ToolControlNotification(char *event);

5.1.75 void ToolDisplayCommand(char *command, char *param);

5.1.76 void ToolDisplayNotification(char *event);

5.1.77 char *ToolStartNotification(char *class, long sid, char *hostname, int pid);

5.1.78 trigger char *VerifyVersionedElement(char *libraryname, char *filename, char *revision );

5.1.1 char AddToFilterList(char target, char *filter_pattern );

5.1.2 trigger char Build(char target, char reserved1, char reserved2);

5.1.3 void BuilderFinish(char target, char makefile, char *outputfile, int status);

5.1.4 char BuilderGetSelection(char reserved1);

5.1.6 char BuilderSetSelection(char target);

5.1.7 char BuildTarget(char target, char makefile, char options, char engine, char reserved1, char *reserved2);

5.1.8 char CallGraphActOnSelection(char action);

5.1.9 char CallGraphCommand(char action, int action_qualifier);

5.1.10 void CallGraphHighlightNotification(char highlighted_type, char node_type, char node_name, char node_path, int node_line, char called_node_ type, char called_node_name, char *called_node_path, int called_node_line);

5.1.11 trigger char CallGraphSelect(char node_type, char name, char path);

5.1.12 char CallGraphSelectFunctionFile(char name);

5.1.13 void CallGraphSelectionNotification(char selection_type, char node_type, char node_name, char node_path, int node_line, char called_node_type, char called_node_name, char *called_node_path, int called_node_line);

5.1.14 trigger char CancelLock(char libraryname, char filename, char revision);

5.1.15 trigger char CancelLockDialog(char libraryname, char filename, char revision);

5.1.16 void CancelLockNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int *status);

5.1.17 trigger char CheckIn(char libraryname, char filename, char revision, char *comment, int keepfile, int filemode);

5.1.18 trigger char CheckInDialog(char libraryname, char filename, char revision);

5.1.19 void CheckInNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

5.1.20 trigger char CheckOut(char libraryname, char filename, char revision, int withlock, int overwrite);

5.1.21 trigger char CheckOutDialog(char libraryname, char filename, char revision);

5.1.22 void CheckOutNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

5.1.23 trigger char ClassBrowserSelectClass(char class);

5.1.24 char CompareCommand(char window_id, char command, char position);

5.1.25 trigger char CompareLoadFile(char window_id, char file_ name, char position);

5.1.27 char ControlPanelCommand(char req, char *param);

5.1.28 char ControlPanelQuery(char query, char tool_class, int tool_id, char *tool_group);

5.1.29 void DebuggerBreakActivated(char target, char source_ file, char *routine, int line_number, int break_id);

5.1.30 void DebuggerBreakDeactivated(char target, char source_ file, char *routine, int line_number, int break_id);

5.1.31 void DebuggerBreakDeleted(char target, char source_file, char *routine, int line_number, int break_id);

5.1.32 char DebuggerBreakSet(char target, char source_file, char routine, int line_number, int break_id );

5.1.33 char DebuggerDeleteBreak(char target, char source_file, char routine, int line_number, int break_id );

5.1.34 char DebuggerSetBreak(char target, char source_file, char routine, int line_number);

5.1.35 void DiagnosticShown(char display_diagnostic_text, char full_diagnostic_text, char file_filter_pattern char everywhere_filter_pattern, char help_topic, int next, int previous, char reserved1, char *reserved2,);

5.1.36 char EditorAddLine(char option, int linenum, char *text );

5.1.37 char EditorAnnotate(char direction, char option, char symbol, char *buffer, int linenum);

5.1.38 char EditorAnnotateLines(char direction, char option, char symbol, char buffer, char lines, char *text);

5.1.39 char EditorAppendLine(char option, int linenum, char *text );

5.1.40 char EditorBufferCommand(char option, *char buffer);

5.1.41 char EditorDeleteLine(char option, int from, int to);

5.1.45 char EditorGotoLine(char option, int linenum);

5.1.46 char EditorHighlightLine(char option, int from, int to);

5.1.47 char* EditorInsertFile(char option, char filename);

5.1.48 char EditorNavigate(char direction, char *option);

5.1.49 trigger char EditorOpenFile(char filename);

5.1.50 char EditorQuery(char query_type, char *buffer);

5.1.51 char EditorReplace(char direction, char option,char old_text, char *new_text);

5.1.52 char EditorSearch(char direction, char option, char text);

5.1.53 trigger void HelpShowTopic(char product, char mode, char *topic);

5.1.54 trigger char InsertVersionedElement(char libraryname, char librarytype, char filename, char revision, char comment, char *descname);

5.1.55 trigger char InsertVersionedElementDialog(char libraryname, char librarytype, char filename, char *revision);

5.1.56 void InsertVersionedElementNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int status);

5.1.57 trigger char LocateFunctionInLibraries(char function_name, char *match_type);

5.1.58 trigger char Lock(char libraryname, char filename, char revision);

5.1.59 trigger char LockDialog(char libraryname, char filename, char revision);

5.1.60 void LockNotification(int instance_id, char libraryname, char workdir, char filename, char revision, int *status);

5.1.61 trigger char LookupFunction (char keywords, char keywords_options, char function_type, char *reserved);

5.1.62 trigger char ManShowTopic(char topic, char *section);

5.1.63 trigger char ManShowTopicAtSearchString(char topic, char section, char searchstring);

5.1.67 char QuerySystemInformation(char info);

5.1.68 char RaiseProjectManager(char tool_option, Boolean target_needed, Boolean makefile_needed, Boolean libraries_needed, char reserved1, char reserved2);

5.1.69 char RaiseToolSpecificDialog(char dialog, char *reserved);

5.1.70 char ShowDiagnostic(int direction);

5.1.71 trigger char SearchFiles(char search_directory, char file_pattern, char search_for_expression, char match, char case, char line_matching_mode, char *dir_scan_mode);

5.1.72 char StartConfirmReplace(char query_id, char file, char search_string, char *replace_string, int line, int any_case, int match_option, int more_files);

5.1.73 void ToolControlCommand(char command, char param);

5.1.75 void ToolDisplayCommand(char command, char param);

5.1.77 char ToolStartNotification(char class, long sid, char *hostname, int pid);

5.1.78 trigger char VerifyVersionedElement(char libraryname, char filename, char revision );

5.1.79 uint VisualizeDataSet(char filespec, uint clearFlag, uint deleteFlag, uint reserved );

5.1.80 trigger char XrefDatabaseCommand(char target, char *command );

5.1.81 void XrefDatabaseNotification(char target, char information );

5.1.82 trigger char XrefDatabaseQuery(char target, char query_ type, char name, char name_match_type, char file, char line, char call_from, char call_from_match_type, char data_type, char data_type_match_type, char class_ specifier);

5.1.83 trigger char XrefGoToDeclaration(char name, char name_match_type, char class_specifier );

5.1.84 trigger char XrefShowQuery(char query_type, char name, char name_match_type, char file, char line, char call_from, char call_from_match_type, char data_type, char data_type_match_type, char *class_specifier );