Main Page

Source Files

Class Hierarchy

Alphabetical List

Compound List

Compound Members

File Members

Related Pages

Search for

---

libsrc/do1.cxx File Reference

Udanax document handling routines. More...

#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include "udanax.h"

Include dependency graph for do1.cxx:

Go to the source code of this file.

Functions
void	graphwholetree (char *filename, typecorecrum *ptr, char *graphtitle)
	???
bool	dofinddocscontaining (Session *sess, typespecset specset, typelinkset *addresssetptr)
	Find documents containing any of the material specified.
bool	doappend (Session *sess, IStreamAddr *doc_isa, typetextset textset)
	Append text to a document.
bool	dorearrange (Session *sess, IStreamAddr *docisaptr, typecutseq *cutseqptr)
	Transpose two regions of text within a document.
bool	docopy (Session *sess, IStreamAddr *docisaptr, Tumbler *vsaptr, typespecset specset)
	Virtually copy (transclude) some material into a document.
bool	docopyinternal (Session *sess, IStreamAddr *docisaptr, Tumbler *vsaptr, typespecset specset)
	Virtually copy (transclude) some material into a document.
bool	doinsert (Session *sess, IStreamAddr *docisaptr, Tumbler *vsaptr, typetextset textset)
	Insert a set of text strings into a document.
void	checkspecandstringbefore ()
	???
bool	dodeletevspan (Session *sess, IStreamAddr *docisaptr, typevspan *vspanptr)
	Delete a range of text from a document.
bool	domakelink (Session *sess, IStreamAddr *docisaptr, typespecset fromspecset, typespecset tospecset, IStreamAddr *linkisaptr)
	Create a 2-endpoint link between parts of documents.
bool	docreatelink (Session *sess, IStreamAddr *docisaptr, typespecset fromspecset, typespecset tospecset, typespecset threespecset, IStreamAddr *linkisaptr)
	Create a 3-endpoint link between parts of documents.
bool	dofollowlink (Session *sess, IStreamAddr *linkisaptr, typespecset *specsetptr, int whichend)
	Return the specification set of one endpoint of a link.
bool	docreatenewdocument (Session *sess, IStreamAddr *isaptr)
	Create a new, empty document.
bool	docreatenode_or_account (Session *sess, IStreamAddr *isaptr)
	Create a new node or account identifier.
bool	doretrievedocvspanfoo (Session *sess, IStreamAddr *docisaptr, typevspan *vspanptr)
	Return the total span of the V-stream of a document.
bool	docreatenewversion (Session *sess, IStreamAddr *isaptr, IStreamAddr *wheretoputit, IStreamAddr *newisaptr)
	Create a new version of a document and return its identifier.
bool	doretrievedocvspan (Session *sess, IStreamAddr *docisaptr, typevspan *vspanptr)
	Return the total span of text and links within a document.
bool	doretrievedocvspanset (Session *sess, IStreamAddr *docisaptr, typevspanset *vspansetptr)
	Return the total span of text and links within a document.
bool	doretrievev (Session *sess, typespecset specset, typevstuffset *vstuffsetptr)
	Return the text and links from set of places within a document.
bool	dofindlinksfromtothree (Session *sess, typespecset fromvspecset, typespecset tovspecset, typespecset threevspecset, typeispan *orglrangeptr, typelinkset *linksetptr)
	Return a list of links that meet a specific set of endpoint criteria.
bool	dofindnumoflinksfromtothree (Session *sess, typespecset *fromvspecset, typespecset *tovspecset, typespecset *threevspecset, typeispan *orglrangeptr, int *numptr)
	Return a count of links that meet a specific set of endpoint criteria.
bool	dofindnextnlinksfromtothree (Session *sess, typevspec *fromvspecptr, typevspec *tovspecptr, typevspec *threevspecptr, typeispan *orglrangeptr, IStreamAddr *lastlinkisaptr, typelinkset *nextlinksetptr, int *nptr)
	Return a subset of links that meet a specific set of endpoint criteria.
bool	doretrieveendsets (Session *sess, typespecset specset, typespecset *fromsetptr, typespecset *tosetptr, typespecset *threesetptr)
	Return a list of all link end-sets in the specification set.
bool	doshowrelationof2versions (Session *sess, typespecset version1, typespecset version2, typespanpairset *relation)
	???
Variables
typespec	spec
typespec	spec2
typespec	spec3
typevstuffset	uppervstuffset
Tumbler	fivetumbler = { 0, 0, 0, 0, { 500 , 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} }

---

Detailed Description

Udanax document handling routines.

(to be defined)

Definition in file do1.cxx.

---

Function Documentation

void checkspecandstringbefore (   )

??? Definition at line 357 of file do1.cxx. References L. Referenced by insertnd(). { L("--checkspecandstringbefore is a NOP--\n"); }

bool doappend (  Session *  sess, IStreamAddr *  doc_isa, typetextset  textset )

Append text to a document. Append a set of text strings onto the end of the text space of a document, returning an indicator of success. Parameters: sess  Input: User's session context doc_isa  Input: Identifier of document textset  Input: Set of text strings Definition at line 148 of file do1.cxx. References appendpm(), and typetextset. Referenced by sourceunixcommand(). : User's session context IStreamAddr *doc_isa, typetextset textset) { return appendpm(sess, doc_isa, textset); }

bool docopy (  Session *  sess, IStreamAddr *  docisaptr, Tumbler *  vsaptr, typespecset  specset )

Virtually copy (transclude) some material into a document. The material determined by the specification set provided is copied to the document at the V-stream address given. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vsaptr  Input: Place within document to receive copy specset  Input: Set of places from which to copy Definition at line 193 of file do1.cxx. References acceptablevsa(), asserttreeisok(), DOCISPAN, findorgl(), granf, graphwholetree(), insertpm(), insertspanf(), L, NOBERTREQUIRED, putitemset(), puttumbler(), spanf, specset2ispanset(), typecorecrum, typeispanset, typeorgl, typespecset, and WRITEBERT. Referenced by copy(), docreatelink(), doinsert(), and domakelink(). : User's session context IStreamAddr *docisaptr, Tumbler *vsaptr, typespecset specset) { bool f; L("(specset2ispanset p=0x%08X)\n", (int) specset); putitemset(sess, (typeitem *) specset); L(")\n"); // Convert the specification set into a set of spans into the I-stream. typeispanset ispanset; f = specset2ispanset(sess, specset, &ispanset, NOBERTREQUIRED); if (!f) { L("(specset2ispanset FAILED)\n"); return false; } L("ispanset is 0x%08X\n", (int) ispanset); L("(specset2ispanset ispanset="); putitemset(sess, (typeitem *) ispanset); L(")\n"); L("(findorgl for docisa="); puttumbler(stdout, docisaptr); L(")\n"); /* * Walk the granfilade to locate and lock, for writing, the document to receive * the copied material. */ // Locate the document's ORGL within the Granfilade and // obtain a write lock on it. typeorgl docorgl; f = findorgl(sess, granf, docisaptr, &docorgl, WRITEBERT); if (!f) { L("(attempt to findorgl FAILED)\n"); return false; } /* * Validate the V-stream address at which to insert the content for reasonableness. */ L("(acceptablevsa)\n"); f = acceptablevsa(vsaptr, docorgl); if (!f) { L("(acceptablevsa FAILED)\n"); return false; } L("(asserttreeisok)\n"); f = asserttreeisok((typecorecrum *) docorgl); if (!f) { L("(asserttreeisok FAILED)\n"); return false; } // L("---- Dump of Entire Granfilade Before Copy ----\n"); // dumpwholetree((typecorecrum *) granf); graphwholetree("/var/tmp/granf_before.dot", (typecorecrum *) granf, "Granfilade before Copy"); // L("---- End of Dump of Entire Granfilade Before Copy ----\n"); // L("---- Dump of Entire Spanfilade Before Copy ----\n"); // dumpwholetree((typecorecrum *) spanf); graphwholetree("/var/tmp/spanf_before.dot", (typecorecrum *) spanf, "Spanfilade before Copy"); // L("---- End of Dump of Entire Spanfilade Before Copy ----\n"); /* * */ /* the meat of docopy: */ L("(insertpm)\n"); f = insertpm(sess, docisaptr, docorgl, vsaptr, (typesporglitem *) ispanset); if (!f) { L("(insertpm FAILED)\n"); return false; } L("(insertspanf)\n"); f = insertspanf(sess, spanf, docisaptr, (typesporglitem *) ispanset, DOCISPAN); if (!f) { L("(insertspanf FAILED)\n"); return false; } L("(asserttreeisok)\n"); f = asserttreeisok((typecorecrum *) docorgl); if (!f) { L("(asserttreeisok FAILED)\n"); return false; } // L("---- Dump of Entire Granfilade After Copy ----\n"); // dumpwholetree((typecorecrum *) granf); graphwholetree("/var/tmp/granf_after.dot", (typecorecrum *) granf, "Granfilade after Copy"); // L("---- End of Dump of Entire Granfilade After Copy ----\n"); // L("---- Dump of Entire Spanfilade After Copy ----\n"); // dumpwholetree((typecorecrum *) spanf); graphwholetree("/var/tmp/spanf_after.dot", (typecorecrum *) spanf, "Spanfilade after Copy"); // L("---- End of Dump of Entire Spanfilade After Copy ----\n"); return true; }

bool docopyinternal (  Session *  sess, IStreamAddr *  docisaptr, Tumbler *  vsaptr, typespecset  specset )

Virtually copy (transclude) some material into a document. The material determined by the specification set provided is copied to the document at the V-stream address given. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vsaptr  Input: Place within document to receive copy specset  Input: Set of places from which to copy Definition at line 304 of file do1.cxx. References acceptablevsa(), asserttreeisok(), DOCISPAN, findorgl(), granf, insertpm(), insertspanf(), NOBERTREQUIRED, spanf, specset2ispanset(), typecorecrum, typeispanset, typeorgl, and typespecset. Referenced by docreatenewversion(). : User's session context IStreamAddr *docisaptr, Tumbler *vsaptr, typespecset specset) { typeispanset ispanset; typeorgl docorgl; // Convert the specification set into a set of spans into the I-stream. return (specset2ispanset(sess, specset, &ispanset, NOBERTREQUIRED) && findorgl(sess, granf, docisaptr, &docorgl, NOBERTREQUIRED) && acceptablevsa(vsaptr, docorgl) && asserttreeisok((typecorecrum *) docorgl) /* the meat of docopy: */ && insertpm(sess, docisaptr, docorgl, vsaptr, (typesporglitem *) ispanset) && insertspanf(sess, spanf, docisaptr, (typesporglitem *) ispanset, DOCISPAN) && asserttreeisok((typecorecrum *) docorgl) ); }

bool docreatelink (  Session *  sess, IStreamAddr *  docisaptr, typespecset  fromspecset, typespecset  tospecset, typespecset  threespecset, IStreamAddr *  linkisaptr )

Create a 3-endpoint link between parts of documents. Create a link within the specified document, -from- a set of spans, -to- a set of spans, -of type- a set of spans. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document to contain link fromspecset  Input: Specification set of 'From' end tospecset  Input: Specification set of 'To' end threespecset  Input: Specification set of 'Three' end linkisaptr  Input: I-stream address of new link Definition at line 428 of file do1.cxx. References ATOM, createorglingranf(), docopy(), DOCUMENT, findnextlinkvsa(), findorgl(), granf, insertendsetsinorgl(), insertendsetsinspanf(), LINKATOM, makehint(), NOBERTREQUIRED, setlinkvsas(), spanf, specset2sporglset(), tumbler2spanset(), typeorgl, typespanset, typespecset, and typesporglset. Referenced by createlink(). : User's session context IStreamAddr *docisaptr, typespecset fromspecset, typespecset tospecset, typespecset threespecset, IStreamAddr *linkisaptr) { Tumbler linkvsa, fromvsa, tovsa, threevsa; typespanset ispanset; typesporglset fromsporglset; typesporglset tosporglset; typesporglset threesporglset; typeorgl link; typehint hint; makehint(DOCUMENT, ATOM, LINKATOM, docisaptr, &hint); return createorglingranf(sess, granf, &hint, linkisaptr) && tumbler2spanset(sess, linkisaptr, &ispanset) && findnextlinkvsa(sess, docisaptr, &linkvsa) && docopy(sess, docisaptr, &linkvsa, (typespec *) ispanset) && findorgl(sess, granf, linkisaptr, &link, /* WRITEBERT ECH 7-1 */ NOBERTREQUIRED) && specset2sporglset(sess, fromspecset, &fromsporglset, NOBERTREQUIRED) && specset2sporglset(sess, tospecset, &tosporglset, NOBERTREQUIRED) && specset2sporglset(sess, threespecset, &threesporglset, NOBERTREQUIRED) && setlinkvsas(&fromvsa, &tovsa, &threevsa) && insertendsetsinorgl(sess, linkisaptr, link, &fromvsa, fromsporglset, &tovsa, tosporglset, &threevsa, threesporglset) && insertendsetsinspanf(sess, spanf, linkisaptr, fromsporglset, tosporglset, threesporglset) ; }

bool docreatenewdocument (  Session *  sess, IStreamAddr *  isaptr )

Create a new, empty document. Create a new, empty and unopened document within the user's document space and return its identifier. Create a new document under the account and node of the user who issued the request. Return the global identifier for the document. This request creates the document but does not open it for access; you must issue an open request (see below) to access the data in the new document. Parameters: sess  Input: User's session context isaptr  Output: I-stream address of new, empty document Definition at line 493 of file do1.cxx. References ACCOUNT, Session::account, createorglingranf(), DOCUMENT, granf, and makehint(). Referenced by createnewdocument(), and sourceunixcommand(). : User's session context IStreamAddr *isaptr) { typehint hint; makehint(ACCOUNT, DOCUMENT, 0, &sess->account, &hint); return createorglingranf(sess, granf, &hint, isaptr); }

bool docreatenewversion (  Session *  sess, IStreamAddr *  isaptr, IStreamAddr *  wheretoputit, IStreamAddr *  newisaptr )

Create a new version of a document and return its identifier. Create a new version of a document and return its identifier. The new version of the document will contain a virtual copy of the original. Parameters: sess  Input: User's session context isaptr  Input: Identifier of document to fork wheretoputit  Input: User account under which to create copy newisaptr  Output: I-stream address of new version Definition at line 553 of file do1.cxx. References ACCOUNT, assert, BERTMODEONLY, createorglingranf(), typevspec::docisa, doclose(), docopyinternal(), DOCUMENT, doopen(), doretrievedocvspanfoo(), granf, isthisusersdocument(), typevspec::itemid, makehint(), movetumbler, typevspec::next, NULL, typespan::stream, tumbleraccounteq(), typevspan, typevspec::vspanset, VSPECID, and WRITEBERT. Referenced by createnewversion(), and doopen(). : User's session context IStreamAddr *isaptr, IStreamAddr *wheretoputit, IStreamAddr *newisaptr) { IStreamAddr newtp; /* for internal open */ // Test for ownership to do the right thing for explicit creation of new // version of someone else's document typehint hint; if (tumbleraccounteq(isaptr, wheretoputit) && isthisusersdocument(sess, isaptr)) { makehint(DOCUMENT, DOCUMENT, 0, isaptr /* wheretoputit */ , &hint); } else { // This does the right thing for a new version of someone else's // document, as it duplicates the behavior of docreatenewdocument makehint(ACCOUNT, DOCUMENT, 0, wheretoputit, &hint); } if (!createorglingranf(sess, granf, &hint, newisaptr)) return false; // Determine the full span of the parent document, to know the range to // copy into the newly created version. typevspan vspan; if (!doretrievedocvspanfoo(sess, isaptr, &vspan)) return false; typevspec vspec; vspec.next = NULL; vspec.itemid = VSPECID; movetumbler(isaptr, &vspec.docisa); vspec.vspanset = &vspan; // BERTMODEONLY to prevent recursive createnewversions if (!doopen(sess, newisaptr, &newtp, WRITEBERT, BERTMODEONLY)) assert(0); // Couldn't do internal doopen for new doc in docreatenewversion // Map (copy virtually) the entire content of the original document into // V-stream of the newly created version. docopyinternal(sess, newisaptr, &vspan.stream, (typespec *) &vspec); doclose(sess, newisaptr); return true; }

bool docreatenode_or_account (  Session *  sess, IStreamAddr *  isaptr )

Create a new node or account identifier. Create a new node or account identifier, globally, and return its identifier. Declare that id-account is a legal account or node. If id-account is an account tumbler, then the backend creates the account. If it is a node tumbler, then the backend reassigns its own address to id-account. Parameters: sess  Input: User's session context isaptr  Output: I-stream address of new node or account Definition at line 515 of file do1.cxx. References createorglingranf(), granf, makehint(), NODE, and tumblercopy(). Referenced by createnode_or_account(). : User's session context IStreamAddr *isaptr) { IStreamAddr isa; tumblercopy(isaptr, &isa); typehint hint; makehint(NODE, NODE, 0, /* &sess->account */ &isa, &hint); return createorglingranf(sess, granf, &hint, &isa); }

bool dodeletevspan (  Session *  sess, IStreamAddr *  docisaptr, typevspan *  vspanptr )

Delete a range of text from a document. Remove the specified span of text from a document, shuffling down the text that follows that position. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vspanptr  Input: Span of text to be deleted Definition at line 370 of file do1.cxx. References deletevspanpm(), findorgl(), granf, typeorgl, typevspan, and WRITEBERT. Referenced by deletevspan(). : User's session context IStreamAddr *docisaptr, typevspan *vspanptr) { typeorgl docorgl; if (findorgl(sess, granf, docisaptr, &docorgl, WRITEBERT)) return deletevspanpm(sess, docisaptr, docorgl, vspanptr); return false; }

bool dofinddocscontaining (  Session *  sess, typespecset  specset, typelinkset *  addresssetptr )

Find documents containing any of the material specified. Return a list of all documents containing any of the material specified by the V-stream specification set, regardless of where the native copies are located. Parameters: sess  Input: User's session context specset  Input: Set of specifications addresssetptr  Output: Set of matching documents Definition at line 126 of file do1.cxx. References finddocscontainingsp(), NOBERTREQUIRED, specset2ispanset(), typeispanset, typelinkset, and typespecset. Referenced by finddocscontaining(). : User's session context typespecset specset, typelinkset *addresssetptr) { typeispanset ispanset; // Convert the specification set into a set of spans into the I-stream. return specset2ispanset(sess, specset, &ispanset, NOBERTREQUIRED) // Search for documents containing those spans && finddocscontainingsp(sess, ispanset, addresssetptr); }

bool dofindlinksfromtothree (  Session *  sess, typespecset  fromvspecset, typespecset  tovspecset, typespecset  threevspecset, typeispan *  orglrangeptr, typelinkset *  linksetptr )

Return a list of links that meet a specific set of endpoint criteria. Return a list of all links which are (1) from any or all part of the -from- set, (2) to any or all part of the -to- set and -three- set, and (3) in the home of ORGLs. This is an AND-relation in that all qualifications must be met. Parameters: sess  Input: User's session context fromvspecset  Input: Specification of the From endpoint tovspecset  Input: Specification of the To endpoint threevspecset  Input: Specification of the Three endpoint orglrangeptr  Input: a Range of document ORGLs linksetptr  Output: Set of links meeting qualifications Definition at line 675 of file do1.cxx. References findlinksfromtothreesp(), spanf, typeispan, typelinkset, and typespecset. Referenced by findlinksfromtothree(). : User's session context typespecset fromvspecset, typespecset tovspecset, typespecset threevspecset, typeispan *orglrangeptr, typelinkset *linksetptr) { return findlinksfromtothreesp(sess, spanf, fromvspecset, tovspecset, threevspecset, orglrangeptr, linksetptr); }

bool dofindnextnlinksfromtothree (  Session *  sess, typevspec *  fromvspecptr, typevspec *  tovspecptr, typevspec *  threevspecptr, typeispan *  orglrangeptr, IStreamAddr *  lastlinkisaptr, typelinkset *  nextlinksetptr, int *  nptr )

Return a subset of links that meet a specific set of endpoint criteria. Return a subset of all links which are (1) from any or all part of the -from- set, (2) to any or all part of the -to- set and -three- set, and (3) in the home of ORGLs. This is an AND-relation in that all qualifications must be met. Parameters: sess  Input: User's session context fromvspecptr  Input: Specification of the From endpoint tovspecptr  Input: Specification of the To endpoint threevspecptr  Input: Specification of the Three endpoint orglrangeptr  Input: a range of document ORGLs lastlinkisaptr  Input: last link addr from previous query nextlinksetptr  Ouput: Set of links meeting qualifications nptr  Input: Maximum count of links to return Definition at line 717 of file do1.cxx. References findnextnlinksfromtothreesp(), typeispan, and typelinkset. Referenced by findnextnlinksfromtothree(). : User's session context typevspec *fromvspecptr, typevspec *tovspecptr, typevspec *threevspecptr, typeispan *orglrangeptr, IStreamAddr *lastlinkisaptr, typelinkset *nextlinksetptr, int *nptr) { return findnextnlinksfromtothreesp(sess, (typespec *) fromvspecptr, (typespec *) tovspecptr, (typespec *) threevspecptr, orglrangeptr, lastlinkisaptr, nextlinksetptr, nptr); }

bool dofindnumoflinksfromtothree (  Session *  sess, typespecset *  fromvspecset, typespecset *  tovspecset, typespecset *  threevspecset, typeispan *  orglrangeptr, int *  numptr )

Return a count of links that meet a specific set of endpoint criteria. Return a count of all links which are (1) from any or all part of the -from- set, (2) to any or all part of the -to- set and -three- set, and (3) in the home of ORGLs. This is an AND-relation in that all qualifications must be met. Parameters: sess  Input: User's session context fromvspecset  Input: Specification of the From endpoint tovspecset  Input: Specification of the To endpoint threevspecset  Input: Specification of the Three endpoint orglrangeptr  Input: a Range of document ORGLs numptr  Output: Count of links meeting qualifications Definition at line 695 of file do1.cxx. References findnumoflinksfromtothreesp(), spanf, typeispan, and typespecset. Referenced by findnumoflinksfromtothree(). : User's session context typespecset *fromvspecset, typespecset *tovspecset, typespecset *threevspecset, typeispan *orglrangeptr, int *numptr) { /*BUG: there is some inconsistency re arg 'fromvspecset' as whether it is (typespec *)[fn below] or (typespec **)[passed-in] */ return findnumoflinksfromtothreesp(sess, spanf, (typespec *) fromvspecset, (typespec *) tovspecset, (typespec *) threevspecset, orglrangeptr, numptr); }

bool dofollowlink (  Session *  sess, IStreamAddr *  linkisaptr, typespecset *  specsetptr, int  whichend )

Return the specification set of one endpoint of a link. Parameters: sess  Input: User's session context linkisaptr  Input: Identifier of link to query specsetptr  Output: Specification of end specified whichend  Input: Which end of the link to query Definition at line 466 of file do1.cxx. References link2sporglset(), linksporglset2specset(), NOBERTREQUIRED, typespecset, and typesporglset. Referenced by followlink(). : User's session context IStreamAddr *linkisaptr, typespecset *specsetptr, int whichend) { typesporglset sporglset; return link2sporglset(sess, linkisaptr, &sporglset, whichend, NOBERTREQUIRED) && linksporglset2specset(sess, &((typesporgl *) sporglset)->sporgladdress, sporglset, specsetptr, NOBERTREQUIRED); }

bool doinsert (  Session *  sess, IStreamAddr *  docisaptr, Tumbler *  vsaptr, typetextset  textset )

Insert a set of text strings into a document. Insert a set of text strings into the specified place within a document, shoving down the text following that position. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vsaptr  Input: Place within document to receive text textset  Input: Set of text strings to insert Definition at line 337 of file do1.cxx. References ATOM, docopy(), DOCUMENT, granf, inserttextingranf(), makehint(), TEXTATOM, typespanset, and typetextset. Referenced by appendpm(), and insert(). : User's session context IStreamAddr *docisaptr, Tumbler *vsaptr, typetextset textset) { typehint hint; makehint(DOCUMENT, ATOM, TEXTATOM, docisaptr, &hint); typespanset ispanset; return inserttextingranf(sess, granf, &hint, textset, &ispanset) && docopy(sess, docisaptr, vsaptr, (typespec *) ispanset); }

bool domakelink (  Session *  sess, IStreamAddr *  docisaptr, typespecset  fromspecset, typespecset  tospecset, IStreamAddr *  linkisaptr )

Create a 2-endpoint link between parts of documents. Create a link within the specified document, -from- a set of spans, -to- a set of spans. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document to contain link fromspecset  Input: Specification set of 'From' end tospecset  Input: Specification set of 'To' end linkisaptr  Output: I-stream address of new link Definition at line 391 of file do1.cxx. References ATOM, createorglingranf(), docopy(), DOCUMENT, findnextlinkvsa(), findorgl(), granf, insertendsetsinorgl(), insertendsetsinspanf(), LINKATOM, makehint(), NOBERTREQUIRED, NULL, setlinkvsas(), spanf, specset2sporglset(), tumbler2spanset(), typeorgl, typespanset, typespecset, typesporglset, and WRITEBERT. : User's session context IStreamAddr *docisaptr, typespecset fromspecset, typespecset tospecset, IStreamAddr *linkisaptr) { Tumbler linkvsa, fromvsa, tovsa; typespanset ispanset; typesporglset fromsporglset; typesporglset tosporglset; typeorgl link; typehint hint; makehint(DOCUMENT, ATOM, LINKATOM, docisaptr, &hint); return createorglingranf(sess, granf, &hint, linkisaptr) && tumbler2spanset(sess, linkisaptr, &ispanset) && findnextlinkvsa(sess, docisaptr, &linkvsa) && docopy(sess, docisaptr, &linkvsa, (typespec *) ispanset) && findorgl(sess, granf, linkisaptr, &link, WRITEBERT) && specset2sporglset(sess, fromspecset, &fromsporglset, NOBERTREQUIRED) && specset2sporglset(sess, tospecset, &tosporglset, NOBERTREQUIRED) && setlinkvsas(&fromvsa, &tovsa, NULL) && insertendsetsinorgl(sess, linkisaptr, link, &fromvsa, fromsporglset, &tovsa, tosporglset, NULL, NULL) && insertendsetsinspanf(sess, spanf, linkisaptr, fromsporglset, tosporglset, NULL) ; }

bool dorearrange (  Session *  sess, IStreamAddr *  docisaptr, typecutseq *  cutseqptr )

Transpose two regions of text within a document. Transpose two regions of text, using a set of 'cuts' within a document. Cuts are V-stream addresses within a particular document. There can be three of four entries in the cut set. If three cuts are supplied, the two regions being transposed are from cut 1 to cut 2, and from cut 2 to cut 3, assuming cut 1 < cut 2 < cut 3. If four cuts are supplied, the regions are from cut 1 to cut 2, and from cut 3 to cut 4, again assuming cut 1 < cut 2 < cut 3 < cut 4. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document cutseqptr  Input: Sequence of cuts Definition at line 169 of file do1.cxx. References findorgl(), granf, rearrangepm(), typeorgl, and WRITEBERT. Referenced by rearrange(). : User's session context IStreamAddr *docisaptr, typecutseq *cutseqptr) { // ORGL element on the Granfilade representing the particular document typeorgl docorgl; // Locate the document's ORGL within the Granfilade and // obtain a write lock on it. return findorgl(sess, granf, docisaptr, &docorgl, WRITEBERT) // Actually perform the rearrangement of text. && rearrangepm(sess, docisaptr, docorgl, cutseqptr); }

bool doretrievedocvspan (  Session *  sess, IStreamAddr *  docisaptr, typevspan *  vspanptr )

Return the total span of text and links within a document. Return a V-stream span representing the full size of both the text and link streams. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vspanptr  Input: Span of V-stream to query for content Definition at line 608 of file do1.cxx. References findorgl(), granf, READBERT, retrievevspanpm(), typeorgl, and typevspan. Referenced by findnextlinkvsa(), and retrievedocvspan(). : User's session context IStreamAddr *docisaptr, typevspan *vspanptr) { typeorgl docorgl; return findorgl(sess, granf, docisaptr, &docorgl, READBERT) && retrievevspanpm(sess, docorgl, vspanptr); }

bool doretrievedocvspanfoo (  Session *  sess, IStreamAddr *  docisaptr, typevspan *  vspanptr )  [static]

Return the total span of the V-stream of a document. Note: Internal routine, no open required. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vspanptr  Output: Total span of V-stream within document Definition at line 534 of file do1.cxx. References findorgl(), granf, NOBERTREQUIRED, retrievedocumentpartofvspanpm(), typeorgl, and typevspan. Referenced by docreatenewversion(). : User's session context IStreamAddr *docisaptr, typevspan *vspanptr) { typeorgl docorgl; return findorgl(sess, granf, docisaptr, &docorgl, NOBERTREQUIRED) && retrievedocumentpartofvspanpm(sess, docorgl, vspanptr); }

bool doretrievedocvspanset (  Session *  sess, IStreamAddr *  docisaptr, typevspanset *  vspansetptr )

Return the total span of text and links within a document. Return a set of V-stream spans, one representing the full size of the text stream, and one representing the full size of the link stream. To-Fix: This function should not fail on an empty doc but instead return an empty result set. It also should return a set for each type of data, even when there are none of that type. Parameters: sess  Input: User's session context docisaptr  Input: Identifier of document vspansetptr  Input: Set of V-stream spans to query Definition at line 630 of file do1.cxx. References findorgl(), granf, isemptyorgl(), READBERT, retrievevspansetpm(), typeorgl, and typevspanset. Referenced by retrievedocvspanset(). : User's session context IStreamAddr *docisaptr, typevspanset *vspansetptr) { typeorgl docorgl; if (findorgl(sess, granf, docisaptr, &docorgl, READBERT)) { if (!isemptyorgl(docorgl)) { if (retrievevspansetpm(sess, docorgl, vspansetptr)) { return true; } } } return false; }

bool doretrieveendsets (  Session *  sess, typespecset  specset, typespecset *  fromsetptr, typespecset *  tosetptr, typespecset *  threesetptr )

