org.extex.unit.tex.register
Class Chardef

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.register.Chardef

All Implemented Interfaces:

java.io.Serializable, Code

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: 4770 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Chardef(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.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

Chardef

public Chardef(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)