diff options
Diffstat (limited to 'filter/source/config/cache/basecontainer.hxx')
| -rw-r--r-- | filter/source/config/cache/basecontainer.hxx | 256 |
1 files changed, 256 insertions, 0 deletions
diff --git a/filter/source/config/cache/basecontainer.hxx b/filter/source/config/cache/basecontainer.hxx new file mode 100644 index 000000000..6691c1b49 --- /dev/null +++ b/filter/source/config/cache/basecontainer.hxx @@ -0,0 +1,256 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#pragma once + +#include <memory> + +#include "filtercache.hxx" +#include <com/sun/star/lang/XServiceInfo.hpp> +#include <com/sun/star/util/XRefreshable.hpp> +#include <com/sun/star/uno/XComponentContext.hpp> +#include <com/sun/star/container/XNameContainer.hpp> +#include <com/sun/star/container/XContainerQuery.hpp> +#include <com/sun/star/util/XFlushable.hpp> +#include <comphelper/multicontainer2.hxx> +#include <cppuhelper/implbase.hxx> +#include <cppuhelper/weakref.hxx> +#include <rtl/ustring.hxx> + + +namespace filter::config { + + +/** @short implements the interface css::container::XNameContainer + on top of a FilterCache reference. + + @descr This class can be used as base for own service implementations, + which must provide read/write access to the filter configuration. + Parameters regulate read/write access, which sub set of information + should be available etc. + + @attention The base class BaseLock must be the first of declared ones. + Otherwise we can't be sure, that our own mutex member (which is + present by this base class!) was full initialized inside our own + ctor as first! + */ +class BaseContainer : public cppu::BaseMutex + , public ::cppu::WeakImplHelper< css::lang::XServiceInfo , + css::container::XNameContainer , // => XNameReplace => XNameAccess => XElementAccess + css::container::XContainerQuery , + css::util::XFlushable > +{ + + // member + + protected: + + /** @short the implementation name of our derived class, which we provide + at the interface XServiceInfo of our class... */ + OUString m_sImplementationName; + + /** @short the list of supported uno service names of our derived class, which we provide + at the interface XServiceInfo of our class... */ + css::uno::Sequence< OUString > m_lServiceNames; + + /** @short local filter cache, which is used to collect changes on the + filter configuration first and flush it later. + + @descr Normally this member isn't used nor initialized. That's true, + if this container is used for reading only. The first write access + (e.g. by calling insertByName()) creates a copy of the current + global cache m_rCache to initialize the m_pFlushCache member. + + Afterwards only the flush cache copy is used. Inside flush() this + copy will be removed and m_rCache can be used again. + + m_pFlushCache and m_rCache must not be synchronized manually here. + m_rCache listen on the global configuration, where m_pFlushCache + write its data. m_rCache update itself automatically. + */ + std::unique_ptr<FilterCache> m_pFlushCache; + + /** @short specify, which sub container of the used filter cache + must be wrapped by this container interface. */ + FilterCache::EItemType m_eType; + + /** @short holds all listener, which are registered at this instance. */ + comphelper::OMultiTypeInterfaceContainerHelper2 m_lListener; + + + // native interface + + public: + + + // ctor/dtor + + /** @short standard ctor. + + @descr Because mostly this class is used as base class for own service + implementations in combination with an ImplInheritanceHelper template... + there is no way to provide some initializing data through the ctor :-( + This base class will be created inside its default ctor and must be + initialized with its needed parameters explicitly by calling: "init()". + + @see init() + */ + BaseContainer(); + + + /** @short standard dtor. + */ + virtual ~BaseContainer() override; + + + /** @short initialize this generic instance with some specialized values + from our derived object. + + @descr Because an outside class must use ImplInheritanceHelper template to + use us a base class... and there is no way to pass such initializing + parameters through a required default ctor... we must be initialized + by this special method. Of course this method must be called first before + any other interface method is used. + + @param rxContext + reference to the uno service manager, which created this service instance. + + @param sImplementationName + the implementation name of our derived class, which we provide + at the interface XServiceInfo of our class... + + @param lServiceNames + the list of supported uno service names of our derived class, which we provide + at the interface XServiceInfo of our class... + + @param eType + specify, which sub container of the used filter cache + must be wrapped by this container interface. + */ + void init( const OUString& sImplementationName, + const css::uno::Sequence< OUString >& lServiceNames , + FilterCache::EItemType eType ); + + + // helper + + protected: + + + /** @short check if the underlying configuration data was already loaded + and do it if necessary automatically. + */ + void impl_loadOnDemand(); + + + /** @short it creates the global instance m_pFilterCache, which is a copy + of the global instance m_rCache, and will be used to change the + configuration. + + @descr If no exception occurs, its guaranteed, that the member m_rFlushCache + was initialized right and can be used further. + + @throws css::uno::RuntimeException + */ + void impl_initFlushMode(); + + + /** @short returns a pointer to the current used cache member. + + @descr It's a point to the FilterCache instance behind m_pFlushCache + or m_rCache. + + @note The lifetime of this pointer is restricted to the time, where + the mutex of this BaseContainer instance is locked. + Otherwise may be the interface method flush() will destroy + m_pFlushCache and the here returned pointer will be invalid! + + Use: + + Guard aLock(m_aLock); + FilterCache* p = impl_getWorkingCache(); + p->doSomething(); + aLock.clear(); + // after this point p can't b e guaranteed any longer! + */ + FilterCache* impl_getWorkingCache() const; + + + // uno interface + + public: + + + // XServiceInfo + + virtual OUString SAL_CALL getImplementationName() override; + + virtual sal_Bool SAL_CALL supportsService(const OUString& sServiceName) override; + + virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override; + + + // XNameContainer + + virtual void SAL_CALL insertByName(const OUString& sItem , + const css::uno::Any& aValue) override; + + virtual void SAL_CALL removeByName(const OUString& sItem) override; + + + // XNameReplace + + virtual void SAL_CALL replaceByName(const OUString& sItem , + const css::uno::Any& aValue) override; + + + // XElementAccess + + virtual css::uno::Any SAL_CALL getByName(const OUString& sItem) override; + + virtual css::uno::Sequence< OUString > SAL_CALL getElementNames() override; + + virtual sal_Bool SAL_CALL hasByName(const OUString& sItem) override; + + virtual css::uno::Type SAL_CALL getElementType() override; + + virtual sal_Bool SAL_CALL hasElements() override; + + + // XContainerQuery + + // must be implemented really by derived class... + // We implement return of an empty result here only! + // But we show an assertion :-) + virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createSubSetEnumerationByQuery(const OUString& sQuery) override; + + virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createSubSetEnumerationByProperties(const css::uno::Sequence< css::beans::NamedValue >& lProperties) override; + + + // XFlushable + + virtual void SAL_CALL flush() override; + + virtual void SAL_CALL addFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener) override; + + virtual void SAL_CALL removeFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener) override; +}; + +} // namespace filter::config + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |