1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 24 апр. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_IPC_LIBRARY_H_
#define LSP_PLUG_IN_IPC_LIBRARY_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/io/Path.h>
#if defined(PLATFORM_WINDOWS)
#include <libloaderapi.h>
#else
#include <dlfcn.h>
#endif /* PLATFORM_WINDOWS */
namespace lsp
{
namespace ipc
{
/**
* Class for loading dynamic libraries
*/
class Library
{
private:
#ifdef PLATFORM_WINDOWS
HMODULE hDlSym;
#else
void *hDlSym;
#endif
status_t nLastError;
static int hTag;
private:
Library & operator = (const Library &);
public:
explicit Library();
~Library();
public:
/**
* Check that library is opened
* @return true if library is opened
*/
inline bool id_opened() const { return hDlSym != NULL; }
/**
* Return last error
* @return last error
*/
inline status_t last_error() const { return nLastError; }
/**
* Load library at specified path
* @param path UTF-8 path
* @return status of operation
*/
status_t open(const char *path);
/**
* Load library at specified path
* @param path path
* @return status of operation
*/
status_t open(const LSPString *path);
/**
* Load library at specified path
* @param path UTF-8 path
* @return status of operation
*/
status_t open(const io::Path *path);
/**
* Import symbol from library
* @param name symbol name
*/
void *import(const char *name);
/**
* Import symbol from library
* @param name symbol name
*/
void *import(const LSPString *name);
/**
* Unload loaded library
* @return status of operation
*/
status_t close();
/**
* Swap contents with another library handle
* @param dst target library handle to perform swap
*/
void swap(Library *dst);
/**
* Get path to the module by the specified address
* @param path variable to store path to the module
* @param ptr specified address
* @return status of operation
*/
static status_t get_module_file(LSPString *path, const void *ptr);
/**
* Get path to the module by the specified address
* @param path variable to store path to the module
* @param ptr specified address
* @return status of operation
*/
static status_t get_module_file(io::Path *path, const void *ptr);
/**
* Get path to the current module
* @param path variable to store path to the current module
* @return status of operation
*/
static inline status_t get_self_file(LSPString *path) { return get_module_file(path, &hTag); };
/**
* Get path to the current module
* @param path variable to store path to the current module
* @return status of operation
*/
static inline status_t get_self_file(io::Path *path) { return get_module_file(path, &hTag); };
/**
* Check that library file name is valid
* @param path UTF-8 path
* @return true if library file name is valid
*/
static bool valid_library_name(const char *path);
/**
* Check that library file name is valid
* @param path UTF-8 path
* @return true if library file name is valid
*/
static bool valid_library_name(const LSPString *path);
/**
* Check that library file name is valid
* @param path UTF-8 path
* @return true if library file name is valid
*/
static bool valid_library_name(const io::Path *path);
};
} /* namespace io */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IPC_LIBRARY_H_ */
|