COMPOPT

This system command is used to set various compilation options. The options are evaluated when a Natural object is compiled.

If you enter the COMPOPT command without any options, a screen is displayed where you can enable or disable the options described below.

The default settings of the individual options are set with the corresponding keyword subparameters of the parameter macro NTCMPO in the Natural parameter module or in the profile parameter CMPO. When you change the library, the COMPOPT options are reset to their default values.

This document covers the following topics:

• Syntax Explanation

• Specifying Compiler Keyword Parameters

• General Compilation Options

• Compilation Options for Version and Platform Compatibility

Syntax Explanation

Specifying Compiler Keyword Parameters

You can specify compiler keyword parameters on different levels:

1. The default settings of the individual keyword parameters are specified in the macro NTCMPO in the Natural parameter module.

2. At session start, you can override the compiler keyword parameters with the profile parameter CMPO.

3. During an active Natural session, there are two ways to change the compiler keyword parameters with the COMPOPT system command: either directly using command assignment (COMPOPT option=value) or by issuing the COMPOPT command without keyword parameters which displays the Compilation Options screen. The settings assigned to a compiler option are in effect until you issue the next LOGON command to another library. At LOGON, the default settings set with the macro NTCMPO and/or the profile parameter CMPO (see above) will be resumed. Example:

   OPTIONS KCHECK=ON
   DEFINE DATA LOCAL
   1 #A (A25) INIT <'Hello World'>
   END-DEFINE
   WRITE #A
   END

4. In a Natural object (for example: program, subprogram), you can set compiler parameters (options) with the OPTIONS statement. Example:

   OPTIONS KCHECK=ON
   WRITE 'Hello World'
   END

   The compiler options defined in an OPTIONS statement will only affect the compilation of this object, but do not update settings set with the command COMPOPT.

General Compilation Options

The following options are available:

• CHKRULE - Validate INCDIR Statements in Maps

• CPAGE - Code Page Support for Alphanumeric Constants

• DBSHORT - Interpretation of Database Short Field Names

• DB2ARRY - Support DB2 Arrays in SQL SELECT and INSERT Statements

• DB2BIN – Generate SQL Binary Data Types for Natural Binary Fields

• DB2PKYU – Place Primary Key Fields into the Natural DML UPDATE Statement

• DB2TSTI – Generate SQL TIMESTAMP Data Type for Natural TIME Fields

• ECHECK - Existence Check for Object Calling Statements

• GDASC - GDA Signature Check

• GFID - Generation of Global Format IDs

• KCHECK - Keyword Checking

• LOWSRCE - Allow Lower-Case Source

• MAXPREC – Maximum Number of Digits after Decimal Point

• MEMOPT - Memory Optimization for Locally Declared Variables

• PCHECK - Parameter Check for Object Calling Statements

• PSIGNF - Internal Representation of Positive Sign of Packed Numbers

• THSEP - Dynamic Thousands Separator

• TQMARK - Translate Quotation Mark

• TSENABL - Applicability of TS Profile Parameter

These options correspond to the keyword subparameters of the CMPO profile parameter and/or the NTCMPO parameter macro.

CHKRULE - Validate INCDIR Statements in Maps

The CHKRULE option can be used to enable or disable a validation check during the catalog process for maps.

CPAGE - Code Page Support for Alphanumeric Constants

The CPAGE option can be used to activate a conversion routine which translates all alphanumeric constants (from the code page that was active at compilation time into the code page that is active at runtime) when the object is started at runtime.

See also CPAGE Compiler Option in the Unicode and Code Page Support documentation.

DBSHORT - Interpretation of Database Short Field Names

A database field defined in a DDM is described by two names:

• the short name with a length of 2 characters, used by Natural to communicate with the database (especially with Adabas);

• the long name with a length of 3-32 characters (1-32 characters, if the underlying database type accessed is DB2/SQL), which is supposed to be used to reference the field in the Natural programming code.

Under special conditions, you may reference a database field in a Natural program with its short name instead of the long name. This applies if running in Reporting Mode without Natural Security and if the database access statement contains a reference to a DDM instead of a view.

The decision if a field name is regarded as a short-name reference depends on the name length. When the field identifier consists of two characters, a short-name reference is assumed; a field name with another length is considered as a long-name reference. This standard interpretation rule for database fields can additionally be influenced and controlled by setting the compiler option DBSHORT to ON or OFF:

Examples:

Assume the following data base field definition in the DDM EMPLOYEES:

Example 1:

