de.dante.extex.interpreter.primitives.dynamic
Class EnsureLoaded

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

public class EnsureLoaded
extends AbstractCode
implements OutputStreamConsumer, LogEnabled

This primitive initiates the loading of native code and implements the primitive \ensureloaded

The Primitive \ensureloaded

The primitive \ensureloaded dynamically requests that a unit of ExTeX is loaded.

A unit consists of primitives and some initializing actions.

Syntax

The general form of this primitive is
   ⟨ensureloaded⟩
       → \ensureloaded ⟨tokens⟩ 

Examples

    \ensureloaded{etex}  
    \ensureloaded\toks0  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
EnsureLoaded(java.lang.String codeName)
          Creates a new object.
 
Method Summary
 void enableLogging(java.util.logging.Logger theLogger)
          Setter for the logger.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it.
protected  java.util.logging.Logger getLogger()
          Getter for logger.
 void setOutputStreamFactory(OutputStreamFactory factory)
          This method takes an output stream factory for further use.
 
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

EnsureLoaded

public EnsureLoaded(java.lang.String codeName)
Creates a new object.

Parameters:
codeName - the name of the primitive
Method Detail

enableLogging

public void enableLogging(java.util.logging.Logger theLogger)
Description copied from interface: LogEnabled
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
theLogger - the logger to use
See Also:
LogEnabled.enableLogging( java.util.logging.Logger)

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
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
Throws:
InterpreterException
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)

getLogger

protected java.util.logging.Logger getLogger()
Getter for logger.

Returns:
the logger

setOutputStreamFactory

public void setOutputStreamFactory(OutputStreamFactory factory)
Description copied from interface: OutputStreamConsumer
This method takes an output stream factory for further use.

Specified by:
setOutputStreamFactory in interface OutputStreamConsumer
Parameters:
factory - the output stream factory to use
See Also:
OutputStreamConsumer.setOutputStreamFactory( de.dante.extex.backend.outputStream.OutputStreamFactory)