de.dante.extex.interpreter.primitives.typesetter.mark
Class Marks
java.lang.Object
de.dante.extex.interpreter.type.AbstractCode
de.dante.extex.interpreter.primitives.typesetter.mark.AbstractMarkCode
de.dante.extex.interpreter.primitives.typesetter.mark.Marks
- All Implemented Interfaces:
- Code, Localizable, java.io.Serializable
- Direct Known Subclasses:
- Mark
- public class Marks
- extends AbstractMarkCode
This class provides an implementation for the primitive
\marks
.
The Primitive \marks
The primitive \marks places a mark in the current list. The
marks on the last page can be retrieved when the page is mounted in the
output routine.
The text stored within the mark is a list of tokens.
The marks can be classified with an identifier. In eTeX the
identifier is a number. In ExTeX in addition arbitrary
token lists can be used as identifier.
The \marks0 is equivalent to \mark.
Syntax
The formal description of this primitive is the following:
〈marks〉
→ \marks 〈mark name〉 〈tokens〉
Examples
\marks123{abc}
- Version:
- $Revision: 1.16 $
- Author:
- Gerd Neugebauer
- See Also:
- Serialized Form
Field Summary |
protected static long |
serialVersionUID
The constant serialVersionUID contains the id for serialization. |
Constructor Summary |
Marks(java.lang.String name)
Creates a new object. |
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
Marks
public Marks(java.lang.String name)
- Creates a new object.
- Parameters:
name
- the name for debugging
execute
public void execute(Flags prefix,
Context context,
TokenSource source,
Typesetter typesetter)
throws InterpreterException
- Description copied from interface:
Code
- 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
- Throws:
InterpreterException
- See Also:
Code.execute(
de.dante.extex.interpreter.Flags,
de.dante.extex.interpreter.context.Context,
de.dante.extex.interpreter.TokenSource,
de.dante.extex.typesetter.Typesetter)