mex.h

Go to the documentation of this file.

#if defined(_MSC_VER)
# pragma once
#endif
#if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3))
# pragma once
#endif

#ifndef mex_h
#define mex_h
#endif

#ifndef __MEX_PUBLISHED_API_HPP__
#define __MEX_PUBLISHED_API_HPP__


#ifndef EXTERN_C
#  ifdef __cplusplus
#    define EXTERN_C extern "C"
#  else
#    define EXTERN_C extern
#  endif
#endif

#if defined(BUILDING_LIBMEX)
#  include "mex/libmwmex_util.hpp"
#else
#  ifndef LIBMWMEX_API
#      define LIBMWMEX_API
#  endif

#  ifndef LIBMWMEX_API_EXTERN_C
#     define LIBMWMEX_API_EXTERN_C EXTERN_C LIBMWMEX_API
#  endif
#endif


#ifndef mex_typedefs_h
#define mex_typedefs_h

typedef struct impl_info_tag *MEX_impl_info;

#include "matrix.h"

#ifdef __cplusplus
extern "C"
{
#endif
typedef void (*mex_exit_fn)(void);
#ifdef __cplusplus
}
#endif

typedef struct mexGlobalTableEntry_Tag
{
    const char *name;             
    mxArray    **variable;        
} mexGlobalTableEntry, *mexGlobalTable;

#ifdef _WIN32
#define cicompare(s1,s2) utStrcmpi((s1),(s2))
#else
#define cicompare(s1,s2) strcmp((s1),(s2))
#endif
#define cscompare(s1,s2) strcmp((s1),(s2))

typedef struct mexFunctionTableEntry_tag {
  const char *  name;
  mxFunctionPtr f;
  int           nargin;
  int           nargout;
  struct _mexLocalFunctionTable *local_function_table;
} mexFunctionTableEntry, *mexFunctionTable;

typedef struct _mexLocalFunctionTable {
  size_t           length;
  mexFunctionTable entries;
} _mexLocalFunctionTable, *mexLocalFunctionTable;

typedef struct {
  void (*initialize)(void);
  void (*terminate)(void);
} _mexInitTermTableEntry, *mexInitTermTableEntry;

#define MEX_INFORMATION_VERSION 1

typedef struct {
  int                   version;
  int                   file_function_table_length;
  mexFunctionTable      file_function_table;
  int                   global_variable_table_length;
  mexGlobalTable        global_variable_table;
  int                   npaths;
  const char **         paths;
  int                   init_term_table_length;
  mexInitTermTableEntry init_term_table;
} _mex_information, *mex_information;

typedef mex_information(*fn_mex_file)(void);

typedef void (*fn_clean_up_after_error)(void);
typedef const char *(*fn_simple_function_to_string)(mxFunctionPtr f);

typedef void (*fn_mex_enter_mex_library)(mex_information x);
typedef fn_mex_enter_mex_library fn_mex_exit_mex_library;

typedef mexLocalFunctionTable (*fn_mex_get_local_function_table)(void);
typedef mexLocalFunctionTable (*fn_mex_set_local_function_table)(mexLocalFunctionTable);

#endif


#ifdef DLL_EXPORT_SYM
# define MEXFUNCTION_LINKAGE EXTERN_C DLL_EXPORT_SYM
#else
# ifdef MW_NEEDS_VERSION_H
#  include "version.h"
#  define MEXFUNCTION_LINKAGE EXTERN_C DLL_EXPORT_SYM
# else
#  define MEXFUNCTION_LINKAGE EXTERN_C
# endif
#endif


MEXFUNCTION_LINKAGE
void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[]);


#include "matrix.h"
#include <stdio.h>


LIBMWMEX_API_EXTERN_C void mexErrMsgTxt(const char *error_msg);

LIBMWMEX_API_EXTERN_C void mexErrMsgIdAndTxt(const char * identifier, const char * err_msg, ...);

LIBMWMEX_API_EXTERN_C void mexWarnMsgTxt(const char *warn_msg);

LIBMWMEX_API_EXTERN_C void mexWarnMsgIdAndTxt(const char * identifier, const char * warn_msg, ...);

LIBMWMEX_API_EXTERN_C int mexPrintf(const char *fmt, ...);

#define printf mexPrintf

LIBMWMEX_API_EXTERN_C void mexMakeArrayPersistent(mxArray *pa);

LIBMWMEX_API_EXTERN_C void mexMakeMemoryPersistent(void *ptr);

LIBMWMEX_API_EXTERN_C int mexCallMATLAB(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[], const char *fcn_name);

LIBMWMEX_API_EXTERN_C int mexCallMATLABWithObject(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[], const char *fcn_name);

LIBMWMEX_API_EXTERN_C mxArray *mexCallMATLABWithTrap(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[], const char *fcn_name);

LIBMWMEX_API_EXTERN_C mxArray *mexCallMATLABWithTrapWithObject(int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[], const char *fcn_name);


#ifndef MEX_DOUBLE_HANDLE
#define mexCallMATLAB mexCallMATLABWithObject
#define mexCallMATLABWithTrap mexCallMATLABWithTrapWithObject
#define mexGetVariable mexGetVariableWithObject
#define mexGet(a,b) \
NULL;do{mexGetIsDeprecated x;}while(0)
#define mexSet(a,b,c) \
0;do{mexSetIsDeprecated x;}while(0)
#else

LIBMWMEX_API_EXTERN_C const mxArray *mexGet(double handle, const char *property);

LIBMWMEX_API_EXTERN_C int mexSet(double handle, const char *property, mxArray *value);

#endif


LIBMWMEX_API_EXTERN_C void mexSetTrapFlag(int flag);

LIBMWMEX_API_EXTERN_C void mexPrintAssertion(const char *test, const char *fname, int linenum, const char *message);

LIBMWMEX_API_EXTERN_C bool mexIsGlobal(const mxArray *pa);

LIBMWMEX_API_EXTERN_C int mexPutVariable(const char *workspace, const char *name, const mxArray *parray);

LIBMWMEX_API_EXTERN_C const mxArray *mexGetVariablePtr(const char *workspace, const char *name);

LIBMWMEX_API_EXTERN_C mxArray *mexGetVariable(const char *workspace, const char *name);

LIBMWMEX_API_EXTERN_C void mexLock(void);

LIBMWMEX_API_EXTERN_C void mexUnlock(void);

LIBMWMEX_API_EXTERN_C bool mexIsLocked(void);

LIBMWMEX_API_EXTERN_C const char *mexFunctionName(void);

LIBMWMEX_API_EXTERN_C int mexEvalString(const char *str);

LIBMWMEX_API_EXTERN_C mxArray* mexEvalStringWithTrap(const char *str);

LIBMWMEX_API_EXTERN_C int mexAtExit(mex_exit_fn exit_fcn);

#endif /* mex_h */