PluginSpecificRegistrationContextImpl.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_PluginSpecificRegistrationContextImpl_h_GUID_E8A348C1_28DC_4691_6214_32F75A6665F0
#define INCLUDED_PluginSpecificRegistrationContextImpl_h_GUID_E8A348C1_28DC_4691_6214_32F75A6665F0

// Internal Includes
#include <osvr/PluginKit/PluginKitC.h>
#include <osvr/PluginHost/PluginSpecificRegistrationContext.h>
#include <osvr/Util/UniquePtr.h>
#include <osvr/Util/CallbackWrapper.h>
#include <osvr/Util/AnyMap.h>

// Library/third-party includes
#include <libfunctionality/PluginHandle.h>

// Standard includes
#include <vector>
#include <functional>

namespace osvr {

namespace pluginhost {
    class PluginSpecificRegistrationContextImpl
        : public PluginSpecificRegistrationContext {
      public:
        PluginSpecificRegistrationContextImpl(std::string const &name);

        ~PluginSpecificRegistrationContextImpl();

        void takePluginHandle(libfunc::PluginHandle &handle);

        void setParent(RegistrationContext &parent);

        virtual RegistrationContext &getParent();

        virtual RegistrationContext const &getParent() const;

        void triggerHardwareDetectCallbacks();

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

        virtual util::AnyMap &data();

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


        virtual void registerDataWithDeleteCallback(
            OSVR_PluginDataDeleteCallback deleteCallback, void *pluginData);

        virtual void registerHardwareDetectCallback(
            OSVR_HardwareDetectCallback detectCallback, void *userData);
        virtual void registerDriverInstantiationCallback(
            const char *name, OSVR_DriverInstantiationCallback constructor,
            void *userData);

      private:
        typedef unique_ptr<void, OSVR_PluginDataDeleteCallback> PluginDataPtr;
        typedef std::vector<PluginDataPtr> PluginDataList;

        PluginDataList m_dataList;
        libfunc::PluginHandle m_handle;
        RegistrationContext *m_parent;

        typedef util::CallbackWrapper<OSVR_HardwareDetectCallback>
            HardwareDetectCallback;
        typedef std::vector<HardwareDetectCallback> HardwareDetectCallbackList;
        HardwareDetectCallbackList m_hardwareDetectCallbacks;

        typedef std::function<OSVR_ReturnCode(const char *)>
            DriverInstantiationCallback;
        typedef std::map<std::string, DriverInstantiationCallback>
            DriverInstantiationMap;
        DriverInstantiationMap m_driverInstantiationCallbacks;

        util::AnyMap m_data;
    };

} // namespace pluginhost
} // namespace osvr

#endif // INCLUDED_PluginSpecificRegistrationContextImpl_h_GUID_E8A348C1_28DC_4691_6214_32F75A6665F0