com.heirloomcomputing.epli.runtime

Class Builtin

java.lang.Object

com.heirloomcomputing.epli.runtime.Builtin

public class Builtin
extends java.lang.Object

Builtin - contains all the (static) methods that implement the standards- and IBM-defined PL/I BUILTIN functions that are not recognized and replaced INLINE by native Java classes and methods.

Author:

Heirloom Computing, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static Pointer<?>	NULL NULL() function and NULL constant
static int	RC

Constructor Summary

Constructors

Constructor and Description
Builtin()

Method Summary

Modifier and Type	Method and Description
static java.math.BigDecimal	ABS(java.math.BigDecimal X) Return the absolute value of the argument.
static java.math.BigInteger	ABS(java.math.BigInteger X) Return the absolute value of the argument.
static java.lang.Byte	ABS(java.lang.Byte X) Return the absolute value of the argument.
static Complex	ABS(Complex X) Return the absolute value of the argument.
static java.lang.Double	ABS(java.lang.Double X) Return the absolute value of the argument.
static FixedBin	ABS(FixedBin X) Return the absolute value of the argument.
static java.lang.Float	ABS(java.lang.Float X) Return the absolute value of the argument.
static java.lang.Integer	ABS(java.lang.Integer X) Return the absolute value of the argument.
static java.lang.Long	ABS(java.lang.Long X) Return the absolute value of the argument.
static Picture	ABS(Picture X) Return the absolute value of the argument.
static java.lang.Short	ABS(java.lang.Short X) Return the absolute value of the argument.
static java.math.BigDecimal	ADD(java.lang.Object X, java.lang.Object Y, int P, int Q) ADD returns the sum of x and y with a precision specified by p and q.
static Pointer<?>	ADDR(java.lang.Object ref, java.lang.Class<?> outerClass, java.lang.Object This) ADDR returns the pointer value that identifies the generation of outerClass mapped to the object ref.
static Pointer<?>	ADDR(Pointer<?> ptr, java.lang.Object toModel) ADDR simulates taking the address of one variable to be used as a base for another using handles (Pointer to a Pointer).
static java.lang.Integer	ALLOCATION(java.util.Stack<?> x) ALLOCATION returns a FIXED BINARY(31,0) specifying the number of generations that can be accessed in the current program for x.
static void	CALLCOBOL(java.lang.String pgmName, com.heirloomcomputing.ecs.exec.Context context, java.lang.Object... actualParameters) invoke the Elastic COBOL program with the given (PL/I as COBOL) parameters, setting up an Elastic COBOL program Context if need be.
static java.lang.Object	CALLCOBOLGIVING(java.lang.String pgmName, com.heirloomcomputing.ecs.exec.Context context, java.lang.Class<?> returnType, java.lang.Object... actualParameters) invoke the Elastic COBOL program with the given (PL/I as COBOL) parameters, setting up an Elastic COBOL program Context if need be, and return a result object
static java.lang.Object	CEIL(java.lang.Object X) CEIL determines the smallest integer value greater than or equal to x, and assigns this value to the result.
static java.lang.String	CHARACTER(java.lang.Object X, int Y) CHARACTER returns the character value of x, with a length specified by y.
static java.lang.String	COLLATE() COLLATE returns a CHARACTER(256) string comprising the 256 possible CHARACTER(1) values one time each in the collating order.
static int	compareTo(java.lang.Byte op1, BitN op2) compare two Elastic PL/I primitive types
static java.lang.String	COUNTER() COUNTER returns a CHARACTER string of length 5 containing a decimal number.
static java.lang.Integer	CURRENTSIZE(java.lang.Object x) CURRENTSIZE returns a FIXED BIN value that gives the implementation-defined storage, in bytes, required by x
static java.lang.String	DATE() DATE returns a nonvarying character(6) string containing the date in the format, YYMMDD.
static java.lang.String	DATETIME(java.lang.String Y) DATETIME returns a character string timestamp of today's date in either the default format or a user-specified format.
static java.lang.Integer	DAYS(java.lang.String D, java.lang.String P, java.lang.Integer W) DAYS returns a FIXED BINARY(31,0) value that is the number of days (in Lilian format) corresponding to the date d
static java.lang.String	DAYSTODATE(java.lang.Integer D, java.lang.String P, java.lang.Integer W) DAYSTODATE returns a nonvarying character string containing the date in the form p that corresponds to d days (in Lilian format).
static java.lang.Double	DAYSTOSECS(java.lang.Integer D) DAYSTOSECS returns a FLOAT BINARY(53) value that is the number of seconds corresponding to the number of days x.
static java.lang.Integer	DIMENSION(Array<?> x, java.lang.Integer y) DIMENSION returns a FIXED BINARY value that specifies the current extent of dimension y of x.
static java.lang.Object	DIVIDE(java.lang.Object X, java.lang.Object Y, int P, int Q) DIVIDE returns the quotient of x/y with a precision specified by p and q.
static void	ENTRYADDR(Entry lhs, Entry rhs) assign the Entry variable the address of the Entry point
static java.lang.Object	EXP(java.lang.Object X) EXP returns a floating-point value that is an approximation of the base, e, of the natural logarithm system raised to the power x.
static java.lang.Object	EXP(java.lang.Object X, int P, int Q) EXP(X, P, Q) same as EPLIConversion.Precision(EXP(X), P, Q)
static FixedBin	FIXEDBIN(java.lang.Object X, int P, int Q) FIXEDBIN returns a FIXED BIN value with precision and scale derived from the source unless explicitly specified as parameters to the function.
static java.math.BigDecimal	FIXEDDEC(java.lang.Object X, int P, int Q) FIXEDDEC returns a FIXED DEC value with precision and scale derived from the source unless explicitly specified as parameters to the function.
static java.lang.Object	FLOATBIN(java.lang.Object X, int P, int Q) FLOATBIN returns a FLOAT BIN value with precision and scale derived from the source unless explicitly specified as parameters to the function.
static java.math.BigDecimal	FLOATDEC(java.lang.Object X, int P, int Q) FLOATDEC returns a FLOAT DEC value with precision and scale derived from the source unless explicitly specified as parameters to the function.
static java.lang.Object	FLOOR(java.lang.Object X) FLOOR determines the greatest integer value less than or equal to x, and assigns this value to the result.
static java.lang.Integer	HBOUND(Array<?> x, java.lang.Integer y) HBOUND returns a FIXED BINARY value that specifies the current upper bound of dimension y of x.
static java.lang.String	HEX(java.lang.Object X, java.lang.String Y) HEX returns a character string that is the hexadecimal representation of the storage that contains X in which every 8 characters of the result has Y inserted, if given.
static Complex	IMAG(Complex c1, java.lang.Object c2) replace the imaginary portion of a Complex number
static java.lang.Integer	INDEX(java.lang.String var, java.lang.String search, int start) INDEX returns an unscaled REAL FIXED BINARY value indicating the starting position within x of a substring identical to y when the search for y starts from the left end of x.
static java.lang.Integer	INDEXR(java.lang.String var, java.lang.String search, int start) INDEXR returns an unscaled REAL FIXED BINARY value indicating the starting position within x of a substring identical to y when the search for y starts from the right end of x.
static java.lang.Integer	LBOUND(Array<?> x, java.lang.Integer y) LBOUND returns a FIXED BINARY value that specifies the current lower bound of dimension y of x.
static java.lang.Object	LOG(java.lang.Object X) LOG returns a floating-point value that is an approximation of the natural logarithm (the logarithm to the base e) of x.
static java.lang.Object	LOG(java.lang.Object X, int P, int Q) LOG returns same as LOG(X) trimmed to a specific precision and scale
static void	main(java.lang.String[] args)
static java.lang.Object	MAX(java.lang.Object D, java.lang.Object R, java.lang.Object... X) Take the maximum value of its (multiple) arguments which may be mixed of CHAR and CODED ARITHMETIC data types including String, Byte, Short, Integer, Long, FixedBin, BigInteger, BigDecimal, Float or Double.
static java.lang.Object	MIN(java.lang.Object D, java.lang.Object R, java.lang.Object... X) Take the minimum value of its (multiple) arguments which may be mixed of CHAR and CODED ARITHMETIC data types including String, Byte, Short, Integer, Long, FixedBin, BigInteger, BigDecimal, Float or Double.
static java.lang.Object	MOD(java.lang.Object X, java.lang.Object Y) MOD determines the modulus of an integer value by another integer.
static java.lang.Object	MULTIPLY(java.lang.Object X, java.lang.Object Y, int P, int Q) MULTIPLY returns the product of x and y, with a precision specified by p and q.
static java.lang.String	ONCHAR() ONCHAR returns single character on which a ONCHAR condition was raised
static void	ONCHAR(java.lang.String x) ONCHAR sets the ONCHAR character returned by the ONCHAR() built-in function
static java.lang.String	ONSOURCE() ONSOURCE returns the String set through the ONSOURCE(x) pseudo-variable or raised as part of the CONVERSION condition
static void	ONSOURCE(java.lang.String x) ONSOURCE sets the ONSOURCE character returned by the ONSOURCE() built-in function
static java.lang.String	PLIDUMP(java.lang.Object... argument) The PLIDUMP subroutine allows you to obtain a formatted dump of selected parts of storage that is used by your program.
static void	PLIEXIT() The PLIEXIT built-in subroutine is invoked by the STOP and EXIT statements with exit code 0 or that set with the CALL PLIRETC() built-in subroutine.
static void	PLIRETC(java.lang.Integer X) The PLIRETC built-in subroutine allows you to set a return code that can be examined by the program that invoked this PL/I program or by another PL/I procedure via the PLIRETV built-in function.
static java.lang.Integer	PLIRETV() PLIRETV returns a FIXED BINARY(31,0) value that is the PL/I return code.
static java.lang.Object	PRECISION(java.lang.Object X, int P, int Q) PRECISION returns the value of x, with a precision specified by p and q.
static java.lang.Double	RANDOM() RANDOM returns a random number
static java.lang.Double	RANDOM(int X) RANDOM returns a random number and sets the seed to the random number generator
static Complex	REAL(Complex c1, java.lang.Object c2) replace the real portion of a Complex number
static java.lang.Object	REM(java.lang.Object X, java.lang.Object Y) REM determines the remainder of a modulus of an integer value by another integer.
static java.lang.String	REPEAT(java.lang.String X, int Y) REPEAT returns a bit, character, graphic or widechar string consisting of x concatenated to itself the number of times specified by y.
static java.lang.Object	ROUND(java.lang.Object X, int N) ROUND returns the value of x rounded at a digit specified by n.
static java.math.BigDecimal	ROUNDDEC(java.math.BigDecimal X, int N) ROUNDDEC returns the value of x rounded at a digit specified by n.
static java.lang.Double	SECS(java.lang.String D, java.lang.String P, java.lang.Integer W) SECS returns a FLOAT BINARY(53) value that is the number of seconds (based on Lilian format) corresponding to the date d.
static java.lang.String	SECSTODATE(java.lang.Double D, java.lang.String P, java.lang.Integer W) SECSTODATE returns a nonvarying character string containing the date in the date/time pattern specified by p that corresponds to d seconds (based on Lilian format).
static java.lang.Integer	SECSTODAYS(java.lang.Double D) SECSTODAYS returns a FIXED BINARY(31,0) value that represents the number of seconds x converted to days, ignoring incomplete days.
static java.lang.Integer	SIGN(java.lang.Object X) SIGN returns an unscaled REAL FIXED BINARY value that indicates whether x is positive, zero, or negative.
static java.lang.Integer	SIZE(java.lang.Object x, int dclsize) SIZE returns a FIXED BIN value that gives the implementation-defined storage, in bytes, allocated to a variable x
static java.lang.String	STRING(java.lang.Object x) STRING returns a string that is the concatenation of all the elements of x.
static int	STRING(Pointer<?> destptr, java.lang.String source) The STRING pseudovariable assigns a string to x as if x were a string scalar.
static java.lang.String	SUBSTR(java.lang.String x, int y, int z) SUBSTR returns a substring, specified by y and z, of x.
static java.lang.String	SUBSTR(java.lang.String lhs, int x, int y, java.lang.String rhs) the SUBSTR pseudo-variable replace characters within a String and return it for assignment.
static java.lang.Object	SUBTRACT(java.lang.Object X, java.lang.Object Y, int P, int Q) SUBTRACT is equivalent to ADD(x,-y,p,q).
static java.lang.Integer	SYSTEM(java.lang.String cmd) SYSTEM(x) returns a FIXED BIN(31,0) value that is the return value from the command processor when it is invoked with the command contained in x.
static java.lang.String	TIME() TIME returns a character string timestamp in the format HHMISS999.
static java.lang.String	TRANSLATE(java.lang.String X, java.lang.String Y, java.lang.String Z) TRANSLATE returns a character string of the same length as x
static java.lang.Integer	TRUNC(java.lang.Object X) TRUNC returns returns an integer value that is the truncated value of x.
static java.lang.Object	TYPE(java.lang.Object rhs) The TYPE pseudovariable assigns a typed structure or union to the storage located by the handle x.
static BitN	UNSPEC(java.lang.Object X) UNSPEC function returns a bit string that is the internal coded form of x.
static java.lang.Object	UNSPEC(Pointer<?> dest, java.lang.Object source) The UNSPEC pseudovariable assigns a bit value directly to x; that is, without conversion.
static java.lang.Integer	VERIFY(java.lang.String X, java.lang.String Y, java.lang.Integer N) Returns an unscaled Integer value that indicates the position in x of the leftmost character, widechar, graphic, or bit that is not in y.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RC

