org.extex.unit.tex.math.symbol
Class Mathchar

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.math.AbstractMathCode
          extended by org.extex.unit.tex.math.AbstractTeXMathCode
              extended by org.extex.unit.tex.math.symbol.Mathchar
All Implemented Interfaces:
java.io.Serializable, Code, MathCodeConvertible

public class Mathchar
extends AbstractTeXMathCode
implements MathCodeConvertible

This class provides an implementation for the primitive \mathchar.

The Math Primitive \mathchar

The primitive \mathchar inserts a mathematical character consisting of a math class and a character code into the current math list. This is supposed to work in math mode only.

TODO missing documentation

Syntax

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

Examples

    \mathchar"041  
    \mathchar{ordinary 0 `A}  

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
Mathchar(CodeToken token)
          Creates a new object.
 
Method Summary
 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.
 
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

Mathchar

public Mathchar(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

convertMathCode

public MathCode convertMathCode(Context context,
                                TokenSource source,
                                Typesetter typesetter)
                         throws HelpingException,
                                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:
HelpingException - in case of an error
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 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)