org.extex.unit.pdftex
Class Pdffontname

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.pdftex.AbstractPdftexCode
          extended by org.extex.unit.pdftex.Pdffontname
All Implemented Interfaces:
java.io.Serializable, Code, ExpandableCode, Theable, TokensConvertible

public class Pdffontname
extends AbstractPdftexCode
implements ExpandableCode, Theable, TokensConvertible

This class provides an implementation for the primitive \pdffontname.

The PDF Primitive \pdffontname

This primitive expands to the name of the font as used in PDF. For instance if a font is addressed as /F12 then this primitive expands to 12.

Syntax

The formal description of this primitive is the following:
    ⟨pdffontname⟩
       → \pdffontname ⟨font⟩ 

Examples

    \font\f cmr12
    \pdffontname \f  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Pdffontname(CodeToken token)
          Creates a new object.
 
Method Summary
 Tokens convertTokens(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into tokens.
 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.
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 
Methods inherited from class org.extex.unit.pdftex.AbstractPdftexCode
ensurePdftex
 
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

Pdffontname

public Pdffontname(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

convertTokens

public Tokens convertTokens(Context context,
                            TokenSource source,
                            Typesetter typesetter)
                     throws HelpingException,
                            TypesetterException
This method converts a register into tokens. 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:
convertTokens in interface TokensConvertible
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:
TokensConvertible.convertTokens( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

execute

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

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws 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:
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)