public static int RC

NULL

public static final Pointer<?> NULL

NULL() function and NULL constant

Constructor Detail

Builtin

public Builtin()

Method Detail

ABS

public static java.lang.Byte ABS(java.lang.Byte X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.lang.Short ABS(java.lang.Short X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.lang.Integer ABS(java.lang.Integer X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.lang.Long ABS(java.lang.Long X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.lang.Float ABS(java.lang.Float X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.lang.Double ABS(java.lang.Double X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static FixedBin ABS(FixedBin X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.math.BigDecimal ABS(java.math.BigDecimal X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static java.math.BigInteger ABS(java.math.BigInteger X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static Complex ABS(Complex X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

ABS

public static Picture ABS(Picture X)

Return the absolute value of the argument.

Parameters:

X - - number to take the absolute value of

Returns:

the absolute value of the argument

CEIL

public static java.lang.Object CEIL(java.lang.Object X)

CEIL determines the smallest integer value greater than or equal to x, and assigns this value to the result.

Parameters:

X - - number to take the ceiling of

Returns:

the same type of object (with same scale and precision) as the parameter, but with the smallest integer value greater

MOD

public static java.lang.Object MOD(java.lang.Object X,
                                   java.lang.Object Y)

MOD determines the modulus of an integer value by another integer.

Parameters:

X - - number to take the ceiling of

Returns:

the same type of object (with same scale and precision) as the parameter, with the modulus of the divide operation

REM

public static java.lang.Object REM(java.lang.Object X,
                                   java.lang.Object Y)

REM determines the remainder of a modulus of an integer value by another integer.

Parameters:

X - - number to take the ceiling of

Returns:

the same type of object (with same scale and precision) as the parameter, with the remainder of the divide operation

FLOOR

public static java.lang.Object FLOOR(java.lang.Object X)

FLOOR determines the greatest integer value less than or equal to x, and assigns this value to the result.

Parameters:

X - - number to take the ceiling of

Returns:

the same type of object (with same scale and precision) as the parameter, but with the smallest integer value greater

compareTo

public static int compareTo(java.lang.Byte op1,
                            BitN op2)

compare two Elastic PL/I primitive types

Parameters:

op1 - - any of the base EPLITYPES

op2 - - any of the base EPLITYPES

Returns:

0 if they are equal, -1 if op2 < op1, + if op1 >

MAX

public static java.lang.Object MAX(java.lang.Object D,
                                   java.lang.Object R,
                                   java.lang.Object... X)

Take the maximum value of its (multiple) arguments which may be mixed of CHAR and CODED ARITHMETIC data types including String, Byte, Short, Integer, Long, FixedBin, BigInteger, BigDecimal, Float or Double. Not Picture, not Complex

Parameters:

D - - a return object type, with implied precision and scale. not considered part of the MAX calculation but will be returned as the function result if an error occurs, like not a type that can be converted into CODED ARITHMETIC form.

R - - Object - the first argument to take the maximum of.

X - - Object - the subsequent arguments to take the maximum of.

Returns:

Object of the same type as C with the maximal value

MIN

public static java.lang.Object MIN(java.lang.Object D,
                                   java.lang.Object R,
                                   java.lang.Object... X)

Take the minimum value of its (multiple) arguments which may be mixed of CHAR and CODED ARITHMETIC data types including String, Byte, Short, Integer, Long, FixedBin, BigInteger, BigDecimal, Float or Double. Not Picture, not Complex

Parameters:

D - - a return object type, with implied precision and scale. not considered part of the MAX calculation but will be returned as the function result if an error occurs, like not a type that can be converted into CODED ARITHMETIC form.

R - - Object - the first argument to take the maximum of.

X - - Object - the subsequent arguments to take the maximum of.

Returns:

Object of the same type as C with the maximal value

ADD

public static java.math.BigDecimal ADD(java.lang.Object X,
                                       java.lang.Object Y,
                                       int P,
                                       int Q)

ADD returns the sum of x and y with a precision specified by p and q. The base, scale, and mode of the result are determined by the rules for expression evaluation unless overruled by the PRECTYPE compiler option. This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression.

Y - - expression.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the sum of X and Y as a BigDecimal according to P and Q

SUBTRACT

public static java.lang.Object SUBTRACT(java.lang.Object X,
                                        java.lang.Object Y,
                                        int P,
                                        int Q)

SUBTRACT is equivalent to ADD(x,-y,p,q). This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression.

Y - - expression.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the subtraction of Y from X according to P and Q

MULTIPLY

public static java.lang.Object MULTIPLY(java.lang.Object X,
                                        java.lang.Object Y,
                                        int P,
                                        int Q)

MULTIPLY returns the product of x and y, with a precision specified by p and q. The base, scale, and mode of the result are determined by the rules for expression evaluation unless overruled by the PRECTYPE compiler option. This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression.

Y - - expression.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the result of X*Y with precision and scale of P & Q

DIVIDE

public static java.lang.Object DIVIDE(java.lang.Object X,
                                      java.lang.Object Y,
                                      int P,
                                      int Q)

DIVIDE returns the quotient of x/y with a precision specified by p and q. The base, scale, and mode of the result follow the rules for expression evaluation. This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression of the dividend.

Y - - expression of the divisor. if y=0 the ZERODIVIDE condition is raised

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the quotient of X/Y with precision and scale of P & Q

EXP

public static java.lang.Object EXP(java.lang.Object X)

EXP returns a floating-point value that is an approximation of the base, e, of the natural logarithm system raised to the power x. This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression in any CODEDARITHMETIC data type.

Returns:

e raised to the power of X in the same CODEDARITHMETIC data type

Throws:

SIZE - CONDITION if result is Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY

EXP

public static java.lang.Object EXP(java.lang.Object X,
                                   int P,
                                   int Q)

EXP(X, P, Q) same as EPLIConversion.Precision(EXP(X), P, Q)

Parameters:

X - - expression in any CODEDARITHMETIC data type.

P - - the requested precision number of binary digits of the result

Q - - the requested scale number of binary digits of the result

Returns:

e raised to the power of X in the same CODEDARITHMETIC data type trimmed to the given precision and scale if necessary

Throws:

SIZE - CONDITION if result is Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY or loss of precision would result

LOG

public static java.lang.Object LOG(java.lang.Object X)

LOG returns a floating-point value that is an approximation of the natural logarithm (the logarithm to the base e) of x. It has the base, mode, and precision of x. This is GENERIC so it returns an Object of same type as its first argument.

Parameters:

X - - expression must be greater than zero CODEDARITHMETIC data type

Returns:

the natural log of X in the same CODEDARITHMETIC data type

Throws:

SIZE - CONDITION if result is Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY

LOG

public static java.lang.Object LOG(java.lang.Object X,
                                   int P,
                                   int Q)

LOG returns same as LOG(X) trimmed to a specific precision and scale

Parameters:

X - - expression must be greater than zero CODEDARITHMETIC data type

P - - the requested precision number of binary digits of the result

Q - - the requested scale number of binary digits of the result

Returns:

the natural log of X in the same CODEDARITHMETIC data type trimmed to the given precision and scale if necessary

Throws:

SIZE - CONDITION if result is Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY or loss of precision would result

FIXEDDEC

public static java.math.BigDecimal FIXEDDEC(java.lang.Object X,
                                            int P,
                                            int Q)

FIXEDDEC returns a FIXED DEC value with precision and scale derived from the source unless explicitly specified as parameters to the function.

Parameters:

X - - expression of the dividend.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the argument as a FLOAT DEC(P,Q)

FLOATDEC

public static java.math.BigDecimal FLOATDEC(java.lang.Object X,
                                            int P,
                                            int Q)

FLOATDEC returns a FLOAT DEC value with precision and scale derived from the source unless explicitly specified as parameters to the function.

Parameters:

X - - expression of the dividend.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the argument as a FLOAT DEC(P,Q)

CHARACTER

public static java.lang.String CHARACTER(java.lang.Object X,
                                         int Y)

CHARACTER returns the character value of x, with a length specified by y. CHARACTER also supports conversion from graphic to character type.

Parameters:

X - - Expression. X must have a computational type.

Y - - Expression. If necessary, Y is converted to a real fixed-point binary value. If Y is omitted, the length is determined by the rules for type conversion. Y cannot be negative. If Y = 0, the result is the null character string.

HEX

public static java.lang.String HEX(java.lang.Object X,
                                   java.lang.String Y)

HEX returns a character string that is the hexadecimal representation of the storage that contains X in which every 8 characters of the result has Y inserted, if given.

Parameters:

X - - Expression that represents any variable. The whole number of bytes that contain x is converted to hexadecimal.

Y - - Expression. If specified, z must have the type CHARACTER(1) NONVARYING.

FIXEDBIN

public static FixedBin FIXEDBIN(java.lang.Object X,
                                int P,
                                int Q)

FIXEDBIN returns a FIXED BIN value with precision and scale derived from the source unless explicitly specified as parameters to the function.

Parameters:

X - - expression of the dividend.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the argument as a FIXED BIN(P,Q)

FLOATBIN

public static java.lang.Object FLOATBIN(java.lang.Object X,
                                        int P,
                                        int Q)

FLOATBIN returns a FLOAT BIN value with precision and scale derived from the source unless explicitly specified as parameters to the function.

Parameters:

X - - expression of the dividend.

P - - Restricted expression specifying the number of digits to be maintained throughout the operation.

Q - - Restricted expression specifying the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is the default. For a floating-point result, q must be omitted.

Returns:

the argument as a FLOAT BIN(P,Q)

ROUND

public static java.lang.Object ROUND(java.lang.Object X,
                                     int N)

ROUND returns the value of x rounded at a digit specified by n. The result has the mode, base, and scale of x.

Parameters:

X - - Any CODEDARITHMETIC. If x is negative, the absolute value is rounded and the sign is restored

N - - Optional signed integer. It specifies the digit at which rounding is to occur

Returns:

the same CODEDARITHMETIC type of x rounded at a digit specified by n

ROUNDDEC

public static java.math.BigDecimal ROUNDDEC(java.math.BigDecimal X,
                                            int N)

ROUNDDEC returns the value of x rounded at a digit specified by n. The result has the mode, base, and scale of x.

Parameters:

X - - Decimal expression. If x is negative, the absolute value is rounded and the sign is restored

N - - Optional signed integer. It specifies the digit at which rounding is to occur

Returns:

the value of x rounded at a digit specified by n

SIGN

public static java.lang.Integer SIGN(java.lang.Object X)

SIGN returns an unscaled REAL FIXED BINARY value that indicates whether x is positive, zero, or negative.

Parameters:

X - - Arithmetic expression to test

Returns:

the value of x rounded at a digit specified by n

TRUNC

public static java.lang.Integer TRUNC(java.lang.Object X)

TRUNC returns returns an integer value that is the truncated value of x. If x is positive or 0, this is the largest integer value less than or equal to x. If x is negative, this is the smallest integer value greater than or equal to x..

Parameters:

X - - Arithmetic expression to truncate

Returns:

the truncated (integer) value of x

ONCHAR

public static java.lang.String ONCHAR()

ONCHAR returns single character on which a ONCHAR condition was raised

Returns:

- a String of length 1 that contains the character raising the condition or modified with the ONCHAR(x) pseudo-variable Note: also used for ONWCHAR()

ONSOURCE

public static java.lang.String ONSOURCE()

ONSOURCE returns the String set through the ONSOURCE(x) pseudo-variable or raised as part of the CONVERSION condition

Returns:

- a String that contains the character raising the condition or modified with the ONSOURCE(x) pseudo-variable

RANDOM

public static java.lang.Double RANDOM(int X)

RANDOM returns a random number and sets the seed to the random number generator

Parameters:

X - - a number to use as a seed for future random numbers)

Returns:

- a random number

RANDOM

public static java.lang.Double RANDOM()

RANDOM returns a random number

Returns:

- a random number

REPEAT

public static java.lang.String REPEAT(java.lang.String X,
                                      int Y)

REPEAT returns a bit, character, graphic or widechar string consisting of x concatenated to itself the number of times specified by y. That is, there are (y + 1) occurrences of x

Parameters:

X - - string to repeat (e.g., 'the quick brown fox jumped over the lazy dog')

Y - - number of times to repeat (0 meaning X is returned)

Returns:

- X repeated Y times (total Y+1 copies of X)

VERIFY

public static java.lang.Integer VERIFY(java.lang.String X,
                                       java.lang.String Y,
                                       java.lang.Integer N)

Returns an unscaled Integer value that indicates the position in x of the leftmost character, widechar, graphic, or bit that is not in y. It also allows you to specify the location within x at which to begin processing

Parameters:

X - - string to verify (e.g., 'the quick brown fox jumped over the lazy dog')

Y - - chars to verify X against (e.g., 'abcdefghijklmnopqrstuvwxyz')

N - - where to start in X (e.g., 1) [optional]

Returns:

- the char position in X where it does not very, 0 if all are verified (e.g., 4, the space char is not in the chars to verify against string)

ENTRYADDR

public static void ENTRYADDR(Entry lhs,
                             Entry rhs)

assign the Entry variable the address of the Entry point

Parameters:

lhs - - the original Entry variable

rhs - - the Entry constant Note: compiler generates in-line code for this pseudo-variable

IMAG

public static Complex IMAG(Complex c1,
                           java.lang.Object c2)

replace the imaginary portion of a Complex number

Parameters:

c1 - - the original Complex number containing the real part

c2 - - the imaginary part that should replace it

Returns:

the Complex number made up of the two parameters

Throws:

CONVERSION - condition if could not convert

ONCHAR

public static void ONCHAR(java.lang.String x)

ONCHAR sets the ONCHAR character returned by the ONCHAR() built-in function

Parameters:

x - - a String the first character of which will be returned by ONCHAR() Note: also used in ONWCHAR

ONSOURCE

public static void ONSOURCE(java.lang.String x)

ONSOURCE sets the ONSOURCE character returned by the ONSOURCE() built-in function

Parameters:

x - - a String the first character of which will be returned by ONCHAR() Note: also used in ONWSOURCE, ONGSOURCE

REAL

public static Complex REAL(Complex c1,
                           java.lang.Object c2)

replace the real portion of a Complex number

Parameters:

c1 - - the original Complex number containing the imaginary part

c2 - - the real part that should replace it

Returns:

the Complex number made up of the two parameters

Throws:

CONVERSION - condition if could not convert

DATE

public static java.lang.String DATE()

DATE returns a nonvarying character(6) string containing the date in the format, YYMMDD.

TIME

public static java.lang.String TIME()

TIME returns a character string timestamp in the format HHMISS999.

DATETIME

public static java.lang.String DATETIME(java.lang.String Y)

DATETIME returns a character string timestamp of today's date in either the default format or a user-specified format.

Parameters:

Y - - optional CHAR format for the returned string

DAYS

public static java.lang.Integer DAYS(java.lang.String D,
                                     java.lang.String P,
                                     java.lang.Integer W)

DAYS returns a FIXED BINARY(31,0) value that is the number of days (in Lilian format) corresponding to the date d

Parameters:

D - - optional - the date/time to examine, DATETIME() if null

P - - optional - the date/time format, format of DATETIME() if null

W - - optional - An integer expression that defines a century window to be used to handle any two-digit year formats. 1) If the value is positive, such as 1950, it is treated as a year. 2) If negative or zero, the value specifies an offset to be subtracted from the current, system-supplied year. 3) If omitted, w defaults to the value specified in the WINDOW compile-time option.

DAYSTODATE

public static java.lang.String DAYSTODATE(java.lang.Integer D,
                                          java.lang.String P,
                                          java.lang.Integer W)

DAYSTODATE returns a nonvarying character string containing the date in the form p that corresponds to d days (in Lilian format).

Parameters:

D - - the number of days (in Lilian format). d must have a computational type and is converted to FIXED BINARY(31,0) if necessary

P - - optional - the date/time format, format of DATETIME() if null

W - - optional - An integer expression that defines a century window to be used to handle any two-digit year formats. 1) If the value is positive, such as 1950, it is treated as a year. 2) If negative or zero, the value specifies an offset to be subtracted from the current, system-supplied year. 3) If omitted, w defaults to the value specified in the WINDOW compile-time option.

DAYSTOSECS

public static java.lang.Double DAYSTOSECS(java.lang.Integer D)

DAYSTOSECS returns a FLOAT BINARY(53) value that is the number of seconds corresponding to the number of days x.

Parameters:

D - - the number of days (in Lilian format). d must have a computational type and is converted to FIXED BINARY(31,0) if necessary

Returns:

the number of seconds correspond to the number of days x

SECS

public static java.lang.Double SECS(java.lang.String D,
                                    java.lang.String P,
                                    java.lang.Integer W)

SECS returns a FLOAT BINARY(53) value that is the number of seconds (based on Lilian format) corresponding to the date d.

Parameters:

D - -optional - A string expression representing a date. If present, d specifies the input date as a character string representing the date/time specified in the pattern p. If d is missing, it is assumed to be DATETIME(). D must have a computational type and should have character type. If not, it is converted to character.

P - - optional - the date/time format, format of DATETIME() if null

W - - optional - An integer expression that defines a century window to be used to handle any two-digit year formats. 1) If the value is positive, such as 1950, it is treated as a year. 2) If negative or zero, the value specifies an offset to be subtracted from the current, system-supplied year. 3) If omitted, w defaults to the value specified in the WINDOW compile-time option.

