pluginExtension.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: pluginExtension.h,v $ $Revision: 1.19 $ $State: Exp $
*******************************************************************************/


#ifndef PLUGINEXTENSION_H_
#define PLUGINEXTENSION_H_

#include <vlutil/vlString.h>

#pragma warning (disable:4251)
#ifdef WIN32
   #ifdef DT_DLL_BUILD
      #ifdef DT_PLUGIN_EXPORTS
         #define DT_DLL_PLUGIN __declspec(dllexport)
      #else
         #define DT_DLL_PLUGIN __declspec(dllimport)
      #endif
   #else
      #define DT_DLL_PLUGIN
   #endif
#else
   #define DT_DLL_PLUGIN
#endif

class DtTMApplication;

#define DtInitializePluginFunction "DtInitializePlugin"
#define DtPostAppInitialize "DtPostInitializePlugin"
#define DtGuiUnloadPlugin "DtUnloadPlugin"
#define DtPluginVersionFunction "DtPluginVersion"

typedef struct _DtPluginInformation
{
   DtString    pluginName;
   DtString    pluginVersion;
   DtString    pluginDescription;
   DtString    pluginCreator;
   DtString    pluginCreatorEmail;
   DtString    pluginContactWebPage;
   DtString    pluginContactMailingAddress;
   DtString    pluginContactPhone;
   DtString    applicationVersion;
} DtPluginInformation;

typedef bool (*DtInitializePluginFcn)(DtTMApplication* app, DtPluginInformation&);
typedef bool (*DtPostAppInitializeFcn)(DtTMApplication* app, DtPluginInformation&);
typedef bool (*DtUnloadPluginFcn)();
typedef void (*DtPluginVersionFcn)(DtString&);

//extern "C" {
//}

#if defined (BUILDING_PLUGIN)
   #if !defined (APPLICATION_VERSION)
      #pragma message ("APPLICATION_VERSION is not defined for plugin.")
      #pragma message ("If building a tdbTool plugin, include tdbToolVersion.h")
      #pragma message ("If building a PVD plugin, include pvdVersion.h")
      #pragma message ("If building a VRF GUI plugin, include vrfGuiVersion.h")
      #pragma message ("Not including one of these headers could cause application instability if this plugin is used against a later version of an application.")
   #else
      #include <vlutil/vlString.h>

      extern "C" {
         DT_DLL_PLUGIN void DtPluginVersion(DtString& version)
         {
            version = PLUGIN_COMPATIBLE_VERSION;
#ifdef WIN32
#ifdef NDEBUG
            version += " Release";
#else
            version += " Debug";
#endif
#endif
         }
      }
   #endif
#endif

#endif