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

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.etex.register.muskip.Gluetomu

All Implemented Interfaces:

java.io.Serializable, MuskipConvertible, Code

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:4431 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Gluetomu(CodeToken token)
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 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

Gluetomu

public Gluetomu(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)

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:

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