de.dante.extex.interpreter.primitives.macro.util
Class MacroCode

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.macro.util.MacroCode
All Implemented Interfaces:
Code, ComparableCode, ExpandableCode, Localizable, PrefixCode, java.io.Serializable, Showable
Direct Known Subclasses:
ProtectedMacroCode

public class MacroCode
extends AbstractCode
implements PrefixCode, ExpandableCode, ComparableCode, Showable

This class provides an implementation for any macro code bound to a control sequence or active character.

The Macro Code

TODO missing documentation

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
MacroCode(java.lang.String name, Flags flags, MacroPattern thePattern, Tokens theBody)
          Creates a new object.
 
Method Summary
 boolean compare(Token token, Context context)
          Compare the code with some other code.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it.
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
protected  Localizer getLocalizer()
          Getter for localizer.
 boolean isOuter()
          Getter for the outer flag.
 Tokens show(Context context)
          This method is the getter for the description of the primitive.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getName, isIf, 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

MacroCode

public MacroCode(java.lang.String name,
                 Flags flags,
                 MacroPattern thePattern,
                 Tokens theBody)
Creates a new object.

Parameters:
name - the initial name of the macro
flags - the flags controlling the behavior of the macro
thePattern - the pattern for the acquiring of the arguments
theBody - the expansion text
Method Detail

compare

public boolean compare(Token token,
                       Context context)
                throws InterpreterException
Description copied from interface: ComparableCode
Compare the code with some other code.

Specified by:
compare in interface ComparableCode
Parameters:
token - the token to compare to
context - the interpreter context
Returns:
true iff the code is equivalent according to the semantics of \ifx
Throws:
InterpreterException - in case of an error
See Also:
ComparableCode.compare( de.dante.extex.scanner.type.token.Token, de.dante.extex.interpreter.context.Context)

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Throws:
InterpreterException
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)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: ExpandableCode
This method takes the first token and expands it. The result is placed on the stack. This means that expandable code does one step of expansion and puts the result on the stack. To expand a token it might be necessary to consume further tokens.

Specified by:
expand in interface ExpandableCode
Parameters:
prefix - the prefix flags controlling the expansion
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
ExpandableCode.expand( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

getLocalizer

protected Localizer getLocalizer()
Description copied from class: AbstractCode
Getter for localizer.

Overrides:
getLocalizer in class AbstractCode
Returns:
the localizer.
See Also:
AbstractCode.getLocalizer()

isOuter

public boolean isOuter()
Description copied from interface: Code
Getter for the outer flag.

Specified by:
isOuter in interface Code
Overrides:
isOuter in class AbstractCode
See Also:
Code.isOuter()

show

public Tokens show(Context context)
            throws InterpreterException
Description copied from interface: Showable
This method is the getter for the description of the primitive.

Specified by:
show in interface Showable
Parameters:
context - the interpreter context
Returns:
the description of the primitive as list of Tokens
Throws:
InterpreterException - in case of an error
See Also:
Showable.show( de.dante.extex.interpreter.context.Context)