org.extex.unit.tex.typesetter
Class Special

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.Special

All Implemented Interfaces:

java.io.Serializable, Code

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

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Special(CodeToken token)
Creates a new object.

Method Summary

void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and executes it.

Methods inherited from class org.extex.interpreter.type.AbstractCode

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

Special

public Special(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

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)