org.extex.unit.tex.info
Class Message

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.info.Message

All Implemented Interfaces:

java.io.Serializable, LogEnabled, Code

public class Message
extends AbstractCode
implements LogEnabled

This class provides an implementation for the primitive \message.

The Primitive \message

The primitive \message takes as argument a list of tokens enclosed in braces and writes them to output stream and into the log file.

If the keywords to log are given then the message is written to the log file only. This is an extension not present in TeX and friends.

Syntax

The formal description of this primitive is the following:

    ⟨message⟩
      → \message { ⟨unprotected tokens⟩ }
       |   \message to log { ⟨unprotected tokens⟩ }
       

Examples

    \message{Hello World!}  

    \message to log {Hello World!}  

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer, Michael Niedermair

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Message(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

Message

public Message(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)