247 lines
10 KiB
C++
247 lines
10 KiB
C++
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2000, 2010 Oracle and/or its affiliates.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __FRAMEWORK_JOBS_JOB_HXX_
|
|
#define __FRAMEWORK_JOBS_JOB_HXX_
|
|
|
|
//_______________________________________
|
|
// my own includes
|
|
|
|
#include <jobs/jobresult.hxx>
|
|
#include <jobs/jobdata.hxx>
|
|
#include <threadhelp/threadhelpbase.hxx>
|
|
#include <macros/debug.hxx>
|
|
#include <macros/xinterface.hxx>
|
|
#include <macros/xtypeprovider.hxx>
|
|
#include <stdtypes.h>
|
|
#include <general.h>
|
|
|
|
//_______________________________________
|
|
// interface includes
|
|
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
|
#include <com/sun/star/lang/XTypeProvider.hpp>
|
|
#include <com/sun/star/frame/XFrame.hpp>
|
|
#include <com/sun/star/frame/XDesktop.hpp>
|
|
#include <com/sun/star/frame/XDispatchResultListener.hpp>
|
|
#include <com/sun/star/task/XJobListener.hpp>
|
|
#include <com/sun/star/util/XCloseListener.hpp>
|
|
#include <com/sun/star/frame/DispatchResultEvent.hpp>
|
|
|
|
//_______________________________________
|
|
// other includes
|
|
#include <cppuhelper/weak.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
|
|
//_______________________________________
|
|
// namespace
|
|
|
|
namespace framework{
|
|
|
|
//_______________________________________
|
|
// public const
|
|
|
|
//_______________________________________
|
|
// definitions
|
|
|
|
/**
|
|
@short it represent a job; execute it and control it's lifetime
|
|
|
|
@descr This implemetation can be used to wrapp jobs, execute it
|
|
synchronously or asynchronous, control it's lifetime
|
|
and differe between jobs with and without configuration.
|
|
*/
|
|
class Job : public css::lang::XTypeProvider
|
|
, public css::task::XJobListener
|
|
, public css::frame::XTerminateListener
|
|
, public css::util::XCloseListener
|
|
, private ThreadHelpBase
|
|
, public ::cppu::OWeakObject
|
|
{
|
|
//___________________________________
|
|
// structs
|
|
|
|
private:
|
|
|
|
/** different possible states for the internal wrapped job.
|
|
It can be started, stopped by a queryClosing() request or
|
|
disposed() by a notifyClosing() request ...
|
|
*/
|
|
enum ERunState
|
|
{
|
|
E_NEW,
|
|
E_RUNNING,
|
|
E_STOPPED_OR_FINISHED,
|
|
E_DISPOSED
|
|
};
|
|
|
|
//___________________________________
|
|
// member
|
|
|
|
private:
|
|
|
|
/**
|
|
hold all neccessary informations about this job.
|
|
It can be used for both modes: with and without configuration.
|
|
*/
|
|
JobData m_aJobCfg;
|
|
|
|
/**
|
|
We need it to create own services on demand.
|
|
*/
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
|
|
|
|
/**
|
|
Hold the (may asynchronous) job alive.
|
|
*/
|
|
css::uno::Reference< css::uno::XInterface > m_xJob;
|
|
|
|
/**
|
|
Used to wait for finishing of asynchronous started jobs.
|
|
*/
|
|
::osl::Condition m_aAsyncWait;
|
|
|
|
/**
|
|
For some special cases we must know the environment, in which
|
|
this job runs. Means the frame inside which we may was triggered.
|
|
We use it too, to listen for closing events of this ressource.
|
|
|
|
Please note: If m_xFrame is set - m_xModel should be NULL.
|
|
Only one environment can be supported realy.
|
|
*/
|
|
css::uno::Reference< css::frame::XFrame > m_xFrame;
|
|
|
|
/**
|
|
For some special cases we must know the environment, in which
|
|
this job runs. Means the document inside which we may was triggered.
|
|
We use it too, to listen for closing events of this ressource.
|
|
|
|
Please note: If m_xModel is set - m_xFrame should be NULL.
|
|
Only one environment can be supported realy.
|
|
*/
|
|
css::uno::Reference< css::frame::XModel > m_xModel;
|
|
|
|
/**
|
|
We are registered at this instance to listen for office shutdown events.
|
|
It's neccessary supress it (if possible) or to react in the right way.
|
|
*/
|
|
css::uno::Reference< css::frame::XDesktop > m_xDesktop;
|
|
|
|
/**
|
|
A job can return a dispatch result event after finishing its work.
|
|
We have to transport it to any outside interested listener then.
|
|
(see m_xResultSourceFake for further informations too!)
|
|
*/
|
|
css::uno::Reference< css::frame::XDispatchResultListener > m_xResultListener;
|
|
|
|
/**
|
|
We can't set ourself as source of a dispatch result event ... nor our job.
|
|
Because the listener (set as m_xResultListener) expect the original instance,
|
|
where it was registered. This original instance is the user of this class.
|
|
It must be set explicitly and will be used to fake the source of the event!
|
|
*/
|
|
css::uno::Reference< css::uno::XInterface > m_xResultSourceFake;
|
|
|
|
/**
|
|
Holds the state, if we are listen for desktop/frame or model closing events or not.
|
|
The used references are not realy enough to detect a valid listener connection.
|
|
Thats why we use this additional information here too.
|
|
*/
|
|
sal_Bool m_bListenOnDesktop;
|
|
sal_Bool m_bListenOnFrame;
|
|
sal_Bool m_bListenOnModel;
|
|
|
|
/**
|
|
In case we got a close request from our desktop/frame/model (on which we listen) ... and
|
|
the ownership was delivered there ... we have to close ourself and this object
|
|
in case the internal wrapped and running job finish his work.
|
|
*/
|
|
sal_Bool m_bPendingCloseFrame;
|
|
sal_Bool m_bPendingCloseModel;
|
|
|
|
/**
|
|
indicates in which state the internal job currently exist.
|
|
|
|
We can use this information to throw any suitable veto exception
|
|
to prevent the environment against dieing or supress superflous dispose()
|
|
calls at the job.
|
|
*/
|
|
ERunState m_eRunState;
|
|
|
|
//___________________________________
|
|
// native interface
|
|
|
|
public:
|
|
|
|
Job( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
|
|
const css::uno::Reference< css::frame::XFrame >& xFrame );
|
|
Job( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
|
|
const css::uno::Reference< css::frame::XModel >& xModel );
|
|
virtual ~Job( );
|
|
|
|
void setDispatchResultFake( const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ,
|
|
const css::uno::Reference< css::uno::XInterface >& xSourceFake );
|
|
void setJobData ( const JobData& aData );
|
|
void execute ( const css::uno::Sequence< css::beans::NamedValue >& lDynamicArgs );
|
|
void die ( );
|
|
|
|
private:
|
|
|
|
css::uno::Sequence< css::beans::NamedValue > impl_generateJobArgs ( const css::uno::Sequence< css::beans::NamedValue >& lDynamicArgs );
|
|
void impl_reactForJobResult( const css::uno::Any& aResult );
|
|
void impl_startListening ( );
|
|
void impl_stopListening ( );
|
|
|
|
//___________________________________
|
|
// uno interface
|
|
|
|
public:
|
|
|
|
FWK_DECLARE_XINTERFACE
|
|
FWK_DECLARE_XTYPEPROVIDER
|
|
|
|
// XJobListener
|
|
virtual void SAL_CALL jobFinished( const css::uno::Reference< css::task::XAsyncJob >& xJob,
|
|
const css::uno::Any& aResult ) throw(css::uno::RuntimeException);
|
|
|
|
// XTerminateListener
|
|
virtual void SAL_CALL queryTermination ( const css::lang::EventObject& aEvent ) throw(css::frame::TerminationVetoException,
|
|
css::uno::RuntimeException );
|
|
virtual void SAL_CALL notifyTermination( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException );
|
|
|
|
// XCloseListener
|
|
virtual void SAL_CALL queryClosing ( const css::lang::EventObject& aEvent ,
|
|
sal_Bool bGetsOwnership ) throw(css::util::CloseVetoException,
|
|
css::uno::RuntimeException );
|
|
virtual void SAL_CALL notifyClosing( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException );
|
|
|
|
// XEventListener
|
|
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException);
|
|
};
|
|
|
|
} // namespace framework
|
|
|
|
#endif // __FRAMEWORK_JOBS_JOB_HXX_
|