org.extex.unit.etex.register.muskip
Class Muexpr

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.etex.register.muskip.Muexpr
All Implemented Interfaces:
java.io.Serializable, MuskipConvertible, Code

public class Muexpr
extends AbstractCode
implements MuskipConvertible

This class provides an implementation for the primitive \muexpr.

The Primitive \muexpr

The primitive \muexpr evaluates an expression which results in a mu value.

TODO missing documentation

Syntax

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

Examples

    \muexpr  

Version:
$Revision:4431 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Constructor Summary
Muexpr(CodeToken token)
          Creates a new object.
 
Method Summary
 Muskip convertMuskip(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a muskip.
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
execute, 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
 

Constructor Detail

Muexpr

public Muexpr(CodeToken token)
Creates a new object.

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

convertMuskip

public Muskip convertMuskip(Context context,
                            TokenSource source,
                            Typesetter typesetter)
                     throws HelpingException,
                            TypesetterException
This method converts a register into a muskip. 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. The return value is the length in scaled points.

Specified by:
convertMuskip in interface MuskipConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value in mu
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
MuskipConvertible.convertMuskip( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)