Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.file.AbstractFileCode
          extended byde.dante.extex.interpreter.primitives.file.Openout
All Implemented Interfaces:
Code, Configurable, Localizable, java.io.Serializable
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 {@link de.dante.extex.interpreter.primitives.prefix.Immediate \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 {@linkplain
        de.dante.extex.interpreter.primitives.file.AbstractFileCode#scanOutFileKey(Context,TokenSource,Typesetter)
        ⟨outfile name⟩} {@linkplain
        de.dante.extex.interpreter.TokenSource#getOptionalEquals(Context)
        ⟨equals⟩} {@linkplain
        de.dante.extex.interpreter.primitive.file.AbstractFileCode#scanFileName(Context,TokenSource)
        ⟨file name⟩}

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

Examples

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

Version:
$Revision: 1.31 $
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 de.dante.extex.interpreter.primitives.file.AbstractFileCode
MAX_IN_FILE_NO, MAX_OUT_FILE_NO
 
Constructor Summary
Openout(java.lang.String name)
          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.
 
Methods inherited from class de.dante.extex.interpreter.primitives.file.AbstractFileCode
configure, getEncoding, scanFileName, scanInFileKey, scanOutFileKey
 
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

Openout

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

Parameters:
name - the name for debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
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
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)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD