org.extex.unit.tex.file
Class Read

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.file.Read

All Implemented Interfaces:

java.io.Serializable, Code

public class Read
extends AbstractAssignment

This class provides an implementation for the primitive \read.

The Primitive \read

The primitive \read read a line of text from the given input stream into a control sequence. The input stream should be opened with \openin. If a stream name is used which has not been opened or has already been closed then the default input stream is used instead.

The primitive can be prefixed with \global. In this case the assignment to the control sequence is global instead of the default of assigning it locally to the current group.

The primitive implements an assignment. Thus the definition of \afterassignment and \globaldefs are honored.

Syntax

The formal description of this primitive is the following:

    ⟨read⟩
      → ⟨optional prefix⟩\read ⟨infile name⟩ to ⟨control sequence⟩

    ⟨optional prefix⟩
      →
       |  \global ⟨optional prefix⟩  

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.

Constructor Summary

Read(CodeToken token)
Creates a new object.

Method Summary

void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().
void	enableLogging(java.util.logging.Logger log) Setter for the logger.

Methods inherited from class org.extex.interpreter.type.AbstractAssignment

execute

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

Read

public Read(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

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:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

enableLogging

public void enableLogging(java.util.logging.Logger log)

Setter for the logger.

Parameters:

log - the logger to use

See Also:

org.extex.framework.logger.LogEnabled#enableLogging( java.util.logging.Logger)