Return a list of all link end-sets in the specification set. Parameters: sess  Input: User's session context specset  Input: Specification set fromsetptr  Output: List of all From sets in specification tosetptr  Output: List of all To sets in specification threesetptr  Output: List of all Three sets in specifiations Definition at line 737 of file do1.cxx. References retrieveendsetsfromspanf(), and typespecset. Referenced by retrieveendsets(). : User's session context typespecset specset, typespecset *fromsetptr, typespecset *tosetptr, typespecset *threesetptr) { return retrieveendsetsfromspanf(sess, specset, fromsetptr, tosetptr, threesetptr); }

bool doretrievev (  Session *  sess, typespecset  specset, typevstuffset *  vstuffsetptr )

Return the text and links from set of places within a document. Return actual content from a document. Parameters: sess  Input: User's session context specset  Input: Set of specifications from which to obtain content vstuffsetptr  Output: Set of content items queried Definition at line 654 of file do1.cxx. References granf, ispanset2vstuffset(), READBERT, specset2ispanset(), typeispanset, typespecset, and typevstuffset. Referenced by assertspecisstring(), and retrievev(). : User's session context typespecset specset, typevstuffset *vstuffsetptr) { typeispanset ispanset; // Convert the specification set into a set of spans into the I-stream. return specset2ispanset(sess, specset, &ispanset, READBERT) && ispanset2vstuffset(sess, granf, ispanset, vstuffsetptr); }

bool doshowrelationof2versions (  Session *  sess, typespecset  version1, typespecset  version2, typespanpairset *  relation )

??? Return a list of ordered pairs of the spans of the two spec sets that correspond Parameters: sess  Input: User's session context version1  Input: Specification of version 1 document version2  Input: Specification of version 2 document relation  Output: List of corresponding spans Definition at line 754 of file do1.cxx. References intersectspansets(), ISPANID, ispansetandspecsets2spanpairset(), NULL, READBERT, specset2ispanset(), typeispanset, typespanpairset, and typespecset. Referenced by showrelationof2versions(). : User's session context typespecset version1, typespecset version2, typespanpairset *relation) { typeispanset version1ispans = NULL; typeispanset version2ispans = NULL; typeispanset commonispans = NULL; // Convert the specification set into a set of spans into the I-stream. return specset2ispanset(sess, version1, &version1ispans, READBERT) && specset2ispanset(sess, version2, &version2ispans, READBERT) && intersectspansets(sess, version1ispans, version2ispans, &commonispans, ISPANID) && ispansetandspecsets2spanpairset(sess, commonispans, version1, version2, relation); }

void graphwholetree (  char *  filename, typecorecrum *  ptr, char *  graphlabel )

??? (to be defined) Definition at line 710 of file test.cxx. References clear, findfather(), graphwholesubtree(), isfullcrum(), typecorecrum, and typedsp. Referenced by docopy(). { FILE *fd = fopen(filename, "w"); fprintf(fd, "digraph G {\n"); fprintf(fd, " nodesep=0.40;\n"); fprintf(fd, " ranksep=\"0.40 equally\";\n"); fprintf(fd, " center=true;\n"); fprintf(fd, " page=\"8.5, 11\"; /* unit of pagination */\n"); fprintf(fd, " size=\"8.25, 10.75\";\n"); fprintf(fd, " /* ratio=auto; */\n"); fprintf(fd, " orientation=landscape;\n"); fprintf(fd, " label=\"%s\";\n", graphlabel); fprintf(fd, " fontsize=14;\n"); fprintf(fd, " fontcolor=blue;\n"); fprintf(fd, "\n"); fprintf(fd, " node [shape = record];\n"); fprintf(fd, "\n"); for (; !isfullcrum(ptr); ptr = (typecorecrum *) findfather(ptr)) ; typedsp offset; clear(&offset, sizeof(offset)); graphwholesubtree(fd, (typecuc *) ptr, &offset, ""); fprintf(fd, " A [width=0.1, height=0.1, style=invis];\n"); fprintf(fd, " B [width=0.1, height=0.1, style=invis];\n"); fprintf(fd, " C [width=0.1, height=0.1, style=invis];\n"); fprintf(fd, " A -> B [style=invis];\n"); fprintf(fd, " B -> C [style=invis];\n"); fprintf(fd, "}\n"); fclose(fd); }

---

Variable Documentation

Tumbler fivetumbler = { 0, 0, 0, 0, { 500 , 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} }

Definition at line 115 of file do1.cxx.

typespec spec

Definition at line 113 of file do1.cxx.

typespec spec2

Definition at line 113 of file do1.cxx. Referenced by makespanpairsforispan().

typespec spec3

Definition at line 113 of file do1.cxx.

typevstuffset uppervstuffset

Definition at line 114 of file do1.cxx.

---