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

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.Openin
All Implemented Interfaces:
Code, Configurable, Localizable, java.io.Serializable

public class Openin
extends AbstractFileCode

This class provides an implementation for the primitive \openin.

The Primitive \openin

The primitive \openin tries to open a file or other named resource for reading. The reference is stored in a read register to be used with \read. If the opening fails then the read register is void. This can be checked with the primitive \ifeof.

The assignment to a read register is always global. The opening is always performed immediately. Thus no prefix is allowed.

The stream should be closed with \closein when not needed any more.

Syntax

The formal description of this primitive is the following:
    ⟨openin⟩
      → \openin  ⟨infile name⟩ ⟨equals⟩ ⟨file name⟩   

Examples

  \openin3= abc.def
  \read3 to \line
  \closein3 

Version:
$Revision: 1.32 $
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
Openin(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

Openin

public Openin(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)