xmloff/source/text/txtlists.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
  21 #include <txtlists.hxx>
  22 #include <comphelper/random.hxx>
  23 #include <tools/date.hxx>
  24 #include <tools/time.hxx>
  25
  26 #include <xmloff/txtimp.hxx>
  27 #include <xmloff/xmlimp.hxx>
  28 #include <xmloff/xmlnumi.hxx>
  29
  30 #include <com/sun/star/style/XStyle.hpp>
  31 #include <com/sun/star/beans/XPropertySet.hpp>
  32 #include "XMLTextListItemContext.hxx"
  33 #include "XMLTextListBlockContext.hxx"
  34 #include "txtparai.hxx"
  35
  36
  37 using namespace ::com::sun::star;
  38
  39
  40 XMLTextListsHelper::XMLTextListsHelper()
  41    :  mpProcessedLists( 0 ),
  42       msLastProcessedListId(),
  43       msListStyleOfLastProcessedList(),
  44       // Inconsistent behavior regarding lists (#i92811#)
  45       mpMapListIdToListStyleDefaultListId( 0 ),
  46       mpContinuingLists( 0 ),
  47       mpListStack( 0 )
  48 {
  49 }
  50
  51 XMLTextListsHelper::~XMLTextListsHelper()
  52 {
  53     if ( mpProcessedLists )
  54     {
  55         mpProcessedLists->clear();
  56         delete mpProcessedLists;
  57     }
  58     // Inconsistent behavior regarding lists (#i92811#)#
  59     if ( mpMapListIdToListStyleDefaultListId )
  60     {
  61         mpMapListIdToListStyleDefaultListId->clear();
  62         delete mpMapListIdToListStyleDefaultListId;
  63     }
  64     if ( mpContinuingLists )
  65     {
  66         mpContinuingLists->clear();
  67         delete mpContinuingLists;
  68     }
  69     if ( mpListStack )
  70     {
  71         mpListStack->clear();
  72         delete mpListStack;
  73     }
  74 }
  75
  76 void XMLTextListsHelper::PushListContext(
  77     XMLTextListBlockContext *i_pListBlock)
  78 {
  79     mListStack.push(::boost::make_tuple(i_pListBlock,
  80         static_cast<XMLTextListItemContext*>(0),
  81         static_cast<XMLNumberedParaContext*>(0)));
  82 }
  83
  84 void XMLTextListsHelper::PushListContext(
  85     XMLNumberedParaContext *i_pNumberedParagraph)
  86 {
  87     mListStack.push(::boost::make_tuple(
  88         static_cast<XMLTextListBlockContext*>(0),
  89         static_cast<XMLTextListItemContext*>(0), i_pNumberedParagraph));
  90 }
  91
  92 void XMLTextListsHelper::PopListContext()
  93 {
  94     assert(mListStack.size());
  95     if ( !mListStack.empty())
  96         mListStack.pop();
  97 }
  98
  99 void XMLTextListsHelper::ListContextTop(
 100     XMLTextListBlockContext*& o_pListBlockContext,
 101     XMLTextListItemContext*& o_pListItemContext,
 102     XMLNumberedParaContext*& o_pNumberedParagraphContext )
 103 {
 104     if ( !mListStack.empty() ) {
 105         o_pListBlockContext =
 106             static_cast<XMLTextListBlockContext*>(&mListStack.top().get<0>());
 107         o_pListItemContext  =
 108             static_cast<XMLTextListItemContext *>(&mListStack.top().get<1>());
 109         o_pNumberedParagraphContext =
 110             static_cast<XMLNumberedParaContext *>(&mListStack.top().get<2>());
 111     }
 112 }
 113
 114 void XMLTextListsHelper::SetListItem( XMLTextListItemContext *i_pListItem )
 115 {
 116     // may be cleared by ListBlockContext for upper list...
 117     if (i_pListItem) {
 118         assert(mListStack.size());
 119         assert(mListStack.top().get<0>() &&
 120             "internal error: SetListItem: mListStack has no ListBlock");
 121         assert(!mListStack.top().get<1>() &&
 122             "error: SetListItem: list item already exists");
 123     }
 124     if ( !mListStack.empty() ) {
 125         mListStack.top().get<1>() = i_pListItem;
 126     }
 127 }
 128
 129 // Handling for parameter <sListStyleDefaultListId> (#i92811#)
 130 void XMLTextListsHelper::KeepListAsProcessed( const OUString& sListId,
 131                                               const OUString& sListStyleName,
 132                                               const OUString& sContinueListId,
 133                                               const OUString& sListStyleDefaultListId )
 134 {
 135     if ( IsListProcessed( sListId ) )
 136     {
 137         assert(false &&
 138                     "<XMLTextListsHelper::KeepListAsProcessed(..)> - list id already added" );
 139         return;
 140     }
 141
 142     if ( mpProcessedLists == 0 )
 143     {
 144         mpProcessedLists = new tMapForLists();
 145     }
 146
 147     ::std::pair< OUString, OUString >
 148                                 aListData( sListStyleName, sContinueListId );
 149     (*mpProcessedLists)[ sListId ] = aListData;
 150
 151     msLastProcessedListId = sListId;
 152     msListStyleOfLastProcessedList = sListStyleName;
 153
 154     // Inconsistent behavior regarding lists (#i92811#)
 155     if ( !sListStyleDefaultListId.isEmpty())
 156     {
 157         if ( mpMapListIdToListStyleDefaultListId == 0 )
 158         {
 159             mpMapListIdToListStyleDefaultListId = new tMapForLists();
 160         }
 161
 162         if ( mpMapListIdToListStyleDefaultListId->find( sListStyleName ) ==
 163                                 mpMapListIdToListStyleDefaultListId->end() )
 164         {
 165             ::std::pair< OUString, OUString >
 166                                 aListIdMapData( sListId, sListStyleDefaultListId );
 167             (*mpMapListIdToListStyleDefaultListId)[ sListStyleName ] =
 168                                                                 aListIdMapData;
 169         }
 170     }
 171 }
 172
 173 bool XMLTextListsHelper::IsListProcessed( const OUString& sListId ) const
 174 {
 175     if ( mpProcessedLists == 0 )
 176     {
 177         return false;
 178     }
 179
 180     return mpProcessedLists->find( sListId ) != mpProcessedLists->end();
 181 }
 182
 183 OUString XMLTextListsHelper::GetListStyleOfProcessedList(
 184                                             const OUString& sListId ) const
 185 {
 186     if ( mpProcessedLists != 0 )
 187     {
 188         tMapForLists::const_iterator aIter = mpProcessedLists->find( sListId );
 189         if ( aIter != mpProcessedLists->end() )
 190         {
 191             return (*aIter).second.first;
 192         }
 193     }
 194
 195     return OUString();
 196 }
 197
 198 OUString XMLTextListsHelper::GetContinueListIdOfProcessedList(
 199                                             const OUString& sListId ) const
 200 {
 201     if ( mpProcessedLists != 0 )
 202     {
 203         tMapForLists::const_iterator aIter = mpProcessedLists->find( sListId );
 204         if ( aIter != mpProcessedLists->end() )
 205         {
 206             return (*aIter).second.second;
 207         }
 208     }
 209
 210     return OUString();
 211 }
 212
 213
 214
 215 OUString XMLTextListsHelper::GenerateNewListId() const
 216 {
 217     static bool bHack = (getenv("LIBO_ONEWAY_STABLE_ODF_EXPORT") != NULL);
 218     OUString sTmpStr( "list" );
 219
 220     if (bHack)
 221     {
 222         static sal_Int64 nIdCounter = SAL_CONST_INT64(5000000000);
 223         sTmpStr += OUString::number(nIdCounter++);
 224     }
 225     else
 226     {
 227         // Value of xml:id in element <text:list> has to be a valid ID type (#i92478#)
 228         sal_Int64 n = ::tools::Time( ::tools::Time::SYSTEM ).GetTime();
 229         n += Date( Date::SYSTEM ).GetDate();
 230         n += comphelper::rng::uniform_int_distribution(0, std::numeric_limits<int>::max());
 231         // Value of xml:id in element <text:list> has to be a valid ID type (#i92478#)
 232         sTmpStr += OUString::number( n );
 233     }
 234
 235     OUString sNewListId( sTmpStr );
 236     if ( mpProcessedLists != 0 )
 237     {
 238         long nHitCount = 0;
 239         while ( mpProcessedLists->find( sNewListId ) != mpProcessedLists->end() )
 240         {
 241             ++nHitCount;
 242             sNewListId = sTmpStr;
 243             sNewListId += OUString::number( nHitCount );
 244         }
 245     }
 246
 247     return sNewListId;
 248 }
 249
 250 // Provide list id for a certain list block for import (#i92811#)
 251 OUString XMLTextListsHelper::GetListIdForListBlock( XMLTextListBlockContext& rListBlock )
 252 {
 253     OUString sListBlockListId( rListBlock.GetContinueListId() );
 254     if ( sListBlockListId.isEmpty() )
 255     {
 256         sListBlockListId = rListBlock.GetListId();
 257     }
 258
 259     if ( mpMapListIdToListStyleDefaultListId != 0 )
 260     {
 261         if ( !sListBlockListId.isEmpty() )
 262         {
 263             const OUString sListStyleName =
 264                                 GetListStyleOfProcessedList( sListBlockListId );
 265
 266             tMapForLists::const_iterator aIter =
 267                     mpMapListIdToListStyleDefaultListId->find( sListStyleName );
 268             if ( aIter != mpMapListIdToListStyleDefaultListId->end() )
 269             {
 270                 if ( (*aIter).second.first == sListBlockListId )
 271                 {
 272                     sListBlockListId = (*aIter).second.second;
 273                 }
 274             }
 275         }
 276     }
 277
 278     return sListBlockListId;
 279 }
 280
 281 void XMLTextListsHelper::StoreLastContinuingList( const OUString& sListId,
 282                                                   const OUString& sContinuingListId )
 283 {
 284     if ( mpContinuingLists == 0 )
 285     {
 286         mpContinuingLists = new tMapForContinuingLists();
 287     }
 288
 289     (*mpContinuingLists)[ sListId ] = sContinuingListId;
 290 }
 291
 292 OUString XMLTextListsHelper::GetLastContinuingListId(
 293                                                 const OUString& sListId ) const
 294 {
 295     if ( mpContinuingLists != 0)
 296     {
 297         tMapForContinuingLists::const_iterator aIter =
 298                                                 mpContinuingLists->find( sListId );
 299         if ( aIter != mpContinuingLists->end() )
 300         {
 301             return (*aIter).second;
 302         }
 303     }
 304
 305     return sListId;
 306 }
 307
 308 void XMLTextListsHelper::PushListOnStack( const OUString& sListId,
 309                                           const OUString& sListStyleName )
 310 {
 311     if ( mpListStack == 0 )
 312     {
 313         mpListStack = new tStackForLists();
 314     }
 315     ::std::pair< OUString, OUString >
 316                                 aListData( sListId, sListStyleName );
 317     mpListStack->push_back( aListData );
 318 }
 319 void XMLTextListsHelper::PopListFromStack()
 320 {
 321     if ( mpListStack != 0 &&
 322          mpListStack->size() > 0 )
 323     {
 324         mpListStack->pop_back();
 325     }
 326 }
 327
 328 bool XMLTextListsHelper::EqualsToTopListStyleOnStack( const OUString& sListId ) const
 329 {
 330     return mpListStack != 0 && sListId == mpListStack->back().second;
 331 }
 332
 333 OUString
 334 XMLTextListsHelper::GetNumberedParagraphListId(
 335     const sal_uInt16 i_Level,
 336     const OUString& i_StyleName)
 337 {
 338     if (i_StyleName.isEmpty()) {
 339         SAL_INFO("xmloff.text", "invalid numbered-paragraph: no style-name");
 340     }
 341     if (!i_StyleName.isEmpty()
 342         && (i_Level < mLastNumberedParagraphs.size())
 343         && (mLastNumberedParagraphs[i_Level].first == i_StyleName) )
 344     {
 345         assert(!mLastNumberedParagraphs[i_Level].second.isEmpty() &&
 346             "internal error: numbered-paragraph style-name but no list-id?");
 347         return mLastNumberedParagraphs[i_Level].second;
 348     } else {
 349         return GenerateNewListId();
 350     }
 351 }
 352
 353 static void
 354 ClampLevel(uno::Reference<container::XIndexReplace> const& i_xNumRules,
 355     sal_Int16 & io_rLevel)
 356 {
 357     assert(i_xNumRules.is());
 358     if (i_xNumRules.is()) {
 359         const sal_Int32 nLevelCount( i_xNumRules->getCount() );
 360         if ( io_rLevel >= nLevelCount ) {
 361             io_rLevel = sal::static_int_cast< sal_Int16 >(nLevelCount-1);
 362         }
 363     }
 364 }
 365
 366 uno::Reference<container::XIndexReplace>
 367 XMLTextListsHelper::EnsureNumberedParagraph(
 368     SvXMLImport & i_rImport,
 369     const OUString& i_ListId,
 370     sal_Int16 & io_rLevel, const OUString& i_StyleName)
 371 {
 372     assert(!i_ListId.isEmpty());
 373     assert(io_rLevel >= 0);
 374     NumParaList_t & rNPList( mNPLists[i_ListId] );
 375     const OUString none; // default
 376     if ( rNPList.empty() ) {
 377         // create default list style for top level
 378         sal_Int16 lev(0);
 379         rNPList.push_back(::std::make_pair(none,
 380             MakeNumRule(i_rImport, 0, none, none, lev) ));
 381     }
 382     // create num rule first because this might clamp the level...
 383     uno::Reference<container::XIndexReplace> xNumRules;
 384     if ((0 == io_rLevel) || rNPList.empty() || !i_StyleName.isEmpty()) {
 385         // no parent to inherit from, or explicit style given => new numrules!
 386         // index of parent: level - 1, but maybe that does not exist
 387         const size_t parent( std::min(static_cast<size_t>(io_rLevel),
 388             rNPList.size()) - 1 );
 389         xNumRules = MakeNumRule(i_rImport,
 390             io_rLevel > 0 ? rNPList[parent].second : 0,
 391             io_rLevel > 0 ? rNPList[parent].first  : none,
 392             i_StyleName, io_rLevel);
 393     } else {
 394         // no style given, but has a parent => reuse parent numrules!
 395         ClampLevel(rNPList.back().second, io_rLevel);
 396     }
 397     if (static_cast<sal_uInt16>(io_rLevel) + 1U > rNPList.size()) {
 398         // new level: need to enlarge
 399         for (size_t i = rNPList.size();
 400                 i < static_cast<size_t>(io_rLevel); ++i)
 401         {
 402             NumParaList_t::value_type const rule(rNPList.back());
 403             rNPList.push_back(rule);
 404         }
 405         NumParaList_t::value_type const rule(rNPList.back());
 406         rNPList.push_back(xNumRules.is()
 407             ? ::std::make_pair(i_StyleName, xNumRules)
 408             : rule);
 409     } else {
 410         // old level: no need to enlarge; possibly shrink
 411         if (xNumRules.is()) {
 412             rNPList[io_rLevel] = std::make_pair(i_StyleName, xNumRules);
 413         }
 414         if (static_cast<sal_uInt16>(io_rLevel) + 1U < rNPList.size()) {
 415             rNPList.erase(rNPList.begin() + io_rLevel + 1, rNPList.end());
 416         }
 417     }
 418     // remember the list id
 419     if (mLastNumberedParagraphs.size() <= static_cast<size_t>(io_rLevel)) {
 420         mLastNumberedParagraphs.resize(io_rLevel+1);
 421     }
 422     mLastNumberedParagraphs[io_rLevel] = std::make_pair(i_StyleName, i_ListId);
 423     return rNPList.back().second;
 424 }
 425
 426 /** extracted from the XMLTextListBlockContext constructor */
 427 uno::Reference<container::XIndexReplace>
 428 XMLTextListsHelper::MakeNumRule(
 429     SvXMLImport & i_rImport,
 430     const uno::Reference<container::XIndexReplace>& i_rNumRule,
 431     const OUString& i_ParentStyleName,
 432     const OUString& i_StyleName,
 433     sal_Int16 & io_rLevel,
 434     bool* o_pRestartNumbering,
 435     bool* io_pSetDefaults)
 436 {
 437     static const char s_NumberingRules[] = "NumberingRules";
 438     uno::Reference<container::XIndexReplace> xNumRules(i_rNumRule);
 439     if ( !i_StyleName.isEmpty() && i_StyleName != i_ParentStyleName )
 440     {
 441         const OUString sDisplayStyleName(
 442             i_rImport.GetStyleDisplayName( XML_STYLE_FAMILY_TEXT_LIST,
 443                                              i_StyleName) );
 444         const uno::Reference < container::XNameContainer >& rNumStyles(
 445                             i_rImport.GetTextImport()->GetNumberingStyles() );
 446         if( rNumStyles.is() && rNumStyles->hasByName( sDisplayStyleName ) )
 447         {
 448             uno::Reference < style::XStyle > xStyle;
 449             uno::Any any = rNumStyles->getByName( sDisplayStyleName );
 450             any >>= xStyle;
 451
 452             uno::Reference< beans::XPropertySet > xPropSet( xStyle,
 453                 uno::UNO_QUERY );
 454             any = xPropSet->getPropertyValue(s_NumberingRules);
 455             any >>= xNumRules;
 456         }
 457         else
 458         {
 459             const SvxXMLListStyleContext *pListStyle(
 460                 i_rImport.GetTextImport()->FindAutoListStyle( i_StyleName ) );
 461             if( pListStyle )
 462             {
 463                 xNumRules = pListStyle->GetNumRules();
 464                 if( !xNumRules.is() )
 465                 {
 466                     pListStyle->CreateAndInsertAuto();
 467                     xNumRules = pListStyle->GetNumRules();
 468                 }
 469             }
 470         }
 471     }
 472
 473     bool bSetDefaults(io_pSetDefaults && *io_pSetDefaults);
 474     if ( !xNumRules.is() )
 475     {
 476         // If no style name has been specified for this style and for any
 477         // parent or if no num rule with the specified name exists,
 478         // create a new one.
 479
 480         xNumRules =
 481             SvxXMLListStyleContext::CreateNumRule( i_rImport.GetModel() );
 482         assert(xNumRules.is());
 483         if ( !xNumRules.is() )
 484             return xNumRules;
 485
 486         // Because it is a new num rule, numbering must not be restarted.
 487         if (o_pRestartNumbering) *o_pRestartNumbering = false;
 488         bSetDefaults = true;
 489         if (io_pSetDefaults) *io_pSetDefaults = bSetDefaults;
 490     }
 491
 492     ClampLevel(xNumRules, io_rLevel);
 493
 494     if ( bSetDefaults )
 495     {
 496         // Because there is no list style sheet for this style, a default
 497         // format must be set for any level of this num rule.
 498         SvxXMLListStyleContext::SetDefaultStyle( xNumRules, io_rLevel,
 499             false );
 500     }
 501
 502     return xNumRules;
 503 }
 504
 505 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */