org.extex.unit.tex.math.delimiter
Class Delcode

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.math.delimiter.Delcode

All Implemented Interfaces:

java.io.Serializable, CountConvertible, Code, Advanceable, Divideable, Multiplyable, Theable

public class Delcode
extends AbstractAssignment
implements CountConvertible, Advanceable, Divideable, Multiplyable, Theable

This class provides an implementation for the primitive \delcode.

The Math Primitive \delcode

The primitive \delcode can be used to assign and query the delimiter code for a character. The delimiter code determines, how a character is typeset in math mode.

The TeX encoding interprets the number as 27 bit hex number: "csyylxx. Here the digits have the following meaning:

c

the math class of this delimiter. It has a range from 0 to 7.

l

the family for the large character. It has a range from 0 to 15.

xx

the character code of the large character.

s

the family for the small character. It has a range from 0 to 15.

yy

the character code of the small character.

The assigning a new value to a delimiter code acts in a group restricted way unless declared differently. If the prefix \global is given then the assignment is performed globally. The same effect can be achieved when the count register \globaldefs is greater than 0.

Syntax

The formal description of this primitive is the following:

    ⟨delcode⟩
      → ⟨prefix⟩ \delcode ⟨8-bit number⟩ ⟨equals⟩ ⟨8-bit number⟩

    ⟨prefix⟩
      →
       |  ⟨global⟩ 

Examples

    \delcode`x="123456  

    \global\delcode`x="123456  

Using as Count Register

The primitive \delcode can be used like a count register. This means you can use it wherever a number is expected. In addition the value can be advanced, multiplied, and divided. In any case the delimiter code is translated according to the TeX encoding and processed as number.

Examples

    \count1=\delcode`x  

    \advance\delcode`x by 42  

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

Delcode(CodeToken token)
Creates a new object.

Method Summary

void	advance(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \advance has been seen.
void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().
long	convertCount(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a count.
void	divide(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \divide has been seen.
void	multiply(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \multiply has been seen.
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.AbstractAssignment

execute

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

Delcode

public Delcode(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

advance

public void advance(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

This method is called when the macro \advance has been seen. It performs the remaining tasks for the expansion.

Specified by:

advance in interface Advanceable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Advanceable.advance( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws ConfigurationException,
                   HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

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)

divide

public void divide(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

This method is called when the macro \divide has been seen. It performs the remaining tasks for the expansion.

Specified by:

divide in interface Divideable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Divideable.divide( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

multiply

public void multiply(Flags prefix,
                     Context context,
                     TokenSource source,
                     Typesetter typesetter)
              throws HelpingException,
                     TypesetterException

This method is called when the macro \multiply has been seen. It performs the remaining tasks for the expansion.

Specified by:

multiply in interface Multiplyable

Parameters:

prefix - the prefix for the command

context - the processor context

source - the token source to parse

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Multiplyable.multiply( org.extex.interpreter.Flags, 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

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)