Class Mathchoice

  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.math.AbstractMathCode
          extended byde.dante.extex.interpreter.primitives.math.Mathchoice
All Implemented Interfaces:
Code, Localizable,

public class Mathchoice
extends AbstractMathCode

This class provides an implementation for the primitive \mathchoice.

The Math Primitive \mathchoice

The math primitive \mathchoice provides a switch on the current style of math processing. The math processing is in one of the styles display, text, script, and scriptscript. The math styles influence the size of the typeset material and the spacing. The primitive can be used to insert some material depending on the current math style.

For each of the styles the material to be used must be given. The current style determines which material should be expanded. The material for the other styles is discarded.

The material is enclosed in braces – or to be precise in tokens with the catcodes 1 (left brace) and 2 (right brace). The four cases lead to four groups.

Outside the math mode the primitive raises an error.


The formal description of this primitive is the following:
       → \mathchoice {⟨display material⟩}{⟨text material⟩}{⟨script material⟩}{⟨scriptscript material⟩} 



$Revision: 1.18 $
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
Constructor Summary
Mathchoice(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.
Methods inherited from class de.dante.extex.interpreter.primitives.math.AbstractMathCode
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

Field Detail


protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail


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

name - the name for tracing and debugging
Method Detail


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
execute in class AbstractCode
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)