org.extex.unit.namespace
Class Export

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.namespace.Export
All Implemented Interfaces:
java.io.Serializable, Code

public class Export
extends AbstractAssignment

This class provides an implementation for the primitive \export.

The Primitive \export

The primitive \export takes a list of tokens and saves them away for an associated \import. The tokens in the list are either control sequence tokens or active characters. All other tokens are ignored.

The expansion text is empty. The primitive is an assignment. Thus \afterassignment interacts with the primitive in the expected way.

The definitions are usually performed local to the current group. If the prefix \global is given or the count register \globaldefs has a positive value then the definition is made globally. Usually you want to define the export as global. This is the case if the \export primitive is invoked at group level 0. Interesting special effects can be achieved when using the export statement in groups and together with a local scope definition.

This primitive is one building block for the use of name spaces in ExTeX. The central primitive for this purpose is \namespace.

Syntax

The formal description of this primitive is the following:
    ⟨export⟩
      → ⟨prefix⟩ \export ⟨replacement text⟩

    ⟨prefix⟩
      →
       |  \global  

Examples

    \export{\a\b}  

Version:
$Revision: 4732 $
Author:
Gerd Neugebauer
See Also:
Namespace, Import, Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Export(CodeToken token)
          Creates a new object.
 
Method Summary
 void assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          The method assign is the core of the functionality of execute().
 
Methods inherited from class org.extex.interpreter.type.AbstractAssignment
execute
 
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

Export

public Export(CodeToken token)
Creates a new object.

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

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException
The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:
assign in class AbstractAssignment
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:
AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)