IBM
Contents Index Previous Next



Description of Analyzer Commands


In this section, the Analyzer commands are listed in alphabetical order, along with their parameters and a description.

Alphabetical List of Commands

! (shell escape)

Parameters:

<operating system command>

Escape to the shell to do command.

Add-Input

Parameters:

<Filespec>

Add a file to the list of files to be converted to PR. The file will be processed according to the setting of Input-Mode.

Analyze

Parameters:

(None)

This command orders the Analyzer to perform the passes according to the Analyzer options as they are defined.

Hint:

The current analysis options can be printed using the command
Show-Analyze-Options (see Show-Analyze-Options).

The order in which the passes are performed is:

  1. Conversion to PR, if the input is C header, ASN.1 or SDL/GR diagrams.
  2. Macro expansion (optional).
  3. Syntactic analysis (optional).
  4. Pretty-printing of a PR file (optional).
  5. PR to GR conversion (optional). This pass converts an SDL/PR input file to SDL/GR diagrams, using the native format of the SDL Suite.
  6. Semantic analysis (optional).
  7. Cross reference generation (optional).

Note:

The Analyzer may need to be reset (using the New or Clear command) between subsequent Analyze commands, since the Analyzer keeps track of what passes have been performed in order to minimize analysis time.

ASN1-Coder-Name

Parameters:

<name>

The prefix of encode and decode functions for ASN.1 types. Default is BER.

ASN1-Keyword-File

Parameters:

<file>

Change keywords in files output by asn1util according to file. Default is no file, in this case the keywords in file asn1util_kwd.txt in the SDT installation is used.

Asn1Util

Parameters:

<options>

Invoke asn1util through the post master. Same options as the command line interface.

Cd

Parameters:

<directory>

Change current working directory to <directory>.

Clear

Parameters:

(None)

Force the Analyzer to perform all passes from scratch as defined in the Analyzer options on the previously selected input. See also the New command described in New.

Coder-Buffer-In-Sdl

Parameters:

Octet-String | Coder-Buf | Custom-Coder-Buf | None

Pick representation of ASN.1 Buffer in SDL, None means no encoding available in SDL. Default is Octet-String. For more information see Buffer Management System.

ComplexityMeasurement-File

Parameters:

[<file spec>]

Specifies where the complexity measurements file is stored if the Set-ComplexityMeasurement command is set.

Default is <system name>.csv.

See Complexity Measurements for more information.

Component

Parameters:

[<SDL qualifier>]

Add a new item to a program. See Partitioning.

Cpp2sdl

Parameters:

<options>

Invoke cpp2sdl through the post master. Same options as the command line interface.

Env-Header-Channel-Name

Parameters:

[<name>]

Configuration of channel names in environment header file (.ifc). %n is the name of the entity in SDL, %s is the name of the scope. Omit <name> to exclude the definitions completely from the file. Default is %n.

Env-Header-Literal-Name

Parameters:

[<name>]

Configuration of literal names in environment header file (.ifc). %n is the name of the entity in SDL, %s is the name of the scope. Omit <name> to exclude the definitions completely from the file. Default is %n.

Env-Header-Operators

Parameters:

[On/Off]

Configure if operators should be present in environment header file (.ifc). Default is On.

Env-Header-Signal-Name

Parameters:

[<name>]

Configuration of signal names in environment header file (.ifc). %n is the name of the entity in SDL, %s is the name of the scope. Omit <name> to exclude the definitions completely from the file. Default is %n.

Env-Header-Synonym-Name

Parameters:

[<name>]

Configuration of synonym names in environment header file (.ifc). %n is the name of the entity in SDL, %s is the name of the scope. Omit <name> to exclude the definitions completely from the file. Default is %n.

Env-Header-Type-Name

Parameters:

[<name>]

Configuration of type names in environment header file (.ifc). %n is the name of the entity in SDL, %s is the name of the scope. Type definitions are always present in the file. Default is %n.

Error-File

Parameters:

[<file spec>]

An optional file to store analyzer messages in. Default is no error file.

Exit

Parameters:

(None)

Terminates the Analyzer and returns you to the Operating System prompt.

Filter

Parameters:

[Command]

This command allows filtering or preprocessing files before they are read by the Analyzer. The command should be an executable file, preferably found in $PATH. The Analyzer appends three parameters to the supplied command. The first parameter is the name of the file, the second parameter tells what the Analyzer is about to do with the file, and the third is the Source Directory. Currently the following are available:

