sc/source/filter/inc/excrecds.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_SC_SOURCE_FILTER_INC_EXCRECDS_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_EXCRECDS_HXX
  22
  23 #include <rtl/string.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include <svl/zforlist.hxx>
  26 #include <tools/solar.h>
  27 #include <tools/color.hxx>
  28 #include <vcl/vclenum.hxx>
  29
  30 #include "olinetab.hxx"
  31 #include "filter.hxx"
  32 #include "rangelst.hxx"
  33 #include "xerecord.hxx"
  34 #include "xeroot.hxx"
  35 #include "xeformula.hxx"
  36 #include "xestring.hxx"
  37 #include "root.hxx"
  38 #include "excdefs.hxx"
  39 #include <memory>
  40 #include <vector>
  41
  42 //------------------------------------------------------------------ Forwards -
  43
  44 class ScDBData;
  45 struct ScQueryEntry;
  46
  47 //----------------------------------------------------------- class ExcRecord -
  48
  49 class ExcRecord : public XclExpRecord
  50 {
  51 public:
  52     virtual void            Save( XclExpStream& rStrm ) override;
  53     virtual void            SaveXml( XclExpXmlStream& rStrm ) override;
  54
  55     virtual sal_uInt16          GetNum() const = 0;
  56     virtual sal_Size        GetLen() const = 0;
  57
  58 protected:
  59     virtual void            SaveCont( XclExpStream& rStrm );
  60
  61 private:
  62     /** Writes the body of the record. */
  63     virtual void            WriteBody( XclExpStream& rStrm ) override;
  64 };
  65
  66 //--------------------------------------------------------- class ExcEmptyRec -
  67
  68 class ExcEmptyRec : public ExcRecord
  69 {
  70 private:
  71 protected:
  72 public:
  73     virtual void            Save( XclExpStream& rStrm ) override;
  74     virtual sal_uInt16          GetNum() const override;
  75     virtual sal_Size        GetLen() const override;
  76 };
  77
  78 //--------------------------------------------------------- class ExcDummyRec -
  79
  80 class ExcDummyRec : public ExcRecord
  81 {
  82 protected:
  83 public:
  84     virtual void            Save( XclExpStream& rStrm ) override;
  85     virtual sal_uInt16          GetNum() const override;
  86     virtual const sal_uInt8*        GetData() const = 0;    // byte data must contain header and body
  87 };
  88
  89 //------------------------------------------------------- class ExcBoolRecord -
  90 // stores bool as 16bit val ( 0x0000 | 0x0001 )
  91
  92 class ExcBoolRecord : public ExcRecord
  93 {
  94 private:
  95     virtual void            SaveCont( XclExpStream& rStrm ) override;
  96
  97 protected:
  98     bool                    bVal;
  99
 100     inline                  ExcBoolRecord() : bVal( false ) {}
 101
 102 public:
 103     virtual sal_Size        GetLen() const override;
 104 };
 105
 106 //--------------------------------------------------------- class ExcBof_Base -
 107
 108 class ExcBof_Base : public ExcRecord
 109 {
 110 private:
 111 protected:
 112     sal_uInt16                  nDocType;
 113     sal_uInt16                  nVers;
 114     sal_uInt16                  nRupBuild;
 115     sal_uInt16                  nRupYear;
 116 public:
 117                             ExcBof_Base();
 118 };
 119
 120 //-------------------------------------------------------------- class ExcBof -
 121 // Header Record fuer WORKSHEETS
 122
 123 class ExcBof : public ExcBof_Base
 124 {
 125 private:
 126     virtual void            SaveCont( XclExpStream& rStrm ) override;
 127 public:
 128                             ExcBof();
 129
 130     virtual sal_uInt16          GetNum() const override;
 131     virtual sal_Size        GetLen() const override;
 132 };
 133
 134 //------------------------------------------------------------- class ExcBofW -
 135 // Header Record fuer WORKBOOKS
 136
 137 class ExcBofW : public ExcBof_Base
 138 {
 139 private:
 140     virtual void            SaveCont( XclExpStream& rStrm ) override;
 141 public:
 142                             ExcBofW();
 143
 144     virtual sal_uInt16          GetNum() const override;
 145     virtual sal_Size        GetLen() const override;
 146 };
 147
 148 //-------------------------------------------------------------- class ExcEof -
 149
 150 class ExcEof : public ExcRecord
 151 {
 152 private:
 153 public:
 154     virtual sal_uInt16          GetNum() const override;
 155     virtual sal_Size        GetLen() const override;
 156 };
 157
 158 //--------------------------------------------------------- class ExcDummy_00 -
 159 // INTERFACEHDR to FNGROUPCOUNT (see excrecds.cxx)
 160
 161 class ExcDummy_00 : public ExcDummyRec
 162 {
 163 private:
 164     static const sal_uInt8      pMyData[];
 165     static const sal_Size   nMyLen;
 166 public:
 167     virtual sal_Size        GetLen() const override;
 168     virtual const sal_uInt8*        GetData() const override;
 169 };
 170
 171 // EXC_ID_WINDOWPROTECTION
 172 class XclExpWindowProtection : public   XclExpBoolRecord
 173 {
 174     public:
 175         XclExpWindowProtection(bool bValue);
 176
 177     virtual void            SaveXml( XclExpXmlStream& rStrm ) override;
 178 };
 179
 180 // EXC_ID_PROTECT  Document Protection
 181 class XclExpProtection : public XclExpBoolRecord
 182 {
 183     public:
 184         XclExpProtection(bool bValue);
 185 };
 186
 187 class XclExpSheetProtection : public XclExpProtection
 188 {
 189     SCTAB                   mnTab;
 190     public:
 191         XclExpSheetProtection(bool bValue, SCTAB nTab);
 192     virtual void            SaveXml( XclExpXmlStream& rStrm ) override;
 193 };
 194
 195 class XclExpPassHash : public XclExpRecord
 196 {
 197 public:
 198     XclExpPassHash(const css::uno::Sequence<sal_Int8>& aHash);
 199     virtual ~XclExpPassHash();
 200
 201 private:
 202     virtual void    WriteBody(XclExpStream& rStrm) override;
 203
 204 private:
 205     sal_uInt16  mnHash;
 206 };
 207
 208 //-------------------------------------------------------- class ExcDummy_04x -
 209 // PASSWORD to BOOKBOOL (see excrecds.cxx), no 1904
 210
 211 class ExcDummy_040 : public ExcDummyRec
 212 {
 213 private:
 214     static const sal_uInt8      pMyData[];
 215     static const sal_Size   nMyLen;
 216 public:
 217     virtual sal_Size        GetLen() const override;
 218     virtual const sal_uInt8*        GetData() const override;
 219 };
 220
 221 class ExcDummy_041 : public ExcDummyRec
 222 {
 223 private:
 224     static const sal_uInt8      pMyData[];
 225     static const sal_Size   nMyLen;
 226 public:
 227     virtual sal_Size        GetLen() const override;
 228     virtual const sal_uInt8*        GetData() const override;
 229 };
 230
 231 //------------------------------------------------------------- class Exc1904 -
 232
 233 class Exc1904 : public ExcBoolRecord
 234 {
 235 public:
 236                             Exc1904( ScDocument& rDoc );
 237     virtual sal_uInt16          GetNum() const override;
 238
 239     virtual void            SaveXml( XclExpXmlStream& rStrm ) override;
 240 private:
 241     bool                    bDateCompatibility;
 242 };
 243
 244 //------------------------------------------------------ class ExcBundlesheet -
 245
 246 class ExcBundlesheetBase : public ExcRecord
 247 {
 248 protected:
 249     sal_uInt64              m_nStrPos;
 250     sal_uInt64              m_nOwnPos;    // Position after # and Len
 251     sal_uInt16                  nGrbit;
 252     SCTAB                   nTab;
 253
 254                             ExcBundlesheetBase();
 255
 256 public:
 257                             ExcBundlesheetBase( RootData& rRootData, SCTAB nTab );
 258
 259     inline void             SetStreamPos(sal_uInt64 const nStrPos) { m_nStrPos = nStrPos; }
 260     void                    UpdateStreamPos( XclExpStream& rStrm );
 261
 262     virtual sal_uInt16          GetNum() const override;
 263 };
 264
 265 class ExcBundlesheet : public ExcBundlesheetBase
 266 {
 267 private:
 268     OString            aName;
 269
 270     virtual void            SaveCont( XclExpStream& rStrm ) override;
 271
 272 public:
 273                             ExcBundlesheet( RootData& rRootData, SCTAB nTab );
 274     virtual sal_Size        GetLen() const override;
 275 };
 276
 277 //--------------------------------------------------------- class ExcDummy_02 -
 278 // sheet dummies: CALCMODE to SETUP
 279
 280 class ExcDummy_02a : public ExcDummyRec
 281 {
 282 private:
 283     static const sal_uInt8      pMyData[];
 284     static const sal_Size   nMyLen;
 285 public:
 286     virtual sal_Size        GetLen() const override;
 287     virtual const sal_uInt8*        GetData() const override;
 288 };
 289
 290 /** This record contains the Windows country IDs for the UI and document language. */
 291 class XclExpCountry : public XclExpRecord
 292 {
 293 public:
 294     explicit                    XclExpCountry( const XclExpRoot& rRoot );
 295
 296 private:
 297     sal_uInt16                  mnUICountry;        /// The UI country ID.
 298     sal_uInt16                  mnDocCountry;       /// The document country ID.
 299
 300     /** Writes the body of the COUNTRY record. */
 301     virtual void                WriteBody( XclExpStream& rStrm ) override;
 302 };
 303
 304 // XclExpWsbool ===============================================================
 305
 306 class XclExpWsbool : public XclExpUInt16Record
 307 {
 308 public:
 309     explicit XclExpWsbool( bool bFitToPages );
 310 };
 311
 312 /**
 313  * Save sheetPr element and its children for xlsx export.
 314  */
 315 class XclExpXmlSheetPr : public XclExpRecordBase
 316 {
 317 public:
 318     explicit XclExpXmlSheetPr(
 319         bool bFitToPages, SCTAB nScTab, const Color& rTabColor, XclExpFilterManager* pManager );
 320
 321     virtual void SaveXml( XclExpXmlStream& rStrm ) override;
 322
 323 private:
 324     SCTAB mnScTab;
 325     XclExpFilterManager* mpManager;
 326     bool mbFitToPage;
 327     Color maTabColor;
 328 };
 329
 330 class XclExpFiltermode : public XclExpEmptyRecord
 331 {
 332 public:
 333     explicit            XclExpFiltermode();
 334 };
 335
 336 class XclExpAutofilterinfo : public XclExpUInt16Record
 337 {
 338 public:
 339     explicit            XclExpAutofilterinfo( const ScAddress& rStartPos, SCCOL nScCol );
 340
 341     inline const ScAddress& GetStartPos() const { return maStartPos; }
 342     inline SCCOL        GetColCount() const { return static_cast< SCCOL >( GetValue() ); }
 343
 344 private:
 345     ScAddress           maStartPos;
 346 };
 347
 348 class ExcFilterCondition
 349 {
 350 private:
 351     sal_uInt8               nType;
 352     sal_uInt8               nOper;
 353     double                  fVal;
 354     XclExpString*           pText;
 355
 356 protected:
 357 public:
 358                             ExcFilterCondition();
 359                             ~ExcFilterCondition();
 360
 361     inline bool             IsEmpty() const     { return (nType == EXC_AFTYPE_NOTUSED); }
 362     sal_uLong               GetTextBytes() const;
 363
 364     void                    SetCondition( sal_uInt8 nTp, sal_uInt8 nOp, double fV, OUString* pT );
 365
 366     void                    Save( XclExpStream& rStrm );
 367     void                    SaveXml( XclExpXmlStream& rStrm );
 368     void                    SaveText( XclExpStream& rStrm );
 369 };
 370
 371 class XclExpAutofilter : public XclExpRecord, protected XclExpRoot
 372 {
 373 private:
 374     enum FilterType { FilterCondition, MultiValue };
 375     FilterType              meType;
 376     sal_uInt16              nCol;
 377     sal_uInt16              nFlags;
 378     ExcFilterCondition      aCond[ 2 ];
 379     std::vector<OUString> maMultiValues;
 380
 381     bool                    AddCondition( ScQueryConnect eConn, sal_uInt8 nType,
 382                                 sal_uInt8 nOp, double fVal, OUString* pText,
 383                                 bool bSimple = false );
 384
 385     virtual void            WriteBody( XclExpStream& rStrm ) override;
 386
 387 public:
 388                             XclExpAutofilter( const XclExpRoot& rRoot, sal_uInt16 nC );
 389
 390     inline sal_uInt16       GetCol() const          { return nCol; }
 391     inline bool             HasTop10() const        { return ::get_flag( nFlags, EXC_AFFLAG_TOP10 ); }
 392
 393     bool                    HasCondition() const;
 394     bool                    AddEntry( const ScQueryEntry& rEntry );
 395     bool                    AddMultiValueEntry( const ScQueryEntry& rEntry );
 396
 397     virtual void            SaveXml( XclExpXmlStream& rStrm ) override;
 398 };
 399
 400 class ExcAutoFilterRecs : public XclExpRecordBase, protected XclExpRoot
 401 {
 402 public:
 403     /** @param  pDefinedData
 404                 If nullptr, obtain anonymous ScDBData from sheet nTab.
 405                 Else, use defined database range; used with XclExpTables.
 406      */
 407     explicit            ExcAutoFilterRecs( const XclExpRoot& rRoot, SCTAB nTab, const ScDBData* pDefinedData );
 408     virtual             ~ExcAutoFilterRecs();
 409
 410     void                AddObjRecs();
 411
 412     virtual void        Save( XclExpStream& rStrm ) override;
 413     virtual void        SaveXml( XclExpXmlStream& rStrm ) override;
 414
 415     bool                HasFilterMode() const;
 416
 417 private:
 418     XclExpAutofilter*   GetByCol( SCCOL nCol ); // always 0-based
 419     bool                IsFiltered( SCCOL nCol );
 420
 421 private:
 422     typedef XclExpRecordList< XclExpAutofilter >    XclExpAutofilterList;
 423     typedef XclExpAutofilterList::RecordRefType     XclExpAutofilterRef;
 424
 425     XclExpAutofilterList maFilterList;
 426     XclExpFiltermode*   pFilterMode;
 427     XclExpAutofilterinfo* pFilterInfo;
 428     ScRange                 maRef;
 429     bool mbAutoFilter;
 430 };
 431
 432 /** Sheet filter manager. Contains auto filters or advanced filters from all sheets. */
 433 class XclExpFilterManager : protected XclExpRoot
 434 {
 435 public:
 436     explicit            XclExpFilterManager( const XclExpRoot& rRoot );
 437
 438     /** Creates the filter records for the specified sheet.
 439         @descr  Creates and inserts related built-in NAME records. Therefore this
 440             function is called from the name buffer itself. */
 441     void                InitTabFilter( SCTAB nScTab );
 442
 443     /** Returns a record object containing all filter records for the specified sheet. */
 444     XclExpRecordRef     CreateRecord( SCTAB nScTab );
 445
 446     /** Returns whether or not FilterMode is present */
 447     bool                HasFilterMode( SCTAB nScTab );
 448
 449 private:
 450     using               XclExpRoot::CreateRecord;
 451
 452     typedef std::shared_ptr< ExcAutoFilterRecs >  XclExpTabFilterRef;
 453     typedef ::std::map< SCTAB, XclExpTabFilterRef > XclExpTabFilterMap;
 454
 455     XclExpTabFilterMap  maFilterMap;
 456 };
 457
 458 #endif
 459
 460 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */