Class Muskipdef

  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.register.muskip.AbstractMuskip
              extended by org.extex.unit.tex.register.muskip.Muskipdef
All Implemented Interfaces:, Code

public class Muskipdef
extends AbstractMuskip

This class provides an implementation for the primitive \muskipdef.

The Primitive \muskipdef

The primitive \muskipdef can be used to define a control sequence as alias for a muskip register. The control sequence can be used wherever a muskip register is expected afterwards.

The primitive \muskipdef is an assignment. Thus the settings of \afterassignment and \globaldefs are applied.

The prefix \global can be used to make the assignment to the new control sequence global instead of the group-local assignment which is the default.


The formal description of this primitive is the following:
      → ⟨modifier⟩ \muskipdef ⟨control sequence⟩ ⟨equals⟩ ⟨register name⟩

       |  \global  


    \muskipdef\abc 33  

Differences to TeX and Friends

In TeX the register name could consist of an integer in the range from 0 to 255. In Omega this restriction has been relaxed to allow integers from 0 to 32767. In ExTeX the restriction to integers has been relaxed. The register name can either be a number – positive or not and of any value – or alternatively any token sequence enclosed in braces.

Note that the extended register names and the maximal number acceptable as register names are a feature of ExTeX which is configurable via the count register \max.register. This means that the feature can be disabled in the compatibility modes.

To protect the buildin registers one might consider to use the key "#name" or "muskip#name".

$Revision:4431 $
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
Constructor Summary
Muskipdef(CodeToken token)
          Creates a new object.
Method Summary
 void assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          The method assign is the core of the functionality of execute().
Methods inherited from class org.extex.unit.tex.register.muskip.AbstractMuskip
Methods inherited from class org.extex.interpreter.type.AbstractAssignment
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


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

See Also:
Constant Field Values
Constructor Detail


public Muskipdef(CodeToken token)
Creates a new object.

token - the initial token for the primitive
Method Detail


public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
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
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
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)