Returns:

the date

SECSTODATE

public static java.lang.String SECSTODATE(java.lang.Double D,
                                          java.lang.String P,
                                          java.lang.Integer W)

SECSTODATE returns a nonvarying character string containing the date in the date/time pattern specified by p that corresponds to d seconds (based on Lilian format).

Parameters:

D - - the number of seconds (in Lilian format). d must have a computational type and is converted to FIXED BINARY(31,0) if necessary

P - - optional - the date/time format, format of DATETIME() if null

W - - optional - An integer expression that defines a century window to be used to handle any two-digit year formats. 1) If the value is positive, such as 1950, it is treated as a year. 2) If negative or zero, the value specifies an offset to be subtracted from the current, system-supplied year. 3) If omitted, w defaults to the value specified in the WINDOW compile-time option.

Returns:

the date

SECSTODAYS

public static java.lang.Integer SECSTODAYS(java.lang.Double D)

SECSTODAYS returns a FIXED BINARY(31,0) value that represents the number of seconds x converted to days, ignoring incomplete days.

Parameters:

D - - Expression. The value for x must have computational type and should be FLOAT BINARY(53). If not, it is converted to FLOAT BINARY(53)

Returns:

the number of seconds correspond to the number of days x

COLLATE

public static java.lang.String COLLATE()

