VRPNDeviceRegistration.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_VRPNDeviceRegistration_h_GUID_1D69B168_9B9C_47B9_A9F3_9A569E9710D2
#define INCLUDED_VRPNDeviceRegistration_h_GUID_1D69B168_9B9C_47B9_A9F3_9A569E9710D2

// Internal Includes
#include <osvr/VRPNServer/Export.h>
#include <osvr/Util/UniquePtr.h>
#include <osvr/PluginHost/PluginSpecificRegistrationContext.h>
#include <osvr/PluginKit/DeviceInterfaceC.h>
#include <osvr/PluginKit/PluginRegistration.h>
#include <osvr/Util/PluginRegContextC.h>

// Library/third-party includes
// - none

// Standard includes
// - none

class vrpn_Connection;

namespace osvr {
namespace vrpnserver {
    class VRPNDeviceRegistration_impl;

    namespace detail {
        template <typename T>
        static OSVR_ReturnCode callMainloop(void *userdata) {
            T *obj = static_cast<T *>(userdata);
            obj->mainloop();
            return OSVR_RETURN_SUCCESS;
        }
    } // namespace detail

    class VRPNDeviceRegistration {
      public:
        VRPNDeviceRegistration(VRPNDeviceRegistration const &) = delete;
        VRPNDeviceRegistration &
        operator=(VRPNDeviceRegistration const &) = delete;
        OSVR_VRPNSERVER_EXPORT
        VRPNDeviceRegistration(OSVR_PluginRegContext ctx);
        OSVR_VRPNSERVER_EXPORT VRPNDeviceRegistration(
            pluginhost::PluginSpecificRegistrationContext &context);
        OSVR_VRPNSERVER_EXPORT ~VRPNDeviceRegistration();

        OSVR_VRPNSERVER_EXPORT std::string
        useDecoratedName(std::string const &name);

        OSVR_VRPNSERVER_EXPORT vrpn_Connection *getVRPNConnection();

        template <typename T> T *registerDevice(T *dev) {
            osvr::pluginkit::registerObjectForDeletion(
                m_ctx.extractOpaquePointer(), dev);
            m_registerDevice(&detail::callMainloop<T>,
                             static_cast<void *>(dev));
            return dev;
        }

        template <typename T>
        T *constructAndRegisterDevice(std::string const &name) {
            unique_ptr<T> ret(
                new T(useDecoratedName(name).c_str(), getVRPNConnection()));
            return registerDevice(ret.release());
        }

        OSVR_VRPNSERVER_EXPORT void
        setDeviceDescriptor(std::string const &jsonString);

      private:
        OSVR_VRPNSERVER_EXPORT void
        m_registerDevice(OSVR_DeviceUpdateCallback cb, void *dev);
        pluginhost::PluginSpecificRegistrationContext &m_ctx;
        unique_ptr<VRPNDeviceRegistration_impl> m_impl;
    };
} // namespace vrpnserver
} // namespace osvr

#endif // INCLUDED_VRPNDeviceRegistration_h_GUID_1D69B168_9B9C_47B9_A9F3_9A569E9710D2