sc/inc/autoform.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 #pragma once
  21
  22 /*************************************************************************
  23 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  24
  25     The structure of auto formatting should not be changed. It is used
  26     by various code of Writer and Calc. If a change is necessary, the
  27     source code of both applications must be changed!
  28
  29 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  30 **************************************************************************/
  31
  32 #include <svl/poolitem.hxx>
  33 #include <svx/autoformathelper.hxx>
  34
  35 #include "scdllapi.h"
  36 #include "zforauto.hxx"
  37
  38 #include <array>
  39 #include <memory>
  40 #include <map>
  41 #include <climits>
  42
  43 class ScDocument;
  44
  45 /**
  46 A binary blob of writer-specific data. This data typically consists of types that are
  47 unavailable to Calc (e.g. SwFmtVertOrient), or that Calc doesn't care about.
  48
  49 @remarks Note that in autoformat versions prior to AUTOFORMAT_DATA_ID_31005, Calc
  50 logic handled and stored several writer-specific items (such as ScAutoFormatDataField::aAdjust).
  51 That logic was preserved. From _31005 onward, writer-specific data should be handled by
  52 blobs to avoid needlessly complicating the Calc logic.
  53 */
  54 struct AutoFormatSwBlob
  55 {
  56     std::unique_ptr<sal_uInt8[]> pData;
  57     std::size_t size;
  58
  59     AutoFormatSwBlob() : size(0)
  60     {
  61     }
  62     AutoFormatSwBlob(const AutoFormatSwBlob&) = delete;
  63     const AutoFormatSwBlob& operator=(const AutoFormatSwBlob&) = delete;
  64
  65     void Reset()
  66     {
  67         pData.reset();
  68         size = 0;
  69     }
  70 };
  71
  72 /// Struct with version numbers of the Items
  73 struct ScAfVersions : public AutoFormatVersions
  74 {
  75 private:
  76     AutoFormatSwBlob swVersions;
  77
  78 public:
  79     ScAfVersions();
  80
  81     void Load( SvStream& rStream, sal_uInt16 nVer );
  82     void Write(SvStream& rStream, sal_uInt16 fileVersion);
  83 };
  84
  85 /// Contains all items for one cell of a table autoformat.
  86 class ScAutoFormatDataField : public AutoFormatBase
  87 {
  88 private:
  89     AutoFormatSwBlob                            m_swFields;
  90
  91     // number format
  92     ScNumFormatAbbrev                           aNumFormat;
  93
  94 public:
  95     ScAutoFormatDataField();
  96     ScAutoFormatDataField( const ScAutoFormatDataField& rCopy );
  97     ~ScAutoFormatDataField();
  98
  99     // block assignment operator
 100     ScAutoFormatDataField& operator=(const ScAutoFormatDataField& rRef) = delete;
 101
 102     // number format
 103     const ScNumFormatAbbrev&    GetNumFormat() const    { return aNumFormat; }
 104
 105     // number format
 106     void    SetNumFormat( const ScNumFormatAbbrev& rNumFormat )     { aNumFormat = rNumFormat; }
 107
 108     bool    Load( SvStream& rStream, const ScAfVersions& rVersions, sal_uInt16 nVer );
 109     bool    Save( SvStream& rStream, sal_uInt16 fileVersion );
 110 };
 111
 112 class SAL_DLLPUBLIC_RTTI ScAutoFormatData
 113 {
 114 private:
 115     OUString               aName;
 116     sal_uInt16                  nStrResId;
 117     // common flags of Calc and Writer
 118     bool                        bIncludeFont : 1;
 119     bool                        bIncludeJustify : 1;
 120     bool                        bIncludeFrame : 1;
 121     bool                        bIncludeBackground : 1;
 122
 123     // Calc specific flags
 124     bool                        bIncludeValueFormat : 1;
 125     bool                        bIncludeWidthHeight : 1;
 126
 127     // Writer-specific data
 128     AutoFormatSwBlob m_swFields;
 129
 130     std::array<std::unique_ptr<ScAutoFormatDataField>,16> ppDataField;
 131
 132     SAL_DLLPRIVATE ScAutoFormatDataField&       GetField( sal_uInt16 nIndex );
 133     SAL_DLLPRIVATE const ScAutoFormatDataField& GetField( sal_uInt16 nIndex ) const;
 134
 135 public:
 136     ScAutoFormatData();
 137     SC_DLLPUBLIC ScAutoFormatData( const ScAutoFormatData& rData );
 138     SC_DLLPUBLIC ~ScAutoFormatData();
 139
 140     void            SetName( const OUString& rName )              { aName = rName; nStrResId = USHRT_MAX; }
 141     const OUString& GetName() const { return aName; }
 142
 143     bool            GetIncludeValueFormat() const               { return bIncludeValueFormat; }
 144     bool            GetIncludeFont() const                      { return bIncludeFont; }
 145     bool            GetIncludeJustify() const                   { return bIncludeJustify; }
 146     bool            GetIncludeFrame() const                     { return bIncludeFrame; }
 147     bool            GetIncludeBackground() const                { return bIncludeBackground; }
 148     bool            GetIncludeWidthHeight() const               { return bIncludeWidthHeight; }
 149
 150     void            SetIncludeValueFormat( bool bValueFormat )  { bIncludeValueFormat = bValueFormat; }
 151     void            SetIncludeFont( bool bFont )                { bIncludeFont = bFont; }
 152     void            SetIncludeJustify( bool bJustify )          { bIncludeJustify = bJustify; }
 153     void            SetIncludeFrame( bool bFrame )              { bIncludeFrame = bFrame; }
 154     void            SetIncludeBackground( bool bBackground )    { bIncludeBackground = bBackground; }
 155     void            SetIncludeWidthHeight( bool bWidthHeight )  { bIncludeWidthHeight = bWidthHeight; }
 156
 157     const SfxPoolItem*          GetItem( sal_uInt16 nIndex, sal_uInt16 nWhich ) const;
 158     template<class T> const T*  GetItem( sal_uInt16 nIndex, TypedWhichId<T> nWhich ) const
 159     {
 160         return static_cast<const T*>(GetItem(nIndex, sal_uInt16(nWhich)));
 161     }
 162     void                        PutItem( sal_uInt16 nIndex, const SfxPoolItem& rItem );
 163     void                        CopyItem( sal_uInt16 nToIndex, sal_uInt16 nFromIndex, sal_uInt16 nWhich );
 164
 165     const ScNumFormatAbbrev&    GetNumFormat( sal_uInt16 nIndex ) const;
 166
 167     bool                        HasSameData( sal_uInt16 nIndex1, sal_uInt16 nIndex2 ) const;
 168
 169     void                        FillToItemSet( sal_uInt16 nIndex, SfxItemSet& rItemSet, const ScDocument& rDoc ) const;
 170     void                        GetFromItemSet( sal_uInt16 nIndex, const SfxItemSet& rItemSet, const ScNumFormatAbbrev& rNumFormat );
 171
 172     bool                        Load( SvStream& rStream, const ScAfVersions& rVersions );
 173     bool                        Save( SvStream& rStream, sal_uInt16 fileVersion );
 174 };
 175
 176 struct DefaultFirstEntry {
 177     bool operator() (const OUString& left, const OUString& right) const;
 178 };
 179
 180 class SAL_DLLPUBLIC_RTTI ScAutoFormat
 181 {
 182     typedef std::map<OUString, std::unique_ptr<ScAutoFormatData>, DefaultFirstEntry> MapType;
 183     MapType m_Data;
 184     bool mbSaveLater;
 185     ScAfVersions m_aVersions;
 186
 187     ScAutoFormat(const ScAutoFormat&) = delete;
 188     const ScAutoFormat operator=(const ScAutoFormat&) = delete;
 189
 190 public:
 191     typedef MapType::const_iterator const_iterator;
 192     typedef MapType::iterator iterator;
 193
 194     ScAutoFormat();
 195     void Load();
 196     SC_DLLPUBLIC bool Save();
 197
 198     void SetSaveLater( bool bSet );
 199     bool IsSaveLater() const { return mbSaveLater; }
 200
 201     const ScAutoFormatData* findByIndex(size_t nIndex) const;
 202     SC_DLLPUBLIC ScAutoFormatData* findByIndex(size_t nIndex);
 203     SC_DLLPUBLIC iterator find(const OUString& rName);
 204
 205     SC_DLLPUBLIC iterator insert(std::unique_ptr<ScAutoFormatData> pNew);
 206     SC_DLLPUBLIC void erase(const iterator& it);
 207
 208     SC_DLLPUBLIC size_t size() const;
 209     const_iterator begin() const;
 210     const_iterator end() const;
 211     SC_DLLPUBLIC iterator begin();
 212     SC_DLLPUBLIC iterator end();
 213 };
 214
 215 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */