IGraphProcessingEnvironment Interface

The actions employed by this graph processing environment

The backend to be used for graph creation when a graph is imported

Returns a non-interactive user proxy just echoing its inputs.

The action execution environment dependent commands that are available, and a description of each command.

The writer used by emit statements. By default this is Console.Out.

The writer used by emitdebug statements. This is Console.Out, and can't be redirected to a file in contrast to the EmitWriter.

Returns the graph currently focused in processing / sequence execution. This may be the initial main graph, or a subgraph switched to, the current top element of the graph usage stack.

Tells whether execution is interrupted because a highlight statement was hit. Consequence: the timer that normally prints match statistics every second remains silent

Returns true when graph processings is currently occuring inside a subgraph, returns false when the main host graph is currently processed (i.e. only one entry on the current graph stack is existing).

Indexer for accessing the variables by name, via index notation on this object.

The maximum number of matches to be returned for a RuleAll sequence element. If it is zero or less, the number of matches is unlimited.

Returns the named graph currently focused in processing / sequence execution. Returns null if this graph is not a named but an unnamed graph.

PerformanceInfo is used to accumulate information about needed time, found matches and applied rewrites. And additionally search steps carried out if profiling instrumentation code was generated. It must not be null. The user is responsible for resetting the PerformanceInfo object. This is typically done at the start of a rewrite sequence, to measure its performance.

The recorder of the main graph. Might be null (is set if a named graph is available, then the persistent names are taken from the named graph).

Returns the transaction manager of the processing environment. (Recording and undoing changes in the main graph and all processed subgraphs). Don't forget to call Commit after a transaction is finished!

The user proxy queried for choices during sequence execution. By default the compliant user proxy, if debugging the debugger acting on behalf of/controlled by the user.

Returns an iterator over all available (non-null) variables

Adds an existing IEdge object to the current graph of this processing environment and assigns it to the given variable. The edge must not be part of any graph, yet! Source and target of the edge must already be part of the graph.

Adds an existing edge to the graph, names it, and assigns it to the given variable.

Adds a new edge to the current graph of this processing environment and assigns it to the given variable.

Adds a new named edge to the graph and assigns it to the given variable.

Adds an existing INode object to the current graph of this processing environment and assigns it to the given variable. The node must not be part of any graph, yet! The node may not be connected to any other elements!

Adds a new node to the current graph of this processing environment and assigns it to the given variable.

Adds an existing node to the graph, names it, and assigns it to the given variable.

Adds a new named node to the graph and assigns it to the given variable.

Apply a graph rewrite sequence (to the currently associated graph).

Apply a graph rewrite sequence (to the currently associated graph).

Apply a rewrite rule.

Duplicates the graph variables of an old just cloned graph, assigns them to the new cloned graph.

Does action execution environment dependent stuff.

Fires an OnDebugEmit event.

Fires an OnDebugEnter event.

Fires an OnDebugExit event.

Fires an OnDebugHalt event.

Fires an OnDebugHighlight event.

Deletes the given special variable name. Special variables are used for GrGen-internal data storage (as of now only "this"-reference handling).

Fires an OnEndOfIteration event. This informs the debugger about the end of a loop iteration, so it can display the state at the end of the iteration.

Fires an OnEnteringSequence event.

Evaluate a graph rewrite sequence expression (on the currently associated graph).

Evaluate a graph rewrite sequence expression (on the currently associated graph).

Fires an OnExitingSequence event.

Filters the matches of a rule (all) call with a lambda expression filter (call).

Fires an OnFinished event.

Fires an OnFinishing event.

Retrieves the IEdge for a variable name or null, if the variable isn't set yet or anymore. A InvalidCastException is thrown, if the variable is set and does not point to an IEdge object.

Returns a linked list of variables mapping to the given graph element or null, if no variable points to this element

Retrieves the newest version of an IAction object currently available for this graph. This may be the given object.

Retrieves the INode for a variable name or null, if the variable isn't set yet or anymore. A InvalidCastException is thrown, if the variable is set and does not point to an INode object.

Retrieves the value of a special variable name. Special variables are used for GrGen-internal data storage (as of now only "this"-reference handling).

Retrieves the object for a variable name or null, if the variable isn't set yet or anymore

Matches a rewrite rule.

Fires an OnMatched event.

Matches the rewrite rules, without firing the Matched event, but with firing the PreMatch event and Cloning of the matches (so they can stored, or used in an expression combining multiple queries).

Matches a rewrite rule, without firing the Matched event, but with firing the PreMatch event and Cloning of the matches (so they can stored, or used in an expression combining multiple queries like [?r] + [?r], or the action can be called multiple times in a multi rule all call query (on different parameters)).

Matches the rewrite rules, without firing the Matched event, but fires the PreMatched event (for internal or non-debugger use).

Matches a rewrite rule, without firing the Matched event (but fires the PreMatched event - for internal or non-debugger use).

Parses the given sequence string and generates a Sequence object. Any actions in the string must refer to actions from the actions contained in this object.

Parses the given sequence expression string and generates a SequenceExpression object. Any actions in the string must refer to actions from the actions contained in this object.

Fires an OnPreMatched event.

Fires an OnPreMatched event.

Executes the modifications of the according rule to the given match/matches. Fires OnRewritingNextMatch events before each rewrite except for the first one.

Returns from the last switch to subgraph. (One level back on the current graph stack.)

Fires an OnRewritingNextMatch event.

Sets the newest action version for a static action.

Sets the given special variable name to the given value. Special variables are used for GrGen-internal data storage (as of now only "this"-reference handling).

Sets the value of the given variable to the given value. If the variable name is null, this function does nothing. If val is null, the variable is unset.

Switches the graph to the given (sub)graph. (One level added to the current graph stack.)

Tests whether the given sequence succeeds on a clone of the associated graph.

Tests whether the given sequence succeeds on a clone of the associated graph.

Fired when a debug emit is executed.

Fired when a debug entity is entered.

Fired when a debug entity is left.

Fired when a debug halt is executed.

Fired when a debug highlight is executed.

Fired when a sequence iteration is ended.

Fired when a sequence is entered.

Fired when a sequence is left.

Fired after the rewrite step of a rule. Note, that the given matches object may contain invalid entries, as parts of the match may have been deleted!

Fired before the rewrite step of a rule, when at least one match has been found.

Fired after all requested matches of a rule have been matched (after filtering/selection of matches).

Fired after all requested matches of a multi rule or rule have been matched, yet before filtering/selection of the matches. Allows a lookahead on the matches, on all found matches, in contrast to OnMatched that only reports the ones that are applied in the end. Also fired for queries, esp. for queries used for computing rule(/test) arguments, which don't cause a firing of other events.

Fired when graph processing is returning back after a switch. (To the main graph, or a subgraph previously switched to.)

Fired before the next match is rewritten. It is not fired before rewriting the first match.

Fired when graph processing (rule and sequence execution) is switched to a (sub)graph. (Not fired when the main graph is replaced by another main graph, or initialized.)