Previous Chapter 27 The Cross Reference Viewer

27 The Cross Reference Viewer

The Cross Reference Viewer shows all definitions of SDL entities in a system and where they are referenced. Cross reference files are produced by the Analyzer tool. The Message Sequence Chart Editor can also produce listings of definitions and references from an MSC. These listings are also supported by the Cross Reference Viewer. This chapter contains a reference manual to the Cross Reference Viewer; the functionality it provides, its menus, windows and symbols.

Entities and Windows

Definitions and Cross References

SDL

The SDT Analyzer has the ability to generate files containing SDL Cross-References. See the Analyzer command "Set-Xref" on page 1554, and the Organizer's Analyzer option "Generate a cross reference file" on page 1106. These files use a textual format that is human readable; the purpose of the Cross Reference Viewer is to provide a means to take advantage of this information in SDT's graphical environment. SDL Icons are used when displaying the contents of the files in a graphical way.

MSC

The Message Sequence Chart Editor features the generation of MSC cross references, using the Extract Information command. These entities have properties that are similar to SDL cross-references. Where possible, a direct mapping from MSC to the corresponding SDL concept is made. A few concepts have been added so that all information of interest may be extracted from an MSC. MSC Icons identify the various MSC entities graphically.

SDL Icons

Each type of SDL entity has a unique name and icon used in the Cross Reference Viewer. The different SDL diagram types use the same icon and type name as in the Organizer's Main window. For other types of entities, the following icons and names are used:

------------------------------------------------------------------------
(fig)    Unknown symbol type. Used for diagrams when the type of the dia  
         gram for some reason could not be determined.                    
(fig)    

                                                                
         OPERATOR                                                         
         PACKAGE_INTERFACE                                                
         CHANNEL                                                          
         SIGNALROUTE                                                      
         GATE                                                             
         INPUT                                                            
         OUTPUT                                                           
         CONNECTION                                                       
         CREATE                                                           
         TASK                                                             
         SIGNAL                                                           
         SIGNALLIST                                                       
         GENERATOR                                                        
         FPAR; PROCESS_PARAM, PROCEDURE_PARAM (actual param.)             
         STATE                                                            
         NEXTSTATE                                                        
         TIMER                                                            
         LABEL (in-connector, out-connector)                              
TP(fig)  

                                                                
         INSTANTIATION                                                    
         SET                                                              
         USE                                                              
         INHERITS                                                         
         JOIN                                                             
         STATE_LIST                                                       
         ATLEAST                                                          
         DECISION                                                         
         SAVE                                                             
         DCL; VARIABLE                                                    
         NEWTYPE; SYNTYPE; SORT                                           
         SYNONYM                                                          
         RESET                                                            
         IMPORT; IMPORT_DEF (i.e. Imported)                               
         LITERAL                                                          
         VIEW; VIEW_DEF (i.e. Viewed)                                     
         REMOTE_PROCEDURE                                                 
         REMOTE_VARIABLE                                                  
         SIGNALSET                                                        
         ACTIVE                                                           
         TRANS_OPTION (i.e. transition option)                            
         EXPORT                                                           
         ENAB_COND (i.e. enabling condition)                              
         CONT_SIGNAL (i.e. continuous signal)                             
         NUMBER_INST (i.e. number of instances)                           
         EXPORTED_PROCEDURE                                               
         (PROCEDURE) CALL                                                 
------------------------------------------------------------------------

MSC Icons

Each type of MSC entity has a unique name and icon used in the Cross Reference Viewer. The MSC diagram uses the same icon as in the Organizer's Main window. For other types of entities, the following icons and names are used:

----------------------------------------------------------------------
(fig)  Unknown symbol type. Used for diagrams when the type of the dia  
       gram for some reason could not be determined.                    
(fig)  

                                                                
       CONDITION                                                        
       CREATE of instance                                               
       INPUT of message                                                 
       INSTANCE head                                                    
       OUTPUT of message                                                
       RESET of timer                                                   
       SET of timer                                                     
       STOP of process                                                  
       TIMEOUT (expire of timer)                                        
----------------------------------------------------------------------

Cross Reference Viewer Windows

The Cross Reference Viewer has two windows, the Main window and the References window. The Main window lists all entities in the system and the diagrams they are defined in. The References window lists all cross references in the system for an entity (this is not applicable to entities from an MSC diagram).

The Main window is opened when the Cross Reference Viewer is started, whereas the References window is not opened initially. The general characteristics of these windows are described in the chapter "The SDT Graphical User Interface" on page 1021.

The Main Window

The Drawing Area

The Main window contains a list of all definitions of entities in the current SDL system or the current MSC diagram. The first line in the list gives the name of the current cross reference file. The entities are grouped by which diagram they are defined in.

The diagrams are identified by the same icon as used in the Organizer's Main window, and also by the diagram's type, name and qualifier:

