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

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

public class Readline
extends AbstractAssignment
implements LogEnabled

This class provides an implementation for the primitive \readline.

The Primitive \readline

The primitive \readline read characters from an input stream until the end of line is encountered. The characters are translated to tokens with the category code OTHER except the white-space characters which receive the category code SPACE. This mapping is performed ignoring the setting of \catcode. The resulting token list is bound to the control sequence given.

Syntax

The formal description of this primitive is the following:
    ⟨readline⟩
      → ⟨optional prefix⟩ \readline ⟨infile name⟩ to ⟨control sequence⟩

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

Examples

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

Version:
$Revision: 1.15 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Readline(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

Readline

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