org.extex.unit.tex.typesetter.mark
Class Marks

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.typesetter.mark.AbstractMarkCode
          extended by org.extex.unit.tex.typesetter.mark.Marks
All Implemented Interfaces:
java.io.Serializable, Code
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:4431 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Marks(CodeToken token)
          Creates a new object.
 
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 org.extex.unit.tex.typesetter.mark.AbstractMarkCode
getKey
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText
 
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

Marks

public Marks(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

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 execution
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
Code.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)