org.extex.unit.tex.file
Class Openout

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.base.file.AbstractFileCode
          org.extex.unit.tex.file.Openout

All Implemented Interfaces:

java.io.Serializable, Configurable, Code

public class Openout
extends AbstractFileCode

This class provides an implementation for the primitive \openout.

The Primitive \openout

The primitive \openout tries to open a file or other named resource for writing. The reference is stored in a write register to be used with \write. If the opening fails then the write register is void.

The opening of a write register is delayed until the nodes are shipped out. If the invocation is prefixed with \immediate then the resource is opened immediately.

The primitive \openout is not considered as assignment. Nor can it be prefixed with \global. The definition of an output stream is always global.

Syntax

The formal description of this primitive is the following:

    ⟨openout⟩
      → ⟨optional prefix⟩ \openout ⟨outfile name⟩ ⟨equals⟩ ⟨file name⟩

    ⟨optional prefix⟩
      →
       |  \immediate ⟨optional prefix⟩  

Examples

  \immediate\openout3= abc.def
  \write3{Hi there!}
  \closeout3 

Version:

$Revision: 4441 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Fields inherited from class org.extex.unit.base.file.AbstractFileCode

MAX_IN_FILE_NO, MAX_OUT_FILE_NO

Constructor Summary

Openout(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.unit.base.file.AbstractFileCode

configure, getEncoding, scanFileName, scanInFileKey, scanOutFileKey

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

Openout

public Openout(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 TypesetterException,
                    HelpingException

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:

TypesetterException - in case of an error in the typesetter

HelpingException - in case of an error

See Also:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)