org.extex.unit.omega.translation
Class InputTranslation

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.omega.mode.AbstractModeCode
          org.extex.unit.omega.translation.InputTranslation

All Implemented Interfaces:

java.io.Serializable, Code, ResourceAware

public class InputTranslation
extends AbstractModeCode
implements ResourceAware

This class provides an implementation for the primitive \InputTranslation.

The Primitive \InputTranslation

TODO missing documentation

Syntax

The formal description of this primitive is the following:

    ⟨InputTranslation⟩
      → \InputTranslation ⟨in file⟩ ⟨ocp file name⟩  

Examples

 \InputTranslation 4 myocp 

Version:

$Revision:4411 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The field serialVersionUID contains the version number for serialization.

Fields inherited from class org.extex.unit.omega.mode.AbstractModeCode

DEFAULT_INPUT_MODE, DEFAULT_INPUT_TRANSLATION, DEFAULT_OUTPUT_MODE, DEFAULT_OUTPUT_TRANSLATION, INPUT_MODE, INPUT_TRANSLATION, OUTPUT_MODE, OUTPUT_TRANSLATION

Constructor Summary

InputTranslation(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.
void	setResourceFinder(ResourceFinder finder) Setter for the resource finder.

Methods inherited from class org.extex.unit.omega.mode.AbstractModeCode

scanInputMode, scanOutputMode

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

The field serialVersionUID contains the version number for serialization.

See Also:

Constant Field Values

Constructor Detail

InputTranslation

public InputTranslation(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

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)

setResourceFinder

public void setResourceFinder(ResourceFinder finder)

Setter for the resource finder.

Specified by:

setResourceFinder in interface ResourceAware

Parameters:

finder - the resource finder

See Also:

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