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