apiPWP.cxx

Go to the documentation of this file.

/****************************************************************************
 *
 * PWP Plugin example
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#include <string.h>
 
// Define this on the build command line for verbose build messages
// #define SHOW_PWP_MESSAGES
#include "apiPWP.h"
#include "apiPWPUtils.h"
#include "apiUtils.h"
 
//************************* COMPILE TIME SANITY CHECKS *************************
// PWP_INT and PWP_UINT are must be sizeof(void*) for the target machine
VERIFY_EXPLICIT_CAST(void*, PWP_INT);
VERIFY_EXPLICIT_CAST(void*, PWP_UINT);
 
 
//************************************************
// impl-defined plugin version values
//************************************************
#include "rtPwpVersions.h"
 
/*------------------------------------*/
PWU_RTITEM pwpRtItem[] = {
 
// include the impl-defined PWP runtime item array data
#include "rtPwpInitItems.h"
 
    // special items NOT returned bt PwpEnumAPIs() - always LAST!
    /*............................*/
    {
        {PWP_MESSAGECB_DEFAULT, {0,0}},
        0,
    },
    /*............................*/
    {
        {PWP_MESSAGECB_SPY, {0,0}},
        0,
    },
};
 
PWP_UINT32  totalApiCnt     = ARRAYSIZE(pwpRtItem);
PWP_UINT32  publishedApiCnt = ARRAYSIZE(pwpRtItem) - 2;
 
 
/**************************************/
PWP_BOOL PwpInitialize()
{
    PWP_BOOL ret = PWP_TRUE;
    return ret;
}
 
/**************************************/
PWP_BOOL PwpActivateAPI(const char api[])
{
    return PwuFindPublishedAPI(api) ? PWP_TRUE : PWP_FALSE;
}
 
/**************************************/
PWP_VOID PwpDestroy()
{
}
 
/**************************************/
const char* PwpEnumAPIs(PWP_UINT32 ndx, PWP_APIINFO *pInfo)
{
    const char* ret = (ndx < publishedApiCnt) ? pwpRtItem[ndx].apiInfo.name : 0;
    if (ret && pInfo) {
        *pInfo = pwpRtItem[ndx].apiInfo;
    }
    return ret;
}
 
/**************************************/
PWP_UINT32 PwpGetAPICount()
{
    return publishedApiCnt;
}
 
/**************************************/
PWP_MESSAGECB PwpGetMessageCallback(const char api[])
{
    return PwuFindApiMsgCB(api);
}
 
/**************************************/
PWP_VERSIONVAL PwpGetPluginInfo(PWP_PLUGININFO *pInfo)
{
    PWP_VERSIONVAL ret = VERSION_PWP_MAJOR;
    PWP_PLUGININFO info = {
#       include "rtPwpPluginInfo.h"
    };
 
    info.apiCount = publishedApiCnt;
    info.defCB    = PwuFindApiMsgCB(PWP_MESSAGECB_DEFAULT);
    info.spyCB    = PwuFindApiMsgCB(PWP_MESSAGECB_SPY);
 
    if (pInfo) {
        *pInfo = info;
    }
    return ret;
}
 
/**************************************/
PWP_BOOL PwpIsLicensed(const char api[], const PWP_LICENSEDATA *pLicenseData)
{
    return (pLicenseData && PwuFindPublishedAPI(api)) ? PWP_TRUE : PWP_FALSE;
}
 
/**************************************/
PWP_MESSAGECB PwpSetMessageCallback(const char api[], PWP_MESSAGECB msgCallback)
{
    PWP_MESSAGECB ret = 0;
    PWU_RTITEM *pApiItem = PwuFindTotalAPI(api);
    if (pApiItem) {
        ret = pApiItem->msgCB;
        //PwuSendDebugMsg(api, "removing callback", 0);
        pApiItem->msgCB = msgCallback;
        //PwuSendDebugMsg(api, "adding callback", 1);
    }
    return ret;
}
 
/**************************************/
PWP_VOID PwpSetLanguage(const char language[])
{
    if (language && language[0]) {
    }
}
 
 
/**************************************/
PWP_BOOL PwpGetValue(const char group[], const char key[], PWP_HVALUE hVal)
{
    PWP_BOOL ret = PWP_FALSE;
    if (group && key && PWP_HVALUE_ISVALID(hVal)) {
        ret = PwuGetValue(group, key, hVal);
    }
    return ret;
}