Carla/source/utils/CarlaLibUtils.hpp

/*
 * Carla library utils
 * Copyright (C) 2011-2013 Filipe Coelho <falktx@falktx.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * For a full copy of the GNU General Public License see the GPL.txt file
 */

#ifndef __CARLA_LIB_UTILS_HPP__
#define __CARLA_LIB_UTILS_HPP__

#include "CarlaUtils.hpp"

#if defined(CARLA_OS_WIN) && ! defined(__WINE__)
# define CARLA_LIB_WINDOWS
#else
# include <dlfcn.h>
#endif

// -------------------------------------------------
// library related calls

static inline
void* lib_open(const char* const filename)
{
    CARLA_ASSERT(filename != nullptr);

#ifdef CARLA_LIB_WINDOWS
    return (void*)LoadLibraryA(filename);
#else
    return dlopen(filename, RTLD_NOW|RTLD_LOCAL);
#endif
}

static inline
bool lib_close(void* const lib)
{
    CARLA_ASSERT(lib != nullptr);

    if (lib == nullptr)
        return false;

#ifdef CARLA_LIB_WINDOWS
    return FreeLibrary((HMODULE)lib);
#else
    return (dlclose(lib) == 0);
#endif
}

static inline
void* lib_symbol(void* const lib, const char* const symbol)
{
    CARLA_ASSERT(lib != nullptr);
    CARLA_ASSERT(symbol != nullptr);

    if (lib == nullptr && symbol == nullptr)
        return nullptr;

#ifdef CARLA_LIB_WINDOWS
    return (void*)GetProcAddress((HMODULE)lib, symbol);
#else
    return dlsym(lib, symbol);
#endif
}

static inline
const char* lib_error(const char* const filename)
{
    CARLA_ASSERT(filename != nullptr);

#ifdef CARLA_LIB_WINDOWS
    static char libError[2048];
    carla_zeroMem(libError, sizeof(char)*2048);

    LPVOID winErrorString;
    DWORD  winErrorCode = GetLastError();
    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr, winErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&winErrorString, 0, nullptr);

    snprintf(libError, 2048, "%s: error code %li: %s", filename, winErrorCode, (const char*)winErrorString);
    LocalFree(winErrorString);

    return libError;
#else
    return dlerror();

    // unused
    (void)filename;
#endif
}

// -------------------------------------------------

#endif // __CARLA_LIB_UTILS_HPP__