org.extex.unit.etex.info
Class Showtokens

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.etex.info.Showtokens
All Implemented Interfaces:
java.io.Serializable, LogEnabled, Code

public class Showtokens
extends AbstractCode
implements LogEnabled

This class provides an implementation for the primitive \showtokens.

The Primitive \showtokens

The primitive \showtokens shows some tokens on the log stream. This is meant for diagnostic and debugging purposes.

Syntax

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

Examples

    \showtokens {1234}  
    \showtokens \expandafter{\jobname}  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Showtokens(CodeToken token)
          Creates a new object.
 
Method Summary
 void enableLogging(java.util.logging.Logger log)
          Setter for the logger.
 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.
 
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

Showtokens

public Showtokens(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

enableLogging

public void enableLogging(java.util.logging.Logger log)
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
log - the logger to use
See Also:
LogEnabled.enableLogging( java.util.logging.Logger)

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)