NAME

ada.xref − Ada cross-referencer

SYNOPSIS

ada.xref [ -l ] file

Remarks:

This command requires installation of optional Ada software (not included with the standard HP-UX operating system) before it can be used. 

DESCRIPTION

Ada.xref produces a list of cross references for each name encountered in the compilation unit(s) submitted to it.  Ada.xref operates in either source or library mode, as defined below:

source mode Ada.xref gathers information directly from the specified Ada source file.  In this mode, ada.xref requires the source file suffix to be .ad?, where ? is any single alphanumeric character.  The advantage of this mode is that the compilation unit(s) need not be compiled. 

library mode Ada.xref retrieves the information which has been stored in one or more Ada program libraries at compile time.  In this mode, file contains a list of compilation units along with the library name(s) containing the actual (as opposed to linked) compilation units.  The compilation units specified must have been compiled with the -k option of the ada(1) command.  The advantage of this mode is that ada.xref can identify Ada objects precisely, resolve overloading, understand deferred constants, and extend the cross-references to parent and "withed" units not directly submitted. 

The following option is recognized:

−l Indicate library mode cross-referencing to be performed (default is source mode). 

In library mode, any number of libraries can be specified, but all must belong to the same family.  The library names are specified in the file using the following syntax:

use library_name

and the unit names are specified in the file using the following syntax:

unit_name [ specification | body | all ]

where the optional unit parameter defines whether to cross-reference the specification, body or both the specification and body of the specified unit.  By default, only the body of the specified unit_name is cross-referenced. 

Environment Variables

The environment variable ADA_PATH is associated with all components of the Ada compilation system.  It must be set properly and exported before any component of the Ada compilation system (including ada.xref) can be used (see ada(1), Environment Variables). 

Locks

To ensure the integrity of their internal data structures, Ada libraries and families are locked for the duration of operations that are performed on them.  Normally Ada families are locked only briefly when libraries within them are manipulated.  However, sometimes multiple Ada libraries must be locked for longer periods during a single operation.  If more than one library must be locked for a single operation, at most one library is locked for updating and all other locked libraries are locked for read-only. 

An Ada family or library locked for updating cannot be accessed in any way by any part of the Ada compilation system except by the part which holds the lock.  An Ada family or library locked for reading can be accessed by any part of the Ada compilation system for read-only purposes. 

If ada.xref cannot obtain a lock after a suitable number of retries, it displays an informational message and terminates. 

Under some circumstances, an Ada family or Ada library might be locked, but the locking program(s) might have terminated (for example, due to system crash or network failure).  If you determine that the Ada family or Ada library is locked but should not be locked, you can remove the lock. 

Use ada.unlock(1) to unlock an Ada library and ada.funlock(1) to unlock an Ada family.  However, unlocking should be done with care.  If an Ada family or Ada library is actually locked by a tool, unlocking it permits access by other tools that might find the contents invalid or might damage the Ada family or Ada library. 

AUTHOR

Ada.xref was developed by HP and Alsys. 

FILES

$ADA_PATH/ada.xref Ada cross-referencer command. 

$ADA_PATH/ada.xref.bin Ada cross-referencer subprocess. 

SEE ALSO

ada(1), ada.fmgr(1), ada.format(1), ada.funlock(1), ada.lmgr(1), ada.lsfam(1), ada.lslib(1), ada.make(1), ada.mkfam(1), ada.mklib(1), ada.mvfam(1), ada.mvlib(1), ada.probe(1), ada.protect(1), ada.rmfam(1), ada.rmlib(1), ada.umgr(1), ada.unlock(1). 

Ada User’s Guide (Series 300), HP Part No. 98860-90000. 

Ada Tools Manual (Series 300).

EXTERNAL INFLUENCES

International Code Set Support

Single-byte character code sets are supported within file names. 

Hewlett-Packard Company  —  HP-UX Release 7.0: Sept 1989