com.goldencode.p2j.util

Class ProcedureManager.ProcedureHelper

java.lang.Object

com.goldencode.p2j.util.ProcedureManager.ProcedureHelper

Enclosing class:

ProcedureManager

public static class ProcedureManager.ProcedureHelper
extends java.lang.Object

Helper to expose APIs which have direct access to the context-local state.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) handle.Helper	h Cache and expose the handle.Helper.
(package private) ObjectOps.ObjectHelper	oh Cache and expose the ObjectOps.ObjectHelper.
private ProcedureManager.WorkArea	wa The ProcedureManager.WorkArea instance.
(package private) WidgetPool.WidgetPoolHelper	wp Cache and expose the WidgetPool.WidgetPoolHelper.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProcedureHelper(ProcedureManager.WorkArea wa) Create a new instance and associate the given WorkArea instance.

Method Summary

Modifier and Type	Method and Description
boolean	_isDelayedDelete(java.lang.Object referent) Check if this is a "delete-on-exit" procedure.
boolean	_isPersistent(java.lang.Object referent) Check if the given referent is for a persistent procedure.
boolean	_isPersistentAndNotPendingDelete(java.lang.Object referent) Check if the given referent is for a persistent procedure which has not been deleted explicitly while its still on stack, so a delete is pending when last call for this reference exits the stack.
java.lang.Object	_rootProcedure() Get the root procedure instance .
java.lang.Object	_sourceProcedure() Get the SOURCE-PROCEDURE referent.
java.lang.Object	_thisProcedure() Get the THIS-PROCEDURE referent.
(package private) void	addFinalizable(java.lang.Object referent, Finalizable target) Register the given Finalizable to be processed when the persistent procedure gets deleted.
(package private) void	addProcedure(handle h, java.lang.String name, boolean persistent) Add the h handle as a persistent procedure.
(package private) void	addProcedure(handle h, java.lang.String name, boolean singleton, boolean singleRun) Add the h handle as a persistent procedure.
(package private) void	addProcedure(handle h, java.lang.String name, boolean persistent, boolean singleton, boolean singleRun, boolean legacyClass) Add the h handle as a persistent procedure.
(package private) void	addScopeable(java.lang.Object referent, Scopeable target) Register the given Scopeable to be processed when the persistent procedure gets deleted.
boolean	addStaleReferent(java.lang.Object referent) Mark that the selected referent is stale.
logical	addSuperProcedure(java.lang.Object referent, handle h) Add the given handle as a super-procedure for the specified referent.
logical	addSuperProcedure(java.lang.Object referent, handle h, int mode) Add the given handle as a super-procedure for the specified referent, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).
logical	addSuperProcedure(java.lang.Object referent, handle h, ProcedureManager.SearchMode mode) Add the given handle as a super-procedure for the specified referent, using the explicit mode.
void	cleanupPending() Cleanup of pending resources.
(package private) java.lang.String	currentInternalEntry() Get the currently executing internal entry name.
(package private) boolean	delete(java.lang.Object referent, boolean letStaleProcedure) Delete the given procedure handle (i.e.
void	deleteResource(WrappedResource res) Delete the specified resource - this allows a static resource to be deleted.
void	deregisterExecuteOnReturn(java.lang.Runnable code, WeightFactor weight) Deregister the given code from the ProcedureManager.WorkArea.cleanupHandlers.
void	deregisterResource(java.lang.Object referent, HandleResource resource) Deregister the given resource from the specified creator procedure.
java.util.Iterator<java.lang.Object>	destinationIterator() Get an iterator over the stack of currently destination resolved code.
void	disablePendingResources() Disable static resources to be registered to ProcedureManager.WorkArea.pendingResources.
void	enablePendingResources() Allow static resources to be registered to ProcedureManager.WorkArea.pendingResources.
void	executeInThisProcedure(java.lang.Object thisProcedureOverride, Block block) Execute the given block with THIS-PROCEDURE as the given instProc procedure.
void	executeOnReturn(java.lang.Runnable code, WeightFactor weight) Registers a specific procedure-cleanup handler.
java.util.Iterator<java.lang.Class<?>>	executingIterator() Get an iterator over the stack of currently executing code.
character	getADMData(java.lang.Object referent) Get the value of the ADM-DATA attribute of the specified referent.
java.lang.Class<?>	getExecuting() Get the Java class associated with the currently executing code.
(package private) handle	getHandleForFunction(handle phandle, java.lang.String fname) Using the name of a function defined IN handle and a procedure handle to which this function definition belongs, resolve the target handle, to be able to invoke it.
java.lang.String	getInstantiatingExternalProgram() ProcedureHelper Get the name of the currently instantiated external program.
java.lang.Class<?>	getInstantiatingExternalProgramClass() Get the source class of the currently instantiating external program or OE class.
java.lang.Object	getInstantiatingProcedure(java.lang.Object referent) Gets the INSTANTIATING-PROCEDURE associated to the referent.
handle	getNextSibling(java.lang.Object referent) Get the NEXT-SIBLING attribute of the specified referent.
Stack<BlockDefinition>	getPersistentProcStack(java.lang.Object referent) Obtains the stack snapshot of one persistent procedure.
handle	getPrevSibling(java.lang.Object referent) Get the PREV-SIBLING attribute of the specified referent.
character	getPrivateData(java.lang.Object referent) Get the PRIVATE-DATA attribute of the specified referent.
java.lang.Object	getProcessedProcedure() Get the current external program (an application logic instance) being processed for scopeable or finalizable notifications.
java.lang.String	getRelativeName(java.lang.Object instance) Get the relative name used to create the given external program instance.
(package private) java.lang.String	getStackEntry(int idx) Implementation for the PROGRAM-NAME functions.
java.util.List<java.lang.String>	getStackTrace() Get the legacy stack trace
(package private) handle	getSuperHandle(java.lang.String iename, boolean function) For procedures or functions defined IN SUPER, this computes the target procedure handle where the procedure's or function's body resides.
(package private) java.util.List<handle>	getSuperProcedures() Get a handle list of super-procedures for the session handle.
(package private) java.util.List<handle>	getSuperProcedures(java.lang.Object referent) Get a handle list of super-procedures for the given referent.
integer	getUniqueID(java.lang.Object referent) Gets the the unique ID number associated to the referent.
boolean	hasReferent(java.lang.Object referent) Check if the given referent has been (or is still) registered with the ProcedureManager in the procedure map.
boolean	hasStaleReferent(java.lang.Object referent) Check if a provided referent is stale or not.
boolean	hasSubscriptions(_BaseObject_ resource) Check if the given instance has associated subscriptions.
boolean	inNotifications() Check if we are executing finalizable or scopeable notifications.
(package private) boolean	isBlockLevelUndoThrow() Check if current THIS-PROCEDURE is marked as BLOCK-LEVEL UNDO, THROW.
boolean	isDelayedDelete(java.lang.Object referent) Check if this referent can be deleted or not.
boolean	isExecuted(java.lang.Object referent) Check whether the specified referent (procedure) has been executed or not.
logical	isPersistent(java.lang.Object referent) Check if the given referent is for a persistent procedure.
boolean	isRemotePersistentProcedure(java.lang.Object referent) Check if an external program was ran persistent by a remote side.
(package private) boolean	isRoutineLevelUndoThrow() Check if current THIS-PROCEDURE is marked as ROUTINE-LEVEL UNDO, THROW or BLOCK-LEVEL UNDO, THROW (as BLOCK-LEVEL includes the ROUTINE-LEVEL blocks).
logical	isSingleRun(java.lang.Object referent) Check if the given referent is for a single-run procedure.
logical	isSingleton(java.lang.Object referent) Check if the given referent is for a singleton procedure.
boolean	isThisProcedurePersistent() Check if _thisProcedure() is ran persistent.
boolean	isTopLevel(java.lang.Object referent) Check if the given referent is the top-level procedure (the startup procedure).
boolean	isValid(java.lang.Object referent) Check if the given referent is a valid procedure.
(package private) void	markBlockLevelUndoThrow() Mark current THIS-PROCEDURE as BLOCK-LEVEL UNDO, THROW.
(package private) void	markRoutineLevelUndoThrow() Mark current THIS-PROCEDURE as ROUTINE-LEVEL UNDO, THROW.
void	notifyStaticRecordWasLoaded(RecordBuffer recordBuffer) A system which notifies the ProcedureManager when a static record buffer is changed.
long	onStackReferences(java.lang.Object referent) Calculate the number of occurences of the specified referent, on current stack.
CalleeInfo	peekCalleeInfo() Return the last callee info from the stack.
boolean	pendingResourceDelete(WrappedResource res) Check if this resource is currently being implicitly deleted.
void	popCalleeInfo() Pop the last callee info from the stack.
ProcedureManager.ProcedureData	prevThisProcedureData() Get the THIS-PROCEDURE data for the previous block on the stack.
void	processResource(WrappedResource res, boolean dynamic) Process the given resource by either setting its INSTANTIATING-PROCEDURE attribute immediately (in case of non-static resources) or add the static resource to the ProcedureManager.WorkArea.pendingResources set, to be processed when the next scope is entered.
void	pushCalleeInfo(java.lang.Class<?> def, boolean superCall, java.lang.Object target, java.lang.Object destination, java.lang.String iename, java.lang.String pname, boolean function, boolean persistentProc) Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.
void	pushCalleeInfo(java.lang.Class<?> def, boolean superCall, java.lang.Object target, java.lang.Object destination, java.lang.String iename, java.lang.String pname, boolean function, boolean persistentProc, boolean dynamicCall) Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.
void	pushCalleeInfo(java.lang.Class<?> def, boolean superCall, java.lang.Object target, java.lang.Object destination, java.lang.String iename, java.lang.String pname, boolean function, boolean persistentProc, boolean singletonProc, boolean singleRunProc) Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.
void	registerRemotePersistentProcedure(java.lang.Object referent) Register an external program which was ran persistent by a remote side.
void	registerResource(java.lang.Object referent, HandleResource resource) Register the given resource as being created by the specified procedure.
void	removeStaleProcedure(java.lang.Object referent) Removes the referent information from the persistent procedure stack mapping and stale set.
logical	removeSuperProcedure(java.lang.Object referent, handle h) Remove the given handle from the specified referent's list of super-procedures.
handle	resolveInstantiatingProcedure(java.lang.Object instProc) Resolve the instantiating procedure from the given handle: if the handle contains a valid procedure, return a copy of it; else, return an unknown handle.
java.lang.Object	searchInStack(java.util.function.Function<java.lang.Object,java.lang.Object> search) Walk the THIS-PROCEDURE stack and apply the search function; return the first value given by the search function, once it returns a non-null value.
void	setADMData(java.lang.Object referent, java.lang.String value) Set the value of the ADM-DATA attribute for the specified referent.
void	setInstantingExternalProgram(java.lang.String name) Set the name of the 4GL program currently being instantiated, into the ProcedureManager.WorkArea.initiatingExtProg field.
void	setInstantingExternalProgramClass(java.lang.Class<?> cls) Set the Java class of the currently instantiating external program or OE class.
void	setPrivateData(java.lang.Object referent, character data) Set the PRIVATE-DATA attribute of the specified referent.
void	setProcessedProcedure(java.lang.Object referent) Set the external procedure beeing processed for scopeable or finalizable notifications.
character	superProcedures(java.lang.Object referent) Get the SUPER-PROCEDURES attribute of the specified external procedure instance.
handle	thisProcedure() Get the THIS-PROCEDURE system handle.
ProcedureManager.ProcedureData	thisProcedureData() Get the THIS-PROCEDURE data for the current block.

Methods inherited from class java.lang.Object

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

Field Detail

wp

final WidgetPool.WidgetPoolHelper wp

Cache and expose the WidgetPool.WidgetPoolHelper.

h

final handle.Helper h

Cache and expose the handle.Helper.

oh

final ObjectOps.ObjectHelper oh

Cache and expose the ObjectOps.ObjectHelper.

wa

private final ProcedureManager.WorkArea wa

The ProcedureManager.WorkArea instance.

Constructor Detail

ProcedureHelper

private ProcedureHelper(ProcedureManager.WorkArea wa)

Create a new instance and associate the given WorkArea instance.

Parameters:

wa - The ProcedureManager.WorkArea instance.

Method Detail

enablePendingResources

public void enablePendingResources()

Allow static resources to be registered to ProcedureManager.WorkArea.pendingResources.

disablePendingResources

public void disablePendingResources()

Disable static resources to be registered to ProcedureManager.WorkArea.pendingResources.

processResource

public void processResource(WrappedResource res,
                            boolean dynamic)

Process the given resource by either setting its INSTANTIATING-PROCEDURE attribute immediately (in case of non-static resources) or add the static resource to the ProcedureManager.WorkArea.pendingResources set, to be processed when the next scope is entered.

Parameters:

res - The resource to be processed.

dynamic - Flag indicating if this is a dynamic or static resource.

isDelayedDelete

public boolean isDelayedDelete(java.lang.Object referent)

Check if this referent can be deleted or not.

This checks if the instance is on stack, and if the run is SINGLE-RUN or SINGLETON.

Parameters:

referent - The instance to check.

Returns:

true if the delete must be postponed.

hasSubscriptions

public boolean hasSubscriptions(_BaseObject_ resource)

Check if the given instance has associated subscriptions. If yes, it can't be deleted implicitly.

Parameters:

resource - The instance to check.

Returns:

If there are any subscriptions registered.

superProcedures

public character superProcedures(java.lang.Object referent)

Get the SUPER-PROCEDURES attribute of the specified external procedure instance.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

removeSuperProcedure

public logical removeSuperProcedure(java.lang.Object referent,
                                    handle h)

Remove the given handle from the specified referent's list of super-procedures.

Parameters:

referent - An instance of an converted external procedure class.

h - The procedure handle to be removed.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

public logical addSuperProcedure(java.lang.Object referent,
                                 handle h)

Add the given handle as a super-procedure for the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

h - The handle to be added as a super-procedure.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

public logical addSuperProcedure(java.lang.Object referent,
                                 handle h,
                                 ProcedureManager.SearchMode mode)

Add the given handle as a super-procedure for the specified referent, using the explicit mode.

Parameters:

referent - An instance of an converted external procedure class.

h - The handle to be added as a super-procedure.

mode - The ProcedureManager.SearchMode to be set for the h handle.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

public logical addSuperProcedure(java.lang.Object referent,
                                 handle h,
                                 int mode)

Add the given handle as a super-procedure for the specified referent, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).