The command is supposed to modify the file given in the parameter and leave the result in the same file. Note that the files passed are your original files.

Generate-Advanced-C

Parameters:

(None)

This command invokes the Cadvanced SDL to C Compiler, which will produce one / multiple C program(s), as well as a makefile. This C program is then compiled and linked in order to build up an executable application. The Cadvanced SDL to C Compiler uses the options which have been previously defined using the various Generate Options commands. See also Generate-Basic-C.

Generate-Basic-C

Parameters:

(None)

This command invokes the Cbasic SDL to C Compiler, which will produce one / multiple C program(s), as well as a makefile. This C program is then compiled and linked in order to build up an executable application. The Cbasic SDL to C Compiler uses the options which have been previously defined using the various Generate Options commands. This command cannot be used when building applications, but otherwise it is identical to Generate-Advanced-C.

Generate-Micro-C

Parameters: 1

(None)

This command invokes the Cmicro SDL to C Compiler, which will produce one / multiple C program(s), as well as a makefile. This C program is then compiled and linked in order to build up an executable application. The Cmicro SDL to C Compiler uses the options which have been previously defined using the various Generate Options commands. See also Generate-Advanced-C.

GR-PR-File

Parameters:

[<file spec>]

This command specifies where the output of the conversion to PR pass is stored. Default is <infile>.pr.

GR2PR

Parameters:

<GR-File> <PR-File>

The command converts the file designated by the file specifier GR-File to a textual (i.e. PR) description of the diagram, storing the results in the file designated by the file specifier PR-File.

The file GR-File should contain an SDL diagram stored in binary format.

Help

Parameters:

[Command]

The command issues on-line help for the Analyzer commands. Depending on if a command is specified or not, the following happens:

You can abbreviate any topic name, although ambiguous abbreviations result in all matches being displayed.

Include-Directory

Parameters:

[<directory>]

Where the analyzer looks for include files. An empty <directory> clears the list.Subsequent commands adds more directories to the list. Default is an empty list.

Include-File

Parameters:

<file spec>

Execute analyzer commands in <file spec>.

Include-Map

Parameters:

<logical name> <file spec>

Maps logical names to file names for graphical includes when converting graphical SDL (GR) to text (PR). This command should be preceded by commands to specify input mode to GR and a GR file. Subsequent commands adds more maps to the list. Default is an empty list.

Input-Mode

Parameters:

ASN.1 | C-Header | GR | PR

Select filter to convert input to PR. Default is PR.

Instance-File

Parameters:

[<file spec>]

Where the instance tree is stored. Default is <system name>.ins. See SDL Instance Information for more information.

Macro-PR-File

Parameters:

[<file spec>]

This command specifies where the output of the macro expander is stored. Default is <infile>.prm.

Make-File

Parameters:

[<file spec>]

Name of makefile. Default is <system name>.m.

Make-Template-File

Parameters:

[<file spec>]

Name of make template file. Default is no template.

New

Parameters:

(None)

This command initializes the Analyzer. Following the New command, you will need to specify an input to the Analyzer using the Set-Input command.

See also Clear.

Operating-System

Parameters:

(None)

Creates a subprocess which returns you temporarily to the Operating System. Once you terminate this process, control is returned to the Analyzer.

Organizer-Object

Parameters:

Level Type Name File Sep SepName Selected [Depend]

Pass the Organizers info on a diagram to the Analyzer. This command is used by the Organizer.

Pretty-PR-File

Parameters:

<Filespec>

This command specifies where the output of the pretty printer is stored. Default is <infile>.sdl.

Program

Parameters:

[<name>]

Name of program built from components. See Partitioning.

Quit

Parameters:

(None)

Synonym for exit.

SDL-Coder-Name

Parameters:

<name>

The prefix of encode and decode functions for SDL types. Default is ASCII.

SDL-Keyword-File

Parameters:

[<file spec>]

Produce a list of SDL keywords and SDT Ref in a file. Default is no list.

SDT-Ref

Parameters:

[<sdt ref>]

Use <sdt ref> in error messages from command parser overriding any other <sdt ref>.

SDT-SYSTEM-6.3

Parameters:

(None)

The Organizer uses this to make sure the right version of the analyzer is running.

Set-ASN1-Coder

Parameters:

[On/Off]

