org.extex.unit.omega.ocp
Class OcpPrimitive

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

All Implemented Interfaces:

java.io.Serializable, Code, ResourceAware

public class OcpPrimitive
extends AbstractAssignment
implements ResourceAware

This class provides an implementation for the primitive \ocp.

The Primitive \ocp

The primitive \ocp can be used to define a control sequence which holds an ΩCP program.

This primitive is an assignment. This means that the value of \globaldefs and \afterassignment are taken into account.

Syntax

The formal description of this primitive is the following:

    ⟨ocp⟩
      → ⟨prefix⟩ \ocp ⟨control sequence⟩  ⟨equals⟩ ⟨resource name⟩  

Examples

 \ocp\abc=def 

Version:

$Revision: 4770 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Constructor Summary

OcpPrimitive(CodeToken token)
Creates a new object.

Method Summary

void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().
void	setResourceFinder(ResourceFinder resourceFinder) Setter for the resource finder.

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

execute

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

Constructor Detail

OcpPrimitive

public OcpPrimitive(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

assign

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

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

TypesetterException - in case of an error in the typesetter

HelpingException - in case of an error

See Also:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

setResourceFinder

public void setResourceFinder(ResourceFinder resourceFinder)

Setter for the resource finder.

Specified by:

setResourceFinder in interface ResourceAware

Parameters:

resourceFinder - the resource finder

See Also:

ResourceAware.setResourceFinder( org.extex.resource.ResourceFinder)