checkheaderlibdesync.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once



#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_CONFIG_DEBUG)
        Check_DEBUG();
    #elif defined(KY_CONFIG_DEV)
        Check_DEV();
    #elif defined(KY_CONFIG_RELEASE)
        Check_RELEASE();
    #else
        static_assert(0, "Please define KY_CONFIG_DEBUG, KY_CONFIG_DEV or KY_CONFIG_RELEASE, accordingly to the Autodesk Navigation libraries you are linking against (debug, dev or release respectively)");
    #endif
    }

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

}