XMLTree.cpp

   1 #include "XMLTree.h"\r
   2 #include <cstring>\r
   3 \r
   4 // functions to convert tag positions to the corresponding tree node and viceversa. \r
   5 // These are implemented in order to be able to change the tree and Tags representations, \r
   6 // without affecting the code so much.\r
   7 // Current implementation corresponds to balanced-parentheses representation for\r
   8 // the tree, and storing 2 tags per tree node (opening and closing tags).\r
   9 \r
  10 // tag position -> tree node\r
  11 inline treeNode tagpos2node(int t) {\r
  12    return (treeNode)t;\r
  13 }\r
  14 \r
  15 // tree node -> tag position\r
  16 inline int node2tagpos(treeNode x) {\r
  17    return (int)x;\r
  18 }\r
  19 \r
  20 \r
  21 //KIM OJO to prevent suprious "unused result" warnings\r
  22 \r
  23 inline void ufread(void *ptr, size_t size, size_t nmemb, FILE *stream){\r
  24   size_t res;\r
  25   res = fread(ptr,size,nmemb,stream);\r
  26   if (res < nmemb)\r
  27     throw "ufread I/O error";\r
  28 \r
  29   return;\r
  30 }\r
  31 \r
  32 inline void ufwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream){\r
  33   size_t res;\r
  34   res = fwrite(ptr,size,nmemb,stream);\r
  35   if (res < nmemb)\r
  36     throw "ufwrite I/O error";\r
  37   return;\r
  38 }\r
  39 \r
  40 // OJO to fail cleanly while doing a realloc\r
  41 // if we can't realloc we are pretty much screwed anyway but\r
  42 // it makes the code clearer to not have a bunch of if (!ptr) { printf("..."); exit(1); };\r
  43 inline void * urealloc(void *ptr, size_t size){\r
  44 \r
  45   void * dest = realloc(ptr,size);\r
  46   //don't fail if we requested size 0\r
  47   if (dest == NULL && size > 0 )\r
  48     throw std::bad_alloc();\r
  49   return dest;\r
  50 \r
  51 }\r
  52 \r
  53 inline void * ucalloc(size_t nmemb, size_t size){\r
  54 \r
  55   void * dest = calloc(nmemb,size);\r
  56   //don't fail if we requested size 0\r
  57   if (dest == NULL && nmemb > 0 && size > 0 )\r
  58     throw std::bad_alloc();\r
  59   return dest;\r
  60 \r
  61 }\r
  62 \r
  63 inline void * umalloc(size_t size){\r
  64   void * dest = malloc(size);\r
  65   if (dest == NULL && size > 0)\r
  66     throw std::bad_alloc();\r
  67   return dest;\r
  68 }\r
  69 \r
  70 // Save: saves XML tree data structure to file. \r
  71 void XMLTree::Save(unsigned char *filename) \r
  72  {\r
  73 \r
  74     FILE *fp;\r
  75     char filenameaux[1024];\r
  76     int i;\r
  77    \r
  78     sprintf(filenameaux, "%s.srx", filename);\r
  79     fp = fopen(filenameaux, "w");\r
  80     if (fp == NULL) {\r
  81        printf("Error: cannot create file %s to store the tree structure of XML collection\n", filenameaux);\r
  82        exit(1);\r
  83     } \r
  84     \r
  85     // first stores the tree topology\r
  86     saveTree(Par, fp);\r
  87  \r
  88     // stores the table with tag names\r
  89     ufwrite(&ntagnames, sizeof(int), 1, fp);\r
  90     for (i=0; i<ntagnames;i++)\r
  91       fprintf(fp, "%s\n",TagName[i]);\r
  92     \r
  93     \r
  94     // stores the flags\r
  95     ufwrite(&indexing_empty_texts, sizeof(bool), 1, fp);\r
  96     ufwrite(&initialized, sizeof(bool), 1, fp);\r
  97     ufwrite(&finished, sizeof(bool), 1, fp);\r
  98     ufwrite(&disable_tc, sizeof(bool),1,fp);\r
  99     \r
 100     if (!indexing_empty_texts) EBVector->save(fp);\r
 101     \r
 102     // stores the tags\r
 103     Tags->save(fp);\r
 104 \r
 105     // stores the texts   \r
 106     if (!disable_tc)\r
 107       Text->Save(fp);\r
 108 \r
 109     fclose(fp);\r
 110 \r
 111  }\r
 112 \r
 113 \r
 114 // Load: loads XML tree data structure from file. Returns\r
 115 // a pointer to the loaded data structure\r
 116 XMLTree *XMLTree::Load(unsigned char *filename, int sample_rate_text) \r
 117  {\r
 118 \r
 119     FILE *fp;\r
 120     char buffer[1024];\r
 121     XMLTree *XML_Tree;\r
 122     int i;\r
 123     size_t s_tree = 0;\r
 124     long s_text = 0;\r
 125     size_t s_tags = 0;\r
 126 \r
 127     // first load the tree topology\r
 128     sprintf(buffer, "%s.srx", filename);\r
 129     fp = fopen(buffer, "r");\r
 130     if (fp == NULL) {\r
 131        printf("Error: cannot open file %s to load the tree structure of XML collection\n", buffer);\r
 132        exit(1);\r
 133     } \r
 134 \r
 135     XML_Tree = new XMLTree();\r
 136 \r
 137     XML_Tree->Par = (bp *)umalloc(sizeof(bp));\r
 138 \r
 139     loadTree(XML_Tree->Par, fp); \r
 140 \r
 141     s_tree += sizeof(bp);\r
 142 \r
 143     // stores the table with tag names\r
 144     ufread(&XML_Tree->ntagnames, sizeof(int), 1, fp);\r
 145     \r
 146     s_tree += sizeof(int);\r
 147 \r
 148     XML_Tree->TagName = (unsigned char **)umalloc(XML_Tree->ntagnames*sizeof(unsigned char *));\r
 149     \r
 150     s_tags += sizeof(unsigned char*)*XML_Tree->ntagnames;\r
 151 \r
 152 \r
 153     for (i=0; i<XML_Tree->ntagnames;i++) {\r
 154       \r
 155       // OJO Kim is it needed ?\r
 156       int k = feof(fp);\r
 157 \r
 158       \r
 159        // fscanf chokes on "\n" which is the case for the root element\r
 160        char * r = fgets(buffer,1023,fp);\r
 161        //       int r = fscanf(fp, "%s\n",buffer);\r
 162        if (r==NULL)\r
 163          throw "Cannot read tag list";\r
 164 \r
 165        // strlen is actually the right size, since there is a trailing '\n'\r
 166        int len = strlen((const char*)buffer);\r
 167        XML_Tree->TagName[i] = (unsigned char *)ucalloc(len,sizeof(char));\r
 168        strncpy((char *)XML_Tree->TagName[i], (const char *)buffer,len - 1);\r
 169        s_tags+= len*sizeof(char);\r
 170     }\r
 171         \r
 172     // loads the flags\r
 173 \r
 174     ufread(&(XML_Tree->indexing_empty_texts), sizeof(bool), 1, fp);\r
 175     ufread(&(XML_Tree->initialized), sizeof(bool), 1, fp);\r
 176     ufread(&(XML_Tree->finished), sizeof(bool), 1, fp);\r
 177     ufread(&(XML_Tree->disable_tc), sizeof(bool), 1, fp);\r
 178     \r
 179     s_tree+=sizeof(bool)*4;\r
 180 \r
 181     if (!(XML_Tree->indexing_empty_texts)) XML_Tree->EBVector = static_bitsequence_rrr02::load(fp);\r
 182     \r
 183     s_tree+= XML_Tree->EBVector->size();\r
 184     \r
 185     // loads the tags\r
 186     XML_Tree->Tags = static_sequence::load(fp);\r
 187     s_tree+= XML_Tree->Tags->size();\r
 188 \r
 189     s_text = ftell(fp);\r
 190 \r
 191     // loads the texts\r
 192     if (!XML_Tree->disable_tc){\r
 193       XML_Tree->Text = TextCollection::InitTextCollection(sample_rate_text);\r
 194       XML_Tree->Text->Load(fp,sample_rate_text);\r
 195     }\r
 196     else\r
 197       XML_Tree->Text = NULL;\r
 198 \r
 199     s_text = ftell(fp) - s_text;\r
 200     fclose(fp);\r
 201 \r
 202     std::cerr << "Tree part is " << s_tree/1024 << " Kbytes,\n"\r
 203               << "with node->tagid part " << XML_Tree->Tags->size()/1024 << "Kbytes \n"\r
 204               << "size of Tag part : " << XML_Tree->Tags->length () << " elements\n"\r
 205               << "sizof(unsigned int)* " <<  XML_Tree->Tags->length () << " = " << \r
 206       sizeof(unsigned int) * XML_Tree->Tags->length () / 1024 << " Kbytes\n"\r
 207               << "Tag part is " << s_tags/1024 << " Kbytes,\n"\r
 208               << "Text collection is " << s_text/1024 << " Kbytes \n";\r
 209     return XML_Tree;\r
 210  }\r
 211 \r
 212 \r
 213 // ~XMLTree: frees memory of XML tree.\r
 214 XMLTree::~XMLTree() \r
 215  { \r
 216     int i;\r
 217 \r
 218     destroyTree(Par);\r
 219     free(Par); // frees the memory of struct Par\r
 220    \r
 221     for (i=0; i<ntagnames;i++) \r
 222        free(TagName[i]);\r
 223     \r
 224     free(TagName);\r
 225 \r
 226     if (!indexing_empty_texts) {\r
 227        //EBVector->~static_bitsequence_rrr02();\r
 228        delete EBVector;\r
 229        EBVector = NULL;\r
 230     }\r
 231 \r
 232     //Tags->~static_sequence_wvtree();\r
 233     delete Tags;\r
 234     Tags = NULL;\r
 235 \r
 236     //Text->~TextCollection();\r
 237     delete Text;\r
 238     Text = NULL;\r
 239 \r
 240     initialized = false;\r
 241     finished = false;\r
 242  }\r
 243 \r
 244 // root(): returns the tree root.\r
 245 treeNode XMLTree::Root() \r
 246  {\r
 247     if (!finished) {\r
 248        fprintf(stderr, "Root() : Error: data structure has not been constructed properly\n");\r
 249        exit(1);\r
 250     }\r
 251     return root_node(Par);\r
 252  }\r
 253 \r
 254 // SubtreeSize(x): the number of nodes (and attributes) in the subtree of node x.\r
 255 int XMLTree::SubtreeSize(treeNode x) \r
 256  {\r
 257     if (!finished) {\r
 258        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 259        exit(1);\r
 260     }\r
 261     return subtree_size(Par, x);\r
 262  }\r
 263 \r
 264 // SubtreeTags(x,tag): the number of occurrences of tag within the subtree of node x.\r
 265 int XMLTree::SubtreeTags(treeNode x, TagType tag) \r
 266  {\r
 267     if (!finished) {\r
 268        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 269        exit(1);\r
 270     }\r
 271 \r
 272     int s = x + 2*subtree_size(Par, x) - 1;\r
 273  \r
 274     return Tags->rank(tag, s) - Tags->rank(tag, node2tagpos(x)-1);\r
 275  }\r
 276 \r
 277 // IsLeaf(x): returns whether node x is leaf or not. In the succinct representation\r
 278 // this is just a bit inspection.\r
 279 bool XMLTree::IsLeaf(treeNode x) \r
 280  {\r
 281     return isleaf(Par, x);\r
 282  } \r
 283 \r
 284 // IsAncestor(x,y): returns whether node x is ancestor of node y.\r
 285 bool XMLTree::IsAncestor(treeNode x, treeNode y) \r
 286  {\r
 287     if (!finished) {\r
 288        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 289        exit(1);\r
 290     }\r
 291 \r
 292     return is_ancestor(Par, x, y);\r
 293  }\r
 294 \r
 295 // IsChild(x,y): returns whether node x is parent of node y.\r
 296 bool XMLTree::IsChild(treeNode x, treeNode y) \r
 297  {\r
 298     if (!finished) {\r
 299        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 300        exit(1);\r
 301     }\r
 302 \r
 303     if (!is_ancestor(Par, x, y)) return false;\r
 304     return depth(Par, x) == (depth(Par, y) + 1);\r
 305  }\r
 306 \r
 307 // NumChildren(x): number of children of node x. Constant time with the data structure\r
 308 // of Sadakane.\r
 309 int XMLTree::NumChildren(treeNode x) \r
 310  {\r
 311     if (!finished) {\r
 312        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 313        exit(1);\r
 314     }\r
 315 \r
 316     return degree(Par, x);\r
 317  }\r
 318 \r
 319 // ChildNumber(x): returns i if node x is the i-th children of its parent.\r
 320 int XMLTree::ChildNumber(treeNode x) \r
 321  {\r
 322     if (!finished) {\r
 323        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 324        exit(1);\r
 325     }\r
 326 \r
 327     return child_rank(Par, x);\r
 328  }\r
 329 \r
 330 // Depth(x): depth of node x, a simple binary rank on the parentheses sequence.\r
 331 int XMLTree::Depth(treeNode x) \r
 332  {\r
 333     if (!finished) {\r
 334        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 335        exit(1);\r
 336     }\r
 337 \r
 338     return depth(Par, x);\r
 339  }\r
 340 \r
 341 // Preorder(x): returns the preorder number of node x, just counting the tree\r
 342 // nodes (i.e., tags, it disregards the texts in the tree).\r
 343 int XMLTree::Preorder(treeNode x) \r
 344  {\r
 345     if (!finished) {\r
 346        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 347        exit(1);\r
 348     }\r
 349 \r
 350     return preorder_rank(Par, x);\r
 351  }\r
 352 \r
 353 // Postorder(x): returns the postorder number of node x, just counting the tree\r
 354 // nodes (i.e., tags, it disregards the texts in the tree).\r
 355 int XMLTree::Postorder(treeNode x) \r
 356  {\r
 357     if (!finished) {\r
 358        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 359        exit(1);\r
 360     }\r
 361     return postorder_rank(Par, x);\r
 362  }\r
 363 \r
 364 // Tag(x): returns the tag identifier of node x.\r
 365 TagType XMLTree::Tag(treeNode x) \r
 366  {\r
 367     if (!finished) {\r
 368        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 369        exit(1);\r
 370     }\r
 371 \r
 372     return Tags->access(node2tagpos(x));\r
 373  }\r
 374 \r
 375 // DocIds(x): returns the range of text identifiers that descend from node x.\r
 376 // returns {NULLT, NULLT} when there are no texts descending from x.\r
 377 range XMLTree::DocIds(treeNode x) \r
 378  {\r
 379     if (!finished) {\r
 380        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 381        exit(1);\r
 382     }\r
 383 \r
 384     range r;\r
 385     if (indexing_empty_texts) { // faster, no rank needed\r
 386        r.min = x;\r
 387        r.max = x+2*subtree_size(Par, x)-2;\r
 388     }\r
 389     else { // we are not indexing empty texts, we need rank\r
 390        int min = EBVector->rank1(x-1);                          \r
 391        int max = EBVector->rank1(x+2*subtree_size(Par, x)-2); \r
 392        if (min==max) { // range is empty, no texts within the subtree of x\r
 393           r.min = NULLT;\r
 394           r.max = NULLT;\r
 395        }\r
 396        else { // the range is non-empty, there are texts within the subtree of x\r
 397           r.min = min+1;\r
 398           r.max = max;\r
 399        }\r
 400     }\r
 401     return r;\r
 402  }\r
 403 \r
 404 // Parent(x): returns the parent node of node x.\r
 405 treeNode XMLTree::Parent(treeNode x) \r
 406  {\r
 407     if (!finished) {\r
 408        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 409        exit(1);\r
 410     }\r
 411     if (x == Root())\r
 412       return NULLT;\r
 413     else\r
 414       return parent(Par, x);\r
 415  }\r
 416 \r
 417 // Child(x,i): returns the i-th child of node x, assuming it exists.\r
 418 treeNode XMLTree::Child(treeNode x, int i) \r
 419 {\r
 420     if (!finished) {\r
 421        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 422        exit(1);\r
 423     }\r
 424 \r
 425     if (i <= OPTD) return naive_child(Par, x, i);\r
 426     else return child(Par, x, i);\r
 427  }\r
 428 \r
 429 // FirstChild(x): returns the first child of node x, assuming it exists. Very fast in BP.\r
 430 treeNode XMLTree::FirstChild(treeNode x) \r
 431  {\r
 432     if (!finished) {\r
 433        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 434        exit(1);\r
 435     }\r
 436 \r
 437     return first_child(Par, x);\r
 438  }\r
 439 \r
 440 // NextSibling(x): returns the next sibling of node x, assuming it exists.\r
 441 treeNode XMLTree::NextSibling(treeNode x) \r
 442  {\r
 443     if (!finished) {\r
 444        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 445        exit(1);\r
 446     }\r
 447     if (x == Root())\r
 448       return NULLT;\r
 449  \r
 450     return next_sibling(Par, x);\r
 451  }\r
 452 \r
 453 // PrevSibling(x): returns the previous sibling of node x, assuming it exists.\r
 454 treeNode XMLTree::PrevSibling(treeNode x) \r
 455  {\r
 456     if (!finished) {\r
 457        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 458        exit(1);\r
 459     }\r
 460 \r
 461     return prev_sibling(Par, x);\r
 462  }\r
 463 \r
 464 // TaggedChild(x,i,tag): returns the i-th child of node x tagged tag, or NULLT if there is none.\r
 465 // Because of the balanced-parentheses representation of the tree, this operation is not supported\r
 466 // efficiently, just iterating among the children of node x until finding the desired child.\r
 467 treeNode XMLTree::TaggedChild(treeNode x, int i, TagType tag) \r
 468  {\r
 469     if (!finished) {\r
 470        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 471        exit(1);\r
 472     }\r
 473 \r
 474     treeNode child;\r
 475    \r
 476     child = first_child(Par, x); // starts at first child of node x\r
 477     if (child==(treeNode)-1) return NULLT; // node x is a leaf, there is no such child\r
 478     while (child!=(treeNode)-1) {\r
 479        if (Tags->access(node2tagpos(child)) == tag) { // current child is labeled with tag of interest\r
 480           i--;\r
 481           if (i==0) return child; // we have seen i children of x tagged tag, this is the one we are looking for\r
 482        }\r
 483        child = next_sibling(Par, x); // OK, let's try with the next child\r
 484     }\r
 485     return NULLT; // no such child was found  \r
 486  }\r
 487 \r
 488 // TaggedDesc(x,tag): returns the first node tagged tag with larger preorder than x and within\r
 489 // the subtree of x. Returns NULLT if there is none.\r
 490 treeNode XMLTree::TaggedDesc(treeNode x, TagType tag) \r
 491  {\r
 492     if (!finished) {\r
 493        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 494        exit(1);\r
 495     }\r
 496 \r
 497     int r, s;\r
 498     treeNode y;\r
 499     r = (int) Tags->rank(tag, node2tagpos(x));\r
 500     s = (int) Tags->select(tag, r+1);\r
 501     if (s == -1) return NULLT; // there is no such node\r
 502     y = tagpos2node(s); // transforms the tag position into a node position\r
 503     if (!is_ancestor(Par, x, y)) return NULLT; // the next node tagged tag (in preorder) is not within the subtree of x.\r
 504     else return y;\r
 505  }\r
 506 \r
 507 // TaggedPrec(x,tag): returns the first node tagged tag with smaller preorder than x and not an\r
 508 // ancestor of x. Returns NULLT if there is none.\r
 509 treeNode XMLTree::TaggedPrec(treeNode x, TagType tag) \r
 510  {\r
 511     if (!finished) {\r
 512        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 513        exit(1);\r
 514     }\r
 515     \r
 516     int r, s;\r
 517     treeNode node_s, root;\r
 518     r = (int)Tags->rank(tag, node2tagpos(x)-1);\r
 519     if (r==0) return NULLT; // there is no such node.\r
 520     s = (int)Tags->select(tag, r);\r
 521     root = root_node(Par);\r
 522     node_s = tagpos2node(s);\r
 523     while (is_ancestor(Par, node_s, x) && (node_s!=root)) { // the one that we found is an ancestor of x\r
 524        r--;\r
 525        if (r==0) return NULLT; // there is no such node\r
 526        s = (int)Tags->select(tag, r);  // we should use select_prev instead when provided\r
 527        node_s = tagpos2node(s);\r
 528     }\r
 529     return NULLT; // there is no such node \r
 530  }\r
 531 \r
 532 // TaggedFoll(x,tag): returns the first node tagged tag with larger preorder than x and not in\r
 533 // the subtree of x. Returns NULLT if there is none.\r
 534 treeNode XMLTree::TaggedFoll(treeNode x, TagType tag) \r
 535  {\r
 536     if (!finished) {\r
 537        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 538        exit(1);\r
 539     }\r
 540 \r
 541     int r, s;\r
 542     if (x == Root() || (next_sibling(Par,x) == -1 ))\r
 543       return NULLT;\r
 544     \r
 545     r = (int) Tags->rank(tag, node2tagpos(next_sibling(Par, x))-1);\r
 546     s = (int) Tags->select(tag, r+1);  // select returns -1 in case that there is no r+1-th tag.\r
 547     if (s==-1) return NULLT;\r
 548     else return tagpos2node(s);\r
 549  }\r
 550 \r
 551 // PrevText(x): returns the document identifier of the text to the left \r
 552 // of node x, or NULLT if x is the root node or the text is empty.\r
 553 // Assumes Doc ids start from 0.\r
 554 DocID XMLTree::PrevText(treeNode x) \r
 555  {\r
 556     if (!finished) {\r
 557        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 558        exit(1);\r
 559     }\r
 560 \r
 561     if (x == Root()) return NULLT;\r
 562     if (indexing_empty_texts)  // faster, no rank needed\r
 563        return (DocID)x-1;\r
 564     else { // we are not indexing empty texts, rank is needed\r
 565        if (EBVector->access(x-1) == 0) \r
 566           return (DocID)NULLT;  // there is no text to the left of node (text is empty)\r
 567        else\r
 568           return (DocID)EBVector->rank1(x-1)-1;  //-1 because document ids start from 0\r
 569     }\r
 570  }\r
 571 \r
 572 // NextText(x): returns the document identifier of the text to the right\r
 573 // of node x, or NULLT if x is the root node. Assumes Doc ids start from 0.\r
 574 DocID XMLTree::NextText(treeNode x) \r
 575  {\r
 576     if (!finished) {\r
 577        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 578        exit(1);\r
 579     }\r
 580 \r
 581     if (x == Root()) return NULLT;\r
 582     if (indexing_empty_texts)  // faster, no rank needed\r
 583        return (DocID)x+2*subtree_size(Par, x)-1;\r
 584     else { // we are not indexing empty texts, rank is needed\r
 585        int p = x+2*subtree_size(Par, x)-1;\r
 586        if (EBVector->access(p) == 0) // there is no text to the right of node\r
 587           return (DocID)NULLT;\r
 588        else\r
 589           return (DocID)EBVector->rank1(p)-1; //-1 because document ids start from 0\r
 590     }\r
 591  }\r
 592 \r
 593 // MyText(x): returns the document identifier of the text below node x, \r
 594 // or NULLT if x is not a leaf node or the text is empty. Assumes Doc \r
 595 // ids start from 0.\r
 596 DocID XMLTree::MyText(treeNode x) \r
 597  {\r
 598     if (!finished) {\r
 599        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 600        exit(1);\r
 601     }\r
 602 \r
 603     if (!IsLeaf(x)) return NULLT;\r
 604     if (indexing_empty_texts) // faster, no rank needed\r
 605        return (DocID)x;\r
 606     else { // we are not indexing empty texts, rank is needed\r
 607        if (EBVector->access(x) == 0)  // there is no text below node x\r
 608           return (DocID)NULLT;\r
 609        else\r
 610           return (DocID)EBVector->rank1(x)-1; //-1 because document ids start from 0\r
 611     } \r
 612  }\r
 613 \r
 614 // TextXMLId(d): returns the preorder of document with identifier d in the tree consisting of\r
 615 // all tree nodes and all text nodes. Assumes that the tree root has preorder 1.\r
 616 int XMLTree::TextXMLId(DocID d) \r
 617  {\r
 618     if (!finished) {\r
 619        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 620        exit(1);\r
 621     }\r
 622 \r
 623     if (indexing_empty_texts) \r
 624        return d + rank_open(Par, d)+1; // +1 because root has preorder 1\r
 625     else { // slower, needs rank and select\r
 626        int s = EBVector->select1(d+1);\r
 627        return rank_open(Par, s) + d + 1; // +1 because root has preorder 1\r
 628     }\r
 629  }\r
 630 \r
 631 // NodeXMLId(x): returns the preorder of node x in the tree consisting \r
 632 // of all tree nodes and all text nodes. Assumes that the tree root has\r
 633 // preorder 0;\r
 634 int XMLTree::NodeXMLId(treeNode x) \r
 635  {\r
 636     if (!finished) {\r
 637        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 638        exit(1);\r
 639     }\r
 640 \r
 641     if (indexing_empty_texts)\r
 642        return x - 1 + rank_open(Par, x);\r
 643     else {\r
 644        if (x == Root()) return 1; // root node has preorder 1\r
 645        else\r
 646           return rank_open(Par, x) + EBVector->rank1(x-1);\r
 647     }\r
 648  }\r
 649 \r
 650 // ParentNode(d): returns the parent node of document identifier d.\r
 651 treeNode XMLTree::ParentNode(DocID d) \r
 652  {\r
 653     if (!finished) {\r
 654        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
 655        exit(1);\r
 656     }\r
 657     \r
 658     if (d == NULLT)\r
 659       return NULLT;\r
 660     \r
 661     int s;\r
 662     // OJO : Kim : I added the d+1. before that, else branch was \r
 663     // EBVector->select1(d)\r
 664     // and gave wrong results (I'm really poking a bear with a stick here).\r
 665     if (indexing_empty_texts) s = d;\r
 666     else s = EBVector->select1(d+1);\r
 667     \r
 668     if (inspect(Par,s) == CP) // is a closing parenthesis\r
 669        return parent(Par, find_open(Par, s));\r
 670     else // is an opening parenthesis\r
 671        return (treeNode)s;\r
 672      \r
 673  }\r
 674 \r
 675 \r
 676 // OpenDocument(empty_texts): it starts the construction of the data structure for\r
 677 // the XML document. Parameter empty_texts indicates whether we index empty texts\r
 678 // in document or not. Returns a non-zero value upon success, NULLT in case of error.\r
 679 int XMLTree::OpenDocument(bool empty_texts, int sample_rate_text,bool dtc)\r
 680  {\r
 681     initialized = true;\r
 682     finished = false;\r
 683     found_attributes = false;\r
 684     npar = 0;\r
 685     parArraySize = 1;\r
 686     ntagnames = 2;    \r
 687     disable_tc = dtc;\r
 688     \r
 689     indexing_empty_texts = empty_texts;\r
 690     \r
 691     par_aux = (pb *)umalloc(sizeof(pb)*parArraySize);\r
 692     \r
 693     tags_aux = (TagType *) umalloc(sizeof(TagType));\r
 694     \r
 695     TagName = (unsigned char **) umalloc(2*sizeof(unsigned char*));\r
 696 \r
 697     TagName[0] = (unsigned char *) umalloc(4*sizeof(unsigned char));\r
 698 \r
 699     strcpy((char *) TagName[0], "<@>");\r
 700 \r
 701     TagName[1] = (unsigned char *) umalloc(4*sizeof(unsigned char));\r
 702 \r
 703     strcpy((char *) TagName[1], "<$>");\r
 704 \r
 705 \r
 706     if (!indexing_empty_texts) \r
 707       empty_texts_aux = (unsigned int *)umalloc(sizeof(unsigned int));\r
 708        \r
 709     \r
 710     \r
 711     Text = TextCollection::InitTextCollection((unsigned)sample_rate_text);\r
 712     \r
 713     return 1;  // indicates success in the initialization of the data structure\r
 714  }\r
 715 \r
 716 // CloseDocument(): it finishes the construction of the data structure for the XML\r
 717 // document. Tree and tags are represented in the final form, dynamic data \r
 718 // structures are made static, and the flag "finished" is set to true. After that, \r
 719 // the data structure can be queried.\r
 720 int XMLTree::CloseDocument()\r
 721  {\r
 722     if (!initialized) {  // data structure has not been initialized properly\r
 723        fprintf(stderr, "Error: data structure has not been initialized properly (by calling method OpenDocument)\n");\r
 724        return NULLT;\r
 725     }\r
 726     \r
 727     // closing parenthesis for the tree root\r
 728     par_aux = (pb *)urealloc(par_aux, sizeof(pb)*(1+npar/(8*sizeof(pb))));\r
 729     \r
 730     // creates the data structure for the tree topology\r
 731     Par = (bp *)umalloc(sizeof(bp));\r
 732     bp_construct(Par, npar, par_aux, OPT_DEGREE|0);    \r
 733     // creates structure for tags\r
 734     static_bitsequence_builder * bmb = new static_bitsequence_builder_brw32(20);\r
 735     static_permutation_builder * pmb = new static_permutation_builder_mrrr(PERM_SAMPLE, bmb);\r
 736     static_sequence_builder * ssb = new static_sequence_builder_gmr_chunk(bmb, pmb);\r
 737 \r
 738 \r
 739     // If we found an attribute then "<@>" is present in the tree\r
 740     // if we didn't then it is not. "<$>" is never present in the tree\r
 741     int ntagsize = found_attributes ? 2*ntagnames-1 : 2*ntagnames - 2;\r
 742 \r
 743     Tags = new static_sequence_gmr((uint *) tags_aux, (uint) npar-1,ntagsize, bmb, ssb);\r
 744     \r
 745     delete bmb;\r
 746     delete pmb;\r
 747     delete ssb;\r
 748     // makes the text collection static\r
 749     if (!disable_tc)\r
 750       Text->MakeStatic();\r
 751     \r
 752     // creates the data structure marking the non-empty texts (just in the case it is necessary)\r
 753     if (!indexing_empty_texts)  {\r
 754        EBVector = new static_bitsequence_rrr02((uint *)empty_texts_aux,(ulong)npar,(uint)32);\r
 755        free (empty_texts_aux);\r
 756        empty_texts_aux = NULL;\r
 757     }\r
 758    \r
 759     // OJO was leaked before, found by valgrind\r
 760     free(tags_aux);\r
 761 \r
 762     tags_aux = NULL;\r
 763 \r
 764     finished = true;\r
 765 \r
 766     return 1; // indicates success in the inicialization\r
 767  }\r
 768 \r
 769 \r
 770 // NewOpenTag(tagname): indicates the event of finding a new opening tag in the document.\r
 771 // Tag name is given. Returns a non-zero value upon success, and returns NULLT\r
 772 // in case of failing when trying to insert the new tag.\r
 773 int XMLTree::NewOpenTag(unsigned char *tagname)\r
 774  {\r
 775     int i;\r
 776 \r
 777     if (!initialized) {  // data structure has not been initialized properly\r
 778        fprintf(stderr, "Error: you cannot insert a new opening tag without first calling method OpenDocument first\n");\r
 779        return NULLT;\r
 780     }\r
 781     \r
 782     // inserts a new opening parentheses in the bit sequence\r
 783     if (sizeof(pb)*8*parArraySize == npar) { // no space left for the new parenthesis\r
 784        par_aux = (pb *)urealloc(par_aux, sizeof(pb)*2*parArraySize);\r
 785        parArraySize *= 2;\r
 786     }\r
 787     \r
 788     setbit(par_aux,npar,OP);  // marks a new opening parenthesis\r
 789 \r
 790     // transforms the tagname into a tag identifier. If the tag is new, we insert\r
 791     // it in the table.\r
 792     for (i=0; i<ntagnames; i++)\r
 793       if (strcmp((const char *)tagname,(const char *)TagName[i])==0) break;\r
 794  \r
 795 \r
 796     // NewOpenTag("<@>") was called\r
 797     if (i==0) \r
 798       found_attributes=true;\r
 799 \r
 800     if (i==ntagnames) { // the tag is a new one, then we insert it\r
 801        TagName = (unsigned char **)urealloc(TagName, sizeof(char *)*(ntagnames+1));\r
 802        \r
 803        if (!TagName) {\r
 804           fprintf(stderr, "Error: not enough memory\n");\r
 805           return NULLT;\r
 806        }\r
 807        \r
 808        ntagnames++;\r
 809        TagName[i] = (unsigned char *)umalloc(sizeof(unsigned char)*(strlen((const char *)tagname)+1));\r
 810        strcpy((char *)TagName[i], (const char *)tagname);\r
 811     } \r
 812     tags_aux = (TagType *) urealloc(tags_aux, sizeof(TagType)*(npar + 1));\r
 813 \r
 814     tags_aux[npar] = i; // inserts the new tag id within the preorder sequence of tags\r
 815     \r
 816     npar++;\r
 817 \r
 818     return 1;\r
 819     \r
 820  }\r
 821 \r
 822 \r
 823 // NewClosingTag(tagname): indicates the event of finding a new closing tag in the document.\r
 824 // Tag name is given. Returns a non-zero value upon success, and returns NULLT\r
 825 // in case of failing when trying to insert the new tag.\r
 826 int XMLTree::NewClosingTag(unsigned char *tagname)\r
 827  {\r
 828     int i;\r
 829 \r
 830     if (!initialized) {  // data structure has not been initialized properly\r
 831        fprintf(stderr, "Error: you cannot insert a new closing tag without first calling method OpenDocument first\n");\r
 832        return NULLT;\r
 833     }\r
 834     \r
 835     // inserts a new closing parentheses in the bit sequence\r
 836     if (sizeof(pb)*8*parArraySize == npar) { // no space left for the new parenthesis\r
 837        par_aux = (pb *)urealloc(par_aux, sizeof(pb)*2*parArraySize);\r
 838        parArraySize *= 2;\r
 839     }\r
 840     \r
 841     setbit(par_aux,npar,CP);  // marks a new closing opening parenthesis\r
 842 \r
 843     // transforms the tagname into a tag identifier. If the tag is new, we insert\r
 844     // it in the table.\r
 845     for (i=0; i<ntagnames; i++)\r
 846        if (strcmp((const char *)tagname,(const char *)TagName[i])==0) break;\r
 847  \r
 848     if (i==ntagnames) { // the tag is a new one, then we insert it\r
 849        TagName = (unsigned char **)urealloc(TagName, sizeof(char *)*(ntagnames+1));\r
 850        \r
 851        \r
 852        ntagnames++;\r
 853        TagName[i] = (unsigned char *)umalloc(sizeof(char)*(strlen((const char *)tagname)+2));\r
 854        TagName[i][0] = '/';\r
 855        strcpy((char *)&(TagName[i][1]), (const char *)tagname);\r
 856     } \r
 857 \r
 858     tags_aux = (TagType *)urealloc(tags_aux, sizeof(TagType)*(npar + 1));\r
 859 \r
 860     tags_aux[npar] = i; // inserts the new tag id within the preorder sequence of tags\r
 861     \r
 862     npar++;\r
 863 \r
 864     return 1; // success\r
 865     \r
 866  }\r
 867 \r
 868 \r
 869 // NewText(s): indicates the event of finding a new (non-empty) text s in the document.\r
 870 // The new text is inserted within the text collection. Returns a non-zero value upon\r
 871 // success, NULLT in case of error.\r
 872 int XMLTree::NewText(unsigned char *s)\r
 873  {\r
 874     if (!initialized) {  // data structure has not been initialized properly\r
 875        fprintf(stderr, "Error: you cannot insert a new text without first calling method OpenDocument first\n");\r
 876        return NULLT;\r
 877     }\r
 878 \r
 879     if (disable_tc) {\r
 880       XMLTree::NewEmptyText();\r
 881       return 1;\r
 882     };\r
 883 \r
 884     if (!indexing_empty_texts) {\r
 885        empty_texts_aux = (unsigned int *)urealloc(empty_texts_aux, sizeof(pb)*(1+(npar-1)/(8*sizeof(pb))));\r
 886               bitset(empty_texts_aux, npar-1);  // marks the non-empty text with a 1 in the bit vector\r
 887     }\r
 888     \r
 889     Text->InsertText(s);\r
 890     \r
 891     return 1; // success\r
 892  }\r
 893 \r
 894 // NewEmptyText(): indicates the event of finding a new empty text in the document.\r
 895 // In case of indexing empty and non-empty texts, we insert the empty texts into the\r
 896 // text collection. In case of indexing only non-empty texts, it just indicates an\r
 897 // empty text in the bit vector of empty texts. Returns a non-zero value upon\r
 898 // success, NULLT in case of error.\r
 899 int XMLTree::NewEmptyText() \r
 900  {\r
 901     unsigned char c = 0;\r
 902     if (!initialized) {  // data structure has not been initialized properly\r
 903        fprintf(stderr, "Error: you cannot insert a new empty text without first calling method OpenDocument first\n");\r
 904        return NULLT;\r
 905     }\r
 906 \r
 907     if (!indexing_empty_texts) {\r
 908        empty_texts_aux = (unsigned int *)urealloc(empty_texts_aux, sizeof(pb)*(1+(npar-1)/(8*sizeof(pb))));\r
 909        \r
 910        bitclean(empty_texts_aux, npar-1);  // marks the empty text with a 0 in the bit vector\r
 911     }\r
 912     else Text->InsertText(&c); // we insert the empty text just in case we index all the texts\r
 913     \r
 914     return 1; // success    \r
 915  }\r
 916 \r
 917 \r
 918 // GetTagId: returns the tag identifier corresponding to a given tag name.\r
 919 // Returns NULLT in case that the tag name does not exists.\r
 920 TagType XMLTree::GetTagId(unsigned char *tagname)\r
 921  {\r
 922     int i;\r
 923     // this should be changed for more efficient processing\r
 924     for (i=0; i<ntagnames; i++)\r
 925        if (strcmp((const char *)tagname,(const char *)TagName[i])==0) break; \r
 926     if (i==ntagnames) return (TagType)NULLT; // tagname does not exists in the table\r
 927     else return i;\r
 928  }\r
 929 \r
 930 \r
 931 // GetTagName(tagid): returns the tag name of a given tag identifier.\r
 932 // Returns NULL in case that the tag identifier is not valid.\r
 933 unsigned char *XMLTree::GetTagName(TagType tagid)\r
 934  {\r
 935     unsigned char *s;\r
 936 \r
 937     if (tagid >= ntagnames) return NULL; // invalid tag identifier\r
 938     s = (unsigned char *)umalloc((strlen((const char *)TagName[tagid])+1)*sizeof(unsigned char));\r
 939     strcpy((char *)s, (const char *)TagName[tagid]);\r
 940     return s;\r
 941  }\r
 942 \r
 943 \r
 944 //KIM : OJO need the two following methods\r
 945 \r
 946 const unsigned char *XMLTree::GetTagNameByRef(TagType tagid)\r
 947  {\r
 948     if (tagid >= ntagnames) return NULL; // invalid tag identifier\r
 949     return ((const unsigned char*)  TagName[tagid]);\r
 950  }\r
 951 \r
 952 \r
 953 \r
 954 TagType XMLTree::RegisterTag(unsigned char *tagname)\r
 955 {\r
 956   if (!finished)\r
 957     return NULLT;\r
 958   \r
 959   TagType id = XMLTree::GetTagId(tagname);\r
 960   if (id == NULLT){\r
 961     id = ntagnames;\r
 962     ntagnames = ntagnames + 1;    \r
 963     TagName = (unsigned char **) urealloc(TagName,ntagnames*(sizeof(unsigned char*)));\r
 964     TagName[id] = (unsigned char *) umalloc(sizeof(unsigned char)*strlen( (const char*) tagname)+1);\r
 965     strcpy((char*)TagName[id], (const char *)tagname);  \r
 966   };\r
 967 \r
 968   return id;\r
 969 }\r