de.dante.extex.interpreter.primitives.register.toks
Class Toksdef

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.type.AbstractAssignment
          de.dante.extex.interpreter.primitives.register.toks.AbstractToks
              de.dante.extex.interpreter.primitives.register.toks.Toksdef

All Implemented Interfaces:

Code, Localizable, java.io.Serializable

public class Toksdef

extends AbstractToks

This class provides an implementation for the primitive \toksdef.

The Primitive \toksdef

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

The primitive \toksdef 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

    ⟨toksdef⟩
      → ⟨optional prefix⟩ \toksdef ⟨control sequence⟩ ⟨equals⟩ ⟨register name⟩

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

Examples

    \toksdef\abc=45  

    \toksdef\abc 33  

    \toksdef\abc={xyz}  

    \toksdef\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 buildin registers one might consider to use the key "#name" or "toks#name".

Version:

$Revision: 1.24 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Toksdef

public Toksdef(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

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:

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