Class Special

  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.typesetter.Special
All Implemented Interfaces:
Code, Localizable,

public class Special
extends AbstractCode

This class provides an implementation for the primitive \special.

The Primitive \special

This primitive sends a string to the back-end driver. The argument is a balanced block of text which is expanded and translated into a string. The string is given in a SpecialNode to the typesetter for passing it down.


The formal description of this primitive is the following:
        → \special ⟨general text⟩  


    \special{hello world}  
    \special{ps: \abc}  

For several back-end drivers for TeX a quasi-standard has emerged which uses a prefix ended by a colon to indicate the back-end driver the special is targeted at.

$Revision: 1.17 $
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
Constructor Summary
Special(java.lang.String name)
          Creates a new object.
Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          Scan the next tokens (between braces) and send the value (as text) to the typesetter for the back-end driver.
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail


protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail


public Special(java.lang.String name)
Creates a new object.

name - the name for tracing and debugging
Method Detail


public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Scan the next tokens (between braces) and send the value (as text) to the typesetter for the back-end driver.

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