basecontainer.hxx

Go to the documentation of this file.

/* -*- 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/interfacecontainer4.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/weakref.hxx>
#include <rtl/ustring.hxx>
 
 
namespace filter::config {
 
 
class BaseContainer : public ::cppu::WeakImplHelper< css::lang::XServiceInfo         ,
                                                      css::container::XNameContainer  , // => XNameReplace => XNameAccess => XElementAccess
                                                      css::container::XContainerQuery ,
                                                      css::util::XFlushable           >
{
 
    // member
 
    protected:
        mutable std::mutex m_aMutex;
 
        OUString m_sImplementationName;
 
        css::uno::Sequence< OUString > m_lServiceNames;
 
        std::unique_ptr<FilterCache> m_pFlushCache;
 
        FilterCache::EItemType m_eType;
 
        comphelper::OInterfaceContainerHelper4<css::util::XFlushListener> m_lListener;
 
 
    // native interface
 
    public:
 
 
        // ctor/dtor
 
        BaseContainer();
 
 
        virtual ~BaseContainer() override;
 
 
        void init( const OUString&                                        sImplementationName,
                   const css::uno::Sequence< OUString >&                  lServiceNames      ,
                   FilterCache::EItemType                                 eType              );
 
 
    // helper
 
    protected:
 
 
        void impl_loadOnDemand(std::unique_lock<std::mutex>& rGuard);
 
 
        void impl_initFlushMode(std::unique_lock<std::mutex>& rGuard);
 
 
        FilterCache* impl_getWorkingCache(std::unique_lock<std::mutex>& rGuard) 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: */