de.dante.extex.interpreter.context
Interface ContextFile

All Known Subinterfaces:

Context, ContextInternals

All Known Implementing Classes:

ContextExtensionImpl, ContextImpl

public interface ContextFile

This interface describes the container for all data of an interpreter context.

Version:

$Revision: 1.3 $

Author:

Gerd Neugebauer

getInFile

public InFile getInFile(java.lang.String name)

Getter for a input file register. In the case that the named descriptor doe not exist yet a new one is returned. Especially if the name is null then the default input stream is used.

Parameters:

name - the name or the number of the file register

Returns:

the input file descriptor

See Also:

setInFile(String, InFile, boolean)

getOutFile

public OutFile getOutFile(java.lang.String name)

Getter for an output file descriptor.

Parameters:

name - the name or the number of the file register

Returns:

the output file descriptor

See Also:

setOutFile(String, OutFile, boolean)

setInFile

public void setInFile(java.lang.String name,
                      InFile file,
                      boolean global)

Setter for the InFile register in all requested groups. InFile registers are named, either with a number or an arbitrary string. The numbered registers where limited to 16 in TeX. This restriction does no longer hold for ExTeX.

Parameters:

name - the name or the number of the file register

file - the input file descriptor

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

getInFile(String)

setOutFile

public void setOutFile(java.lang.String name,
                       OutFile file,
                       boolean global)

Setter for a outfile descriptor.

Parameters:

name - the name or the number of the file register

file - the descriptor of the output file

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

getOutFile(String)