Plugin.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is part of the RSC project.
 *
 * Copyright (C) 2012, 2014 Jan Moringen <jmoringe@techfak.uni-bielefeld.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 <string>

#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>

#include "rsc/rscexports.h"

namespace rsc {
namespace plugins {

extern const std::string PLUGIN_INIT_SYMBOL;
extern const std::string PLUGIN_SHUTDOWN_SYMBOL;

class Impl;

class RSC_EXPORT Plugin : boost::noncopyable {
public:
    virtual ~Plugin();

    const std::string& getName() const;

    void load(bool wrapExceptions = true);

    void unload(bool wrapExceptions = true);

    std::string getLibrary() const;

private:
    friend class Manager;

    boost::scoped_ptr<Impl> impl;

    Plugin(Impl* impl);

    static boost::shared_ptr<Plugin> create(const std::string& name,
                                            const std::string& library);
};

typedef boost::shared_ptr<Plugin> PluginPtr;

}
}