FCMMacros.h

Go to the documentation of this file.

/******************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
******************************************************************************/

#ifndef FCM_MACROS_H_
#define FCM_MACROS_H_

#include "FCMPreConfig.h"


/* -------------------------------------------------- Forward Decl */


/* -------------------------------------------------- Enums */


/* -------------------------------------------------- Macros / Constants */

namespace FCM
{
    #define FCM_VERSION_MAJOR                   0x01
    

    #define FCM_VERSION_MINOR                   0x03
    

    #define FCM_VERSION_MAINTENANCE             0x00
    

    #define FCM_VERSION_BUILD                   0x00

    
    #define FCM_VERSION ((FCM_VERSION_MAJOR << 24) | (FCM_VERSION_MINOR << 16) | \
                         (FCM_VERSION_MAINTENANCE << 8) | (FCM_VERSION_BUILD))


    #define DEFINE_FCMIID    (name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \
    const FCMID name = {l, w1, w2, {b1, b2,  b3,  b4,  b5,  b6,  b7,  b8}}
    
    
    #define IID(ifx) IID_##ifx
    
    
    #define _FCM_SIMPLEMAPENTRY ((_FCM_CREATORARGFUNC*)0)
    


    #define FORWARD_DECLARE_INTERFACE(ifx) \
    class ifx; \
    typedef ifx* P##ifx;



    #define BEGIN_DECLARE_INTERFACE_COMMON(ifx, iid) \
    FORWARD_DECLARE_INTERFACE(ifx) \
    const FCM::FCMIID IID_##ifx = (iid); \
    using namespace FCM;
    
    
    #define BEGIN_DECLARE_INTERFACE_INHERIT(ifx, iid, baseifx) \
    BEGIN_DECLARE_INTERFACE_COMMON (ifx, iid) \
    class ifx : public baseifx {  public:  inline static FCM::FCMIID GetIID() {return IID(ifx);}
    


    #define BEGIN_DECLARE_INTERFACE(ifx, iid) BEGIN_DECLARE_INTERFACE_INHERIT(ifx, iid, FCM::IFCMUnknown);


    #define BEGIN_DECLARE_BASE_INTERFACE(ifx, iid) \
    BEGIN_DECLARE_INTERFACE_COMMON (ifx, iid) \
    class ifx { public: inline static FCM::FCMIID GetIID() {return IID(ifx);}
      

    #define END_DECLARE_INTERFACE    };
        
    
    #if defined(__GNUC__) 
        #define _FCMCALL
    #else
        #define _FCMCALL __stdcall
    #endif


    #define FCM_ADDREF(intPtr) if(intPtr){(intPtr)->AddRef();}
    

    #define FCM_RELEASE(intPtr) if(intPtr){(intPtr)->Release();(intPtr)=0;}
    
    
    #define _FCM_PACKING 1


    #define offsetofclass(base, derived) \
                ((FCM::S_Int64)(static_cast<base*>((derived*)_FCM_PACKING))-_FCM_PACKING)


    #define offsetofclasscustom(base,custom, derived) \
                ((FCM::S_Int64)(static_cast<base*>((custom*)((derived*)_FCM_PACKING)))-_FCM_PACKING)


    #define offsetofmem(m,s) \
        (FCM::S_Int64)&(((s *)0)->m)

    

    #define BEGIN_INTERFACE_MAP(impl,implVersion) \
            public:  \
            virtual FCM::PIFCMCallback GetCallback()=0; \
            typedef impl _ClassImpl; \
            static FCM::U_Int32 GetVersion(){ return (FCM::U_Int32)implVersion;} \
            static FCM::FCMInterfaceMap* GetInterfaceMap() \
            { static FCM::FCMInterfaceMap _pInterfaceMap [] ={ \
            INTERFACE_ENTRY(IFCMUnknown)
    

    #define BEGIN_MULTI_INTERFACE_MAP(impl,implVersion) \
        public:  \
        virtual FCM::PIFCMCallback GetCallback()=0; \
        typedef impl _ClassImpl; \
        static FCM::U_Int32 GetVersion(){ return (FCM::U_Int32)implVersion;} \
        static FCM::FCMInterfaceMap* GetInterfaceMap() \
        { static FCM::FCMInterfaceMap _pInterfaceMap [] ={
        

    #define INTERFACE_ENTRY(ifx) \
            {IID(ifx),offsetofclass(ifx,_ClassImpl),_FCM_SIMPLEMAPENTRY},


    #define INTERFACE_ENTRY_CUSTOM(ifx,custom) \
            {IID(ifx),offsetofclasscustom(ifx,custom,_ClassImpl),_FCM_SIMPLEMAPENTRY},


    #define INTERFACE_ENTRY_AGGREGATE(ifx, punk)\
    {IID(ifx),offsetofmem(punk,_ClassImpl),_Delegate},

    
    #define END_INTERFACE_MAP \
            {FCM::FCMIID_NULL,0,_FCM_SIMPLEMAPENTRY}}; \
            return _pInterfaceMap;}

    #define BEGIN_MODULE(usrModule) \
            class usrModule : public FCM::FCMPluginModule {


    #define BEGIN_CLASS_ENTRY \
            public: \
            FCM::Result init(FCM::PIFCMCallback pCallback) { FCM::Result res = FCMPluginModule::init(pCallback); 


    #define CLASS_ENTRY(clsid,ursClass)        \
            addClassEntry(clsid,&FCMClassFactory<ursClass>::GetFactory,&ursClass::GetInterfaceMap,ursClass::GetVersion());


    #define END_CLASS_ENTRY return res; }


    #define END_MODULE    };


    #if defined(__GNUC__)
        #ifndef DllExport
            #define DllExport        __attribute__((visibility("default")))
        #endif
    #else
        #ifndef DllExport 
            #define DllExport        __declspec( dllexport )
        #endif
    #endif


    #if defined( __FCM_INTERNAL_PLUGIN__)
        #define FCMPLUGIN_IMP_EXP
    #else 
        #define FCMPLUGIN_IMP_EXP DllExport
    #endif //__FCM_INTERNAL_PLUGIN__

};


/* -------------------------------------------------- Structs / Unions */


/* -------------------------------------------------- Class Decl */


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif //FCM_MACROS_H_