Registry.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of RSC project
 *
 * Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <iostream>
#include <map>
#include <set>
#include <stdexcept>
#include <string>

#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/static_assert.hpp>
#include <boost/thread/recursive_mutex.hpp>

#include "rsc/config.h"
#include "rsc/rscexports.h"

#include "../misc/langutils.h"

namespace rsc {
namespace misc {

template<class R>
class DEPRECATED_CLASS("If possible, use rsc::patterns::Factory instead") Registry: public boost::noncopyable {
public:

    Registry() {
    }

    DEPRECATED_MSG(void addRegistree(R* r, const std::string& errorDescription = ""),
                   "If possible, use rsc::patterns::Factory instead") {

        boost::recursive_mutex::scoped_lock lock(mutex);

        if (registreesByName.count(r->getRegistryKey())) {
            throw std::invalid_argument(
                    "There already is a registree with key '"
                            + r->getRegistryKey() + "'. " + errorDescription);
        }

        registreesByName[r->getRegistryKey()] = boost::shared_ptr<R>(r);

    }

    DEPRECATED_MSG(boost::shared_ptr<R> getRegistree(const std::string& key),
                   "If possible, use rsc::patterns::Factory instead") {

        boost::recursive_mutex::scoped_lock lock(mutex);

        typename std::map<std::string, boost::shared_ptr<R> >::const_iterator it =
                registreesByName.find(key);
        if (it == registreesByName.end()) {
            throw std::invalid_argument(
                    "There is no registree with key '" + key + "'.");
        }

        return it->second;

    }

    DEPRECATED_MSG(std::set<std::string> getKnownRegistryKeys(),
                   "If possible, use rsc::patterns::Factory instead") {

        boost::recursive_mutex::scoped_lock lock(mutex);

        std::set<std::string> keys;
        typename std::map<std::string, boost::shared_ptr<R> >::const_iterator it;
        for (it = registreesByName.begin(); it != registreesByName.end();
                ++it) {
            keys.insert(it->first);
        }
        return keys;

    }

    DEPRECATED_MSG(bool removeRegistree(const std::string& name),
                   "If possible, use rsc::patterns::Factory instead") {
        boost::recursive_mutex::scoped_lock lock(mutex);
        return registreesByName.erase(name) != 0;
    }

    DEPRECATED_MSG(boost::recursive_mutex* getMutex(),
                   "If possible, use rsc::patterns::Factory instead") {
        return &mutex;
    }

private:

    boost::recursive_mutex mutex;
    std::map<std::string, boost::shared_ptr<R> > registreesByName;

};

#define CREATE_GLOBAL_REGISTREE(registry, registree, uniqueName) \
    class Starter##uniqueName { \
    public: \
        Starter##uniqueName() { \
        (registry)->addRegistree(registree); \
        } \
    }; \
    Starter##uniqueName uniqueName##Starter;

#define CREATE_GLOBAL_REGISTREE_MSG(registry, registree, uniqueName, msg) \
    class Starter##uniqueName { \
    public: \
        Starter##uniqueName() { \
        (registry)->addRegistree(registree, msg); \
        } \
    }; \
    Starter##uniqueName uniqueName##Starter;

}
}