org.extex.unit.etex.info
Class Showgroups

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.etex.info.Showgroups

All Implemented Interfaces:

java.io.Serializable, Configurable, LogEnabled, Code

public class Showgroups
extends AbstractCode
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: 4770 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Showgroups(CodeToken token)
Creates a new object.

Method Summary

void	configure(Configuration config) Configure an object according to a given Configuration.
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.

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

Showgroups

public Showgroups(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

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( org.extex.framework.configuration.Configuration)

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)