org.extex.unit.tex.register.muskip
Class MuskipParameter

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.register.muskip.MuskipParameter

All Implemented Interfaces:

java.io.Serializable, MuskipConvertible, Code, Advanceable, Divideable, Multiplyable, Theable

Direct Known Subclasses:

MuskipPrimitive

public class MuskipParameter
extends AbstractAssignment
implements MuskipConvertible, Advanceable, Multiplyable, Divideable, Theable

This class provides an implementation for the primitive \muskip. It sets the named dimen register to the value given, and as a side effect all prefixes are zeroed.

Example

 \muskip=345pt plus 123em
 

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

MuskipParameter(CodeToken token)
Creates a new object.

MuskipParameter(CodeToken token, java.lang.String key)
Creates a new object.

Method Summary

void	advance(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \advance has been seen.
void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().
Muskip	convertMuskip(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a muskip.
void	divide(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \divide has been seen.
protected java.lang.String	getKey(Context context, TokenSource source, Typesetter typesetter) Return the key (the number) for the skip register.
void	multiply(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \multiply has been seen.
Tokens	the(Context context, TokenSource source, Typesetter typesetter) This method is the getter for the description of the primitive.

Methods inherited from class org.extex.interpreter.type.AbstractAssignment

execute

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

MuskipParameter

public MuskipParameter(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

MuskipParameter

public MuskipParameter(CodeToken token,
                       java.lang.String key)

Creates a new object.

Parameters:

token - the initial token for the primitive

key - the reference key

Method Detail

advance

public void advance(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

This method is called when the macro \advance has been seen. It performs the remaining tasks for the expansion.

Specified by:

advance in interface Advanceable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Advanceable.advance( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

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:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

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)

divide

public void divide(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

This method is called when the macro \divide has been seen. It performs the remaining tasks for the expansion.

Specified by:

divide in interface Divideable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Divideable.divide( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws HelpingException,
                                  TypesetterException

Return the key (the number) for the skip register.

Parameters:

context - the interpreter context to use

source - the source for the next tokens – if required

typesetter - the typesetter

Returns:

the key for the skip register

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

multiply

public void multiply(Flags prefix,
                     Context context,
                     TokenSource source,
                     Typesetter typesetter)
              throws HelpingException,
                     TypesetterException

This method is called when the macro \multiply has been seen. It performs the remaining tasks for the expansion.

Specified by:

multiply in interface Multiplyable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Multiplyable.multiply( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws HelpingException,
                  TypesetterException

This method is the getter for the description of the primitive.

Specified by:

the in interface Theable

Parameters:

context - the interpreter context

source - the source for further tokens to qualify the request

typesetter - the typesetter to use

Returns:

the description of the primitive as list of Tokens

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error

See Also:

Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)