xplra.h

Go to the documentation of this file.

/* 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_XPLRA_H
#define HU_VARADIISTVAN_XPLRA_XPLRA_H
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------*/
 
#include <stdlib.h>
#include <inttypes.h>
 
/*----------------------------------------------------------------------------*/
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*----------------------------------------------------------------------------*/
 
#define ERROR_NONE 0
 
#define ERROR_IO 1
 
#define ERROR_PROTOCOL 2
 
#define ERROR_PROTOCOL_INVALID_COMMAND = 1
 
#define ERROR_PROTOCOL_UNKNOWN_DATAREF = 2
 
#define ERROR_PROTOCOL_INVALID_TYPE = 3
 
#define ERROR_PROTOCOL_INVALID_LENGTH = 4
 
#define ERROR_PROTOCOL_INVALID_OFFSET = 5
 
#define ERROR_PROTOCOL_INVALID_COUNT = 6
 
#define ERROR_PROTOCOL_INVALID_ID = 7
 
#define ERROR_PROTOCOL_INVALID_DURATION = 8
 
#define ERROR_PROTOCOL_OTHER = 255
 
#define ERROR_NOT_CONNECTED 3
 
#define ERROR_TYPE_MISMATCH 4
 
#define ERROR_INVALID_ID 5
 
#define ERROR_OTHER 255
 
/*----------------------------------------------------------------------------*/
 
#define HOTKEY_MODIFIER_SHIFT 0x01
 
#define HOTKEY_MODIFIER_CONTROL 0x02
 
/*----------------------------------------------------------------------------*/
 
#define INVALID_DATAREF_ID ((size_t)-1)
 
/*----------------------------------------------------------------------------*/
 
int xplra_get_last_error(int connectionID, unsigned long* subCode);
 
const char* xplra_get_last_error_string(int connectionID);
 
void xplra_clear_last_error(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_connect();
 
/*----------------------------------------------------------------------------*/
 
int xplra_connect_tcp(const char* address);
 
/*----------------------------------------------------------------------------*/
 
int xplra_connect_tcp_port(const char* address, unsigned short port);
 
/*----------------------------------------------------------------------------*/
 
int xplra_get_versions(int connectionID,
                       int* xplaneVersion, int* xplmVersion,
                       int* xplraVersion);
 
/*----------------------------------------------------------------------------*/
 
int xplra_reload_plugins(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_save_situation(int connectionID, const char* path);
 
/*----------------------------------------------------------------------------*/
/* Single dataref support                                                     */
/*----------------------------------------------------------------------------*/
 
int xplra_get_int(int* value, int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
int xplra_get_float(float* value, int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
int xplra_get_double(double* value, int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_get_float_array(float* dest, size_t length, size_t offset,
                              int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
float* xplra_get_float_array_new(size_t* length, size_t offset,
                                 int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_get_int_array(int32_t* dest, size_t length, size_t offset,
                            int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
int32_t* xplra_get_int_array_new(size_t* length, size_t offset,
                                 int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_get_byte_array(void* dest, size_t length, size_t offset,
                             int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
uint8_t* xplra_get_byte_array_new(size_t* length, size_t offset,
                                  int connectionID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_int(int connectionID, const char* name, int value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_float(int connectionID, const char* name, float value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_double(int connectionID, const char* name, double value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_float_array(int connectionID, const char* name,
                          const float* values, size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_int_array(int connectionID, const char* name,
                        const int32_t* values, size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_byte_array(int connectionID, const char* name,
                         const void* values, size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
int xplra_set_string(int connectionID, const char* name,
                     const char* value, size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
/* Multi-dataref support                                                      */
/*----------------------------------------------------------------------------*/
 
int xplra_multi_create_getter(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_create_setter(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_int(int bufferID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_float(int bufferID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_double(int bufferID, const char* name);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_float_array(int bufferID, const char* name,
                                   size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_int_array(int bufferID, const char* name,
                                 size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
size_t xplra_multi_add_byte_array(int bufferID, const char* name,
                                  size_t length, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_finalize(int bufferID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_register(int bufferID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_unregister(int bufferID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_unregister_safely(int bufferID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_execute(int bufferID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_set_int(int bufferID, size_t datarefID, int value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_get_int(int* dest, int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const int32_t* xplra_multi_get_int_const_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
int32_t* xplra_multi_get_int_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_set_float(int bufferID, size_t datarefID, float value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_get_float(float* dest, int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const float* xplra_multi_get_float_const_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
float* xplra_multi_get_float_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_set_double(int bufferID, size_t datarefID, double value);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_get_double(double* dest, int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const double* xplra_multi_get_double_const_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
double* xplra_multi_get_double_ptr(int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_set_float_array(int bufferID, size_t datarefID,
                                    const float* value, size_t length,
                                    size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_get_float_array(float* value,
                                    size_t length, size_t offset,
                                    int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const float* xplra_multi_get_float_array_ptr(int bufferID, size_t datarefID,
                                             size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_set_int_array(int bufferID, size_t datarefID,
                                  const int32_t* value, size_t length,
                                  size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_get_int_array(int32_t* value,
                                  size_t length, size_t offset,
                                  int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const int32_t* xplra_multi_get_int_array_ptr(int bufferID, size_t datarefID,
                                             size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_set_byte_array(int bufferID, size_t datarefID,
                                   const void* value, size_t length,
                                   size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_get_byte_array(void* value,
                                   size_t length, size_t offset,
                                   int bufferID, size_t datarefID);
 
/*----------------------------------------------------------------------------*/
 
const uint8_t* xplra_multi_get_byte_array_ptr(int bufferID, size_t datarefID,
                                              size_t offset);
 
/*----------------------------------------------------------------------------*/
 
ssize_t xplra_multi_set_string(int bufferID, size_t datarefID,
                               const char* value, size_t offset);
 
/*----------------------------------------------------------------------------*/
 
const char* xplra_multi_get_string_ptr(int bufferID, size_t datarefID,
                                       size_t offset);
 
/*----------------------------------------------------------------------------*/
 
int xplra_multi_destroy_buffer(int connectionID, int bufferID);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int xplra_show_message(int connectionID, const char* message, float duration);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int xplra_register_hotkeys(int connectionID,
                           const uint16_t* codes, size_t length);
 
/*----------------------------------------------------------------------------*/
 
int xplra_query_hotkeys(int connectionID, uint8_t* states, size_t length);
 
/*----------------------------------------------------------------------------*/
 
int xplra_unregister_hotkeys(int connectionID);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int xplra_disconnect(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_reconnect(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
int xplra_destroy(int connectionID);
 
/*----------------------------------------------------------------------------*/
 
#ifdef __cplusplus
} // extern "C"
#endif
 
/*----------------------------------------------------------------------------*/
#endif // HU_VARADIISTVAN_XPLRA_XPLRA_H