Parameters:

referent - An instance of an converted external procedure class.

h - The handle to be added as a super-procedure.

mode - The search-mode to be set for the h handle.

Returns:

true if h is a valid procedure handle.

resolveInstantiatingProcedure

public handle resolveInstantiatingProcedure(java.lang.Object instProc)

Resolve the instantiating procedure from the given handle: if the handle contains a valid procedure, return a copy of it; else, return an unknown handle.

Parameters:

instProc - The instance representing an instantiating procedure.

Returns:

See above.

isTopLevel

public boolean isTopLevel(java.lang.Object referent)

Check if the given referent is the top-level procedure (the startup procedure).

Parameters:

referent - The instance to be verified.

Returns:

true if the referent is the startup procedure.

setPrivateData

public void setPrivateData(java.lang.Object referent,
                           character data)

Set the PRIVATE-DATA attribute of the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

data - the PRIVATE-DATA.

getPrivateData

public character getPrivateData(java.lang.Object referent)

Get the PRIVATE-DATA attribute of the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

getUniqueID

public integer getUniqueID(java.lang.Object referent)

Gets the the unique ID number associated to the referent. Not the same as the handle value itself.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

The integer number of the children.

pendingResourceDelete

public boolean pendingResourceDelete(WrappedResource res)

Check if this resource is currently being implicitly deleted.

Parameters:

res - The resource to check.

Returns:

true if the resource is the same as ProcedureManager.WorkArea.pendingResourceDelete.

registerResource

public void registerResource(java.lang.Object referent,
                             HandleResource resource)

Register the given resource as being created by the specified procedure.

Parameters:

referent - The procedure which creates the resource.

resource - The resource being created.

deregisterResource

public void deregisterResource(java.lang.Object referent,
                               HandleResource resource)

Deregister the given resource from the specified creator procedure.

Parameters:

referent - The procedure which creates the resource.

resource - The resource being created.

inNotifications

public boolean inNotifications()

Check if we are executing finalizable or scopeable notifications.

Returns:

See above.

isValid

public boolean isValid(java.lang.Object referent)

Check if the given referent is a valid procedure.

Parameters:

referent - The instance to check.

getStackTrace

public java.util.List<java.lang.String> getStackTrace()

Get the legacy stack trace

Returns:

the legacy stack trace

deleteResource

public void deleteResource(WrappedResource res)

Delete the specified resource - this allows a static resource to be deleted.

Parameters:

res - The resource to delete.

getInstantiatingProcedure

public java.lang.Object getInstantiatingProcedure(java.lang.Object referent)

Gets the INSTANTIATING-PROCEDURE associated to the referent.

Parameters:

referent - The external program.

Returns:

See above.

getNextSibling

public handle getNextSibling(java.lang.Object referent)

Get the NEXT-SIBLING attribute of the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

getPrevSibling

public handle getPrevSibling(java.lang.Object referent)

Get the PREV-SIBLING attribute of the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

isSingleRun

public logical isSingleRun(java.lang.Object referent)

Check if the given referent is for a single-run procedure. This implements the SINGLE-RUN attribute for a procedure handle.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

true if the referent is a single-run procedure.

isSingleton

public logical isSingleton(java.lang.Object referent)

Check if the given referent is for a singleton procedure. This implements the SINGLETON attribute for a procedure handle.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

true if the referent is a singleton procedure.

isPersistent

public logical isPersistent(java.lang.Object referent)

Check if the given referent is for a persistent procedure. This implements the PERSISTENT attribute for a procedure handle.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

true if the referent is a persistent procedure.

getADMData

public character getADMData(java.lang.Object referent)

Get the value of the ADM-DATA attribute of the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

setADMData

public void setADMData(java.lang.Object referent,
                       java.lang.String value)

Set the value of the ADM-DATA attribute for the specified referent.

Parameters:

referent - An instance of an converted external procedure class.

value - The new value.

executingIterator

public java.util.Iterator<java.lang.Class<?>> executingIterator()

