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

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

public class Futurelet
extends Let

This class provides an implementation for the primitive \futurelet.

The Primitive \futurelet

The primitive \futurelet lets a token to a control sequence while keeping the token between the two out of sight. This means that this token is stored away and reinserted after the let is complete.

Syntax

The formal description of this primitive is the following:
    ⟨futurelet⟩
      → \futurelet ⟨control sequence⟩ ⟨token⟩ ...  

Examples

    \futurelet \aa\bb x  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Fields inherited from class de.dante.extex.interpreter.primitives.macro.Let
VISITOR
 
Constructor Summary
Futurelet(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.primitives.macro.Let
let
 
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

Futurelet

public Futurelet(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.

Overrides:
assign in class Let
Throws:
InterpreterException
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)