/src/libreoffice/include/oox/helper/refmap.hxx

Source
/* -*- 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_OOX_HELPER_REFMAP_HXX
#define INCLUDED_OOX_HELPER_REFMAP_HXX

#include <algorithm>
#include <functional>
#include <map>
#include <memory>

namespace oox {


/** Template for a map of ref-counted objects with additional accessor functions.

    An instance of the class RefMap< Type > stores elements of the type
    std::shared_ptr< Type >. The new accessor functions has() and get()
    work correctly for nonexisting keys, there is no need to check the passed
    key before.
 */
template< typename KeyType, typename ObjType, typename CompType = std::less< KeyType > >
class RefMap : public std::map< KeyType, std::shared_ptr< ObjType >, CompType >
{
public:
    typedef std::map< KeyType, std::shared_ptr< ObjType >, CompType > container_type;
    typedef typename container_type::key_type                               key_type;
    typedef typename container_type::mapped_type                            mapped_type;
    typedef typename container_type::value_type                             value_type;
    typedef typename container_type::key_compare                            key_compare;

public:
    /** Returns true, if the object associated to the passed key exists.
        Returns false, if the key exists but points to an empty reference. */
    bool                has(const key_type& rKey) const
                        {
                            const mapped_type* pxRef = getRef(rKey);
                            return pxRef && pxRef->get();
                        }

    /** Returns a reference to the object associated to the passed key, or an
        empty reference on error. */
    mapped_type         get(const key_type& rKey) const
                        {
                            if( const mapped_type* pxRef = getRef(rKey) ) return *pxRef;
                            return mapped_type();
                        }

    /** Calls the passed functor for every contained object, automatically
        skips all elements that are empty references. */
    template <typename FunctorType> void forEach(const FunctorType& rFunctor) const
    {
        forEachWithKey([&rFunctor](const key_type&, ObjType& rObj) { rFunctor(rObj); });
    }

    /** Calls the passed member function of ObjType on every contained object,
        automatically skips all elements that are empty references. */
    template <typename FuncType, typename... T> void forEachMem(FuncType pFunc, T&&... args) const
    {
        forEach([pFunc, &args...](ObjType& rObj) { (rObj.*pFunc)(args...); });
    }

    /** Calls the passed member function of ObjType on every contained object.
        Passes the object key as argument to the member function. */
    template <typename FuncType> void forEachMemWithKey(FuncType pFunc) const
    {
        forEachWithKey([pFunc](const key_type& rKey, ObjType& rObj) { (rObj.*pFunc)(rKey); });
    }

private:
    template <typename F> void forEachWithKey(const F& f) const
    {
        std::for_each(this->begin(), this->end(),
                      [&f](const value_type& rValue)
                      {
                          if (rValue.second)
                              f(rValue.first, *rValue.second);
                      });
    }

    const mapped_type* getRef(const key_type& rKey) const
    {
        typename container_type::const_iterator aIt = this->find(rKey);
        return (aIt == this->end()) ? nullptr : &aIt->second;
    }
};


} // namespace oox

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Coverage Report

Created: 2026-06-30 11:14