Added TaggedFollBelow
[SXSI/XMLTree.git] / 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 (x == NULLT)\r
431       {\r
432         r.min = NULLT;\r
433         r.max = NULLT;\r
434         return r;\r
435       };\r
436         \r
437       \r
438     if (indexing_empty_texts) { // faster, no rank needed\r
439        r.min = x;\r
440        r.max = x+2*subtree_size(Par, x)-2;\r
441     }\r
442     else { // we are not indexing empty texts, we need rank\r
443        int min = EBVector->rank1(x-1);                          \r
444        int max = EBVector->rank1(x+2*subtree_size(Par, x)-2); \r
445        if (min==max) { // range is empty, no texts within the subtree of x\r
446           r.min = NULLT;\r
447           r.max = NULLT;\r
448        }\r
449        else { // the range is non-empty, there are texts within the subtree of x\r
450           r.min = min+1;\r
451           r.max = max;\r
452        }\r
453     }\r
454     return r;\r
455  }\r
456 \r
457 // Parent(x): returns the parent node of node x.\r
458 treeNode XMLTree::Parent(treeNode x) \r
459  {\r
460     if (!finished) {\r
461        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
462        exit(1);\r
463     }\r
464     if (x == Root())\r
465       return NULLT;\r
466     else\r
467       return parent(Par, x);\r
468  }\r
469 \r
470 // Child(x,i): returns the i-th child of node x, assuming it exists.\r
471 treeNode XMLTree::Child(treeNode x, int i) \r
472 {\r
473     if (!finished) {\r
474        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
475        exit(1);\r
476     }\r
477 \r
478     if (i <= OPTD) return naive_child(Par, x, i);\r
479     else return child(Par, x, i);\r
480  }\r
481 \r
482 // FirstChild(x): returns the first child of node x, assuming it exists. Very fast in BP.\r
483 treeNode XMLTree::FirstChild(treeNode x) \r
484  {\r
485     if (!finished) {\r
486        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
487        exit(1);\r
488     }\r
489 \r
490     return first_child(Par, x);\r
491  }\r
492 \r
493 // NextSibling(x): returns the next sibling of node x, assuming it exists.\r
494 treeNode XMLTree::NextSibling(treeNode x) \r
495  {\r
496     if (!finished) {\r
497        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
498        exit(1);\r
499     }\r
500     if (x == Root() || x==NULLT)\r
501       return NULLT;\r
502     \r
503     return next_sibling(Par, x);\r
504  }\r
505 \r
506 // PrevSibling(x): returns the previous sibling of node x, assuming it exists.\r
507 treeNode XMLTree::PrevSibling(treeNode x) \r
508  {\r
509     if (!finished) {\r
510        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
511        exit(1);\r
512     }\r
513 \r
514     return prev_sibling(Par, x);\r
515  }\r
516 \r
517 // TaggedChild(x,i,tag): returns the i-th child of node x tagged tag, or NULLT if there is none.\r
518 // Because of the balanced-parentheses representation of the tree, this operation is not supported\r
519 // efficiently, just iterating among the children of node x until finding the desired child.\r
520 treeNode XMLTree::TaggedChild(treeNode x, int i, TagType tag) \r
521  {\r
522     if (!finished) {\r
523        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
524        exit(1);\r
525     }\r
526 \r
527     treeNode child;\r
528    \r
529     child = first_child(Par, x); // starts at first child of node x\r
530     if (child==(treeNode)-1) return NULLT; // node x is a leaf, there is no such child\r
531     while (child!=(treeNode)-1) {\r
532        if (get_field(tags_fix,tags_blen,node2tagpos(child)) /*Tags->access(node2tagpos(child))*/ == tag) { // current child is labeled with tag of interest\r
533           i--;\r
534           if (i==0) return child; // we have seen i children of x tagged tag, this is the one we are looking for\r
535        }\r
536        child = next_sibling(Par, x); // OK, let's try with the next child\r
537     }\r
538     return NULLT; // no such child was found  \r
539  }\r
540 \r
541 // TaggedDesc(x,tag): returns the first node tagged tag with larger preorder than x and within\r
542 // the subtree of x. Returns NULLT if there is none.\r
543 treeNode XMLTree::TaggedDesc(treeNode x, TagType tag) \r
544  {\r
545     if (!finished) {\r
546        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
547        exit(1);\r
548     }\r
549 \r
550     int r, s;\r
551     treeNode y;\r
552     if (isleaf(Par,x))\r
553       return NULLT;\r
554 \r
555     r = (int) Tags->rank(tag, node2tagpos(x));\r
556     s = (int) Tags->select(tag, r+1);\r
557     if (s == -1) return NULLT; // there is no such node\r
558     y = tagpos2node(s); // transforms the tag position into a node position\r
559     if (!is_ancestor(Par, x, y)) return NULLT; // the next node tagged tag (in preorder) is not within the subtree of x.\r
560     else return y;\r
561  }\r
562 \r
563 treeNode XMLTree::TaggedDescOnly(treeNode x,TagType *desctags, unsigned int dtlen)\r
564 {\r
565 \r
566   treeNode res,y;\r
567   if (isleaf(Par,x))\r
568     return NULLT;\r
569   \r
570   res=NULLT;\r
571   for (unsigned int i = 0; i < dtlen; i ++ )\r
572     {\r
573       y = TaggedDesc(x,desctags[i]);\r
574       res = (res == NULLT) || (( res != NULLT) && (y =! NULLT) && y < res) ? y : res;\r
575       \r
576     };\r
577   \r
578   return res;\r
579   \r
580 }\r
581 \r
582 \r
583 treeNode XMLTree::TaggedBelow(treeNode x, TagType *childtags, unsigned int ctlen,\r
584                               TagType *desctags, unsigned int dtlen)\r
585 {\r
586   treeNode fs,y,res;\r
587   TagType tag;\r
588 \r
589   if (isleaf(Par,x))\r
590     return NULLT;\r
591   \r
592   res = NULLT;\r
593   fs = first_child(Par,x);\r
594   while (fs != NULLT) {\r
595     tag = get_field(tags_fix,tags_blen,node2tagpos(fs));\r
596         \r
597     /* Check for first_child */\r
598     for (unsigned int i = 0; i < ctlen; i++) {\r
599       if (childtags[i] == tag)\r
600         return fs;\r
601     };\r
602     \r
603     for (unsigned int i = 0; i < dtlen; i++)\r
604       if (desctags[i] == tag)\r
605         return fs;  \r
606     \r
607     /* check in the descendants */\r
608     res = NULLT;\r
609     for (unsigned int i = 0; i < dtlen; i ++ ){\r
610       /* maybe inline by hand */\r
611       y = TaggedDesc(fs,desctags[i]);\r
612       res = (res==NULLT || (y != NULLT) &&(y < res)) ? y : res;   \r
613     };\r
614     if (res != NULLT)\r
615       return res;\r
616     \r
617     fs = next_sibling(Par,fs);\r
618   };\r
619   return res;\r
620     \r
621 }\r
622 treeNode XMLTree::TaggedFollOnly(treeNode x,TagType *folltags, unsigned int ftlen,treeNode root)\r
623 {\r
624 \r
625   treeNode res,y,lim;\r
626   lim = find_close(Par,root);   \r
627   res=NULLT;\r
628   for (unsigned int i = 0; i < ftlen; i ++ )\r
629     {\r
630       y = TaggedFoll(x,folltags[i]);\r
631       res = (res == NULLT) || (( res != NULLT) && (y =! NULLT) && y < res) ? y : res;\r
632       \r
633     };\r
634   \r
635   return res < lim ? res : NULLT;\r
636   \r
637 }\r
638 \r
639 treeNode XMLTree::TaggedDescOrFollOnly(treeNode x,TagType *folltags, unsigned int ftlen,treeNode root)\r
640 {\r
641 \r
642   treeNode res,y,lim;\r
643   int r,s;\r
644   lim = find_close(Par,root);   \r
645   res=NULLT;\r
646   for (unsigned int i = 0; i < ftlen; i ++ )\r
647     {\r
648 \r
649       r = (int) Tags->rank(folltags[i], node2tagpos(x));\r
650       s = (int) Tags->select(folltags[i], r+1);\r
651       if (s == -1) \r
652         y = NULLT; // there is no such node\r
653       else {\r
654         y = tagpos2node(s); \r
655         if (y >= lim)\r
656           y = NULLT;\r
657       };\r
658       res = (res == NULLT) || (( res != NULLT) && (y =! NULLT) && y < res) ? y : res;\r
659       \r
660     };\r
661   \r
662   return res < lim ? res : NULLT;\r
663   \r
664 }\r
665 \r
666 \r
667 // TaggedNext(x,tag): returns the first node tagged tag with larger preorder than x \r
668 // Returns NULLT if there is none.\r
669 treeNode XMLTree::TaggedNext(treeNode x, TagType *childtags, unsigned int ctlen,\r
670                              TagType *folltags, unsigned int flen,treeNode root)\r
671  {\r
672    treeNode y,old_y,lim,res;\r
673    TagType tag;\r
674    if (x == NULLT || x == Root())\r
675      return NULLT;\r
676 \r
677 \r
678    lim = find_close(Par,root);   \r
679 \r
680    res = NULLT;\r
681   \r
682    y = next_sibling(Par,x);\r
683    while (y != NULLT) {\r
684      tag = get_field(tags_fix,tags_blen,node2tagpos(y));\r
685      for(unsigned int i = 0; i < ctlen;i++)\r
686        if (childtags[i] == tag)\r
687          return y;\r
688      \r
689      for(unsigned int i = 0; i < flen;i++)\r
690        if (folltags[i] == tag)\r
691          return y;\r
692 \r
693      res = TaggedBelow(y,NULL,0,folltags,flen);\r
694      if (res != NULLT)\r
695        return res;\r
696      \r
697      y = next_sibling(Par,y);\r
698    };\r
699    //Found nothing in the following sibling of x.\r
700    res = NULLT;\r
701    for(unsigned int i = 0; i < flen;i++){\r
702      y = TaggedFoll(x,folltags[i]);\r
703      res = (y!= x && (res == NULLT || (y != NULLT && y < res)))? y : res;\r
704    };\r
705   \r
706    return res < lim ? res : NULLT;\r
707    \r
708  }\r
709 \r
710 \r
711 // TaggedPrec(x,tag): returns the first node tagged tag with smaller preorder than x and not an\r
712 // ancestor of x. Returns NULLT if there is none.\r
713 treeNode XMLTree::TaggedPrec(treeNode x, TagType tag) \r
714  {\r
715     if (!finished) {\r
716        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
717        exit(1);\r
718     }\r
719     \r
720     int r, s;\r
721     treeNode node_s, root;\r
722     r = (int)Tags->rank(tag, node2tagpos(x)-1);\r
723     if (r==0) return NULLT; // there is no such node.\r
724     s = (int)Tags->select(tag, r);\r
725     root = root_node(Par);\r
726     node_s = tagpos2node(s);\r
727     while (is_ancestor(Par, node_s, x) && (node_s!=root)) { // the one that we found is an ancestor of x\r
728        r--;\r
729        if (r==0) return NULLT; // there is no such node\r
730        s = (int)Tags->select(tag, r);  // we should use select_prev instead when provided\r
731        node_s = tagpos2node(s);\r
732     }\r
733     return NULLT; // there is no such node \r
734  }\r
735 \r
736 \r
737 // TaggedFoll(x,tag): returns the first node tagged tag with larger preorder than x and not in\r
738 // the subtree of x. Returns NULLT if there is none.\r
739 treeNode XMLTree::TaggedFoll(treeNode x, TagType tag)\r
740  {\r
741     if (!finished) {\r
742        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
743        exit(1);\r
744     }\r
745 \r
746     int r, s;\r
747     if (x ==NULLT || x == Root())\r
748        return NULLT;\r
749                    \r
750     r = (int) Tags->rank(tag, find_close(Par, x));\r
751     s = (int) Tags->select(tag, r+1);  // select returns -1 in case that there is no r+1-th tag.\r
752     if (s==-1) return NULLT;\r
753     else return tagpos2node(s);\r
754  } \r
755 \r
756 // TaggedFoll(x,tag): returns the first node tagged tag with larger preorder than x and not in\r
757 // the subtree of x. Returns NULLT if there is none.\r
758 treeNode XMLTree::TaggedFollBelow(treeNode x, TagType tag, treeNode root)\r
759  {\r
760 \r
761     int r, s;\r
762     int lim = node2tagpos(find_close(Par,root));\r
763     if (x ==NULLT || x == Root())\r
764        return NULLT;\r
765                    \r
766     r = (int) Tags->rank(tag,find_close(Par,x));\r
767     s = (int) Tags->select(tag, r+1);  // select returns -1 in case that there is no r+1-th tag.\r
768     if (s==-1 || s >= lim) \r
769       return NULLT;\r
770     else \r
771       return tagpos2node(s);\r
772  } \r
773 \r
774 \r
775 // TaggedFollowingSibling(x,tag): returns the first node tagged tag with larger preorder than x and not in\r
776 // the subtree of x. Returns NULLT if there is none.\r
777 treeNode XMLTree::TaggedFollowingSibling(treeNode x, TagType tag) \r
778  {\r
779     if (!finished) {\r
780        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
781        exit(1);\r
782     }\r
783 \r
784     int r, s;\r
785     treeNode ns = next_sibling(Par,x);\r
786 \r
787     if (x == NULLT || x == Root() || ns == -1)\r
788       return NULLT;\r
789 \r
790     r = (int) Tags->rank(tag, node2tagpos(ns)-1);\r
791     s = (int) Tags->select(tag, r+1);  // select returns -1 in case that there is no r+1-th tag.\r
792     if (s==-1) return NULLT;\r
793     else return tagpos2node(s);\r
794  }\r
795 \r
796 \r
797 // TaggedAncestor(x, tag): returns the closest ancestor of x tagged tag. Return\r
798 // NULLT is there is none.\r
799 treeNode XMLTree::TaggedAncestor(treeNode x, TagType tag)\r
800  {\r
801     if (!finished) {\r
802        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
803        exit(1);\r
804     }\r
805     \r
806     if (x == NULLT || x == Root())\r
807        return NULLT;\r
808     \r
809     treeNode s = parent(Par, x), r = Root();\r
810     while (s != r) {\r
811        if (get_field(tags_fix,tags_blen,node2tagpos(s)) /*Tags->access(node2tagpos(s))*/ == tag) return s;\r
812        s = parent(Par, s);\r
813     }\r
814     return NULLT;\r
815  }\r
816 \r
817 \r
818 // PrevText(x): returns the document identifier of the text to the left \r
819 // of node x, or NULLT if x is the root node or the text is empty.\r
820 // Assumes Doc ids start from 0.\r
821 DocID XMLTree::PrevText(treeNode x) \r
822  {\r
823     if (!finished) {\r
824        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
825        exit(1);\r
826     }\r
827 \r
828     if (x == Root()) return NULLT;\r
829     if (indexing_empty_texts)  // faster, no rank needed\r
830        return (DocID)x-1;\r
831     else { // we are not indexing empty texts, rank is needed\r
832        if (EBVector->access(x-1) == 0) \r
833           return (DocID)NULLT;  // there is no text to the left of node (text is empty)\r
834        else\r
835           return (DocID)EBVector->rank1(x-1)-1;  //-1 because document ids start from 0\r
836     }\r
837  }\r
838 \r
839 // NextText(x): returns the document identifier of the text to the right\r
840 // of node x, or NULLT if x is the root node. Assumes Doc ids start from 0.\r
841 DocID XMLTree::NextText(treeNode x) \r
842  {\r
843     if (!finished) {\r
844        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
845        exit(1);\r
846     }\r
847 \r
848     if (x == Root()) return NULLT;\r
849     if (indexing_empty_texts)  // faster, no rank needed\r
850        return (DocID)x+2*subtree_size(Par, x)-1;\r
851     else { // we are not indexing empty texts, rank is needed\r
852        int p = x+2*subtree_size(Par, x)-1;\r
853        if (EBVector->access(p) == 0) // there is no text to the right of node\r
854           return (DocID)NULLT;\r
855        else\r
856           return (DocID)EBVector->rank1(p)-1; //-1 because document ids start from 0\r
857     }\r
858  }\r
859 \r
860 // MyText(x): returns the document identifier of the text below node x, \r
861 // or NULLT if x is not a leaf node or the text is empty. Assumes Doc \r
862 // ids start from 0.\r
863 DocID XMLTree::MyText(treeNode x) \r
864  {\r
865     if (!finished) {\r
866        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
867        exit(1);\r
868     }\r
869 \r
870     if (!IsLeaf(x)) return NULLT;\r
871     if (indexing_empty_texts) // faster, no rank needed\r
872        return (DocID)x;\r
873     else { // we are not indexing empty texts, rank is needed\r
874        if (EBVector->access(x) == 0)  // there is no text below node x\r
875           return (DocID)NULLT;\r
876        else\r
877           return (DocID)EBVector->rank1(x)-1; //-1 because document ids start from 0\r
878     } \r
879  }\r
880 \r
881 // TextXMLId(d): returns the preorder of document with identifier d in the tree consisting of\r
882 // all tree nodes and all text nodes. Assumes that the tree root has preorder 1.\r
883 int XMLTree::TextXMLId(DocID d) \r
884  {\r
885     if (!finished) {\r
886        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
887        exit(1);\r
888     }\r
889 \r
890     if (indexing_empty_texts) \r
891        return d + rank_open(Par, d)+1; // +1 because root has preorder 1\r
892     else { // slower, needs rank and select\r
893        int s = EBVector->select1(d+1);\r
894        return rank_open(Par, s) + d + 1; // +1 because root has preorder 1\r
895     }\r
896  }\r
897 \r
898 // NodeXMLId(x): returns the preorder of node x in the tree consisting \r
899 // of all tree nodes and all text nodes. Assumes that the tree root has\r
900 // preorder 0;\r
901 int XMLTree::NodeXMLId(treeNode x) \r
902  {\r
903     if (!finished) {\r
904        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
905        exit(1);\r
906     }\r
907 \r
908     if (indexing_empty_texts)\r
909        return x - 1 + rank_open(Par, x);\r
910     else {\r
911        if (x == Root()) return 1; // root node has preorder 1\r
912        else\r
913           return rank_open(Par, x) + EBVector->rank1(x-1);\r
914     }\r
915  }\r
916 \r
917 // ParentNode(d): returns the parent node of document identifier d.\r
918 treeNode XMLTree::ParentNode(DocID d) \r
919  {\r
920     if (!finished) {\r
921        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
922        exit(1);\r
923     }\r
924     \r
925     if (d == NULLT)\r
926       return NULLT;\r
927     \r
928     int s;\r
929     // OJO : Kim : I added the d+1. before that, else branch was \r
930     // EBVector->select1(d)\r
931     // and gave wrong results (I'm really poking a bear with a stick here).\r
932     if (indexing_empty_texts) s = d;\r
933     else s = EBVector->select1(d+1);\r
934     \r
935     if (inspect(Par,s) == CP) // is a closing parenthesis\r
936        return parent(Par, find_open(Par, s));\r
937     else // is an opening parenthesis\r
938        return (treeNode)s;\r
939      \r
940  }\r
941 treeNode XMLTree::PrevNode(DocID d) \r
942  {\r
943     if (!finished) {\r
944        fprintf(stderr, "Error: data structure has not been constructed properly\n");\r
945        exit(1);\r
946     }\r
947     \r
948     if (d == NULLT)\r
949       return NULLT;\r
950     \r
951     int s;\r
952     \r
953     if (indexing_empty_texts) s = d;\r
954     else s = EBVector->select1(d+1);\r
955     if (s == -1)\r
956       return NULLT;\r
957     \r
958     if (inspect(Par,s) == CP) // is a closing parenthesis\r
959       return find_open(Par, s);\r
960     else // is an opening parenthesis\r
961       return NULLT;\r
962     \r
963  }\r
964 \r
965 \r
966 // OpenDocument(empty_texts): it starts the construction of the data structure for\r
967 // the XML document. Parameter empty_texts indicates whether we index empty texts\r
968 // in document or not. Returns a non-zero value upon success, NULLT in case of error.\r
969 int XMLTree::OpenDocument(bool empty_texts, int sample_rate_text,bool dtc)\r
970  {\r
971     initialized = true;\r
972     finished = false;\r
973     found_attributes = false;\r
974     npar = 0;\r
975     parArraySize = 1;\r
976     ntagnames = 4;    \r
977     disable_tc = dtc;\r
978     \r
979     indexing_empty_texts = empty_texts;\r
980     \r
981     par_aux = (pb *)umalloc(sizeof(pb)*parArraySize);\r
982     \r
983     tags_aux = (TagType *) umalloc(sizeof(TagType));\r
984     \r
985     TagName = (unsigned char **) umalloc(4*sizeof(unsigned char*));\r
986 \r
987     TagName[0] = (unsigned char *) umalloc(4*sizeof(unsigned char));\r
988 \r
989     strcpy((char *) TagName[0], "<@>");\r
990 \r
991     TagName[1] = (unsigned char *) umalloc(4*sizeof(unsigned char));\r
992 \r
993     strcpy((char *) TagName[1], "<$>");\r
994     \r
995     //OJO need to put these in the table too.\r
996     TagName[2] = (unsigned char *) umalloc(5*sizeof(unsigned char));\r
997 \r
998     strcpy((char *) TagName[2], "/<@>");\r
999 \r
1000     TagName[3] = (unsigned char *) umalloc(5*sizeof(unsigned char));\r
1001 \r
1002     strcpy((char *) TagName[3], "/<$>");\r
1003 \r
1004 \r
1005     if (!indexing_empty_texts) \r
1006       empty_texts_aux = (unsigned int *)umalloc(sizeof(unsigned int));\r
1007        \r
1008     \r
1009     \r
1010     Text = TextCollection::InitTextCollection((unsigned)sample_rate_text);\r
1011     \r
1012     return 1;  // indicates success in the initialization of the data structure\r
1013  }\r
1014 \r
1015 // CloseDocument(): it finishes the construction of the data structure for the XML\r
1016 // document. Tree and tags are represented in the final form, dynamic data \r
1017 // structures are made static, and the flag "finished" is set to true. After that, \r
1018 // the data structure can be queried.\r
1019 int XMLTree::CloseDocument()\r
1020  {\r
1021     if (!initialized) {  // data structure has not been initialized properly\r
1022        fprintf(stderr, "Error: data structure has not been initialized properly (by calling method OpenDocument)\n");\r
1023        return NULLT;\r
1024     }\r
1025     \r
1026     // closing parenthesis for the tree root\r
1027     par_aux = (pb *)urealloc(par_aux, sizeof(pb)*(1+npar/(8*sizeof(pb))));\r
1028     \r
1029     // creates the data structure for the tree topology\r
1030     Par = (bp *)umalloc(sizeof(bp));\r
1031     bp_construct(Par, npar, par_aux, OPT_DEGREE|0);    \r
1032     // creates structure for tags\r
1033     //static_bitsequence_builder * bmb = new static_bitsequence_builder_brw32(20);\r
1034     //static_permutation_builder * pmb = new static_permutation_builder_mrrr(PERM_SAMPLE, bmb);\r
1035     //static_sequence_builder * ssb = new static_sequence_builder_gmr_chunk(bmb, pmb);\r
1036 \r
1037 \r
1038     // If we found an attribute then "<@>" is present in the tree\r
1039     // if we didn't then it is not. "<$>" is never present in the tree\r
1040                 uint max_tag = 0;\r
1041                 for(uint i=0;i<(uint)npar-1;i++)\r
1042                         max_tag = max(max_tag,tags_aux[i]);\r
1043                 max_tag++;\r
1044     int ntagsize = found_attributes ? 2*ntagnames-1 : 2*ntagnames - 2;\r
1045                 tags_aux = (TagType *) urealloc(tags_aux, sizeof(TagType)*(npar + 1));\r
1046                 tags_aux[npar++] = max_tag;\r
1047 \r
1048                 static_bitsequence_builder * bmb = new static_bitsequence_builder_brw32(20);\r
1049                 alphabet_mapper *am = new alphabet_mapper_none();\r
1050                 wt_coder * wc = new wt_coder_huff((uint*)tags_aux,npar,am);\r
1051                 Tags = new static_sequence_wvtree((uint*)tags_aux,npar,wc ,bmb, am);\r
1052     //Tags = new static_sequence_gmr((uint *) tags_aux, (uint) npar-1,ntagsize, bmb, ssb);\r
1053                 tags_blen = bits(max_tag);\r
1054                 tags_len = (uint)npar;\r
1055                 tags_fix = new uint[uint_len(tags_blen,tags_len)];\r
1056                 for(uint i=0;i<(uint)npar-1;i++)\r
1057                         set_field(tags_fix,tags_blen,i,tags_aux[i]);\r
1058     \r
1059     delete bmb;\r
1060     //delete pmb;\r
1061     //delete ssb;\r
1062     // makes the text collection static\r
1063     if (!disable_tc)\r
1064       Text->MakeStatic();\r
1065     \r
1066     // creates the data structure marking the non-empty texts (just in the case it is necessary)\r
1067     if (!indexing_empty_texts)  {\r
1068        EBVector = new static_bitsequence_rrr02((uint *)empty_texts_aux,(ulong)npar,(uint)32);\r
1069        free (empty_texts_aux);\r
1070        empty_texts_aux = NULL;\r
1071     }\r
1072    \r
1073     // OJO was leaked before, found by valgrind\r
1074     free(tags_aux);\r
1075 \r
1076     tags_aux = NULL;\r
1077 \r
1078     finished = true;\r
1079                 print_stats();\r
1080 \r
1081     return 1; // indicates success in the inicialization\r
1082  }\r
1083 \r
1084 \r
1085 // NewOpenTag(tagname): indicates the event of finding a new opening tag in the document.\r
1086 // Tag name is given. Returns a non-zero value upon success, and returns NULLT\r
1087 // in case of failing when trying to insert the new tag.\r
1088 int XMLTree::NewOpenTag(unsigned char *tagname)\r
1089  {\r
1090     int i;\r
1091 \r
1092     if (!initialized) {  // data structure has not been initialized properly\r
1093        fprintf(stderr, "Error: you cannot insert a new opening tag without first calling method OpenDocument first\n");\r
1094        return NULLT;\r
1095     }\r
1096     \r
1097     // inserts a new opening parentheses in the bit sequence\r
1098     if (sizeof(pb)*8*parArraySize == npar) { // no space left for the new parenthesis\r
1099        par_aux = (pb *)urealloc(par_aux, sizeof(pb)*2*parArraySize);\r
1100        parArraySize *= 2;\r
1101     }\r
1102     \r
1103     setbit(par_aux,npar,OP);  // marks a new opening parenthesis\r
1104 \r
1105     // transforms the tagname into a tag identifier. If the tag is new, we insert\r
1106     // it in the table.\r
1107     for (i=0; i<ntagnames; i++)\r
1108       if (strcmp((const char *)tagname,(const char *)TagName[i])==0) break;\r
1109  \r
1110 \r
1111     // NewOpenTag("<@>") was called\r
1112     if (i==0) \r
1113       found_attributes=true;\r
1114 \r
1115     if (i==ntagnames) { // the tag is a new one, then we insert it\r
1116        TagName = (unsigned char **)urealloc(TagName, sizeof(char *)*(ntagnames+1));\r
1117        \r
1118        if (!TagName) {\r
1119           fprintf(stderr, "Error: not enough memory\n");\r
1120           return NULLT;\r
1121        }\r
1122        \r
1123        ntagnames++;\r
1124        TagName[i] = (unsigned char *)umalloc(sizeof(unsigned char)*(strlen((const char *)tagname)+1));\r
1125        strcpy((char *)TagName[i], (const char *)tagname);\r
1126     } \r
1127     tags_aux = (TagType *) urealloc(tags_aux, sizeof(TagType)*(npar + 1));\r
1128 \r
1129     tags_aux[npar] = i; // inserts the new tag id within the preorder sequence of tags\r
1130     \r
1131     npar++;\r
1132     \r
1133     return 1;\r
1134     \r
1135  }\r
1136 \r
1137 \r
1138 // NewClosingTag(tagname): indicates the event of finding a new closing tag in the document.\r
1139 // Tag name is given. Returns a non-zero value upon success, and returns NULLT\r
1140 // in case of failing when trying to insert the new tag.\r
1141 int XMLTree::NewClosingTag(unsigned char *tagname)\r
1142  {\r
1143     int i;\r
1144 \r
1145     if (!initialized) {  // data structure has not been initialized properly\r
1146        fprintf(stderr, "Error: you cannot insert a new closing tag without first calling method OpenDocument first\n");\r
1147        return NULLT;\r
1148     }\r
1149     \r
1150     // inserts a new closing parentheses in the bit sequence\r
1151     if (sizeof(pb)*8*parArraySize == npar) { // no space left for the new parenthesis\r
1152        par_aux = (pb *)urealloc(par_aux, sizeof(pb)*2*parArraySize);\r
1153        parArraySize *= 2;\r
1154     }\r
1155     \r
1156     setbit(par_aux,npar,CP);  // marks a new closing parenthesis\r
1157 \r
1158     // transforms the tagname into a tag identifier. If the tag is new, we insert\r
1159     // it in the table.\r
1160     for (i=0; i<ntagnames; i++)\r
1161        if ((strcmp((const char *)tagname,(const char *)(TagName[i]+1))==0) && (TagName[i][0]=='/')) break;\r
1162  \r
1163     if (i==ntagnames) { // the tag is a new one, then we insert it\r
1164        TagName = (unsigned char **)urealloc(TagName, sizeof(char *)*(ntagnames+1));\r
1165        \r
1166        ntagnames++;\r
1167        TagName[i] = (unsigned char *)umalloc(sizeof(char)*(strlen((const char *)tagname)+2));\r
1168        TagName[i][0] = '/';\r
1169        strcpy((char *)&(TagName[i][1]), (const char *)tagname);\r
1170     } \r
1171 \r
1172     tags_aux = (TagType *)urealloc(tags_aux, sizeof(TagType)*(npar + 1));\r
1173 \r
1174     tags_aux[npar] = i; // inserts the new tag id within the preorder sequence of tags\r
1175     \r
1176     npar++;\r
1177 \r
1178     return 1; // success\r
1179     \r
1180  }\r
1181 \r
1182 \r
1183 // NewText(s): indicates the event of finding a new (non-empty) text s in the document.\r
1184 // The new text is inserted within the text collection. Returns a non-zero value upon\r
1185 // success, NULLT in case of error.\r
1186 int XMLTree::NewText(unsigned char *s)\r
1187  {\r
1188     if (!initialized) {  // data structure has not been initialized properly\r
1189        fprintf(stderr, "Error: you cannot insert a new text without first calling method OpenDocument first\n");\r
1190        return NULLT;\r
1191     }\r
1192 \r
1193     if (disable_tc) {\r
1194       XMLTree::NewEmptyText();\r
1195       return 1;\r
1196     };\r
1197 \r
1198     if (!indexing_empty_texts) {\r
1199        empty_texts_aux = (unsigned int *)urealloc(empty_texts_aux, sizeof(pb)*(1+(npar-1)/(8*sizeof(pb))));\r
1200               bitset(empty_texts_aux, npar-1);  // marks the non-empty text with a 1 in the bit vector\r
1201     }\r
1202     \r
1203     Text->InsertText(s);\r
1204     string cpps = (char*) s;\r
1205     CachedText.push_back(cpps); \r
1206     \r
1207     return 1; // success\r
1208  }\r
1209 \r
1210 // NewEmptyText(): indicates the event of finding a new empty text in the document.\r
1211 // In case of indexing empty and non-empty texts, we insert the empty texts into the\r
1212 // text collection. In case of indexing only non-empty texts, it just indicates an\r
1213 // empty text in the bit vector of empty texts. Returns a non-zero value upon\r
1214 // success, NULLT in case of error.\r
1215 int XMLTree::NewEmptyText() \r
1216  {\r
1217     unsigned char c = 0;\r
1218     if (!initialized) {  // data structure has not been initialized properly\r
1219        fprintf(stderr, "Error: you cannot insert a new empty text without first calling method OpenDocument first\n");\r
1220        return NULLT;\r
1221     }\r
1222 \r
1223     if (!indexing_empty_texts) {\r
1224        empty_texts_aux = (unsigned int *)urealloc(empty_texts_aux, sizeof(pb)*(1+(npar-1)/(8*sizeof(pb))));\r
1225        \r
1226        bitclean(empty_texts_aux, npar-1);  // marks the empty text with a 0 in the bit vector\r
1227     }\r
1228     else Text->InsertText(&c); // we insert the empty text just in case we index all the texts\r
1229     \r
1230     return 1; // success    \r
1231  }\r
1232 \r
1233 \r
1234 // GetTagId: returns the tag identifier corresponding to a given tag name.\r
1235 // Returns NULLT in case that the tag name does not exists.\r
1236 TagType XMLTree::GetTagId(unsigned char *tagname)\r
1237  {\r
1238     int i;\r
1239     // this should be changed for more efficient processing\r
1240     for (i=0; i<ntagnames; i++)\r
1241        if (strcmp((const char *)tagname,(const char *)TagName[i])==0) break; \r
1242     if (i==ntagnames) return ntagnames; //(TagType)NULLT; // tagname does not exists in the table\r
1243     else return i;\r
1244  }\r
1245 \r
1246 \r
1247 // GetTagName(tagid): returns the tag name of a given tag identifier.\r
1248 // Returns NULL in case that the tag identifier is not valid.\r
1249 unsigned char *XMLTree::GetTagName(TagType tagid)\r
1250  {\r
1251     unsigned char *s;\r
1252 \r
1253     if (tagid >= ntagnames) return NULL; // invalid tag identifier\r
1254     s = (unsigned char *)umalloc((strlen((const char *)TagName[tagid])+1)*sizeof(unsigned char));\r
1255     strcpy((char *)s, (const char *)TagName[tagid]);\r
1256     return s;\r
1257  }\r
1258 \r
1259 \r
1260 //KIM : OJO need the two following methods\r
1261 \r
1262 const unsigned char *XMLTree::GetTagNameByRef(TagType tagid)\r
1263  {\r
1264     if (tagid >= ntagnames) return NULL; // invalid tag identifier\r
1265     return ((const unsigned char*)  TagName[tagid]);\r
1266  }\r
1267 \r
1268 \r
1269 \r
1270 TagType XMLTree::RegisterTag(unsigned char *tagname)\r
1271 {\r
1272   if (!finished)\r
1273     return NULLT;\r
1274   \r
1275   TagType id = XMLTree::GetTagId(tagname);\r
1276   if (id == NULLT){\r
1277     id = ntagnames;\r
1278     ntagnames = ntagnames + 1;    \r
1279     TagName = (unsigned char **) urealloc(TagName,ntagnames*(sizeof(unsigned char*)));\r
1280     TagName[id] = (unsigned char *) umalloc(sizeof(unsigned char)*strlen( (const char*) tagname)+1);\r
1281     strcpy((char*)TagName[id], (const char *)tagname);  \r
1282   };\r
1283 \r
1284   return id;\r
1285 }\r