LogicalTerminal.ScopeProcessor (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.LogicalTerminal.ScopeProcessor

All Implemented Interfaces:

ConditionListener, Finalizable

Enclosing class:

LogicalTerminal
```
private class LogicalTerminal.ScopeProcessor
extends java.lang.Object
implements ConditionListener
```
Callback mechanism to manage frame hiding, interactions counter and other state. Heavily uses block notifications to trip processing.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`canHide` Track frame hiding in current scope.
`private java.util.HashMap<java.lang.Integer,GenericFrame>`	`deepFrames` Frames registered at previous scope.
`private boolean`	`deferReset` Track if any exception was raised in this block.
`private boolean`	`forceCanHide` Set 'canHide' flag on the next iteration.
`private java.util.HashMap<java.lang.Integer,GenericFrame>`	`frames` Frames registered at current scope.
`private boolean`	`hadException` Track if any ENDKEY/ERROR condition was raised in this block.
`private boolean`	`hadWrap` Frame in scope has been wrapped.
`private java.util.ArrayList<java.lang.Integer>`	`hidden` List of frames which were marked for hiding last time.
`private int`	`innerViewed` Maximal number of frames viewed in nested blocks.
`private int`	`interactionsAtEntry` A snapshot of the interactions counter at block entry.
`private boolean`	`isException` Mark exception from general hiding rule.
`private boolean`	`marked` Set to `true` when first non-empty list of frames was marked for hiding.
`private LogicalTerminal.ScopeProcessor`	`prev` Reference to previous scope in the chain.
`private boolean`	`realTopLevel` Mark external procedure scope.
`private int`	`savedInnerViewed` Number of viewed frames in outer scope.
`private boolean`	`topLevel` Mark inherited or temporary external procedure scope.
`private org.roaringbitmap.RoaringBitmap`	`viewed` Viewed in current iteration frames.

Constructor Summary

Constructors
Constructor and Description

ScopeProcessor()
Create new instance.

Constructors
Constructor and Description
`ScopeProcessor()` Create new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`clearTopLevelFlag()` Clear top level procedure flag.
`void`	`condition(BlockManager.Condition condition)` Provides a notification that a `ConditionException` or an unexpected `Throwable` was encountered for the current block.
`private void`	`deferMarkFrames(java.util.ArrayList<java.lang.Integer> list, int mode)` Setup the deferral processing to mark frames for hiding.
`void`	`deleted()` This implementation does nothing.
`void`	`finished()` Process end of block scope.
`void`	`forceHiding()` Clear map of viewed frames.
`void`	`frameViewed(GenericFrame frame)` Notify scope that frame is viewed.
`void`	`frameWrapped(java.lang.Integer id)` Notify that frame is wrapped during DOWN or UP processing.
`private java.util.HashMap<java.lang.Integer,GenericFrame>`	`getDeepFrames()` Get the `deepFrames` map and create it if it does not exist.
`private java.util.HashMap<java.lang.Integer,GenericFrame>`	`getFrames()` Get the `frames` map and create it if it does not exist.
`private java.util.ArrayList<java.lang.Integer>`	`getHidden()` Get the `hidden` list and create it if it does not exist.
`private org.roaringbitmap.RoaringBitmap`	`getViewed()` Get the `viewed` set and create it if it does not exist.
`private boolean`	`hasDeepFrames()` Check if the `deepFrames` map exists and is not empty.
`private boolean`	`hasFrames()` Check if the `frames` map exists and is not empty.
`private boolean`	`hasHidden()` Check if the `hidden` list exists and is not empty.
`private boolean`	`hasViewed()` Check if the `viewed` set exists and is not empty.
`private boolean`	`isDoBlock(BlockType type)` Check current block scope for type of block.
`private boolean`	`isSpecialBlock(BlockType type)` Check type of current block and return `true` if this is some kind of FOR or REPEAT loop.
`void`	`iterate()` Process iteration of block nesting scope.
`private void`	`process(boolean isRetry)` Handle block iteration and retry.
`void`	`register(GenericFrame frame)` Register frame at current scope.
`void`	`retry()` Process retrying of the block nesting scope.
`java.lang.String`	`toString()` Prepare human readable representations of the instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.Finalizable
entry, initFailure, weight

- Field Detail
  - frames
```
private java.util.HashMap<java.lang.Integer,GenericFrame> frames
```
    Frames registered at current scope.
  - deepFrames
```
private java.util.HashMap<java.lang.Integer,GenericFrame> deepFrames
```
    Frames registered at previous scope.
  - prev
```
private LogicalTerminal.ScopeProcessor prev
```
    Reference to previous scope in the chain.
  - marked
```
private boolean marked
```
    Set to true when first non-empty list of frames was marked for hiding.
  - hadException
```
private boolean hadException
```
    Track if any ENDKEY/ERROR condition was raised in this block.
  - deferReset
```
private boolean deferReset
```
    Track if any exception was raised in this block.
  - hidden
```
private java.util.ArrayList<java.lang.Integer> hidden
```
    List of frames which were marked for hiding last time.
  - viewed
```
private org.roaringbitmap.RoaringBitmap viewed
```
    Viewed in current iteration frames.
  - canHide
```
private boolean canHide
```
    Track frame hiding in current scope.
  - isException
```
private boolean isException
```
    Mark exception from general hiding rule.
  - innerViewed
```
private int innerViewed
```
    Maximal number of frames viewed in nested blocks.
  - hadWrap
```
private boolean hadWrap
```
    Frame in scope has been wrapped.
  - savedInnerViewed
```
private int savedInnerViewed
```
    Number of viewed frames in outer scope.
  - realTopLevel
```
private final boolean realTopLevel
```
    Mark external procedure scope.
  - topLevel
```
private boolean topLevel
```
    Mark inherited or temporary external procedure scope.
  - forceCanHide
```
private boolean forceCanHide
```
    Set 'canHide' flag on the next iteration.
  - interactionsAtEntry
```
private int interactionsAtEntry
```
    A snapshot of the interactions counter at block entry.
- Constructor Detail
  - ScopeProcessor
```
ScopeProcessor()
```
    Create new instance.
- Method Detail
  - forceHiding
```
public void forceHiding()
```
    Clear map of viewed frames.
  - frameViewed
```
public void frameViewed(GenericFrame frame)
```
    Notify scope that frame is viewed.
    
    Parameters:
    
    frame - Frame which is about to be viewed.
  - frameWrapped
```
public void frameWrapped(java.lang.Integer id)
```
    Notify that frame is wrapped during DOWN or UP processing.
    
    Parameters:
    
    id -
  - finished
```
public void finished()
```
    Process end of block scope.
    
    Specified by:
    
    finished in interface Finalizable
    
    See Also:
    
    Finalizable.finished()
  - deleted
```
public void deleted()
```
    This implementation does nothing.
    
    Specified by:
    
    deleted in interface Finalizable
  - register
```
public void register(GenericFrame frame)
```
    Register frame at current scope.
    
    Parameters:
    
    frame - Frame to register.
  - iterate
```
public void iterate()
```
    Process iteration of block nesting scope. All regular frames present at current scope are marked for hiding. All frames at nested scopes are marked for hiding.
    
    Specified by:
    
    iterate in interface Finalizable
  - retry
```
public void retry()
```
    Process retrying of the block nesting scope. All frames present at current scope are marked for hiding. All frames at nested scopes are marked for hiding.
    
    Specified by:
    
    retry in interface Finalizable
  - condition
```
public void condition(BlockManager.Condition condition)
```
    Provides a notification that a ConditionException or an unexpected Throwable was encountered for the current block.
    This method will reset the interactions counter for any block that has the ENDKEY property. This is done to ensure that if the block is exited, that the current block's interactions will not be added to the containing block's interactions. If the block is retried or iterated, then the counter is going to be reset anyway so this has no negative effect.
    If the exception was for ERROR or ENDKEY then a flag will be set to allow exit processing to be modified accordingly.
    
    Specified by:
    
    condition in interface ConditionListener
    
    Parameters:
    
    condition - The condition thrown during block processing.
  - clearTopLevelFlag
```
private void clearTopLevelFlag()
```
    Clear top level procedure flag.
  - process
```
private void process(boolean isRetry)
```
    Handle block iteration and retry. Manage state including collection of frames to mark for hide.
    
    Parameters:
    
    isRetry - Allows differentiation of behavior for retry and iterate.
  - deferMarkFrames
```
private void deferMarkFrames(java.util.ArrayList<java.lang.Integer> list,
                             int mode)
```
    Setup the deferral processing to mark frames for hiding.
    
    Parameters:
    
    list - Array of frame IDs.
    
    mode - Code of the performed operation.
  - isDoBlock
```
private boolean isDoBlock(BlockType type)
```
    Check current block scope for type of block.
    
    Parameters:
    
    type - The current block's type.
    
    Returns:
    
    true if current block scope is a DO block.
  - isSpecialBlock
```
private boolean isSpecialBlock(BlockType type)
```
    Check type of current block and return true if this is some kind of FOR or REPEAT loop. This excludes non-looping FOR blocks.
    
    Parameters:
    
    type - The current block's type.
    
    Returns:
    
    true if current block is a FOR loop or REPEAT block.
  - hasViewed
```
private boolean hasViewed()
```
    Check if the viewed set exists and is not empty.
    
    Returns:
    
    See above.
  - hasFrames
```
private boolean hasFrames()
```
    Check if the frames map exists and is not empty.
    
    Returns:
    
    See above.
  - hasDeepFrames
```
private boolean hasDeepFrames()
```
    Check if the deepFrames map exists and is not empty.
    
    Returns:
    
    See above.
  - hasHidden
```
private boolean hasHidden()
```
    Check if the hidden list exists and is not empty.
    
    Returns:
    
    See above.
  - getViewed
```
private org.roaringbitmap.RoaringBitmap getViewed()
```
    Get the viewed set and create it if it does not exist.
    
    Returns:
    
    See above.
  - getDeepFrames
```
private java.util.HashMap<java.lang.Integer,GenericFrame> getDeepFrames()
```
    Get the deepFrames map and create it if it does not exist.
    
    Returns:
    
    See above.
  - getFrames
```
private java.util.HashMap<java.lang.Integer,GenericFrame> getFrames()
```
    Get the frames map and create it if it does not exist.
    
    Returns:
    
    See above.
  - getHidden
```
private java.util.ArrayList<java.lang.Integer> getHidden()
```
    Get the hidden list and create it if it does not exist.
    
    Returns:
    
    See above.
  - toString
```
public java.lang.String toString()
```
    Prepare human readable representations of the instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class LogicalTerminal.ScopeProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.util.Finalizable

Field Detail

frames

deepFrames

prev

marked

hadException

deferReset

hidden

viewed

canHide

isException

innerViewed

hadWrap

savedInnerViewed

realTopLevel

topLevel

forceCanHide

interactionsAtEntry

Constructor Detail

ScopeProcessor

Method Detail

forceHiding

frameViewed

frameWrapped

finished

deleted

register

iterate

retry

condition

clearTopLevelFlag

process

deferMarkFrames

isDoBlock

isSpecialBlock

hasViewed

hasFrames

hasDeepFrames

hasHidden

getViewed

getDeepFrames

getFrames

getHidden

toString