writerfilter/inc/doctok/WW8Document.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: WW8Document.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_WW8_DOCUMENT_HXX
  32 #define INCLUDED_WW8_DOCUMENT_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35 #include <sal/types.h>
  36 #include <com/sun/star/uno/Reference.hxx>
  37 #include <resourcemodel/SubSequence.hxx>
  38 #include <com/sun/star/io/XInputStream.hpp>
  39 #ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEX_HPP_
  40 #include <com/sun/star/uno/XComponentContext.hpp>
  41 #endif
  42
  43 #ifndef INCLUDED_WW8_RESOURCE_MODEL_HXX
  44 #include <resourcemodel/WW8ResourceModel.hxx>
  45 #endif
  46 #include <resourcemodel/OutputWithDepth.hxx>
  47
  48 #include <WriterFilterDllApi.hxx>
  49
  50 namespace writerfilter {
  51 namespace doctok {
  52
  53 using namespace ::com::sun::star;
  54
  55 /**
  56    A stream containing a WW8 document.
  57
  58    The content of the stream is a sequence of unsigned bytes. The
  59    stream consists of substreams that are identified by string
  60    identifiers.
  61 */
  62 class WRITERFILTER_DLLPUBLIC WW8Stream
  63 {
  64 public:
  65     /**
  66        Pointer to a WW8Stream.
  67     */
  68     typedef boost::shared_ptr<WW8Stream> Pointer_t;
  69
  70     /**
  71        Type for the content of the stream
  72      */
  73     typedef SubSequence<sal_uInt8> Sequence;
  74
  75     virtual ~WW8Stream();
  76
  77     /**
  78        Returns pointer to a substream.
  79
  80        @param rSid     identifier of substream to return
  81
  82        @return    the substream
  83      */
  84     virtual Pointer_t getSubStream(const ::rtl::OUString & rSid) = 0;
  85
  86     /**
  87        Return a continious part of the stream.
  88
  89        @param nOffset     offset in the stream where the part starts
  90        @param nCount      length of the part (number of bytes)
  91
  92        @return    sequence of unsigned bytes
  93      */
  94     virtual Sequence get(sal_uInt32 nOffset, sal_uInt32 nCount)
  95         const = 0;
  96
  97     // Returns the names of substreams contained in the stream
  98     virtual string getSubStreamNames() const = 0;
  99
 100     virtual uno::Sequence<rtl::OUString> getSubStreamUNames() const = 0;
 101
 102     /**
 103        Dumps content of stream to output.
 104
 105        @param o     the target output
 106     */
 107     virtual void dump(OutputWithDepth<string> & o) const = 0;
 108
 109     //virtual bool put(sal_uInt32 nOffset, const Sequence & rSeq) = 0;
 110 };
 111
 112 /**
 113    A property.
 114
 115 */
 116 class WRITERFILTER_DLLPUBLIC WW8Property
 117 {
 118 public:
 119     /**
 120        Ponter to a property.
 121     */
 122     typedef boost::shared_ptr<WW8Property> Pointer_t;
 123
 124     virtual ~WW8Property();
 125
 126     virtual sal_uInt32 getId() const = 0;
 127     virtual sal_uInt32 getParam() const = 0;
 128     virtual WW8Stream::Sequence getParams() const = 0;
 129
 130     virtual string toString() const = 0;
 131
 132     /**
 133        Dumps this object to an output.
 134
 135     */
 136     virtual void dump(OutputWithDepth<string> & o) const = 0;
 137 };
 138
 139 /**
 140    An iterator for traversal of a set of properties.
 141
 142    Sample code for use of iterator:
 143
 144    \code
 145    Return_t function(WW8PropertySet::tPointer pSet)
 146    {
 147        do_something;
 148
 149        WW8PropertySetIterator::tPointer pIt = pSet->begin();
 150        WW8PropertySetIterator::tPointer pItEnd = pSet->end();
 151
 152        while ((*pIt) != (*pItEnd))
 153        {
 154            do_something();
 155
 156            ++(*pIt);
 157        }
 158
 159        do_something;
 160    }
 161    \endcode
 162 */
 163 class WRITERFILTER_DLLPUBLIC WW8PropertySetIterator
 164 {
 165 public:
 166     typedef boost::shared_ptr<WW8PropertySetIterator> Pointer_t;
 167
 168     virtual ~WW8PropertySetIterator();
 169
 170     /**
 171        Advance iterator to the next property.
 172     */
 173     virtual WW8PropertySetIterator & operator++() = 0;
 174
 175     /**
 176        Returns a pointer to the property the iterator references.
 177     */
 178     virtual WW8Property::Pointer_t get() const = 0;
 179
 180     /**
 181        Checks if the iterator is equal to another one.
 182     */
 183     virtual bool equal(const WW8PropertySetIterator & rIt) const = 0;
 184
 185     /**
 186        Returns string representation of iterator.
 187      */
 188     virtual string toString() const = 0;
 189 };
 190
 191 /**
 192    Checks if two property set iterators are not equal.
 193 */
 194 bool operator != (const WW8PropertySetIterator & rA,
 195                   const WW8PropertySetIterator & rB);
 196
 197 /**
 198    A set of properties.
 199 */
 200 class WRITERFILTER_DLLPUBLIC WW8PropertySet
 201 {
 202 public:
 203     typedef boost::shared_ptr<WW8PropertySet> Pointer_t;
 204
 205     virtual ~WW8PropertySet();
 206
 207     /**
 208        Returns iterator to the start of the set.
 209      */
 210     virtual WW8PropertySetIterator::Pointer_t begin() = 0;
 211
 212     /**
 213        Returns iterator to the end of the set.
 214     */
 215     virtual WW8PropertySetIterator::Pointer_t end() = 0;
 216
 217     /**
 218        Dumps property set to output stream.
 219
 220        @param o    output stream to dump property set to
 221     */
 222     virtual void dump(OutputWithDepth<string> & o) const = 0;
 223
 224     /**
 225        Iterate through property set and for each element dump a dot
 226        output stream.
 227
 228        @param o      output stream to dump dots to
 229      */
 230     virtual void dots(ostream & o) = 0;
 231
 232     virtual bool isPap() const = 0;
 233     virtual sal_uInt32 get_istd() const = 0;
 234
 235     /**
 236        Insert another property set into this property set.
 237
 238        @param pSet   the set to insert
 239      */
 240     virtual void insert(const WW8PropertySet::Pointer_t pSet) = 0;
 241 };
 242
 243 enum PropertyType {
 244     /** Auxiliary type for character positions defined in piece table */
 245     PROP_DOC,
 246
 247     /** properties are section properies */
 248     PROP_SEC,
 249
 250     /** properties are paragraph properties */
 251     PROP_PAP,
 252
 253     /** properties are character properties */
 254     PROP_CHP,
 255
 256     /** a footnote reference */
 257     PROP_FOOTNOTE,
 258
 259     /** an endnote reference */
 260     PROP_ENDNOTE,
 261
 262     /** an annotaion reference */
 263     PROP_ANNOTATION,
 264
 265     /** the start of a bookmark */
 266     PROP_BOOKMARKSTART,
 267
 268     /** the end of a bookmark */
 269     PROP_BOOKMARKEND,
 270
 271     /** a field character (start, separator or end) */
 272     PROP_FLD,
 273
 274     /** a shape character */
 275     PROP_SHP,
 276
 277     /** a break character */
 278     PROP_BRK
 279 };
 280
 281 /**
 282    An iterator for traversal of the character positions of a Word
 283    document.
 284
 285    The use of the iterator is analogous to WW8PropertySetIterator.
 286 */
 287 class WRITERFILTER_DLLPUBLIC WW8DocumentIterator
 288 {
 289 public:
 290     typedef boost::shared_ptr<WW8DocumentIterator> Pointer_t;
 291
 292     virtual ~WW8DocumentIterator();
 293
 294     /**
 295        Advance iterator to next character position of the document.
 296     */
 297     virtual WW8DocumentIterator & operator++() = 0;
 298
 299     /**
 300        Recedes iterator to previous character postion of the document.
 301      */
 302     virtual WW8DocumentIterator & operator--() = 0;
 303
 304     /**
 305        Returns properties set at the character position the iterator
 306        points to.
 307
 308        @return pointer to set of properties
 309      */
 310     virtual writerfilter::Reference<Properties>::Pointer_t getProperties()
 311         const = 0;
 312
 313     virtual writerfilter::Reference<Stream>::Pointer_t getSubDocument()
 314         const = 0;
 315
 316     /**
 317        Returns text run at the character position the iterator points
 318        to.
 319      */
 320     virtual WW8Stream::Sequence getText() = 0;
 321
 322     /**
 323        Return pointer to the shape at character position the iterator
 324        is pointing to.
 325      */
 326     virtual writerfilter::Reference<Properties>::Pointer_t getShape() const = 0;
 327
 328     /**
 329        Checks if the characters of the entity the iterator points to
 330        are complex.
 331
 332        Complex characters in a Word document are byte size
 333        characters. Non-complex characters are word size characters.
 334
 335        @retval true      The characters are complex.
 336        @retval false     The characters are non-complex.
 337      */
 338     virtual bool isComplex() const = 0;
 339
 340     /**
 341        Returns the property type of the entity the iterator points to.
 342      */
 343     virtual PropertyType getPropertyType() const = 0;
 344
 345     /**
 346        Checks is the iterator is equal to another one.
 347
 348        @param rIt    iterator to check against
 349
 350        @retval true    the iterators are equal
 351        @retval false   else
 352     */
 353     virtual bool equal(const WW8DocumentIterator & rIt) const = 0;
 354
 355     /**
 356        Returns string representation of the iterator.
 357     */
 358     virtual string toString() const = 0;
 359
 360     /**
 361        Dumps the iterator to an output stream.
 362
 363        @param o    the output stream to dump the iterator to
 364      */
 365     virtual void dump(ostream & o) const = 0;
 366 };
 367
 368 /**
 369    Checks if two document iterators are equal.
 370
 371    @param rA     first iterator
 372    @param rB     second iterator
 373
 374    @retval true    the document iterators are equal
 375    @retval false   else
 376  */
 377 bool operator == (const WW8DocumentIterator & rA,
 378                   const WW8DocumentIterator & rB);
 379
 380 class WRITERFILTER_DLLPUBLIC SubDocumentId
 381 {
 382 public:
 383     enum eType { FOOTNOTES, HEADERS, FOOTERS };
 384
 385 private:
 386     eType mnType;
 387     sal_uInt8 mnIndex;
 388
 389 public:
 390     SubDocumentId(eType nType, sal_uInt8 nIndex)
 391     : mnType(nType), mnIndex(nIndex)
 392     {
 393     }
 394
 395     eType getType() const { return mnType; }
 396     sal_uInt8 getIndex() const { return mnIndex; }
 397 };
 398
 399 /**
 400    A Word 8 document.
 401 */
 402 class WRITERFILTER_DLLPUBLIC WW8Document :
 403     public writerfilter::Reference<Stream>
 404 {
 405 public:
 406     typedef boost::shared_ptr<WW8Document> Pointer_t;
 407
 408     virtual ~WW8Document();
 409
 410     /**
 411        Get a subdocument.
 412
 413        A subdocument can be
 414
 415        - a header
 416        - a footer
 417        - a footnode
 418
 419        @param nId identifier of the subdocumen
 420     */
 421     virtual Pointer_t getSubDocument(SubDocumentId nId) = 0;
 422
 423     /**
 424        Returns iterator to beginning of document.
 425      */
 426     virtual WW8DocumentIterator::Pointer_t begin() = 0;
 427
 428     /**
 429        Returns iterator to end of document.
 430      */
 431     virtual WW8DocumentIterator::Pointer_t end() = 0;
 432 };
 433
 434 class WRITERFILTER_DLLPUBLIC WW8DocumentFactory
 435 {
 436 public:
 437     static WW8Stream::Pointer_t
 438     createStream(uno::Reference<uno::XComponentContext> rContext,
 439                  uno::Reference<io::XInputStream> rStream);
 440
 441     static WW8Document *
 442     createDocument(WW8Stream::Pointer_t rpStream);
 443 };
 444
 445 void sprmidsToXML(::std::iostream & out);
 446
 447 void doctokidsToXML(::std::iostream & out);
 448
 449 }}
 450
 451 #endif // INCLUDED_WW8_DOCUMENT_HXX