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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.register.box.AbstractBox
          extended byde.dante.extex.interpreter.primitives.info.Showgroups
All Implemented Interfaces:
Code, Configurable, Localizable, LogEnabled, java.io.Serializable

public class Showgroups
extends AbstractBox
implements LogEnabled, Configurable

This class provides an implementation for the primitive \showgroups.

The Primitive \showgroups

The primitive \showgroups prints the list of group descriptions to the log file. The list consists of descriptions of the currently open groups in descending order.

Syntax

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

Examples

    \showgroups  

Configuration

The primitive takes an optional attribute named format. If this attribute is present and has the value short then only the line number is logged instead of the complete locator.

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Showgroups(java.lang.String name)
          Creates a new object.
 
Method Summary
 void configure(Configuration config)
          Configure an object according to a given Configuration.
 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.
 
Methods inherited from class de.dante.extex.interpreter.primitives.register.box.AbstractBox
getKey
 
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

Showgroups

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

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

configure

public void configure(Configuration config)
               throws ConfigurationException
Description copied from interface: Configurable
Configure an object according to a given Configuration.

Specified by:
configure in interface Configurable
Parameters:
config - the configuration object to consider
Throws:
ConfigurationException - in case that something went wrong
See Also:
Configurable.configure( de.dante.util.framework.configuration.Configuration)

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)