Definitions of SDL(1) entities in
TYPE Name
<< Qualifier >>

Each entity within a diagram is then listed on a separate line in the following format:

TYPE Name * No of definitions No of xrefs

For each entity, the following information is presented:

An icon identifying the type of entity (see "SDL Icons" on page 1394 and "MSC Icons" on page 1397)
The type of the entity, in uppercase text form, and the name of the entity as used in the diagram
The number of definitions with an asterisk in front, if more than one definition of the entity exists (in SDL diagrams, this is only possible for states)
The number of cross references found (only for SDL entities; not applicable to MSC entities)

Within each diagram, the entities are sorted alphabetically.

Figure 430 : Main Window. 
-----
(fig)  
       
-----

When the user selects an entity in the Main window which have cross references, the References window is updated and displays the cross references for the selected entity. If the References window has not been opened earlier in the same Cross Reference Viewer session, the References window is opened automatically.

To double click on an entity in the Main window is the same operation as Show Definition in the Tools menu (see "Show Definition" on page 1404). If there are several definitions associated with the entity, one of them is selected. If the user double clicks again, another definition is selected. The list of definitions associated with the entity is traversed in a circular pattern.

The Menu Bar

The File Menu

Figure 431 : File Menu. 
-----
(fig)  
       
-----

Open

Opens a cross reference file to read cross reference information from. A Standard File Selection Dialog is opened with the file filter initially set to *.xrf. The contents of the Main window is replaced by the information read from the selected file.

Print

Prints the contents of the Main window. The Print Utility is started and issues the Print dialog; see chapter 29, The Print Utility for more information.

Exit

Exits the Cross Reference Viewer.

The View Menu

Figure 432 : View Menu. 
-----
(fig)  
       
-----

Window Options

Sets options for which parts of the Main window to show. The dialog controls whether to show the Tool Bar and the Status Bar.

Figure 433 : The Windows Options Dialog. 
-----
(fig)  
       
-----

Filter Entities

Determines which entity types to show/hide in the entity list. A dialog is opened with a sorted list of all entity types found in the current cross reference file:

Figure 434 : The Filter Entities Dialog.Figure legend: The figure shows the 
		entitytypes for an SDL diagram. See "MSC Icons"on page 1397 for a list of MSC 
		entities.
-----
(fig)  
       
       
       
-----

It is possible to have several entity types selected at the same time in the list. Each selected entity type is added to the previous selection. Selecting an already selected entity type deselects it and removes it from the selection. The dialog remembers the selections made between invocations of the dialog.

Hide
Removes (hides) all entities of the selected types from the entity list in the Main window. The dialog is closed.
Show All
Shows all entities in the entity list in the Main window, i.e. all hide conditions are cleared. The dialog is closed.

An SDT preference, Filter can be set to an initial list of entities to hide whenever the Cross Reference Viewer is opened. See page 1525.

Set Scale

Sets the scale used in the Tree window. The scale is set using a modal dialog:

Figure 435 : The Set Scale Dialog. 
-----
(fig)  
       
-----

The scale can be set between 20% and 800% by using the slider. 100% is the default. Pressing Set changes the scale and brings down the dialog.

The Tools Menu

Figure 436 : The Tools Menu.Figure legend: The picture reads "Show References"
		butthe correct menu choice is "Show Reference List". 
-----
(fig)  
       
       
       
-----

Search

Searches for a visible text in the entity list shown in the Main window.

Figure 437 : The Search Dialog. 
-----
(fig)  
       
-----

Search for
Specifies the text string to search for. As a special case, a GR Reference obtained from for instance an Editor may also be specified.
Ignore Case, Consider Case
These options toggles between a case insensitive and a case sensitive search.
Search
Starts the search and closes the dialog. The first symbol containing the text is selected. The search starts from the selected symbol, if any, or from the first symbol in the first tree.

If the search reaches the end of the trees, the user is asked whether to continue the search from the first tree:

Figure 438 : The Search Continue Dialog. 
-----
(fig)  
       
-----

Pressing the Continue button continues the search from the first tree.

If the text cannot be found among the visible information, the user is informed in a confirmation dialog.

Search Again

Searches again for the same text as in the latest search. The behavior is the same as for Search above.

Show Definition

Opens an Editor containing the specified definition of the entity selected in the entity list. The diagram symbol containing the definition becomes selected in the Editor.

The name and behavior of this menu choice depends on the number of existing definitions for the selected entity:

If only one definition exists, that definition is shown in the Editor.
If more than one definition exists, a separate menu choice is available for the first 9 definitions: Show Definition 1, Show Definition 2, etc. The specified definition is shown in the Editor.
If more than 9 definitions exist, an additional menu choice Show Definition... is available. This menu choice opens a dialog in which the number of the definition can be specified.
```
Figure 439 : The Show Definition Dialog. 
-----
(fig)  
       
-----
```
- The number of the definition is specified by using the Slide Bar.
- Pressing the Show button shows the specified definition in the Editor.