COLLATE returns a CHARACTER(256) string comprising the 256 possible CHARACTER(1) values one time each in the collating order.

Elastic PL/I Note: the String contains the unicode chars from 0 to 256 in the default code page, of which 0xfe and 0xff have special significance

COUNTER

public static java.lang.String COUNTER()

COUNTER returns a CHARACTER string of length 5 containing a decimal number. The returned number is 00001 for the first invocation, and increments by one on each successive invocation.

STRING

public static int STRING(Pointer<?> destptr,
                         java.lang.String source)

The STRING pseudovariable assigns a string to x as if x were a string scalar. Any remaining strings in x are filled with blanks or zero bits, or, if varying-length, are given zero length.

Parameters:

destptr - - a pointer to a Group or other variable to be assigned

source - - a String to be used as the source of the assignment

Returns:

number of chars of the source consumed for this operation

Throws:

STRINGRANGE - condition if x or y are out-of-range of lhs note: ignore code page issues (like 0xffef unicode markers)

INDEX

public static java.lang.Integer INDEX(java.lang.String var,
                                      java.lang.String search,
                                      int start)

INDEX returns an unscaled REAL FIXED BINARY value indicating the starting position within x of a substring identical to y when the search for y starts from the left end of x. You can also specify the location within x where processing begins.

