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