Класс QLibrary

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

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

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

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

Свойства

• fileName : QString
• loadHints : LoadHints

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

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

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

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

Если имя файла является абсолютным путём, то сначала производится попытка загрузить по этому пути. Если файл не найден, QLibrary пытается загрузить его с использованием различных платформ-специфических префиксов и суффиксов, таких как «lib» в Unix и Mac, и «.so» в Unix, «.dylib» в Mac или «.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() по какой-либо причине завершится неудачно.

Эта функция была добавлена в Qt 4.2.

[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 в случае, если символ не удалось разрешить или библиотеку не удалось загрузить.

Функция была добавлена в Qt 4.4.

См. также 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.

Функция была добавлена в Qt 4.4.

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

bool QLibrary::unload()

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

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

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

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

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