sc/source/core/data/dpcache.cxx

   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 #include "dpcache.hxx"
  21
  22 #include "document.hxx"
  23 #include "queryentry.hxx"
  24 #include "queryparam.hxx"
  25 #include "dpglobal.hxx"
  26 #include "dpobject.hxx"
  27 #include "globstr.hrc"
  28 #include "docoptio.hxx"
  29 #include "dpitemdata.hxx"
  30 #include "dputil.hxx"
  31 #include "dpnumgroupinfo.hxx"
  32
  33 #include <rtl/math.hxx>
  34 #include <unotools/textsearch.hxx>
  35 #include <unotools/localedatawrapper.hxx>
  36 #include <svl/zforlist.hxx>
  37
  38 #include <memory>
  39
  40 using namespace ::com::sun::star;
  41
  42 using ::com::sun::star::uno::Exception;
  43 using ::com::sun::star::uno::Reference;
  44 using ::com::sun::star::uno::UNO_QUERY;
  45 using ::com::sun::star::uno::UNO_QUERY_THROW;
  46
  47 ScDPCache::GroupItems::GroupItems() : mnGroupType(0) {}
  48
  49 ScDPCache::GroupItems::GroupItems(const ScDPNumGroupInfo& rInfo, sal_Int32 nGroupType) :
  50     maInfo(rInfo), mnGroupType(nGroupType) {}
  51
  52 ScDPCache::Field::Field() : mnNumFormat(0) {}
  53
  54 ScDPCache::ScDPCache(ScDocument* pDoc) :
  55     mpDoc( pDoc ),
  56     mnColumnCount ( 0 ),
  57     maEmptyRows(0, MAXROW, true),
  58     mnDataSize(-1),
  59     mnRowCount(0),
  60     mbDisposing(false)
  61 {
  62 }
  63
  64 namespace {
  65
  66 struct ClearObjectSource : std::unary_function<ScDPObject*, void>
  67 {
  68     void operator() (ScDPObject* p) const
  69     {
  70         p->ClearTableData();
  71     }
  72 };
  73
  74 }
  75
  76 ScDPCache::~ScDPCache()
  77 {
  78     // Make sure no live ScDPObject instances hold reference to this cache any
  79     // more.
  80     mbDisposing = true;
  81     std::for_each(maRefObjects.begin(), maRefObjects.end(), ClearObjectSource());
  82 }
  83
  84 namespace {
  85
  86 /**
  87  * While the macro interpret level is incremented, the formula cells are
  88  * (semi-)guaranteed to be interpreted.
  89  */
  90 class MacroInterpretIncrementer
  91 {
  92 public:
  93     MacroInterpretIncrementer(ScDocument* pDoc) :
  94         mpDoc(pDoc)
  95     {
  96         mpDoc->IncMacroInterpretLevel();
  97     }
  98     ~MacroInterpretIncrementer()
  99     {
 100         mpDoc->DecMacroInterpretLevel();
 101     }
 102 private:
 103     ScDocument* mpDoc;
 104 };
 105
 106 OUString createLabelString(ScDocument* pDoc, SCCOL nCol, SCROW nRow, SCTAB nTab)
 107 {
 108     OUString aDocStr = pDoc->GetString(nCol, nRow, nTab);
 109     if (aDocStr.isEmpty())
 110     {
 111         // Replace an empty label string with column name.
 112         OUStringBuffer aBuf;
 113         aBuf.append(ScGlobal::GetRscString(STR_COLUMN));
 114         aBuf.append(sal_Unicode(' '));
 115
 116         ScAddress aColAddr(nCol, 0, 0);
 117         OUString aColStr;
 118         aColAddr.Format(aColStr, SCA_VALID_COL, NULL);
 119         aBuf.append(aColStr);
 120         aDocStr = aBuf.makeStringAndClear();
 121     }
 122     return aDocStr;
 123 }
 124
 125 void initFromCell(
 126     ScDPCache& rCache, ScDocument* pDoc, SCCOL nCol, SCROW nRow, SCTAB nTab,
 127     ScDPItemData& rData, sal_uLong& rNumFormat)
 128 {
 129     OUString aDocStr = pDoc->GetString(nCol, nRow, nTab);
 130     rNumFormat = 0;
 131
 132     ScAddress aPos(nCol, nRow, nTab);
 133
 134     if (pDoc->GetErrCode(aPos))
 135     {
 136         rData.SetErrorString(rCache.InternString(aDocStr));
 137     }
 138     else if (pDoc->HasValueData(nCol, nRow, nTab))
 139     {
 140         double fVal = pDoc->GetValue(aPos);
 141         rNumFormat = pDoc->GetNumberFormat(aPos);
 142         rData.SetValue(fVal);
 143     }
 144     else if (pDoc->HasData(nCol, nRow, nTab))
 145     {
 146         rData.SetString(rCache.InternString(aDocStr));
 147     }
 148     else
 149         rData.SetEmpty();
 150 }
 151
 152 struct Bucket
 153 {
 154     ScDPItemData maValue;
 155     SCROW mnOrderIndex;
 156     SCROW mnDataIndex;
 157     SCROW mnValueSortIndex;
 158     Bucket(const ScDPItemData& rValue, SCROW nOrder, SCROW nData) :
 159         maValue(rValue), mnOrderIndex(nOrder), mnDataIndex(nData), mnValueSortIndex(0) {}
 160 };
 161
 162 #if DEBUG_PIVOT_TABLE
 163 #include <iostream>
 164 using std::cout;
 165 using std::endl;
 166
 167 struct PrintBucket : std::unary_function<Bucket, void>
 168 {
 169     void operator() (const Bucket& v) const
 170     {
 171         cout << "value: " << v.maValue.GetValue() << "  order index: " << v.mnOrderIndex << "  data index: " << v.mnDataIndex << "  value sort index: " << v.mnValueSortIndex << endl;
 172     }
 173 };
 174
 175 #endif
 176
 177 struct LessByValue : std::binary_function<Bucket, Bucket, bool>
 178 {
 179     bool operator() (const Bucket& left, const Bucket& right) const
 180     {
 181         return left.maValue < right.maValue;
 182     }
 183 };
 184
 185 struct LessByValueSortIndex : std::binary_function<Bucket, Bucket, bool>
 186 {
 187     bool operator() (const Bucket& left, const Bucket& right) const
 188     {
 189         return left.mnValueSortIndex < right.mnValueSortIndex;
 190     }
 191 };
 192
 193 struct LessByDataIndex : std::binary_function<Bucket, Bucket, bool>
 194 {
 195     bool operator() (const Bucket& left, const Bucket& right) const
 196     {
 197         return left.mnDataIndex < right.mnDataIndex;
 198     }
 199 };
 200
 201 struct EqualByOrderIndex : std::binary_function<Bucket, Bucket, bool>
 202 {
 203     bool operator() (const Bucket& left, const Bucket& right) const
 204     {
 205         return left.mnOrderIndex == right.mnOrderIndex;
 206     }
 207 };
 208
 209 class PushBackValue : std::unary_function<Bucket, void>
 210 {
 211     ScDPCache::ItemsType& mrItems;
 212 public:
 213     PushBackValue(ScDPCache::ItemsType& _items) : mrItems(_items) {}
 214     void operator() (const Bucket& v)
 215     {
 216         mrItems.push_back(v.maValue);
 217     }
 218 };
 219
 220 class PushBackOrderIndex : std::unary_function<Bucket, void>
 221 {
 222     ScDPCache::IndexArrayType& mrData;
 223 public:
 224     PushBackOrderIndex(ScDPCache::IndexArrayType& _items) : mrData(_items) {}
 225     void operator() (const Bucket& v)
 226     {
 227         mrData.push_back(v.mnOrderIndex);
 228     }
 229 };
 230
 231 class TagValueSortOrder : std::unary_function<Bucket, void>
 232 {
 233     SCROW mnCurIndex;
 234 public:
 235     TagValueSortOrder() : mnCurIndex(0) {}
 236     void operator() (Bucket& v)
 237     {
 238         v.mnValueSortIndex = mnCurIndex++;
 239     }
 240 };
 241
 242 void processBuckets(std::vector<Bucket>& aBuckets, ScDPCache::Field& rField)
 243 {
 244     if (aBuckets.empty())
 245         return;
 246
 247     // Sort by the value.
 248     std::sort(aBuckets.begin(), aBuckets.end(), LessByValue());
 249
 250     // Remember this sort order.
 251     std::for_each(aBuckets.begin(), aBuckets.end(), TagValueSortOrder());
 252
 253     {
 254         // Set order index such that unique values have identical index value.
 255         SCROW nCurIndex = 0;
 256         std::vector<Bucket>::iterator it = aBuckets.begin(), itEnd = aBuckets.end();
 257         ScDPItemData aPrev = it->maValue;
 258         it->mnOrderIndex = nCurIndex;
 259         for (++it; it != itEnd; ++it)
 260         {
 261             if (!aPrev.IsCaseInsEqual(it->maValue))
 262                 ++nCurIndex;
 263
 264             it->mnOrderIndex = nCurIndex;
 265             aPrev = it->maValue;
 266         }
 267     }
 268
 269     // Re-sort the bucket this time by the data index.
 270     std::sort(aBuckets.begin(), aBuckets.end(), LessByDataIndex());
 271
 272     // Copy the order index series into the field object.
 273     rField.maData.reserve(aBuckets.size());
 274     std::for_each(aBuckets.begin(), aBuckets.end(), PushBackOrderIndex(rField.maData));
 275
 276     // Sort by the value again.
 277     std::sort(aBuckets.begin(), aBuckets.end(), LessByValueSortIndex());
 278
 279     // Unique by value.
 280     std::vector<Bucket>::iterator itUniqueEnd =
 281         std::unique(aBuckets.begin(), aBuckets.end(), EqualByOrderIndex());
 282
 283     // Copy the unique values into items.
 284     std::vector<Bucket>::iterator itBeg = aBuckets.begin();
 285     size_t nLen = distance(itBeg, itUniqueEnd);
 286     rField.maItems.reserve(nLen);
 287     std::for_each(itBeg, itUniqueEnd, PushBackValue(rField.maItems));
 288 }
 289
 290 }
 291
 292 bool ScDPCache::InitFromDoc(ScDocument* pDoc, const ScRange& rRange)
 293 {
 294     Clear();
 295
 296     // Make sure the formula cells within the data range are interpreted
 297     // during this call, for this method may be called from the interpretation
 298     // of GETPIVOTDATA, which disables nested formula interpretation without
 299     // increasing the macro level.
 300     MacroInterpretIncrementer aMacroInc(pDoc);
 301
 302     SCROW nStartRow = rRange.aStart.Row();  // start of data
 303     SCROW nEndRow = rRange.aEnd.Row();
 304
 305     // Sanity check
 306     if (!ValidRow(nStartRow) || !ValidRow(nEndRow) || nEndRow <= nStartRow)
 307         return false;
 308
 309     sal_uInt16 nStartCol = rRange.aStart.Col();
 310     sal_uInt16 nEndCol = rRange.aEnd.Col();
 311     sal_uInt16 nDocTab = rRange.aStart.Tab();
 312
 313     mnColumnCount = nEndCol - nStartCol + 1;
 314
 315     // this row count must include the trailing empty rows.
 316     mnRowCount = nEndRow - nStartRow; // skip the topmost label row.
 317
 318     // Skip trailing empty rows if exists.
 319     SCCOL nCol1 = nStartCol, nCol2 = nEndCol;
 320     SCROW nRow1 = nStartRow, nRow2 = nEndRow;
 321     pDoc->ShrinkToDataArea(nDocTab, nCol1, nRow1, nCol2, nRow2);
 322     bool bTailEmptyRows = nEndRow > nRow2; // Trailing empty rows exist.
 323     nEndRow = nRow2;
 324
 325     if (nEndRow <= nStartRow)
 326     {
 327         // Check this again since the end row position has changed. It's
 328         // possible that the new end row becomes lower than the start row
 329         // after the shrinkage.
 330         Clear();
 331         return false;
 332     }
 333
 334     maFields.reserve(mnColumnCount);
 335     for (size_t i = 0; i < static_cast<size_t>(mnColumnCount); ++i)
 336         maFields.push_back(new Field);
 337
 338     maLabelNames.reserve(mnColumnCount+1);
 339
 340     ScDPItemData aData;
 341     for (sal_uInt16 nCol = nStartCol; nCol <= nEndCol; ++nCol)
 342     {
 343         AddLabel(createLabelString(pDoc, nCol, nStartRow, nDocTab));
 344         Field& rField = maFields[nCol-nStartCol];
 345         std::vector<Bucket> aBuckets;
 346         aBuckets.reserve(nEndRow-nStartRow); // skip the topmost label cell.
 347
 348         // Push back all original values.
 349         SCROW nOffset = nStartRow + 1;
 350         for (SCROW i = 0, n = nEndRow-nStartRow; i < n; ++i)
 351         {
 352             SCROW nRow = i + nOffset;
 353             sal_uLong nNumFormat = 0;
 354             initFromCell(*this, pDoc, nCol, nRow, nDocTab, aData, nNumFormat);
 355             aBuckets.push_back(Bucket(aData, 0, i));
 356
 357             if (!aData.IsEmpty())
 358             {
 359                 maEmptyRows.insert_back(i, i+1, false);
 360                 if (nNumFormat)
 361                     // Only take non-default number format.
 362                     rField.mnNumFormat = nNumFormat;
 363             }
 364         }
 365
 366         processBuckets(aBuckets, rField);
 367
 368         if (bTailEmptyRows)
 369         {
 370             // If the last item is not empty, append one. Note that the items
 371             // are sorted, and empty item should come last when sorted.
 372             if (rField.maItems.empty() || !rField.maItems.back().IsEmpty())
 373             {
 374                 aData.SetEmpty();
 375                 rField.maItems.push_back(aData);
 376             }
 377         }
 378     }
 379
 380     PostInit();
 381     return true;
 382 }
 383
 384 bool ScDPCache::InitFromDataBase(DBConnector& rDB)
 385 {
 386     Clear();
 387
 388     try
 389     {
 390         mnColumnCount = rDB.getColumnCount();
 391         maFields.clear();
 392         maFields.reserve(mnColumnCount);
 393         for (size_t i = 0; i < static_cast<size_t>(mnColumnCount); ++i)
 394             maFields.push_back(new Field);
 395
 396         // Get column titles and types.
 397         maLabelNames.clear();
 398         maLabelNames.reserve(mnColumnCount+1);
 399
 400         for (sal_Int32 nCol = 0; nCol < mnColumnCount; ++nCol)
 401         {
 402             OUString aColTitle = rDB.getColumnLabel(nCol);
 403             AddLabel(aColTitle);
 404         }
 405
 406         std::vector<Bucket> aBuckets;
 407         ScDPItemData aData;
 408         for (sal_Int32 nCol = 0; nCol < mnColumnCount; ++nCol)
 409         {
 410             if (!rDB.first())
 411                 continue;
 412
 413             aBuckets.clear();
 414             Field& rField = maFields[nCol];
 415             SCROW nRow = 0;
 416             do
 417             {
 418                 short nFormatType = NUMBERFORMAT_UNDEFINED;
 419                 aData.SetEmpty();
 420                 rDB.getValue(nCol, aData, nFormatType);
 421                 aBuckets.push_back(Bucket(aData, 0, nRow));
 422                 if (!aData.IsEmpty())
 423                 {
 424                     maEmptyRows.insert_back(nRow, nRow+1, false);
 425                     SvNumberFormatter* pFormatter = mpDoc->GetFormatTable();
 426                     rField.mnNumFormat = pFormatter ? pFormatter->GetStandardFormat(nFormatType) : 0;
 427                 }
 428
 429                 ++nRow;
 430             }
 431             while (rDB.next());
 432
 433             processBuckets(aBuckets, rField);
 434         }
 435
 436         rDB.finish();
 437
 438         if (!maFields.empty())
 439             mnRowCount = maFields[0].maData.size();
 440
 441         PostInit();
 442         return true;
 443     }
 444     catch (const Exception&)
 445     {
 446         return false;
 447     }
 448 }
 449
 450 bool ScDPCache::ValidQuery( SCROW nRow, const ScQueryParam &rParam) const
 451 {
 452     if (!rParam.GetEntryCount())
 453         return true;
 454
 455     if (!rParam.GetEntry(0).bDoQuery)
 456         return true;
 457
 458     bool bMatchWholeCell = mpDoc->GetDocOptions().IsMatchWholeCell();
 459
 460     SCSIZE nEntryCount = rParam.GetEntryCount();
 461     std::vector<bool> aPassed(nEntryCount, false);
 462
 463     long nPos = -1;
 464     CollatorWrapper* pCollator = (rParam.bCaseSens ? ScGlobal::GetCaseCollator() :
 465                                   ScGlobal::GetCollator() );
 466     ::utl::TransliterationWrapper* pTransliteration = (rParam.bCaseSens ?
 467                                                        ScGlobal::GetCaseTransliteration() : ScGlobal::GetpTransliteration());
 468
 469     for (size_t i = 0; i < nEntryCount && rParam.GetEntry(i).bDoQuery; ++i)
 470     {
 471         const ScQueryEntry& rEntry = rParam.GetEntry(i);
 472         const ScQueryEntry::Item& rItem = rEntry.GetQueryItem();
 473         // we can only handle one single direct query
 474         // #i115431# nField in QueryParam is the sheet column, not the field within the source range
 475         SCCOL nQueryCol = (SCCOL)rEntry.nField;
 476         if ( nQueryCol < rParam.nCol1 )
 477             nQueryCol = rParam.nCol1;
 478         if ( nQueryCol > rParam.nCol2 )
 479             nQueryCol = rParam.nCol2;
 480         SCCOL nSourceField = nQueryCol - rParam.nCol1;
 481         SCROW nId = GetItemDataId( nSourceField, nRow, false );
 482         const ScDPItemData* pCellData = GetItemDataById( nSourceField, nId );
 483
 484         bool bOk = false;
 485
 486         if (rEntry.GetQueryItem().meType == ScQueryEntry::ByEmpty)
 487         {
 488             if (rEntry.IsQueryByEmpty())
 489                 bOk = pCellData->IsEmpty();
 490             else
 491             {
 492                 OSL_ASSERT(rEntry.IsQueryByNonEmpty());
 493                 bOk = !pCellData->IsEmpty();
 494             }
 495         }
 496         else if (rEntry.GetQueryItem().meType != ScQueryEntry::ByString && pCellData->IsValue())
 497         {   // by Value
 498             double nCellVal = pCellData->GetValue();
 499
 500             switch (rEntry.eOp)
 501             {
 502                 case SC_EQUAL :
 503                     bOk = ::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 504                     break;
 505                 case SC_LESS :
 506                     bOk = (nCellVal < rItem.mfVal) && !::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 507                     break;
 508                 case SC_GREATER :
 509                     bOk = (nCellVal > rItem.mfVal) && !::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 510                     break;
 511                 case SC_LESS_EQUAL :
 512                     bOk = (nCellVal < rItem.mfVal) || ::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 513                     break;
 514                 case SC_GREATER_EQUAL :
 515                     bOk = (nCellVal > rItem.mfVal) || ::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 516                     break;
 517                 case SC_NOT_EQUAL :
 518                     bOk = !::rtl::math::approxEqual(nCellVal, rItem.mfVal);
 519                     break;
 520                 default:
 521                     bOk= false;
 522                     break;
 523             }
 524         }
 525         else if ((rEntry.eOp == SC_EQUAL || rEntry.eOp == SC_NOT_EQUAL)
 526                  || (rEntry.GetQueryItem().meType == ScQueryEntry::ByString
 527                      && pCellData->HasStringData() )
 528                 )
 529         {   // by String
 530             String  aCellStr = pCellData->GetString();
 531
 532             bool bRealRegExp = (rParam.bRegExp && ((rEntry.eOp == SC_EQUAL)
 533                                                    || (rEntry.eOp == SC_NOT_EQUAL)));
 534             bool bTestRegExp = false;
 535             if (bRealRegExp || bTestRegExp)
 536             {
 537                 xub_StrLen nStart = 0;
 538                 xub_StrLen nEnd   = aCellStr.Len();
 539                 bool bMatch = (bool) rEntry.GetSearchTextPtr( rParam.bCaseSens )
 540                               ->SearchFrwrd( aCellStr, &nStart, &nEnd );
 541                 // from 614 on, nEnd is behind the found text
 542                 if (bMatch && bMatchWholeCell
 543                     && (nStart != 0 || nEnd != aCellStr.Len()))
 544                     bMatch = false;    // RegExp must match entire cell string
 545                 if (bRealRegExp)
 546                     bOk = ((rEntry.eOp == SC_NOT_EQUAL) ? !bMatch : bMatch);
 547             }
 548             if (!bRealRegExp)
 549             {
 550                 if (rEntry.eOp == SC_EQUAL || rEntry.eOp == SC_NOT_EQUAL)
 551                 {
 552                     if (bMatchWholeCell)
 553                     {
 554                         String aStr = rEntry.GetQueryItem().maString;
 555                         bOk = pTransliteration->isEqual(aCellStr, aStr);
 556                         bool bHasStar = false;
 557                         xub_StrLen nIndex;
 558                         if (( nIndex = aStr.Search('*') ) != STRING_NOTFOUND)
 559                             bHasStar = sal_True;
 560                         if (bHasStar && (nIndex>0))
 561                         {
 562                             for (i=0;(i<nIndex) && (i< aCellStr.Len()) ; i++)
 563                             {
 564                                 if (aCellStr.GetChar( (sal_uInt16)i ) == aStr.GetChar((sal_uInt16) i ))
 565                                 {
 566                                     bOk=1;
 567                                 }
 568                                 else
 569                                 {
 570                                     bOk=0;
 571                                     break;
 572                                 }
 573                             }
 574                         }
 575                     }
 576                     else
 577                     {
 578                         const OUString& rQueryStr = rEntry.GetQueryItem().maString;
 579                         ::com::sun::star::uno::Sequence< sal_Int32 > xOff;
 580                         String aCell = pTransliteration->transliterate(
 581                             aCellStr, ScGlobal::eLnge, 0, aCellStr.Len(), &xOff);
 582                         String aQuer = pTransliteration->transliterate(
 583                             rQueryStr, ScGlobal::eLnge, 0, rQueryStr.getLength(), &xOff);
 584                         bOk = (aCell.Search( aQuer ) != STRING_NOTFOUND);
 585                     }
 586                     if (rEntry.eOp == SC_NOT_EQUAL)
 587                         bOk = !bOk;
 588                 }
 589                 else
 590                 {   // use collator here because data was probably sorted
 591                     sal_Int32 nCompare = pCollator->compareString(
 592                         aCellStr, rEntry.GetQueryItem().maString);
 593                     switch (rEntry.eOp)
 594                     {
 595                         case SC_LESS :
 596                             bOk = (nCompare < 0);
 597                             break;
 598                         case SC_GREATER :
 599                             bOk = (nCompare > 0);
 600                             break;
 601                         case SC_LESS_EQUAL :
 602                             bOk = (nCompare <= 0);
 603                             break;
 604                         case SC_GREATER_EQUAL :
 605                             bOk = (nCompare >= 0);
 606                             break;
 607                         case SC_NOT_EQUAL:
 608                             OSL_FAIL("SC_NOT_EQUAL");
 609                             break;
 610                         case SC_TOPVAL:
 611                         case SC_BOTVAL:
 612                         case SC_TOPPERC:
 613                         case SC_BOTPERC:
 614                         default:
 615                             break;
 616                     }
 617                 }
 618             }
 619         }
 620
 621         if (nPos == -1)
 622         {
 623             nPos++;
 624             aPassed[nPos] = bOk;
 625         }
 626         else
 627         {
 628             if (rEntry.eConnect == SC_AND)
 629             {
 630                 aPassed[nPos] = aPassed[nPos] && bOk;
 631             }
 632             else
 633             {
 634                 nPos++;
 635                 aPassed[nPos] = bOk;
 636             }
 637         }
 638     }
 639
 640     for (long j=1; j <= nPos; j++)
 641         aPassed[0] = aPassed[0] || aPassed[j];
 642
 643     bool bRet = aPassed[0];
 644     return bRet;
 645 }
 646
 647 bool ScDPCache::IsRowEmpty(SCROW nRow) const
 648 {
 649     bool bEmpty = true;
 650     maEmptyRows.search_tree(nRow, bEmpty);
 651     return bEmpty;
 652 }
 653
 654 const ScDPCache::GroupItems* ScDPCache::GetGroupItems(long nDim) const
 655 {
 656     if (nDim < 0)
 657         return NULL;
 658
 659     long nSourceCount = static_cast<long>(maFields.size());
 660     if (nDim < nSourceCount)
 661         return maFields[nDim].mpGroup.get();
 662
 663     nDim -= nSourceCount;
 664     if (nDim < static_cast<long>(maGroupFields.size()))
 665         return &maGroupFields[nDim];
 666
 667     return NULL;
 668 }
 669
 670 OUString ScDPCache::GetDimensionName(LabelsType::size_type nDim) const
 671 {
 672     OSL_ENSURE(nDim < maLabelNames.size()-1 , "ScDPTableDataCache::GetDimensionName");
 673     OSL_ENSURE(maLabelNames.size() == static_cast <sal_uInt16> (mnColumnCount+1), "ScDPTableDataCache::GetDimensionName");
 674
 675     if ( nDim+1 < maLabelNames.size() )
 676     {
 677         return maLabelNames[nDim+1];
 678     }
 679     else
 680         return OUString();
 681 }
 682
 683 namespace {
 684
 685 typedef boost::unordered_set<OUString, OUStringHash> LabelSet;
 686
 687 class InsertLabel : public std::unary_function<OUString, void>
 688 {
 689     LabelSet& mrNames;
 690 public:
 691     InsertLabel(LabelSet& rNames) : mrNames(rNames) {}
 692     void operator() (const OUString& r)
 693     {
 694         mrNames.insert(r);
 695     }
 696 };
 697
 698 }
 699
 700 void ScDPCache::PostInit()
 701 {
 702     OSL_ENSURE(!maFields.empty(), "Cache not initialized!");
 703
 704     maEmptyRows.build_tree();
 705     typedef mdds::flat_segment_tree<SCROW, bool>::const_reverse_iterator itr_type;
 706     itr_type it = maEmptyRows.rbegin();
 707     OSL_ENSURE(it != maEmptyRows.rend(), "corrupt flat_segment_tree instance!");
 708     mnDataSize = maFields[0].maData.size();
 709     ++it; // Skip the first position.
 710     OSL_ENSURE(it != maEmptyRows.rend(), "buggy version of flat_segment_tree is used.");
 711     if (it->second)
 712     {
 713         SCROW nLastNonEmpty = it->first - 1;
 714         if (nLastNonEmpty+1 < mnDataSize)
 715             mnDataSize = nLastNonEmpty+1;
 716     }
 717 }
 718
 719 void ScDPCache::Clear()
 720 {
 721     mnColumnCount = 0;
 722     mnRowCount = 0;
 723     maFields.clear();
 724     maLabelNames.clear();
 725     maGroupFields.clear();
 726     maEmptyRows.clear();
 727     maStringPool.clear();
 728 }
 729
 730 void ScDPCache::AddLabel(const OUString& rLabel)
 731 {
 732
 733     if ( maLabelNames.empty() )
 734         maLabelNames.push_back(ScGlobal::GetRscString(STR_PIVOT_DATA));
 735
 736     //reset name if needed
 737     LabelSet aExistingNames;
 738     std::for_each(maLabelNames.begin(), maLabelNames.end(), InsertLabel(aExistingNames));
 739     sal_Int32 nSuffix = 1;
 740     OUString aNewName = rLabel;
 741     while (true)
 742     {
 743         if (!aExistingNames.count(aNewName))
 744         {
 745             // unique name found!
 746             maLabelNames.push_back(aNewName);
 747             return;
 748         }
 749
 750         // Name already exists.
 751         OUStringBuffer aBuf(rLabel);
 752         aBuf.append(++nSuffix);
 753         aNewName = aBuf.makeStringAndClear();
 754     }
 755 }
 756
 757 SCROW ScDPCache::GetItemDataId(sal_uInt16 nDim, SCROW nRow, bool bRepeatIfEmpty) const
 758 {
 759     OSL_ENSURE(nDim < mnColumnCount, "ScDPTableDataCache::GetItemDataId ");
 760
 761     const Field& rField = maFields[nDim];
 762     if (static_cast<size_t>(nRow) >= rField.maData.size())
 763     {
 764         // nRow is in the trailing empty rows area.
 765         if (bRepeatIfEmpty)
 766             nRow = rField.maData.size()-1; // Move to the last non-empty row.
 767         else
 768             // Return the last item, which should always be empty if the
 769             // initialization has skipped trailing empty rows.
 770             return rField.maItems.size()-1;
 771
 772     }
 773     else if (bRepeatIfEmpty)
 774     {
 775         while (nRow > 0 && rField.maItems[rField.maData[nRow]].IsEmpty())
 776             --nRow;
 777     }
 778
 779     return rField.maData[nRow];
 780 }
 781
 782 const ScDPItemData* ScDPCache::GetItemDataById(long nDim, SCROW nId) const
 783 {
 784     if (nDim < 0 || nId < 0)
 785         return NULL;
 786
 787     size_t nSourceCount = maFields.size();
 788     size_t nDimPos = static_cast<size_t>(nDim);
 789     size_t nItemId = static_cast<size_t>(nId);
 790     if (nDimPos < nSourceCount)
 791     {
 792         // source field.
 793         const Field& rField = maFields[nDimPos];
 794         if (nItemId < rField.maItems.size())
 795             return &rField.maItems[nItemId];
 796
 797         if (!rField.mpGroup)
 798             return NULL;
 799
 800         nItemId -= rField.maItems.size();
 801         const ItemsType& rGI = rField.mpGroup->maItems;
 802         if (nItemId >= rGI.size())
 803             return NULL;
 804
 805         return &rGI[nItemId];
 806     }
 807
 808     // Try group fields.
 809     nDimPos -= nSourceCount;
 810     if (nDimPos >= maGroupFields.size())
 811         return NULL;
 812
 813     const ItemsType& rGI = maGroupFields[nDimPos].maItems;
 814     if (nItemId >= rGI.size())
 815         return NULL;
 816
 817     return &rGI[nItemId];
 818 }
 819
 820 SCROW ScDPCache::GetRowCount() const
 821 {
 822     return mnRowCount;
 823 }
 824
 825 SCROW ScDPCache::GetDataSize() const
 826 {
 827     OSL_ENSURE(mnDataSize <= GetRowCount(), "Data size should never be larger than the row count.");
 828     return mnDataSize >= 0 ? mnDataSize : 0;
 829 }
 830
 831 const ScDPCache::ItemsType& ScDPCache::GetDimMemberValues(SCCOL nDim) const
 832 {
 833     OSL_ENSURE( nDim>=0 && nDim < mnColumnCount ," nDim < mnColumnCount ");
 834     return maFields.at(nDim).maItems;
 835 }
 836
 837 sal_uLong ScDPCache::GetNumberFormat( long nDim ) const
 838 {
 839     if ( nDim >= mnColumnCount )
 840         return 0;
 841
 842     // TODO: Find a way to determine the dominant number format in presence of
 843     // multiple number formats in the same field.
 844     return maFields[nDim].mnNumFormat;
 845 }
 846
 847 bool ScDPCache::IsDateDimension( long nDim ) const
 848 {
 849     if (nDim >= mnColumnCount)
 850         return false;
 851
 852     SvNumberFormatter* pFormatter = mpDoc->GetFormatTable();
 853     if (!pFormatter)
 854         return false;
 855
 856     short eType = pFormatter->GetType(maFields[nDim].mnNumFormat);
 857     return (eType == NUMBERFORMAT_DATE) || (eType == NUMBERFORMAT_DATETIME);
 858 }
 859
 860 long ScDPCache::GetDimMemberCount(long nDim) const
 861 {
 862     OSL_ENSURE( nDim>=0 && nDim < mnColumnCount ," ScDPTableDataCache::GetDimMemberCount : out of bound ");
 863     return maFields[nDim].maItems.size();
 864 }
 865
 866 SCCOL ScDPCache::GetDimensionIndex(const OUString& sName) const
 867 {
 868     for (size_t i = 1; i < maLabelNames.size(); ++i)
 869     {
 870         if (maLabelNames[i].equals(sName))
 871             return static_cast<SCCOL>(i-1);
 872     }
 873     return -1;
 874 }
 875
 876 const OUString* ScDPCache::InternString(const OUString& rStr) const
 877 {
 878     StringSetType::iterator it = maStringPool.find(rStr);
 879     if (it != maStringPool.end())
 880         // In the pool.
 881         return &(*it);
 882
 883     std::pair<StringSetType::iterator, bool> r = maStringPool.insert(rStr);
 884     return r.second ? &(*r.first) : NULL;
 885 }
 886
 887 void ScDPCache::AddReference(ScDPObject* pObj) const
 888 {
 889     maRefObjects.insert(pObj);
 890 }
 891
 892 void ScDPCache::RemoveReference(ScDPObject* pObj) const
 893 {
 894     if (mbDisposing)
 895         // Object being deleted.
 896         return;
 897
 898     maRefObjects.erase(pObj);
 899     if (maRefObjects.empty())
 900         mpDoc->GetDPCollection()->RemoveCache(this);
 901 }
 902
 903 const ScDPCache::ObjectSetType& ScDPCache::GetAllReferences() const
 904 {
 905     return maRefObjects;
 906 }
 907
 908 SCROW ScDPCache::GetIdByItemData(long nDim, const ScDPItemData& rItem) const
 909 {
 910     if (nDim < 0)
 911         return -1;
 912
 913     if (nDim < mnColumnCount)
 914     {
 915         // source field.
 916         const ItemsType& rItems = maFields[nDim].maItems;
 917         for (size_t i = 0, n = rItems.size(); i < n; ++i)
 918         {
 919             if (rItems[i] == rItem)
 920                 return i;
 921         }
 922
 923         if (!maFields[nDim].mpGroup)
 924             return -1;
 925
 926         // grouped source field.
 927         const ItemsType& rGI = maFields[nDim].mpGroup->maItems;
 928         for (size_t i = 0, n = rGI.size(); i < n; ++i)
 929         {
 930             if (rGI[i] == rItem)
 931                 return rItems.size() + i;
 932         }
 933         return -1;
 934     }
 935
 936     // group field.
 937     nDim -= mnColumnCount;
 938     if (static_cast<size_t>(nDim) < maGroupFields.size())
 939     {
 940         const ItemsType& rGI = maGroupFields[nDim].maItems;
 941         for (size_t i = 0, n = rGI.size(); i < n; ++i)
 942         {
 943             if (rGI[i] == rItem)
 944                 return i;
 945         }
 946     }
 947
 948     return -1;
 949 }
 950
 951 OUString ScDPCache::GetFormattedString(long nDim, const ScDPItemData& rItem) const
 952 {
 953     if (nDim < 0)
 954         return rItem.GetString();
 955
 956     ScDPItemData::Type eType = rItem.GetType();
 957     if (eType == ScDPItemData::Value)
 958     {
 959         // Format value using the stored number format.
 960         sal_uLong nNumFormat = GetNumberFormat(nDim);
 961         SvNumberFormatter* pFormatter = mpDoc->GetFormatTable();
 962         if (pFormatter)
 963         {
 964             Color* pColor = NULL;
 965             String aStr;
 966             pFormatter->GetOutputString(rItem.GetValue(), nNumFormat, aStr, &pColor);
 967             return aStr;
 968         }
 969     }
 970
 971     if (eType == ScDPItemData::GroupValue)
 972     {
 973         ScDPItemData::GroupValueAttr aAttr = rItem.GetGroupValue();
 974         double fStart = 0.0, fEnd = 0.0;
 975         const GroupItems* p = GetGroupItems(nDim);
 976         if (p)
 977         {
 978             fStart = p->maInfo.mfStart;
 979             fEnd = p->maInfo.mfEnd;
 980         }
 981         return ScDPUtil::getDateGroupName(
 982             aAttr.mnGroupType, aAttr.mnValue, mpDoc->GetFormatTable(), fStart, fEnd);
 983     }
 984
 985     if (eType == ScDPItemData::RangeStart)
 986     {
 987         double fVal = rItem.GetValue();
 988         const GroupItems* p = GetGroupItems(nDim);
 989         if (!p)
 990             return rItem.GetString();
 991
 992         sal_Unicode cDecSep = ScGlobal::pLocaleData->getNumDecimalSep()[0];
 993         return ScDPUtil::getNumGroupName(fVal, p->maInfo, cDecSep, mpDoc->GetFormatTable());
 994     }
 995
 996     return rItem.GetString();
 997 }
 998
 999 long ScDPCache::AppendGroupField()