Parameters:

var - - the string to search

search - the string to search for

start - the starting location (default 1)

Returns:

the 1-based offset index of the search in var

INDEXR

public static java.lang.Integer INDEXR(java.lang.String var,
                                       java.lang.String search,
                                       int start)

INDEXR returns an unscaled REAL FIXED BINARY value indicating the starting position within x of a substring identical to y when the search for y starts from the right end of x. You can also specify the location within x where processing begins.

Parameters:

var - - the string to search

search - the string to search

start - the starting location (default end-of-string), if "not specified" (it is optional in INDEXR), 0 is passed to indicate this

Returns:

the 1-based offset index of the search in var

STRING

public static java.lang.String STRING(java.lang.Object x)

STRING returns a string that is the concatenation of all the elements of x.

Parameters:

x - Aggregate or element reference.

Returns:

convert x to CHAR VARYING String and return it

SUBSTR

public static java.lang.String SUBSTR(java.lang.String x,
                                      int y,
                                      int z)

SUBSTR returns a substring, specified by y and z, of x.

Parameters:

x - String expression. It specifies the string from which the substring is extracted. If x is not a string, it is converted to character.

y - Expression that is converted to FIXED BINARY(31,0). y specifies the starting position of the substring in x.

z - Expression that is converted to FIXED BINARY(31,0). z specifies the length of the substring in x. If z is zero, a null string is returned. If z is omitted (-1), the substring returned is position y in x to the end of x.

Returns:

the substring

Throws:

CONDITION(STRINGRANGE) - if an arg is out-of-range

SUBSTR

public static java.lang.String SUBSTR(java.lang.String lhs,
                                      int x,
                                      int y,
                                      java.lang.String rhs)

the SUBSTR pseudo-variable replace characters within a String and return it for assignment. this is the default, generic PVSTRING that generally only works for Group structures; PVSTRING1, PVSTRING2 are alternatives when the lhs is CHAR or CHAR VAR. Other lhs (e.g. FIXED BIN(15)) generally will not work and no assignment will be made.

Parameters:

lhs - - the left-hand-side, generally a Group

x - - the start within lhs of the replacement

y - - the length of the chars within lhs that should be replaced

rhs - - the characters (trimmed/padded to length y) to be used as the replacement

Returns:

the String with the designated characters replaced

Throws:

STRINGRANGE - condition if x or y are out-of-range of lhs

TRANSLATE

public static java.lang.String TRANSLATE(java.lang.String X,
                                         java.lang.String Y,
                                         java.lang.String Z)

TRANSLATE returns a character string of the same length as x

Parameters:

X - - Character expression to be searched for possible translation of its characters.

Y - - Character expression containing the translation values of characters.

Z - - Character expression containing the characters that are to be translated. If z is omitted, it defaults to collate().

