de.dante.extex.interpreter.primitives
Class Relax

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.Relax
All Implemented Interfaces:
Code, Localizable, java.io.Serializable

public class Relax
extends AbstractCode

This class provides an implementation for the primitive \relax.

The Primitive \relax

This primitive simply does nothing. It acts as a no-op for the TeX macro language. \relax is not even expandable. in certain circumstances it might be treated as if it where expandable and the expansion is empty.

\relax sometimes acts as terminating token. For instance when a number is parsed \relax terminates the parsing even if the following token is a digit.

Syntax

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

Examples

    \relax  
    \the\count123\relax456  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Relax(java.lang.String name)
          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.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
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

Relax

public Relax(java.lang.String name)
Creates a new object.

Parameters:
name - the name for tracing and debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
Description copied from interface: Code
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
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)