apiPWP.h

Go to the documentation of this file.

#ifndef _APIPWP_H_
#define _APIPWP_H_
/****************************************************************************
 *
 * Pointwise Plugin API (PWP-API) v1.0
 *
 * Proprietary software product of Pointwise, Inc.
 * Copyright (c) 1995-2020 Pointwise, Inc.
 * All rights reserved.
 *
 ***************************************************************************/

//*********************************************
//   platform-dependent export defines
//*********************************************
#if defined(WINDOWS)
#  define winmsgSTRING2(ss)  #ss
#  define winmsgSTRING(ss)  winmsgSTRING2(ss)
#  define PW_DLLEXPORT __declspec(dllexport)
#  define PW_DLLIMPORT __declspec(dllimport)
#else
#  define PW_DLLEXPORT
#  define PW_DLLIMPORT
#endif /* WINDOWS */

#undef PWP_PROTOTYPE_DECL

#ifdef BUILD_PWPLUGIN_DYNLIB

#include "apiUtils.h"

// Building a plugin dyn lib module.
// Don't need this stuff when building GgPlugin
// for Pointwise distro.

#if defined(WINDOWS)
#  if defined(SHOW_PWP_MESSAGES)
#    pragma message ("PWP_SITE_GROUPNAME='" PWP_SITE_GROUPNAME "'")
#    pragma message ("PWP_SITE_GROUPID='" winmsgSTRING(PWP_SITE_GROUPID) "'")
#  endif /* SHOW_PWP_MESSAGES */
#endif /* WINDOWS */

//*********************************************
# define PWP_PROTOTYPE_DECL PW_DLLEXPORT

#else // building pointwise distro

# define PWP_PROTOTYPE_DECL typedef

#endif
 // sdkINTERNALS


#if defined(WINDOWS) && defined(SHOW_PWP_MESSAGES)
#  pragma message ("PWP_PROTOTYPE_DECL='" winmsgSTRING(PWP_PROTOTYPE_DECL) "'")
#endif /* WINDOWS */


#undef PW_DLL_IMPEXP
#ifdef BUILD_GGPLUGIN
# define PW_DLL_IMPEXP PW_DLLEXPORT
#else
# define PW_DLL_IMPEXP PW_DLLIMPORT
#endif
 // sdkINTERNALS


extern "C" {

/***********************************************************/
/***********************************************************/
/***********************************************************/
/***********************************************************/
#define PWP_API_PLUGIN        "Plugin-PWP"

#define PWP_API_CAE_EXPORT    "Export-CAE"

#define PWP_API_GRID_IMPORT   "Import-GRID"

#define CAEP_API_EXPORT  PWP_API_CAE_EXPORT
 /* DOXGRP_APIPWP_BASENAMES */


/***********************************************************/
/***********************************************************/
typedef signed char         PWP_INT8;  

typedef unsigned char       PWP_UINT8; 

#define PWP_UINT8_MAX       ((PWP_UINT8)(~0))

#define PWP_UINT8_UNDEF     PWP_UINT8_MAX

#define PWP_INT8_FORMAT     "d"

#define PWP_UINT8_FORMAT    "u"



typedef short               PWP_INT16; 

typedef unsigned short      PWP_UINT16;

#define PWP_UINT16_MAX      ((PWP_UINT16)(~0))

#define PWP_UINT16_UNDEF    PWP_UINT16_MAX

#define PWP_INT16_FORMAT    "hd"

#define PWP_UINT16_FORMAT   "hu"



typedef int                 PWP_INT32; 

typedef unsigned int        PWP_UINT32;

#define PWP_UINT32_MAX      ((PWP_UINT32)(~0))

#define PWP_UINT32_UNDEF    PWP_UINT32_MAX

#define PWP_INT32_FORMAT    "d"

#define PWP_UINT32_FORMAT   "u"



#if defined(darwin) && defined(IS64BIT)

typedef long                PWP_INT64;

typedef unsigned long       PWP_UINT64;

#define PWP_INT64_FORMAT    "ld"

#define PWP_UINT64_FORMAT   "lu"
#else

typedef long long           PWP_INT64;

typedef unsigned long long  PWP_UINT64;

#define PWP_INT64_FORMAT    "lld"

#define PWP_UINT64_FORMAT   "llu"
#endif /* darwin && IS64BIT */

#define PWP_UINT64_MAX      ((PWP_UINT64)(~0))

#define PWP_UINT64_UNDEF    PWP_UINT64_MAX



typedef float               PWP_FLOAT; 

typedef double              PWP_REAL;  



#ifdef IS64BIT

typedef PWP_INT64           PWP_INT;

typedef PWP_UINT64          PWP_UINT;

#define PWP_INT_FORMAT      PWP_INT64_FORMAT

#define PWP_UINT_FORMAT     PWP_UINT64_FORMAT
#else

typedef PWP_INT32           PWP_INT;

typedef PWP_UINT32          PWP_UINT;

#define PWP_INT_FORMAT      PWP_INT32_FORMAT

#define PWP_UINT_FORMAT     PWP_UINT32_FORMAT
#endif /* IS64BIT */

#define PWP_UINT_MAX        ((PWP_UINT)(~0))

#define PWP_UINT_UNDEF      PWP_UINT_MAX



typedef int                 PWP_BOOL;  

#define PWP_FALSE           (0)         

#define PWP_TRUE            (!PWP_FALSE)

#define PWP_CAST_BOOL(v)    ((v) ? PWP_TRUE : PWP_FALSE)



typedef void                PWP_VOID; 
 /* DOXGRP_APIPWP_XPLATFORMTYPES */


/***********************************************************/
/***********************************************************/
#define PWP_DECLARE_HANDLE(name) \
                typedef struct name##_t { \
 \
                    int unused; \
 \
                } * name

