de.dante.extex.interpreter.primitives.register
Class Chardef

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.register.Chardef
All Implemented Interfaces:
Code, Localizable, java.io.Serializable

public class Chardef
extends AbstractAssignment

This class provides an implementation for the primitive \chardef.

The Primitive \chardef

The primitive \chardef allows you to define a control sequence or active character to be equivalent to a character. This mean that the new entity can be used wherever a character is allowed.

A character is represented by a code point; i.e. a positive number denoting the character position. In TeX only 8-bit number where allowed. In ExTeX arbitrary positive numbers are valid as values.

The definition is performed with respect to to group to keep it locally. The prefix /global or the value of \globaldefs can influence the scope.

This primitive is an assignment. All actions around assignments are performed.

Syntax

The formal description of this primitive is the following:
    ⟨chardef⟩
      → \chardef ⟨control sequence⟩ ⟨equals⟩ ⟨number⟩  

Examples

    \chardef\abc=45  
    \chardef\abc 33  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Chardef(java.lang.String name)
          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 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

Chardef

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

Parameters:
name - the name for debugging
Method Detail

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)