de.dante.extex.interpreter.primitives.macro
Class Def

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.macro.Def
All Implemented Interfaces:
Code, Localizable, java.io.Serializable
Direct Known Subclasses:
Edef, Gdef, Xdef

public class Def
extends AbstractAssignment

This class provides an implementation for the primitive \def.

The Primitive \def

TODO missing documentation

Syntax

The formal description of this primitive is the following:
    ⟨def⟩
       → ⟨prefix⟩ \def ⟨control sequence⟩ ⟨parameter text⟩ { ⟨replacement text⟩ }

    ⟨prefix⟩
      →
       | \global ⟨prefix⟩
       | \long ⟨prefix⟩
       | \outer ⟨prefix⟩
       | \protected ⟨prefix⟩

Examples

    \def\a#1{--#1--}  
    \def\a#1#{--#1--}  
    \def\a#1#2{--#2--#1--}  
    \def\a#1:#2.{--#2--#1--}  

Version:
$Revision: 1.45 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Def(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().
protected  MacroPattern getPattern(Context context, TokenSource source)
          Parse the pattern.
 
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

Def

public Def(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)

getPattern

protected MacroPattern getPattern(Context context,
                                  TokenSource source)
                           throws InterpreterException
Parse the pattern.

Parameters:
context - the processor context
source - the source for new tokens
Returns:
the tokens read
Throws:
InterpreterException - in case of an error