Generates encoder and decoder from ASN.1 modules (requires separate license).

Default is off.

Set-C-Compiler-Driver

Parameters:

[On/Off]

This option informs the SDL to C compilers if the SDL C Compiler Driver should be invoked. See SDL C Compiler Driver (SCCD).

Default is off.

Set-C-Plus-Plus

Parameters:

[On/Off]

SDL to C compilers generate code to be compiled with C++ compiler if on. Default is off.

Set-Case-Sensitive

Parameters:

[On/Off]

Case sensitive SDL names if On. Keywords must be all upper or lower case if on.

Default is off.

Set-Compile-Link

Parameters:

[On/Off]

This option informs the Code Generator (SDL to C compilers) whether the generated code should be compiled and linked automatically (by executing the generated makefile).

Default is on.

Set-ComplexityMeasurement

Parameters:

[On/Off]

This option will generate a complexity measurement file. Following the Set-ComplexityMeasurement command, you may specify a file name using the ComplexityMeasurement-File command.

Default is off.

See Complexity Measurements for more information.

Set-Echo

Parameters:

[On/Off]

This option will print (echo) all Analyzer commands as they are executed. Default is off.

Set-Env-Function

Parameters:

[On/Off]

This option informs the code generators (SDL to C compilers) if environment functions should be generated or not.

Default is off.

Set-Env-Header

Parameters:

[On/Off]

This option is applicable to the SDL to C compilers only. With this parameter turned on, a header file containing the definitions of the SDL system's interface to the environment is created. This file is identified by the .ifc file name extension.

Default is off.

Set-Error-Limit

Parameters:

<Errorlimit>

This command sets the limit of reported errors after which the Analyzer will stop its execution. Use 0 to turn off the limit.

Default is a limit of 30 diagnostics.

Set-Expand-Include

Parameters:

[On/Off]

This option specifies whether include directives should be handled and expanded when reading input files. See Including PR Files.

Default is on.

Set-Expression-Limit

Parameters:

<Depth>

This command instructs the Analyzer to issue a warning when the semantic analyzer encounters an SDL expression which is at least Depth deep.

Note:

Deeply nested expressions may cause a significant degradation of performance when performing the semantic analysis pass. It is therefore recommended to break down complex expressions into multiple, less complex expressions.

Default is 0, meaning that no warnings will be issued.

Set-External-Type-Free-Function

Parameters:

[On/Off]

This option informs the code generators if GenericFree should be called for variables of externally defined types (of struct kind).

Default is on.

Set-File-Prefix

Parameters:

[<file name prefix>]

Prefix for files generated by the code generators. Default is no prefix.

Set-Full

Parameters:

[On/Off]

Redo everything if on. Default is off.

Set-Generate-All-Files

Parameters:

[On/Off]

Existing files will not be touched by C code generators if the new version is identical to the existing one and this option if Off. Default is On.

Set-Ignore-Hidden

Parameters:

[On/Off]

Decides if PR should be generated for hidden SDL symbols. Default is On.

Set-Implicit-Type-Conversion

Parameters:

[On/Off]

When this option is on, the Analyzer allows implicit type conversion of reference data types (generators Own, ORef, and Ref). Note that analyzing large expressions with this option on is slow. Default is off.

For more information, see Implicit Type Conversions.

Set-Input

Parameters:

<Filespec>

The Analyzer will use the file specified in filespec as input file. The file will be processed according to the setting of Input-Mode (see Input-Mode). Use Add-Input to process a system stored in several files.

Set-Instance

Parameters:

[On/Off]

With this option on, a file containing the SDL instance tree will be generated. Default is off. See SDL Instance Information for more information.

Set-Kernel

Parameters:

<Kernel>

This option is applicable to the SDL to C compilers only. This option allows you to select the appropriate kernel with predefined runtime libraries. The makefile generated by the SDL to C compilers contains instructions which link the generated and compiled code with object modules of the selected library. The effect of this will be that the code which is generated by the SDL to C compilers will have different properties, reflecting the purpose of its usage (simulation, application generation, etc.). The allowed values of the parameter kernel vary from one configuration to another. The definitions are made in the file sdtsct.knl. The definitions for Cadvanced are made in the file sdtsct.knl, whereas the definitions for Cmicro are made in the file scmsct.knl.

The following values are recognized for Cadvanced:

Library Application area
SCTADEBCOM

