net.sourceforge.czt.circus.ast

Interface BasicProcess

All Superinterfaces:

CircusProcess, Term

All Known Implementing Classes:

BasicProcessImpl

public interface BasicProcess
extends CircusProcess

A process definition for an explicit process declaration. It is formed by a (possibly empty) set of process paragraphs, an optional process state given as a schema and a (mandatory) main action definition.

It represents the grammar rule begin PParagraph* state Schema-Exp PParagraph* @ Action end.

For the process state, the corresponding action (as a SchExprAction) or Z paragraph (as a Schema or HorizontalDef) must contain a CircusStateAnn annotation.

Author:

GnAST version 1.6-SNAPSHOT

Method Summary

Modifier and Type	Method and Description
List<? extends Para>	getLocalPara() This is a convenience method.
CircusAction	getMainAction() This is a convenience method.
List<? extends Para>	getOnTheFlyPara() This is a convenience method.
ParaList	getParaList() Returns the ParaList element.
AxPara	getStatePara() This is a convenience method.
Name	getStateParaName() This is a convenience method.
ZName	getStateParaZName() This is a convenience method.
ZParaList	getZParaList() This is a convenience method.
boolean	isDefaultState() Returns true iff getStatePara() != null and the result is the default state paragraph as created by the parser.
boolean	isMainActionValid()
boolean	isStateValid() This method checks whether the state paragraph is valid.
void	setParaList(ParaList paraList) Sets the ParaList element.

Methods inherited from interface net.sourceforge.czt.base.ast.Term

accept, annsSize, create, getAnn, getAnns, getChildren, hasAnn, hasAnn, removeAnn, removeAnn

Method Detail

getParaList

ParaList getParaList()

Returns the ParaList element.

Returns:

the ParaList element.

setParaList

void setParaList(ParaList paraList)

Sets the ParaList element.

Parameters:

paraList - the ParaList element.

See Also:

getParaList()

getStatePara

AxPara getStatePara()

This is a convenience method. It returns the state paragraph within the getZParaList(). That is, the first paragraph with a CircusStateAnn. A state paragraph is always a horizonal AxPara. When declared implicitly a default name is given with the prefix CircusUtils.DEFAULT_PROCESS_STATE_NAME.

isStateValid

boolean isStateValid()

This method checks whether the state paragraph is valid. That is, if getStatePara() != null and that getZParaList() contains exactly one state element. The parser always creates a default state for basic process declared without state. So, after parsing, this method should always be true. It may be false when the parser is still creating the underlying structures, or when created manually by the user.

isDefaultState

boolean isDefaultState()

Returns true iff getStatePara() != null and the result is the default state paragraph as created by the parser. The default state paragraph is empty (i.e., horizontal box named CircusUtils.DEFAULT_PROCESS_STATE_NAME. with empty declarations and true predicate).

Returns:

getMainAction

CircusAction getMainAction()

This is a convenience method. It returns the main action within the getZParaList(). The method checks that only one such paragraph exists, that it has a OnTheFlyAnn in it, and that its name is CircusUtils.DEFAULT_MAIN_ACTION_NAME. All these invariants are guaranteed by both the parser and typechecker.

isMainActionValid

boolean isMainActionValid()

getLocalPara

List<? extends Para> getLocalPara()

This is a convenience method. It returns a unmodifiable list of declared paragraphs within the getZParaList(); they may be either Circus or Z paragraphs. That is, all paragraphs from getZParaList() that have not been declared on-the-fly. All these invariants are guaranteed by both the parser and typechecker.

getOnTheFlyPara

List<? extends Para> getOnTheFlyPara()

This is a convenience method. It returns a unmodifiable list of on-the-fly paragraphs within the getZParaList(); they can only be ActionPara, since there are no Z on-the-fly paragraphs. That is, all paragraphs from getZParaList() that have been declared on-the-fly. All elements in the resulting list contain a OnTheFlyAnn. All these invariants are guaranteed by both the parser and typechecker.

getZParaList

ZParaList getZParaList()

This is a convenience method. It represents the non-null (possibly empty) list of paragraphs for the basic process. It contains both Z and Circus paragraphs. It may throw a UnsupportedAstClassException is #getParaList() is a ParaJoker. This method forms a partition between getOnTheFlyPara() and getLocalPara(). All these invariants are guaranteed by both the parser and typechecker.

getStateParaName

Name getStateParaName()

This is a convenience method. It represents the non-null name of the (possibly implicitly) declared process state name.

getStateParaZName

ZName getStateParaZName()

This is a convenience method. It casts getStateParaName() into a ZName.