13.18.40.1 General

The PICTURE clause describes the General characteristics, editing requirements, and format validation profile of an elementary item.

13.18.40.2 General formats

Format 1 (basic):

Format 2 (locale):

13.18.40.3 Syntax rules

13.18.40.4 General rules

ALL FORMATS

1. When the usage of the subject of the entry is national, each symbol representing a character position defines a national character position. When the usage of the subject of the entry is display, each symbol representing a character position defines an alphanumeric character position.
2. The value of insertion and replacement characters in a resultant edited item is the value of those characters in the computer's runtime coded character set. When the usage of the item being edited is national, the value is the national character representation; otherwise, the value is the alphanumeric character representation.

FORMAT 1

3. A PICTURE clause defines the subject of the entry to fall into one of the following categories of data:

   • alphabetic
   • alphanumeric
   • alphanumeric-edited
   • boolean
   • national
   • national-edited
   • numeric
   • numeric-edited

   A BLANK WHEN ZERO clause specified for the subject of the entry defines the item as numeric-edited.

4. The size in boolean positions or character positions of an elementary data item that has been defined with a PICTURE clause is determined by the number of symbols in character-string-1 that represent either boolean positions or character positions.
5. To define an item as alphabetic, character-string-1 shall contain only one or more occurrences of the symbol 'A'.

6. To define an item as alphanumeric, character-string-1 shall contain a combination of symbols from the set 'A', 'X', and '9', that includes

   • at least one symbol 'X', or
   • at least two different symbols from this set.

7. To define an item as alphanumeric-edited, character-string-1 shall include

   • at least one symbol 'A' or one symbol 'X', and
   • at least one instance of character-1 or one of the symbols from the set 'B', '0', '/'.
8. To define an item as boolean, character-string-1 shall contain only one or more occurrences of the symbol '1'.
9. To define an item as national, character-string-1 shall contain only one or more occurrences of the symbol 'N'.

10. To define an item as national-edited, character-string-1 shall include

    • at least one symbol 'N', and
    • at least one instance of character-1 or one of the symbols from the set 'B', '0', '/'.

11. To define an item as fixed-point numeric, character-string-1

    • shall include at least one symbol '9', and
    • may contain a combination of symbols from the set 'P', 'S', and 'V'.
12. In the following general rules, for a PICTURE clause with the FOR phrase all references to ‘+’ apply to POSITIVE is literal-2, and all references to ‘-’ apply to NEGATIVE IS literal-3 unless otherwise indicated.

13. To define an item as numeric-edited, one of the following options shall be specified:

    1. To define a fixed-point numeric-edited item, character-string-1 shall include:

       • at least one symbol 'Z'; or
       • at least one symbol '*'; or
       • at least two identical symbols from the set '+', '-', currency symbol; or
       • at least one symbol '9' and at least one instance of character-1 or at least one of the symbols from the set 'B', 'CR', 'DB', '0', '/', ',', '.', '+', '-', the currency symbol.

    2. To define a floating-point numeric-edited item, characters-string-1 shall consist of two parts, separated without any spaces, by the symbol 'E'. The first part represents the significand; the second part represents the exponent.

       The significand shall be a valid character-string for either a numeric item or a numeric-edited item for a fixed-point result. Neither floating insertion editing nor zero suppression with replacement shall be specified for the significand.

       The exponent shall be '+9', '+99', '+999', '+9999', or '+9(n)' where n = 1, 2, 3, or 4.

