de.dante.extex.interpreter.primitives.group
Class Currentgrouplevel
java.lang.Object
de.dante.extex.interpreter.type.AbstractCode
de.dante.extex.interpreter.primitives.group.Currentgrouplevel
- All Implemented Interfaces:
- Code, CountConvertible, Localizable, java.io.Serializable, Theable
- public class Currentgrouplevel
- extends AbstractCode
- implements CountConvertible, Theable
This class provides an implementation for the primitive
\currentgrouplevel.
The Primitive \currentgrouplevel
The primitive \currentgrouplevel provides reading access to an
internal integer value containing the number of groups currently open.
Outside of any group 0 is returned. For each opened group the value is
incremented by 1.
Syntax
The formal description of this primitive is the following:
⟨currentgrouplevel⟩
→ \currentgrouplevel
Examples
\the\currentgrouplevel
- Version:
- $Revision: 1.11 $
- Author:
- Gerd Neugebauer, Sebastian Waschik
- See Also:
- Serialized Form
|
Field Summary |
protected static long |
serialVersionUID
The field serialVersionUID contains the id for serialization. |
| Methods inherited from class de.dante.extex.interpreter.type.AbstractCode |
enableLocalization, execute, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
serialVersionUID
protected static final long serialVersionUID
- The field serialVersionUID contains the id for serialization.
- See Also:
- Constant Field Values
Currentgrouplevel
public Currentgrouplevel(java.lang.String name)
- Creates a new object.
- Parameters:
name - the name for debugging
convertCount
public long convertCount(Context context,
TokenSource source,
Typesetter typesetter)
throws InterpreterException
- Description copied from interface:
CountConvertible
- This method converts a register into a count.
It might be necessary to read further tokens to determine which value to
use. For instance an additional register number might be required. In
this case the additional arguments Context and TokenSource can be used.
- Specified by:
convertCount in interface CountConvertible
- Parameters:
context - the interpreter contextsource - the source for new tokenstypesetter - the typesetter to use for conversion
- Returns:
- the converted value
- Throws:
InterpreterException - in case of an error- See Also:
CountConvertible.convertCount(
de.dante.extex.interpreter.context.Context,
de.dante.extex.interpreter.TokenSource,
de.dante.extex.typesetter.Typesetter)
the
public Tokens the(Context context,
TokenSource source,
Typesetter typesetter)
throws InterpreterException
- Description copied from interface:
Theable
- This method is the getter for the description of the primitive.
- Specified by:
the in interface Theable
- Parameters:
context - the interpreter contextsource - the source for further tokens to qualify the requesttypesetter - the typesetter to use
- Returns:
- the description of the primitive as list of Tokens
- Throws:
InterpreterException - in case of an error- See Also:
Theable.the(
de.dante.extex.interpreter.context.Context,
de.dante.extex.interpreter.TokenSource,
de.dante.extex.typesetter.Typesetter)