org.extex.unit.tex.file
Class Openin

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

All Implemented Interfaces:

java.io.Serializable, Code

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: 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

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

Openin

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

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

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