/*************************************************************************
                        Mathematica source file

        Copyright 1986 through 2015 by Wolfram Research Inc.

This material contains trade secrets and may be registered with the
U.S. Copyright Office as an unpublished work, pursuant to Title 17,
U.S. Code, Section 408.  Unauthorized copying, adaptation, distribution
or display is prohibited.

$Id: WolframLibrary.h,v 1.65 2014/09/30 15:03:51 marks Exp $

*************************************************************************/

#ifndef WOLFRAMLIBRARY_H
#define WOLFRAMLIBRARY_H

// #include "setjmp.h"

#define WolframLibraryVersion 6

#if !(defined(MATHEMATICA_KERNEL) || defined(MATHEMATICA_RUNTIME))

#include <stddef.h>
#include <stdint.h>
#include "dllexport.h"
#include "extern.h"

#ifdef __cplusplus
extern "C" {
#endif

#define True	1
#define False	0

#ifdef MINT_32
typedef int32_t mint;
typedef uint32_t umint;
#else
typedef int64_t mint;
typedef uint64_t umint;
#endif

typedef int mbool;

typedef double mreal;

typedef int type_t;

typedef int errcode_t;

typedef uint32_t UBIT32;

typedef uint64_t UBIT64;

/* Platform specific variants in mcomplex.h */

typedef struct {mreal ri[2];} mcomplex;

#define mcreal(z) (((z).ri)[0])
#define mcimag(z) (((z).ri)[1])

/* Incomplete types */

typedef struct st_MTensor *MTensor;

typedef struct st_MNumericArray *MRawArray;

typedef struct st_MNumericArray *MNumericArray;

typedef struct MSparseArray_struct *MSparseArray;

typedef struct IMAGEOBJ_ENTRY *MImage;

/* Hard-coded types for CYINTEGER, CYREAL CYCOMPLEX */

#define MType_Integer 2
#define MType_Real 3
#define MType_Complex 4

typedef union {
	mbool *boolean;
	mint *integer;
	mreal *real;
	mcomplex *cmplex;
	MTensor *tensor;
	MSparseArray *sparse;
	MNumericArray *numeric;
	MImage *image;
	char **utf8string;
} MArgument;

#define MArgument_getBooleanAddress(marg)		((marg).boolean)
#define MArgument_getIntegerAddress(marg)		((marg).integer)
#define MArgument_getRealAddress(marg)			((marg).real)
#define MArgument_getComplexAddress(marg)		((marg).cmplex)
#define MArgument_getMTensorAddress(marg)		((marg).tensor)
#define MArgument_getMSparseArrayAddress(marg)	((marg).sparse)
#define MArgument_getMRawArrayAddress(marg)		((marg).numeric)
#define MArgument_getMNumericArrayAddress(marg)	((marg).numeric)
#define MArgument_getMImageAddress(marg)		((marg).image)
#define MArgument_getUTF8StringAddress(marg)	((marg).utf8string)

#define MArgument_getAddress(marg)				((void *) ((marg).integer))
#define MArgument_setAddress(marg, add)			(((marg).integer) = ((mint *) (add)))

#define MArgument_getBoolean(marg)				(*MArgument_getBooleanAddress(marg))
#define MArgument_getInteger(marg)				(*MArgument_getIntegerAddress(marg))
#define MArgument_getReal(marg)					(*MArgument_getRealAddress(marg))
#define MArgument_getComplex(marg)				(*MArgument_getComplexAddress(marg))
#define MArgument_getMTensor(marg)				(*MArgument_getMTensorAddress(marg))
#define MArgument_getMSparseArray(marg)			(*MArgument_getMSparseArrayAddress(marg))
#define MArgument_getMRawArray(marg)			(*MArgument_getMRawArrayAddress(marg))
#define MArgument_getMNumericArray(marg)		(*MArgument_getMNumericArrayAddress(marg))
#define MArgument_getMImage(marg)				(*MArgument_getMImageAddress(marg))
#define MArgument_getUTF8String(marg)			(*MArgument_getUTF8StringAddress(marg))

#define MArgument_setBoolean(marg, v)			((*MArgument_getBooleanAddress(marg)) = (v))
#define MArgument_setInteger(marg, v)			((*MArgument_getIntegerAddress(marg)) = (v))
#define MArgument_setReal(marg, v)				((*MArgument_getRealAddress(marg)) = (v))
#define MArgument_setComplex(marg, v)			((*MArgument_getComplexAddress(marg)) = (v))
#define MArgument_setMTensor(marg, v)			((*MArgument_getMTensorAddress(marg)) = (v))
#define MArgument_setMSparseArray(marg, v)		((*MArgument_getMSparseArrayAddress(marg)) = (v))
#define MArgument_setMRawArray(marg, v)			((*MArgument_getMRawArrayAddress(marg)) = (v))
#define MArgument_setMNumericArray(marg, v)		((*MArgument_getMNumericArrayAddress(marg)) = (v))
#define MArgument_setMImage(marg, v)			((*MArgument_getMImageAddress(marg)) = (v))
#define MArgument_setUTF8String(marg, v)		((*MArgument_getUTF8StringAddress(marg)) = (v))

#ifdef __cplusplus
}
#endif

#endif /* !(defined(MATHEMATICA_KERNEL) || defined(MATHEMATICA_RUNTIME)) */

#ifdef __cplusplus
extern "C" {
#endif

#if defined(_MATHLINK_H)

#define WSLINK MLINK
#define WSENV MLENV

#else

#ifndef __MLINK__
typedef struct MLink *MLINK;
typedef struct MLink *WSLINK;
#define __MLINK__
#endif

#ifndef __MLENV__
typedef struct ml_environment *MLENV;
typedef MLENV MLEnvironment;
typedef struct ml_environment *WSENV;
typedef WSENV WSEnvironment;
#define __MLENV__
#endif

#endif /* defined(_MATHLINK_H) */

#ifndef MSTREAM_TYPEDEF
#define MSTREAM_TYPEDEF
typedef struct st_MInputStream *MInputStream;
typedef struct st_MOutputStream *MOutputStream;
#endif

/* Error types for LibraryErrorHandler */
enum {
	LIBRARY_NO_ERROR = 0,
	LIBRARY_TYPE_ERROR,
	LIBRARY_RANK_ERROR,
	LIBRARY_DIMENSION_ERROR,
	LIBRARY_NUMERICAL_ERROR,
	LIBRARY_MEMORY_ERROR,
	LIBRARY_FUNCTION_ERROR,
	LIBRARY_VERSION_ERROR
};

typedef struct st_DataStore *DataStore;



typedef struct st_WolframLibraryData* WolframLibraryData;

/* For backward compatibility with name change */
#define		getMathLink				getWSLINK
#define		processMathLink			processWSLINK
#define		getMathLinkEnvironment	getWSLINKEnvironment

struct st_WolframLibraryData
{
	void (*UTF8String_disown)(char *);

	int (*MTensor_new)(mint, mint, mint const*, MTensor *);
	void (*MTensor_free)( MTensor);
	int (*MTensor_clone)( MTensor, MTensor *);
	mint (*MTensor_shareCount)(MTensor);
	void (*MTensor_disown)( MTensor);
	void (*MTensor_disownAll)(MTensor);

	int (*MTensor_setInteger)(MTensor, mint*, mint);
	int (*MTensor_setReal)(MTensor, mint*, mreal);
	int (*MTensor_setComplex)(MTensor, mint*, mcomplex);
	int (*MTensor_setMTensor)(MTensor, MTensor, mint*, mint);

	int (*MTensor_getInteger)(MTensor, mint *, mint *);
	int (*MTensor_getReal)(MTensor, mint *, mreal *);
	int (*MTensor_getComplex)(MTensor, mint *, mcomplex *);
	int (*MTensor_getMTensor)(MTensor, mint *, mint, MTensor *);

	mint (*MTensor_getRank)( MTensor);
	mint const * (*MTensor_getDimensions)( MTensor);
	mint (*MTensor_getType)( MTensor);
	mint (*MTensor_getFlattenedLength)( MTensor);
	mint* (*MTensor_getIntegerData)( MTensor);
	mreal* (*MTensor_getRealData)( MTensor);
	mcomplex* (*MTensor_getComplexData)( MTensor);
	void (*Message)(const char *);
	mint (*AbortQ)(void);
	WSLINK (*getWSLINK)(WolframLibraryData);
	int (*processWSLINK)(WSLINK);
	int (*evaluateExpression)(WolframLibraryData, char *, int, mint, void *);
	struct st_WolframRuntimeData *runtimeData;
	struct st_WolframCompileLibrary_Functions *compileLibraryFunctions;
	mint VersionNumber;

	/* Added in WolframLibraryVersion 2 */
	mbool (*registerInputStreamMethod)(
		const char *name,
		void  (*ctor)(MInputStream, const char* msgHead, void* optionsIn),
		mbool (*handlerTest)(void*, char*),
		void* methodData,
		void  (*destroyMethod)(void* methodData)
	);

	mbool (*unregisterInputStreamMethod)(const char *name);

	mbool (*registerOutputStreamMethod)(
		const char *name,
		void  (*ctor)(MOutputStream, const char* msgHead, void* optionsIn, mbool appendMode),
		mbool (*handlerTest)(void*, char*),
		void* methodData,
		void  (*destroyMethod)(void* methodData)
	);

	mbool (*unregisterOutputStreamMethod)(const char *name);

	struct st_WolframIOLibrary_Functions* ioLibraryFunctions;
	WSENV (*getWSLINKEnvironment)(WolframLibraryData);
	struct st_WolframSparseLibrary_Functions *sparseLibraryFunctions;
	struct st_WolframImageLibrary_Functions *imageLibraryFunctions;

	int (*registerLibraryExpressionManager)(const char *mname, void (*mfun)(WolframLibraryData, mbool, mint));
	int (*unregisterLibraryExpressionManager)(const char *mname);
	int (*releaseManagedLibraryExpression)(const char *mname, mint id);

	int (*registerLibraryCallbackManager)(const char *name, mbool (*mfun)(WolframLibraryData, mint, MTensor));
	int (*unregisterLibraryCallbackManager)(const char *name);
	int (*callLibraryCallbackFunction)(mint id, mint ArgC, MArgument *Args, MArgument Res);
	int (*releaseLibraryCallbackFunction)(mint id);

	/* security callback */
	mbool (*validatePath)(char* path, char type);
	mbool (*protectedModeQ)(void);

	struct st_WolframRawArrayLibrary_Functions *rawarrayLibraryFunctions;
	struct st_WolframNumericArrayLibrary_Functions *numericarrayLibraryFunctions;

	/*
		Sets the value ParallelThreadNumber and returns the old value, or the input if invalid.
		The old value should be stored in a local variable.
		The old value must be restored using restoreParallelThreadNumber
		before the setting routine exits.
	 */
	int (*setParallelThreadNumber)(int);
	void (*restoreParallelThreadNumber)(int);
	int (*getParallelThreadNumber)(void);
};

#ifdef __cplusplus
}
#endif

#endif