Класс QLibrary

Класс QLibrary загружает динамические библиотеки во время выполнения. Подробнее...

• Список всех членов, включая наследуемые

Примечание: Все функции в этом классе являются реентерабельными.

Открытые типы

Свойства

• fileName : QString
• loadHints : LoadHints

Открытые функции

Статические открытые члены

Подробное описание

Экземпляр объекта QLibrary работает с одним файлом динамической библиотеки (который мы называем "библиотекой", но также известен как "DLL"). QLibrary предоставляет независимый от платформы доступ к функциональности библиотеки. Вы можете либо передать имя файла в конструктор, либо установить его явно с помощью setFileName(). При загрузке библиотеки QLibrary ищет во всех системных расположениях библиотек (например, LD_LIBRARY_PATH в Unix), если имя файла не содержит абсолютный путь.

Если имя файла содержит абсолютный путь, то сначала будет сделана попытка загрузить по этому пути. Если файл не найден, QLibrary пытается загрузить его с различными системными префиксами и суффиксами, такими как "lib" в Unix и macOS, ".so" в Unix, ".dylib" в macOS или ".dll" в Windows.

Если путь к файлу не абсолютный, то QLibrary изменяет порядок поиска, сначала пытаясь найти библиотеку с системными префиксами и суффиксами, а затем с заданным именем файла.

Это позволяет указывать динамические библиотеки, идентифицируемые только по своему имени без суффикса, что позволяет одному и тому же коду работать на разных операционных системах, при этом минимизируя попытки найти библиотеку.

Самые важные функции — load() для динамической загрузки файла библиотеки, isLoaded() для проверки успешности загрузки и resolve() для разрешения символа в библиотеке. Функция resolve() неявно пытается загрузить библиотеку, если она еще не загружена. Несколько экземпляров QLibrary могут использоваться для доступа к одной и той же физической библиотеке. После загрузки библиотеки она остается в памяти до завершения приложения. Вы можете попытаться разгрузить библиотеку с помощью unload(), но если другие экземпляры QLibrary используют ту же библиотеку, вызов завершится неудачей, и разгрузка произойдёт только тогда, когда все экземпляры вызовут unload().

Типичное использование QLibrary заключается в разрешении экспортированного символа в библиотеке и вызове C-функции, которую этот символ представляет. Это называется "явным связыванием" в отличие от "неявного связывания", которое выполняется этапом компоновки при компоновке исполняемого файла с библиотекой.

Следующий фрагмент кода загружает библиотеку, разрешает символ "mysymbol" и вызывает функцию, если все прошло успешно. Если возникнет ошибка, например, файл библиотеки не существует или символ не определён, указатель на функцию будет nullptr и не будет вызван.

QLibrary myLib("mylib");
typedef void (*MyPrototype)();
MyPrototype myFunction = (MyPrototype) myLib.resolve("mysymbol");
if (myFunction)
    myFunction();

Символ должен быть экспортирован как C-функция из библиотеки для работы resolve(). Это означает, что функция должна быть обернута в extern "C" блок, если библиотека скомпилирована с помощью компилятора C++. В Windows для этого также требуется использование макроса dllexport; см. resolve() для получения подробностей о том, как это делается. Для удобства существует статическая функция resolve(), которую можно использовать, если вы просто хотите вызвать функцию в библиотеке, не загружая явно библиотеку:

typedef void (*MyPrototype)();
MyPrototype myFunction =
        (MyPrototype) QLibrary::resolve("mylib", "mysymbol");
if (myFunction)
    myFunction();

См. также QPluginLoader.

Документация по типам членов

перечисление QLibrary::LoadHintфлаги QLibrary::LoadHints

Это перечисление описывает возможные подсказки, которые могут использоваться для изменения обработки библиотек при их загрузке. Эти значения указывают, как разрешаются символы при загрузке библиотек, и задаются с помощью функции setLoadHints().

Тип LoadHints — это псевдоним для QFlags<LoadHint>. Он хранит логическое ИЛИ комбинацию значений LoadHint.

См. также loadHints.

Документация по функциям-членам

QLibrary::QLibrary(const QString &fileName, const QString &version, QObject *parent = nullptr)

Создаёт объект библиотеки с заданным parent, который загрузит библиотеку, указанную fileName и полным номером версии version. В настоящее время номер версии игнорируется в Windows.

Рекомендуется опускать расширение файла в fileName, так как QLibrary автоматически будет искать файл с соответствующим расширением в соответствии с платформой, например, ".so" на Unix, ".dylib" на macOS и iOS, и ".dll" на Windows. (См. fileName.)

QLibrary::QLibrary(const QString &fileName, int verNum, QObject *parent = nullptr)

Создаёт объект библиотеки с заданным parent, который загрузит библиотеку, указанную fileName и номер версии verNum. В настоящее время номер версии игнорируется в Windows.

Рекомендуется опускать расширение файла в fileName, так как QLibrary автоматически будет искать файл с соответствующим расширением в соответствии с платформой, например, ".so" на Unix, ".dylib" на macOS и iOS, и ".dll" на Windows. (См. fileName.)