1000 {
1001     maGroupFields.push_back(new GroupItems);
1002     return static_cast<long>(maFields.size() + maGroupFields.size() - 1);
1003 }
1004
1005 void ScDPCache::ResetGroupItems(long nDim, const ScDPNumGroupInfo& rNumInfo, sal_Int32 nGroupType)
1006 {
1007     if (nDim < 0)
1008         return;
1009
1010     long nSourceCount = static_cast<long>(maFields.size());
1011     if (nDim < nSourceCount)
1012     {
1013         maFields.at(nDim).mpGroup.reset(new GroupItems(rNumInfo, nGroupType));
1014         return;
1015     }
1016
1017     nDim -= nSourceCount;
1018     if (nDim < static_cast<long>(maGroupFields.size()))
1019     {
1020         GroupItems& rGI = maGroupFields[nDim];
1021         rGI.maItems.clear();
1022         rGI.maInfo = rNumInfo;
1023         rGI.mnGroupType = nGroupType;
1024     }
1025 }
1026
1027 SCROW ScDPCache::SetGroupItem(long nDim, const ScDPItemData& rData)
1028 {
1029     if (nDim < 0)
1030         return -1;
1031
1032     long nSourceCount = static_cast<long>(maFields.size());
1033     if (nDim < nSourceCount)
1034     {
1035         GroupItems& rGI = *maFields.at(nDim).mpGroup;
1036         rGI.maItems.push_back(rData);
1037         SCROW nId = maFields[nDim].maItems.size() + rGI.maItems.size() - 1;
1038         return nId;
1039     }
1040
1041     nDim -= nSourceCount;
1042     if (nDim < static_cast<long>(maGroupFields.size()))
1043     {
1044         ItemsType& rItems = maGroupFields.at(nDim).maItems;
1045         rItems.push_back(rData);
1046         return rItems.size()-1;
1047     }
1048
1049     return -1;
1050 }
1051
1052 void ScDPCache::GetGroupDimMemberIds(long nDim, std::vector<SCROW>& rIds) const
1053 {
1054     if (nDim < 0)
1055         return;
1056
1057     long nSourceCount = static_cast<long>(maFields.size());
1058     if (nDim < nSourceCount)
1059     {
1060         if (!maFields.at(nDim).mpGroup)
1061             return;
1062
1063         size_t nOffset = maFields[nDim].maItems.size();
1064         const ItemsType& rGI = maFields[nDim].mpGroup->maItems;
1065         for (size_t i = 0, n = rGI.size(); i < n; ++i)
1066             rIds.push_back(static_cast<SCROW>(i + nOffset));
1067
1068         return;
1069     }
1070
1071     nDim -= nSourceCount;
1072     if (nDim < static_cast<long>(maGroupFields.size()))
1073     {
1074         const ItemsType& rGI = maGroupFields.at(nDim).maItems;
1075         for (size_t i = 0, n = rGI.size(); i < n; ++i)
1076             rIds.push_back(static_cast<SCROW>(i));
1077     }
1078 }
1079
1080 namespace {
1081
1082 struct ClearGroupItems : std::unary_function<ScDPCache::Field, void>
1083 {
1084     void operator() (ScDPCache::Field& r) const
1085     {
1086         r.mpGroup.reset();
1087     }
1088 };
1089
1090 }
1091
1092 void ScDPCache::ClearGroupFields()
1093 {
1094     maGroupFields.clear();
1095     std::for_each(maFields.begin(), maFields.end(), ClearGroupItems());
1096 }
1097
1098 const ScDPNumGroupInfo* ScDPCache::GetNumGroupInfo(long nDim) const
1099 {
1100     if (nDim < 0)
1101         return NULL;
1102
1103     long nSourceCount = static_cast<long>(maFields.size());
1104     if (nDim < nSourceCount)
1105     {
1106         if (!maFields.at(nDim).mpGroup)
1107             return NULL;
1108
1109         return &maFields[nDim].mpGroup->maInfo;
1110     }
1111
1112     nDim -= nSourceCount;
1113     if (nDim < static_cast<long>(maGroupFields.size()))
1114         return &maGroupFields.at(nDim).maInfo;
1115
1116     return NULL;
1117 }
1118
1119 sal_Int32 ScDPCache::GetGroupType(long nDim) const
1120 {
1121     if (nDim < 0)
1122         return 0;
1123
1124     long nSourceCount = static_cast<long>(maFields.size());
1125     if (nDim < nSourceCount)
1126     {
1127         if (!maFields.at(nDim).mpGroup)
1128             return 0;
1129
1130         return maFields[nDim].mpGroup->mnGroupType;
1131     }
1132
1133     nDim -= nSourceCount;
1134     if (nDim < static_cast<long>(maGroupFields.size()))
1135         return maGroupFields.at(nDim).mnGroupType;
1136
1137     return 0;
1138 }
1139
1140 SCROW ScDPCache::GetOrder(long /*nDim*/, SCROW nIndex) const
1141 {
1142     return nIndex;
1143 }
1144
1145 ScDocument* ScDPCache::GetDoc() const
1146 {
1147     return mpDoc;
1148 };
1149
1150 long ScDPCache::GetColumnCount() const
1151 {
1152     return mnColumnCount;
1153 }
1154
1155 #if DEBUG_PIVOT_TABLE
1156
1157 namespace {
1158
1159 std::ostream& operator<< (::std::ostream& os, const OUString& str)
1160 {
1161     return os << OUStringToOString(str, RTL_TEXTENCODING_UTF8).getStr();
1162 }
1163
1164 void dumpItems(const ScDPCache& rCache, long nDim, const ScDPCache::ItemsType& rItems, size_t nOffset)
1165 {
1166     for (size_t i = 0; i < rItems.size(); ++i)
1167         cout << "      " << (i+nOffset) << ": " << rCache.GetFormattedString(nDim, rItems[i]) << endl;
1168 }
1169
1170 void dumpSourceData(const ScDPCache& rCache, long nDim, const ScDPCache::ItemsType& rItems, const ScDPCache::IndexArrayType& rArray)
1171 {
1172     ScDPCache::IndexArrayType::const_iterator it = rArray.begin(), itEnd = rArray.end();
1173     for (; it != itEnd; ++it)
1174         cout << "      '" << rCache.GetFormattedString(nDim, rItems[*it]) << "'" << endl;
1175 }
1176
1177 }
1178
1179 void ScDPCache::Dump() const
1180 {
1181     cout << "--- pivot cache dump" << endl;
1182     {
1183         FieldsType::const_iterator it = maFields.begin(), itEnd = maFields.end();
1184         for (size_t i = 0; it != itEnd; ++it, ++i)
1185         {
1186             const Field& fld = *it;
1187             cout << "* source dimension: " << GetDimensionName(i) << " (ID = " << i << ")" << endl;
1188             cout << "    item count: " << fld.maItems.size() << endl;
1189             dumpItems(*this, i, fld.maItems, 0);
1190             if (fld.mpGroup)
1191             {
1192                 cout << "    group item count: " << fld.mpGroup->maItems.size() << endl;
1193                 dumpItems(*this, i, fld.mpGroup->maItems, fld.maItems.size());
1194             }
1195
1196             cout << "    source data (re-constructed):" << endl;
1197             dumpSourceData(*this, i, fld.maItems, fld.maData);
1198         }
1199     }
1200
1201     {
1202         struct { SCROW start; SCROW end; bool empty; } aRange;
1203         cout << "* empty rows: " << endl;
1204         mdds::flat_segment_tree<SCROW, bool>::const_iterator it = maEmptyRows.begin(), itEnd = maEmptyRows.end();
1205         if (it != itEnd)
1206         {
1207             aRange.start = it->first;
1208             aRange.empty = it->second;
1209             ++it;
1210         }
1211
1212         for (; it != itEnd; ++it)
1213         {
1214             aRange.end = it->first-1;
1215             cout << "    rows " << aRange.start << "-" << aRange.end << ": " << (aRange.empty ? "empty" : "not-empty") << endl;
1216             aRange.start = it->first;
1217             aRange.empty = it->second;
1218         }
1219     }
1220
1221     {
1222         GroupFieldsType::const_iterator it = maGroupFields.begin(), itEnd = maGroupFields.end();
1223         for (size_t i = maFields.size(); it != itEnd; ++it, ++i)
1224         {
1225             const GroupItems& gi = *it;
1226             cout << "* group dimension: (unnamed) (ID = " << i << ")" << endl;
1227             cout << "    item count: " << gi.maItems.size() << endl;
1228             dumpItems(*this, i, gi.maItems, 0);
1229         }
1230     }
1231
1232     cout << "---" << endl;
1233 }
1234
1235 #endif
1236
1237 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */