Regina Calculation Engine
|
A packet representing a script that can be run. More...
#include <packet/nscript.h>
Public Member Functions | |
NScript () | |
Initialises to a script with no lines and no variables. | |
unsigned long | getNumberOfLines () const |
Returns the number of lines in this script. | |
const std::string & | getLine (unsigned long index) const |
Returns the requested line of this script. | |
void | addFirst (const std::string &line) |
Adds the given line to the beginning of this script. | |
void | addLast (const std::string &line) |
Adds the given line to the end of this script. | |
void | insertAtPosition (const std::string &line, unsigned long index) |
Inserts the given line into the given position in this script. | |
void | replaceAtPosition (const std::string &line, unsigned long index) |
Replaces a line of this script with the given line. | |
void | removeLineAt (unsigned long index) |
Removes the requested line from this script. | |
void | removeAllLines () |
Removes all lines from this script. | |
unsigned long | getNumberOfVariables () const |
Returns the number of variables associated with this script. | |
const std::string & | getVariableName (unsigned long index) const |
Returns the name of the requested variable associated with this script. | |
const std::string & | getVariableValue (unsigned long index) const |
Returns the value of the requested variable associated with this script. | |
const std::string & | getVariableValue (const std::string &name) const |
Returns the value of the variable stored with the given name. | |
bool | addVariable (const std::string &name, const std::string &value) |
Adds a new variable to be associated with this script. | |
void | removeVariable (const std::string &name) |
Removes the variable stored with the given name. | |
void | removeAllVariables () |
Removes all variables associated with this script. | |
virtual int | getPacketType () const |
Returns the integer ID representing this type of packet. | |
virtual std::string | getPacketTypeName () const |
Returns an English name for this type of packet. | |
virtual void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. | |
virtual void | writePacket (NFile &out) const |
Writes the packet details to the given old-style binary file. | |
virtual bool | dependsOnParent () const |
Determines if this packet depends upon its parent. | |
![]() | |
NPacket (NPacket *parent=0) | |
Constructor that inserts the new packet into the overall tree structure. | |
virtual | ~NPacket () |
Destructor that also orphans this packet and destroys all of its descendants. | |
const std::string & | getPacketLabel () const |
Returns the label associated with this individual packet. | |
void | setPacketLabel (const std::string &newLabel) |
Sets the label associated with this individual packet. | |
std::string | getFullName () const |
Returns a descriptive text string for the packet. | |
std::string | makeUniqueLabel (const std::string &base) const |
Returns a new label that cannot be found anywhere in the entire tree structure. | |
bool | makeUniqueLabels (NPacket *reference) |
Ensures that all packet labels in both this and the given packet tree combined are distinct. | |
bool | hasTag (const std::string &tag) const |
Determines whether this packet has the given associated tag. | |
bool | hasTags () const |
Determines whether this packet has any associated tags at all. | |
bool | addTag (const std::string &tag) |
Associates the given tag with this packet. | |
bool | removeTag (const std::string &tag) |
Removes the association of the given tag with this packet. | |
void | removeAllTags () |
Removes all associated tags from this packet. | |
const std::set< std::string > & | getTags () const |
Returns the set of all tags associated with this packet. | |
bool | listen (NPacketListener *listener) |
Registers the given packet listener to listen for events on this packet. | |
bool | isListening (NPacketListener *listener) |
Determines whether the given packet listener is currently listening for events on this packet. | |
bool | unlisten (NPacketListener *listener) |
Unregisters the given packet listener so that it no longer listens for events on this packet. | |
NPacket * | getTreeParent () const |
Determines the parent packet in the tree structure. | |
NPacket * | getFirstTreeChild () const |
Determines the first child of this packet in the tree structure. | |
NPacket * | getLastTreeChild () const |
Determines the last child of this packet in the tree structure. | |
NPacket * | getNextTreeSibling () const |
Determines the next sibling of this packet in the tree structure. | |
NPacket * | getPrevTreeSibling () const |
Determines the previous sibling of this packet in the tree structure. | |
NPacket * | getTreeMatriarch () const |
Determines the matriarch (the root) of the tree to which this packet belongs. | |
unsigned | levelsDownTo (const NPacket *descendant) const |
Counts the number of levels between this packet and its given descendant in the tree structure. | |
unsigned | levelsUpTo (const NPacket *ancestor) const |
Counts the number of levels between this packet and its given ancestor in the tree structure. | |
bool | isGrandparentOf (const NPacket *descendant) const |
Determines if this packet is equal to or an ancestor of the given packet in the tree structure. | |
unsigned long | getNumberOfChildren () const |
Returns the number of immediate children of this packet. | |
unsigned long | getNumberOfDescendants () const |
Returns the total number of descendants of this packet. | |
unsigned long | getTotalTreeSize () const |
Determines the total number of packets in the tree or subtree for which this packet is matriarch. | |
void | insertChildFirst (NPacket *child) |
Inserts the given packet as the first child of this packet. | |
void | insertChildLast (NPacket *child) |
Inserts the given packet as the last child of this packet. | |
void | insertChildAfter (NPacket *newChild, NPacket *prevChild) |
Inserts the given packet as a child of this packet at the given location in this packet's child list. | |
void | makeOrphan () |
Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree. | |
void | reparent (NPacket *newParent, bool first=false) |
Cuts this packet away from its parent in the tree structure, and inserts it as a child of the given packet instead. | |
void | swapWithNextSibling () |
Swaps this packet with its next sibling in the sequence of children beneath their common parent packet. | |
void | moveUp (unsigned steps=1) |
Moves this packet the given number of steps towards the beginning of its sibling list. | |
void | moveDown (unsigned steps=1) |
Moves this packet the given number of steps towards the end of its sibling list. | |
void | moveToFirst () |
Moves this packet to be the first in its sibling list. | |
void | moveToLast () |
Moves this packet to be the last in its sibling list. | |
void | sortChildren () |
Sorts the immediate children of this packet according to their packet labels. | |
NPacket * | nextTreePacket () |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. | |
const NPacket * | nextTreePacket () const |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. | |
NPacket * | firstTreePacket (const std::string &type) |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. | |
const NPacket * | firstTreePacket (const std::string &type) const |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. | |
NPacket * | nextTreePacket (const std::string &type) |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure. | |
const NPacket * | nextTreePacket (const std::string &type) const |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure. | |
NPacket * | findPacketLabel (const std::string &label) |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. | |
const NPacket * | findPacketLabel (const std::string &label) const |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. | |
bool | isPacketEditable () const |
Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children. | |
NPacket * | clone (bool cloneDescendants=false, bool end=true) const |
Clones this packet (and possibly its descendants), assigns to it a suitable unused label and inserts the clone into the tree as a sibling of this packet. | |
void | writeXMLFile (std::ostream &out) const |
Writes a complete XML file containing the subtree with this packet as matriarch. | |
![]() | |
ShareableObject () | |
Default constructor that does nothing. | |
virtual | ~ShareableObject () |
Default destructor that does nothing. | |
std::string | toString () const |
Returns the output from writeTextShort() as a string. | |
std::string | toStringLong () const |
Returns the output from writeTextLong() as a string. | |
![]() | |
virtual | ~NFilePropertyReader () |
Default destructor that does nothing. |
Static Public Member Functions | |
static NXMLPacketReader * | getXMLReader (NPacket *parent) |
(end: File I/O) | |
static NScript * | readPacket (NFile &in, NPacket *parent) |
Reads a single packet from the specified file and returns a newly created object containing that information. |
Static Public Attributes | |
static const int | packetType |
Contains the integer ID for this packet. | |
![]() |
Protected Member Functions | |
virtual NPacket * | internalClonePacket (NPacket *parent) const |
Makes a newly allocated copy of this packet. | |
virtual void | writeXMLPacketData (std::ostream &out) const |
Writes a chunk of XML containing the data for this packet only. | |
virtual void | readIndividualProperty (NFile &infile, unsigned propType) |
Reads an individual property from an old-style binary file. | |
![]() | |
void | writeXMLPacketTree (std::ostream &out) const |
Writes a chunk of XML containing the subtree with this packet as matriarch. |
Additional Inherited Members | |
![]() | |
typedef ChangeEventSpan | ChangeEventBlock |
A deprecated typedef for ChangeEventSpan. |
A packet representing a script that can be run.
Accessor methods for a script work a line at a time.
|
inline |
Initialises to a script with no lines and no variables.
|
inline |
Adds the given line to the beginning of this script.
line | the line to insert. |
|
inline |
Adds the given line to the end of this script.
line | the line to add. |
|
inline |
Adds a new variable to be associated with this script.
If a variable with the given name is already stored, this routine will do nothing.
name | the name of the new variable. |
value | the value of the new variable, as described in the notes for getVariableValue(). |
true
if the variable was successfully added, or false
if a variable with the given name was already stored.
|
inlinevirtual |
Determines if this packet depends upon its parent.
This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.
true
if and only if this packet depends on its parent. Implements regina::NPacket.
|
inline |
Returns the requested line of this script.
index | the index of the requested line; this must be between 0 and getNumberOfLines()-1 inclusive. |
|
inline |
Returns the number of lines in this script.
|
inline |
Returns the number of variables associated with this script.
|
virtual |
Returns the integer ID representing this type of packet.
This is the same for all packets of this class.
Implements regina::NPacket.
|
virtual |
Returns an English name for this type of packet.
An example is NTriangulation
. This is the same for all packets of this class.
Implements regina::NPacket.
const std::string& regina::NScript::getVariableName | ( | unsigned long | index | ) | const |
Returns the name of the requested variable associated with this script.
index | the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive. |
const std::string& regina::NScript::getVariableValue | ( | unsigned long | index | ) | const |
Returns the value of the requested variable associated with this script.
If the value is a packet, the packet label will be returned. If the value is null
, the empty string will be returned.
index | the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive. |
const std::string& regina::NScript::getVariableValue | ( | const std::string & | name | ) | const |
Returns the value of the variable stored with the given name.
The return strings are as described in getVariableValue(unsigned long).
If no variable is stored with the given name, the empty string will be returned.
name | the name of the requested variable; note that names are case sensitive. |
|
static |
(end: File I/O)
Returns a newly created XML element reader that will read the contents of a single XML packet element. You may assume that the packet to be read is of the same type as the class in which you are implementing this routine.
The XML element reader should read exactly what writeXMLPacketData() writes, and vice versa.
parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. The XML element reader can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.
This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated.
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
Reimplemented from regina::NPacket.
|
inline |
Inserts the given line into the given position in this script.
All subsequent lines will be shifted down to make room.
line | the line to insert. |
index | the index at which the new line will be placed; this must be between 0 and getNumberOfLines() inclusive. |
Makes a newly allocated copy of this packet.
This routine should not insert the new packet into the tree structure, clone the packet's associated tags or give the packet a label. It should also not clone any descendants of this packet.
You may assume that the new packet will eventually be inserted into the tree beneath either the same parent as this packet or a clone of that parent.
parent | the parent beneath which the new packet will eventually be inserted. |
Implements regina::NPacket.
|
protectedvirtual |
Reads an individual property from an old-style binary file.
The property type and bookmarking details should not read; merely the contents of the property that are written to file between NFile::writePropertyHeader() and NFile::writePropertyFooter(). See the NFile::writePropertyHeader() notes for details.
The property type of the property to be read will be passed in propType. If the property type is unrecognised, this routine should simply do nothing and return. If the property type is recognised, this routine should read the property and process it accordingly (e.g., store it in whatever data object is currently being read).
infile | the file from which to read the property. This should be open for reading and at the position immediately after writePropertyHeader() would have been called during the corresponding write operation. |
propType | the property type of the property about to be read. |
Implements regina::NFilePropertyReader.
Reads a single packet from the specified file and returns a newly created object containing that information.
You may assume that the packet to be read is of the same type as the class in which you are implementing this routine. The newly created object must also be of this type.
For instance, NTriangulation::readPacket() may assume that the packet is of type NTriangulation, and must return a pointer to a newly created NTriangulation. Deallocation of the newly created packet is the responsibility of whoever calls this routine.
The packet type and label may be assumed to have already been read from the file, and should not be reread. The readPacket() routine should read exactly what writePacket() writes, and vice versa.
parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. This routine can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.
This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated. Within each such subclass the function must be declared to return a pointer to an object of that subclass. For instance, NTriangulation::readPacket() must be declared to return an NTriangulation*, not simply an NPacket*.
New packet types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer packet types anyway.
in | the file from which to read the packet. |
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
Reimplemented from regina::NPacket.
|
inline |
Removes all lines from this script.
|
inline |
Removes all variables associated with this script.
|
inline |
Removes the requested line from this script.
index | the index of the requested line; this must be between 0 and getNumberOfLines()-1 inclusive. |
|
inline |
Removes the variable stored with the given name.
Note that the indices of other variables may change as a result of this action.
If no variable is stored with the given name, this routine will do nothing (but waste time!).
name | the name of the variable to remove; note that names are case sensitive. |
|
inline |
Replaces a line of this script with the given line.
line | the line to replace the currently stored line. |
index | the index of the line to replace; this must be between 0 and getNumberOfLines()-1 inclusive. |
|
virtual |
Writes the packet details to the given old-style binary file.
You may assume that the packet type and label have already been written. Only the actual data stored in the packet need be written.
The default implementation for this routine does nothing; new packet types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown packet types when reading from binary files.
out | the file to be written to. |
Reimplemented from regina::NPacket.
|
virtual |
Writes this object in long text format to the given output stream.
The output should provided the user with all the information they could want. The output should end with a newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
|
inlinevirtual |
Writes this object in short text format to the given output stream.
The output should fit on a single line and no newline should be written.
out | the output stream to which to write. |
Implements regina::ShareableObject.
|
protectedvirtual |
Writes a chunk of XML containing the data for this packet only.
You may assume that the packet opening tag (including the packet type and label) has already been written, and that all child packets followed by the corresponding packet closing tag will be written immediately after this routine is called. This routine need only write the internal data stored in this specific packet.
out | the output stream to which the XML should be written. |
Implements regina::NPacket.
|
static |
Contains the integer ID for this packet.
Each distinct packet type must have a unique ID, and this should be a positive integer. See packetregistry.h for further requirements regarding ID selection.
This member is not actually provided for NPacket itself, but must be declared for every packet subclass that will be instantiated. A value need not be assigned; packetregistry.h will take care of this task when you register the packet.
Reimplemented from regina::NPacket.