QLibrary::QLibrary(const QString &fileName, QObject *parent = nullptr)

Создаёт объект библиотеки с заданным parent, который загрузит библиотеку, указанную fileName.

Рекомендуется опускать расширение файла в fileName, так как QLibrary автоматически будет искать файл с соответствующим расширением в соответствии с платформой, например, ".so" на Unix, ".dylib" на macOS и iOS, и ".dll" на Windows. (См. fileName.)

QLibrary::QLibrary(QObject *parent = nullptr)

Создаёт библиотеку с заданным parent.

[virtual] QLibrary::~QLibrary()

Уничтожает объект QLibrary.

Если явно не был вызван unload(), библиотека остаётся в памяти до завершения приложения.

См. также isLoaded() и unload().

QString QLibrary::errorString() const

Возвращает строку текста с описанием последней произошедшей ошибки. В настоящее время errorString будет установлен только в том случае, если load(), unload() или resolve() по какой-либо причине завершились неудачно.

[static] bool QLibrary::isLibrary(const QString &fileName)

Возвращает true если fileName имеет правильное расширение для загружаемой библиотеки, в противном случае возвращает false.

Конечные номера версий на Unix игнорируются.

bool QLibrary::isLoaded() const

Возвращает true если библиотека загружена, в противном случае возвращает false.

См. также load().

bool QLibrary::load()

Загружает библиотеку и возвращает true если библиотека была загружена успешно, в противном случае возвращает false. Поскольку resolve() всегда вызывает эту функцию перед разрешением каких-либо символов, нет необходимости вызывать её явно. В некоторых ситуациях вам может потребоваться загрузить библиотеку заранее, в этом случае вы используете эту функцию.

См. также unload().

QFunctionPointer QLibrary::resolve(const char *symbol)

Возвращает адрес экспортированного символа symbol. Библиотека загружается при необходимости. Функция возвращает nullptr если символ не может быть разрешён или если библиотека не может быть загружена.

Пример:

typedef int (*AvgFunction)(int, int);

AvgFunction avg = (AvgFunction) library->resolve("avg");
if (avg)
    return avg(5, 8);
else
    return -1;

Символ должен быть экспортирован как C-функция из библиотеки. Это означает, что функция должна быть обернута в extern "C" если библиотека скомпилирована с помощью C++-компилятора. В Windows вы также должны явно экспортировать функцию из DLL, используя директиву компилятора __declspec(dllexport), например:

extern "C" MY_EXPORT int avg(int a, int b)
{
    return (a + b) / 2;
}

где MY_EXPORT определено как

#ifdef Q_OS_WIN
#define MY_EXPORT __declspec(dllexport)
#else
#define MY_EXPORT
#endif

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, const char *symbol)

Это перегруженная функция.

Загружает библиотеку fileName и возвращает адрес экспортированного символа symbol. Обратите внимание, что fileName не должна содержать платформоспецифическое расширение файла; (см. fileName). Библиотека остаётся загруженной до выхода приложения.

Функция возвращает nullptr если символ не может быть разрешён или если библиотека не может быть загружена.

См. также resolve().

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, int verNum, const char *symbol)

Это перегруженная функция.

Загружает библиотеку fileName с номером основной версии verNum и возвращает адрес экспортированного символа symbol. Обратите внимание, что fileName не должна содержать платформоспецифическое расширение файла; (см. fileName). Библиотека остаётся загруженной до выхода приложения. verNum игнорируется в Windows.

Функция возвращает nullptr если символ не удалось разрешить или библиотеку не удалось загрузить.

См. также resolve().

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, const QString &version, const char *symbol)

Это перегруженная функция.

Загружает библиотеку fileName с полным номером версии version и возвращает адрес экспортированного символа symbol. Обратите внимание, что fileName не должно включать платформоспецифическое расширение файла; (см. fileName). Библиотека остается загруженной до завершения работы приложения. version игнорируется в Windows.

Функция возвращает nullptr если символ не удалось разрешить или библиотеку не удалось загрузить.

См. также resolve().

void QLibrary::setFileNameAndVersion(const QString &fileName, int versionNumber)

Устанавливает свойство fileName и номер основной версии соответственно на fileName и versionNumber. versionNumber игнорируется в Windows.

См. также setFileName().

void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &version)

Устанавливает свойство fileName и полный номер версии соответственно на fileName и version. Параметр version игнорируется в Windows.

См. также setFileName().

bool QLibrary::unload()

Выгружает библиотеку и возвращает true если библиотеку удалось выгрузить; в противном случае возвращает false.

Это происходит автоматически при завершении работы приложения, поэтому обычно вызывать эту функцию не нужно.

Если другие экземпляры QLibrary используют ту же библиотеку, вызов завершится неудачей, и выгрузка произойдёт только тогда, когда каждый экземпляр вызовет unload().

Обратите внимание, что на Mac OS X 10.3 (Panther) динамические библиотеки нельзя выгрузить.

См. также resolve() и load().