checkheaderlibdesync.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

// primary contact: GUAL - secondary contact: NOBODY
#ifndef Navigation_CheckHeaderLibDesync_H
#define Navigation_CheckHeaderLibDesync_H



#include "gwnavruntime/basesystem/version.h"
#include "gwnavruntime/kernel/SF_Std.h"
#include "gwnavruntime/base/types.h"
#include "gwnavruntime/basesystem/versionconfig.inl"

namespace Kaim
{

// Declare a function whose implementation only exists in gwnavruntime library.
void KY_CHECK_MATCHING_VERSION_FUNCTION_NAME();

class CheckHeaderLibDesync
{
public:
    KY_INLINE static void Check()
    {
        // This check that used libraries are in sync with defined macros.
        CheckBuildMode();
        
        // This ensure there's no mismatch between header files and libraries.
        CheckHeaderVsLibraryVersions();
    }


private:
    KY_INLINE static void CheckHeaderVsLibraryVersions()
    {
        KY_CHECK_MATCHING_VERSION_FUNCTION_NAME();
    }


    KY_INLINE static void CheckBuildMode()
    {
#if defined(KY_BUILD_DEBUG)
        Check_DEBUG();
#elif defined(KY_BUILD_RELEASE)
        Check_RELEASE();
#elif defined(KY_BUILD_SHIPPING)
        Check_SHIPPING();
#else
KY_COMPILE_TIME_MESSAGE("Please define KY_BUILD_DEBUG, KY_BUILD_RELEASE or KY_BUILD_SHIPPING, accordingly to the Gameware Navigation libraries you are linking against (debug, release or shipping respectively)");
KY_COMPILER_ASSERT(0);
#endif
    }

    static void Check_DEBUG();     
    static void Check_RELEASE();   
    static void Check_SHIPPING();  
    static KyUInt32 s_dummy;
};

}

#endif