org.extex.unit.tex.info
Class Jobname

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.info.Jobname

All Implemented Interfaces:

java.io.Serializable, Code, ExpandableCode

public class Jobname
extends AbstractCode
implements ExpandableCode

This class provides an implementation for the primitive \jobname.

The Primitive \jobname

The primitive \jobname expands to the name of the job currently processed. The job name is usually the name of the first input file. If this can not be determined – e.g. because the input is not coming from a file – then the fallback texput is usd as default value.

Syntax

The formal description of this primitive is the following:

    ⟨jobname⟩
      → \jobname  

Examples

    \jobname  

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

static java.lang.String	JOBNAME The constant JOBNAME contains the name of the token register to carry the job name.
protected static long	serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Jobname(CodeToken token)
Creates a new object.

Method Summary

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.

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

JOBNAME

public static final java.lang.String JOBNAME

The constant JOBNAME contains the name of the token register to carry the job name.

See Also:

Constant Field Values

Constructor Detail

Jobname

public Jobname(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

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:

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

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)