writerfilter/inc/resourcemodel/WW8ResourceModel.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: WW8ResourceModel.hxx,v $
  10  * $Revision: 1.4 $
  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_EVENT_HANDLER_HXX
  32 #define INCLUDED_WW8_EVENT_HANDLER_HXX
  33
  34 #include <string>
  35 #include <memory>
  36 #include <boost/shared_ptr.hpp>
  37 #include <sal/types.h>
  38 #include <com/sun/star/drawing/XShape.hpp>
  39 #include <com/sun/star/uno/Any.hxx>
  40 #include <WriterFilterDllApi.hxx>
  41 #include <resourcemodel/OutputWithDepth.hxx>
  42 /**
  43    @file WW8ResourceModel.hxx
  44
  45    The classes in this file define the interfaces for the resource
  46    model of the DocTokenizer:
  47
  48    @image html doctok.png
  49
  50    A resource is a set of events that describe an object. A resource
  51    is only an abstract concept. It is not instanciated to a class.
  52
  53    A reference to a resource represents the object that the resource
  54    describes. The reference can be resolved thereby generating the
  55    events of the resource.
  56
  57    A handler receives the events generated by resolving a
  58    reference. There are several types of handlers each accepting their
  59    specific set of events.
  60
  61    References always have a parameter determining the kind of handler
  62    they send the events they generate to. The set of events generated
  63    by resolving the reference is a subset of the events received by
  64    the handler.
  65 */
  66
  67
  68 typedef sal_uInt32 Id;
  69
  70 namespace writerfilter {
  71 using namespace ::com::sun::star;
  72 using namespace ::std;
  73
  74 /**
  75     Reference to an resource that generates events and sends them to a
  76     handler.
  77
  78     The reference can be resolved, i.e. the resource generates its
  79     events. The events must be suitable for the handler type given by
  80     the template parameter.
  81
  82     @attention The parameter of the template does not determine the
  83     type of the reference's target. It determines the type of the handler!
  84
  85     Example:
  86
  87     A Word document can be represented as a stream of events. Event
  88     types in a Word document are text, properties, tables, starts and
  89     ends of groups. These can be handled by a stream handler (@see
  90     Stream). Thus a reference to a Word document is resolved by
  91     sending these events to a stream handler.
  92 */
  93
  94 template <class T>
  95 class WRITERFILTER_DLLPUBLIC Reference
  96 {
  97 public:
  98     /**
  99         Pointer to reference
 100
 101         @attention The ownership of a reference is transfered when
 102         the reference is passed.
 103     */
 104     typedef boost::shared_ptr< Reference<T> > Pointer_t;
 105
 106     virtual ~Reference() {}
 107
 108     /**
 109        Resolves the reference.
 110
 111        The events of the references target resource are generated and
 112        send to a handler.
 113
 114        @param rHandler         handler which receives the events
 115      */
 116     virtual void resolve(T & rHandler) = 0;
 117
 118     /**
 119        Returns the type of the reference aka the name of the access class.
 120      */
 121     virtual string getType() const = 0;
 122 };
 123
 124 class Value;
 125 class Sprm;
 126
 127 /**
 128    Handler for properties.
 129  */
 130 class WRITERFILTER_DLLPUBLIC Properties
 131 {
 132 public:
 133     /**
 134        Receives an attribute.
 135
 136        @param name     name of the attribute
 137        @param val      value of the attribute
 138      */
 139     virtual void attribute(Id name, Value & val) = 0;
 140
 141     /**
 142        Receives a SPRM.
 143
 144        @param  sprm      the SPRM received
 145     */
 146     virtual void sprm(Sprm & sprm) = 0;
 147
 148 };
 149
 150 /**
 151    Handler for tables.
 152  */
 153 class WRITERFILTER_DLLPUBLIC Table
 154 {
 155 public:
 156     /**
 157        Receives an entry of the table.
 158
 159        @param pos     position of the entry in the table
 160        @param ref     reference to properties of the entry
 161      */
 162     virtual void entry(int pos, writerfilter::Reference<Properties>::Pointer_t ref) = 0;
 163 };
 164
 165 /**
 166    Handler for binary objects.
 167  */
 168 class WRITERFILTER_DLLPUBLIC BinaryObj
 169 {
 170 public:
 171     /**
 172        Receives binary data of the object.
 173
 174        @param buf     pointer to buffer containing the data
 175        @param len     size of buffer
 176        @param ref     reference to properties of binary object
 177      */
 178     virtual void data(const sal_uInt8* buf, size_t len,
 179                       writerfilter::Reference<Properties>::Pointer_t ref) = 0;
 180 };
 181
 182 /**
 183    Handler for a stream.
 184  */
 185 class WRITERFILTER_DLLPUBLIC Stream
 186 {
 187 public:
 188     /**
 189        Pointer to this stream.
 190      */
 191     typedef boost::shared_ptr<Stream> Pointer_t;
 192
 193     /**
 194        Receives start mark for group with the same section properties.
 195      */
 196     virtual void startSectionGroup() = 0;
 197
 198     /**
 199        Receives end mark for group with the same section properties.
 200     */
 201     virtual void endSectionGroup() = 0;
 202
 203     /**
 204        Receives start mark for group with the same paragraph properties.
 205      */
 206     virtual void startParagraphGroup() = 0;
 207
 208     /**
 209        Receives end mark for group with the same paragraph properties.
 210      */
 211     virtual void endParagraphGroup() = 0;
 212
 213     virtual void markLastParagraphInSection( ) { };
 214
 215     /**
 216        Receives start mark for group with the same character properties.
 217      */
 218     virtual void startCharacterGroup() = 0;
 219
 220     /**
 221        Receives end mark for group with the same character properties.
 222      */
 223     virtual void endCharacterGroup() = 0;
 224
 225     /**
 226       Receives a shape.
 227      */
 228     virtual void startShape( ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape > xShape ) = 0;
 229
 230     virtual void endShape( ) = 0;
 231
 232     /**
 233        Receives 8-bit per character text.
 234
 235        @param data  buffer containing the text
 236        @param len   number of characters in the text
 237      */
 238     virtual void text(const sal_uInt8 * data, size_t len) = 0;
 239
 240     /**
 241        Receives 16-bit per character text.
 242
 243        @param data    buffer containing the text
 244        @param len     number of characters in the text.
 245      */
 246     virtual void utext(const sal_uInt8 * data, size_t len) = 0;
 247
 248     /**
 249        Receives properties of the current run of text.
 250
 251        @param ref    reference to the properties
 252      */
 253     virtual void props(writerfilter::Reference<Properties>::Pointer_t ref) = 0;
 254
 255     /**
 256        Receives table.
 257
 258        @param name     name of the table
 259        @param ref      referecne to the table
 260      */
 261     virtual void table(Id name,
 262                        writerfilter::Reference<Table>::Pointer_t ref) = 0;
 263
 264     /**
 265         Receives a substream.
 266
 267         @param name    name of the substream
 268         @param ref     reference to the substream
 269     */
 270     virtual void substream(Id name,
 271                            writerfilter::Reference<Stream>::Pointer_t ref) = 0;
 272
 273
 274     /**
 275        Debugging: Receives information about current point in stream.
 276
 277        @param info     the information
 278      */
 279     virtual void info(const string & info) = 0;
 280 };
 281
 282 /**
 283    A value.
 284
 285    The methods of this class may throw exceptions if a certain aspect
 286    makes no sense for a certain value, e.g. the integer value of a
 287    string.
 288  */
 289 class WRITERFILTER_DLLPUBLIC Value
 290 {
 291 public:
 292     /**
 293        Pointer to a value.
 294      */
 295     typedef auto_ptr<Value> Pointer_t;
 296
 297     /**
 298        Returns integer representation of the value.
 299      */
 300     virtual int getInt() const = 0;
 301
 302     /**
 303        Returns string representation of the value.
 304      */
 305     virtual ::rtl::OUString getString() const = 0;
 306
 307     /**
 308        Returns representation of the value as uno::Any.
 309      */
 310     virtual uno::Any getAny() const = 0;
 311
 312     /**
 313        Returns properties of this value.
 314      */
 315     virtual writerfilter::Reference<Properties>::Pointer_t getProperties() = 0;
 316
 317     /**
 318        Returns stream of this value.
 319      */
 320     virtual writerfilter::Reference<Stream>::Pointer_t getStream() = 0;
 321
 322     /**
 323        Returns binary object  of this value.
 324      */
 325     virtual writerfilter::Reference<BinaryObj>::Pointer_t getBinary() = 0;
 326
 327     /**
 328        Returns string representation of this value.
 329      */
 330     virtual string toString() const = 0;
 331 };
 332
 333 /**
 334    An SPRM.
 335
 336  */
 337 class WRITERFILTER_DLLPUBLIC Sprm
 338 {
 339 public:
 340     typedef auto_ptr<Sprm> Pointer_t;
 341     enum Kind { UNKNOWN, CHARACTER, PARAGRAPH, TABLE };
 342     /**
 343        Returns id of the SPRM.
 344      */
 345     virtual sal_uInt32 getId() const = 0;
 346
 347     /**
 348        Returns value of the SPRM.
 349      */
 350     virtual Value::Pointer_t getValue() = 0;
 351
 352     /**
 353        Returns reference to binary object contained in the SPRM.
 354      */
 355     virtual writerfilter::Reference<BinaryObj>::Pointer_t getBinary() = 0;
 356
 357     /**
 358        Returns reference to stream associated with the SPRM.
 359      */
 360     virtual writerfilter::Reference<Stream>::Pointer_t getStream() = 0;
 361
 362     /**
 363        Returns reference to properties contained in the SPRM.
 364
 365      */
 366     virtual writerfilter::Reference<Properties>::Pointer_t getProps() = 0;
 367
 368     /**
 369        Returns the kind of this SPRM.
 370     */
 371     virtual Kind getKind() = 0;
 372
 373     /**
 374        Returns name of sprm.
 375     */
 376     virtual string getName() const = 0;
 377
 378     /**
 379        Returns string repesentation of sprm.
 380      */
 381     virtual string toString() const = 0;
 382 };
 383
 384 /**
 385    Creates handler for a stream.
 386 */
 387 Stream::Pointer_t WRITERFILTER_DLLPUBLIC createStreamHandler();
 388
 389     void WRITERFILTER_DLLPUBLIC analyzerIds();
 390     Stream::Pointer_t WRITERFILTER_DLLPUBLIC createAnalyzer();
 391
 392     void WRITERFILTER_DLLPUBLIC logger(string prefix, string message);
 393
 394     void WRITERFILTER_DLLPUBLIC dump(OutputWithDepth<string> & o, const char * name, writerfilter::Reference<Properties>::Pointer_t props);
 395     void WRITERFILTER_DLLPUBLIC dump(OutputWithDepth<string> & o, const char * name, sal_uInt32 n);
 396     void WRITERFILTER_DLLPUBLIC dump(OutputWithDepth<string> & /*o*/, const char * /*name*/,
 397                                      const rtl::OUString & /*str*/);
 398     void WRITERFILTER_DLLPUBLIC dump(OutputWithDepth<string> & o, const char * name, writerfilter::Reference<BinaryObj>::Pointer_t binary);
 399
 400 }
 401
 402
 403 #endif // INCLUDED_WW8_EVENT_HANDLER_HXX