org.extex.interpreter.type
Interface ExpandableCode

All Known Implementing Classes:
AbstractIf, AbstractMarksCode, Botmark, Botmarks, Char, CharCode, CountArray, CountPrimitive, Csname, Detokenize, DimenParameter, DimenPrimitive, Dp, Efcode, Else, Expandafter, Fi, Firstmark, Firstmarks, Fontchardp, Fontcharht, Fontcharic, Fontcharwd, Fontdimen, Fontname, Ht, Hyphenchar, If, Ifcase, Ifcat, Ifcsname, Ifdefined, Ifdim, Ifeof, Iffalse, Iffontchar, Ifhbox, Ifhmode, Ifinner, Ifmmode, Ifnum, Ifodd, Iftrue, Ifvbox, Ifvmode, Ifvoid, Ifx, Input, IntegerCode, IntegerParameter, Jobname, Lccode, LetCode, Lowercase, MacroCode, Mag, Namespace, Noexpand, Number, Pdffontname, Prevgraf, ProtectedMacroCode, Romannumeral, Scantokens, Skewchar, Splitbotmark, Splitbotmarks, Splitfirstmark, Splitfirstmarks, StringPrimitive, The, Topmark, Topmarks, Uccode, Unexpanded, Unless, Wd, WriterType

public interface ExpandableCode

This interface describes the feature of being expandable code.

Version:
$Revision: 5586 $
Author:
Gerd Neugebauer

Method Summary
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
 

Method Detail

expand

void expand(Flags prefix,
            Context context,
            TokenSource source,
            Typesetter typesetter)
            throws ConfigurationException,
                   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.

Parameters:
prefix - the prefix flags controlling the expansion
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
ConfigurationException - in case of an configuration error
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter