org.extex.unit.tex.interaction
Class Batchmode

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.interaction.Batchmode

All Implemented Interfaces:

java.io.Serializable, Code

public class Batchmode
extends AbstractAssignment

This class provides an implementation for the primitive \batchmode. It does simply nothing, but as a side effect all prefixes are zeroed and the interaction mode is set to batchmode.

The Primitive \batchmode

This primitive sets the interaction mode to batch mode. In batch mode the processing is terminated if the program needs input from the terminal or an error occurs. The output to the terminal is reduced to a minimum.

The setting of the interaction mode is an assignment. The mode is always processed globally. This means it does not interact with the group concept.

Syntax

The formal description of this primitive is the following:

    ⟨batchmode⟩
      → \batchmode  

Examples

    \batchmode  

Version:

$Revision:4408 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Batchmode(CodeToken token)
Creates a new object.

Method Summary

void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().

Methods inherited from class org.extex.interpreter.type.AbstractAssignment

execute

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

Batchmode

public Batchmode(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

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:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)