org.extex.unit.tex.arithmetic
Class Multiply

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.arithmetic.Multiply
All Implemented Interfaces:
java.io.Serializable, Code

public class Multiply
extends AbstractAssignment

This class provides an implementation for the primitive \multiply.

The Primitive \advance

This primitive implements an assignment. The variable given as next tokens is multiplied by the quantity given after the optional by.

Syntax

The formal description of this primitive is the following:
   ⟨multiply⟩
     → ⟨optional prefix⟩ \multiply ⟨multiplyable⟩

   ⟨multiplyable⟩
     → ⟨integer variable⟩ ⟨optional by⟨8-bit number⟩
      |  ⟨dimen variable⟩ ⟨optional by⟨8-bit number⟩
      |  ⟨glue variable⟩ ⟨optional by⟨8-bit number⟩
      |  ⟨muglue variable⟩ ⟨optional by⟨8-bit number⟩

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

   ⟨optional by⟩
     → [by]
      |  ⟨optional spaces⟩
   

Examples

    \multiply\count12 345  
    \multiply\count12 by -345  

Version:
$Revision:4408 $
Author:
Gerd Neugebauer
See Also:
Multiplyable, Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Multiply(CodeToken token)
          Creates a new object.
 
Method Summary
 void assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          The method assign is the core of the functionality of execute().
 
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

Multiply

public Multiply(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

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)