14. The meaning of the symbols used in character-string-1 are as follows:

    A

    Each symbol 'A' represents a character position that shall contain any character from the computer's alphanumeric character set. Each symbol 'A' is counted in the size of the item.

    The characters represented may be graphic characters or non-graphic characters.

    NOTE 1 The symbol ‘A’ is equivalent to the symbol ‘X’ except within the execution of a VALIDATE statement. The meaning of the symbol ‘A’ within the VALIDATE statement is specified in General rule 15, below.

    B

    Each symbol 'B' represents a character position into which the character space will be inserted during editing. Each symbol 'B' is counted in the size of the item.

    E

    The symbol 'E' represents a character position into which the character 'E' will be inserted during editing. The symbol 'E' is counted in the size of the item.

    The symbol 'E' is used to separate the significand and the exponent of a floating-point numeric-edited item.

    N

    Each symbol 'N' represents a national character position that shall contain a character from the computer's national character set. Each symbol 'N' is counted in the size of the item.

    P

    The symbol 'P' specifies the location of an assumed decimal point when that point is not within the number that appears in the data item. The symbol 'P' is not counted in the size of the item, but each symbol 'P' is counted in the maximum number of digit positions.

    The symbol 'P' implies an assumed decimal point that is either

    • to the left of the string of 'P's if they indicate the leftmost digit positions in character-string-1; or
    • to the right of the string of 'P's if they indicate the rightmost digit positions in character-string-1.

    In certain operations that reference a data item whose picture character-string contains the symbol 'P', the algebraic value of the data item is used rather than the actual value of the data item. This algebraic value assumes the decimal point in the prescribed position and zero in place of each digit position specified by the symbol 'P'. The size of the value is the number of digit positions represented by the picture character-string.

    The operations that use the algebraic value are the following:

    1. Any operation requiring a numeric sending operand.
    2. An elementary move operation where the sending operand is numeric and its picture character-string contains one or more symbols 'P'.
    3. A move operation where the sending operand is numeric-edited, its picture character-string contains one or more symbols 'P', and the receiving operand is numeric or numeric-edited.
    4. A comparison operation where both operands are numeric.

    In all other operations, the digit positions specified with the symbol 'P' are ignored and are not counted in the size of the operand.

    S

    The symbol 'S' indicates the presence, but neither the representation nor, necessarily, the position of an operational sign. For usages display and national, the symbol 'S' is counted in the size of the item only when the subject of the entry is described with a SIGN clause with the SEPARATE phrase. For other numeric usages, the effect of the 'S' is described in the rules for the USAGE clause.

    V

    The symbol 'V' indicates the position of the assumed decimal point for alignment purposes. The symbol 'V' is not counted in the size of the item.

    When the assumed decimal point position is to the right of the rightmost digit position, the symbol 'V' is redundant.

    X

    Each symbol 'X' represents a character position that shall contain any character from the computer's alphanumeric character set. Each symbol 'X' is counted in the size of the item.

    The characters represented may be graphic characters or non-graphic characters.

    Z

    Each symbol 'Z' represents a leading numeric position that during editing will contain a numeric character in the range 0 through 9, or a character space when the content of that position is a leading zero. Each symbol 'Z' is counted in the size of the item.

    0

    Each symbol '0' (zero) represents a character position into which the character zero will be inserted during editing. Each symbol '0' is counted in the size of the item.

    1

    Each symbol '1' represents a boolean position that shall contain a boolean character. Each boolean character can be represented in storage as a bit, an alphanumeric character, or a national character. Each symbol '1' is counted in the size of the item.

    9

    Each symbol '9' represents a decimal digit position of the value of the item. For usages display and national, each '9' represents a character position that shall contain a numeric character in the range 0 through 9 with the possible inclusion of an operational sign; each '9' is counted in the size of the item. For other numeric usages, the effect of the number of '9's is described in the rules for the USAGE clause.

    /

    Each symbol '/' (slant) represents a character position into which the character slant will be inserted during editing. Each symbol '/' is counted in the size of the item.

    ,

    Each symbol ',' (comma) represents a character position into which the character comma will be inserted during editing. Each symbol ',' is counted in the size of the item.

    .

    The symbol '.' (period) represents a character position into which the character period will be inserted during editing. The symbol '.' is counted in the size of the item.

    In addition, the symbol '.' indicates the decimal point position for alignment purposes.

    + – CR DB

    These symbols represent the character position(s) into which the editing sign control character(s) is (are) placed during editing. Each character used in the symbol is counted in the size of the item.

    *

    Each symbol '*' represents a leading numeric position that during editing will contain a numeric character in the range 0 through 9, or a character asterisk when the content of that position is a leading zero. Each symbol '*' is counted in the size of the item.

    cs

    A currency symbol represents character positions into which the currency string will be placed during editing. A currency symbol is represented in character-string-1 either by the currency sign or by the currency symbol specified in a CURRENCY SIGN clause in the SPECIAL-NAMES paragraph.

    The first occurrence of the currency symbol adds the number of characters in the currency string to the size of the item. Each subsequent occurrence of the currency symbol adds one to the size of the item.

    es

    Character-1 in character-string-1 represents a character position into which the associated literal-1, literal-2, or literal-3 is to be placed. If character-1 is a simple insertion symbol or a fixed insertion symbol, the size of literal-1 is counted in the size of the item. For fixed editing sign control symbols, each character used in the symbol is counted in the size of the item. For extended editing sign control symbols with fixed insertion, each occurrence of the character(s) specified in the associated literal are counted in the size of the item. For floating inserting, one occurrence of literal-2 or literal-3 is counted in the size of the item plus one character for each repetition of character-1.

    NOTE 2 If reference modification is used to reference part of a data item described with floating extended editing sign control symbols, care is needed to account for the repetitions.

15. The PICTURE clause takes effect during the format validation stage of the execution of a VALIDATE statement that refers directly or indirectly to the subject of the entry.

    [Validation rules omitted.]

FORMAT 2

16. Format 2 of the PICTURE clause defines the item to be fixed-point numeric-edited.
17. The number of character positions in the item is specified by integer-1.

