XPlane.cc

// Copyright (c) 2013 by István Váradi
 
// This file is part of XPLRA, a remote-access plugin for X-Plane
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
//------------------------------------------------------------------------------
 
#include "XPlane.h"
 
#include "MultiGetter.h"
#include "MultiSetter.h"
 
#include <hu/varadiistvan/scpl/io/LocalClientSocket.h>
#include <hu/varadiistvan/scpl/io/TCPClientSocket.h>
#include <hu/varadiistvan/scpl/io/DataStream.h>
 
#include <xplra/Protocol.h>
 
#include <memory>
 
#ifndef _WIN32
#include <signal.h>
#endif
 
//------------------------------------------------------------------------------
 
using hu::varadiistvan::xplra::XPlane;
using hu::varadiistvan::xplra::MultiGetter;
using hu::varadiistvan::xplra::MultiSetter;
 
using hu::varadiistvan::scpl::io::LocalClientSocket;
using hu::varadiistvan::scpl::io::TCPClientSocket;
using hu::varadiistvan::scpl::io::DataStream;
 
using xplra::Protocol;
 
using std::unique_ptr;
using std::string;
using std::min;
 
//------------------------------------------------------------------------------
 
const unsigned short XPlane::defaultTCPPort;
 
//------------------------------------------------------------------------------
 
template <class ClientSocket>
void XPlane::connect(std::unique_ptr<ClientSocket> clientSocket)
{
    auto& connector = clientSocket->getConnector();
 
    while (!connector.connect()) {
        if (connector.failed()) {
            throw IOException(connector.getErrorCode());
        }
        waiter.wait();
        if (waiter.failed()) {
            throw IOException(waiter.getErrorCode());
        }
    }
 
#ifndef _WIN32
    signal(SIGPIPE, SIG_IGN);
#endif
 
    socket = clientSocket.release();
    stream = new DataStream(*socket);
 
    for(multiBuffers_t::iterator i = multiBuffers.begin();
        i!=multiBuffers.end(); ++i)
    {
        MultiBuffer* buffer = *i;
        buffer->reregisterInXPlane();
    }
}
 
//------------------------------------------------------------------------------
 
void XPlane::checkStream()
{
    if (stream==0) {
        throw NotConnectedException();
    } else if (stream->failed()) {
        throw IOException(stream->getErrorCode());
    }
}
 
//------------------------------------------------------------------------------
 
void XPlane::checkResult(uint8_t result, bool hasParameter, long parameter)   
{
    switch(result) {
      case Protocol::RESULT_OK:
        return;
      case Protocol::RESULT_INVALID_COMMAND:
        throw ProtocolException(ProtocolException::INVALID_COMMAND,
                                hasParameter, parameter);
      case Protocol::RESULT_UNKNOWN_DATAREF:
        throw ProtocolException(ProtocolException::UNKNOWN_DATAREF,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_TYPE:
        throw ProtocolException(ProtocolException::INVALID_TYPE,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_LENGTH:
        throw ProtocolException(ProtocolException::INVALID_LENGTH,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_OFFSET:
        throw ProtocolException(ProtocolException::INVALID_OFFSET,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_COUNT:
        throw ProtocolException(ProtocolException::INVALID_COUNT,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_ID:
        throw ProtocolException(ProtocolException::INVALID_ID,
                                hasParameter, parameter);
      case Protocol::RESULT_INVALID_DURATION:
        throw ProtocolException(ProtocolException::INVALID_DURATION,
                                hasParameter, parameter);
      case Protocol::RESULT_OTHER_ERROR:
      default:
        throw ProtocolException(ProtocolException::OTHER,
                                hasParameter, parameter);
    }
}
 
//------------------------------------------------------------------------------
 
void XPlane::checkResult(bool multi)
{
    uint8_t result = stream->readU8();
    bool hasParameter = false;
    long parameter = 0;
    if (multi) {
        if (result==Protocol::RESULT_UNKNOWN_DATAREF) {
            parameter = stream->readU32();
            hasParameter = true;
        }
    }
    checkStream();
    checkResult(result, hasParameter, parameter);
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
XPlane::~XPlane() noexcept
{
    disconnect();
    for(multiBuffers_t::iterator i = multiBuffers.begin();
        i!=multiBuffers.end(); ++i)
    {
        MultiBuffer* buffer = *i;
        buffer->forgetRegistration();
        delete buffer;
    }
}
 
//------------------------------------------------------------------------------
 
void XPlane::connect()
{
    if (socket!=0) return;
 
    unique_ptr<LocalClientSocket> clientSocket(new LocalClientSocket("xplra",
                                                                     &waiter));
    connect(std::move(clientSocket));
}
 
//------------------------------------------------------------------------------
 
void XPlane::connectTCP(const std::string& address, unsigned short port)
{
    if (socket!=0) return;
 
    unique_ptr<TCPClientSocket> clientSocket(new TCPClientSocket(address.c_str(),
                                                                 port,
                                                                 &waiter));
    connect(std::move(clientSocket));
}
 
//------------------------------------------------------------------------------
 
void XPlane::disconnect() noexcept
{
    if (socket==0) return;
 
    delete stream; stream = 0;
    delete socket; socket = 0;
}
 
//------------------------------------------------------------------------------
 
MultiGetter& XPlane::createMultiGetter() noexcept
{
    MultiGetter* getter = new MultiGetter(*this);
    multiBuffers.insert(getter);
    return *getter;
}
 
//------------------------------------------------------------------------------
 
MultiSetter& XPlane::createMultiSetter() noexcept
{
    MultiSetter* setter = new MultiSetter(*this);
    multiBuffers.insert(setter);
    return *setter;
}
 
//------------------------------------------------------------------------------
 
bool XPlane::destroyMultiBuffer(MultiBuffer& buffer)
{
    multiBuffers_t::iterator i = multiBuffers.find(&buffer);
    if (i==multiBuffers.end()) return false;
 
    multiBuffers.erase(i);
    delete &buffer;
 
    return true;
}
 
//------------------------------------------------------------------------------
 
void XPlane::getVersions(int& xplaneVersion, int& xplmVersion, int& xplraVersion)   
{
    stream->writeU8(Protocol::COMMAND_GET_VERSIONS);
    stream->flush();
    checkResult();
 
    xplaneVersion = stream->readS32();
    xplmVersion = stream->readS32();
    xplraVersion = stream->readS32();
 
    checkStream();
}
 
//------------------------------------------------------------------------------
 
void XPlane::reloadPlugins()
{
    stream->writeU8(Protocol::COMMAND_RELOAD_PLUGINS);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::saveSituation(const char* path)
{
    stream->writeU8(Protocol::COMMAND_SAVE_SITUATION);
    stream->writeString(path);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::getScalar(const char* name, uint8_t type)
{
    checkStream();
 
    stream->writeU8(Protocol::COMMAND_GET_SINGLE);
    stream->writeString(name, strlen(name));
    stream->writeU8(type);
    if (!stream->flush()) checkStream();
 
    checkResult();
}
 
//------------------------------------------------------------------------------
 
int XPlane::getInt(const char* name)
{
    getScalar(name, Protocol::TYPE_INT);
 
    int value = stream->readS32();
    checkStream();
    return value;
}
 
//------------------------------------------------------------------------------
 
float XPlane::getFloat(const char* name)
{
    getScalar(name, Protocol::TYPE_FLOAT);
 
    float value = stream->readFloat();
    checkStream();
    return value;
}
 
//------------------------------------------------------------------------------
 
double XPlane::getDouble(const char* name)
{
    getScalar(name, Protocol::TYPE_DOUBLE);
 
    double value = stream->readDouble();
    checkStream();
    return value;
}
 
//------------------------------------------------------------------------------
 
size_t XPlane::getArray(const char* name, uint8_t type,
                        ssize_t length, size_t offset)
{
    checkStream();
 
    stream->writeU8(Protocol::COMMAND_GET_SINGLE);
    stream->writeString(name, strlen(name));
    stream->writeU8(type);
    stream->writeS32(static_cast<int32_t>(length));
    stream->writeS32(static_cast<int32_t>(offset));
    if (!stream->flush()) checkStream();
 
    uint8_t result = stream->readU8();
    length = stream->readS32();
    checkStream();
    checkResult(result);
 
    return length;
}
 
//------------------------------------------------------------------------------
 
size_t XPlane::getFloatArray(const char* name, float* dest,
                             size_t length, size_t offset)
{
    length = getArray(name, Protocol::TYPE_FLOAT_ARRAY, length, offset);
 
    if (!stream->read(dest, length*sizeof(float))) checkStream();
 
    return length;
}
 
//------------------------------------------------------------------------------
 
float* XPlane::getFloatArray(const char* name, size_t& length,
                             size_t offset)
{
    length = getArray(name, Protocol::TYPE_FLOAT_ARRAY, -1, offset);
 
    unique_ptr<float[]> data(new float[length]);
    if (!stream->read(data.get(), length*sizeof(float))) checkStream();
    return data.release();
}
 
//------------------------------------------------------------------------------
 
size_t XPlane::getIntArray(const char* name, int32_t* dest,
                           size_t length, size_t offset)
{
    length = getArray(name, Protocol::TYPE_INT_ARRAY, length, offset);
 
    if (!stream->read(dest, length*sizeof(int32_t))) checkStream();
 
    return length;
}
 
//------------------------------------------------------------------------------
 
int32_t* XPlane::getIntArray(const char* name, size_t& length,
                             size_t offset)
{
    length = getArray(name, Protocol::TYPE_INT_ARRAY, -1, offset);
 
    unique_ptr<int32_t[]> data(new int32_t[length]);
    if (!stream->read(data.get(), length*sizeof(int32_t))) checkStream();
    return data.release();
}
 
//------------------------------------------------------------------------------
 
size_t XPlane::getByteArray(const char* name, uint8_t* dest,
                            size_t length, size_t offset)
{
    length = getArray(name, Protocol::TYPE_BYTE_ARRAY, length, offset);
 
    if (!stream->read(dest, length*sizeof(uint8_t))) checkStream();
 
    return length;
}
 
//------------------------------------------------------------------------------
 
uint8_t* XPlane::getByteArray(const char* name, size_t& length,
                              size_t offset)
{
    length = getArray(name, Protocol::TYPE_BYTE_ARRAY, -1, offset);
 
    unique_ptr<uint8_t[]> data(new uint8_t[length]);
    if (!stream->read(data.get(), length*sizeof(uint8_t))) checkStream();
    return data.release();
}
 
//------------------------------------------------------------------------------
 
string XPlane::getString(const char* name, size_t offset)
{
    size_t length = 0;
    unique_ptr<uint8_t[]> data(getByteArray(name, length, offset));
    return string(reinterpret_cast<char*>(data.get()));
}
 
//------------------------------------------------------------------------------
 
void XPlane::setScalar(const char* name, uint8_t type)
{
    stream->writeU8(Protocol::COMMAND_SET_SINGLE);
    stream->writeString(name, strlen(name));
    stream->writeU8(type);
}
 
//------------------------------------------------------------------------------
 
void XPlane::setInt(const char* name, int value)
{
    setScalar(name, Protocol::TYPE_INT);
    stream->writeS32(value);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setFloat(const char* name, float value)
{
    setScalar(name, Protocol::TYPE_FLOAT);
    stream->writeFloat(value);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setDouble(const char* name, double value)
{
    setScalar(name, Protocol::TYPE_DOUBLE);
    stream->writeDouble(value);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setArray(const char* name, uint8_t type, size_t length,
                      size_t offset)
{
    stream->writeU8(Protocol::COMMAND_SET_SINGLE);
    stream->writeString(name, strlen(name));
    stream->writeU8(type);
    stream->writeS32(static_cast<int32_t>(length));
    stream->writeS32(static_cast<int32_t>(offset));
}
 
//------------------------------------------------------------------------------
 
void XPlane::setFloatArray(const char* name, const float* values, size_t length,
                           size_t offset)
{
    setArray(name, Protocol::TYPE_FLOAT_ARRAY, length, offset);
    stream->write(values, length*sizeof(*values));
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setIntArray(const char* name, const int32_t* values, size_t length,
                         size_t offset)
{
    setArray(name, Protocol::TYPE_INT_ARRAY, length, offset);
    stream->write(values, length*sizeof(*values));
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setByteArray(const char* name, const uint8_t* values, size_t length,
                          size_t offset)
{
    setArray(name, Protocol::TYPE_BYTE_ARRAY, length, offset);
    stream->write(values, length*sizeof(*values));
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::setString(const char* name, const char* value, size_t length,
                       size_t offset)
{
    size_t valueLength = strlen(value);
    if ((valueLength+1)>=length) {
        setByteArray(name, reinterpret_cast<const uint8_t*>(value),
                     length, offset);
    } else {
        unique_ptr<uint8_t[]> buffer(new uint8_t[length]);
        memcpy(buffer.get(), value, valueLength);
        memset(buffer.get() + valueLength, 0, length - valueLength);
        setByteArray(name, buffer.get(), length, offset);
    }
}
 
//------------------------------------------------------------------------------
 
void XPlane::showMessage(const char* message, float duration)
{
    stream->writeU8(Protocol::COMMAND_SHOW_MESSAGE);
    stream->writeString(message);
    stream->writeFloat(duration);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::registerHotkeys(const uint16_t* codes, size_t length)
   
{
    stream->writeU8(Protocol::COMMAND_REGISTER_HOTKEYS);
    stream->writeU32(length);
    stream->write(codes, sizeof(uint16_t)*length);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
void XPlane::queryHotkeys(uint8_t* states, size_t length)
{
    stream->writeU8(Protocol::COMMAND_QUERY_HOTKEYS);
    stream->flush();
    checkResult();
 
    size_t count = stream->readU32();
    checkStream();
    stream->read(states, min(length, count));
    if (length<count) {
        while(length<count) {
            stream->readU8();
            ++length;
        }
    } else if (length>count) {
        memset(states + count, 0, length - count);
    }
    checkStream();
}
 
//------------------------------------------------------------------------------
 
void XPlane::unregisterHotkeys()
{
    stream->writeU8(Protocol::COMMAND_UNREGISTER_HOTKEYS);
    stream->flush();
    checkResult();
}
 
//------------------------------------------------------------------------------
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: