org.extex.unit.tex.info
Class The

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.info.The

All Implemented Interfaces:

java.io.Serializable, Code, CodeExpander, ExpandableCode

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

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(CodeToken token)
Creates a new object.

Method Summary

void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.
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 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

The

public The(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:

execute in interface Code

Overrides:

execute in class AbstractCode

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:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

ExpandableCode.expand(org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

expandCode

public void expandCode(Context context,
                       TokenSource source,
                       Typesetter typesetter,
                       Tokens tokens)
                throws HelpingException,
                       TypesetterException

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:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

CodeExpander.expandCode( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, org.extex.scanner.type.tokens.Tokens)