18. The meaning of the symbols used in character-string-1 are as follows:

    Z

    Each symbol 'Z' represents a leading numeric position that during editing will contain a numeric character in the range 0 through 9, or a character space when the content of that position is a leading zero.

    9

    Each symbol '9' represents a digit position that shall contain a numeric character in the range 0 through 9.

    .

    The symbol '.' (period) represents a character position into which the decimal separator taken from the locale will be inserted during editing.

    In addition, the symbol '.' indicates the decimal point position for alignment purposes.

    +

    The symbol '+' indicates that the item is to be signed in accordance with the specifications in the locale. If the symbol '+' is not specified, the item will be unsigned.

    cd

    The currency symbol indicates that the item is to include a currency string in accordance with the specifications in the locale.

19. The PICTURE clause takes effect during the format validation stage of the execution of a VALIDATE statement that refers directly or indirectly to the subject of the entry. The validation is carried out in accordance with the character classification and monetary specification in the locale.

13.18.40.5 Editing rules

FORMAT 1

1. There are two methods of performing editing: either insertion or suppression with replacement.

   There are four types of insertion editing:

   • simple insertion
   • special insertion
   • fixed insertion
   • floating insertion

   There are two types of suppression with replacement:

   • zero suppression with replacement with spaces
   • zero suppression with replacement with asterisks

2. The type of editing that may be performed upon an item is dependent upon the category to which the item belongs. Table 7, Category and type of editing, specifies which type of editing may be performed upon a given category:

   Table 7 — Category and type of editing

   Category	Type of editing
   Alphabetic	None
   Alphanumeric	None
   Boolean	None
   National	None
   Numeric	None
   Alphanumeric-edited	Simple insertion
   National-edited	Simple insertion
   Numeric-edited (fixed-point edited result)	All
   Numeric-edited (floating-point edited result)	Simple insertion, special insertion, and fixed insertion for the significand part None for the exponent part

3. Simple insertion editing

   Character-1 and the symbols 'B', '0', '/', ',' and, if literal-1 is specified, character-1 are used as the simple insertion editing symbols.

   Simple insertion editing results in the insertion character occupying the same character position in the edited item as the associated symbol occupies in character-string-1.

4. Special insertion editing

   The symbol '.' is used as the special insertion editing symbol.

   Special insertion editing results in the period character occupying the same character position in the edited item as the symbol '.' occupies in character-string-1.

5. Fixed insertion editing

   Character-1, the currency symbol and the editing sign control symbols '+', '-', 'CR' and 'DB' are used as the fixed insertion editing symbols.

   Fixed insertion editing results in the insertion character(s) occupying the same character position(s) in the edited item as the associated symbol occupies in character-string-1.

   When character-1 is used, and is not a simple insertion character, it represents literal-2, or literal-3 as the insertion characters.

   Table 8, Results of fixed insertion editing, shows the character(s) produced by an editing sign control symbol, depending on the value of the data item.

   Table 8 — Results of fixed insertion editing

   Editing symbol	Result
   	Positive or zero value	Negative value
   +	+	–
   –	space	–
   CR	2 spaces	CR
   DB	2 spaces	DB
   character-1, NEGATIVE phrase	literal-2	literal-2 or spaces
   character-1, POSITIVE phrase	literal-3 or spaces	literal-3
   Literal-2 or literal-3 or spaces means one instance of literal-2 or literal-3 or as many spaces as there are characters in literal-2 or literal-3.

   The uppercase letters CR and DB are the insertion characters for the insertion symbols 'CR' and 'DB'.

6. Floating insertion editing

   The currency symbol, the extended editing sign control symbols, if specified, and the fixed editing sign control symbols '+' and '-' are used as the floating insertion symbols.

   Floating insertion editing is indicated by specifying a string of at least two identical floating insertion editing symbols. Any of the simple insertion editing symbols embedded in this string or to the immediate right of this string are part of the string.

   The leftmost symbol of the insertion string represents the leftmost limit of the floating characters in the data item. The rightmost symbol of the insertion string represents the rightmost limit of the floating characters in the data item.

   The second floating symbol represents the leftmost limit of the numeric data that may be stored in the item. During editing, nonzero numeric characters may replace all the insertion symbols at or to the right of this limit.

   If truncation occurs, the value of the data that is used for editing is the value after truncation as specified in 14.6.8, Alignment and transfer of data into data items

   NOTE 1 If the size of character-string-1 is not at least the number of characters in the sending operand, plus the number of non-floating insertion symbols to be inserted in the item, plus one. unwanted truncation of data can result.

   There are two ways of representing floating insertion editing:

   1. One way is to represent any or all of the leading numeric character positions to the left of the decimal point position by the same insertion symbol. The result is that a single occurrence of the replacement character(s) is (are) placed into the character position(s) immediately preceding whichever of the following is encountered first:

      • the first nonzero numeric character in the item
      • the first character position for which no floating insertion editing is specified
      • the decimal point position.

      Any character positions preceding this (these) insertion character(s) will contain the space character.

   2. The second way is to represent all of the numeric character positions by the same insertion symbol. The result depends upon the value of the data to be stored. If the value is not zero, the result is the same as if the floating insertion editing were defined only to the left of the decimal point position. If the value is zero, all character positions will contain the space character.

   Table 9, Results of floating insertion editing, shows the character produced by the floating editing sign control symbols ‘es’, '+' and '-', depending on the value of the data item.

   Table 9 — Results of floating insertion editing

   Editing symbol in picture character-string	Result
   	Data item positive or zero	Data item negative
   +	+	–
   –	space	–
   character-1 NEGATIVE phrase	literal-2 or spaces	literal-2
   character-1 POSITIVE phrase	literal-3	literal-3 or spaces

