1 files changed, 143 insertions, 0 deletions
diff --git a/writerfilter/source/doctok/XNoteHelper.hxx b/writerfilter/source/doctok/XNoteHelper.hxx
new file mode 100644
index 000000000000..faa7f3bb038d
--- /dev/null
+++ b/writerfilter/source/doctok/XNoteHelper.hxx
@@ -0,0 +1,143 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef INCLUDED_X_NOTE_HELPER_HXX
+#define INCLUDED_X_NOTE_HELPER_HXX
+
+#ifndef INLCUED_PLCF_HXX
+#include <PLCF.hxx>
+#endif
+#include <WW8DocumentImpl.hxx>
+
+namespace writerfilter {
+namespace doctok
+{
+/**
+   A helper class for footnotes and endnotes and annotations(aka X-notes).
+ */
+template <class T>
+class XNoteHelper
+{
+    /// Character positions of X-notes in footnote document
+    WW8StructBase::Pointer_t mpCps;
+
+    /// Character positions of references to X-notes
+    typename PLCF<T>::Pointer_t mpRefs;
+
+    /// piece table for CP to FC conversion
+    WW8PieceTable::Pointer_t mpPieceTable;
+
+    /// the document
+    WW8DocumentImpl * mpDocument;
+
+    /// type of X-notes handled by this helper (PROP_FOOTNOTE, PROP_ENDNOTE)
+    PropertyType meType;
+
+    /// offset in document where X-note subdocument starts
+    CpAndFc mCpAndFcOffset;
+
+    /**
+       Return CpAndFc in document for X-note.
+
+       @param nPos     index of X-note
+    */
+    CpAndFc getCpAndFc(sal_uInt32 nPos);
+
+    /**
+       Return CpAndFc in document for reference to a certain X-note.
+
+       @param nPos     index of the X-note
+     */
+    CpAndFc getRefCpAndFc(sal_uInt32 nPos);
+
+public:
+    typedef boost::shared_ptr<XNoteHelper> Pointer_t;
+
+    XNoteHelper(WW8StructBase::Pointer_t pCps,
+                typename PLCF<T>::Pointer_t pRefs,
+                WW8PieceTable::Pointer_t pPieceTable,
+                WW8DocumentImpl * pDocument,
+                PropertyType eType,
+                CpAndFc cpAndFcOffset)
+    : mpCps(pCps), mpRefs(pRefs), mpPieceTable(pPieceTable),
+      mpDocument(pDocument), meType(eType), mCpAndFcOffset(cpAndFcOffset)
+    {
+    }
+
+    /**
+       Initialize.
+
+       Generates CpAndFcs in document for X-notes.
+     */
+    void init();
+
+    /**
+       Return number of X-notes.
+     */
+    sal_uInt32 getCount() const;
+
+    /**
+       Return index of CpAndFc.
+
+       @param rCpAndFc    the CpAndFc to search
+
+       @return the index of the rCpAndFc found or getCount() otherwise
+     */
+    sal_uInt32 getIndexOfCpAndFc(const CpAndFc & rCpAndFc);
+
+    /**
+        Return subdocument containing X-note.
+
+        @param nIndex  index of X-note.
+    */
+    writerfilter::Reference<Stream>::Pointer_t get(sal_uInt32 nIndex);
+
+    /**
+       Return subdocument containing X-note.
+
+       @param rCpAndFc     CpAndFc of the X-note's reference
+    */
+    writerfilter::Reference<Stream>::Pointer_t get(const CpAndFc & rCpAndFc);
+
+    /**
+       Return reference data structure of X-note.
+
+       @param nIndex    index of X-note
+    */
+    T * getRef(sal_uInt32 nIndex);
+
+    /**
+       Return reference data structure of X-note.
+
+       @param rCpAndFc     CpAndFc for the X-note's reference
+    */
+    T * getRef(const CpAndFc & rCpAndFc);
+};
+
+}}
+
+#endif // INCLUDED_X_NOTE_HELPER_HXX