writerfilter/inc/dmapper/resourcemodel.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_WRITERFILTER_INC_DMAPPER_RESOURCEMODEL_HXX
  21 #define INCLUDED_WRITERFILTER_INC_DMAPPER_RESOURCEMODEL_HXX
  22
  23 #include <string>
  24 #include <sal/types.h>
  25 #include <com/sun/star/drawing/XShape.hpp>
  26 #include <com/sun/star/uno/Any.hxx>
  27 #include <tools/ref.hxx>
  28
  29 /**
  30    @file resourcemodel.hxx
  31
  32    The classes in this file define the interfaces for the resource
  33    model of the DocTokenizer:
  34
  35    @image html doctok.png
  36
  37    A resource is a set of events that describe an object. A resource
  38    is only an abstract concept. It is not instantiated to a class.
  39
  40    A reference to a resource represents the object that the resource
  41    describes. The reference can be resolved thereby generating the
  42    events of the resource.
  43
  44    A handler receives the events generated by resolving a
  45    reference. There are several types of handlers each accepting their
  46    specific set of events.
  47
  48    References always have a parameter determining the kind of handler
  49    they send the events they generate to. The set of events generated
  50    by resolving the reference is a subset of the events received by
  51    the handler.
  52 */
  53
  54 typedef sal_uInt32 Id;
  55
  56 namespace writerfilter
  57 {
  58 /**
  59     Reference to a resource that generates events and sends them to a
  60     handler.
  61
  62     The reference can be resolved, i.e. the resource generates its
  63     events. The events must be suitable for the handler type given by
  64     the template parameter.
  65
  66     @attention The parameter of the template does not determine the
  67     type of the reference's target. It determines the type of the handler!
  68
  69     Example:
  70
  71     A Word document can be represented as a stream of events. Event
  72     types in a Word document are text, properties, tables, starts and
  73     ends of groups. These can be handled by a stream handler (@see
  74     Stream). Thus a reference to a Word document is resolved by
  75     sending these events to a stream handler.
  76 */
  77
  78 template <class T> class SAL_DLLPUBLIC_TEMPLATE Reference : public virtual SvRefBase
  79 {
  80 public:
  81     /**
  82         Pointer to reference
  83
  84         @attention The ownership of a reference is transferred when
  85         the reference is passed.
  86     */
  87     typedef tools::SvRef<Reference<T>> Pointer_t;
  88
  89     /**
  90        Resolves the reference.
  91
  92        The events of the references target resource are generated and
  93        send to a handler.
  94
  95        @param rHandler         handler which receives the events
  96      */
  97     virtual void resolve(T& rHandler) = 0;
  98
  99     Reference() = default;
 100     Reference(Reference const&) = default;
 101     Reference(Reference&&) = default;
 102     Reference& operator=(Reference const&) = default;
 103     Reference& operator=(Reference&&) = default;
 104
 105 protected:
 106     ~Reference() override {}
 107 };
 108
 109 class Value;
 110 class Sprm;
 111
 112 /**
 113    Handler for properties.
 114  */
 115 class Properties : public virtual SvRefBase
 116 {
 117 public:
 118     /**
 119        Receives an attribute.
 120
 121        @param name     name of the attribute
 122        @param val      value of the attribute
 123      */
 124     virtual void attribute(Id name, Value& val) = 0;
 125
 126     /**
 127        Receives a SPRM.
 128
 129        @param  sprm      the SPRM received
 130     */
 131     virtual void sprm(Sprm& sprm) = 0;
 132
 133 protected:
 134     ~Properties() override {}
 135 };
 136
 137 /**
 138    Handler for tables.
 139  */
 140 class Table : public virtual SvRefBase
 141 {
 142 public:
 143     typedef tools::SvRef<Table> Pointer_t;
 144
 145     /**
 146        Receives an entry of the table.
 147
 148        @param pos     position of the entry in the table
 149        @param ref     reference to properties of the entry
 150      */
 151     virtual void entry(int pos, writerfilter::Reference<Properties>::Pointer_t ref) = 0;
 152
 153 protected:
 154     ~Table() override {}
 155 };
 156
 157 /**
 158    Handler for binary objects.
 159  */
 160 class BinaryObj
 161 {
 162 public:
 163     /**
 164        Receives binary data of the object.
 165
 166        @param buf     pointer to buffer containing the data
 167        @param len     size of buffer
 168      */
 169     virtual void data(const sal_uInt8* buf, size_t len) = 0;
 170
 171 protected:
 172     ~BinaryObj() {}
 173 };
 174
 175 const sal_uInt8 cFieldStart = 0x13;
 176 const sal_uInt8 cFieldSep = 0x14;
 177 const sal_uInt8 cFieldEnd = 0x15;
 178
 179 /**
 180    Handler for a stream.
 181  */
 182 class Stream : public virtual SvRefBase
 183 {
 184 public:
 185     /**
 186        Pointer to this stream.
 187      */
 188     typedef tools::SvRef<Stream> Pointer_t;
 189
 190     /**
 191        Receives start mark for group with the same section properties.
 192      */
 193     virtual void startSectionGroup() = 0;
 194
 195     /**
 196        Receives end mark for group with the same section properties.
 197     */
 198     virtual void endSectionGroup() = 0;
 199
 200     /// The current section is the last one in this body text.
 201     virtual void markLastSectionGroup(){};
 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(css::uno::Reference<css::drawing::XShape> const& 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      * Offset in EMUs for a shape.
 250      *
 251      * Call *before* an ooxml::CT_PosH/V_posOffset sprm is sent.
 252      */
 253     virtual void positionOffset(const OUString& rText, bool bVertical) = 0;
 254     /// Returns the last set offsets of a shape in HMM.
 255     virtual css::awt::Point getPositionOffset() = 0;
 256     /**
 257      * Horizontal and vertical alignment for a shape.
 258      *
 259      * Call *before* an ooxml:CT_PosH/V_align sprm is sent.
 260      */
 261     virtual void align(const OUString& rText, bool bVertical) = 0;
 262     virtual void positivePercentage(const OUString& rText) = 0;
 263
 264     /**
 265        Receives properties of the current run of text.
 266
 267        @param ref    reference to the properties
 268      */
 269     virtual void props(writerfilter::Reference<Properties>::Pointer_t ref) = 0;
 270
 271     /**
 272        Receives table.
 273
 274        @param name     name of the table
 275        @param ref      reference to the table
 276      */
 277     virtual void table(Id name, writerfilter::Reference<Table>::Pointer_t ref) = 0;
 278
 279     /**
 280         Receives a substream.
 281
 282         @param name    name of the substream
 283         @param ref     reference to the substream
 284     */
 285     virtual void substream(Id name, writerfilter::Reference<Stream>::Pointer_t ref) = 0;
 286
 287     /**
 288        Debugging: Receives information about current point in stream.
 289
 290        @param info     the information
 291      */
 292     virtual void info(const std::string& info) = 0;
 293
 294     /// Receives start mark for glossary document entry.
 295     virtual void startGlossaryEntry() = 0;
 296
 297     /// Receives end mark for glossary document entry.
 298     virtual void endGlossaryEntry() = 0;
 299
 300 protected:
 301     ~Stream() override {}
 302 };
 303
 304 /**
 305    A value.
 306
 307    The methods of this class may throw exceptions if a certain aspect
 308    makes no sense for a certain value, e.g. the integer value of a
 309    string.
 310  */
 311 class Value : public virtual SvRefBase
 312 {
 313 public:
 314     /**
 315        Pointer to a value.
 316      */
 317     typedef tools::SvRef<Value> Pointer_t;
 318
 319     /**
 320        Returns integer representation of the value.
 321      */
 322     virtual int getInt() const = 0;
 323
 324     /**
 325        Returns string representation of the value.
 326      */
 327     virtual OUString getString() const = 0;
 328
 329     /**
 330        Returns representation of the value as uno::Any.
 331      */
 332     virtual css::uno::Any getAny() const = 0;
 333
 334     /**
 335        Returns properties of this value.
 336      */
 337     virtual writerfilter::Reference<Properties>::Pointer_t getProperties() = 0;
 338
 339     /**
 340        Returns binary object  of this value.
 341      */
 342     virtual writerfilter::Reference<BinaryObj>::Pointer_t getBinary() = 0;
 343
 344     /**
 345        Returns string representation of this value.
 346      */
 347 #ifdef DBG_UTIL
 348     virtual std::string toString() const = 0;
 349 #endif
 350 };
 351
 352 /**
 353    An SPRM: Section, Paragraph and Run Modifier
 354
 355  */
 356 class Sprm : public virtual SvRefBase
 357 {
 358 public:
 359     typedef tools::SvRef<Sprm> Pointer_t;
 360
 361     /**
 362        Returns id of the SPRM.
 363      */
 364     virtual sal_uInt32 getId() const = 0;
 365
 366     /**
 367        Returns value of the SPRM.
 368      */
 369     virtual Value::Pointer_t getValue() = 0;
 370
 371     /**
 372        Returns reference to properties contained in the SPRM.
 373
 374      */
 375     virtual writerfilter::Reference<Properties>::Pointer_t getProps() = 0;
 376
 377     /**
 378        Returns name of sprm.
 379     */
 380 #ifdef DBG_UTIL
 381     virtual std::string getName() const = 0;
 382 #endif
 383
 384     /**
 385        Returns string representation of sprm.
 386      */
 387 #ifdef DBG_UTIL
 388     virtual std::string toString() const = 0;
 389 #endif
 390
 391 protected:
 392     ~Sprm() override {}
 393 };
 394
 395 typedef sal_Int32 Token_t;
 396 }
 397
 398 #endif // INCLUDED_WRITERFILTER_INC_DMAPPER_RESOURCEMODEL_HXX
 399
 400 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */