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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.info.Message
All Implemented Interfaces:
Code, Localizable, LogEnabled, java.io.Serializable

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: 1.24 $
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(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)
          Scan the next tokens (between braces) and put the value (as text) on the log.
 
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

Message

public Message(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
Scan the next tokens (between braces) and put the value (as text) on the log. In fact only the source is informed that there is something to write out. This is done using the observer pattern.

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)