module_loader.h

Go to the documentation of this file.

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

#ifndef MODULE_LOADER_H
#define MODULE_LOADER_H

#include "azure_c_shared_utility/macro_utils.h"
#include "azure_c_shared_utility/umock_c_prod.h"

#include "module.h"
#include "parson.h"

#ifdef __cplusplus
extern "C"
{
#endif

typedef void* MODULE_LIBRARY_HANDLE;

struct MODULE_LOADER_TAG;

typedef struct MODULE_LOADER_BASE_CONFIGURATION_TAG
{
    STRING_HANDLE binding_path;
} MODULE_LOADER_BASE_CONFIGURATION;

typedef MODULE_LIBRARY_HANDLE(*pfModuleLoader_Load)(const struct MODULE_LOADER_TAG* loader, const void* entrypoint);
typedef void(*pfModuleLoader_Unload)(const struct MODULE_LOADER_TAG* loader, MODULE_LIBRARY_HANDLE handle);
typedef const MODULE_API*(*pfModuleLoader_GetApi)(const struct MODULE_LOADER_TAG* loader, MODULE_LIBRARY_HANDLE handle);

typedef void*(*pfModuleLoader_ParseEntrypointFromJson)(const struct MODULE_LOADER_TAG* loader, const JSON_Value* json);
typedef void(*pfModuleLoader_FreeEntrypoint)(const struct MODULE_LOADER_TAG* loader, void* entrypoint);

typedef MODULE_LOADER_BASE_CONFIGURATION*(*pfModuleLoader_ParseConfigurationFromJson)(const struct MODULE_LOADER_TAG* loader, const JSON_Value* json);
typedef void(*pfModuleLoader_FreeConfiguration)(const struct MODULE_LOADER_TAG* loader, MODULE_LOADER_BASE_CONFIGURATION* configuration);

typedef void*(*pfModuleLoader_BuildModuleConfiguration)(const struct MODULE_LOADER_TAG* loader, const void* entrypoint, const void* module_configuration);
typedef void(*pfModuleLoader_FreeModuleConfiguration)(const struct MODULE_LOADER_TAG* loader, const void* module_configuration);

typedef struct MODULE_LOADER_API_TAG
{
    pfModuleLoader_Load Load;

    pfModuleLoader_Unload Unload;

    pfModuleLoader_GetApi GetApi;

    pfModuleLoader_ParseEntrypointFromJson ParseEntrypointFromJson;
    pfModuleLoader_FreeEntrypoint FreeEntrypoint;

    pfModuleLoader_ParseConfigurationFromJson ParseConfigurationFromJson;
    pfModuleLoader_FreeConfiguration FreeConfiguration;

    pfModuleLoader_BuildModuleConfiguration BuildModuleConfiguration;
    pfModuleLoader_FreeModuleConfiguration FreeModuleConfiguration;
} MODULE_LOADER_API;

#define MODULE_LOADER_TYPE_VALUES \
    UNKNOWN,    \
    NATIVE,     \
    JAVA,       \
    DOTNET,     \
    DOTNETCORE, \
    NODEJS,     \
    OUTPROCESS     

DEFINE_ENUM(MODULE_LOADER_TYPE, MODULE_LOADER_TYPE_VALUES);


typedef struct MODULE_LOADER_TAG
{
    MODULE_LOADER_TYPE                  type;

    const char*                         name;

    MODULE_LOADER_BASE_CONFIGURATION*   configuration;

    MODULE_LOADER_API*                  api;
} MODULE_LOADER;

#define MODULE_LOADER_RESULT_VALUES \
    MODULE_LOADER_SUCCESS, \
    MODULE_LOADER_ERROR

DEFINE_ENUM(MODULE_LOADER_RESULT, MODULE_LOADER_RESULT_VALUES);

MOCKABLE_FUNCTION(, MODULE_LOADER_RESULT, ModuleLoader_ParseBaseConfigurationFromJson,
    MODULE_LOADER_BASE_CONFIGURATION*, configuration,
    const JSON_Value*, json
);

MOCKABLE_FUNCTION(, void, ModuleLoader_FreeBaseConfiguration, MODULE_LOADER_BASE_CONFIGURATION*, configuration);

MOCKABLE_FUNCTION(, MODULE_LOADER_RESULT, ModuleLoader_Initialize);

MOCKABLE_FUNCTION(, void, ModuleLoader_Destroy);

MOCKABLE_FUNCTION(, MODULE_LOADER_RESULT, ModuleLoader_Add, const MODULE_LOADER*, loader);

MOCKABLE_FUNCTION(, MODULE_LOADER_RESULT, ModuleLoader_UpdateConfiguration,
    MODULE_LOADER*, loader,
    MODULE_LOADER_BASE_CONFIGURATION*, configuration
);

MOCKABLE_FUNCTION(, MODULE_LOADER*, ModuleLoader_FindByName, const char*, name);

MOCKABLE_FUNCTION(, MODULE_LOADER*, ModuleLoader_GetDefaultLoaderForType, MODULE_LOADER_TYPE, type);

MOCKABLE_FUNCTION(, MODULE_LOADER_TYPE, ModuleLoader_ParseType, const char*, type);

MOCKABLE_FUNCTION(, bool, ModuleLoader_IsDefaultLoader, const char*, name);

MOCKABLE_FUNCTION(, MODULE_LOADER_RESULT, ModuleLoader_InitializeFromJson, const JSON_Value*, loaders);

#ifdef __cplusplus
}
#endif

#endif // MODULE_LOADER_H