de.dante.extex.interpreter.primitives.typesetter.mark
Class Splitbotmark

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.typesetter.mark.AbstractMarksCode
          de.dante.extex.interpreter.primitives.typesetter.mark.Splitbotmarks
              de.dante.extex.interpreter.primitives.typesetter.mark.Splitbotmark

All Implemented Interfaces:

Code, ExpandableCode, Localizable, java.io.Serializable, TokensConvertible

public class Splitbotmark

extends Splitbotmarks

This class provides an implementation for the primitive \splitbotmark.

The Primitive \splitbotmark

TODO missing documentation

Syntax

    \splitbotmark  

Examples

    \splitbotmark 

Version:

$Revision: 1.8 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Splitbotmark

public Splitbotmark(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws InterpreterException

Description copied from class: AbstractMarksCode

Get the key for this mark.

A Mark Name

A mark name determines under which key a mark can be addressed. In TeX this used to be a positive number only. This has been extended to allow also a token list in braces.

The alternative is controlled by the count register \register.max. The following interpretation of the value of this count is used:

• If the value of this count register is negative then a arbitrary non-negative number is allowed as register name as well as any list of tokens enclosed in braces.
• If the value of this count register is not-negative then a only a non-negative number is allowed as register name which does not exceed the value of the count register.

The value of the count register \register.max is set differently for various configurations of ExTeX:

• TeX uses the value 255.
• eTeX uses the value 32767.
• Omega uses the value 65536.
• ExTeX uses the value -1.

Note that the register name \register.max contains a period. Thus it can normally not be entered easily since the catcode of the period is OTHER but needs to be LETTER. Thus you have to use a temporarily reassigned category code (see \catcode) or use {@link de.dante.extex.interpreter.primitives.macro.Csname \csname}.

Syntax

   ⟨register name⟩
       → {@linkplain
        de.dante.extex.interpreter.TokenSource#scanTokens(Context,boolean,boolean,String)
        ⟨tokens⟩}
        | {@linkplain de.dante.extex.interpreter.TokenSource#scanNumber(Context)
        ⟨number⟩}  

Examples

  123
  {abc
 

Overrides:

getKey in class AbstractMarksCode

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

Returns:

the key for the mark primitive

Throws:

InterpreterException - in case of an error

See Also:

AbstractMarkCode.getKey( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)