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