de.dante.extex.interpreter.primitives.macro
Class Csname

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.macro.Csname
All Implemented Interfaces:
Code, ExpandableCode, Localizable, java.io.Serializable

public class Csname
extends AbstractCode
implements ExpandableCode

This class provides an implementation for the primitive \csname.

The Primitive \csname

The primitive \csname absorbs further tokens until a matching \endcsname is found. The tokens found are expanded. Spaces are ignored. The expansion should lead to character tokens only. A new token is constructed from the characters. The escape character is the current escape character.

If the meaning of the new token is currently not defined then it is defined to be equivalent to the original meaning of \relax.

If a non-expandable token is encountered then an error is raised.

Syntax

The formal description of this primitive is the following:
    ⟨csname⟩
      → \csname ⟨...⟩ \endcsname  

Examples

    \csname abc\endcsname  

This results in the control sequence \abc.

    \csname ab#de\endcsname  

The example is valid. It shows that even non-character tokens might be contained.

    \csname \TeX\endcsname  

This is usually illegal since \TeX is defined in plain to contain some non-expandable primitives.

Version:
$Revision: 1.36 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Csname(java.lang.String name)
          Creates a new object.
 
Method Summary
 Token convertCs(Context context, TokenSource source, Typesetter typesetter)
           
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it.
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
static Tokens scanToEndCsname(Context context, TokenSource source, Typesetter typesetter, Localizer loc)
          Expand tokens and collect the result until \endcsname is found.
 
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

Csname

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

Parameters:
name - the name for debugging
Method Detail

scanToEndCsname

public static Tokens scanToEndCsname(Context context,
                                     TokenSource source,
                                     Typesetter typesetter,
                                     Localizer loc)
                              throws InterpreterException
Expand tokens and collect the result until \endcsname is found. In fact the termination condition is that a Token is found which is assigned to Endcsname.

Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter
loc - the localizer
Returns:
the Tokens found while scanning the input tokens
Throws:
InterpreterException - in case of an error

convertCs

public Token convertCs(Context context,
                       TokenSource source,
                       Typesetter typesetter)
                throws InterpreterException
Throws:
InterpreterException
See Also:
CsConvertible.convertCs( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource)

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
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
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)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: ExpandableCode
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.

Specified by:
expand in interface ExpandableCode
Parameters:
prefix - the prefix flags controlling the expansion
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
ExpandableCode.expand( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)