XMLTree.cpp

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