Interface Code

All Known Implementing Classes:
Above, Abovewithdelims, AbstractAlign, AbstractAssignment, AbstractBoxPrimitive, AbstractCode, AbstractColor, AbstractCount, AbstractDimen, AbstractDirCode, AbstractFileCode, AbstractHorizontalCode, AbstractHyphenationCode, AbstractIf, AbstractMarkCode, AbstractMarksCode, AbstractMath, AbstractMathCode, AbstractModeCode, AbstractMuskip, AbstractOcplist, AbstractOmegaDelimiter, AbstractOmegaMathCode, AbstractPdftexCode, AbstractReadonlyCount, AbstractSkip, AbstractTeXDelimiter, AbstractTeXMathCode, AbstractToks, AbstractVerticalCode, Accent, Addafterocplist, Addbeforeocplist, Advance, Afterassignment, Aftergroup, Atop, Atopwithdelims, Badness, Batchmode, Begingroup, BeginL, BeginR, BoolDef, Botmark, Botmarks, BoxParameter, BoxPrimitive, CatcodePrimitive, Char, CharCode, Chardef, Cleaders, Clearocplists, Closein, Closeout, Colordef, ColorPrimitive, Copy, CountArray, Countdef, CountPrimitive, Cr, Crcr, Csname, Currentgrouplevel, Currentgrouptype, Currentifbranch, Currentiflevel, Currentiftype, Def, DefaultInputMode, DefaultInputTranslation, DefaultOutputMode, DefaultOutputTranslation, Delcode, Delimiter, Detokenize, Dimendef, Dimenexpr, DimenParameter, DimenPrimitive, Discretionary, Displaylimits, Displaystyle, Divide, Dp, Dump, Edef, Efcode, Else, End, Endcsname, Endgroup, Endinput, EndL, EndR, EnsureLoaded, Eqno, Errmessage, Errorstopmode, EtexVersion, Expandafter, Export, Fi, Firstmark, Firstmarks, Fontchardp, Fontcharht, Fontcharic, Fontcharwd, FontCode, Fontdimen, Fontname, FontPrimitive, Futurelet, Gdef, Global, Glueexpr, Glueshrink, Glueshrinkorder, Gluestretch, Gluestretchorder, Gluetomu, Halign, HashToksDef, Hbox, Hfi, Hfil, Hfill, Hfilneg, Hrule, Hskip, Hss, Ht, Hyphen, Hyphenation, HyphenationPrimitive, Hyphenchar, If, Ifcase, Ifcat, Ifcsname, Ifdefined, Ifdim, Ifeof, Iffalse, Iffontchar, Ifhbox, Ifhmode, Ifinner, Ifmmode, Ifnum, Ifodd, Iftrue, Ifvbox, Ifvmode, Ifvoid, Ifx, Ignorespaces, Immediate, Import, Indent, Input, Inputlineno, InputMode, InputTranslation, Insert, Integer, IntegerCode, IntegerParameter, Interactionmode, ItalicCorrection, JavaDef, JavaLoad, Jobname, Kern, Lastbox, Lastkern, Lastnodetype, Lastpenalty, Lccode, Leaders, Left, LeftHyphenmin, Leqno, Let, LetCode, Limits, Localleftbox, Localrightbox, Long, Lower, Lowercase, MacroCode, Mag, Mark, Marks, MathAbs, Mathaccent, MathACos, MathAdd, MathASin, MathATan, MathATanTwo, Mathbin, MathCeil, Mathchar, Mathchardef, Mathchoice, Mathclose, MathcodePrimitive, MathCos, Mathdir, MathDiv, MathE, MathExp, MathExpression, MathFloor, Mathinner, MathLog, MathMax, MathMin, MathMul, Mathop, Mathopen, Mathord, MathPi, MathPow, Mathpunct, MathRandom, Mathrel, MathRint, MathRound, MathSin, MathSqrt, MathSub, MathTan, MathToDegrees, MathToRadians, Meaning, Message, Middle, Mkern, Moveleft, Moveright, Mskip, Muexpr, Multiply, Muskipdef, MuskipParameter, MuskipPrimitive, Mutoglue, NamedBool, NamedFont, NamedHashToks, NamedPair, NamedReal, NamedTransform, Namespace, NativeDef, NativeLoad, Naturaldir, Noalign, Noboundary, NoDefaultInputMode, NoDefaultInputTranslation, NoDefaultOutputMode, NoDefaultOutputTranslation, Noexpand, Noindent, Nolimits, Nonscript, Nonstopmode, NullfontPrimitive, Nullocplist, Number, NumberedBool, NumberedFont, NumberedHashToks, NumberedPair, NumberedReal, NumberedTransform, Numexpr, Ocp, OcpList, OcplistPrimitive, OcpPrimitive, Odelcode, Odelimiter, Oglueshrinkorder, Ogluestretchorder, Omathaccent, Omathchar, Omathchardef, OmathcodePrimitive, OmegaMathcharCode, Omit, Openin, Openout, Or, Oradical, Outer, OutputMode, OutputTranslation, Over, Overline, Overwithdelims, Pagedir, PagedirHL, PagedirHR, PairDef, Par, PardirHL, PardirHR, Parshape, Parshapedimen, Parshapeindent, Parshapelength, Patterns, Pdfannot, Pdfcatalog, Pdfdest, Pdfendlink, Pdfendthread, Pdffontname, Pdffontobjnum, Pdfincludechars, Pdfinfo, Pdflastannot, Pdflastobj, Pdflastxform, Pdflastximage, Pdfliteral, Pdfnames, Pdfobj, Pdfoutline, Pdfrefobj, Pdfrefxform, Pdfrefximage, Pdfstartlink, Pdfthread, Pdfxform, Pdfximage, Penalty, Popocplist, Prevdepth, Prevgraf, PrintFormat, Protected, ProtectedMacroCode, Pushocplist, Radical, Raise, Read, Readline, RealDef, Relax, Removeafterocplist, Removebeforeocplist, Right, RightHyphenmin, Romannumeral, Scantokens, Scriptscriptstyle, Scriptstyle, Scrollmode, Setbox, Setlanguage, Sfcode, Shipout, Show, Showbox, Showgroups, Showlists, Showprefix, Showthe, Showtokens, Skewchar, Skipdef, SkipParameter, SkipPrimitive, Space, Spacefactor, Span, Special, Splitbotmark, Splitbotmarks, Splitfirstmark, Splitfirstmarks, StringPrimitive, TeXMathcharCode, Textdir, Textstyle, The, Toksdef, ToksParameter, ToksPrimitive, Topmark, Topmarks, TransformDef, Uccode, Underline, Unexpanded, Unhbox, Unhcopy, Unkern, Unless, Unnaturaldir, Unpenalty, Unskip, Unvbox, Unvcopy, Uppercase, Vadjust, Valign, Vbox, Vcenter, Vfi, Vfil, Vfill, Vfilneg, Vrule, Vskip, Vsplit, Vss, Vtop, Wd, Write, WriterType, Xdef, Xleaders

public interface Code

This is the interface for all expandable or executable classes.

Each primitive has a name which is used for debugging purposes. Since an arbitrary sequence of \let and \def operations might have taken place it is in general not possible to determine the current name under which the primitive has been called. Thus an initial value is stored in it for this purpose.

$Revision: 6448 $
Gerd Neugebauer, Michael Niedermair

Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it.
 java.lang.String getName()
          Deprecated. access the token instead
 CodeToken getToken()
          Getter for the token.
 boolean isIf()
          This simple little method distinguishes the conditionals from the other primitives.
 boolean isOuter()
          Getter for the outer flag.

Method Detail


boolean isIf()
This simple little method distinguishes the conditionals from the other primitives. This is necessary for the processing of all \if* primitives.

true iff this is some sort if \if.


boolean isOuter()
Getter for the outer flag.

true iff the code is defined outer.


java.lang.String getName()
Deprecated. access the token instead

Getter for the name.

the name


CodeToken getToken()
Getter for the token.

the token


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

prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
ConfigurationException - in case of an configuration error