Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.interpreter.primitives.register.dimen
Class DimenPrimitive

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.register.dimen.AbstractDimen
              extended byde.dante.extex.interpreter.primitives.register.dimen.DimenPrimitive
All Implemented Interfaces:
Advanceable, Code, CountConvertible, DimenConvertible, Divideable, ExpandableCode, Localizable, Multiplyable, java.io.Serializable, 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: 1.30 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
DimenPrimitive(java.lang.String name)
          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 de.dante.extex.interpreter.primitives.register.dimen.AbstractDimen
getKey
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractAssignment
execute
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, 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

DimenPrimitive

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

Parameters:
name - the name for debugging
Method Detail

advance

public void advance(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Advanceable
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:
InterpreterException - in case of an error
See Also:
Advanceable.advance( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from class: AbstractAssignment
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:
InterpreterException - in case of an error
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

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, Typesetter)

convertDimen

public long convertDimen(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException
Description copied from interface: DimenConvertible
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:
InterpreterException - in case of an error
See Also:
DimenConvertible.convertDimen( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, Typesetter)

divide

public void divide(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: Divideable
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:
InterpreterException - in case of an error
See Also:
Divideable.divide( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: ExpandableCode
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:
InterpreterException - in case of an error
See Also:
ExpandableCode.expand( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

multiply

public void multiply(Flags prefix,
                     Context context,
                     TokenSource source,
                     Typesetter typesetter)
              throws InterpreterException
Description copied from interface: Multiplyable
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:
InterpreterException - in case of an error
See Also:
Multiplyable.multiply( de.dante.extex.interpreter.Flags, 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, Typesetter)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD