storageholder.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 <com/sun/star/embed/XStorage.hpp>
 
#include <mutex>
#include <unordered_map>
#include <vector>
 
namespace framework
{
 
class XMLBasedAcceleratorConfiguration;
class StorageHolder final
{
 
    // types
    public:
 
        typedef ::std::vector< css::uno::Reference< css::embed::XStorage > > TStorageList;
 
        typedef ::std::vector< XMLBasedAcceleratorConfiguration* > TStorageListenerList;
 
        struct TStorageInfo
        {
            public:
                css::uno::Reference< css::embed::XStorage > Storage;
                sal_Int32 UseCount;
                TStorageListenerList Listener;
 
                TStorageInfo()
                    : UseCount(0)
                {}
        };
 
        typedef std::unordered_map< OUString,
                                    TStorageInfo > TPath2StorageInfo;
 
    // member
    private:
        mutable std::mutex m_mutex;
 
        css::uno::Reference< css::embed::XStorage > m_xRoot;
 
        TPath2StorageInfo m_lStorages;
 
    // interface
    public:
 
        StorageHolder();
 
        ~StorageHolder();
 
        void forgetCachedStorages();
 
        void setRootStorage(const css::uno::Reference< css::embed::XStorage >& xRoot);
 
        css::uno::Reference< css::embed::XStorage > getRootStorage() const;
 
        css::uno::Reference< css::embed::XStorage > openPath(const OUString& sPath    ,
                                                                           sal_Int32        nOpenMode);
 
        StorageHolder::TStorageList getAllPathStorages(const OUString& sPath);
 
        void commitPath(const OUString& sPath);
 
        void closePath(const OUString& sPath);
 
        void notifyPath(const OUString& sPath);
 
        void addStorageListener(     XMLBasedAcceleratorConfiguration* pListener,
                                        const OUString&  sPath    );
 
        void removeStorageListener(   XMLBasedAcceleratorConfiguration* pListener,
                                           const OUString&  sPath    );
 
        OUString getPathOfStorage(const css::uno::Reference< css::embed::XStorage >& xStorage);
 
        css::uno::Reference< css::embed::XStorage > getParentStorage(const css::uno::Reference< css::embed::XStorage >& xChild);
 
        css::uno::Reference< css::embed::XStorage > getParentStorage(const OUString& sChildPath);
 
        StorageHolder& operator=(const StorageHolder& rCopy);
 
        static css::uno::Reference< css::embed::XStorage > openSubStorageWithFallback(const css::uno::Reference< css::embed::XStorage >& xBaseStorage  ,
                                                                                      const OUString&                             sSubStorage   ,
                                                                                      sal_Int32                                    eOpenMode);
 
        // helper
        private:
 
            static OUString impl_st_normPath(const OUString& sPath);
 
            static std::vector<OUString> impl_st_parsePath(std::u16string_view sPath);
};
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */