org.extex.unit.tex.info
Class Errmessage

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

All Implemented Interfaces:

java.io.Serializable, Code

public class Errmessage
extends AbstractCode

This class provides an implementation for the primitive \errmessage.

The Primitive \errmessage

The primitive \errmessage takes one argument. This argument is an expanded list of tokens. Those tokens are presented as error message. The help text is taken from the token register \errhelp

Syntax

The formal description of this primitive is the following:

    ⟨errmessage⟩
       → \errmessage ⟨tokens⟩  

Examples

    \errhelp={Too bad}
    \errmessage{I found an error}  

The Token Register \errhelp

The token register \errhelp contains the help text for the primitive \errmessage. Nevertheless this register can be used in any place where a token register is needed.

Syntax

The formal description of this primitive is the following:

    ⟨errhelp⟩
      → \errhelp ⟨equals⟩ ⟨tokens⟩  

Examples

    \errhelp={Too bad}
    \errmessage{I found an error}  

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

Errmessage(CodeToken token)
Creates a new object.

Method Summary

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

Errmessage

public Errmessage(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

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)