org.extex.unit.tex.math.util
Class TeXMathcharCode

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.math.AbstractMathCode
          org.extex.unit.tex.math.AbstractTeXMathCode
              org.extex.unit.tex.math.util.TeXMathcharCode

All Implemented Interfaces:

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

public class TeXMathcharCode
extends AbstractTeXMathCode
implements MathCodeConvertible, CountConvertible, Showable, Theable

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

Version:

$Revision:4431 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

TeXMathcharCode(CodeToken token, MathCode charCode)
Creates a new object.

Method Summary

long	convertCount(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a count.
MathCode	convertMathCode(Context context, TokenSource source, Typesetter typesetter) This method converts an implementing class into a MathCode.
void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) 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.
Tokens	show(Context context) This method is the getter for the description of the primitive.
Tokens	the(Context context, TokenSource source, Typesetter typesetter) This method is the getter for the description of the primitive.

Methods inherited from class org.extex.unit.tex.math.AbstractTeXMathCode

mathCodeToLong, parseMathCode

Methods inherited from class org.extex.unit.tex.math.AbstractMathCode

getListMaker

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 constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Constructor Detail

TeXMathcharCode

public TeXMathcharCode(CodeToken token,
                       MathCode charCode)

Creates a new object.

Parameters:

token - the initial token for the primitive

charCode - the code of the math char

Method Detail

convertCount

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

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

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

convertMathCode

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

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:

TypesetterException - in case of an error in the typesetter

See Also:

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

execute

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

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:

TypesetterException - in case of an error in the typesetter

MissingMathException

See Also:

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

show

public Tokens show(Context context)
            throws HelpingException

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:

HelpingException - in case of an error

See Also:

Showable.show( org.extex.interpreter.context.Context)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws CatcodeException,
                  HelpingException,
                  TypesetterException

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:

CatcodeException - in case of an error in token creation

HelpingException - in case of an error

TypesetterException - in case of an error

See Also:

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