org.extex.unit.tex.register.dimen
Class DimenPrimitive

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.register.dimen.AbstractDimen
              org.extex.unit.tex.register.dimen.DimenPrimitive

All Implemented Interfaces:

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

Direct Known Subclasses:

DimenParameter

public class DimenPrimitive
extends AbstractDimen
implements Advanceable, ExpandableCode, CountConvertible, DimenConvertible, Multiplyable, Divideable, Theable

This class provides an implementation for the primitive \dimen. It sets the named dimen register to the value given, and as a side effect all prefixes are zeroed.

The Primitive \dimen

The primitive \dimen provides access to the dimen registers. Those registers contain length values.

TODO gene documentation incomplete

Syntax

The formal description of this primitive is the following:

    ⟨dimen⟩
      → ⟨optional prefix⟩ \dimen ⟨register name⟩ ⟨equals⟩ ⟨dimen value⟩

   ⟨optional prefix⟩
     →
      |  \global ⟨optional prefix⟩  

Examples

   \dimen1=12 pt 

Version:

$Revision: 4770 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

DimenPrimitive(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.
long	convertDimen(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a dimen.
void	divide(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method is called when the macro \divide has been seen.
void	expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and expands it.
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.unit.tex.register.dimen.AbstractDimen

getKey

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

DimenPrimitive

public DimenPrimitive(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 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:

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)

convertDimen

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

This method converts a register into a dimen. 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. The return value is the length in scaled points.

Specified by:

convertDimen in interface DimenConvertible

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter to use for conversion

Returns:

the converted value in sp

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

DimenConvertible.convertDimen( 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)

expand

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

This method takes the first token and expands it. The result is placed on the stack. This means that expandable code does one step of expansion and puts the result on the stack. To expand a token it might be necessary to consume further tokens.

Specified by:

expand in interface ExpandableCode

Parameters:

prefix - the prefix flags controlling the expansion

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

ExpandableCode.expand( 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 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:

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)