OPTIONS DBSHORT=ON
READ EMPLOYEES 
  DISPLAY AA      /* data base short name AA is allowed
END

Example 2:

OPTIONS DBSHORT=OFF
READ EMPLOYEES 
  DISPLAY AA      /* syntax error NAT0981, because DBSHORT=OFF
END

Example 3:

OPTIONS DBSHORT=ON
DEFINE DATA LOCAL
1 V1 VIEW OF EMPLOYEES
  2  PERSONNEL-ID
END-DEFINE
READ V1 BY PERSONNEL-ID 
  DISPLAY AA     /* syntax error NAT0981, because PERSONNEL-ID is defined in view;
                 /* (even if DBSHORT=ON)
END-READ
END

DB2ARRY - Support DB2 Arrays in SQL SELECT and INSERT Statements

The DB2ARRY option can be used to activate retrieval and/or insertion of multiple rows from/into DB2 by a single SQL SELECT or INSERT statement execution. This allows the specification of arrays as receiving fields in the SQL SELECT and as source fields in the SQL INSERT statement. If DB2ARRY is ON, it is no longer possible to use Natural alphanumeric arrays for DB2 VARCHAR/GRAPHIC columns. Instead of these, long alphanumeric Natural variables have to be used.

DB2BIN – Generate SQL Binary Data Types for Natural Binary Fields

The DB2BIN option can be used to support the DB2 data types BINARY and VARBINARY.

If DB2BIN is set to OFF, Natural binary fields (format B(n)) are generated as SQL data type CHAR (n<= 253) or VARCHAR (253<n<=32767) like it was in previous releases. DB2BIN=OFF is good for those who used Natural binary fields like SQL CHAR fields. B2 and B4 are treated as SQL SMALLINT and INTEGER.

If DB2BIN is set to ON, Natural binary fields (format B(n)) are generated as SQL data type BINARY (n<=255) or VARBIN (255<n<=32767). DB2BIN=ON is good for those who want to use SQL binary columns. B2 and B4 are also treated as SQL BINARY(2) and BINARY(4).

Note:
The setting of DB2BIN at the end of the compilation is used for the complete Natural object. It cannot be changed for parts of a Natural object.

DB2PKYU – Place Primary Key Fields into the Natural DML UPDATE Statement

Only applies if supported by the Natural for DB2 version installed at your site.

The DB2PKYU option can be used to update DB2 primary key fields with a Natural DML UPDATE statement. DB2 primary key fields are fields whose short names begin with the character O in the DDM.

Note:
The setting of DB2PKYU at the end of the compilation is used for the complete Natural object. It cannot be changed for parts of a Natural object.

DB2TSTI – Generate SQL TIMESTAMP Data Type for Natural TIME Fields

This option is used to map Natural TIME variables to the SQL TIMESTAMP data type instead of the default SQL TIME data type.

Note:
A Natural TIME field only contains tenth of seconds as precision while a SQL TIMESTAMP column can contain a much greater precision. Thus, the TIMESTAMP value read from the SQL database may be truncated if DB2TSTI=ON is set.

ECHECK - Existence Check for Object Calling Statements

GDASC - GDA Signature Check

This option is used to store information on the structure of a GDA (global data area) to determine whether a Natural error is to be issued when an unchanged GDA is cataloged.

The GDA information (GDA signature) only changes when a GDA is modified. The GDA signature does not change when a GDA is (accidentally) cataloged but was not modified.

The signature of the GDA and the GDA signatures stored in all Natural objects referencing this GDA are compared at execution time, in addition to the time stamps of the objects.

GFID - Generation of Global Format IDs

This option allows you to control Natural's internal generation of global format IDs so as to influence Adabas's performance concerning the re-usability of format buffer translations.

For details on global format IDs, see the Adabas documentation.

Rules for Generating GLOBAL FORMAT-IDs in Natural

• For Natural nucleus internal system-file calls:

  GFID=abccddee

  where	equals
  a	x'F9'
  b	x'22' or x'21' depending on DB statement
  cc	physical database number (2 bytes)
  dd	physical file number (2 bytes)
  ee	number created by runtime (2 bytes)

• For user programs or Natural utilities:

  • GFID=abbbbbb

    where	equals
    a	x'F8' or x'F7' or x'F6' where: F6=UPDATE SAME F7=HISTOGRAM F8=all others
    bbbbbbb	bytes 1-7 of STOD value

  Note:
  STOD is the return value of the store clock machine instruction (STCK).

KCHECK - Keyword Checking

The section Performing a Keyword Check (in the Programming Guide) contains a list of the keywords that are checked by the KCHECK option.

The section Alphabetical List of Natural Reserved Keywords (in the Programming Guide) contains an overview of all Natural keywords and reserved words.

LOWSRCE - Allow Lower-Case Source

This option supports the use of lower or mixed-case program sources on mainframe platforms. It facilitates the transfer of programs written in mixed/lower-case characters from other platforms to a mainframe environment.

When you use lower-case characters with LOWSRCE=ON, consider the following:

• The syntax rules for variable names allow lower-case characters in subsequent positions. Therefore, you can define two variables, one written with lower-case characters and the other with upper-case characters.

  Example:

  DEFINE DATA LOCAL
  1 #Vari  (A20)
  1 #VARI  (A20)
  

  With LOWSRCE=OFF, these variables are treated as different variables.

  With LOWSRCE=ON, the compiler is not case sensitive and does not make a distinction between lower/upper-case characters. This will lead to a syntax error because a duplicate definition of a variable is not allowed.

• Using  the session parameter EM (Edit Mask) in an I/O statement or in a MOVE EDITED statement, there are characters which influence the layout of the data setting assigned to a variable (EM control characters), and characters which insert text fragments into the data setting.

  Example:

  #VARI :='1234567890'
    WRITE #VARI (EM=XXXXXxxXXXXX)
  

  With LOWSRCE=OFF, the output is "12345xx67890", because for alpha-format variables only upper-case X, H and circumflex accent (ˆ) sign can be used.

  With LOWSRCE=ON, the output is "1234567890", because an x character is treated like an upper-case X and, therefore, interpreted as an EM control character for that field format. To avoid this problem, enclose constant text fragments in apostrophes (').

  Example:

  WRITE #VARI(EM=XXXXX'xx'XXXXX)

  The text fragment is not considered an EM control character, regardless of the LOWSRCE settings.

• Since all variable names are converted to upper-case characters with LOWSRCE=ON, the display of variable names in I/O statements (INPUT, WRITE or DISPLAY) differs.

  Example:

  MOVE 'ABC' to #Vari
    DISPLAY #Vari
  

  With LOWSRCE=OFF, the output is:

         #Vari
    --------------------
    
    ABC
  

  With LOWSRCE=ON, the output is:

         #VARI
    --------------------
    
    ABC
  

MAXPREC – Maximum Number of Digits after Decimal Point

This option determines the maximum number of digits after the decimal point that the Natural compiler generates for results of arithmetic operations.

DEFINE DATA LOCAL
1 P (P1.15)
END-DEFINE
P := P + 0.1234567890123456
END

Warning: Changing the value of the MAXPREC option that is being used to catalog a Natural object may lead to different results, even if the object source has not been changed. See example below.

Example:

DEFINE DATA LOCAL
1 #R (P1.7)
END-DEFINE
#R := 1.0008 * 1.0008 * 1.0008
IF #R = 1.0024018 THEN ... ELSE ... END-IF

The value of #R after the computation and the execution of the IF statement depend on the setting of MAXPREC:

MEMOPT - Memory Optimization for Locally Declared Variables

This option determines whether or not memory is allocated for unused level-1 fields or groups defined locally (DEFINE DATA LOCAL).

PCHECK - Parameter Check for Object Calling Statements

PSIGNF - Internal Representation of Positive Sign of Packed Numbers

THSEP - Dynamic Thousands Separator

This option can be used to enable or disable the use of thousands separators at compilation time. See also the profile and session parameter THSEPCH and the section Customizing Separator Character Displays (in the Programming Guide).

TQMARK - Translate Quotation Mark

Example:

RESET A(A5)                    
A:= 'AB"CD'                    
WRITE '12"34' / A / A (EM=H(5))
END

With TQMARK ON, the output is:

12'34     
AB'CD     
C1C27DC3C4

With TQMARK OFF, the output is:

12"34     
AB"CD     
C1C27FC3C4

TSENABL - Applicability of TS Profile Parameter

This option determines whether the profile parameter TS (translate output for locations with non-standard lower-case usage) is to apply only to Natural system libraries (that is, libraries whose names begin with "SYS", except SYSTEM) or to all user libraries as well.

Natural objects cataloged with TSENABL=ON determine the TS parameter even if they are located in a non-system library.

Compilation Options for Version and Platform Compatibility

The following options are available:

• MASKCME - MASK Compatible with MOVE EDITED

• LUWCOMP - Disallow Syntax Not Available on UNIX or Windows

These options correspond to the keyword subparameters of the CMPO profile parameter and/or the NTCMPO parameter macro.

MASKCME - MASK Compatible with MOVE EDITED

LUWCOMP - Disallow Syntax Not Available on UNIX or Windows

The LUWCOMP option checks whether the syntax of the features provided since Natural for Mainframes Version 8.2 is also supported by Natural for UNIX Version 8.3 and Natural for Windows Version 8.3. If any syntax incompatibilities between the mainframe and UNIX or Windows are detected, compilation under Natural for Mainframes Version 8.2 fails with an appropriate Natural error message and reason code.

The following values are possible:

Reason Codes for Syntax Errors

The following reason codes indicate which syntax parts are not supported by UNIX or Windows:

DEFINE DATA LOCAL
  1 #P(P5.8)

OPTIONS MAXPREC=10

MOVE ALL 'X' TO SUBSTR(#A, 3, 5)

READ WORK FILE 1 #XARR(*) AND ADJUST

REINPUT 'text' MARK *#FLD (CV=#C)

SEPARATE #TEXT(*) INTO ...