de.dante.extex.interpreter.primitives.font
Class Fontcharht

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.font.Fontcharht

All Implemented Interfaces:

Code, CountConvertible, DimenConvertible, ExpandableCode, Localizable, java.io.Serializable, Theable

public class Fontcharht

extends AbstractCode

implements ExpandableCode, CountConvertible, DimenConvertible, Theable

This class provides an implementation for the primitive \fontcharht.

The Primitive \fontcharht

The primitive \fontcharht is a read-only dimen register which corresponds to the height of a character in a given font. If the character is not defined in the font then 0pt is returned.

Syntax

    ⟨fontcharht⟩
       → \fontcharht ⟨font⟩ ⟨character code⟩  

Examples

    \fontcharht\tenrm `a  

Version:

$Revision: 1.16 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Fontcharht

public Fontcharht(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException

Description copied from interface: CountConvertible

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:

InterpreterException - in case of an error

See Also:

CountConvertible.convertCount( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

convertDimen

public long convertDimen(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException

Description copied from interface: DimenConvertible

This method converts a register into a dimen. 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. The return value is the length in scaled points.

Specified by:

convertDimen in interface DimenConvertible

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter to use for conversion

Returns:

the converted value in sp

Throws:

InterpreterException - in case of an error

See Also:

DimenConvertible.convertDimen( 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)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException

Description copied from interface: Theable

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:

InterpreterException - in case of an error

See Also:

Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, Typesetter)