org.extex.unit.tex.macro.util
Class MacroCode

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.macro.util.MacroCode

All Implemented Interfaces:

java.io.Serializable, LogEnabled, Code, ComparableCode, ExpandableCode, PrefixCode, Showable

Direct Known Subclasses:

ProtectedMacroCode

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

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:4408 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

MacroCode(CodeToken token, Flags flags, boolean notLong, MacroPattern pattern, Tokens body)
Creates a new object.

Method Summary

boolean	compare(Token token, Context context) Compare the code with some other code.
void	enableLogging(java.util.logging.Logger logger) Setter for the logger.
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 org.extex.interpreter.type.AbstractCode

getName, getToken, isIf, 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

MacroCode

public MacroCode(CodeToken token,
                 Flags flags,
                 boolean notLong,
                 MacroPattern pattern,
                 Tokens body)

Creates a new object.

Parameters:

token - the initial token for the macro

flags - the flags controlling the behavior of the macro

notLong - inverted indicator for the long macros

pattern - the pattern for the acquiring of the arguments. The value of null means that no arguments are expected

body - the expansion text

Method Detail

compare

public boolean compare(Token token,
                       Context context)
                throws HelpingException

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:

HelpingException - in case of an error

See Also:

ComparableCode.compare( org.extex.scanner.type.token.Token, org.extex.interpreter.context.Context)

enableLogging

public void enableLogging(java.util.logging.Logger logger)

Setter for the logger.

Specified by:

enableLogging in interface LogEnabled

Parameters:

logger - the logger to use

See Also:

LogEnabled.enableLogging( java.util.logging.Logger)

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

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

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:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

ExpandableCode.expand( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getLocalizer

protected Localizer getLocalizer()

Getter for localizer.

Overrides:

getLocalizer in class AbstractCode

Returns:

the localizer.

See Also:

AbstractCode.getLocalizer()

isOuter

public boolean isOuter()

Getter for the outer flag.

Specified by:

isOuter in interface Code

Overrides:

isOuter in class AbstractCode

Returns:

true iff the code is defined outer.

See Also:

Code.isOuter()

show

public Tokens show(Context context)
            throws HelpingException

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:

HelpingException - in case of an error

See Also:

Showable.show( org.extex.interpreter.context.Context)