1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef COMPHELPER_LEGACYSINGLETONFACTORY_HXX 25 #define COMPHELPER_LEGACYSINGLETONFACTORY_HXX 26 27 #include "comphelper/comphelperdllapi.h" 28 29 /** === begin UNO includes === **/ 30 /** === end UNO includes === **/ 31 32 #include <cppuhelper/factory.hxx> 33 34 //........................................................................ 35 namespace comphelper 36 { 37 //........................................................................ 38 39 /** creates a factory which can be used when implementing old-style singletons 40 41 Before UNO having the component context concept, singletons were implemented by providing 42 a factory which return the very same component instance for every creation request. 43 44 Nowadays, singletons are implemented by making them available at the component context, 45 as dedicated property. 46 47 To bridge between both worlds - sometimes necessary to support legacy code, which instantiates 48 singletons at the global service manager, instead of obtaining the property at the 49 component context -, you can use the function below. I creates a single-component 50 factory, which behaves like the old factories did: Upon multiple creation requests, 51 it will always return the same instance. Additionally, the signature of the function 52 is the same as the signature of <code>::cppu::createSingleComponentFactory</code> 53 (which creates a "normal" component factory), so you can use both factory functions 54 in the same context. 55 */ 56 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleComponentFactory > 57 COMPHELPER_DLLPUBLIC createLegacySingletonFactory( 58 ::cppu::ComponentFactoryFunc _componentFactoryFunc, 59 const ::rtl::OUString& _rImplementationName, 60 const ::com::sun::star::uno::Sequence< ::rtl::OUString >& _rServiceNames, 61 rtl_ModuleCount* _pModCount = NULL 62 ); 63 64 //........................................................................ 65 } // namespace comphelper 66 //........................................................................ 67 68 #endif // COMPHELPER_LEGACYSINGLETONFACTORY_HXX 69