sc/source/filter/inc/XclExpChangeTrack.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_XCLEXPCHANGETRACK_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_XCLEXPCHANGETRACK_HXX
  22
  23 #include <stack>
  24 #include <tools/datetime.hxx>
  25 #include <rtl/uuid.h>
  26 #include "bigrange.hxx"
  27 #include "chgtrack.hxx"
  28 #include "xelink.hxx"
  29 #include "ftools.hxx"
  30 #include "excrecds.hxx"
  31
  32 class ExcXmlRecord : public ExcRecord
  33 {
  34 public:
  35     virtual sal_Size    GetLen() const override;
  36     virtual sal_uInt16  GetNum() const override;
  37     virtual void        Save( XclExpStream& rStrm ) override;
  38 };
  39
  40 // XclExpUserBView - one UserBView record for each user
  41
  42 class XclExpUserBView : public ExcRecord
  43 {
  44 private:
  45     XclExpString                sUsername;
  46     sal_uInt8                   aGUID[ 16 ];
  47
  48     virtual void                SaveCont( XclExpStream& rStrm ) override;
  49
  50 public:
  51                                 XclExpUserBView( const OUString& rUsername, const sal_uInt8* pGUID );
  52
  53     inline const sal_uInt8*     GetGUID() const { return aGUID; }
  54
  55     virtual sal_uInt16              GetNum() const override;
  56     virtual sal_Size            GetLen() const override;
  57 };
  58
  59 // XclExpUserBViewList - list of UserBView records
  60
  61 class XclExpUserBViewList : public ExcEmptyRec
  62 {
  63 private:
  64     std::vector<XclExpUserBView*> aViews;
  65
  66 public:
  67
  68     typedef std::vector<XclExpUserBView*>::iterator iterator;
  69     typedef std::vector<XclExpUserBView*>::const_iterator const_iterator;
  70
  71                                 XclExpUserBViewList( const ScChangeTrack& rChangeTrack );
  72     virtual                     ~XclExpUserBViewList();
  73
  74     inline iterator begin () { return aViews.begin(); }
  75     inline iterator end () { return aViews.end(); }
  76
  77     virtual void                Save( XclExpStream& rStrm ) override;
  78 };
  79
  80 // XclExpUsersViewBegin - begin of view block (one per sheet)
  81
  82 class XclExpUsersViewBegin : public ExcRecord
  83 {
  84 private:
  85     sal_uInt8                   aGUID[ 16 ];
  86     sal_uInt32                  nCurrTab;
  87
  88     virtual void                SaveCont( XclExpStream& rStrm ) override;
  89
  90 public:
  91                                 XclExpUsersViewBegin( const sal_uInt8* pGUID, sal_uInt32 nTab );
  92     virtual sal_uInt16              GetNum() const override;
  93     virtual sal_Size            GetLen() const override;
  94 };
  95
  96 // XclExpUsersViewEnd - end of view block (one per sheet)
  97
  98 class XclExpUsersViewEnd : public ExcRecord
  99 {
 100 private:
 101     virtual void                SaveCont( XclExpStream& rStrm ) override;
 102
 103 public:
 104     virtual sal_uInt16              GetNum() const override;
 105     virtual sal_Size            GetLen() const override;
 106 };
 107
 108 // dummy record for "User Names" stream
 109
 110 class XclExpChTr0x0191 : public ExcRecord
 111 {
 112 private:
 113     virtual void                SaveCont( XclExpStream& rStrm ) override;
 114
 115 public:
 116     virtual sal_uInt16              GetNum() const override;
 117     virtual sal_Size            GetLen() const override;
 118 };
 119
 120 // dummy record for "User Names" stream
 121
 122 class XclExpChTr0x0198 : public ExcRecord
 123 {
 124 private:
 125     virtual void                SaveCont( XclExpStream& rStrm ) override;
 126
 127 public:
 128     virtual sal_uInt16              GetNum() const override;
 129     virtual sal_Size            GetLen() const override;
 130 };
 131
 132 // dummy record for "User Names" stream
 133
 134 class XclExpChTr0x0192 : public ExcRecord
 135 {
 136 private:
 137     virtual void                SaveCont( XclExpStream& rStrm ) override;
 138
 139 public:
 140     virtual sal_uInt16              GetNum() const override;
 141     virtual sal_Size            GetLen() const override;
 142 };
 143
 144 // dummy record for "User Names" stream
 145
 146 class XclExpChTr0x0197 : public ExcRecord
 147 {
 148 private:
 149     virtual void                SaveCont( XclExpStream& rStrm ) override;
 150
 151 public:
 152     virtual sal_uInt16              GetNum() const override;
 153     virtual sal_Size            GetLen() const override;
 154 };
 155
 156 // dummy record without content
 157
 158 class XclExpChTrEmpty : public ExcRecord
 159 {
 160 private:
 161     sal_uInt16                      nRecNum;
 162
 163 public:
 164     inline                      XclExpChTrEmpty( sal_uInt16 nNum ) : nRecNum( nNum ) {}
 165     virtual                     ~XclExpChTrEmpty();
 166
 167     virtual sal_uInt16              GetNum() const override;
 168     virtual sal_Size            GetLen() const override;
 169 };
 170
 171 // dummy record for "Revision Log" stream
 172
 173 class XclExpChTr0x0195 : public ExcRecord
 174 {
 175 private:
 176     virtual void                SaveCont( XclExpStream& rStrm ) override;
 177
 178 public:
 179     virtual                     ~XclExpChTr0x0195();
 180
 181     virtual sal_uInt16              GetNum() const override;
 182     virtual sal_Size            GetLen() const override;
 183 };
 184
 185 // dummy record for "Revision Log" stream
 186
 187 class XclExpChTr0x0194 : public ExcRecord
 188 {
 189 private:
 190     XclExpString                sUsername;
 191     DateTime                    aDateTime;
 192
 193     virtual void                SaveCont( XclExpStream& rStrm ) override;
 194
 195 public:
 196     inline                      XclExpChTr0x0194( const ScChangeTrack& rChangeTrack );
 197     virtual                     ~XclExpChTr0x0194();
 198
 199     virtual sal_uInt16              GetNum() const override;
 200     virtual sal_Size            GetLen() const override;
 201 };
 202
 203 inline XclExpChTr0x0194::XclExpChTr0x0194( const ScChangeTrack& rChangeTrack ) :
 204     sUsername( rChangeTrack.GetUser() ),
 205     aDateTime( rChangeTrack.GetFixDateTime() )
 206 {
 207 }
 208
 209 // XclExpChTrHeader - header record, includes action count
 210
 211 class XclExpChTrHeader : public ExcRecord
 212 {
 213 private:
 214     sal_uInt8                   aGUID[ 16 ];
 215     sal_uInt32                  nCount;
 216
 217     virtual void                SaveCont( XclExpStream& rStrm ) override;
 218
 219 public:
 220     inline                      XclExpChTrHeader() : nCount( 0 ) {}
 221     virtual                     ~XclExpChTrHeader();
 222
 223     inline void                 SetGUID( const sal_uInt8* pGUID )   { memcpy( aGUID, pGUID, 16 ); }
 224     inline void                 SetCount( sal_uInt32 nNew )         { nCount = nNew; }
 225
 226     virtual sal_uInt16              GetNum() const override;
 227     virtual sal_Size            GetLen() const override;
 228
 229     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 230 };
 231
 232 class XclExpXmlChTrHeaders : public ExcXmlRecord
 233 {
 234     sal_uInt8 maGUID[16];
 235 public:
 236     void SetGUID( const sal_uInt8* pGUID );
 237
 238     virtual void SaveXml( XclExpXmlStream& rStrm ) override;
 239 };
 240
 241 class XclExpChTrTabIdBuffer;
 242 class XclExpChTrAction;
 243
 244 class XclExpXmlChTrHeader : public ExcXmlRecord
 245 {
 246     OUString maUserName;
 247     DateTime maDateTime;
 248     sal_uInt8 maGUID[16];
 249     sal_Int32 mnLogNumber;
 250     sal_uInt32 mnMinAction;
 251     sal_uInt32 mnMaxAction;
 252
 253     std::vector<sal_uInt16> maTabBuffer;
 254     std::vector<std::unique_ptr<XclExpChTrAction>> maActions;
 255
 256 public:
 257     XclExpXmlChTrHeader(
 258         const OUString& rUserName, const DateTime& rDateTime, const sal_uInt8* pGUID,
 259         sal_Int32 nLogNumber, const XclExpChTrTabIdBuffer& rBuf );
 260
 261     virtual void SaveXml( XclExpXmlStream& rStrm ) override;
 262
 263     void AppendAction( std::unique_ptr<XclExpChTrAction> pAction );
 264 };
 265
 266 // XclExpChTrInfo - header of action group of a user
 267
 268 class XclExpChTrInfo : public ExcRecord
 269 {
 270 private:
 271     XclExpString                sUsername;
 272     DateTime                    aDateTime;
 273     sal_uInt8                   aGUID[ 16 ];
 274
 275     virtual void                SaveCont( XclExpStream& rStrm ) override;
 276
 277 public:
 278     XclExpChTrInfo( const OUString& rUsername, const DateTime& rDateTime,
 279                     const sal_uInt8* pGUID );
 280
 281     virtual                     ~XclExpChTrInfo();
 282
 283     virtual sal_uInt16              GetNum() const override;
 284     virtual sal_Size            GetLen() const override;
 285 };
 286
 287 // XclExpChTrTabIdBuffer - buffer for tab id's
 288
 289 class XclExpChTrTabIdBuffer
 290 {
 291 private:
 292     sal_uInt16*                 pBuffer;
 293     sal_uInt16*                 pLast;
 294     sal_uInt16                  nBufSize;
 295     sal_uInt16                  nLastId;
 296
 297 public:
 298                                 XclExpChTrTabIdBuffer( sal_uInt16 nCount );
 299                                 XclExpChTrTabIdBuffer( const XclExpChTrTabIdBuffer& rCopy );
 300                                 ~XclExpChTrTabIdBuffer();
 301
 302     void                        InitFill( sal_uInt16 nIndex );
 303     void                        InitFillup();
 304
 305     sal_uInt16                  GetId( sal_uInt16 nIndex ) const;
 306     void                        Remove();
 307
 308     inline sal_uInt16           GetBufferCount() const
 309                                     { return static_cast< sal_uInt16 >( (pLast - pBuffer) + 1 ); }
 310     inline void                 GetBufferCopy( sal_uInt16* pDest ) const
 311                                     { memcpy( pDest, pBuffer, sizeof(sal_uInt16) * GetBufferCount() ); }
 312 };
 313
 314 // XclExpChTrTabId - tab id record
 315
 316 class XclExpChTrTabId : public ExcRecord
 317 {
 318 private:
 319     sal_uInt16*                 pBuffer;
 320     sal_uInt16                  nTabCount;
 321
 322     inline void                 Clear() { delete[] pBuffer; pBuffer = nullptr; }
 323
 324     virtual void                SaveCont( XclExpStream& rStrm ) override;
 325
 326 public:
 327     inline                      XclExpChTrTabId( sal_uInt16 nCount ) :
 328                                     pBuffer( nullptr ), nTabCount( nCount ) {}
 329                                 XclExpChTrTabId( const XclExpChTrTabIdBuffer& rBuffer );
 330     virtual                     ~XclExpChTrTabId();
 331
 332     void                        Copy( const XclExpChTrTabIdBuffer& rBuffer );
 333
 334     virtual sal_uInt16              GetNum() const override;
 335     virtual sal_Size            GetLen() const override;
 336 };
 337
 338 // XclExpChTrAction - base class for action records
 339
 340 class XclExpChTrAction : public ExcRecord
 341 {
 342 private:
 343     OUString                    sUsername;
 344     DateTime                    aDateTime;
 345     sal_uInt32                  nIndex;         // action number
 346     XclExpChTrAction*           pAddAction;     // additional record for this action
 347     bool                        bAccepted;
 348
 349 protected:
 350     const XclExpTabInfo&        rTabInfo;       // for table num export (sc num -> xcl num)
 351     const XclExpChTrTabIdBuffer& rIdBuffer;     // for table num export (xcl num -> tab id)
 352     sal_uInt32                  nLength;        // this is not the record size
 353     sal_uInt16                  nOpCode;        // EXC_CHTR_OP_***
 354     bool                        bForceInfo;
 355
 356                                 XclExpChTrAction( const XclExpChTrAction& rCopy );
 357
 358     void                        SetAddAction( XclExpChTrAction* pAction );
 359     void                        AddDependentContents(
 360                                     const ScChangeAction& rAction,
 361                                     const XclExpRoot& rRoot,
 362                                     ScChangeTrack& rChangeTrack );
 363
 364     static inline void          Write2DAddress( XclExpStream& rStrm, const ScAddress& rAddress );
 365     static inline void          Write2DRange( XclExpStream& rStrm, const ScRange& rRange );
 366     inline sal_uInt16           GetTabId( SCTAB nTabId ) const;
 367     inline void                 WriteTabId( XclExpStream& rStrm, SCTAB nTabId ) const;
 368
 369                                 // save header data, call SaveActionData()
 370     virtual void                SaveCont( XclExpStream& rStrm ) override;
 371     static inline sal_Size      GetHeaderByteCount() { return 12; }
 372
 373                                 // override to save action data without header, called by SaveCont()
 374     virtual void                SaveActionData( XclExpStream& rStrm ) const = 0;
 375                                 // override to get action size without header, called by GetLen()
 376     virtual sal_Size            GetActionByteCount() const = 0;
 377
 378                                 // do something before writing the record
 379     virtual void                PrepareSaveAction( XclExpStream& rStrm ) const;
 380                                 // do something after writing the record
 381     virtual void                CompleteSaveAction( XclExpStream& rStrm ) const;
 382
 383     inline bool                 GetAccepted() const { return bAccepted; }
 384
 385 public:
 386                                 XclExpChTrAction(
 387                                     const ScChangeAction& rAction,
 388                                     const XclExpRoot& rRoot,
 389                                     const XclExpChTrTabIdBuffer& rTabIdBuffer,
 390                                     sal_uInt16 nNewOpCode = EXC_CHTR_OP_UNKNOWN );
 391     virtual                     ~XclExpChTrAction();
 392
 393     inline const OUString&      GetUsername() const             { return sUsername; }
 394     inline const DateTime&      GetDateTime() const             { return aDateTime; }
 395     inline const XclExpChTrTabIdBuffer& GetTabIdBuffer() const  { return rIdBuffer; }
 396     inline bool                 ForceInfoRecord() const         { return bForceInfo; }
 397
 398                                 // set own index & return new index
 399                                 // could override to use more indexes per action
 400     void                        SetIndex( sal_uInt32& rIndex );
 401
 402     virtual void                Save( XclExpStream& rStrm ) override;
 403     virtual sal_Size            GetLen() const override;
 404
 405     inline XclExpChTrAction*    GetAddAction() { return pAddAction; }
 406     inline sal_uInt32           GetActionNumber() const { return nIndex; }
 407 };
 408
 409 inline void XclExpChTrAction::Write2DAddress( XclExpStream& rStrm, const ScAddress& rAddress )
 410 {
 411     rStrm   << (sal_uInt16) rAddress.Row()
 412             << (sal_uInt16) rAddress.Col();
 413 }
 414
 415 inline void XclExpChTrAction::Write2DRange( XclExpStream& rStrm, const ScRange& rRange )
 416 {
 417     rStrm   << (sal_uInt16) rRange.aStart.Row()
 418             << (sal_uInt16) rRange.aEnd.Row()
 419             << (sal_uInt16) rRange.aStart.Col()
 420             << (sal_uInt16) rRange.aEnd.Col();
 421 }
 422
 423 inline sal_uInt16 XclExpChTrAction::GetTabId( SCTAB nTab ) const
 424 {
 425     return rIdBuffer.GetId( rTabInfo.GetXclTab( nTab ) );
 426 }
 427
 428 inline void XclExpChTrAction::WriteTabId( XclExpStream& rStrm, SCTAB nTab ) const
 429 {
 430     rStrm << GetTabId( nTab );
 431 }
 432
 433 // XclExpChTrData - cell content itself
 434
 435 struct XclExpChTrData
 436 {
 437     XclExpString*               pString;
 438     XclExpStringRef             mpFormattedString;
 439     const ScFormulaCell*        mpFormulaCell;
 440     XclTokenArrayRef            mxTokArr;
 441     XclExpRefLog                maRefLog;
 442     double                      fValue;
 443     sal_Int32                   nRKValue;
 444     sal_uInt16                  nType;
 445     sal_Size                    nSize;
 446
 447                                 XclExpChTrData();
 448                                 ~XclExpChTrData();
 449     void                        Clear();
 450
 451     void                        WriteFormula(
 452                                     XclExpStream& rStrm,
 453                                     const XclExpChTrTabIdBuffer& rTabIdBuffer );
 454     void                        Write(
 455                                     XclExpStream& rStrm,
 456                                     const XclExpChTrTabIdBuffer& rTabIdBuffer );
 457 };
 458
 459 // XclExpChTrCellContent - changed cell content
 460
 461 class XclExpChTrCellContent : public XclExpChTrAction, protected XclExpRoot
 462 {
 463 private:
 464     XclExpChTrData*             pOldData;
 465     XclExpChTrData*             pNewData;
 466     sal_uInt16                  nOldLength;     // this is not the record size
 467
 468     static void                 MakeEmptyChTrData( XclExpChTrData*& rpData );
 469
 470 protected:
 471     ScAddress                   aPosition;
 472
 473     void GetCellData(
 474         const XclExpRoot& rRoot, const ScCellValue& rScCell, XclExpChTrData*& rpData,
 475         sal_uInt32& rXclLength1, sal_uInt16& rXclLength2 );
 476
 477     virtual void                SaveActionData( XclExpStream& rStrm ) const override;
 478
 479 public:
 480                                 XclExpChTrCellContent(
 481                                     const ScChangeActionContent& rAction,
 482                                     const XclExpRoot& rRoot,
 483                                     const XclExpChTrTabIdBuffer& rTabIdBuffer );
 484     virtual                     ~XclExpChTrCellContent();
 485
 486     virtual sal_uInt16              GetNum() const override;
 487     virtual sal_Size            GetActionByteCount() const override;
 488
 489     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 490 };
 491
 492 // XclExpChTrInsert - insert/delete columns/rows
 493
 494 class XclExpChTrInsert : public XclExpChTrAction
 495 {
 496     bool mbEndOfList;
 497
 498 protected:
 499     ScRange                     aRange;
 500
 501     XclExpChTrInsert( const XclExpChTrInsert& rCopy );
 502
 503     virtual void                SaveActionData( XclExpStream& rStrm ) const override;
 504     virtual void                PrepareSaveAction( XclExpStream& rStrm ) const override;
 505     virtual void                CompleteSaveAction( XclExpStream& rStrm ) const override;
 506
 507 public:
 508                                 XclExpChTrInsert(
 509                                     const ScChangeAction& rAction,
 510                                     const XclExpRoot& rRoot,
 511                                     const XclExpChTrTabIdBuffer& rTabIdBuffer,
 512                                     ScChangeTrack& rChangeTrack );
 513     virtual                     ~XclExpChTrInsert();
 514
 515     virtual sal_uInt16              GetNum() const override;
 516     virtual sal_Size            GetActionByteCount() const override;
 517
 518     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 519 };
 520
 521 // XclExpChTrInsertTab - insert table
 522
 523 class XclExpChTrInsertTab : public XclExpChTrAction, protected XclExpRoot
 524 {
 525 private:
 526     SCTAB                   nTab;
 527
 528 protected:
 529     virtual void                SaveActionData( XclExpStream& rStrm ) const override;
 530
 531 public:
 532                                 XclExpChTrInsertTab(
 533                                     const ScChangeAction& rAction,
 534                                     const XclExpRoot& rRoot,
 535                                     const XclExpChTrTabIdBuffer& rTabIdBuffer );
 536     virtual                     ~XclExpChTrInsertTab();
 537
 538     virtual sal_uInt16              GetNum() const override;
 539     virtual sal_Size            GetActionByteCount() const override;
 540
 541     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 542 };
 543
 544 // XclExpChTrMoveRange - move cell range
 545
 546 class XclExpChTrMoveRange : public XclExpChTrAction
 547 {
 548 protected:
 549     ScRange                     aSourceRange;
 550     ScRange                     aDestRange;
 551
 552     virtual void                SaveActionData( XclExpStream& rStrm ) const override;
 553     virtual void                PrepareSaveAction( XclExpStream& rStrm ) const override;
 554     virtual void                CompleteSaveAction( XclExpStream& rStrm ) const override;
 555
 556 public:
 557                                 XclExpChTrMoveRange(
 558                                     const ScChangeActionMove& rAction,
 559                                     const XclExpRoot& rRoot,
 560                                     const XclExpChTrTabIdBuffer& rTabIdBuffer,
 561                                     ScChangeTrack& rChangeTrack );
 562     virtual                     ~XclExpChTrMoveRange();
 563
 564     virtual sal_uInt16              GetNum() const override;
 565     virtual sal_Size            GetActionByteCount() const override;
 566
 567     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 568 };
 569
 570 // XclExpChTr0x019A - additional data for delete action
 571
 572 class XclExpChTr0x014A : public XclExpChTrInsert
 573 {
 574 protected:
 575     virtual void                SaveActionData( XclExpStream& rStrm ) const override;
 576
 577 public:
 578                                 XclExpChTr0x014A( const XclExpChTrInsert& rAction );
 579     virtual                     ~XclExpChTr0x014A();
 580
 581     virtual sal_uInt16              GetNum() const override;
 582     virtual sal_Size            GetActionByteCount() const override;
 583
 584     virtual void                SaveXml( XclExpXmlStream& rStrm ) override;
 585 };
 586
 587 // XclExpChangeTrack - exports the "Revision Log" stream
 588
 589 class XclExpChangeTrack : protected XclExpRoot
 590 {
 591     typedef std::vector<std::unique_ptr<ExcRecord>> RecListType;
 592     typedef std::vector<std::unique_ptr<XclExpChTrTabIdBuffer>> TabIdBufferType;
 593     RecListType maRecList;           // list of "Revision Log" stream records
 594     std::stack<XclExpChTrAction*> aActionStack;
 595     XclExpChTrTabIdBuffer*        pTabIdBuffer;
 596     TabIdBufferType maBuffers;
 597
 598     ScDocument*                 pTempDoc;           // empty document
 599
 600     XclExpChTrHeader*           pHeader;            // header record for last GUID
 601     sal_uInt8                   aGUID[ 16 ];        // GUID for action info records
 602     bool                        bValidGUID;
 603
 604     ScChangeTrack*              CreateTempChangeTrack();
 605     void                        PushActionRecord( const ScChangeAction& rAction );
 606
 607     bool                        WriteUserNamesStream();
 608
 609 public:
 610                                 XclExpChangeTrack( const XclExpRoot& rRoot );
 611                                 virtual ~XclExpChangeTrack();
 612
 613     void                        Write();
 614     void                        WriteXml( XclExpXmlStream& rStrm );
 615 };
 616
 617 #endif
 618
 619 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */