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 : #include "MasterPageObserver.hxx"
21 :
22 : #include <algorithm>
23 : #include "drawdoc.hxx"
24 : #include "sdpage.hxx"
25 : #include <boost/unordered_map.hpp>
26 : #include <set>
27 : #include <vector>
28 : #include <svl/lstner.hxx>
29 : #include <osl/doublecheckedlocking.h>
30 : #include <osl/getglobalmutex.hxx>
31 :
32 :
33 : namespace sd {
34 :
35 0 : class MasterPageObserver::Implementation
36 : : public SfxListener
37 : {
38 : public:
39 : /** The single instance of this class. It is created on demand when
40 : Instance() is called for the first time.
41 : */
42 : static MasterPageObserver* mpInstance;
43 :
44 : /** The master page observer will listen to events of this document and
45 : detect changes of the use of master pages.
46 : */
47 : void RegisterDocument (SdDrawDocument& rDocument);
48 :
49 : /** The master page observer will stop to listen to events of this
50 : document.
51 : */
52 : void UnregisterDocument (SdDrawDocument& rDocument);
53 :
54 : /** Add a listener that is informed of master pages that are newly
55 : assigned to slides or become unassigned.
56 : @param rEventListener
57 : The event listener to call for future events. Call
58 : RemoveEventListener() before the listener is destroyed.
59 : */
60 : void AddEventListener (const Link& rEventListener);
61 :
62 : /** Remove the given listener from the list of listeners.
63 : @param rEventListener
64 : After this method returns the given listener is not called back
65 : from this object. Passing a listener that has not
66 : been registered before is safe and is silently ignored.
67 : */
68 : void RemoveEventListener (const Link& rEventListener);
69 :
70 : /** Return a set of the names of master pages for the given document.
71 : This convenience method exists because this set is part of the
72 : internal data structure and thus takes no time to create.
73 : */
74 : inline MasterPageObserver::MasterPageNameSet GetMasterPageNames (
75 : SdDrawDocument& rDocument);
76 :
77 : private:
78 : ::std::vector<Link> maListeners;
79 :
80 : struct DrawDocHash {
81 0 : size_t operator()(SdDrawDocument* argument) const
82 0 : { return reinterpret_cast<unsigned long>(argument); }
83 : };
84 : typedef ::boost::unordered_map<SdDrawDocument*,
85 : MasterPageObserver::MasterPageNameSet,
86 : DrawDocHash>
87 : MasterPageContainer;
88 : MasterPageContainer maUsedMasterPages;
89 :
90 : virtual void Notify(
91 : SfxBroadcaster& rBroadcaster,
92 : const SfxHint& rHint) SAL_OVERRIDE;
93 :
94 : void AnalyzeUsedMasterPages (SdDrawDocument& rDocument);
95 :
96 : void SendEvent (MasterPageObserverEvent& rEvent);
97 : };
98 :
99 : MasterPageObserver* MasterPageObserver::Implementation::mpInstance = NULL;
100 :
101 :
102 :
103 : //===== MasterPageObserver ====================================================
104 :
105 0 : MasterPageObserver& MasterPageObserver::Instance (void)
106 : {
107 0 : if (Implementation::mpInstance == NULL)
108 : {
109 : ::osl::GetGlobalMutex aMutexFunctor;
110 0 : ::osl::MutexGuard aGuard (aMutexFunctor());
111 0 : if (Implementation::mpInstance == NULL)
112 : {
113 0 : MasterPageObserver* pInstance = new MasterPageObserver ();
114 0 : SdGlobalResourceContainer::Instance().AddResource (
115 0 : ::std::auto_ptr<SdGlobalResource>(pInstance));
116 : OSL_DOUBLE_CHECKED_LOCKING_MEMORY_BARRIER();
117 0 : Implementation::mpInstance = pInstance;
118 0 : }
119 : }
120 : else
121 : {
122 : OSL_DOUBLE_CHECKED_LOCKING_MEMORY_BARRIER();
123 : }
124 :
125 : DBG_ASSERT(Implementation::mpInstance!=NULL,
126 : "MasterPageObserver::Instance(): instance is NULL");
127 0 : return *Implementation::mpInstance;
128 : }
129 :
130 :
131 :
132 :
133 0 : void MasterPageObserver::RegisterDocument (SdDrawDocument& rDocument)
134 : {
135 0 : mpImpl->RegisterDocument (rDocument);
136 0 : }
137 :
138 :
139 :
140 :
141 0 : void MasterPageObserver::UnregisterDocument (SdDrawDocument& rDocument)
142 : {
143 0 : mpImpl->UnregisterDocument (rDocument);
144 0 : }
145 :
146 :
147 :
148 :
149 0 : void MasterPageObserver::AddEventListener (const Link& rEventListener)
150 : {
151 :
152 0 : mpImpl->AddEventListener (rEventListener);
153 0 : }
154 :
155 :
156 :
157 :
158 0 : void MasterPageObserver::RemoveEventListener (const Link& rEventListener)
159 : {
160 0 : mpImpl->RemoveEventListener (rEventListener);
161 0 : }
162 :
163 :
164 :
165 :
166 0 : MasterPageObserver::MasterPageObserver (void)
167 0 : : mpImpl (new Implementation())
168 0 : {}
169 :
170 :
171 :
172 :
173 0 : MasterPageObserver::~MasterPageObserver (void)
174 0 : {}
175 :
176 :
177 :
178 :
179 : //===== MasterPageObserver::Implementation ====================================
180 :
181 0 : void MasterPageObserver::Implementation::RegisterDocument (
182 : SdDrawDocument& rDocument)
183 : {
184 : // Gather the names of all the master pages in the given document.
185 0 : MasterPageContainer::mapped_type aMasterPageSet;
186 0 : sal_uInt16 nMasterPageCount = rDocument.GetMasterSdPageCount(PK_STANDARD);
187 0 : for (sal_uInt16 nIndex=0; nIndex<nMasterPageCount; nIndex++)
188 : {
189 0 : SdPage* pMasterPage = rDocument.GetMasterSdPage (nIndex, PK_STANDARD);
190 0 : if (pMasterPage != NULL)
191 0 : aMasterPageSet.insert (pMasterPage->GetName());
192 : }
193 :
194 0 : maUsedMasterPages[&rDocument] = aMasterPageSet;
195 :
196 0 : StartListening (rDocument);
197 0 : }
198 :
199 :
200 :
201 :
202 0 : void MasterPageObserver::Implementation::UnregisterDocument (
203 : SdDrawDocument& rDocument)
204 : {
205 0 : EndListening (rDocument);
206 :
207 0 : MasterPageContainer::iterator aMasterPageDescriptor(maUsedMasterPages.find(&rDocument));
208 0 : if(aMasterPageDescriptor != maUsedMasterPages.end())
209 0 : maUsedMasterPages.erase(aMasterPageDescriptor);
210 0 : }
211 :
212 :
213 :
214 :
215 0 : void MasterPageObserver::Implementation::AddEventListener (
216 : const Link& rEventListener)
217 : {
218 0 : if (::std::find (
219 : maListeners.begin(),
220 : maListeners.end(),
221 0 : rEventListener) == maListeners.end())
222 : {
223 0 : maListeners.push_back (rEventListener);
224 :
225 : // Tell the new listener about all the master pages that are
226 : // currently in use.
227 0 : MasterPageContainer::iterator aDocumentIterator;
228 0 : for (aDocumentIterator=maUsedMasterPages.begin();
229 0 : aDocumentIterator!=maUsedMasterPages.end();
230 : ++aDocumentIterator)
231 : {
232 0 : ::std::set<OUString>::reverse_iterator aNameIterator;
233 0 : for (aNameIterator=aDocumentIterator->second.rbegin();
234 0 : aNameIterator!=aDocumentIterator->second.rend();
235 : ++aNameIterator)
236 : {
237 : MasterPageObserverEvent aEvent (
238 : MasterPageObserverEvent::ET_MASTER_PAGE_EXISTS,
239 0 : *aDocumentIterator->first,
240 0 : *aNameIterator);
241 0 : SendEvent (aEvent);
242 : }
243 : }
244 : }
245 0 : }
246 :
247 :
248 :
249 :
250 0 : void MasterPageObserver::Implementation::RemoveEventListener (
251 : const Link& rEventListener)
252 : {
253 : maListeners.erase (
254 : ::std::find (
255 : maListeners.begin(),
256 : maListeners.end(),
257 0 : rEventListener));
258 0 : }
259 :
260 :
261 :
262 :
263 : MasterPageObserver::MasterPageNameSet
264 : MasterPageObserver::Implementation::GetMasterPageNames (
265 : SdDrawDocument& rDocument)
266 : {
267 : MasterPageContainer::iterator aMasterPageDescriptor (
268 : maUsedMasterPages.find(&rDocument));
269 : if (aMasterPageDescriptor != maUsedMasterPages.end())
270 : return aMasterPageDescriptor->second;
271 : else
272 : // Not found so return an empty set.
273 : return MasterPageObserver::MasterPageNameSet();
274 : }
275 :
276 :
277 :
278 :
279 0 : void MasterPageObserver::Implementation::Notify(
280 : SfxBroadcaster& rBroadcaster,
281 : const SfxHint& rHint)
282 : {
283 0 : if (rHint.ISA(SdrHint))
284 : {
285 0 : SdrHint& rSdrHint (*PTR_CAST(SdrHint,&rHint));
286 0 : switch (rSdrHint.GetKind())
287 : {
288 : case HINT_PAGEORDERCHG:
289 : // Process the modified set of pages only when the number of
290 : // standard and notes master pages are equal. This test
291 : // filters out events that are sent in between the insertion
292 : // of a new standard master page and a new notes master
293 : // page.
294 0 : if (rBroadcaster.ISA(SdDrawDocument))
295 : {
296 : SdDrawDocument& rDocument (
297 0 : static_cast<SdDrawDocument&>(rBroadcaster));
298 0 : if (rDocument.GetMasterSdPageCount(PK_STANDARD)
299 0 : == rDocument.GetMasterSdPageCount(PK_NOTES))
300 : {
301 0 : AnalyzeUsedMasterPages (rDocument);
302 : }
303 : }
304 0 : break;
305 :
306 : default:
307 0 : break;
308 : }
309 : }
310 0 : }
311 :
312 :
313 :
314 :
315 0 : void MasterPageObserver::Implementation::AnalyzeUsedMasterPages (
316 : SdDrawDocument& rDocument)
317 : {
318 : // Create a set of names of the master pages used by the given document.
319 0 : sal_uInt16 nMasterPageCount = rDocument.GetMasterSdPageCount(PK_STANDARD);
320 0 : ::std::set<OUString> aCurrentMasterPages;
321 0 : for (sal_uInt16 nIndex=0; nIndex<nMasterPageCount; nIndex++)
322 : {
323 0 : SdPage* pMasterPage = rDocument.GetMasterSdPage (nIndex, PK_STANDARD);
324 0 : if (pMasterPage != NULL)
325 0 : aCurrentMasterPages.insert (pMasterPage->GetName());
326 : OSL_TRACE("currently used master page %d is %s",
327 : nIndex,
328 : ::rtl::OUStringToOString(pMasterPage->GetName(),
329 : RTL_TEXTENCODING_UTF8).getStr());
330 : }
331 :
332 : typedef ::std::vector<OUString> StringList;
333 0 : StringList aNewMasterPages;
334 0 : StringList aRemovedMasterPages;
335 : MasterPageContainer::iterator aOldMasterPagesDescriptor (
336 0 : maUsedMasterPages.find(&rDocument));
337 0 : if (aOldMasterPagesDescriptor != maUsedMasterPages.end())
338 : {
339 0 : StringList::iterator I;
340 :
341 0 : ::std::set<OUString>::iterator J;
342 0 : int i=0;
343 0 : for (J=aOldMasterPagesDescriptor->second.begin();
344 0 : J!=aOldMasterPagesDescriptor->second.end();
345 : ++J)
346 : OSL_TRACE("old used master page %d is %s",
347 : i++,
348 : ::rtl::OUStringToOString(*J,
349 : RTL_TEXTENCODING_UTF8).getStr());
350 :
351 : // Send events about the newly used master pages.
352 : ::std::set_difference (
353 : aCurrentMasterPages.begin(),
354 : aCurrentMasterPages.end(),
355 0 : aOldMasterPagesDescriptor->second.begin(),
356 0 : aOldMasterPagesDescriptor->second.end(),
357 0 : ::std::back_insert_iterator<StringList>(aNewMasterPages));
358 0 : for (I=aNewMasterPages.begin(); I!=aNewMasterPages.end(); ++I)
359 : {
360 : OSL_TRACE(" added master page %s",
361 : ::rtl::OUStringToOString(*I,
362 : RTL_TEXTENCODING_UTF8).getStr());
363 :
364 : MasterPageObserverEvent aEvent (
365 : MasterPageObserverEvent::ET_MASTER_PAGE_ADDED,
366 : rDocument,
367 0 : *I);
368 0 : SendEvent (aEvent);
369 : }
370 :
371 : // Send events about master pages that are not used any longer.
372 : ::std::set_difference (
373 0 : aOldMasterPagesDescriptor->second.begin(),
374 0 : aOldMasterPagesDescriptor->second.end(),
375 : aCurrentMasterPages.begin(),
376 : aCurrentMasterPages.end(),
377 0 : ::std::back_insert_iterator<StringList>(aRemovedMasterPages));
378 0 : for (I=aRemovedMasterPages.begin(); I!=aRemovedMasterPages.end(); ++I)
379 : {
380 : OSL_TRACE(" removed master page %s",
381 : ::rtl::OUStringToOString(*I,
382 : RTL_TEXTENCODING_UTF8).getStr());
383 :
384 : MasterPageObserverEvent aEvent (
385 : MasterPageObserverEvent::ET_MASTER_PAGE_REMOVED,
386 : rDocument,
387 0 : *I);
388 0 : SendEvent (aEvent);
389 : }
390 :
391 : // Store the new list of master pages.
392 0 : aOldMasterPagesDescriptor->second = aCurrentMasterPages;
393 0 : }
394 0 : }
395 :
396 :
397 :
398 :
399 0 : void MasterPageObserver::Implementation::SendEvent (
400 : MasterPageObserverEvent& rEvent)
401 : {
402 0 : ::std::vector<Link>::iterator aLink (maListeners.begin());
403 0 : ::std::vector<Link>::iterator aEnd (maListeners.end());
404 0 : while (aLink!=aEnd)
405 : {
406 0 : aLink->Call (&rEvent);
407 0 : ++aLink;
408 : }
409 0 : }
410 :
411 :
412 : } // end of namespace sd
413 :
414 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
