Let

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.interpreter.primitives.macro
Class Let

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.type.AbstractAssignment
          de.dante.extex.interpreter.primitives.macro.Let

All Implemented Interfaces:: Code, Localizable, java.io.Serializable

Direct Known Subclasses:: Futurelet, Import

public class Let
extends AbstractAssignment

This class provides an implementation for the primitive \let.

The Primitive `\let`

The primitive \let defined a control sequence or active character. The value is taken from the meaning of another token. If the token is a control sequence or active character then the meaning is used. If the other definition is changed the newly defined binding remains intact.

Syntax

The formal description of this primitive is the following:

    ⟨let⟩
      → \let ⟨control sequence⟩ ⟨equals⟩ ⟨token⟩

Examples

    \let\a=\b

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

Field Summary
`protected static long`	`serialVersionUID` The constant `serialVersionUID` contains the id for serialization.
`static TokenVisitor`	`VISITOR` The field `VISITOR` contains the anonymous inner class of the token visitor for the let command.

Constructor Summary
`Let(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()`.
`static void`	`let(Flags prefix, Context context, CodeToken cs, Token t)` Assign a new meaning to a control sequence.

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

VISITOR

public static final TokenVisitor VISITOR

The field VISITOR contains the anonymous inner class of the token visitor for the let command.

Constructor Detail

Let

public Let(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:: Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

let

public static void let(Flags prefix,
                       Context context,
                       CodeToken cs,
                       Token t)
                throws InterpreterException

Assign a new meaning to a control sequence. This is the core of the primitive \let.

Parameters:: prefix - the flags to consider; context - the processor context; cs - the control sequence token to bind; t - the new meaning of the control sequence token. If this parameter is null then an exception is thrown.
Throws:: InterpreterException - in case of an error