Class Advance

  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.arithmetic.Advance
All Implemented Interfaces:, Code

public class Advance
extends AbstractAssignment

This class provides an implementation for the primitive \advance.

The Primitive \advance

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

The exact operation of \advance is determined by the quantity following the \advance keyword.


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

    ⟨optional prefix⟩
       |  \global ⟨optional prefix⟩

     → ⟨integer variable⟩ ⟨optional by⟨number⟩
      |  ⟨dimen variable⟩ ⟨optional by⟨dimen⟩
      |  ⟨glue variable⟩ ⟨optional by⟩ ⟨glue⟩
      |  ⟨muglue variable⟩ ⟨optional by⟩ ⟨muglue⟩

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


    \advance\count12 345  
    \advance\count12 by -345  

$Revision:4408 $
Gerd Neugebauer
See Also:
Advanceable, Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
Constructor Summary
Advance(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
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


protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail


public Advance(CodeToken token)
Creates a new object.

token - the initial token for the primitive
Method Detail


public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
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
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
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)