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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.file.Read
All Implemented Interfaces:
Code, Localizable, LogEnabled, java.io.Serializable

public class Read
extends AbstractAssignment
implements LogEnabled

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: 1.36 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Read(java.lang.String name)
          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 theLogger)
          Setter for the logger.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractAssignment
execute
 
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

Read

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

Parameters:
name - the name for debugging
Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from class: AbstractAssignment
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:
InterpreterException - in case of an error
See Also:
AbstractAssignment.assign( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

enableLogging

public void enableLogging(java.util.logging.Logger theLogger)
Description copied from interface: LogEnabled
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
theLogger - the logger to use
See Also:
LogEnabled.enableLogging( java.util.logging.Logger)