Returns:

return the result.

TRANSLATE operates on each character of x as follows: If a character in x is found in z, the character in y that corresponds to that in z is copied to the result; otherwise, the character in x is copied directly to the result. If z contains duplicates, the leftmost occurrence is used. y is padded with blanks, or truncated, on the right to match the length of z. Any arithmetic or bit arguments are converted to character. TRANSLATE does not support GRAPHIC or WIDECHAR data. TRANSLATE will perform best when the second and third arguments are either literals, named constants declared with the VALUE attribute, or restricted expressions

TYPE

public static java.lang.Object TYPE(java.lang.Object rhs)

The TYPE pseudovariable assigns a typed structure or union to the storage located by the handle x.

Parameters:

rhs - - handle of an object to be used as the value Note: compiler generates inline assignment because Java obj are not immu

UNSPEC

public static BitN UNSPEC(java.lang.Object X)

UNSPEC function returns a bit string that is the internal coded form of x.

Parameters:

X - - the PL/I variable to unspec

Returns:

a BIT(n) VARYING (BitN) containing the internal coded form of x

UNSPEC

public static java.lang.Object UNSPEC(Pointer<?> dest,
                                      java.lang.Object source)

The UNSPEC pseudovariable assigns a bit value directly to x; that is, without conversion.

Parameters:

dest - - a Pointer to the original object to be assigned bits from the source

source - - any object that is to be converted to bits and assigned

Returns:

the Object of same type as lhs but with data replaced from rhs

DIMENSION

public static java.lang.Integer DIMENSION(Array<?> x,
                                          java.lang.Integer y)

DIMENSION returns a FIXED BINARY value that specifies the current extent of dimension y of x.

Parameters:

x - - Array reference. x must not have less than y dimensions.

y - - Expression specifying a particular dimension of x. If necessary, y is converted to a FIXED BINARY(31,0). y must be greater than or equal to 1. If y is not supplied, it defaults to 1. y can be omitted only if the array is one-dimensional.

Returns:

an Integer (FIXED BINARY) of the dimensions in the array

Throws:

Condition - SUBSCRIPTRANGE if the dimension number is out of range of the array

LBOUND

public static java.lang.Integer LBOUND(Array<?> x,
                                       java.lang.Integer y)

LBOUND returns a FIXED BINARY value that specifies the current lower bound of dimension y of x.

Parameters:

x - - Array reference. x must not have less than y dimensions.

y - - Expression specifying a particular dimension of x. If necessary, y is converted to FIXED BINARY(31,0). y must be greater than or equal to 1. If y is not supplied, it defaults to 1. y can be omitted only if the array is one-dimensional.

Returns:

an Integer (FIXED BINARY) of the lower bound in the array

Throws:

Condition - SUBSCRIPTRANGE if the dimension number is out of range of the array

HBOUND

public static java.lang.Integer HBOUND(Array<?> x,
                                       java.lang.Integer y)

HBOUND returns a FIXED BINARY value that specifies the current upper bound of dimension y of x.

Parameters:

x - - Array reference. x must not have less than y dimensions.

y - - Expression specifying a particular dimension of x. If necessary, y is converted to FIXED BINARY(31,0). y must be greater than or equal to 1. If y is not supplied, it defaults to 1. y can be omitted only if the array is one-dimensional.

Returns:

an Integer (FIXED BINARY) of the higher bound in the array

