xmloff/source/text/txtlists.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: txtlists.cxx,v $
  10  * $Revision: 1.2.24.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include "precompiled_xmloff.hxx"
  32
  33 #include <txtlists.hxx>
  34
  35 #include <tools/debug.hxx>
  36 #include <tools/date.hxx>
  37 #include <tools/time.hxx>
  38
  39 #include <xmloff/txtimp.hxx>
  40 #include <xmloff/xmlimp.hxx>
  41 #include <xmloff/xmlnumi.hxx>
  42
  43 #include <com/sun/star/style/XStyle.hpp>
  44 #include <com/sun/star/beans/XPropertySet.hpp>
  45 #include "XMLTextListItemContext.hxx"
  46 #include "XMLTextListBlockContext.hxx"
  47 #include "txtparai.hxx"
  48
  49
  50 using namespace ::com::sun::star;
  51
  52
  53 XMLTextListsHelper::XMLTextListsHelper()
  54    :  mpProcessedLists( 0 ),
  55       msLastProcessedListId(),
  56       msListStyleOfLastProcessedList(),
  57       // --> OD 2008-08-15 #i92811#
  58       mpMapListIdToListStyleDefaultListId( 0 ),
  59       // <--
  60       mpContinuingLists( 0 ),
  61       mpListStack( 0 )
  62 {
  63 }
  64
  65 XMLTextListsHelper::~XMLTextListsHelper()
  66 {
  67     if ( mpProcessedLists )
  68     {
  69         mpProcessedLists->clear();
  70         delete mpProcessedLists;
  71     }
  72     // --> OD 2008-08-15 #i92811#
  73     if ( mpMapListIdToListStyleDefaultListId )
  74     {
  75         mpMapListIdToListStyleDefaultListId->clear();
  76         delete mpMapListIdToListStyleDefaultListId;
  77     }
  78     // <--
  79     if ( mpContinuingLists )
  80     {
  81         mpContinuingLists->clear();
  82         delete mpContinuingLists;
  83     }
  84     if ( mpListStack )
  85     {
  86         mpListStack->clear();
  87         delete mpListStack;
  88     }
  89 }
  90
  91 void XMLTextListsHelper::PushListContext(
  92     XMLTextListBlockContext *i_pListBlock)
  93 {
  94 //    fprintf(stderr, "PushListContext\n");
  95     mListStack.push(::boost::make_tuple(i_pListBlock,
  96         static_cast<XMLTextListItemContext*>(0),
  97         static_cast<XMLNumberedParaContext*>(0)));
  98 }
  99
 100 void XMLTextListsHelper::PushListContext(
 101     XMLNumberedParaContext *i_pNumberedParagraph)
 102 {
 103 //    fprintf(stderr, "PushListContext(NP)\n");
 104     mListStack.push(::boost::make_tuple(
 105         static_cast<XMLTextListBlockContext*>(0),
 106         static_cast<XMLTextListItemContext*>(0), i_pNumberedParagraph));
 107 }
 108
 109 void XMLTextListsHelper::PopListContext()
 110 {
 111     OSL_ENSURE(mListStack.size(),
 112         "internal error: PopListContext: mListStack empty");
 113 //    fprintf(stderr, "PopListContext\n");
 114     if ( !mListStack.empty())
 115         mListStack.pop();
 116 }
 117
 118 void XMLTextListsHelper::ListContextTop(
 119     XMLTextListBlockContext*& o_pListBlockContext,
 120     XMLTextListItemContext*& o_pListItemContext,
 121     XMLNumberedParaContext*& o_pNumberedParagraphContext )
 122 {
 123     if ( !mListStack.empty() ) {
 124         o_pListBlockContext =
 125             static_cast<XMLTextListBlockContext*>(&mListStack.top().get<0>());
 126         o_pListItemContext  =
 127             static_cast<XMLTextListItemContext *>(&mListStack.top().get<1>());
 128         o_pNumberedParagraphContext =
 129             static_cast<XMLNumberedParaContext *>(&mListStack.top().get<2>());
 130     }
 131 }
 132
 133 void XMLTextListsHelper::SetListItem( XMLTextListItemContext *i_pListItem )
 134 {
 135     // may be cleared by ListBlockContext for upper list...
 136     if (i_pListItem) {
 137         OSL_ENSURE(mListStack.size(),
 138             "internal error: SetListItem: mListStack empty");
 139         OSL_ENSURE(mListStack.top().get<0>(),
 140             "internal error: SetListItem: mListStack has no ListBlock");
 141         OSL_ENSURE(!mListStack.top().get<1>(),
 142             "error: SetListItem: list item already exists");
 143     }
 144     if ( !mListStack.empty() ) {
 145         mListStack.top().get<1>() = i_pListItem;
 146     }
 147 }
 148
 149 // --> OD 2008-08-15 #i92811# - handling for parameter <sListStyleDefaultListId>
 150 void XMLTextListsHelper::KeepListAsProcessed( ::rtl::OUString sListId,
 151                                               ::rtl::OUString sListStyleName,
 152                                               ::rtl::OUString sContinueListId,
 153                                               ::rtl::OUString sListStyleDefaultListId )
 154 {
 155     if ( IsListProcessed( sListId ) )
 156     {
 157         DBG_ASSERT( false,
 158                     "<XMLTextListsHelper::KeepListAsProcessed(..)> - list id already added" );
 159         return;
 160     }
 161
 162     if ( mpProcessedLists == 0 )
 163     {
 164         mpProcessedLists = new tMapForLists();
 165     }
 166
 167     ::std::pair< ::rtl::OUString, ::rtl::OUString >
 168                                 aListData( sListStyleName, sContinueListId );
 169     (*mpProcessedLists)[ sListId ] = aListData;
 170
 171     msLastProcessedListId = sListId;
 172     msListStyleOfLastProcessedList = sListStyleName;
 173
 174     // --> OD 2008-08-15 #i92811#
 175     if ( sListStyleDefaultListId.getLength() != 0 )
 176     {
 177         if ( mpMapListIdToListStyleDefaultListId == 0 )
 178         {
 179             mpMapListIdToListStyleDefaultListId = new tMapForLists();
 180         }
 181
 182         if ( mpMapListIdToListStyleDefaultListId->find( sListStyleName ) ==
 183                                 mpMapListIdToListStyleDefaultListId->end() )
 184         {
 185             ::std::pair< ::rtl::OUString, ::rtl::OUString >
 186                                 aListIdMapData( sListId, sListStyleDefaultListId );
 187             (*mpMapListIdToListStyleDefaultListId)[ sListStyleName ] =
 188                                                                 aListIdMapData;
 189         }
 190     }
 191     // <--
 192 }
 193
 194 sal_Bool XMLTextListsHelper::IsListProcessed( const ::rtl::OUString sListId ) const
 195 {
 196     if ( mpProcessedLists == 0 )
 197     {
 198         return sal_False;
 199     }
 200
 201     return mpProcessedLists->find( sListId ) != mpProcessedLists->end();
 202 }
 203
 204 ::rtl::OUString XMLTextListsHelper::GetListStyleOfProcessedList(
 205                                             const ::rtl::OUString sListId ) const
 206 {
 207     if ( mpProcessedLists != 0 )
 208     {
 209         tMapForLists::const_iterator aIter = mpProcessedLists->find( sListId );
 210         if ( aIter != mpProcessedLists->end() )
 211         {
 212             return (*aIter).second.first;
 213         }
 214     }
 215
 216     return ::rtl::OUString();
 217 }
 218
 219 ::rtl::OUString XMLTextListsHelper::GetContinueListIdOfProcessedList(
 220                                             const ::rtl::OUString sListId ) const
 221 {
 222     if ( mpProcessedLists != 0 )
 223     {
 224         tMapForLists::const_iterator aIter = mpProcessedLists->find( sListId );
 225         if ( aIter != mpProcessedLists->end() )
 226         {
 227             return (*aIter).second.second;
 228         }
 229     }
 230
 231     return ::rtl::OUString();
 232 }
 233
 234 const ::rtl::OUString& XMLTextListsHelper::GetLastProcessedListId() const
 235 {
 236     return msLastProcessedListId;
 237 }
 238
 239 const ::rtl::OUString& XMLTextListsHelper::GetListStyleOfLastProcessedList() const
 240 {
 241     return msListStyleOfLastProcessedList;
 242 }
 243
 244 ::rtl::OUString XMLTextListsHelper::GenerateNewListId() const
 245 {
 246     // --> OD 2008-08-06 #i92478#
 247     ::rtl::OUString sTmpStr( ::rtl::OUString::createFromAscii( "list" ) );
 248     // <--
 249     sal_Int64 n = Time().GetTime();
 250     n += Date().GetDate();
 251     n += rand();
 252     // --> OD 2008-08-06 #i92478#
 253     sTmpStr += ::rtl::OUString::valueOf( n );
 254     // <--
 255
 256     long nHitCount = 0;
 257     ::rtl::OUString sNewListId( sTmpStr );
 258     if ( mpProcessedLists != 0 )
 259     {
 260         while ( mpProcessedLists->find( sNewListId ) != mpProcessedLists->end() )
 261         {
 262             ++nHitCount;
 263             sNewListId = sTmpStr;
 264             sNewListId += ::rtl::OUString::valueOf( nHitCount );
 265         }
 266     }
 267
 268     return sNewListId;
 269 }
 270
 271 // --> OD 2008-08-15 #i92811#
 272 // provide list id for a certain list block for import
 273 ::rtl::OUString XMLTextListsHelper::GetListIdForListBlock( XMLTextListBlockContext& rListBlock )
 274 {
 275     ::rtl::OUString sListBlockListId( rListBlock.GetContinueListId() );
 276     if ( sListBlockListId.getLength() == 0 )
 277     {
 278         sListBlockListId = rListBlock.GetListId();
 279     }
 280
 281     if ( mpMapListIdToListStyleDefaultListId != 0 )
 282     {
 283         if ( sListBlockListId.getLength() != 0 )
 284         {
 285             const ::rtl::OUString sListStyleName =
 286                                 GetListStyleOfProcessedList( sListBlockListId );
 287
 288             tMapForLists::const_iterator aIter =
 289                     mpMapListIdToListStyleDefaultListId->find( sListStyleName );
 290             if ( aIter != mpMapListIdToListStyleDefaultListId->end() )
 291             {
 292                 if ( (*aIter).second.first == sListBlockListId )
 293                 {
 294                     sListBlockListId = (*aIter).second.second;
 295                 }
 296             }
 297         }
 298     }
 299
 300     return sListBlockListId;
 301 }
 302 // <--
 303
 304 void XMLTextListsHelper::StoreLastContinuingList( ::rtl::OUString sListId,
 305                                                   ::rtl::OUString sContinuingListId )
 306 {
 307     if ( mpContinuingLists == 0 )
 308     {
 309         mpContinuingLists = new tMapForContinuingLists();
 310     }
 311
 312     (*mpContinuingLists)[ sListId ] = sContinuingListId;
 313 }
 314
 315 ::rtl::OUString XMLTextListsHelper::GetLastContinuingListId(
 316                                                 ::rtl::OUString sListId ) const
 317 {
 318     if ( mpContinuingLists != 0)
 319     {
 320         tMapForContinuingLists::const_iterator aIter =
 321                                                 mpContinuingLists->find( sListId );
 322         if ( aIter != mpContinuingLists->end() )
 323         {
 324             return (*aIter).second;
 325         }
 326     }
 327
 328     return sListId;
 329 }
 330
 331 void XMLTextListsHelper::PushListOnStack( ::rtl::OUString sListId,
 332                                           ::rtl::OUString sListStyleName )
 333 {
 334     if ( mpListStack == 0 )
 335     {
 336         mpListStack = new tStackForLists();
 337     }
 338     ::std::pair< ::rtl::OUString, ::rtl::OUString >
 339                                 aListData( sListId, sListStyleName );
 340     mpListStack->push_back( aListData );
 341 }
 342 void XMLTextListsHelper::PopListFromStack()
 343 {
 344     if ( mpListStack != 0 &&
 345          mpListStack->size() > 0 )
 346     {
 347         mpListStack->pop_back();
 348     }
 349 }
 350
 351 sal_Bool XMLTextListsHelper::EqualsToTopListStyleOnStack( const ::rtl::OUString sListId ) const
 352 {
 353     return mpListStack != 0
 354            ? sListId == mpListStack->back().second
 355            : sal_False;
 356 }
 357
 358 ::rtl::OUString
 359 XMLTextListsHelper::GetNumberedParagraphListId(
 360     const sal_uInt16 i_Level,
 361     const ::rtl::OUString i_StyleName)
 362 {
 363     if (!i_StyleName.getLength()) {
 364         OSL_ENSURE(false, "invalid numbered-paragraph: no style-name");
 365     }
 366     if (i_StyleName.getLength()
 367         && (i_Level < mLastNumberedParagraphs.size())
 368         && (mLastNumberedParagraphs[i_Level].first == i_StyleName) )
 369     {
 370         OSL_ENSURE(mLastNumberedParagraphs[i_Level].second.getLength(),
 371             "internal error: numbered-paragraph style-name but no list-id?");
 372         return mLastNumberedParagraphs[i_Level].second;
 373     } else {
 374         return GenerateNewListId();
 375     }
 376 }
 377
 378 static void
 379 ClampLevel(uno::Reference<container::XIndexReplace> const& i_xNumRules,
 380     sal_Int16 & io_rLevel)
 381 {
 382     OSL_ENSURE(i_xNumRules.is(), "internal error: ClampLevel: NumRules null");
 383     if (i_xNumRules.is()) {
 384         const sal_Int32 nLevelCount( i_xNumRules->getCount() );
 385         if ( io_rLevel >= nLevelCount ) {
 386             io_rLevel = sal::static_int_cast< sal_Int16 >(nLevelCount-1);
 387         }
 388     }
 389 }
 390
 391 uno::Reference<container::XIndexReplace>
 392 XMLTextListsHelper::EnsureNumberedParagraph(
 393     SvXMLImport & i_rImport,
 394     const ::rtl::OUString i_ListId,
 395     sal_Int16 & io_rLevel, const ::rtl::OUString i_StyleName)
 396 {
 397     OSL_ENSURE(i_ListId.getLength(), "inavlid ListId");
 398     OSL_ENSURE(io_rLevel >= 0, "inavlid Level");
 399     NumParaList_t & rNPList( mNPLists[i_ListId] );
 400     const ::rtl::OUString none; // default
 401     if ( rNPList.empty() && (0 != io_rLevel)) {
 402         // create default list style for top level
 403         sal_Int16 lev(0);
 404         rNPList.push_back(::std::make_pair(none,
 405             MakeNumRule(i_rImport, 0, none, none, lev) ));
 406     }
 407     // create num rule first because this might clamp the level...
 408     uno::Reference<container::XIndexReplace> xNumRules;
 409     if ((0 == io_rLevel) || rNPList.empty() || i_StyleName.getLength()) {
 410         // no parent to inherit from, or explicit style given => new numrules!
 411         // index of parent: level - 1, but maybe that does not exist
 412         const size_t parent( std::min(static_cast<size_t>(io_rLevel),
 413             rNPList.size()) - 1 );
 414         xNumRules = MakeNumRule(i_rImport,
 415             io_rLevel > 0 ? rNPList[parent].second : 0,
 416             io_rLevel > 0 ? rNPList[parent].first  : none,
 417             i_StyleName, io_rLevel);
 418     } else {
 419         // no style given, but has a parent => reuse parent numrules!
 420         ClampLevel(rNPList.back().second, io_rLevel);
 421     }
 422     if (static_cast<sal_uInt16>(io_rLevel) + 1U > rNPList.size()) {
 423         // new level: need to enlarge
 424         for (size_t i = rNPList.size();
 425                 i < static_cast<size_t>(io_rLevel); ++i) {
 426             rNPList.push_back(rNPList.back());
 427         }
 428         rNPList.push_back(xNumRules.is()
 429             ? ::std::make_pair(i_StyleName, xNumRules)
 430             : rNPList.back());
 431     } else {
 432         // old level: no need to enlarge; possibly shrink
 433         if (xNumRules.is()) {
 434             rNPList[io_rLevel] = std::make_pair(i_StyleName, xNumRules);
 435         }
 436         if (static_cast<sal_uInt16>(io_rLevel) + 1U < rNPList.size()) {
 437             rNPList.erase(rNPList.begin() + io_rLevel + 1, rNPList.end());
 438         }
 439     }
 440     // remember the list id
 441     if (mLastNumberedParagraphs.size() <= static_cast<size_t>(io_rLevel)) {
 442         mLastNumberedParagraphs.resize(io_rLevel+1);
 443     }
 444     mLastNumberedParagraphs[io_rLevel] = std::make_pair(i_StyleName, i_ListId);
 445     return rNPList.back().second;
 446 }
 447
 448 /** extracted from the XMLTextListBlockContext constructor */
 449 uno::Reference<container::XIndexReplace>
 450 XMLTextListsHelper::MakeNumRule(
 451     SvXMLImport & i_rImport,
 452     const uno::Reference<container::XIndexReplace>& i_rNumRule,
 453     const ::rtl::OUString i_ParentStyleName,
 454     const ::rtl::OUString i_StyleName,
 455     sal_Int16 & io_rLevel,
 456     sal_Bool* o_pRestartNumbering,
 457     sal_Bool* io_pSetDefaults)
 458 {
 459     uno::Reference<container::XIndexReplace> xNumRules(i_rNumRule);
 460     if ( i_StyleName.getLength() &&
 461          i_StyleName != i_ParentStyleName )
 462     {
 463         const ::rtl::OUString sDisplayStyleName(
 464             i_rImport.GetStyleDisplayName( XML_STYLE_FAMILY_TEXT_LIST,
 465                                              i_StyleName) );
 466         const uno::Reference < container::XNameContainer >& rNumStyles(
 467                             i_rImport.GetTextImport()->GetNumberingStyles() );
 468         if( rNumStyles.is() && rNumStyles->hasByName( sDisplayStyleName ) )
 469         {
 470             uno::Reference < style::XStyle > xStyle;
 471             uno::Any any = rNumStyles->getByName( sDisplayStyleName );
 472             any >>= xStyle;
 473
 474             // --> OD 2008-05-07 #refactorlists# - no longer needed
 475 //            // If the style has not been used, the restart numbering has
 476 //            // to be set never.
 477 //            if ( mbRestartNumbering && !xStyle->isInUse() )
 478 //            {
 479 //                mbRestartNumbering = sal_False;
 480 //            }
 481             // <--
 482
 483             uno::Reference< beans::XPropertySet > xPropSet( xStyle,
 484                 uno::UNO_QUERY );
 485             any = xPropSet->getPropertyValue(
 486                 i_rImport.GetTextImport()->sNumberingRules );
 487             any >>= xNumRules;
 488         }
 489         else
 490         {
 491             const SvxXMLListStyleContext *pListStyle(
 492                 i_rImport.GetTextImport()->FindAutoListStyle( i_StyleName ) );
 493             if( pListStyle )
 494             {
 495                 xNumRules = pListStyle->GetNumRules();
 496                 // --> OD 2008-05-07 #refactorlists# - no longer needed
 497 //                sal_Bool bUsed = mxNumRules.is();
 498                 // <--
 499                 if( !xNumRules.is() )
 500                 {
 501                     pListStyle->CreateAndInsertAuto();
 502                     xNumRules = pListStyle->GetNumRules();
 503                 }
 504                 // --> OD 2008-05-07 #refactorlists# - no longer needed
 505 //                if( mbRestartNumbering && !bUsed )
 506 //                    mbRestartNumbering = sal_False;
 507                 // <--
 508             }
 509         }
 510     }
 511
 512     sal_Bool bSetDefaults(io_pSetDefaults ? *io_pSetDefaults : sal_False);
 513     if ( !xNumRules.is() )
 514     {
 515         // If no style name has been specified for this style and for any
 516         // parent or if no num rule with the specified name exists,
 517         // create a new one.
 518
 519         xNumRules =
 520             SvxXMLListStyleContext::CreateNumRule( i_rImport.GetModel() );
 521         DBG_ASSERT( xNumRules.is(), "got no numbering rule" );
 522         if ( !xNumRules.is() )
 523             return xNumRules;
 524
 525         // Because it is a new num rule, numbering must not be restarted.
 526         if (o_pRestartNumbering) *o_pRestartNumbering = sal_False;
 527         bSetDefaults = sal_True;
 528         if (io_pSetDefaults) *io_pSetDefaults = bSetDefaults;
 529     }
 530
 531     ClampLevel(xNumRules, io_rLevel);
 532
 533     if ( bSetDefaults )
 534     {
 535         // Because there is no list style sheet for this style, a default
 536         // format must be set for any level of this num rule.
 537         SvxXMLListStyleContext::SetDefaultStyle( xNumRules, io_rLevel,
 538             sal_False );
 539     }
 540
 541     return xNumRules;
 542 }
 543