Show Reference List

Opens or raises the References window, showing cross references for the selected entity type.

Show Organizer

Raises the Organizer's Main window.

Popup Menus

The following tables lists the menu choices in the Main window popup menus and a reference to the corresponding menu choice in the menu bar.

On the Main Window Background

----------------------------------------------------
Search           "Search" on page 1403.               
Search Again     "Search Again" on page 1404.         
Show References  "Show Reference List" on page 1405.  
----------------------------------------------------

On an Entity in the Main Window

----------------------------------------------------------
Search           "Search" on page 1403.                     
Search Again     "Search Again" on page 1404.               
Show Definition  "Show Definition" on page 1404. The same   
                 menu choice variations apply.              
Show References  "Show Reference List" on page 1405.        
----------------------------------------------------------

Keyboard Accelerators

Apart from the general keyboard accelerators, as described in "Accelerators and Mnemonics" on page 1048, the following accelerators can be used in the Main window:

--------------------------------------------
Accelerator  Command (page reference)         
--------------------------------------------
ctrl-E       Show Definition (see page 1404)  
--------------------------------------------

The References Window

The Drawing Area

The References window lists all cross references for an entity, i.e. links to places in the source diagrams where the entity is used. This is not applicable to MSC entities, meaning that the References window will be
empty for such entities.

The first two lines in the list show the type and name of the entity and the total number of references found.

The subsequent lines list the cross references, grouped by the type of object that is referenced in the diagrams. Each line contains the following:

An icon identifying the reference type (see "SDL Icons" on page 1394)
The reference type, in uppercase text form
The number of references of this type with an asterisk in front, if more than one reference exists

In the list, the reference types are sorted alphabetically.

Figure 440 : References Window. 
-----
(fig)  
       
-----

To double click on a reference symbol in the References window is the same operation as Show Reference in the Tools menu (see "Show Reference" on page 1409). If there are several cross references associated with the symbol, one of them is selected. If the user double clicks again, another cross reference is selected. The list of cross references associated with the reference symbol is traversed in a circular pattern.

The References window is updated when the selection in the Main window is changed. The References window is updated to show the cross references in the system for the entity selected in the Main window.

Quick Buttons

The following quick button is special to the References window. The general quick buttons are described in "Quick Buttons" on page 1035.

-------------------------------------------------------------------------
(fig)  Show in Editor                                                      
       Show the selected reference in an SDL Editor. The same as Show Ref  
       erence in the Tools menu; see "Show Reference" on page 1409.        
-------------------------------------------------------------------------

The Menu Bar

The File Menu

Figure 441 : The File Menu. 
-----
(fig)  
       
-----

Print

Prints the contents of the References window. The Print Utility is started; see chapter 29, The Print Utility for more information.

Close

Closes the References window without confirmation.

The View Menu

Figure 442 : The View Menu. 
-----
(fig)  
       
-----

Window Options

Sets options for which parts of the References window to show. The dialog controls whether to show the Tool Bar and the Status Bar.

Figure 443 : The Windows Options Dialog. 
-----
(fig)  
       
-----

The Tools Menu

Figure 444 : The Tools Menu. 
-----
(fig)  
       
-----

Show Reference

Opens an SDL Editor containing the specified reference of the selected symbol. The diagram symbol containing the reference becomes selected in the Editor.

The name and behavior of this menu choice depends on the number of references for the selected symbol:

If only one reference exists, that reference is shown in the Editor.
If more than one reference exist, a separate menu choice is available for the first 9 references: Show Reference 1, Show Reference 2, etc. The specified reference is shown in the Editor.
If more than 9 references exist, an additional menu choice Show Reference... is available. This menu choice opens a dialog in which the number of the reference can be specified:
```
Figure 445 : The Show Reference Dialog. 
-----
(fig)  
       
-----
```
- The number of the reference is specified by using the Slide Bar.
- Pressing the Show button shows the specified reference in the Editor.

--------------------------------------------------
Show Entity List  "Show Entity List" on page 1410.  
--------------------------------------------------

On a Cross Reference in the References Window

---------------------------------------------------------
Show Reference    "Show Reference" on page 1409.The same   
                  menu choice variations apply.            
Show Entity List  "Show Entity List" on page 1410.         
---------------------------------------------------------

Keyboard Accelerators

Apart from the general keyboard accelerators, as described in "Accelerators and Mnemonics" on page 1048, the following accelerators can be used in the References window:

-------------------------------------------
Accelerator  Command (page reference)        
-------------------------------------------
ctrl-E       Show Reference (see page 1409)  
-------------------------------------------

This page intentionally left blank

Footnotes

(1): The diagram header reads "SDL" even when a .xrf file generated by the MSC Editor is being processed.

Table of Contents

Next Chapter