XPlane.h

// 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.
 
#ifndef HU_VARADIISTVAN_XPLRA_XPLANE_H
#define HU_VARADIISTVAN_XPLRA_XPLANE_H
//-----------------------------------------------------------------------------
 
#include "Exception.h"
 
#include <hu/varadiistvan/scpl/io/Waiter.h>
 
#include <set>
#include <memory>
 
#include <inttypes.h>
 
//-----------------------------------------------------------------------------
 
namespace hu { namespace varadiistvan { namespace scpl { namespace io {
 
class BufferedStream;
class DataStream;
 
} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
 
//------------------------------------------------------------------------------
 
namespace hu { namespace varadiistvan { namespace xplra {
 
//------------------------------------------------------------------------------
 
class MultiBuffer;
class MultiGetter;
class MultiSetter;
 
//------------------------------------------------------------------------------
 
class XPlane
{
private:
    static const unsigned short defaultTCPPort = 0x5852;
 
    typedef std::set<MultiBuffer*> multiBuffers_t;
 
    scpl::io::Waiter waiter;
 
    scpl::io::BufferedStream* socket;
 
    scpl::io::DataStream* stream;
 
    multiBuffers_t multiBuffers;
 
public:
    XPlane() noexcept;
 
    ~XPlane() noexcept;
 
    void connect();
 
    void connectTCP(const std::string& address,
                    unsigned short port = defaultTCPPort);
 
    bool isConnected() const noexcept;
 
    void disconnect() noexcept;
 
    MultiGetter& createMultiGetter() noexcept;
 
    MultiSetter& createMultiSetter() noexcept;
 
    bool destroyMultiBuffer(MultiBuffer& buffer);
 
    void getVersions(int& xplaneVersion, int& xplmVersion, int& xplraVersion);
 
    void reloadPlugins();
 
    void saveSituation(const char* path);
 
    int getInt(const char* name);
 
    float getFloat(const char* name);
 
    double getDouble(const char* name);
 
    size_t getFloatArray(const char* name, float* dest,
                         size_t length, size_t offset = 0);
 
    float* getFloatArray(const char* name, size_t& length,
                         size_t offset = 0);
 
    size_t getIntArray(const char* name, int32_t* dest,
                       size_t length, size_t offset = 0);
 
    int32_t* getIntArray(const char* name, size_t& length,
                         size_t offset = 0);
 
    size_t getByteArray(const char* name, uint8_t* dest,
                        size_t length, size_t offset = 0);
 
    uint8_t* getByteArray(const char* name, size_t& length,
                          size_t offset = 0);
 
    std::string getString(const char* name, size_t offset = 0);
 
    void setInt(const char* name, int value);
 
    void setFloat(const char* name, float value);
 
    void setDouble(const char* name, double value);
 
    void setFloatArray(const char* name, const float* values, size_t length,
                       size_t offset = 0);
 
    void setIntArray(const char* name, const int32_t* values, size_t length,
                     size_t offset = 0);
 
    void setByteArray(const char* name, const uint8_t* values, size_t length,
                      size_t offset = 0);
 
    void setString(const char* name, const char* value, size_t length,
                   size_t offset = 0);
 
    void showMessage(const char* message, float duration);
 
    void registerHotkeys(const uint16_t* codes, size_t length);
 
    void queryHotkeys(uint8_t* states, size_t length);
 
    void unregisterHotkeys();
 
private:
    void checkStream();
 
    void checkResult(uint8_t result, bool hasParameter = false,
                     long parameter = 0);
 
    void checkResult(bool multi = false);
 
    void getScalar(const char* name, uint8_t type);
 
    size_t getArray(const char* name, uint8_t type,
                    ssize_t length, size_t offset);
 
 
    void setScalar(const char* name, uint8_t type);
 
    void setArray(const char* name, uint8_t type, size_t length,
                  size_t offset);
 
    template <class ClientSocket>
    void connect(std::unique_ptr<ClientSocket> clientSocket);
 
    friend class MultiBuffer;
    friend class MultiGetter;
    friend class MultiSetter;
};
 
//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------
 
inline XPlane::XPlane() noexcept :
    socket(0),
    stream(0)
{
}
 
//------------------------------------------------------------------------------
 
inline bool XPlane::isConnected() const noexcept
{
    return socket!=0;
}
 
//------------------------------------------------------------------------------
 
} /* namespace hu::varadiistvan::xplra */ } /* namespace hu::varadiistvan */ } /* namespace hu */
 
//------------------------------------------------------------------------------
#endif // HU_VARADIISTVAN_XPLRA_XPLANE_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: