org.extex.unit.tex.file
Class Inputlineno

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.file.Inputlineno

All Implemented Interfaces:

java.io.Serializable, CountConvertible, Code, Theable

public class Inputlineno
extends AbstractCode
implements CountConvertible, Theable

This class provides an implementation for the primitive \inputlineno.

The Primitive \inputlineno

The primitive \inputlineno is an internal integer quantity which expands to the line number of the current input file. This primitive can be used to assign the value to variables or after \the to translate it to tokens.

Syntax

The formal description of this primitive is the following:

    ⟨inputlineno⟩
      → \inputlineno  

Examples

    \count1=\inputlineno  

    \the\inputlineno  

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Constructor Summary

Inputlineno(CodeToken token)
Creates a new object.

Method Summary

long	convertCount(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a count.
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.interpreter.type.AbstractCode

execute, 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

Constructor Detail

Inputlineno

public Inputlineno(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

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, org.extex.typesetter.Typesetter)

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)