Get an iterator over the stack of currently executing code.

Returns:

An iterator of Java classes associated with the code executing on the stack.

destinationIterator

public java.util.Iterator<java.lang.Object> destinationIterator()

Get an iterator over the stack of currently destination resolved code.

Returns:

An iterator of Java classes associated with the code on the stack.

getSuperHandle

handle getSuperHandle(java.lang.String iename,
                      boolean function)

For procedures or functions defined IN SUPER, this computes the target procedure handle where the procedure's or function's body resides.

In case when no super procedure is found, it will throw proper error messages and return null.

Parameters:

iename - Internal-entry's name (this may be a procedure or function).

function - true if this is a function.

Returns:

A procedure handle where to search for the internal-entry's body or null of none found.

getExecuting

public java.lang.Class<?> getExecuting()

Get the Java class associated with the currently executing code.

Returns:

See above.

onStackReferences

public long onStackReferences(java.lang.Object referent)

Calculate the number of occurences of the specified referent, on current stack.

Parameters:

referent - The referent to check.

Returns:

The number of occurrences of the referent on the current stack.

searchInStack

public java.lang.Object searchInStack(java.util.function.Function<java.lang.Object,java.lang.Object> search)

Walk the THIS-PROCEDURE stack and apply the search function; return the first value given by the search function, once it returns a non-null value.

Parameters:

search - The search function.

Returns:

The first non-null value returned by the search function.

isRemotePersistentProcedure

public boolean isRemotePersistentProcedure(java.lang.Object referent)

Check if an external program was ran persistent by a remote side.

Parameters:

referent - The external program instance.

Returns:

true if the referent is part of the ProcedureManager.WorkArea.remotePersistentProcedures map.

registerRemotePersistentProcedure

public void registerRemotePersistentProcedure(java.lang.Object referent)

Register an external program which was ran persistent by a remote side.

Parameters:

referent - The external program instance.

thisProcedure

public handle thisProcedure()

Get the THIS-PROCEDURE system handle.

Returns:

See above.

_thisProcedure

public java.lang.Object _thisProcedure()

Get the THIS-PROCEDURE referent.

Returns:

See thisProcedure().

_rootProcedure

public java.lang.Object _rootProcedure()

Get the root procedure instance .

isThisProcedurePersistent

public boolean isThisProcedurePersistent()

Check if _thisProcedure() is ran persistent.

Returns:

true if THIS-PROCEDURE is ran persistent.

prevThisProcedureData

public ProcedureManager.ProcedureData prevThisProcedureData()

Get the THIS-PROCEDURE data for the previous block on the stack.

Returns:

See above.

thisProcedureData

public ProcedureManager.ProcedureData thisProcedureData()

Get the THIS-PROCEDURE data for the current block.

Returns:

See above.

_sourceProcedure

public java.lang.Object _sourceProcedure()

Get the SOURCE-PROCEDURE referent.

Returns:

See ProcedureManager.sourceProcedure().

_isPersistent

public boolean _isPersistent(java.lang.Object referent)

Check if the given referent is for a persistent procedure. This implements the PERSISTENT attribute for a procedure handle.

Parameters:

referent - An instance of a converted external procedure class.

Returns:

true if the referent is a persistent procedure.

_isPersistentAndNotPendingDelete

public boolean _isPersistentAndNotPendingDelete(java.lang.Object referent)

Check if the given referent is for a persistent procedure which has not been deleted explicitly while its still on stack, so a delete is pending when last call for this reference exits the stack.

Parameters:

referent - An instance of a converted external procedure class.

Returns:

true if the referent is a persistent procedure.

getInstantiatingExternalProgram

public java.lang.String getInstantiatingExternalProgram()

ProcedureHelper Get the name of the currently instantiated external program.

Returns:

The 4GL external program name being instantiated, or null if this is not the case.

getInstantiatingExternalProgramClass

public java.lang.Class<?> getInstantiatingExternalProgramClass()

Get the source class of the currently instantiating external program or OE class.

Returns:

The Java class associated with the source code for the current instantiating OE class.

setProcessedProcedure

public void setProcessedProcedure(java.lang.Object referent)

Set the external procedure beeing processed for scopeable or finalizable notifications.

Parameters:

referent - The external procedure instance.

getProcessedProcedure

public java.lang.Object getProcessedProcedure()

Get the current external program (an application logic instance) being processed for scopeable or finalizable notifications.

Returns:

See above

cleanupPending

public void cleanupPending()

Cleanup of pending resources. This is called when the external procedure constructor failed to build a new object because of an exception thrown in a member initialization (shared frame/table).

_isDelayedDelete

public boolean _isDelayedDelete(java.lang.Object referent)

Check if this is a "delete-on-exit" procedure.

Parameters:

referent - An instance of a converted external procedure class.

Returns:

true if the referent is a "delete-on-exit" procedure.

pushCalleeInfo

public void pushCalleeInfo(java.lang.Class<?> def,
                           boolean superCall,
                           java.lang.Object target,
                           java.lang.Object destination,
                           java.lang.String iename,
                           java.lang.String pname,
                           boolean function,
                           boolean persistentProc)

Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.

Parameters:

def - The currently executing OE class or external program.

superCall - Flag indicating if the destination is in a super-procedure.

target - The target procedure, which was targeted by the caller.

destination - The procedure where the internal entry was resolved.

iename - The internal entry name. In case of triggers or external programs, use the ProcedureManager.EXTERNAL_PROGRAM and ProcedureManager.TRIGGER_PROCEDURE constants.

pname - The external program name; will be non-null only when we are invoking an external program.

function - Flag indicating we are calling a user-defined function.

persistentProc - Flag indicating the external program was ran persistent.

pushCalleeInfo

public void pushCalleeInfo(java.lang.Class<?> def,
                           boolean superCall,
                           java.lang.Object target,
                           java.lang.Object destination,
                           java.lang.String iename,
                           java.lang.String pname,
                           boolean function,
                           boolean persistentProc,
                           boolean dynamicCall)

Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.

Parameters:

def - The currently executing OE class or external program.

superCall - Flag indicating if the destination is in a super-procedure.

target - The target procedure, which was targeted by the caller.

destination - The procedure where the internal entry was resolved.

iename - The internal entry name. In case of triggers or external programs, use the ProcedureManager.EXTERNAL_PROGRAM and ProcedureManager.TRIGGER_PROCEDURE constants.

pname - The external program name; will be non-null only when we are invoking an external program.

function - Flag indicating we are calling a user-defined function.

persistentProc - Flag indicating the external program was ran persistent.

dynamicCall - Flag indicating a dynamic call.

pushCalleeInfo

public void pushCalleeInfo(java.lang.Class<?> def,
                           boolean superCall,
                           java.lang.Object target,
                           java.lang.Object destination,
                           java.lang.String iename,
                           java.lang.String pname,
                           boolean function,
                           boolean persistentProc,
                           boolean singletonProc,
                           boolean singleRunProc)

Save the information about the program being called, to be used on the top-level scope start notification: at that time, the info about the callee (this, source- and target- procedures and other info) will be resolved.

Parameters:

def - The currently executing OE class or external program.

superCall - Flag indicating if the destination is in a super-procedure.

target - The target procedure, which was targeted by the caller.

destination - The procedure where the internal entry was resolved.

iename - The internal entry name. In case of triggers or external programs, use the ProcedureManager.EXTERNAL_PROGRAM and ProcedureManager.TRIGGER_PROCEDURE constants.

pname - The external program name; will be non-null only when we are invoking an external program.

function - Flag indicating we are calling a user-defined function.

persistentProc - Flag indicating the external program was ran persistent.

singletonProc - Flag indicating the external program was ran singleton.

singleRunProc - Flag indicating the external program was ran single-run.

popCalleeInfo

public void popCalleeInfo()

Pop the last callee info from the stack.

peekCalleeInfo

public CalleeInfo peekCalleeInfo()

Return the last callee info from the stack.

Returns:

CalleeInfo instance.

executeInThisProcedure

public void executeInThisProcedure(java.lang.Object thisProcedureOverride,
                                   Block block)

Execute the given block with THIS-PROCEDURE as the given instProc procedure.

Parameters:

instProc - Procedure to be treated as the new THIS-PROCEDURE.

block - The code to execute.

getRelativeName

public java.lang.String getRelativeName(java.lang.Object instance)

Get the relative name used to create the given external program instance.

Parameters:

instance - The external program instance.

Returns:

See above.

hasReferent

public boolean hasReferent(java.lang.Object referent)

Check if the given referent has been (or is still) registered with the ProcedureManager in the procedure map.

Parameters:

referent - The referent to be checked if is still loaded.

Returns:

true if the referent was found.

hasStaleReferent

public boolean hasStaleReferent(java.lang.Object referent)

Check if a provided referent is stale or not.

Parameters:

referent - The referent for which the checking will be done

Returns:

true if the referent is stale.

isExecuted

public boolean isExecuted(java.lang.Object referent)

Check whether the specified referent (procedure) has been executed or not.

Parameters:

referent - The referent which is checked for staleness

Returns:

true if the procedure has been executed or was not found (i.e., is assumed to have executed and been deleted/discarded); else false.

notifyStaticRecordWasLoaded

public void notifyStaticRecordWasLoaded(RecordBuffer recordBuffer)

A system which notifies the ProcedureManager when a static record buffer is changed. This is used to keep up to date the persistent procedure stacks - which are in fact snapshots of the block stacks stored the first time a static record is loaded.

Parameters:

recordBuffer - The record buffer which was loaded and triggered this notification.

removeStaleProcedure

public void removeStaleProcedure(java.lang.Object referent)

Removes the referent information from the persistent procedure stack mapping and stale set. This should be done only when the referent is deleted.

Parameters:

referent - The persistent procedure for which the entry should be removed.

getPersistentProcStack

public Stack<BlockDefinition> getPersistentProcStack(java.lang.Object referent)

Obtains the stack snapshot of one persistent procedure. The stack represent the block stack when the first global buffer was defined inside the referent.

Parameters:

referent - The persistent procedure for which the stack should be retrieved.

Returns:

The block stack snapshot stored for the specified referent.

addStaleReferent

public boolean addStaleReferent(java.lang.Object referent)

Mark that the selected referent is stale.

Parameters:

referent - The referent which should be marked as stale.

setInstantingExternalProgram

public void setInstantingExternalProgram(java.lang.String name)

Set the name of the 4GL program currently being instantiated, into the ProcedureManager.WorkArea.initiatingExtProg field.

Parameters:

name - The 4GL external program name.

setInstantingExternalProgramClass

public void setInstantingExternalProgramClass(java.lang.Class<?> cls)

Set the Java class of the currently instantiating external program or OE class.

Parameters:

cls - The Java class for the currently executing code.

executeOnReturn

public void executeOnReturn(java.lang.Runnable code,
                            WeightFactor weight)

Registers a specific procedure-cleanup handler. The code will be executed AFTER the last bit of code of the CURRENT procedure was executed, including the eventual fini / finally: block, just before the procedure is popped out from the stack.

Parameters:

code - The code that does the cleanup. It can handle a (input-)output parameter or other resource whose scope is bound to the current procedure. For example, in case of a table parameter, it will handle the unbinding process of the table parameter from the local table.

weight - The priority of the code. The lower the weight, the higher priority.

deregisterExecuteOnReturn

public void deregisterExecuteOnReturn(java.lang.Runnable code,
                                      WeightFactor weight)

Deregister the given code from the ProcedureManager.WorkArea.cleanupHandlers.

Parameters:

code - The clean code that needs to be removed.

weight - The priority of the code. The lower the weight, the higher priority.

getHandleForFunction

handle getHandleForFunction(handle phandle,
                            java.lang.String fname)

Using the name of a function defined IN handle and a procedure handle to which this function definition belongs, resolve the target handle, to be able to invoke it.

Parameters:

phandle - The procedure handle where the function was defined.

fname - The function's legacy name.

Returns:

The procedure handle where to search for the function's body.

addProcedure

void addProcedure(handle h,
                  java.lang.String name,
                  boolean persistent)

Add the h handle as a persistent procedure. Used by ControlFlowOps.invokePersistent(character, Object...) and ControlFlowOps.invokePersistentSet(String, handle, Object...).

Parameters:

h - The procedure handle to be added to the list of persistent procedures.

name - The name of this procedure, used at the RUN statement.

persistent - Flag indicating if this is a persistent procedure.

addProcedure

void addProcedure(handle h,
                  java.lang.String name,
                  boolean persistent,
                  boolean singleton,
                  boolean singleRun,
                  boolean legacyClass)

Add the h handle as a persistent procedure. Used by ControlFlowOps.invokePersistent(character, Object...) and ControlFlowOps.invokePersistentSet(String, handle, Object...).

Parameters:

h - The procedure handle to be added to the list of persistent procedures.

name - The name of this procedure, used at the RUN statement.

persistent - Flag indicating if this is a persistent procedure.

singleton - Flag indicating if this is a singleton procedure.

singleRun - Flag indicating if this is a single-run procedure.

legacyClass - Set to true if the method is called as a result of legacy class initialization. false otherwise.

addProcedure

void addProcedure(handle h,
                  java.lang.String name,
                  boolean singleton,
                  boolean singleRun)

Add the h handle as a persistent procedure. Used by ControlFlowOps.invokePersistent(character, Object...) and ControlFlowOps.invokePersistentSet(String, handle, Object...).

Parameters:

h - The procedure handle to be added to the list of persistent procedures.

name - The name of this procedure, used at the RUN statement.

singleton - Flag indicating if this is a singleton procedure.

singleRun - Flag indicating if this is a singleton procedure.

getStackEntry

java.lang.String getStackEntry(int idx)

Implementation for the PROGRAM-NAME functions. Resolves the legacy top level block (external program, function, internal procedure or trigger), at the given depth. The index starts with 0 for the currently executing top-level block.

Parameters:

idx - The stack entry index.

Returns:

The name of the stack entry or null if outside of stack.

currentInternalEntry

java.lang.String currentInternalEntry()

Get the currently executing internal entry name.

Returns:

The top of the ProcedureManager.WorkArea.internalEntryStack.

delete

boolean delete(java.lang.Object referent,
               boolean letStaleProcedure)

Delete the given procedure handle (i.e. execute the DELETE OBJECT or DELETE PROCEDURE handle).

Parameters:

referent - The persistent procedure instance to be deleted.

letStaleProcedure - Flag to indicate if the procedure should go in an stale state.

Returns:

true if this procedure handle can be deleted.

isRoutineLevelUndoThrow

boolean isRoutineLevelUndoThrow()

Check if current THIS-PROCEDURE is marked as ROUTINE-LEVEL UNDO, THROW or BLOCK-LEVEL UNDO, THROW (as BLOCK-LEVEL includes the ROUTINE-LEVEL blocks).

Returns:

See above.

isBlockLevelUndoThrow

boolean isBlockLevelUndoThrow()

Check if current THIS-PROCEDURE is marked as BLOCK-LEVEL UNDO, THROW.

Returns:

See above.

markRoutineLevelUndoThrow

void markRoutineLevelUndoThrow()

Mark current THIS-PROCEDURE as ROUTINE-LEVEL UNDO, THROW.

markBlockLevelUndoThrow

void markBlockLevelUndoThrow()

Mark current THIS-PROCEDURE as BLOCK-LEVEL UNDO, THROW.

addScopeable

void addScopeable(java.lang.Object referent,
                  Scopeable target)

Register the given Scopeable to be processed when the persistent procedure gets deleted.

Parameters:

referent - The external program.

target - The Scopeable instance which needs delayed notification.

addFinalizable

void addFinalizable(java.lang.Object referent,
                    Finalizable target)

Register the given Finalizable to be processed when the persistent procedure gets deleted.

Parameters:

referent - The external program.

target - The Finalizable instance which needs delayed notification.

getSuperProcedures

java.util.List<handle> getSuperProcedures(java.lang.Object referent)

Get a handle list of super-procedures for the given referent.

Parameters:

referent - An instance of an converted external procedure class.

Returns:

See above.

getSuperProcedures

java.util.List<handle> getSuperProcedures()

Get a handle list of super-procedures for the session handle.

Returns:

See above.