de.dante.extex.interpreter.primitives.arithmetic
Class Advance

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.arithmetic.Advance
All Implemented Interfaces:
Code, Localizable, java.io.Serializable

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.

Syntax

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

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

   ⟨advancable⟩
     → ⟨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⟩
   

Examples

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

Version:
$Revision: 1.26 $
Author:
Gerd Neugebauer
See Also:
Advanceable, Serialized Form

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

Advance

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

Parameters:
name - the name for debugging
Method Detail

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)