#define PWP_HANDLE_ISVALID(h)    (0 != h)

#define PWP_HANDLE_INIT          0

#define PWP_HANDLE_SET(h, v)     h=v

#define PWP_HANDLE_SET_IMPL(h, hTyp, impl) (h=reinterpret_cast<hTyp>(&impl))

#define PWP_HANDLE_GET_IMPL(h, hTyp)        reinterpret_cast<hTyp##_IMPL*>(h)

#define PWP_BADID     (~((PWP_UINT32)0))

#define PWP_BADTYPE   ((unsigned char)~0)



#define PWP_DECLARE_HELEMGROUP(pname,name) \
                typedef struct name##_t { \
 \
                    pname hP; \
                    PWP_UINT32 id; \
 \
                } name

#define PWP_HEGRP_ISVALID(h)    (PWP_HANDLE_ISVALID((h).hP) && \
                                    (PWP_BADID != (h).id))

#define PWP_HEGRP_INIT          {0,PWP_BADID}

#define PWP_HEGRP_SET(h, p, v)  { (h).hP=(p); (h).id=(v); }

#define PWP_HEGRP_H(h)          ((h).hP)

#define PWP_HEGRP_ID(h)         ((h).id)



#define PWP_DECLARE_HEGRPITEM(sname,name) \
                typedef struct name##_t { \
 \
                    sname parent; \
                    unsigned char ptype; \
                    PWP_UINT32 id; \
 \
                } name

#define PWP_HEGI_ISVALID(h)       (PWP_HANDLE_ISVALID((h).parent.hP) && \
                                        (PWP_BADID != (h).parent.id) && \
                                        (PWP_BADTYPE != (h).ptype) && \
                                        (PWP_BADID != (h).id))

#define PWP_HEGI_INIT             {{0, PWP_BADID}, PWP_BADTYPE, PWP_BADID}

#define PWP_HEGI_SET(h, p, pt, pid, v)  { (h).parent.hP=(p); \
                                                (h).parent.id=(pid); \
                                                (h).ptype=(pt); \
                                                (h).id=(v); }

#define PWP_HEGI_H(h)      ((h).parent.hP)

#define PWP_HEGI_PID(h)    ((h).parent.id)

#define PWP_HEGI_PTYPE(h)  ((h).ptype)

#define PWP_HEGI_ID(h)     ((h).id)
 /* DOXGRP_APIPWP_DATAHANDLE_HELPERS */


PWP_DECLARE_HANDLE(PWP_HVALUE);

