de.dante.extex.interpreter.primitives.register.box
Class Copy

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.register.box.AbstractBox
          extended byde.dante.extex.interpreter.primitives.register.box.BoxPrimitive
              extended byde.dante.extex.interpreter.primitives.register.box.Copy
All Implemented Interfaces:
Boxable, BoxOrRule, Code, Localizable, java.io.Serializable

public class Copy
extends BoxPrimitive
implements Boxable, java.io.Serializable

This class provides an implementation for the primitive \copy.

The Primitive \copy

The primitive \copy inserts the contents of the named box register at the current position. In contrast to the \box primitive the box register is not cleared.

If the primitive is used on the right hand side of a box assignment then the box contents is used for the assignment.

Syntax

The formal description of this primitive is the following:
    ⟨copy⟩
      → \copy ⟨box register name⟩ 

Examples

    \copy42  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Copy(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.primitives.register.box.BoxPrimitive
getBox
 
Methods inherited from class de.dante.extex.interpreter.primitives.register.box.AbstractBox
getKey
 
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
 
Methods inherited from interface de.dante.extex.interpreter.type.box.Boxable
getBox
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

Copy

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

Parameters:
name - the name for debugging
Method Detail

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 BoxPrimitive
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)