Simulation, simulated time

SCTADEBCLCOM

Simulation, real time

SCTAPERFSIM

Performance simulation

SCTAAPPLCLENV

Application

SCTADEBCLENV

Application debug (simulation with environment, only Cadvanced)

SCTAVALIDATOR

Validation

SCTATTCNLINK

TTCN link

The following values are recognized for Cmicro:

Library Application area
SCMADEBCOM

SDL Target Tester and communication, no real time clock

SCMADEBCLCOM

SDL Target Tester, communication and real time clock

SCMADEBCLENVCOM

SDL Target Tester, communication, user's env and real time clock

SCMAAPPLCLENVMIN

Application with environment, clock, etc.

SCMAAPPLCLENV

Evaluation Kernel (no complex ADT; no SDL Target Tester)

Note:

The predefined kernels for Cmicro cannot be used with any C compiler. They require GCC 2.95.2 on UNIX or Microsoft Visual C++ 6.0 in Windows.

Set-Lower-Case

Parameters:

[On/Off]

SDL does not distinguish between lower case letters (a..z) and upper case letters (A..Z), but the high level programming language C does. With this parameter turned on, the names of, for instance, variables in the generated C code is written in lower case letters only. Otherwise, the case of an item in the SDL definition is used.

Default is off.

Set-Macro

Parameters:

[On/Off]

Turns on or off the macro expansion pass. This option must be turned on if your diagram contains references to macro(s).

Default is off.

Set-Make

Parameters:

[On/Off]

This command affects an option which enables or disables the generation of a makefile in conjunction with generation of C code.

Default is on.

Set-Modularity

Parameters:

[Modularity]

Allows to specify the modularity of the code generated by the code generators, e.g. the SDL to C compilers. This option affects how many files will be generated.

Three options for the parameter Modularity are available:

Default value is No.

Set-Optional-Make-Operator

Parameters:

[On/Off]

Optional and default struct parameters are included in the make operator (invoked by (. .)) if On. Default is Off.

Set-Output

Parameters:

<Filespec>

Allows you to save the information generated by the Analyzer in files with a different name, using Filespec as the base name.

File name extensions are appended automatically by the Analyzer.

Set-Pr2Gr

Parameters:

[On/Off]

Turning this option on, the Analyzer will perform the PR to GR conversion pass. The steps are:

  1. The Analyzer creates diagram files with temporary names.
  2. The Analyzer lets the SDL Editor do tidy up on the diagram files.
  3. The Organizer renames/moves diagram files according to its preference.

Step 3 is only performed when a PR to GR conversion is run from the Organizer. The request to put temporary files in the current working directory is ignored on the Windows platform (they end up in some temp directory).

Default is off.

Set-Predefined-XRef

Parameters:

[On/Off]

Include predefined data in SDL cross reference file if On. Default is Off.

Set-Prefix

Parameters:

[Prefix]

Allows you to specify what prefix the code generators add to SDL names in the generated code.

Possible values for the parameter prefix are:

Default is Full.

Set-Pretty

Parameters:

[On/Off]

Turning this switch on, a pretty printed PR file will be generated.

Default is off.

Set-References

Parameters:

[On/Off]

This option allows you to disable the verification that exactly one reference corresponds to each remote definition.

Default is on.

Set-SDL-Coder

Parameters:

[On/Off]

Generate encoder and decoder from SDL (requires separate license).

Default is off.

Set-Sdt-Ref

Parameters:

[On/Off]

Decides if SDT references should be included in the generated code as comments for easier navigation to its source. As default, SDT references in comments are included. Note that omitting SDT references in comments by using this command is not supported by standard IBM Rational code generators.

Set-Semantic

Parameters:

[On/Off]

With this option turned on, the semantic check pass will be performed. Otherwise, the Analyzer will stop after the syntactic check.

Default is on.

See also Optimizing a System to Reduce Analysis Time.

Set-Signal-Number

Parameters:

[On/Off]

Code generators will generate a file with signal numbers if on.

Default is off

Set-Source

Parameters:

[On/Off]

This command informs the code generators whether to generate C code or not when a generate code command is given. The reason for disabling code generation is that you may want to produce a makefile only, without generating code.

Default is on.

Set-Synonym

Parameters:

[On/Off]

Decides if the specified synonym file should be used or not. Default is Off.

Set-Syntax

Parameters:

[On/Off]

