org.extex.unit.tex.math
Class Mathchoice

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.math.AbstractMathCode
          org.extex.unit.tex.math.Mathchoice

All Implemented Interfaces:

java.io.Serializable, Code

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.

Syntax

The formal description of this primitive is the following:

    ⟨mathchoice⟩
       → \mathchoice {⟨display material⟩}{⟨text material⟩}{⟨script material⟩}{⟨scriptscript material⟩} 

Examples

    \mathchoice{d}{t}{s}{ss}  

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Mathchoice(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. 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.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

Mathchoice

public Mathchoice(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 TypesetterException,
                    HelpingException

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

HelpingException - in case of an error

See Also:

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