X-Git-Url: http://git.nguyen.vg/gitweb/?a=blobdiff_plain;f=XMLTree.h;h=7c08fcc78ec39faa4f09396260a81f9c67320c21;hb=a0808cd570d8645798ae80287d2b4845ceea36a2;hp=759aff83251fe7b820c22bbb6fe836a8d8891a39;hpb=2220c6ca1fb8ebefd48d6f5d9a6be3afc7325da5;p=SXSI%2FXMLTree.git

diff --git a/XMLTree.h b/XMLTree.h
index 759aff8..7c08fcc 100644
--- a/XMLTree.h
+++ b/XMLTree.h
@@ -26,6 +26,7 @@
 #include <stdlib.h>
 #include <cstring>
 
+//KIM : OJO
 //clash between TextCollection/Tools.h and libcds/includes/basics.h
 #undef W
 #undef WW
@@ -61,6 +62,13 @@ typedef struct {
 } range;
 
 
+//KIM : OJO
+// I know this class implements the working draft that we have but the logics seem flawed here...
+// We should have two classes. One XMLTreeBuilder and one XMLTree.
+// XMLTreeBuilder would have OpenDocument, NewOpenTag,... and CloseDocument would return an XMLTree
+// XMLTree would have only an initialized structure. If find it really ugly to check (!finished) or (!initialized)
+// in every function (FirstChild....).
+
 class XMLTree {
    /** Balanced parentheses representation of the tree */
    bp *Par;
@@ -96,7 +104,17 @@ class XMLTree {
    int parArraySize;
    int ntagnames;
    unsigned int *empty_texts_aux;
+
+   // KIM : OJO
+   // I added those two. The TagName array should always contains two special tags
+   // <@> for attributes and <$> for PCDATA.
+   // <$> can never be in a document (since we handle the text differently)
+   // but <@> can be returned by the parser. This boolean is needed for the construction
+   // of the Tag bitmap to know if <@> must be taken into account or not
    bool found_attributes;
+
+   // KIM : OJO
+   // Allows to disable the TextCollection for benchmarkin purposes
    bool disable_tc;
    
 public:
@@ -226,6 +244,7 @@ public:
     * (i.e. everything is considered an empty text *)
     * Returns a non-zero value upon success, NULLT in case of 
     * error. */
+
    int OpenDocument(bool empty_texts, int sample_rate_text, bool dtc);
 
    /** CloseDocument(): finishes the construction of the data structure for 
@@ -265,6 +284,19 @@ public:
    unsigned char *GetTagName(TagType tagid);
 
 
+   // OJO
+   /** GetTagName(tagid): returns the tag name of a given tag identifier.     
+    *  The result is just a reference and should not be freed by the caller.
+    */
+   const unsigned char *GetTagNameByRef(TagType tagid);
+
+   //OJO
+   /** RegisterTag adds a new tag to the tag collection this is needed
+    * if the query contains a tag which is not in the document, we need
+    * to give this new tag a fresh id and store it somewhere. A logical
+    * choice is here.
+    * We might want to use a hashtable instead of an array though.
+    */
    TagType RegisterTag(unsigned char *tagname);
 
    bool EmptyText(DocID i) {