7. Zero suppression with replacement editing

   The symbols 'Z' and '*' are used as the symbols for zero suppression with replacement. If the symbol 'Z' is used, the replacement character is the character space; if the symbol '*' is used, the replacement character is the character asterisk.

   Zero suppression with replacement is indicated by specifying a string of one or more identical zero-suppression characters. Any of the simple insertion editing symbols embedded in this string or to the immediate right of this string are part of the string.

   There are two ways of representing zero suppression with replacement:

   1. One way is to represent any or all of the leading numeric character positions to the left of the decimal point position by the zero-suppression symbol. The result is that the corresponding replacement character is placed into any character position immediately preceding whichever of the following is encountered first:

      • the first nonzero numeric character in the item
      • the first character position for which no zero suppression with replacement is specified
      • the decimal point position.
   2. The second way is to represent all of the numeric character positions by the zero-suppression symbol. The result depends upon the value of the data to be stored. If the value is not zero, the result is the same as if the zero suppression with replacement were defined only to the left of the decimal point position. If the value is zero and the zero-suppression symbol is the symbol 'Z', all character positions of the item will contain the character space. If the value is zero and the zero-suppression symbol is the symbol '*', all character positions of the item will contain the character asterisk, but the decimal separator, when specified, will appear in the item.

8. Zero value of a floating-point edited item

   If the value to be edited into a floating-point edited item is zero, then after editing all digit positions of the significand and all digit positions of the exponent shall be zero; the sign of the significand, if present, shall be positive; and the sign of the exponent shall be positive.

FORMAT 2

[Editing rules 9–15 omitted.]

13.18.40.6 Precedence rules

Where an 'x' appears in Table 10 and in Table 11, additional syntax rules or general rules may apply further restrictions.

FORMAT 1

Table 10, Format 1 picture symbol order of precedence, shows the order of precedence of symbols in a Format 1 picture character-string. An 'x' at an intersection indicates that the symbol(s) at the top of the column may precede (but not necessarily immediately) in character-string-1 the symbol(s) at the left of the row. The currency symbol is indicated by the symbol 'cs'.

The currency symbol when used as a fixed insertion symbol appears in two columns and two rows. The leftmost column and the uppermost row for this symbol represent its use as the first or second symbol in character-string-1. The rightmost column and the lowermost row for this symbol represent its use as the last or penultimate symbol in character-string-1.

The symbol '+' that appears in a column and in a row by itself, represents its use in the exponent part of character-string-1 for a floating-point numeric-edited item.

The symbols '+' and '–' when used as a non-floating insertion symbol appear in two columns and two rows. The leftmost column and the uppermost row for these symbols represent their use as the first symbol in character-string-1. The rightmost column and the lowermost row for these symbols represent their use as the last symbol in character-string-1.

The symbol 'P', the currency symbol when used as a floating insertion symbol, the pair of zero-suppression symbols 'Z' and '*', and the pair of floating insertion symbols '+' and '–' appear in two columns and in two rows in Table 10. The leftmost column and the uppermost row for these symbols represent their use to the left of the decimal point position. The rightmost column and the lowermost row for these symbols represent their use to the right of the decimal point position.

For the purposes of Table 10, character-string-1 for a numeric-edited item for a floating-point edited result is considered as two separate strings, the first of which begins with the first symbol and ends with the symbol 'E', and the second of which begins with the symbol 'E' and ends with the last symbol. The presence of symbols preceding the symbol 'E' has no effect on the validity of symbols following the symbol 'E'.

When the DECIMAL-POINT IS COMMA clause is specified, the precedence rules for the symbols comma and period are interchanged.

If the EDITING phrase is specified, the precedence of ‘es’ as related to Table 10, Format 1 picture symbol order of precedence, has the same precedence as the 'cs' symbol in the column and row of non-floating insertion symbols.