org.extex.unit.etex.conditional.analyze
Class Currentiftype

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.etex.conditional.analyze.Currentiftype

All Implemented Interfaces:

java.io.Serializable, CountConvertible, Code, Theable

public class Currentiftype
extends AbstractCode
implements CountConvertible, Theable

This class provides an implementation for the primitive \currentiftype.

The Primitive \currentiftype

The primitive \currentiftype is an internal count register. It returns an indication of the conditional currently in use. If no conditional is active then 0 is returned. The following table lists the return values for the different types of conditionals:

/if	1
/ifcat	2
/ifnum	3
/ifdim	4
/ifodd	5
/ifvmode	6
/ifhmode	7
/ifmmode	8
/ifinner	9
/ifvoid	10
/ifhbox	11
/ifvbox	12
/ifx	13
/ifeof	14
/iftrue	15
/iffalse	16
/ifcase	17
/ifdefined	18
/ifcsname	19
/iffontchar	20

The value returned by the primitive is negated if the expansion appears in the else branch.

Syntax

The formal description of this primitive is the following:

    ⟨currentiftype⟩
     → \currentiftype 

Examples

    \count0=\currentiftype  

Version:

$Revision:4435 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Currentiftype(CodeToken token)
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 org.extex.interpreter.type.AbstractCode

execute, 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

Currentiftype

public Currentiftype(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws HelpingException,
                         TypesetterException

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

CountConvertible.convertCount( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws CatcodeException,
                  HelpingException,
                  TypesetterException

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:

CatcodeException - in case of an error in token creation

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error

See Also:

Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)