org.extex.unit.base.register
Class CharCode

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.base.register.CharCode
All Implemented Interfaces:
java.io.Serializable, CountConvertible, Code, ExpandableCode, Showable, Theable

public class CharCode
extends AbstractCode
implements ExpandableCode, CountConvertible, Showable, Theable

This class provides an implementation for a Code which represents a single character. The code is executable, expandable, and convertible into a count register. The token returned by expansion depends on the category code at the time of expansion.

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
CharCode(CodeToken token, UnicodeChar uc)
          Creates a new object.
 
Method Summary
 long convertCount(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a count.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          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.
 void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and expands it.
 UnicodeChar getCharacter()
          Getter for character.
 Tokens show(Context context)
          This method is the getter for the description of the primitive.
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 java.lang.String toString()
           
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
getLocalizer, getName, getToken, isIf, isOuter, readResolve, 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

CharCode

public CharCode(CodeToken token,
                UnicodeChar uc)
Creates a new object.

Parameters:
token - the initial token for the primitive
uc - the Unicode character to encapsulate
Method Detail

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws HelpingException,
                         TypesetterException
This method converts a register into a count. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:
convertCount in interface CountConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
CountConvertible.convertCount( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, Typesetter)

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:
Code.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException
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:
HelpingException - in case of an error
See Also:
ExpandableCode.expand( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getCharacter

public UnicodeChar getCharacter()
Getter for character.

Returns:
the character

show

public Tokens show(Context context)
            throws HelpingException
This method is the getter for the description of the primitive.

Specified by:
show in interface Showable
Parameters:
context - the interpreter context
Returns:
the description of the primitive as list of Tokens
Throws:
HelpingException - in case of an error
See Also:
Showable.show( org.extex.interpreter.context.Context)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws CatcodeException,
                  HelpingException,
                  TypesetterException
This method is the getter for the description of the primitive.

Specified by:
the in interface Theable
Parameters:
context - the interpreter context
source - the source for further tokens to qualify the request
typesetter - the typesetter to use
Returns:
the description of the primitive as list of Tokens
Throws:
CatcodeException - in case of an error in token creation
ConfigurationException - in case of an configuration error
HelpingException - in case of an error
TypesetterException - in case of an error
See Also:
Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

toString

public java.lang.String toString()
Overrides:
toString in class AbstractCode
See Also:
AbstractCode.toString()