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

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

All Implemented Interfaces:

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

public class MuskipPrimitive
extends MuskipParameter

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

All features are inherited from MuskipParameter. Just the key has to be provided under which this Muskip has to be stored. This key is constructed from the name, a hash mark and the running number.

The Primitive \muskip

TODO missing documentation

Syntax

The formal description of this primitive is the following:

    ⟨muskip⟩
      → ⟨optional prefix⟩ \muskip  ⟨register name⟩ ⟨equals⟩ ⟨muglue⟩

   ⟨optional prefix⟩
     →
      |  \global ⟨optional prefix⟩  

Examples

   \muskip12=345mu plus 12mu  

   \muskip12=0mu plus 1.2fil  

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

MuskipPrimitive(CodeToken token)
Creates a new object.

Method Summary

protected java.lang.String

getKey(Context context, TokenSource source, Typesetter typesetter) Return the key (the number) for the skip register.

Methods inherited from class org.extex.unit.tex.register.muskip.MuskipParameter

advance, assign, convertMuskip, divide, multiply, the

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

MuskipPrimitive

public MuskipPrimitive(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

getKey

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

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

Overrides:

getKey in class MuskipParameter

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

See Also:

MuskipParameter.getKey( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)