writerfilter/source/ooxml/OOXMLPropertySet.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 #ifndef INCLUDED_WRITERFILTER_SOURCE_OOXML_OOXMLPROPERTYSET_HXX
  20 #define INCLUDED_WRITERFILTER_SOURCE_OOXML_OOXMLPROPERTYSET_HXX
  21
  22 #include <vector>
  23 #include "OOXMLBinaryObjectReference.hxx"
  24 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  25 #include <dmapper/resourcemodel.hxx>
  26
  27 namespace writerfilter {
  28 namespace ooxml
  29 {
  30
  31 class OOXMLValue : public Value
  32 {
  33 public:
  34     typedef tools::SvRef<OOXMLValue> Pointer_t;
  35     OOXMLValue();
  36     virtual ~OOXMLValue() override;
  37
  38     OOXMLValue(OOXMLValue const &) = default;
  39     OOXMLValue(OOXMLValue &&) = default;
  40     OOXMLValue & operator =(OOXMLValue const &) = default;
  41     OOXMLValue & operator =(OOXMLValue &&) = default;
  42
  43     virtual int getInt() const override;
  44     ;
  45     virtual OUString getString() const override;
  46     virtual css::uno::Any getAny() const override;
  47     virtual writerfilter::Reference<Properties>::Pointer_t getProperties() override;
  48     virtual writerfilter::Reference<BinaryObj>::Pointer_t getBinary() override;
  49 #ifdef DEBUG_WRITERFILTER
  50     virtual std::string toString() const override;
  51 #endif
  52     virtual OOXMLValue * clone() const;
  53 };
  54
  55 class OOXMLProperty : public Sprm
  56 {
  57 public:
  58     typedef tools::SvRef<OOXMLProperty> Pointer_t;
  59     enum Type_t { SPRM, ATTRIBUTE };
  60 private:
  61     Id const mId;
  62     mutable OOXMLValue::Pointer_t mpValue;
  63     Type_t const meType;
  64
  65 public:
  66     OOXMLProperty(Id id, const OOXMLValue::Pointer_t& pValue, Type_t eType);
  67     OOXMLProperty(const OOXMLProperty & rSprm) = delete;
  68     virtual ~OOXMLProperty() override;
  69
  70     sal_uInt32 getId() const override;
  71     Value::Pointer_t getValue() override;
  72     writerfilter::Reference<Properties>::Pointer_t getProps() override;
  73 #ifdef DEBUG_WRITERFILTER
  74     std::string getName() const override;
  75     std::string toString() const override;
  76 #endif
  77     void resolve(Properties & rProperties);
  78 };
  79
  80 class OOXMLBinaryValue : public OOXMLValue
  81 {
  82     OOXMLBinaryObjectReference::Pointer_t const mpBinaryObj;
  83 public:
  84     explicit OOXMLBinaryValue(OOXMLBinaryObjectReference::Pointer_t const & pBinaryObj);
  85     virtual ~OOXMLBinaryValue() override;
  86
  87     virtual writerfilter::Reference<BinaryObj>::Pointer_t getBinary() override;
  88 #ifdef DEBUG_WRITERFILTER
  89     virtual std::string toString() const override;
  90 #endif
  91     virtual OOXMLValue * clone() const override;
  92 };
  93
  94 class OOXMLBooleanValue : public OOXMLValue
  95 {
  96     bool const mbValue;
  97     explicit OOXMLBooleanValue(bool bValue);
  98 public:
  99     static OOXMLValue::Pointer_t const & Create (bool bValue);
 100     static OOXMLValue::Pointer_t const & Create (const char *pValue);
 101
 102     virtual ~OOXMLBooleanValue() override;
 103
 104     OOXMLBooleanValue(OOXMLBooleanValue const &) = default;
 105     OOXMLBooleanValue(OOXMLBooleanValue &&) = default;
 106     OOXMLBooleanValue & operator =(OOXMLBooleanValue const &) = delete; // due to const mbValue
 107     OOXMLBooleanValue & operator =(OOXMLBooleanValue &&) = delete; // due to const mbValue
 108
 109     virtual int getInt() const override;
 110     virtual css::uno::Any getAny() const override;
 111 #ifdef DEBUG_WRITERFILTER
 112     virtual std::string toString() const override;
 113 #endif
 114     virtual OOXMLValue * clone() const override;
 115 };
 116
 117 class OOXMLStringValue : public OOXMLValue
 118 {
 119     OUString const mStr;
 120 public:
 121     explicit OOXMLStringValue(const OUString & rStr);
 122     virtual ~OOXMLStringValue() override;
 123
 124     OOXMLStringValue(OOXMLStringValue const &) = default;
 125     OOXMLStringValue(OOXMLStringValue &&) = default;
 126     OOXMLStringValue & operator =(OOXMLStringValue const &) = delete; // due to const mStr
 127     OOXMLStringValue & operator =(OOXMLStringValue &&) = delete; // due to const mStr
 128
 129     virtual css::uno::Any getAny() const override;
 130     virtual OUString getString() const override;
 131 #ifdef DEBUG_WRITERFILTER
 132     virtual std::string toString() const override;
 133 #endif
 134     virtual OOXMLValue * clone() const override;
 135 };
 136
 137 class OOXMLInputStreamValue : public OOXMLValue
 138 {
 139     css::uno::Reference<css::io::XInputStream> mxInputStream;
 140
 141 public:
 142     explicit OOXMLInputStreamValue(css::uno::Reference<css::io::XInputStream> const & xInputStream);
 143     virtual ~OOXMLInputStreamValue() override;
 144
 145     virtual css::uno::Any getAny() const override;
 146 #ifdef DEBUG_WRITERFILTER
 147     virtual std::string toString() const override;
 148 #endif
 149     virtual OOXMLValue * clone() const override;
 150 };
 151
 152 class OOXMLPropertySet : public writerfilter::Reference<Properties>
 153 {
 154 public:
 155     typedef std::vector<OOXMLProperty::Pointer_t> OOXMLProperties_t;
 156     typedef tools::SvRef<OOXMLPropertySet> Pointer_t;
 157 private:
 158     OOXMLProperties_t mProperties;
 159     void add(const OOXMLProperty::Pointer_t& pProperty);
 160 public:
 161     OOXMLPropertySet();
 162     virtual ~OOXMLPropertySet() override;
 163
 164     OOXMLPropertySet(OOXMLPropertySet const &) = default;
 165     OOXMLPropertySet(OOXMLPropertySet &&) = default;
 166     OOXMLPropertySet & operator =(OOXMLPropertySet const &) = default;
 167     OOXMLPropertySet & operator =(OOXMLPropertySet &&) = default;
 168
 169     void resolve(Properties & rHandler) override;
 170     void add(Id id, const OOXMLValue::Pointer_t& pValue, OOXMLProperty::Type_t eType);
 171     void add(const OOXMLPropertySet::Pointer_t& pPropertySet);
 172     OOXMLPropertySet * clone() const;
 173
 174     OOXMLProperties_t::iterator begin();
 175     OOXMLProperties_t::iterator end();
 176     OOXMLProperties_t::const_iterator begin() const;
 177     OOXMLProperties_t::const_iterator end() const;
 178
 179 #ifdef DEBUG_WRITERFILTER
 180     std::string toString();
 181 #endif
 182 };
 183
 184 class OOXMLValue;
 185
 186 class OOXMLTable : public writerfilter::Reference<Table>
 187 {
 188 public:
 189     typedef tools::SvRef<OOXMLValue> ValuePointer_t;
 190     OOXMLTable();
 191     virtual ~OOXMLTable() override;
 192
 193     OOXMLTable(OOXMLTable const &) = default;
 194     OOXMLTable(OOXMLTable &&) = default;
 195     OOXMLTable & operator =(OOXMLTable const &) = default;
 196     OOXMLTable & operator =(OOXMLTable &&) = default;
 197
 198     void resolve(Table & rTable) override;
 199     void add(const ValuePointer_t& pPropertySet);
 200     OOXMLTable * clone() const;
 201 private:
 202     typedef std::vector<ValuePointer_t> PropertySets_t;
 203     PropertySets_t mPropertySets;
 204 };
 205
 206 class OOXMLPropertySetValue : public OOXMLValue
 207 {
 208     OOXMLPropertySet::Pointer_t const mpPropertySet;
 209 public:
 210     explicit OOXMLPropertySetValue(const OOXMLPropertySet::Pointer_t& pPropertySet);
 211     virtual ~OOXMLPropertySetValue() override;
 212
 213     OOXMLPropertySetValue(OOXMLPropertySetValue const &) = default;
 214     OOXMLPropertySetValue(OOXMLPropertySetValue &&) = default;
 215     OOXMLPropertySetValue & operator =(OOXMLPropertySetValue const &) = delete; // due to const mpPropertySet
 216     OOXMLPropertySetValue & operator =(OOXMLPropertySetValue &&) = delete; // due to const mpPropertySet
 217
 218     virtual writerfilter::Reference<Properties>::Pointer_t getProperties() override;
 219 #ifdef DEBUG_WRITERFILTER
 220     virtual std::string toString() const override;
 221 #endif
 222     virtual OOXMLValue * clone() const override;
 223 };
 224
 225 class OOXMLIntegerValue : public OOXMLValue
 226 {
 227     sal_Int32 const mnValue;
 228     explicit OOXMLIntegerValue(sal_Int32 nValue);
 229 public:
 230     static OOXMLValue::Pointer_t Create (sal_Int32 nValue);
 231     virtual ~OOXMLIntegerValue() override;
 232
 233     OOXMLIntegerValue(OOXMLIntegerValue const &) = default;
 234     OOXMLIntegerValue(OOXMLIntegerValue &&) = default;
 235     OOXMLIntegerValue & operator =(OOXMLIntegerValue const &) = delete; // due to const mnValue
 236     OOXMLIntegerValue & operator =(OOXMLIntegerValue &&) = delete; // due to const mnValue
 237
 238     virtual int getInt() const override;
 239     virtual css::uno::Any getAny() const override;
 240 #ifdef DEBUG_WRITERFILTER
 241     virtual std::string toString() const override;
 242 #endif
 243     virtual OOXMLValue * clone() const override;
 244 };
 245
 246 class OOXMLHexValue : public OOXMLValue
 247 {
 248 protected:
 249     sal_uInt32 mnValue;
 250 public:
 251     explicit OOXMLHexValue(sal_uInt32 nValue);
 252     explicit OOXMLHexValue(const char * pValue);
 253     virtual ~OOXMLHexValue() override;
 254
 255     OOXMLHexValue(OOXMLHexValue const &) = default;
 256     OOXMLHexValue(OOXMLHexValue &&) = default;
 257     OOXMLHexValue & operator =(OOXMLHexValue const &) = default;
 258     OOXMLHexValue & operator =(OOXMLHexValue &&) = default;
 259
 260     virtual int getInt() const override;
 261 #ifdef DEBUG_WRITERFILTER
 262     virtual std::string toString() const override;
 263 #endif
 264     virtual OOXMLValue * clone() const override;
 265 };
 266
 267 class OOXMLHexColorValue : public OOXMLHexValue
 268 {
 269 public:
 270     explicit OOXMLHexColorValue(const char * pValue);
 271 };
 272
 273 class OOXMLUniversalMeasureValue : public OOXMLValue
 274 {
 275 private:
 276     int mnValue;
 277 public:
 278     OOXMLUniversalMeasureValue(const char * pValue, sal_uInt32 npPt);
 279     virtual ~OOXMLUniversalMeasureValue() override;
 280
 281     OOXMLUniversalMeasureValue(OOXMLUniversalMeasureValue const &) = default;
 282     OOXMLUniversalMeasureValue(OOXMLUniversalMeasureValue &&) = default;
 283     OOXMLUniversalMeasureValue & operator =(OOXMLUniversalMeasureValue const &) = default;
 284     OOXMLUniversalMeasureValue & operator =(OOXMLUniversalMeasureValue &&) = default;
 285
 286     virtual int getInt() const override;
 287 #ifdef DEBUG_WRITERFILTER
 288     virtual std::string toString() const override;
 289 #endif
 290 };
 291
 292 /// npPt is quotient defining how much units are in 1 pt
 293 template <sal_uInt32 npPt> class OOXMLNthPtMeasureValue : public OOXMLUniversalMeasureValue
 294 {
 295 public:
 296     explicit OOXMLNthPtMeasureValue(const char * pValue)
 297         : OOXMLUniversalMeasureValue(pValue, npPt) {}
 298     virtual OOXMLValue* clone() const override
 299     {
 300         return new OOXMLNthPtMeasureValue<npPt>(*this);
 301     }
 302 };
 303
 304 /// Handles OOXML's ST_TwipsMeasure value.
 305 typedef OOXMLNthPtMeasureValue<20> OOXMLTwipsMeasureValue;
 306
 307 /// Handles OOXML's ST_HpsMeasure value.
 308 typedef OOXMLNthPtMeasureValue<2> OOXMLHpsMeasureValue;
 309
 310 class OOXMLMeasurementOrPercentValue : public OOXMLValue
 311 {
 312     int mnValue;
 313 public:
 314     explicit OOXMLMeasurementOrPercentValue(const char * pValue);
 315
 316     virtual int getInt() const override;
 317     virtual OOXMLValue* clone() const override
 318     {
 319         return new OOXMLMeasurementOrPercentValue(*this);
 320     }
 321 #ifdef DEBUG_WRITERFILTER
 322     virtual std::string toString() const override;
 323 #endif
 324 };
 325
 326 class OOXMLShapeValue : public OOXMLValue
 327 {
 328     css::uno::Reference<css::drawing::XShape> mrShape;
 329 public:
 330     explicit OOXMLShapeValue(css::uno::Reference<css::drawing::XShape> const & rShape);
 331     virtual ~OOXMLShapeValue() override;
 332
 333     virtual css::uno::Any getAny() const override;
 334 #ifdef DEBUG_WRITERFILTER
 335     virtual std::string toString() const override;
 336 #endif
 337     virtual OOXMLValue * clone() const override;
 338 };
 339
 340 class OOXMLStarMathValue : public OOXMLValue
 341 {
 342     css::uno::Reference< css::embed::XEmbeddedObject > component;
 343 public:
 344     explicit OOXMLStarMathValue( css::uno::Reference< css::embed::XEmbeddedObject > const & component );
 345     virtual ~OOXMLStarMathValue() override;
 346
 347     virtual css::uno::Any getAny() const override;
 348 #ifdef DEBUG_WRITERFILTER
 349     virtual std::string toString() const override;
 350 #endif
 351     virtual OOXMLValue * clone() const override;
 352 };
 353
 354 class OOXMLPropertySetEntryToString : public Properties
 355 {
 356     Id const mnId;
 357     OUString mStr;
 358
 359 public:
 360     explicit OOXMLPropertySetEntryToString(Id nId);
 361     virtual ~OOXMLPropertySetEntryToString() override;
 362
 363     virtual void sprm(Sprm & rSprm) override;
 364     virtual void attribute(Id nId, Value & rValue) override;
 365
 366     const OUString & getString() const { return mStr;}
 367 };
 368
 369 class OOXMLPropertySetEntryToInteger : public Properties
 370 {
 371     Id const mnId;
 372     int mnValue;
 373 public:
 374     explicit OOXMLPropertySetEntryToInteger(Id nId);
 375     virtual ~OOXMLPropertySetEntryToInteger() override;
 376
 377     virtual void sprm(Sprm & rSprm) override;
 378     virtual void attribute(Id nId, Value & rValue) override;
 379
 380     int getValue() const { return mnValue;}
 381 };
 382
 383 class OOXMLPropertySetEntryToBool : public Properties
 384 {
 385     Id const mnId;
 386     bool mValue;
 387 public:
 388     explicit OOXMLPropertySetEntryToBool(Id nId);
 389     virtual ~OOXMLPropertySetEntryToBool() override;
 390
 391     virtual void sprm(Sprm & rSprm) override;
 392     virtual void attribute(Id nId, Value & rValue) override;
 393
 394     bool getValue() const { return mValue; }
 395 };
 396
 397
 398 }}
 399
 400 #endif // INCLUDED_WRITERFILTER_SOURCE_OOXML_OOXMLPROPERTYSET_HXX
 401
 402 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */