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

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

All Implemented Interfaces:

Code, CodeExpander, ExpandableCode, Localizable, java.io.Serializable

public class Noexpand

extends AbstractCode

implements ExpandableCode, CodeExpander

This class provides an implementation for the primitive \noexpand.

The Primitive \noexpand

The primitive \noexpand prevents a token from being expanded when collecting the expanded tokens for arguments of macros like \edef, \xdef, \message, and others.

If the token following the \noexpand is not a control sequence or active character then the primitive does nothing at all. The primitive is also void if it occurs outside the said expansion context.

Syntax

    ⟨noexpand⟩
      → \noexpand  

Examples

    \noexpand  

Version:

$Revision: 1.20 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Noexpand

public Noexpand(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

execute

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

Description copied from interface: Code

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

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)