Test ABI cookie for all plugins

Author: darksylinc

OgreMain/include/OgrePlugin.h

@@ -38,6 +38,9 @@ namespace Ogre
     /** \addtogroup General
      *  @{
      */
+
+    struct AbiCookie;
+
     /** Class defining a generic OGRE plugin.
     @remarks
         OGRE is very plugin-oriented and you can customise much of its behaviour
@@ -128,6 +131,9 @@ namespace Ogre
         should have been sorted out in the 'shutdown' method.
         */
         virtual void uninstall() = 0;
+
+        /// Outputs an ABI cookie generated by generateAbiCookie
+        virtual void getAbiCookie( AbiCookie &outAbiCookie ) = 0;
     };
     /** @} */
     /** @} */

OgreMain/src/OgreRoot.cpp

@@ -150,7 +150,6 @@ namespace Ogre
         mIsBlendIndicesGpuRedundant( true ),
         mIsBlendWeightsGpuRedundant( true )
     {
-
         // superclass will do singleton checking
         String msg;
 
@@ -1416,16 +1415,26 @@ namespace Ogre
     {
         LogManager::getSingleton().logMessage( "Installing plugin: " + plugin->getName() );
 
-        mPlugins.push_back( plugin );
-        plugin->install();
+        AbiCookie abiCookie;
+        plugin->getAbiCookie( abiCookie );
 
-        // if rendersystem is already initialised, call rendersystem init too
-        if( mIsInitialised )
+        if( testAbiCookie( abiCookie, false ) )
         {
-            plugin->initialise();
-        }
+            mPlugins.push_back( plugin );
+            plugin->install();
+
+            // if rendersystem is already initialised, call rendersystem init too
+            if( mIsInitialised )
+            {
+                plugin->initialise();
+            }
 
-        LogManager::getSingleton().logMessage( "Plugin successfully installed" );
+            LogManager::getSingleton().logMessage( "Plugin successfully installed" );
+        }
+        else
+        {
+            LogManager::getSingleton().logMessage( "Plugin failed ABI test" );
+        }
     }
     //---------------------------------------------------------------------
     void Root::uninstallPlugin( Plugin *plugin )

PlugIns/ParticleFX/include/OgreParticleFXPlugin.h

@@ -55,6 +55,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         vector<ParticleEmitterFactory *>::type  mEmitterFactories;
         vector<ParticleAffectorFactory *>::type mAffectorFactories;

PlugIns/ParticleFX/src/OgreParticleFXPlugin.cpp

@@ -28,6 +28,7 @@ THE SOFTWARE.
 
 #include "OgreParticleFXPlugin.h"
 
+#include "OgreAbiUtils.h"
 #include "OgreParticleSystemManager.h"
 #include "OgreRoot.h"
 
@@ -112,7 +113,6 @@ namespace Ogre
         pAffFact = OGRE_NEW ColourImageAffectorFactory();
         ParticleSystemManager::getSingleton().addAffectorFactory( pAffFact );
         mAffectorFactories.push_back( pAffFact );
-
         // ColourInterpolatorAffector
         pAffFact = OGRE_NEW ColourInterpolatorAffectorFactory();
         ParticleSystemManager::getSingleton().addAffectorFactory( pAffFact );
@@ -165,5 +165,10 @@ namespace Ogre
             OGRE_DELETE( *ai );
         }
     }
+    //---------------------------------------------------------------------
+    void ParticleFXPlugin::getAbiCookie( AbiCookie &outAbiCookie )
+    {
+        outAbiCookie = generateAbiCookie();
+    }
 
 }  // namespace Ogre

RenderSystems/Direct3D11/include/OgreD3D11Plugin.h

@@ -54,6 +54,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         D3D11RenderSystem *mRenderSystem;
     };

RenderSystems/Direct3D11/src/OgreD3D11Plugin.cpp

@@ -27,6 +27,7 @@ THE SOFTWARE.
 */
 #include "OgreD3D11Plugin.h"
 
+#include "OgreAbiUtils.h"
 #include "OgreRoot.h"
 
 namespace Ogre
@@ -60,5 +61,6 @@ namespace Ogre
         delete mRenderSystem;
         mRenderSystem = 0;
     }
-
+    //---------------------------------------------------------------------
+    void D3D11Plugin::getAbiCookie( AbiCookie &outAbiCookie ) { outAbiCookie = generateAbiCookie(); }
 }  // namespace Ogre

RenderSystems/GL3Plus/include/OgreGL3PlusPlugin.h

@@ -54,6 +54,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         GL3PlusRenderSystem *mRenderSystem;
     };

RenderSystems/GL3Plus/src/OgreGL3PlusPlugin.cpp

@@ -27,6 +27,8 @@ Copyright (c) 2000-2014 Torus Knot Software Ltd
 */
 
 #include "OgreGL3PlusPlugin.h"
+
+#include "OgreAbiUtils.h"
 #include "OgreRoot.h"
 
 namespace Ogre
@@ -59,5 +61,6 @@ namespace Ogre
         OGRE_DELETE mRenderSystem;
         mRenderSystem = 0;
     }
-
+    //---------------------------------------------------------------------
+    void GL3PlusPlugin::getAbiCookie( AbiCookie &outAbiCookie ) { outAbiCookie = generateAbiCookie(); }
 }  // namespace Ogre

RenderSystems/Metal/include/OgreMetalPlugin.h

@@ -57,6 +57,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         MetalRenderSystem *mRenderSystem;
     };

RenderSystems/Metal/src/OgreMetalPlugin.mm

@@ -28,6 +28,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 #include "OgreMetalPlugin.h"
 
+#include "OgreAbiUtils.h"
 #include "OgreMetalRenderSystem.h"
 #include "OgreRoot.h"
 
@@ -65,4 +66,6 @@ of this software and associated documentation files (the "Software"), to deal
         OGRE_DELETE mRenderSystem;
         mRenderSystem = 0;
     }
+    //---------------------------------------------------------------------
+    void MetalPlugin::getAbiCookie( AbiCookie &outAbiCookie ) { outAbiCookie = generateAbiCookie(); }
 }

RenderSystems/NULL/include/OgreNULLPlugin.h

@@ -55,6 +55,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         NULLRenderSystem *mRenderSystem;
     };

RenderSystems/NULL/src/OgreNULLPlugin.cpp

@@ -28,6 +28,7 @@ Copyright (c) 2000-2014 Torus Knot Software Ltd
 
 #include "OgreNULLPlugin.h"
 
+#include "OgreAbiUtils.h"
 #include "OgreRoot.h"
 
 namespace Ogre
@@ -60,4 +61,6 @@ namespace Ogre
         OGRE_DELETE mRenderSystem;
         mRenderSystem = 0;
     }
+    //---------------------------------------------------------------------
+    void NULLPlugin::getAbiCookie( AbiCookie &outAbiCookie ) { outAbiCookie = generateAbiCookie(); }
 }  // namespace Ogre

RenderSystems/Vulkan/include/OgreVulkanPlugin.h

@@ -34,7 +34,7 @@ THE SOFTWARE.
 namespace Ogre
 {
     /** Plugin instance for Vulkan Manager */
-    class VulkanPlugin final : public Plugin
+    class _OgreVulkanExport VulkanPlugin final : public Plugin
     {
     public:
         VulkanPlugin();
@@ -54,6 +54,9 @@ namespace Ogre
         /// @copydoc Plugin::uninstall
         void uninstall() override;
 
+        /// @copydoc Plugin::getAbiCookie
+        void getAbiCookie( AbiCookie &outAbiCookie ) override;
+
     protected:
         VulkanRenderSystem *mRenderSystem;
     };

RenderSystems/Vulkan/src/OgreVulkanPlugin.cpp

@@ -27,6 +27,8 @@ Copyright (c) 2000-2014 Torus Knot Software Ltd
 */
 
 #include "OgreVulkanPlugin.h"
+
+#include "OgreAbiUtils.h"
 #include "OgreRoot.h"
 
 namespace Ogre
@@ -59,4 +61,6 @@ namespace Ogre
         OGRE_DELETE mRenderSystem;
         mRenderSystem = 0;
     }
+    //---------------------------------------------------------------------
+    void VulkanPlugin::getAbiCookie( AbiCookie &outAbiCookie ) { outAbiCookie = generateAbiCookie(); }
 }  // namespace Ogre