de.dante.extex.interpreter.primitives.conditional.analyze
Class Currentifbranch

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.conditional.analyze.Currentifbranch
All Implemented Interfaces:
Code, CountConvertible, Localizable, java.io.Serializable, Theable

public class Currentifbranch
extends AbstractCode
implements CountConvertible, Theable

This class provides an implementation for the primitive \currentifbranch.

The Primitive \currentifbranch

The primitive \currentifbranch is an integer quantity which provides the information in which branch of the enclosing conditional. The value is determined by the following rules:

The primitive \currentifbranch is a read-only quantity. an attempt to use this primitive in a horizontal or vertical mode results in an error.

Syntax

The formal description of this primitive is the following:
    ⟨currentifbranch⟩
     → \currentifbranch 

Examples

    \count0=\currentifbranch  

Version:
$Revision: 1.3 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Currentifbranch(java.lang.String name)
          Creates a new object.
 
Method Summary
 long convertCount(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a count.
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 
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
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

Currentifbranch

public Currentifbranch(java.lang.String name)
Creates a new object.

Parameters:
name - the name for debugging
Method Detail

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 context
source - the source for new tokens
typesetter - 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 context
source - the source for further tokens to qualify the request
typesetter - 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)