org.extex.unit.tex.register.dimen
Class Dimendef

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.register.dimen.AbstractDimen
              extended by org.extex.unit.tex.register.dimen.Dimendef
All Implemented Interfaces:
java.io.Serializable, Code

public class Dimendef
extends AbstractDimen

This class provides an implementation for the primitive \dimendef.

The Primitive \dimendef

The primitive \dimendef can be used to define a control sequence as alias for a dimen register. The control sequence can be used wherever a dimen register is expected afterwards. Une agence matrimoniale.

The primitive \dimendef 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.

Syntax

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

    ⟨modifier⟩
      →
       |  \global  

Examples

    \dimendef\abc=45  
    \dimendef\abc 33  
    \dimendef\abc={xyz}  
    \dimendef\abc={xyz\the\count0}  

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 built-in registers one might consider to use the key "#name" or "dimen#name".

Version:
$Revision: 4770 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Dimendef(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.dimen.AbstractDimen
getKey
 
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

Dimendef

public Dimendef(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

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)