RegistrationContext.h

Go to the documentation of this file.

// Copyright 2014 Sensics, Inc.
//
// Licensed 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
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_RegistrationContext_h_GUID_9FF83E64_B2E1_40B7_E072_929AC0F94A10
#define INCLUDED_RegistrationContext_h_GUID_9FF83E64_B2E1_40B7_E072_929AC0F94A10

// Internal Includes
#include <osvr/PluginHost/RegistrationContext_fwd.h>
#include <osvr/Util/SharedPtr.h>
#include <osvr/Util/UniquePtr.h>
#include <osvr/Util/AnyMap.h>
#include <osvr/Util/Log.h>
#include <osvr/PluginHost/Export.h>
#include <osvr/PluginHost/PluginSpecificRegistrationContext.h>

// Library/third-party includes
#include <boost/noncopyable.hpp>

// Standard includes
#include <string>
#include <map>

namespace osvr {
namespace pluginhost {

    class RegistrationContext : boost::noncopyable {
      public:
        OSVR_PLUGINHOST_EXPORT RegistrationContext();

        OSVR_PLUGINHOST_EXPORT ~RegistrationContext();

        OSVR_PLUGINHOST_EXPORT void loadPlugin(std::string const &pluginName);

        OSVR_PLUGINHOST_EXPORT void loadPlugins();

        OSVR_PLUGINHOST_EXPORT void
        adoptPluginRegistrationContext(PluginRegPtr ctx);

        OSVR_PLUGINHOST_EXPORT void triggerHardwareDetect();

        OSVR_PLUGINHOST_EXPORT void
        instantiateDriver(const std::string &pluginName,
                          const std::string &driverName,
                          const std::string &params = std::string()) const;

        OSVR_PLUGINHOST_EXPORT util::AnyMap &data();

        OSVR_PLUGINHOST_EXPORT util::AnyMap const &data() const;

      private:
        typedef std::map<std::string, PluginRegPtr> PluginRegMap;

        PluginRegMap m_regMap;
        util::AnyMap m_data;
        struct Impl;
        unique_ptr<Impl> m_impl;
        util::log::LoggerPtr m_logger;
    };
} // namespace pluginhost
} // namespace osvr

#endif // INCLUDED_RegistrationContext_h_GUID_9FF83E64_B2E1_40B7_E072_929AC0F94A10