UT_DSOVersion.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_DSOVersion.h ( UT Library, C++)
 *
 * COMMENTS:    This header file defines the version information
 *              for every DSO.
 *
 *              It also specifies the initialization function prototype
 *              HoudiniDSOInit, and the UT_DSOInfo struct that specifies
 *              how a DSO should be initialized.
 */

#ifndef __UT_DSOVersion__
#define __UT_DSOVersion__

#include <SYS/SYS_Types.h>
#include <SYS/SYS_Version.h>
#include <SYS/SYS_Visibility.h>

#define UT_DSO_VERSION  SYS_VERSION_RELEASE

extern "C" {
    class UT_DSOInfo
    {
    public:

        /// Linux only:
        /// Set to true if this DSO should be loaded with RTLD_GLOBAL.
        /// Note that this will mean that your DSO is dlclose()'ed, and then
        /// re-dlopen()'ed.
        /// 
        /// If set to true, then HoudiniDSOInit will be called again after the
        /// DSO is re-openend.  The UT_DSOInfo struct will have its loadGlobal
        /// member set to true.
        ///
        /// @warning If you set loadGlobal to true, make sure to only register
        ///          callbacks inside HoudiniDSOInit() when it is called the
        ///          second time where dsoinfo.loadGlobal is already set to 
        ///          true. Otherwise, Houdini will end up with stale pointers
        ///          to the initial dlclose()'ed instance of your shared DSO.
        ///
        bool loadGlobal;
    };

    SYS_VISIBILITY_EXPORT void HoudiniDSOVersion(const char **version_string);
    SYS_VISIBILITY_EXPORT void HoudiniDSOVersionFull(const char **version_string);
    SYS_VISIBILITY_EXPORT void HoudiniGetTagInfo(const char **version_string);

    /// If your DSO implements this function, it will be called immediately
    /// after the DSO is loaded.
    ///
    /// dsoinfo.loadGlobal will initially be set to false, but see comment above
    ///
    SYS_VISIBILITY_EXPORT void HoudiniDSOInit(UT_DSOInfo& dsoinfo);
}

#ifdef MAKING_DSO

extern "C" SYS_VISIBILITY_EXPORT void
HoudiniDSOVersion(const char **v) { *v = UT_DSO_VERSION; }
extern "C" SYS_VISIBILITY_EXPORT void
HoudiniDSOVersionFull(const char **v) { *v = SYS_VERSION_FULL; }

#ifdef UT_DSO_TAGINFO
extern "C" SYS_VISIBILITY_EXPORT void
HoudiniGetTagInfo(const char **v) { *v = UT_DSO_TAGINFO; }
#endif

#endif // MAKING_DSO

#ifdef MAKING_DSO
#define UT_DSOVERSION_EXPORT extern "C" SYS_VISIBILITY_EXPORT
#else
#define UT_DSOVERSION_EXPORT static inline
#endif

#if defined(__GNUC__)
UT_DSOVERSION_EXPORT unsigned
HoudiniCompilerVersion() { return (__GNUC__ * 100 + __GNUC_MINOR__); }
#elif defined(_MSC_VER)
UT_DSOVERSION_EXPORT unsigned
HoudiniCompilerVersion() { return (_MSC_VER); }
#else
#error Unsupported compiler
#endif

#endif // __UT_DSOVersion__