Throws:

Condition - SUBSCRIPTRANGE if the dimension number is out of range of the array

ALLOCATION

public static java.lang.Integer ALLOCATION(java.util.Stack<?> x)

ALLOCATION returns a FIXED BINARY(31,0) specifying the number of generations that can be accessed in the current program for x.

Parameters:

x - - Level-1 unsubscripted controlled variable.

Returns:

- an Integer (FIXED BIN(31,0)) of the controlled storage size

ADDR

public static Pointer<?> ADDR(Pointer<?> ptr,
                              java.lang.Object toModel)

ADDR simulates taking the address of one variable to be used as a base for another using handles (Pointer to a Pointer). in the process overlays the original and redefined value

Parameters:

ptr - - a pointer to any object to use as the source of the overlay

toModel - - a model of an object in which the object's class is used to return a Pointer of that class. ex. ADDR(Pointer, Integer.valueOf(0)) returns Pointer) such that taking the ref() of it will return the first 4-chars of the string as a 4 byte integer. note: toModel may contain scale and precision information for numbers or @CHAR, @BIT, @PIC annotations for other EPLITYPES. note: the value of toModel is inconsequential.

Returns:

a handle (Pointer to a Pointer) that can be used to reference the input pointer's object

ADDR

public static Pointer<?> ADDR(java.lang.Object ref,
                              java.lang.Class<?> outerClass,
                              java.lang.Object This)

ADDR returns the pointer value that identifies the generation of outerClass mapped to the object ref.

Parameters:

ref - - a reference to any object

outerClass - - a reference to any object

Returns:

the (strongly typed) Pointer that can be used to reference an instance of outerClass mapped to object ref

PLIDUMP

public static java.lang.String PLIDUMP(java.lang.Object... argument)

The PLIDUMP subroutine allows you to obtain a formatted dump of selected parts of storage that is used by your program.

Parameters:

argument - - an (optional) argument on which to obtain a document executable in the host operating system

Returns:

the string of the dump of the given arguments plus a stack trace

PLIEXIT

public static void PLIEXIT()

The PLIEXIT built-in subroutine is invoked by the STOP and EXIT statements with exit code 0 or that set with the CALL PLIRETC() built-in subroutine. It is not a defined as a built-in subroutine or built-in function.

PLIRETC

public static void PLIRETC(java.lang.Integer X)

The PLIRETC built-in subroutine allows you to set a return code that can be examined by the program that invoked this PL/I program or by another PL/I procedure via the PLIRETV built-in function.

Parameters:

X - - the exit value to use when the main program exits

PLIRETV

public static java.lang.Integer PLIRETV()

PLIRETV returns a FIXED BINARY(31,0) value that is the PL/I return code. The value of the PL/I return code is the most recent value specified by a CALL PLIRETC statement.

Returns:

an Integer of the value last set with CALL PLIRETC(...)

PRECISION

public static java.lang.Object PRECISION(java.lang.Object X,
                                         int P,
                                         int Q)

PRECISION returns the value of x, with a precision specified by p and q. The base, mode, and scale of the returned value are the same as that of x.

Parameters:

X - - expression

P - - Restricted expression. p specifies the number of digits that the value of the expression x is to have after conversion.

Q - - Restricted expression. It specifies the scaling factor of the result. For a fixed-point result, if q is omitted, a scaling factor of zero is assumed. For a floating-point result, q must be omitted.

Returns:

X with the modified precision of P and Q

CURRENTSIZE

public static java.lang.Integer CURRENTSIZE(java.lang.Object x)

CURRENTSIZE returns a FIXED BIN value that gives the implementation-defined storage, in bytes, required by x

Parameters:

x - - the variable type (Java class) to analyze

Returns:

an Integer of the Java size of the "value" portion of the class

SIZE

public static java.lang.Integer SIZE(java.lang.Object x,
                                     int dclsize)

SIZE returns a FIXED BIN value that gives the implementation-defined storage, in bytes, allocated to a variable x

Parameters:

x - - the allocated variable (Java object) to analyze

dclsize - - the declared size of the symbol (not a defined parameter on the SIZE(x) builtin; added by the compiler)

Returns:

an Integer of the Java size of the "value" portion of the object

SYSTEM

public static java.lang.Integer SYSTEM(java.lang.String cmd)

SYSTEM(x) returns a FIXED BIN(31,0) value that is the return value from the command processor when it is invoked with the command contained in x.

Parameters:

cmd - - a String representing a command and argument string executable in the host operating system

Returns:

the return code of that command execution

main

public static void main(java.lang.String[] args)

CALLCOBOL

public static void CALLCOBOL(java.lang.String pgmName,
                             com.heirloomcomputing.ecs.exec.Context context,
                             java.lang.Object... actualParameters)

invoke the Elastic COBOL program with the given (PL/I as COBOL) parameters, setting up an Elastic COBOL program Context if need be.

Parameters:

pgmName - - the String program name to invoke

context - - an existing COBOL Context (due to -out:transaction) or null to create a new one to make this call

actualParameters - - Java parameters that are converted to equivalent COBOL Variable types prior to invoking the pgmName

CALLCOBOLGIVING

public static java.lang.Object CALLCOBOLGIVING(java.lang.String pgmName,
                                               com.heirloomcomputing.ecs.exec.Context context,
                                               java.lang.Class<?> returnType,
                                               java.lang.Object... actualParameters)

invoke the Elastic COBOL program with the given (PL/I as COBOL) parameters, setting up an Elastic COBOL program Context if need be, and return a result object

Parameters:

pgmName - - the String program name to invoke

context - - a Context for the calling program or null if no context is available

returnType - - the Class of the expected return type

actualParameters - - Java parameters that are converted to equivalent COBOL Variable types prior to invoking the pgmName