de.dante.extex.interpreter.primitives.register.muskip
Class Gluetomu

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.register.muskip.Gluetomu
All Implemented Interfaces:
Code, Localizable, MuskipConvertible, java.io.Serializable

public class Gluetomu
extends AbstractCode
implements MuskipConvertible

This class provides an implementation for the primitive \gluetomu.

The Primitive \gluetomu

The primitive \gluetomu converts a glue specification to a muglue specification. For this conversion 1mu=1pt is assumed. This primitive can be used wherever a muskip is expected.

Syntax

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

Examples

    \muskip0=\gluetomu1pt  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Gluetomu(java.lang.String name)
          Creates a new object.
 
Method Summary
 Muskip convertMuskip(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a muskip.
 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.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

serialVersionUID

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

See Also:
Constant Field Values
Constructor Detail

Gluetomu

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

Parameters:
name - the name for tracing and debugging
Method Detail

convertMuskip

public Muskip convertMuskip(Context context,
                            TokenSource source,
                            Typesetter typesetter)
                     throws InterpreterException
Description copied from interface: MuskipConvertible
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:
InterpreterException - in case of an error
See Also:
MuskipConvertible.convertMuskip( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

execute

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
Overrides:
execute in class AbstractCode
Throws:
InterpreterException
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)