sd/source/ui/inc/framework/ModuleController.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ModuleController.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_FRAMEWORK_MODULE_CONTROLLER_HXX
  32 #define SD_FRAMEWORK_MODULE_CONTROLLER_HXX
  33
  34 #include "MutexOwner.hxx"
  35
  36 #include <osl/mutex.hxx>
  37 #include <com/sun/star/drawing/framework/XModuleController.hpp>
  38 #include <com/sun/star/uno/XComponentContext.hpp>
  39 #include <com/sun/star/lang/XInitialization.hpp>
  40 #include <com/sun/star/frame/XController.hpp>
  41 #include <cppuhelper/compbase2.hxx>
  42
  43 #include <boost/scoped_ptr.hpp>
  44 #include <set>
  45
  46 namespace css = ::com::sun::star;
  47
  48 namespace {
  49
  50 typedef ::cppu::WeakComponentImplHelper2 <
  51     css::drawing::framework::XModuleController,
  52     css::lang::XInitialization
  53     > ModuleControllerInterfaceBase;
  54
  55 } // end of anonymous namespace.
  56
  57
  58
  59 namespace sd { namespace framework {
  60
  61 /** The ModuleController has to tasks:
  62
  63     1. It reads the
  64     org.openoffice.Office.Impress/MultiPaneGUI/Framework/ResourceFactories
  65     configuration data that maps from resource URLs to service names of
  66     factories that can create resources for the URLs.  When the
  67     configuration controller wants to create a resource for which it does
  68     not have a factory, it asks the ModuleController to provide one.  The
  69     ModuleController looks up the service name registered for the URL of the
  70     resource and instantiates this service.  The service is expected to
  71     register on its creation a factory for the resource in question.
  72
  73     2. The ModuleController reads on its creation
  74     org.openoffice.Office.Impress/MultiPaneGUI/Framework/StartupServices
  75     configuration data and instantiates all listed services.  These servces
  76     can then register as listeners at the ConfigurationController or do
  77     whatever they like.
  78 */
  79 class ModuleController
  80     : private sd::MutexOwner,
  81       public ModuleControllerInterfaceBase
  82 {
  83 public:
  84     static css::uno::Reference<
  85         css::drawing::framework::XModuleController>
  86         CreateInstance (
  87             const css::uno::Reference<css::uno::XComponentContext>&
  88             rxContext);
  89
  90     virtual void SAL_CALL disposing (void);
  91
  92
  93     // XModuleController
  94
  95     virtual void SAL_CALL requestResource(const ::rtl::OUString& rsResourceURL)
  96         throw (css::uno::RuntimeException);
  97
  98
  99     // XInitialization
 100
 101     virtual void SAL_CALL initialize(
 102         const css::uno::Sequence<css::uno::Any>& aArguments)
 103         throw (css::uno::Exception, css::uno::RuntimeException);
 104
 105 private:
 106     css::uno::Reference<
 107         css::frame::XController> mxController;
 108
 109     class ResourceToFactoryMap;
 110     ::boost::scoped_ptr<ResourceToFactoryMap> mpResourceToFactoryMap;
 111     class LoadedFactoryContainer;
 112     ::boost::scoped_ptr<LoadedFactoryContainer> mpLoadedFactories;
 113
 114     ModuleController (
 115         const css::uno::Reference<css::uno::XComponentContext>& rxContext)
 116         throw();
 117     ModuleController (void); // Not implemented.
 118     ModuleController (const ModuleController&); // Not implemented.
 119     virtual ~ModuleController (void) throw();
 120
 121     /** Load a list of URL to service mappings from the
 122         /org.openoffice.Office.Impress/MultiPaneGUI/Framework/ResourceFactories
 123         configuration entry.  The mappings are stored in the
 124         mpResourceToFactoryMap member.
 125     */
 126     void LoadFactories (const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 127
 128     /** Called for every entry in the ResourceFactories configuration entry.
 129     */
 130     void ProcessFactory (const ::std::vector<css::uno::Any>& rValues);
 131
 132     /** Instantiate all startup services that are found in the
 133         /org.openoffice.Office.Impress/MultiPaneGUI/Framework/StartupServices
 134         configuration entry.  This method is called once when a new
 135         ModuleController object is created.
 136     */
 137     void InstantiateStartupServices (void);
 138
 139     /** Called for one entry in the StartupServices configuration list this
 140         method instantiates the service described by the entry.  It does not
 141         hold references to the new object so that the object will be
 142         destroyed on function exit when it does not register itself
 143         somewhere.  It typically will register as
 144         XConfigurationChangeListener at the configuration controller.
 145     */
 146     void ProcessStartupService (const ::std::vector<css::uno::Any>& rValues);
 147 };
 148
 149 } } // end of namespace sd::framework
 150
 151 #endif