Add debugging option to make
[SXSI/XMLTree.git] / XMLTreeBuilder.h
index c7a9036..8ac4eba 100644 (file)
@@ -17,7 +17,7 @@
  *   along with this program; if not, write to the                            *\r
  *   Free Software Foundation, Inc.,                                          *\r
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.                *\r
- ******************************************************************************/ \r
+ ******************************************************************************/\r
 \r
 #ifndef XMLTREEBUILDER_H_\r
 #define XMLTREEBUILDER_H_\r
@@ -43,22 +43,22 @@ using SXSI::TextCollectionBuilder;
 \r
 \r
 class XMLTreeBuilder {\r
-  \r
+\r
    /** Array containing the balanced parentheses sequence */\r
    pb *par_aux;\r
    int parArraySize;\r
    int npar;\r
 \r
-   /** Mapping from tag identifer to tag name */  \r
+   /** Mapping from tag identifer to tag name */\r
    std::vector<std::string> *TagName;\r
    TagIdMap * tIdMap;\r
    /** Array containing the sequence of tags */\r
    TagType *tags_aux;\r
-   \r
+\r
    /** The texts in the XML document */\r
    TextCollectionBuilder *TextBuilder;\r
    TextCollection *Text;\r
-   \r
+\r
    /** The texts in the XML document (cached for faster display) */\r
 \r
    std::vector<std::string> *CachedText;\r
@@ -73,37 +73,37 @@ public:
    XMLTreeBuilder() {;};\r
 \r
    ~XMLTreeBuilder();\r
-   \r
+\r
    /** OpenDocument(sample_rate_text,dtc): initilizes the construction\r
-    * of the data structure for the XML document.  Parameter \r
+    * of the data structure for the XML document.  Parameter\r
     * sample_rate_text indicates the sampling rate for the text searching data\r
-    * structures (small values get faster searching but a bigger space \r
+    * structures (small values get faster searching but a bigger space\r
     * requirement). dtc disable the use of the TextCollection\r
     * (i.e. everything is considered an empty text *)\r
-    * Returns a non-zero value upon success, NULLT in case of \r
+    * Returns a non-zero value upon success, NULLT in case of\r
     * error. */\r
    int OpenDocument(bool empty_texts, int sample_rate_text, bool dtc,\r
                    TextCollectionBuilder::index_type_t index_type);\r
 \r
-   /** CloseDocument(): finishes the construction of the data structure for \r
-    * the XML document. Tree and tags are represented in the final form, \r
+   /** CloseDocument(): finishes the construction of the data structure for\r
+    * the XML document. Tree and tags are represented in the final form,\r
     * dynamic data structures are made static, returning the resulting\r
     * XMLTree. After that, the XMLTree data structure can be queried. */\r
    XMLTree *CloseDocument();\r
 \r
-   /** NewOpenTag(tagname): indicates the event of finding a new opening tag \r
-    * in the document. Tag name is given. Returns a non-zero value upon \r
+   /** NewOpenTag(tagname): indicates the event of finding a new opening tag\r
+    * in the document. Tag name is given. Returns a non-zero value upon\r
     * success, and returns NULLT in case of error. */\r
    int NewOpenTag(std::string tagname);\r
-   \r
+\r
    /** NewClosingTag(tagname): indicates the event of finding a new closing tag\r
-    *  in the document. Tag name is given. Returns a non-zero value upon \r
+    *  in the document. Tag name is given. Returns a non-zero value upon\r
     *  success, and returns NULLT in case of error. */\r
    int NewClosingTag(std::string tagname);\r
\r
-   /** NewText(s): indicates the event of finding a new text s in \r
-    * the document. The new text is inserted within the text collection. \r
-    * Returns a non-zero value upon success, NULLT in case of error. \r
+\r
+   /** NewText(s): indicates the event of finding a new text s in\r
+    * the document. The new text is inserted within the text collection.\r
+    * Returns a non-zero value upon success, NULLT in case of error.\r
     * If the string is empty, which is legal in attributes, then\r
     * the string the sequence '\0x01\0x00' is inserted in the TextCollection\r
     * It is ok to do so since a non printable character cannot occur in an XML document\r