gclib_compat.h

Go to the documentation of this file.

#ifndef GCLIB_COMPAT_H
#define GCLIB_COMPAT_H
 
#ifdef _MSC_VER
#define GCLIB_DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__) | defined(__clang__)
#define GCLIB_DEPRECATED __attribute__((__deprecated__))
#else
#define GCLIB_DEPRECATED
#endif
 
#include "gclib_record.h" // Galil data record structs and unions.
#include "gclib_errors.h" // GReturn error code values and strings.
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef _WIN32
#pragma GCC visibility push(default)
#endif
 
// Constants for function arguments
#define G_DR 1 
#define G_QR 0 
#define G_BOUNDS -1 
#define G_CR 0 
#define G_COMMA 1 
#define G_PUBLISH_SERVER 1 
#define G_REMOVE_SERVER 0 
#define G_USE_INITIAL_TIMEOUT -1 
 
// Convenience constants
#define G_SMALL_BUFFER 1024 
#define G_HUGE_BUFFER 524288 
#define G_LINE_BUFFER 80 
 
//Constants for GUtility()
#define G_UTIL_TIMEOUT 1 
#define G_UTIL_TIMEOUT_OVERRIDE 2 
#define G_USE_INITIAL_TIMEOUT -1 
#define G_UTIL_VERSION 128 
#define G_UTIL_INFO 129 
#define G_UTIL_SLEEP 130 
#define G_UTIL_ADDRESSES 131 
#define G_UTIL_IPREQUEST 132 
#define G_UTIL_ASSIGN 133 
#define G_UTIL_DEVICE_INITIALIZE 134  
#define G_UTIL_PING 135 
#define G_UTIL_ERROR_CONTEXT 136 
 
#define G_UTIL_GCAPS_HOST 256
#define G_UTIL_GCAPS_VERSION 257 
#define G_UTIL_GCAPS_KEEPALIVE 258 
#define G_UTIL_GCAPS_ADDRESSES 259 
#define G_UTIL_GCAPS_IPREQUEST 260 
#define G_UTIL_GCAPS_ASSIGN 261 
#define G_UTIL_GCAPS_PING 262 
#define G_UTIL_GCAPS_LIST_SERVERS 263 
#define G_UTIL_GCAPS_PUBLISH_SERVER 264 
#define G_UTIL_GCAPS_SET_SERVER 265 
#define G_UTIL_GCAPS_SERVER_STATUS 266 
#define G_UTIL_GCAPS_REMOTE_CONNECTIONS 267 
#define G_UTIL_GCAPS_SERVER_INFO 268
#define G_UTIL_GCAPS_ADDRESSES_GET_REMEMBERED 269 
#define G_UTIL_GCAPS_ADDRESSES_SET_REMEMBERED 270 
 
typedef int GReturn; 
typedef struct Context* GCon; 
typedef unsigned int GSize; 
typedef int GOption; 
typedef char* GCStringOut; 
typedef const char* GCStringIn; 
typedef char* GBufOut; 
typedef const char* GBufIn; 
typedef unsigned char GStatus; 
typedef void* GMemory; 

GCLIB_DEPRECATED GReturn GOpen(GCStringIn connection_string, GCon* g);

GCLIB_DEPRECATED GReturn GClose(GCon g);

GCLIB_DEPRECATED GReturn GCommand(GCon g, GCStringIn command, GBufOut buffer, GSize buffer_len, GSize* bytes_returned);

GCLIB_DEPRECATED GReturn GProgramDownload(GCon g, GCStringIn program, GCStringIn preprocessor);

GCLIB_DEPRECATED GReturn GProgramUpload(GCon g, GBufOut buffer, GSize buffer_len);

GCLIB_DEPRECATED GReturn GArrayDownload(GCon g, const GCStringIn array_name, GOption first, GOption last, GCStringIn buffer);

GCLIB_DEPRECATED GReturn GArrayUpload(GCon g, const GCStringIn array_name, GOption first, GOption last, GOption delim, GBufOut buffer, GSize buffer_len);

GCLIB_DEPRECATED GReturn GRecord(GCon g, union GDataRecord* record, GOption method);

GCLIB_DEPRECATED GReturn GMessage(GCon g, GCStringOut buffer, GSize buffer_len);

GCLIB_DEPRECATED GReturn GInterrupt(GCon g, GStatus* status_byte);

GCLIB_DEPRECATED GReturn GFirmwareDownload(GCon g, GCStringIn filepath);

GCLIB_DEPRECATED GReturn GRead(GCon g, GBufOut buffer, GSize buffer_len, GSize* bytes_read);
GCLIB_DEPRECATED GReturn GWrite(GCon g, GBufIn buffer, GSize buffer_len);
GCLIB_DEPRECATED GReturn GUtility(GCon g, GOption request, GMemory memory1, GMemory memory2);
 
#ifdef __cplusplus
} //extern "C"
#endif
 
#ifndef _WIN32
#pragma GCC visibility pop
#endif
 
#endif // GCLIB_COMPAT_H