PluginSpecificRegistrationContext.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_PluginSpecificRegistrationContext_h_GUID_8C008527_0BF6_408F_3C73_4FE76B77D856
#define INCLUDED_PluginSpecificRegistrationContext_h_GUID_8C008527_0BF6_408F_3C73_4FE76B77D856

// Internal Includes
#include <osvr/PluginHost/Export.h>
#include <osvr/PluginHost/RegistrationContext_fwd.h>
#include <osvr/PluginHost/PluginSpecificRegistrationContext_fwd.h>
#include <osvr/PluginHost/PluginRegPtr.h>
#include <osvr/Util/PluginCallbackTypesC.h>
#include <osvr/Util/PluginRegContextC.h>
#include <osvr/Util/SharedPtr.h>
#include <osvr/Util/AnyMap_fwd.h>
#include <osvr/Util/GenericDeleter.h>
#include <osvr/Util/LogLevel.h>
#include <osvr/Util/Logger.h>

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

// Standard includes
#include <string>

namespace osvr {
namespace pluginhost {

    class PluginSpecificRegistrationContext : boost::noncopyable {
      public:
        OSVR_PLUGINHOST_EXPORT static PluginRegPtr
        create(std::string const &name);

        OSVR_PLUGINHOST_EXPORT static PluginSpecificRegistrationContext &
        get(OSVR_PluginRegContext ctx);

        OSVR_PLUGINHOST_EXPORT OSVR_PluginRegContext extractOpaquePointer();

        OSVR_PLUGINHOST_EXPORT virtual ~PluginSpecificRegistrationContext();

        OSVR_PLUGINHOST_EXPORT virtual RegistrationContext &getParent() = 0;

        OSVR_PLUGINHOST_EXPORT virtual RegistrationContext const &
        getParent() const = 0;

        OSVR_PLUGINHOST_EXPORT virtual util::AnyMap &data() = 0;

        OSVR_PLUGINHOST_EXPORT virtual util::AnyMap const &data() const = 0;


        OSVR_PLUGINHOST_EXPORT virtual void registerDataWithDeleteCallback(
            OSVR_PluginDataDeleteCallback deleteCallback, void *pluginData) = 0;

        template <typename T> T *registerDataWithGenericDelete(T *data) {
            registerDataWithDeleteCallback(&::osvr::util::generic_deleter<T>,
                                           static_cast<void *>(data));
            return data;
        }

        OSVR_PLUGINHOST_EXPORT virtual void registerHardwareDetectCallback(
            OSVR_HardwareDetectCallback detectCallback, void *userData) = 0;

        OSVR_PLUGINHOST_EXPORT virtual void registerDriverInstantiationCallback(
            const char *name, OSVR_DriverInstantiationCallback constructor,
            void *userData) = 0;

        OSVR_PLUGINHOST_EXPORT const std::string &getName() const;

        OSVR_PLUGINHOST_EXPORT void log(util::log::LogLevel severity,
                                        const char *message);

      protected:
        PluginSpecificRegistrationContext(std::string const &name);

      private:
        std::string const m_name;
        osvr::util::log::LoggerPtr m_logger;
    };

} // namespace pluginhost
} // namespace osvr

#endif // INCLUDED_PluginSpecificRegistrationContext_h_GUID_8C008527_0BF6_408F_3C73_4FE76B77D856