org.kahina.qtype.bridge

Class QTypeBridge

java.lang.Object

org.kahina.core.bridge.KahinaBridge

org.kahina.lp.bridge.LogicProgrammingBridge

org.kahina.prolog.bridge.PrologBridge

org.kahina.sicstus.bridge.SICStusPrologBridge

org.kahina.qtype.bridge.QTypeBridge

All Implemented Interfaces:

KahinaListener

public class QTypeBridge
extends SICStusPrologBridge

Field Summary

Fields inherited from class org.kahina.lp.bridge.LogicProgrammingBridge

currentID, selectedID, skipFlag, skipID, stepIDConv, waitingForReturnFromSkip

Fields inherited from class org.kahina.core.bridge.KahinaBridge

kahina

Constructor Summary

Constructors

Constructor and Description
QTypeBridge(QTypeDebuggerInstance kahina)

Method Summary

Methods

Modifier and Type	Method and Description
void	call(int extID) Called, typically following a call to #step(int, String, Stirng, String) very soon, to indicate that the call port of the procedure box with the given ID has been reached.
void	exit(int extID, boolean deterministic, java.lang.String newDescription)
void	fail(int extID) Called to indicate that the fail port of the procedure box with the given ID has been reached.
protected QTypeStep	generateStep()
void	redo(int extID) Called to indicate that the redo port of the procedure box with the given ID has been reached.
void	registerExample(int number, java.lang.String expectation, java.lang.String sentence)
void	registerGoal(int extID, java.lang.String key, java.lang.String grisu)
void	step(int extID, java.lang.String type, java.lang.String description, java.lang.String consoleMessage) For each new procedure box that is created, this method or one of its variants must first be called.
int	virtualRedo(int stepID)

Methods inherited from class org.kahina.sicstus.bridge.SICStusPrologBridge

registerBinding

Methods inherited from class org.kahina.prolog.bridge.PrologBridge

isQueryRoot

Methods inherited from class org.kahina.lp.bridge.LogicProgrammingBridge

canSkipOrAutocomplete, convertStepID, deregister, end, exception, exit, exit, getAction, getBridgeState, getParentCandidateID, isPaused, linkNodes, maybeUpdateStepCount, performBreakAction, performCompleteAction, performCreepAction, performFailAction, performSkipAction, processControlEvent, processEvent, processSelectionEvent, processSystemEvent, processWarnEvent, registerLayer, registerStepSourceCodeLocation, select, selectIfPaused, setBridgeState, setParentCandidateID, step, step, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

QTypeBridge

public QTypeBridge(QTypeDebuggerInstance kahina)

Method Detail

step

public void step(int extID,
        java.lang.String type,
        java.lang.String description,
        java.lang.String consoleMessage)

Description copied from class: LogicProgrammingBridge

For each new procedure box that is created, this method or one of its variants must first be called. It is separate from LogicProgrammingBridge.call(int) for historic reasons and for flexibility, e.g. it can be overloaded with various arguments representing all kinds of information about a step without touching the call method. Note however that information about a step that is not absolutely central, such as source code locations, should be sent to Kahina using specialized methods following the call to the step method.

Overrides:

step in class LogicProgrammingBridge

Parameters:

extID - An ID identifying the procedure box uniquely.

type - A string identifying the type of the step, e.g. a Prolog predicate identifier such as append/3. Will be used for categorizing and counting steps in the profiler.

description - A full description of the step, such as append([1,2],[3,4],X). Will be used for labeling nodes in the control flow graph.

consoleMessage - A more extensive description of the (type of) the step, such as a prose description of what append/3 does. Will be displayed in the message console.

call

public void call(int extID)

Description copied from class: LogicProgrammingBridge

Called, typically following a call to #step(int, String, Stirng, String) very soon, to indicate that the call port of the procedure box with the given ID has been reached. This will cause the corresponding node to appear in Kahina's control flow graph.

Overrides:

call in class LogicProgrammingBridge

redo

public void redo(int extID)

Description copied from class: LogicProgrammingBridge

Called to indicate that the redo port of the procedure box with the given ID has been reached. This will create a copy of the original step in Kahina's data model, and a new node in Kahina's control flow graph, distinct from nodes created by previous calls and redos of the box, but labeled with the same ID. Internally, Kahina uses a different set of IDs to distinguish different "instantiations" of the same procedure box when it is redone.

Overrides:

redo in class LogicProgrammingBridge

virtualRedo

public int virtualRedo(int stepID)

Overrides:

virtualRedo in class LogicProgrammingBridge

exit

public void exit(int extID,
        boolean deterministic,
        java.lang.String newDescription)

Overrides:

exit in class LogicProgrammingBridge

fail

public void fail(int extID)

Description copied from class: LogicProgrammingBridge

Called to indicate that the fail port of the procedure box with the given ID has been reached.

Overrides:

fail in class LogicProgrammingBridge

registerExample

public void registerExample(int number,
                   java.lang.String expectation,
                   java.lang.String sentence)

generateStep

protected QTypeStep generateStep()

Overrides:

generateStep in class SICStusPrologBridge

registerGoal

public void registerGoal(int extID,
                java.lang.String key,
                java.lang.String grisu)