de.dante.extex.interpreter.primitives.omega.ocp
Class OcpPrimitive

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.file.AbstractFileCode
          extended byde.dante.extex.interpreter.primitives.omega.ocp.OcpPrimitive
All Implemented Interfaces:
Code, Configurable, Localizable, ResourceConsumer, java.io.Serializable

public class OcpPrimitive
extends AbstractFileCode
implements ResourceConsumer

This class provides an implementation for the primitive \ocp.

The Primitive \ocp

TODO missing documentation

Syntax

The formal description of this primitive is the following:
    ⟨ocp⟩
      → \ocp ...  

Examples

 \ocp\abc=def 

Version:
$Revision: 1.2 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
 
Fields inherited from class de.dante.extex.interpreter.primitives.file.AbstractFileCode
MAX_IN_FILE_NO, MAX_OUT_FILE_NO
 
Constructor Summary
OcpPrimitive(java.lang.String name)
          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.
 void setResourceFinder(ResourceFinder finder)
          Setter for the resource finder.
 
Methods inherited from class de.dante.extex.interpreter.primitives.file.AbstractFileCode
configure, getEncoding, scanFileName, scanInFileKey, scanOutFileKey
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OcpPrimitive

public OcpPrimitive(java.lang.String name)
Creates a new object.

Parameters:
name - the name for debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
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
Throws:
InterpreterException
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

setResourceFinder

public void setResourceFinder(ResourceFinder finder)
Description copied from interface: ResourceConsumer
Setter for the resource finder.

Specified by:
setResourceFinder in interface ResourceConsumer
Parameters:
finder - the resource finder
See Also:
ResourceConsumer.setResourceFinder( de.dante.util.resource.ResourceFinder)