de.dante.extex.interpreter.primitives.scanner
Class Scantokens

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

public class Scantokens
extends AbstractCode
implements ExpandableCode

This class provides an implementation for the primitive \scantokens.

The Primitive \scantokens

The primitive \scantokens takes an unexpanded list of tokens and uses them as a new source for an input stream. For this purpose the tokens are translated into a string which is used as if it where written to a file and read back in.

The tokens from the tokens register \everyeof are inserted when the stream has no more tokens to read.

Syntax

The formal description of this primitive is the following:
    ⟨scantokens⟩
      → \scantokens ⟨tokens⟩  

Examples

    \scantokens{abc}  

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

Field Summary
protected static long serialVersionUID
          The field serialVersionUID contains the id for serialization.
 
Constructor Summary
Scantokens(java.lang.String codeName)
          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.
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
 
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 field serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

Scantokens

public Scantokens(java.lang.String codeName)
Creates a new object.

Parameters:
codeName - the name of the primitive for debugging
Method Detail

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:
AbstractCode.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)