numberedcollection.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 .
 */
 
#ifndef INCLUDED_COMPHELPER_NUMBEREDCOLLECTION_HXX
#define INCLUDED_COMPHELPER_NUMBEREDCOLLECTION_HXX
 
#include <comphelper/comphelperdllapi.h>
 
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/frame/XUntitledNumbers.hpp>
 
#include <cppuhelper/weakref.hxx>
#include <cppuhelper/implbase.hxx>
 
#include <unordered_map>
#include <mutex>
#include <vector>
 
namespace com::sun::star::uno { class XInterface; }
 
namespace comphelper{
 
class COMPHELPER_DLLPUBLIC NumberedCollection final :
                                              public  ::cppu::WeakImplHelper< css::frame::XUntitledNumbers >
{
 
    // types, const
    private:
 
        struct TNumberedItem
        {
            css::uno::WeakReference< css::uno::XInterface > xItem;
            ::sal_Int32 nNumber;
        };
 
        typedef std::unordered_map<
                    sal_IntPtr,
                    TNumberedItem  > TNumberedItemHash;
 
        typedef ::std::vector< sal_IntPtr > TDeadItemList;
 
 
    // interface
    public:
 
 
        NumberedCollection();
 
 
        virtual ~NumberedCollection() override;
 
 
        void setOwner (const css::uno::Reference< css::uno::XInterface >& xOwner);
 
 
        void setUntitledPrefix(const OUString& sPrefix);
 
 
        virtual ::sal_Int32 SAL_CALL leaseNumber(const css::uno::Reference< css::uno::XInterface >& xComponent) override;
 
 
        virtual void SAL_CALL releaseNumber(::sal_Int32 nNumber) override;
 
 
        virtual void SAL_CALL releaseNumberForComponent(const css::uno::Reference< css::uno::XInterface >& xComponent) override;
 
 
        virtual OUString SAL_CALL getUntitledPrefix() override;
 
 
    // internal
    private:
 
 
        ::sal_Int32 impl_searchFreeNumber ();
 
        static void impl_cleanUpDeadItems (      TNumberedItemHash& lItems    ,
                                           const TDeadItemList&     lDeadItems);
 
 
    // member
    private:
 
        OUString m_sUntitledPrefix;
 
        TNumberedItemHash m_lComponents;
 
        css::uno::WeakReference< css::uno::XInterface > m_xOwner;
 
        std::mutex m_aMutex;
};
 
} // namespace comphelper
 
#endif // INCLUDED_COMPHELPER_NUMBEREDCOLLECTION_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */