de.dante.extex.interpreter.primitives.file
Class Dump

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

public class Dump
extends AbstractCode
implements LogEnabled, OutputStreamConsumer

This class provides an implementation for the primitive \dump.

The Primitive \dump

The primitive writes out the current state of the interpreter to an format file. This format file can be read back in to restore the saved state.

The primitive can be used outside of any group only.

The name of the format file is derived from the job name. The extension .fmt is attached to the job name.

Syntax

The formal description of this primitive is the following:
    ⟨dump⟩
       → \dump  

Examples

    \dump  

Version:
$Revision: 1.41 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Dump(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)
          This method takes the first token and executes it.
 void setOutputStreamFactory(OutputStreamFactory factory)
          This method takes an output stream factory for further use.
 
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

Dump

public Dump(java.lang.String name)
Creates a new object.

Parameters:
name - the name for 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
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:
InterpreterException - in case of an exception
See Also:
"TeX – The Program [1303,1304, 1328]", Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

setOutputStreamFactory

public void setOutputStreamFactory(OutputStreamFactory factory)
Description copied from interface: OutputStreamConsumer
This method takes an output stream factory for further use.

Specified by:
setOutputStreamFactory in interface OutputStreamConsumer
Parameters:
factory - the output stream factory to use
See Also:
OutputStreamConsumer.setOutputStreamFactory( de.dante.extex.backend.outputStream.OutputStreamFactory)