utility/src/utility/module.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
#pragma once
 
// Local includes
#include "dllexport.h"
 
// External includes
#include <string>
 
namespace nap
{
    constexpr int moduleAPIVersion = 1;                     
    constexpr const char* moduleCoreName = "napcore";       
 
    struct ModuleDescriptor
    {
        int         mAPIVersion;    // The version of the module API this module was built against. Must be the first member.
        const char* mID;            // The ID (name) of the module
        const char* mVersion;       // The version of the module
        const char* mService;       // The service associated with the module
    };
 
    inline std::string getModuleDescriptorSymbolName(const std::string& moduleName) { return moduleName + "_mod_descriptor"; }
}
 
 
// Macros
 
#ifdef NAP_SHARED_LIBRARY
    // Module descriptor helper macros
    #define NAP_MODULE_CONCAT(x,y) x ## y
    #define NAP_MODULE_UNIQUE_NAME(x,y)  NAP_MODULE_CONCAT(x,y)
    #define NAP_MODULE_ADD_NS(x) nap::x
 
    // Module descriptor symbol name without namespace
    #define NAP_MODULE_SYMBOL_NAME NAP_MODULE_UNIQUE_NAME(MODULE_NAME, _mod_descriptor)
 
    // Module descriptor handle (pointer) with namespace
    #define NAP_MODULE_DESCIPTOR_HANDLE &NAP_MODULE_ADD_NS(NAP_MODULE_SYMBOL_NAME)
#else
    #define NAP_MODULE_DESCIPTOR_HANDLE nullptr
#endif // NAP_SHARED_LIBRARY
 
namespace nap
{
    #define NAP_MODULE(moduleID, moduleVersion)                                         \
        extern "C"                                                                      \
        {                                                                               \
            NAPAPI nap::ModuleDescriptor NAP_MODULE_SYMBOL_NAME =                       \
            {                                                                           \
                nap::moduleAPIVersion,                                                  \
                moduleID,                                                               \
                moduleVersion,                                                          \
                nullptr                                                                 \
            };                                                                          \
        }
 
    #define NAP_SERVICE_MODULE(moduleID, moduleVersion, moduleService)                      \
            extern "C"                                                                      \
            {                                                                               \
                NAPAPI nap::ModuleDescriptor NAP_MODULE_SYMBOL_NAME =                       \
                {                                                                           \
                    nap::moduleAPIVersion,                                                  \
                    moduleID,                                                               \
                    moduleVersion,                                                          \
                    moduleService                                                           \
                };                                                                          \
            }
 
    extern "C" 
    {
    #ifdef NAP_MODULE_SYMBOL_NAME
        extern nap::ModuleDescriptor NAP_MODULE_SYMBOL_NAME;
    #endif // NAP_MODULE_DECLARATION
    }
}