de.dante.extex.interpreter.primitives.math.util
Class OmegaMathcharCode

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.math.AbstractMathCode
          de.dante.extex.interpreter.primitives.math.AbstractOmegaMathCode
              de.dante.extex.interpreter.primitives.math.util.OmegaMathcharCode

All Implemented Interfaces:

Code, CountConvertible, Localizable, MathCodeConvertible, java.io.Serializable, Showable, Theable

public class OmegaMathcharCode

extends AbstractOmegaMathCode

implements MathCodeConvertible, CountConvertible, Showable, Theable

This class is used to dynamically define mathematical characters having the Omega encoding into a count value.

Version:

$Revision: 1.2 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

OmegaMathcharCode

public OmegaMathcharCode(java.lang.String name,
                         MathCode charCode)

Creates a new object.

Parameters:

name - the name for debugging

charCode - the code of the math char

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException

Description copied from interface: CountConvertible

This method converts a register into a count. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:

convertCount in interface CountConvertible

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter to use for conversion

Returns:

the converted value

Throws:

InterpreterException - in case of an error

See Also:

CountConvertible.convertCount( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

convertMathCode

public MathCode convertMathCode(Context context,
                                TokenSource source,
                                Typesetter typesetter)
                         throws InterpreterException

Description copied from interface: MathCodeConvertible

This method converts an implementing class into a MathCode. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:

convertMathCode in interface MathCodeConvertible

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter to use for conversion

Returns:

the converted value

Throws:

InterpreterException - in case of an error

See Also:

MathCodeConvertible.convertMathCode( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

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)

show

public Tokens show(Context context)
            throws InterpreterException

Description copied from interface: Showable

This method is the getter for the description of the primitive.

Specified by:

show in interface Showable

Parameters:

context - the interpreter context

Returns:

the description of the primitive as list of Tokens

Throws:

InterpreterException - in case of an error

See Also:

Showable.show( de.dante.extex.interpreter.context.Context)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException

Description copied from interface: Theable

This method is the getter for the description of the primitive.

Specified by:

the in interface Theable

Parameters:

context - the interpreter context

source - the source for further tokens to qualify the request

typesetter - the typesetter to use

Returns:

the description of the primitive as list of Tokens

Throws:

InterpreterException - in case of an error

See Also:

Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)