#define PWP_HVALUE_ISVALID(h)               PWP_HANDLE_ISVALID(h)

#define PWP_HVALUE_INIT                 PWP_HANDLE_INIT

#define PWP_HVALUE_SET(h, v)            PWP_HANDLE_SET(h, v)

#define PWP_HVALUE_SET_INVALID(h)       PWP_HVALUE_SET(h, PWP_HANDLE_INIT)

#define PWP_HVALUE_SET_IMPL(h, hTyp)    PWP_HANDLE_SET_IMPL(h, PWP_HVALUE, hTyp)

#define PWP_HVALUE_GET_IMPL(h)          PWP_HANDLE_GET_IMPL(h, PWP_HVALUE)


typedef PWP_UINT32  PWP_VERSIONVAL;


struct PWP_VERSION {
    PWP_VERSIONVAL major;

    PWP_VERSIONVAL minor;
};


struct PWP_LICENSEDATA {
    int dummy; // sdkINTERNALS
};


typedef enum PWP_ENUM_MSGID_e {
    PWP_MSGID_DEBUG,

    PWP_MSGID_INFO,

    PWP_MSGID_WARNING,

    PWP_MSGID_ERROR,

    // PWP_MSG_PROGRESS ids
    PWP_MSGID_PROGBEGIN,

    PWP_MSGID_PROGEND,

    PWP_MSGID_PROGSTATUS,

    PWP_MSGID_PROGQUIT,

    // add new group enum values before this line

    PWP_MSGID_SIZE,
    PWP_MSGID_LAST = PWP_MSGID_SIZE-1 // sdkINTERNALS
}
PWP_ENUM_MSGID;



typedef PWP_UINT32 (*PWP_MESSAGECB)(const char api[], PWP_ENUM_MSGID id,
                                    void *pMsg);

#define PWP_MESSAGECB_DEFAULT  "@@default"

#define PWP_MESSAGECB_SPY      "@@spy"


/*---------------------------------------------------------*/
struct PWP_MSG_PROGRESS {
    PWP_UINT32 value;
};


struct PWP_MSG_TEXT {
    PWP_UINT32 code; 
    const char *text;
};


struct PWP_APIINFO {
    const char *name;   
    PWP_VERSION ver;    
};


struct PWP_PLUGININFO {
    PWP_VERSION pwpVer;   
    PWP_VERSION libVer;   
    const char* author;   
    const char* support;  
    const char* copyright;
    PWP_UINT32 apiCount;  
    PWP_MESSAGECB defCB;  
    PWP_MESSAGECB spyCB;  
};


typedef enum PWP_ENUM_VALTYPE_e {
    PWP_VALTYPE_STRING, 
    PWP_VALTYPE_INT,    
    PWP_VALTYPE_UINT,   
    PWP_VALTYPE_REAL,   
    PWP_VALTYPE_ENUM,   
    PWP_VALTYPE_BOOL,   

    // add new enum values before this line

    PWP_VALTYPE_SIZE,
    PWP_VALTYPE_UNKNOWN = PWP_VALTYPE_SIZE,
    PWP_VALTYPE_LAST = PWP_VALTYPE_SIZE - 1 // sdkINTERNALS
}
PWP_ENUM_VALTYPE;



typedef PWP_BOOL PwpValue_t(const void * dest, PWP_ENUM_VALTYPE srcType,
                            const void * srcValue, PWP_UINT32 srcSize);


struct PW_DLL_IMPEXP PWP_HVALUE_IMPL {
    void *          dest_;
    PwpValue_t *    PwpValueCB_;
};



typedef enum PWP_ENUM_FILEDEST_e {
    PWP_FILEDEST_FILENAME, 
    PWP_FILEDEST_BASENAME, 
    PWP_FILEDEST_FOLDER,   
    /* add new group enum values before this line */

    PWP_FILEDEST_SIZE,
    PWP_FILEDEST_LAST = PWP_FILEDEST_SIZE - 1
    /* @} */ // sdkINTERNALS
}
PWP_ENUM_FILEDEST;



typedef enum PWP_ENUM_DIMENSION_e {
    PWP_DIMENSION_2D, 
    PWP_DIMENSION_3D, 
    /* add new group enum values before this line */

    PWP_DIMENSION_SIZE,
    PWP_DIMENSION_LAST = PWP_DIMENSION_SIZE - 1
    /* @} */ // sdkINTERNALS
}
PWP_ENUM_DIMENSION;



typedef enum PWP_ENUM_ENCODING_e {
    PWP_ENCODING_ASCII,       
    PWP_ENCODING_BINARY,      
    PWP_ENCODING_UNFORMATTED, 
    /* add new group enum values before this line */

    PWP_ENCODING_SIZE,
    PWP_ENCODING_LAST = PWP_ENCODING_SIZE - 1
    /* @} */ // sdkINTERNALS
}
PWP_ENUM_ENCODING;



typedef enum PWP_ENUM_PRECISION_e {
    PWP_PRECISION_SINGLE, 
    PWP_PRECISION_DOUBLE, 
    /* add new group enum values before this line */

    PWP_PRECISION_SIZE,
    PWP_PRECISION_LAST = PWP_PRECISION_SIZE - 1
    /* @} */ // sdkINTERNALS
}
PWP_ENUM_PRECISION;


//--------------------------------------------
typedef enum PWP_ENDIANNESS_t {
    PWP_ENDIAN_ERROR,   
    PWP_ENDIAN_NATIVE,  
    PWP_ENDIAN_FOREIGN, 
    PWP_ENDIAN_LITTLE,  
    PWP_ENDIAN_BIG      
}
PWP_ENDIANNESS;
 /* DOXGRP_APIPWP_TYPES */


/***********************************************************/
/***********************************************************/
PWP_PROTOTYPE_DECL PWP_BOOL
PwpInitialize();



PWP_PROTOTYPE_DECL PWP_BOOL
PwpActivateAPI(const char api[]);



PWP_PROTOTYPE_DECL PWP_VOID
PwpDestroy();



PWP_PROTOTYPE_DECL const char*
PwpEnumAPIs(PWP_UINT32 ndx, PWP_APIINFO *pInfo);



PWP_PROTOTYPE_DECL PWP_UINT32
PwpGetAPICount();



PWP_PROTOTYPE_DECL PWP_MESSAGECB
PwpGetMessageCallback(const char api[]);



PWP_PROTOTYPE_DECL PWP_VERSIONVAL
PwpGetPluginInfo(PWP_PLUGININFO *pInfo);



PWP_PROTOTYPE_DECL PWP_BOOL
PwpIsLicensed(const char api[], const PWP_LICENSEDATA *pLicenseData);



PWP_PROTOTYPE_DECL PWP_MESSAGECB
PwpSetMessageCallback(const char api[], PWP_MESSAGECB msgCB);



PWP_PROTOTYPE_DECL PWP_VOID
PwpSetLanguage(const char language[]);



PWP_PROTOTYPE_DECL PWP_BOOL
PwpGetValue(const char group[], const char key[], PWP_HVALUE value);
 // DOXGRP_APIPWP_FUNCTIONS


/***********************************************************/
/***********************************************************/
#define PWU_PUBLISH_NAMES_STR       "PublishedVar.Names"
#define PWU_PUBLISH_DEFNS_STR       "PublishedVar.Definitions"

#define PWU_VALUE_DEFN_NAME_STR     "name"
#define PWU_VALUE_DEFN_TYPE_STR     "type"
#define PWU_VALUE_DEFN_ACCESS_STR   "access"
#define PWU_VALUE_DEFN_DESC_STR     "description"
#define PWU_VALUE_DEFN_DEFAULT_STR  "default"
#define PWU_VALUE_DEFN_RANGE_STR    "range"

#define PWU_GROUP_JOIN(j1, j2)      j1 "." j2
#define PWU_GROUP_VALUE_NAMES(grp)  PWU_GROUP_JOIN(grp, PWU_PUBLISH_NAMES_STR)
#define PWU_GROUP_VALUE_DEFNS(grp)  PWU_GROUP_JOIN(grp, PWU_PUBLISH_DEFNS_STR)
 // DOXGRP_APIPWP_VALUES

} // extern "C"

#endif /* !_APIPWP_H_ */