org.extex.unit.tex.macro
Class Gdef

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.macro.Def
              extended by org.extex.unit.tex.macro.Gdef
All Implemented Interfaces:
java.io.Serializable, LogEnabled, Code

public class Gdef
extends Def

This class provides an implementation for the primitive \gdef.

The Primitive \gdef

This primitive is an abbreviation for \global\def. Thus the description of \def can be consulted for details.

Syntax

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

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

Examples

    \gdef#1{--#1--}  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Gdef(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(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.
 
Methods inherited from class org.extex.unit.tex.macro.Def
enableLogging
 
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

Gdef

public Gdef(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.

Overrides:
assign in class Def
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:
Let.assign(org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)