de.dante.extex.interpreter.primitives.info
Class The

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.info.The
All Implemented Interfaces:
Code, CodeExpander, ExpandableCode, Localizable, java.io.Serializable

public class The
extends AbstractCode
implements ExpandableCode, CodeExpander

This class provides an implementation for the primitive \the.

The Primitive \the

The primitive \the inserts the definition of certain primitives into the input stream. If the token following \the is not theable then an error is raised.

During the expansion of arguments of macros like \edef, \xdef, \message, and others the further expansion of the tokens is inhibited.

Syntax

The formal description of this primitive is the following:
    ⟨the⟩
      → \the ⟨internal quantity⟩ 

Examples

    \the\count123  

Version:
$Revision: 1.31 $
Author:
Gerd Neugebauer, Michael Niedermair
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
The(java.lang.String name)
          Creates a new object.
 
Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          Get the next token (not expand) and if it Theable, then call the() and put the result on the stack.
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
 void expandCode(Context context, TokenSource source, Typesetter typesetter, Tokens tokens)
          Expand the first token and place the result in a token list.
 
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

The

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

Parameters:
name - the name for tracing and debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Get the next token (not expand) and if it Theable, then call the() and put the result on the stack.

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Throws:
InterpreterException
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)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: ExpandableCode
This method takes the first token and expands it. The result is placed on the stack. This means that expandable code does one step of expansion and puts the result on the stack. To expand a token it might be necessary to consume further tokens.

Specified by:
expand in interface ExpandableCode
Parameters:
prefix - the prefix flags controlling the expansion
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
ExpandableCode.expand( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

expandCode

public void expandCode(Context context,
                       TokenSource source,
                       Typesetter typesetter,
                       Tokens tokens)
                throws InterpreterException
Description copied from interface: CodeExpander
Expand the first token and place the result in a token list. During the expansion additional tokens might be used.

Specified by:
expandCode in interface CodeExpander
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter
tokens - the target token list
Throws:
InterpreterException - in case of an error
See Also:
CodeExpander.expandCode( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter, de.dante.extex.interpreter.type.tokens.Tokens)