org.extex.unit.omega.ocp
Class AbstractOcplist

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.omega.ocp.AbstractOcplist

All Implemented Interfaces:

java.io.Serializable, Code, OcplistConvertible

Direct Known Subclasses:

Addafterocplist, Addbeforeocplist, Removeafterocplist, Removebeforeocplist

public abstract class AbstractOcplist
extends AbstractCode
implements OcplistConvertible

This is the abstract base class for ΩCP lists.

Version:

$Revision: 6447 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Constructor Summary

AbstractOcplist(CodeToken token)
Creates a new object.

Method Summary

void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and executes it.
static OcpList	scanOcplist(Context context, TokenSource source, Typesetter typesetter) Scan an ΩCP list.

Methods inherited from class org.extex.interpreter.type.AbstractCode

getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.extex.unit.omega.ocp.util.OcplistConvertible

convertOcplist

Constructor Detail

AbstractOcplist

public AbstractOcplist(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

scanOcplist

public static OcpList scanOcplist(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws HelpingException

Scan an ΩCP list.

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

Returns:

the ΩCP list

Throws:

HelpingException - in case of an error

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:

execute in interface Code

Overrides:

execute in class AbstractCode

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)