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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.register.muskip.MuskipParameter
All Implemented Interfaces:
Advanceable, Code, Divideable, Localizable, Multiplyable, MuskipConvertible, java.io.Serializable, 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: 1.16 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
MuskipParameter(java.lang.String name)
          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 de.dante.extex.interpreter.type.AbstractAssignment
execute
 
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

MuskipParameter

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

Parameters:
name - the name for debugging
Method Detail

advance

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

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from class: AbstractAssignment
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:
InterpreterException - in case of an error
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)

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)

divide

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

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws InterpreterException
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:
InterpreterException - in case of an error

multiply

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

the

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