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 "doceventnotifier.hxx"
21 : #include "scriptdocument.hxx"
22 :
23 : #include <com/sun/star/frame/theGlobalEventBroadcaster.hpp>
24 :
25 : #include <vcl/svapp.hxx>
26 :
27 : #include <tools/diagnose_ex.h>
28 :
29 : #include <comphelper/processfactory.hxx>
30 :
31 :
32 : #include <cppuhelper/compbase1.hxx>
33 : #include <cppuhelper/basemutex.hxx>
34 :
35 : namespace basctl
36 : {
37 :
38 : using ::com::sun::star::document::XDocumentEventBroadcaster;
39 : using ::com::sun::star::document::XDocumentEventListener;
40 : using ::com::sun::star::document::DocumentEvent;
41 : using ::com::sun::star::uno::XComponentContext;
42 : using ::com::sun::star::uno::RuntimeException;
43 : using ::com::sun::star::uno::Reference;
44 : using ::com::sun::star::uno::UNO_QUERY_THROW;
45 : using ::com::sun::star::uno::Exception;
46 : using ::com::sun::star::frame::XModel;
47 : using ::com::sun::star::frame::theGlobalEventBroadcaster;
48 : using ::com::sun::star::uno::UNO_QUERY;
49 :
50 : namespace csslang = ::com::sun::star::lang;
51 :
52 : // DocumentEventNotifier::Impl
53 :
54 : typedef ::cppu::WeakComponentImplHelper1 < XDocumentEventListener
55 : > DocumentEventNotifier_Impl_Base;
56 :
57 : enum ListenerAction
58 : {
59 : RegisterListener,
60 : RemoveListener
61 : };
62 :
63 : /** impl class for DocumentEventNotifier
64 : */
65 : class DocumentEventNotifier::Impl :public ::boost::noncopyable
66 : ,public ::cppu::BaseMutex
67 : ,public DocumentEventNotifier_Impl_Base
68 : {
69 : public:
70 : Impl (DocumentEventListener&, Reference<XModel> const& rxDocument);
71 : virtual ~Impl ();
72 :
73 : // XDocumentEventListener
74 : virtual void SAL_CALL documentEventOccured( const DocumentEvent& Event ) throw (RuntimeException, std::exception) SAL_OVERRIDE;
75 :
76 : // XEventListener
77 : virtual void SAL_CALL disposing( const csslang::EventObject& Event ) throw (RuntimeException, std::exception) SAL_OVERRIDE;
78 :
79 : // ComponentHelper
80 : virtual void SAL_CALL disposing() SAL_OVERRIDE;
81 :
82 : private:
83 : /// determines whether the instance is already disposed
84 0 : bool impl_isDisposed_nothrow() const { return m_pListener == NULL; }
85 :
86 : /// disposes the instance
87 : void impl_dispose_nothrow();
88 :
89 : /// registers or revokes the instance as listener at the global event broadcaster
90 : void impl_listenerAction_nothrow( ListenerAction _eAction );
91 :
92 : private:
93 : DocumentEventListener* m_pListener;
94 : Reference< XModel > m_xModel;
95 : };
96 :
97 0 : DocumentEventNotifier::Impl::Impl (DocumentEventListener& rListener, Reference<XModel> const& rxDocument) :
98 : DocumentEventNotifier_Impl_Base(m_aMutex),
99 : m_pListener(&rListener),
100 0 : m_xModel(rxDocument)
101 : {
102 0 : osl_atomic_increment( &m_refCount );
103 0 : impl_listenerAction_nothrow( RegisterListener );
104 0 : osl_atomic_decrement( &m_refCount );
105 0 : }
106 :
107 0 : DocumentEventNotifier::Impl::~Impl ()
108 : {
109 0 : if ( !impl_isDisposed_nothrow() )
110 : {
111 0 : acquire();
112 0 : dispose();
113 : }
114 0 : }
115 :
116 0 : void SAL_CALL DocumentEventNotifier::Impl::documentEventOccured( const DocumentEvent& _rEvent ) throw (RuntimeException, std::exception)
117 : {
118 0 : ::osl::ClearableMutexGuard aGuard( m_aMutex );
119 :
120 : OSL_PRECOND( !impl_isDisposed_nothrow(), "DocumentEventNotifier::Impl::notifyEvent: disposed, but still getting events?" );
121 0 : if ( impl_isDisposed_nothrow() )
122 0 : return;
123 :
124 0 : Reference< XModel > xDocument( _rEvent.Source, UNO_QUERY );
125 : OSL_ENSURE( xDocument.is(), "DocumentEventNotifier::Impl::notifyEvent: illegal source document!" );
126 0 : if ( !xDocument.is() )
127 0 : return;
128 :
129 : struct EventEntry
130 : {
131 : const sal_Char* pEventName;
132 : void (DocumentEventListener::*listenerMethod)( const ScriptDocument& _rDocument );
133 : };
134 : EventEntry aEvents[] = {
135 : { "OnNew", &DocumentEventListener::onDocumentCreated },
136 : { "OnLoad", &DocumentEventListener::onDocumentOpened },
137 : { "OnSave", &DocumentEventListener::onDocumentSave },
138 : { "OnSaveDone", &DocumentEventListener::onDocumentSaveDone },
139 : { "OnSaveAs", &DocumentEventListener::onDocumentSaveAs },
140 : { "OnSaveAsDone", &DocumentEventListener::onDocumentSaveAsDone },
141 : { "OnUnload", &DocumentEventListener::onDocumentClosed },
142 : { "OnTitleChanged", &DocumentEventListener::onDocumentTitleChanged },
143 : { "OnModeChanged", &DocumentEventListener::onDocumentModeChanged }
144 0 : };
145 :
146 0 : for ( size_t i=0; i < SAL_N_ELEMENTS( aEvents ); ++i )
147 : {
148 0 : if ( !_rEvent.EventName.equalsAscii( aEvents[i].pEventName ) )
149 0 : continue;
150 :
151 0 : ScriptDocument aDocument( xDocument );
152 : {
153 : // the listener implementations usually require the SolarMutex, so lock it here.
154 : // But ensure the proper order of locking the solar and the own mutex
155 0 : aGuard.clear();
156 0 : SolarMutexGuard aSolarGuard;
157 0 : ::osl::MutexGuard aGuard2( m_aMutex );
158 :
159 0 : if ( impl_isDisposed_nothrow() )
160 : // somebody took the chance to dispose us -> bail out
161 0 : return;
162 :
163 0 : (m_pListener->*aEvents[i].listenerMethod)( aDocument );
164 : }
165 0 : break;
166 0 : }
167 : }
168 :
169 0 : void SAL_CALL DocumentEventNotifier::Impl::disposing( const csslang::EventObject& /*Event*/ ) throw (RuntimeException, std::exception)
170 : {
171 0 : SolarMutexGuard aSolarGuard;
172 0 : ::osl::MutexGuard aGuard( m_aMutex );
173 :
174 0 : if ( !impl_isDisposed_nothrow() )
175 0 : impl_dispose_nothrow();
176 0 : }
177 :
178 0 : void SAL_CALL DocumentEventNotifier::Impl::disposing()
179 : {
180 0 : impl_listenerAction_nothrow( RemoveListener );
181 0 : impl_dispose_nothrow();
182 0 : }
183 :
184 0 : void DocumentEventNotifier::Impl::impl_dispose_nothrow()
185 : {
186 0 : m_pListener = NULL;
187 0 : m_xModel.clear();
188 0 : }
189 :
190 0 : void DocumentEventNotifier::Impl::impl_listenerAction_nothrow( ListenerAction _eAction )
191 : {
192 : try
193 : {
194 0 : Reference< XDocumentEventBroadcaster > xBroadcaster;
195 0 : if ( m_xModel.is() )
196 0 : xBroadcaster.set( m_xModel, UNO_QUERY_THROW );
197 : else
198 : {
199 : Reference< com::sun::star::uno::XComponentContext > aContext(
200 0 : comphelper::getProcessComponentContext() );
201 0 : xBroadcaster = theGlobalEventBroadcaster::get(aContext);
202 : }
203 :
204 : void ( SAL_CALL XDocumentEventBroadcaster::*listenerAction )( const Reference< XDocumentEventListener >& ) =
205 0 : ( _eAction == RegisterListener ) ? &XDocumentEventBroadcaster::addDocumentEventListener : &XDocumentEventBroadcaster::removeDocumentEventListener;
206 0 : (xBroadcaster.get()->*listenerAction)( this );
207 : }
208 0 : catch( const Exception& )
209 : {
210 : DBG_UNHANDLED_EXCEPTION();
211 : }
212 0 : }
213 :
214 : // DocumentEventNotifier
215 :
216 0 : DocumentEventNotifier::DocumentEventNotifier (DocumentEventListener& rListener, Reference<XModel> const& rxDocument) :
217 0 : m_pImpl(new Impl(rListener, rxDocument))
218 0 : { }
219 :
220 0 : DocumentEventNotifier::DocumentEventNotifier (DocumentEventListener& rListener) :
221 0 : m_pImpl(new Impl(rListener, Reference<XModel>()))
222 0 : { }
223 :
224 0 : DocumentEventNotifier::~DocumentEventNotifier()
225 : {
226 0 : }
227 :
228 0 : void DocumentEventNotifier::dispose()
229 : {
230 0 : m_pImpl->dispose();
231 0 : }
232 :
233 : // DocumentEventListener
234 :
235 0 : DocumentEventListener::~DocumentEventListener()
236 : {
237 0 : }
238 :
239 : } // namespace basctl
240 :
241 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
