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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.info.Show
All Implemented Interfaces:
Code, Localizable, LogEnabled, java.io.Serializable
Direct Known Subclasses:
Meaning

public class Show
extends AbstractCode
implements LogEnabled

This class provides an implementation for the primitive \show.

The Primitive \show

The primitive \show consumes the following token and prints the definition of the token to the output stream an into the log file.

Syntax

The formal description of this primitive is the following:
    ⟨show⟩
       → \show ⟨token⟩ 

Examples

Examples:
    \show\abc
    > \abc=undefined
  
    \show \def
    > \def=\def.
  
    \let\xxx=\def\show \xxx
    > \xxx=\def.
  
    \def\m{abc}\show \m
    > \m=macro:
    ->abc.
  
    \show a
    > the letter a.
  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Show(java.lang.String name)
          Creates a new object.
 
Method Summary
 void enableLogging(java.util.logging.Logger theLogger)
          Setter for the logger.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it.
protected  Tokens meaning(Token t, Context context)
          Get the descriptions of a token as 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

Show

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

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

enableLogging

public void enableLogging(java.util.logging.Logger theLogger)
Description copied from interface: LogEnabled
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
theLogger - 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 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)

meaning

protected Tokens meaning(Token t,
                         Context context)
                  throws InterpreterException
Get the descriptions of a token as token list.

Parameters:
t - the token to describe
context - the interpreter context
Returns:
the token list describing the token
Throws:
InterpreterException - in case of an error