1 files changed, 451 insertions, 0 deletions
diff --git a/writerfilter/inc/doctok/WW8Document.hxx b/writerfilter/inc/doctok/WW8Document.hxx
new file mode 100644
index 000000000000..eb3196e66e0b
--- /dev/null
+++ b/writerfilter/inc/doctok/WW8Document.hxx
@@ -0,0 +1,451 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: WW8Document.hxx,v $
+ * $Revision: 1.8 $
+ *
+ * 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_WW8_DOCUMENT_HXX
+#define INCLUDED_WW8_DOCUMENT_HXX
+
+#include <boost/shared_ptr.hpp>
+#include <sal/types.h>
+#include <com/sun/star/uno/Reference.hxx>
+#include <resourcemodel/SubSequence.hxx>
+#include <com/sun/star/io/XInputStream.hpp>
+#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEX_HPP_
+#include <com/sun/star/uno/XComponentContext.hpp>
+#endif
+
+#ifndef INCLUDED_WW8_RESOURCE_MODEL_HXX
+#include <resourcemodel/WW8ResourceModel.hxx>
+#endif
+#include <resourcemodel/OutputWithDepth.hxx>
+
+#include <WriterFilterDllApi.hxx>
+
+namespace writerfilter {
+namespace doctok {
+
+using namespace ::com::sun::star;
+
+/**
+   A stream containing a WW8 document.
+
+   The content of the stream is a sequence of unsigned bytes. The
+   stream consists of substreams that are identified by string
+   identifiers.
+*/
+class WRITERFILTER_DLLPUBLIC WW8Stream
+{
+public:
+    /**
+       Pointer to a WW8Stream.
+    */
+    typedef boost::shared_ptr<WW8Stream> Pointer_t;
+
+    /**
+       Type for the content of the stream
+     */
+    typedef SubSequence<sal_uInt8> Sequence;
+
+    virtual ~WW8Stream();
+
+    /**
+       Returns pointer to a substream.
+
+       @param rSid     identifier of substream to return
+
+       @return    the substream
+     */
+    virtual Pointer_t getSubStream(const ::rtl::OUString & rSid) = 0;
+
+    /**
+       Return a continious part of the stream.
+
+       @param nOffset     offset in the stream where the part starts
+       @param nCount      length of the part (number of bytes)
+
+       @return    sequence of unsigned bytes
+     */
+    virtual Sequence get(sal_uInt32 nOffset, sal_uInt32 nCount)
+        const = 0;
+
+    // Returns the names of substreams contained in the stream
+    virtual string getSubStreamNames() const = 0;
+
+    virtual uno::Sequence<rtl::OUString> getSubStreamUNames() const = 0;
+
+    /**
+       Dumps content of stream to output.
+
+       @param o     the target output
+    */
+    virtual void dump(OutputWithDepth<string> & o) const = 0;
+
+    //virtual bool put(sal_uInt32 nOffset, const Sequence & rSeq) = 0;
+};
+
+/**
+   A property.
+
+*/
+class WRITERFILTER_DLLPUBLIC WW8Property
+{
+public:
+    /**
+       Ponter to a property.
+    */
+    typedef boost::shared_ptr<WW8Property> Pointer_t;
+
+    virtual ~WW8Property();
+
+    virtual sal_uInt32 getId() const = 0;
+    virtual sal_uInt32 getParam() const = 0;
+    virtual WW8Stream::Sequence getParams() const = 0;
+
+    virtual string toString() const = 0;
+
+    /**
+       Dumps this object to an output.
+
+    */
+    virtual void dump(OutputWithDepth<string> & o) const = 0;
+};
+
+/**
+   An iterator for traversal of a set of properties.
+
+   Sample code for use of iterator:
+
+   \code
+   Return_t function(WW8PropertySet::tPointer pSet)
+   {
+       do_something;
+
+       WW8PropertySetIterator::tPointer pIt = pSet->begin();
+       WW8PropertySetIterator::tPointer pItEnd = pSet->end();
+
+       while ((*pIt) != (*pItEnd))
+       {
+           do_something();
+
+           ++(*pIt);
+       }
+
+       do_something;
+   }
+   \endcode
+*/
+class WRITERFILTER_DLLPUBLIC WW8PropertySetIterator
+{
+public:
+    typedef boost::shared_ptr<WW8PropertySetIterator> Pointer_t;
+
+    virtual ~WW8PropertySetIterator();
+
+    /**
+       Advance iterator to the next property.
+    */
+    virtual WW8PropertySetIterator & operator++() = 0;
+
+    /**
+       Returns a pointer to the property the iterator references.
+    */
+    virtual WW8Property::Pointer_t get() const = 0;
+
+    /**
+       Checks if the iterator is equal to another one.
+    */
+    virtual bool equal(const WW8PropertySetIterator & rIt) const = 0;
+
+    /**
+       Returns string representation of iterator.
+     */
+    virtual string toString() const = 0;
+};
+
+/**
+   Checks if two property set iterators are not equal.
+*/
+bool operator != (const WW8PropertySetIterator & rA,
+                  const WW8PropertySetIterator & rB);
+
+/**
+   A set of properties.
+*/
+class WRITERFILTER_DLLPUBLIC WW8PropertySet
+{
+public:
+    typedef boost::shared_ptr<WW8PropertySet> Pointer_t;
+
+    virtual ~WW8PropertySet();
+
+    /**
+       Returns iterator to the start of the set.
+     */
+    virtual WW8PropertySetIterator::Pointer_t begin() = 0;
+
+    /**
+       Returns iterator to the end of the set.
+    */
+    virtual WW8PropertySetIterator::Pointer_t end() = 0;
+
+    /**
+       Dumps property set to output stream.
+
+       @param o    output stream to dump property set to
+    */
+    virtual void dump(OutputWithDepth<string> & o) const = 0;
+
+    /**
+       Iterate through property set and for each element dump a dot
+       output stream.
+
+       @param o      output stream to dump dots to
+     */
+    virtual void dots(ostream & o) = 0;
+
+    virtual bool isPap() const = 0;
+    virtual sal_uInt32 get_istd() const = 0;
+
+    /**
+       Insert another property set into this property set.
+
+       @param pSet   the set to insert
+     */
+    virtual void insert(const WW8PropertySet::Pointer_t pSet) = 0;
+};
+
+enum PropertyType {
+    /** Auxiliary type for character positions defined in piece table */
+    PROP_DOC,
+
+    /** properties are section properies */
+    PROP_SEC,
+
+    /** properties are paragraph properties */
+    PROP_PAP,
+
+    /** properties are character properties */
+    PROP_CHP,
+
+    /** a footnote reference */
+    PROP_FOOTNOTE,
+
+    /** an endnote reference */
+    PROP_ENDNOTE,
+
+    /** an annotaion reference */
+    PROP_ANNOTATION,
+
+    /** the start of a bookmark */
+    PROP_BOOKMARKSTART,
+
+    /** the end of a bookmark */
+    PROP_BOOKMARKEND,
+
+    /** a field character (start, separator or end) */
+    PROP_FLD,
+
+    /** a shape character */
+    PROP_SHP,
+
+    /** a break character */
+    PROP_BRK
+};
+
+/**
+   An iterator for traversal of the character positions of a Word
+   document.
+
+   The use of the iterator is analogous to WW8PropertySetIterator.
+*/
+class WRITERFILTER_DLLPUBLIC WW8DocumentIterator
+{
+public:
+    typedef boost::shared_ptr<WW8DocumentIterator> Pointer_t;
+
+    virtual ~WW8DocumentIterator();
+
+    /**
+       Advance iterator to next character position of the document.
+    */
+    virtual WW8DocumentIterator & operator++() = 0;
+
+    /**
+       Recedes iterator to previous character postion of the document.
+     */
+    virtual WW8DocumentIterator & operator--() = 0;
+
+    /**
+       Returns properties set at the character position the iterator
+       points to.
+
+       @return pointer to set of properties
+     */
+    virtual writerfilter::Reference<Properties>::Pointer_t getProperties()
+        const = 0;
+
+    virtual writerfilter::Reference<Stream>::Pointer_t getSubDocument()
+        const = 0;
+
+    /**
+       Returns text run at the character position the iterator points
+       to.
+     */
+    virtual WW8Stream::Sequence getText() = 0;
+
+    /**
+       Return pointer to the shape at character position the iterator
+       is pointing to.
+     */
+    virtual writerfilter::Reference<Properties>::Pointer_t getShape() const = 0;
+
+    /**
+       Checks if the characters of the entity the iterator points to
+       are complex.
+
+       Complex characters in a Word document are byte size
+       characters. Non-complex characters are word size characters.
+
+       @retval true      The characters are complex.
+       @retval false     The characters are non-complex.
+     */
+    virtual bool isComplex() const = 0;
+
+    /**
+       Returns the property type of the entity the iterator points to.
+     */
+    virtual PropertyType getPropertyType() const = 0;
+
+    /**
+       Checks is the iterator is equal to another one.
+
+       @param rIt    iterator to check against
+
+       @retval true    the iterators are equal
+       @retval false   else
+    */
+    virtual bool equal(const WW8DocumentIterator & rIt) const = 0;
+
+    /**
+       Returns string representation of the iterator.
+    */
+    virtual string toString() const = 0;
+
+    /**
+       Dumps the iterator to an output stream.
+
+       @param o    the output stream to dump the iterator to
+     */
+    virtual void dump(ostream & o) const = 0;
+};
+
+/**
+   Checks if two document iterators are equal.
+
+   @param rA     first iterator
+   @param rB     second iterator
+
+   @retval true    the document iterators are equal
+   @retval false   else
+ */
+bool operator == (const WW8DocumentIterator & rA,
+                  const WW8DocumentIterator & rB);
+
+class WRITERFILTER_DLLPUBLIC SubDocumentId
+{
+public:
+    enum eType { FOOTNOTES, HEADERS, FOOTERS };
+
+private:
+    eType mnType;
+    sal_uInt8 mnIndex;
+
+public:
+    SubDocumentId(eType nType, sal_uInt8 nIndex)
+    : mnType(nType), mnIndex(nIndex)
+    {
+    }
+
+    eType getType() const { return mnType; }
+    sal_uInt8 getIndex() const { return mnIndex; }
+};
+
+/**
+   A Word 8 document.
+*/
+class WRITERFILTER_DLLPUBLIC WW8Document :
+    public writerfilter::Reference<Stream>
+{
+public:
+    typedef boost::shared_ptr<WW8Document> Pointer_t;
+
+    virtual ~WW8Document();
+
+    /**
+       Get a subdocument.
+
+       A subdocument can be
+
+       - a header
+       - a footer
+       - a footnode
+
+       @param nId identifier of the subdocumen
+    */
+    virtual Pointer_t getSubDocument(SubDocumentId nId) = 0;
+
+    /**
+       Returns iterator to beginning of document.
+     */
+    virtual WW8DocumentIterator::Pointer_t begin() = 0;
+
+    /**
+       Returns iterator to end of document.
+     */
+    virtual WW8DocumentIterator::Pointer_t end() = 0;
+};
+
+class WRITERFILTER_DLLPUBLIC WW8DocumentFactory
+{
+public:
+    static WW8Stream::Pointer_t
+    createStream(uno::Reference<uno::XComponentContext> rContext,
+                 uno::Reference<io::XInputStream> rStream);
+
+    static WW8Document *
+    createDocument(WW8Stream::Pointer_t rpStream);
+};
+
+void sprmidsToXML(::std::iostream & out);
+
+void doctokidsToXML(::std::iostream & out);
+
+}}
+
+#endif // INCLUDED_WW8_DOCUMENT_HXX