org.extex.unit.tex.typesetter.output
Class Shipout
java.lang.Object
org.extex.interpreter.type.AbstractCode
org.extex.unit.tex.typesetter.output.Shipout
- All Implemented Interfaces:
- java.io.Serializable, Code
public class Shipout
- extends AbstractCode
This class provides an implementation for the primitive \shipout
.
The Primitive \shipout
The primitive \shipout takes a box and send the contents of the
box to the back-end. If the box is void then this primitives ignores it and
does not contact the back-end.
In addition the count register \deadcyles is reset to 0. This
count register is used to break out of infinite loops when no material is
shipped out in the output routine.
Syntax
The formal description of this primitive is the following:
〈shipout〉
→ \shipout 〈box〉
Examples
\shipout\box255
- Version:
- $Revision:4431 $
- Author:
- Gerd Neugebauer
- See Also:
- Serialized Form
Field Summary |
protected static long |
serialVersionUID
The constant serialVersionUID contains the id for
serialization. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
serialVersionUID
protected static final long serialVersionUID
- The constant serialVersionUID contains the id for
serialization.
- See Also:
- Constant Field Values
Shipout
public Shipout(CodeToken token)
- Creates a new object.
- Parameters:
token
- the initial token for the primitive
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 executioncontext
- the interpreter contextsource
- the token sourcetypesetter
- 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)