This option turns on or off the syntax analysis pass.

Default is on.

Set-TAEX-Make

Parameters:

[On/Off]

This command controls the generation of a makefile for Targeting Expert in conjunction to generation of C code.

Default is off.

Set-Upcase-Keyword-Pretty

Parameters:

[On/Off]

Select between upper or lower case keywords in pretty printings.

Default is off (i.e. lower case letters).

Set-Warn-Else-Answer

Parameters:

[On/Off]

Print a message if a decision or transition option does not have an else answer and the Analyzer is unable to decide that it is not needed.

Default is on.

Set-Warn-Match-Answer

Parameters:

[On/Off]

Print a message if a decision or transition option does not have an answer for some value. The analyzer is not able to do this in all situations.

Default is on.

Set-Warn-Parameter-Mismatch

Parameters:

[On/Off]

Print a message if the types of the actual and formal parameters are implemented with different typedef, i.e. they may be of different size. This is only checked for functions that cannot handle length mismatch. No warning is given if the actual parameter is a literal.

Default is on.

Set-Warn-Optional-Parameter

Parameters:

[On/Off]

Print a message if an optional actual parameter is omitted.

Default is on.

Set-Warn-Output

Parameters:

[On/Off]

Print a warning message if an SDL signal output has a different semantic meaning between SDL 88 and 92.

Default is on.

Note:

This command is particularly useful when working with SDT 2.X diagrams in an SDT 3.X environment (SDT 2.X supports SDL-88, while SDT 3.X supports SDL-92).

Set-Warn-Parameter-Count

Parameters:

[On/Off]

Print a message if trailing actual parameters are omitted.

Default is on.

Set-Warn-Usage

Parameters:

[On/Off]

Print a message if an SDL definition is not used.

Default is off.

Set-Xref

Parameters:

[On/Off]

With this option on, a file containing SDL Cross References will be generated. See SDL Cross-References.

Default is off.

Show-Analyze-Options

Parameters:

(None)

This command lists the current Analyzer options.

Show-Commands

Parameters:

(None)

Similar to Help. The commands are listed without the command parameters.

Show-Generate-Options

Parameters:

(None)

This command displays the code generator options as currently defined.

Show-License

Parameters:

(None)

This command returns information about:

Show-Version

Parameters:

(None)

This command displays the version number of the Analyzer.

Source-Directory

Parameters:

[<directory>]

The analyzer looks for include files in this directory.

Default is current working directory.

Synonym-File

Parameters:

[<file spec>]

Specifies the synonym file (containing values of external synonyms). Default is no synonym file.

TAEX-Make-File

Parameters:

[<file spec>]

Name of makefile for Targeting Expert. See Set-TAEX-Make.

Target-Directory

Parameters:

[<directory>]

Specifies the directory where the code generators puts their files.

Default is current working directory.

Thread

Parameters:

<name> <stacksize> <stackprio> <maxqueuesize> 
<maxmessize>

Use this command to distribute components of a program over several threads. Components following this command belongs to this thread. Parameters at the end may be omitted. Omitted parameters will use default values. The word default can be used to indicate that the default value is desired for a parameter. For more information see Threaded Integration.

XRef-File

Parameters:

[<file spec>]

Specifies where the cross references are stored.

Default is <infile>.xrf.

Miscellaneous Analyzer Commands

The following commands can be used for instance in the case of malfunction or unexpected behavior. They are not described further within the scope of the user documentation.

zzMake-Options

Parameters:

(None)

zzSet-Access-Path-Tab

Parameters:

(None)

zzSet-Optimize

Parameters:

(None)

zzSet-Organizer-File

Parameters:

(None)

zzSet-Over-View

Parameters:

(None)

zzSet-SDT

Parameters:

(None)

zzSet-Verbose

Parameters:

(None)

zzSet-Warn-Oper-Usage

Parameters:

(None)

zzShow-Error

Parameters:

(None)

zzShow-Organizer

Parameters:

(None)

zzTransport

Parameters:

(None)

zzWrite-Name-List

Parameters:

(None)

zzWrite-Path

Parameters:

(None)

zzWrite-Pretty

Parameters:

(None)

zzWrite-Symbol

Parameters:

(None)

zzWrite-Syntax

Parameters:

(None)

1

The exact syntax is subject to change since the tool is still under development.


http://www.ibm.com/rational
Contents Index Previous Next