Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.interpreter.primitives.typesetter
Class Special

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.typesetter.Special
All Implemented Interfaces:
Code, Localizable, java.io.Serializable
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.

Syntax

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

Examples

    \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.

Version:
$Revision: 1.17 $
Author:
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

serialVersionUID

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

See Also:
Constant Field Values
Constructor Detail

Special

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

Parameters:
name - the name for tracing and debugging
Method Detail

execute

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
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)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD