Создание серверов ActiveX в Qt

Модуль QAxServer является частью фреймворка ActiveQt. Он состоит из трёх классов:

• QAxFactory определяет фабрику для создания объектов COM.
• QAxBindable предоставляет интерфейс между виджетом Qt и объектом COM.
• QAxAggregated можно наследовать для реализации дополнительных интерфейсов COM.

Предоставляются некоторые примеры реализации ActiveX-контролов и объектов COM.

Разделы:

Использование библиотеки

Чтобы преобразовать стандартное приложение Qt в COM-сервер, используя библиотеку QAxServer, необходимо добавить axserver в переменную QT в вашем файле .pro.

Сервер исполняемого файла вне процесса генерируется из файла .pro, примерно так:

TEMPLATE = app
QT  += axserver

RC_FILE  = qaxserver.rc
...

Для создания сервера в процессе используйте файл .pro примерно так:

TEMPLATE = lib
QT += axserver
CONFIG  += dll

DEF_FILE = qaxserver.def
RC_FILE  = qaxserver.rc
...

Файлы qaxserver.rc и qaxserver.def являются частью фреймворка и могут использоваться из их обычного расположения (указать путь в файле .pro), или скопированы в каталог проекта. Вы можете изменять эти файлы, пока в них указан файл как запись типа библиотеки, то есть вы можете добавить информацию о версии или указать другой значок инструментария.

Использование модуля axserver заставит инструмент qmake добавить необходимые этапы сборки в систему сборки:

• Связать двоичный файл с qaxserver.lib вместо qtmain.lib
• Вызвать инструмент idc для генерации файла IDL для COM-сервера
• Скомпилировать IDL в библиотеку типов с помощью инструмента MIDL (часть установки компилятора)
• Присоединить полученную библиотеку типов в качестве двоичного ресурса к двоичному файлу сервера (снова с помощью инструмента idc)
• Зарегистрировать сервер. Этот шаг может потребовать прав администратора и может быть пропущен, установив конфигурацию qaxserver_no_register.

Чтобы пропустить этап пост-обработки, также установите конфигурацию qaxserver_no_postlink.

Кроме того, вы можете указать номер версии, используя переменную VERSION, например:

TEMPLATE = lib
VERSION = 2.5
...

Указанный номер версии будет использоваться как версия библиотеки типов и сервера при регистрации.

Серверы вне процесса против серверов в процессе

То, будет ли ваш COM-сервер работать как автономный исполняемый файл или как общая библиотека в процессе клиента, в основном зависит от типа COM-объектов, которые вы хотите предоставить на сервере.

Сервер исполняемого файла имеет преимущество в том, что может работать как автономное приложение, но добавляет значительную нагрузку на связь между COM-клиентом и COM-объектом. Если у управления есть ошибка программирования, только процесс сервера, запускающий управление, аварийно завершит работу, и приложение клиента, вероятно, продолжит работать. Не все COM-клиенты поддерживают серверы исполняемого файла.

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

Оба типа серверов могут использовать Qt как общую библиотеку или статически связать ее с двоичным файлом сервера.

Типичные ошибки во время этапов пост-сборки

Для работы ActiveQt-специфичных этапов пост-обработки сервер должен соответствовать некоторым требованиям:

• Все экспонируемые элементы управления можно создавать, имея только экземпляр QApplication
• Первоначальная компоновка сервера включает временный ресурс библиотеки типов
• Все зависимости, необходимые для работы сервера, находятся в системном пути (или в пути, используемом вызывающей средой; обратите внимание, что Visual Studio имеет свой собственный набор переменных среды, перечисленных в диалоговом окне Инструменты | Параметры | Каталоги).

Если эти требования не соблюдены, может возникнуть одна или несколько из следующих ошибок:

Исполняемый файл сервера аварийно завершает работу

Для генерации IDL элементы управления, экспонированные как ActiveX-контролы, должны быть созданы (вызывается конструктор). В этот момент ничего, кроме объекта QApplication, не существует. Конструктор вашего виджета не должен полагаться на создание других объектов, например, он должен проверять указатели на нуль.

Для отладки сервера запустите его с параметром -dumpidl outputfile и проверьте, где он аварийно завершает работу.

Обратите внимание, что никакие функции управления не вызываются.

Исполняемый файл сервера не является допустимым приложением Win32

Присоединение библиотеки типов повредило двоичный файл сервера. Это ошибка в Windows и возникает только при сборке релизной версии.

Первый шаг компоновки должен связать фиктивную библиотеку типов в исполняемый файл, который затем можно заменить с помощью idc. Добавьте файл ресурсов с библиотекой типов в свой проект, как показано в примерах.

"Не удается найти DLL"

Система сборки должна запустить исполняемый файл сервера для генерации определения интерфейса и регистрации сервера. Если динамическая библиотека, с которой связан сервер, не находится в пути, это может завершиться неудачей (например, Visual Studio вызывает сервер, используя параметры среды, указанные в параметре "Каталоги"). Убедитесь, что все DLL и плагины, необходимые для работы сервера, находятся в каталоге, указанном в пути, как указано в сообщении об ошибке (см. также Инструмент развертывания Windows).

"Не удается открыть файл ..."

Сервер ActiveX не смог корректно завершить работу, когда последний клиент перестал его использовать. Обычно для завершения приложения требуется около двух секунд, но вам может потребоваться использовать диспетчер задач для завершения процесса (например, когда клиент не освобождает элементы управления должным образом).

Элемент управления нельзя создать

В этом случае может помочь зарегистрировать сервер от имени администратора.

Реализация элементов управления

Для реализации COM-объекта с Qt создайте подкласс QObject или любого существующего подкласса QObject. Если класс является подклассом QWidget, COM-объект будет ActiveX-контролом.

#include <QWidget>

class MyActiveX : public QWidget
{
    Q_OBJECT

Макрос Q_OBJECT необходим для предоставления метаобъектной информации о виджете фреймворку ActiveQt.

Q_CLASSINFO("ClassID", "{1D9928BD-4453-4bdd-903D-E525ED17FDE5}")
Q_CLASSINFO("InterfaceID", "{99F6860E-2C5A-42ec-87F2-43396F4BE389}")
Q_CLASSINFO("EventsID", "{0A3E9F27-E4F1-45bb-9E47-63099BCCD0E3}")

Используйте макрос Q_CLASSINFO() для указания идентификаторов COM для COM-объекта. ClassID и InterfaceID необходимы, а EventsID необходим только тогда, когда ваш объект имеет сигналы. Для генерации этих идентификаторов используйте системные инструменты, такие как uuidgen или guidgen.

Вы можете указать дополнительные атрибуты для каждого из ваших классов; см. Сведения о классе и настройка для получения подробностей.

Q_PROPERTY(int value READ value WRITE setValue)

Используйте макрос Q_PROPERTY(), чтобы объявить свойства для ActiveX-контрола.

Объявите стандартный конструктор, принимающий объект родителя, и функции, сигналы и слоты, как для любого подкласса QObject.

public:
    MyActiveX(QWidget *parent = 0)
    ...

    int value() const;

public slots:
    void setValue(int v);
    ...

signals:
    void valueChange(int v);
    ...

};

Фреймворк ActiveQt будет экспонировать свойства и публичные слоты как ActiveX-свойства и методы, а сигналы — как ActiveX-события и преобразовывать между типами данных Qt и эквивалентными типами данных COM.

Типы данных

Типы данных Qt, которые поддерживаются для свойств:

Типы данных Qt, которые поддерживаются для параметров в сигналах и слотах:

Также поддерживаются экспортируемые перечисления и флаги (см. Q_ENUMS() и Q_FLAGS()). Типы параметров in также поддерживаются в качестве возвращаемых значений.

Свойства и сигналы/слоты, имеющие параметры других типов данных, игнорируются фреймворком ActiveQt.

Подобъекты

Объекты COM могут иметь несколько подобъектов, которые могут представлять подэлемент объекта COM. Например, объект COM, представляющий приложение с несколькими документами и электронной таблицей, может предоставлять один подобъект для каждой электронной таблицы.

Любой подкласс QObject может использоваться в качестве типа подобъекта в ActiveX, если он известен QAxFactory. Затем тип может быть использован в свойствах или в качестве возвращаемого типа или параметра слота.

Уведомление о свойстве

Чтобы сделать свойства привязываемыми для клиента ActiveX, используйте множественное наследование от класса QAxBindable:

#include <QAxBindable>
#include <QWidget>

class MyActiveX : public QWidget, public QAxBindable
{
    Q_OBJECT

При реализации функций записи свойств используйте функции класса QAxBindable requestPropertyChange() и propertyChanged(), чтобы разрешить клиентам ActiveX привязку к свойствам управления.

Обслуживание элементов управления

Чтобы сделать сервер COM доступным для системы COM, он должен быть зарегистрирован в системном реестре с использованием пяти уникальных идентификаторов. Эти идентификаторы предоставляются инструментами, такими как guidgen или uuidgen. Информация о регистрации позволяет COM локализовать двоичный файл, предоставляющий запрашиваемый ActiveX-элемент управления, передавать удаленные вызовы процедур элементу управления и читать информацию о типах методов и свойств, предоставляемых элементом управления.

Для создания объекта COM при запросе клиентом сервер должен экспортировать реализацию QAxFactory. Самый простой способ сделать это — использовать набор макросов:

QAXFACTORY_BEGIN("{ad90301a-849e-4e8b-9a91-0a6dc5f6461f}",
                 "{a8f21901-7ff7-4f6a-b939-789620c03d83}")
    QAXCLASS(MyWidget)
    QAXCLASS(MyWidget2)
    QAXTYPE(MySubType)
QAXFACTORY_END()

Это экспортирует MyWidget и MyWidget2 как объекты COM, которые могут быть созданы клиентами COM, и зарегистрирует MySubType как тип, который может быть использован в свойствах и параметрах MyWidget и MyWidget2.

Документация класса QAxFactory объясняет, как использовать этот макрос, а также как реализовать и использовать пользовательские фабрики.

Для серверов исполняемых файлов вне процесса вы можете реализовать функцию main() для создания объекта QApplication и ввода в цикл событий, как и в любом обычном приложении Qt. По умолчанию приложение будет запускаться как стандартное приложение Qt, но если вы передадите -activex в командной строке, оно будет запущено как сервер ActiveX. Используйте QAxFactory::isServer(), чтобы создать и запустить стандартный интерфейс приложения или предотвратить автономное выполнение:

#include <QApplication>
#include <QAxFactory>

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    if (!QAxFactory::isServer()) {
        // create and show main window
    }
    return app.exec();
}

Однако это не обязательно, так как ActiveQt предоставляет по умолчанию реализацию функции main. По умолчанию реализация вызывает QAxFactory::startServer(), создает экземпляр QApplication и вызывает exec().

Для создания исполняемого файла сервера ActiveX запустите qmake для генерации файла проекта, и используйте инструмент make вашего компилятора, как и для любого другого приложения Qt. Процесс make также зарегистрирует элементы управления в системном реестре, вызвав результирующий исполняемый файл с опцией командной строки -regserver.

Если сервер ActiveX является исполняемым файлом, поддерживаются следующие параметры командной строки:

Серверы в процессе могут быть зарегистрированы с помощью инструмента regsvr32, доступного на всех системах Windows.

Типичные проблемы при компиляции

Ошибки компилятора/линкера перечислены на основе ошибок, выдаваемых компилятором Microsoft Visual C++ 6.0.

"Нет перегруженной функции, принимающей 2 параметра"

При возникновении ошибки в коде, использующем макрос QAXCLASS() или QAXFACTORY_DEFAULT(), класс виджета не имел конструктора, который может быть использован стандартной фабрикой. Либо добавьте стандартный конструктор виджета, либо реализуйте пользовательскую фабрику, которая не требует его.

При возникновении ошибки в коде, использующем макрос QAXFACTORY_EXPORT(), у подкласса QAxFactory не было соответствующего конструктора. Предоставьте публичный конструктор класса, например

MyFactory(const QUuid &, const QUuid &);

для вашего класса фабрики.

"Синтаксическая ошибка: неверный суффикс в числе"

Уникальные идентификаторы не были переданы в виде строк в макрос QAXFACTORY_EXPORT(), QAXFACTORY_BEGIN() или QAXFACTORY_DEFAULT().

"Неразрешенный внешний символ _ucm_instantiate"

Сервер не экспортирует реализацию QAxFactory. Используйте макрос QAXFACTORY_EXPORT() в одном из файлов реализации проекта для создания и экспорта фабрики или используйте макрос QAXCLASS() или QAXFACTORY_DEFAULT() для использования стандартной фабрики.

"_ucm_initialize уже определён в ..."

Сервер экспортирует более одной реализации QAxFactory или экспортирует одну реализацию дважды. Если вы используете стандартную фабрику, макросы QAXFACTORY_BEGIN() или QAXFACTORY_DEFAULT() должны использоваться только один раз в проекте. Используйте пользовательскую реализацию QAxFactory и макрос QAXFACTORY_EXPORT(), если сервер предоставляет несколько ActiveX-элементов управления.

Распространение библиотек QAxServer

Серверы ActiveX, написанные с Qt, могут использовать Qt как общую библиотеку или иметь Qt, связанный статически с двоичным файлом. Оба способа приведут к довольно большим пакетам (либо сам двоичный файл сервера станет большим, либо вам придётся распространять DLL Qt).

Установка автономных серверов

Если ваш сервер ActiveX также может запускаться как автономное приложение, запустите исполняемый файл сервера с параметром командной строки -regserver после установки исполняемого файла на целевую систему. После этого элементы управления, предоставляемые сервером, станут доступны клиентам ActiveX.

Установка серверов в процессе

Если ваш сервер ActiveX является частью пакета установки, используйте инструмент regsvr32 от Microsoft для регистрации элементов управления на целевой системе. Если этот инструмент отсутствует, загрузите DLL в процесс установщика, найдите символ DllRegisterServer и вызовите функцию:

HMODULE dll = LoadLibrary("myserver.dll");
typedef HRESULT(__stdcall *DllRegisterServerProc)();
DllRegisterServerProc DllRegisterServer =
    (DllRegisterServerProc)GetProcAddress(dll, "DllRegisterServer");

HRESULT res = E_FAIL;
if (DllRegisterServer)
    res = DllRegisterServer();
if (res != S_OK)
    // error handling

Распределение серверов по сети Интернет

Если вы хотите использовать элементы управления на своем сервере в веб-страницах, вам необходимо сделать сервер доступным для браузера, используемого для просмотра вашей страницы, и указать расположение пакета сервера на вашей странице.

Для указания расположения сервера используйте атрибут CODEBASE в теге OBJECT вашего веб-сайта. Значение может указывать на сам файл сервера, на файл INF, перечисляющий другие требуемые файлы сервера (например, Qt DLL), или на сжатый архив CAB.

Файлы INF и CAB документированы практически в каждой книге, посвященной программированию ActiveX и COM, а также в библиотеке MSDN и других онлайн-ресурсах. Примеры включают файлы INF, которые могут быть использованы для создания архивов CAB:

[version]
    signature="$CHICAGO$"
    AdvancedINF=2.0
 [Add.Code]
    simpleax.exe=simpleax.exe
 [simpleax.exe]
    file-win32-x86=thiscab
    clsid={DF16845C-92CD-4AAB-A982-EB9840E74669}
    RegisterServer=yes

Инструмент CABARC от Microsoft может легко генерировать архивы CAB:

cabarc N simpleax.cab simpleax.exe simple.inf

Файлы INF предполагают статическую сборку Qt, поэтому в файлах INF не перечислены зависимости от других DLL. Для распространения сервера ActiveX, зависящего от DLL, необходимо добавить зависимости и предоставить библиотечные файлы в архиве.

Использование элементов управления

Для использования элементов управления ActiveX, например, для их встраивания в веб-страницу, используйте тег <object> HTML.

<object ID="MyActiveX1" CLASSID="CLSID:ad90301a-849e-4e8b-9a91-0a6dc5f6461f">
   ...
<\object>

Для инициализации свойств элемента управления используйте

<object ID=...>
    <param name="name" value="value">
<\object>

Если веб-браузер поддерживает скрипты, используйте JavaScript, VBScript и формы для управления элементом управления. Примеры ActiveQt включают демонстрационные HTML-страницы для примеров элементов управления.

Поддерживаемые и неподдерживаемые клиенты ActiveX

Следующее в значительной степени основано на наших собственных экспериментах с элементами управления ActiveX и клиентскими приложениями и ни в коем случае не является полным.

Поддерживаемые клиенты

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

• Internet Explorer
• Контейнер тестирования элементов управления Microsoft ActiveX
• Microsoft Visual Studio 6.0
• Microsoft Visual Studio.NET/2003
• Microsoft Visual Basic 6.0
• Контейнеры на основе MFC и ATL
• Sybase PowerBuilder
• Контейнеры на основе ActiveQt

Приложения Microsoft Office поддерживаются, но вам необходимо зарегистрировать элементы управления как "вставляемые" объекты. Переопределите QAxFactory::registerClass, чтобы добавить этот атрибут к классу COM, или установите информацию о классе "вставляемый" для вашего класса в "да", используя макрос Q_CLASSINFO.

Неподдерживаемые клиенты

Нам не удалось заставить объекты COM на основе ActiveQt работать с следующими клиентскими приложениями.

• Borland C++ Builder (версии 5 и 6)
• Borland Delphi

Типичные ошибки во время выполнения

Сервер не отвечает

Если система не может запустить сервер (проверьте диспетчер задач, работает ли сервер), убедитесь, что отсутствующие DLL, от которых зависит сервер, не отсутствуют в системном пути (например, DLL Qt!). Используйте утилиту для просмотра зависимостей, чтобы увидеть все зависимости двоичного файла сервера.

Если сервер работает (например, диспетчер задач отображает процесс), см. следующий раздел для получения информации о отладке сервера.

Объект не может быть создан

Если сервер был успешно построен и зарегистрирован во время процесса сборки, но объект не может быть инициализирован, например, приложением OLE/COM Object Viewer, убедитесь, что все DLL, от которых зависит сервер, присутствуют в системном пути (например, Qt DLL). Используйте утилиту для просмотра зависимостей, чтобы увидеть все зависимости двоичного файла сервера.

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

Отладка ошибок во время выполнения

Чтобы отладить сервер в процессе в Visual Studio, установите проект сервера как активный проект и укажите клиентское "исполняемое приложение для сеанса отладки" в настройках проекта (например, используйте контейнер тестирования ActiveX). Вы можете устанавливать точки останова в своем коде и также переходить в код ActiveQt и Qt, если вы установили отладочную версию.

Чтобы отладить исполняемый сервер, запустите приложение в отладчике и запустите его с параметром командной строки -activex. Затем запустите своего клиента и создайте экземпляр вашего элемента управления ActiveX. COM будет использовать существующий процесс для следующего клиента, пытающегося создать элемент управления ActiveX.

Информация о классе и настройка

Чтобы предоставить атрибуты для каждого класса COM, используйте макрос Q_CLASSINFO, который является частью системы метаобъектов Qt.

Обратите внимание, что и ключи, и значения чувствительны к регистру.

Следующее объявляет версию 2.0 класса, который экспонирует только свой собственный API и доступен в диалоговом окне "Вставить объекты" приложений Microsoft Office.

class MyActiveX : public QWidget
{
    Q_OBJECT
    Q_CLASSINFO("Version", "2.0")
    Q_CLASSINFO("ClassID", "{7a4cffd8-cbcd-4ae9-ae7e-343e1e5710df}")
    Q_CLASSINFO("InterfaceID", "{6fb035bf-8019-48d8-be51-ef05427d8994}")
    Q_CLASSINFO("EventsID", "{c42fffdf-6557-47c9-817a-2da2228bc29c}")
    Q_CLASSINFO("Insertable", "yes")
    Q_CLASSINFO("ToSuperClass", "MyActiveX")
    Q_PROPERTY(...)

public:
    MyActiveX(QWidget *parent = 0);

    ...
};

Разработка лицензионных компонентов

Если вы разрабатываете компоненты, вы можете контролировать, кто может их создавать. Поскольку двоичный файл сервера может быть отправлен и зарегистрирован на любом клиентском компьютере, любой может использовать эти компоненты в своем программном обеспечении.

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

Чтобы отметить класс Qt как лицензионный, укажите "LicenseKey" с помощью макроса Q_CLASSINFO().

class MyLicensedControl : public QWidget
{
    Q_OBJECT
    Q_CLASSINFO("LicenseKey", "<key string>")
    ...
};

Ключ необходим для создания экземпляра MyLicensedControl на машине, которая сама не лицензирована. Теперь лицензионный разработчик может перераспространять двоичный файл сервера со своим приложением, которое создает элемент управления, используя значение "LicenseKey", в то время как пользователи приложения не могут создать элемент управления без ключа лицензии.

Если одного ключа лицензии для элемента управления недостаточно (то есть вы хотите, чтобы разные разработчики получали разные ключи лицензии), вы можете указать пустой ключ, чтобы указать, что элемент управления требует лицензии, и переопределить QAxFactory::validateLicenseKey(), чтобы проверить, существует ли лицензия в системе (например, через файл лицензии).

Дополнительные интерфейсы

Элементы управления ActiveX, предоставляемые серверами ActiveQt, поддерживают минимальный набор интерфейсов COM для реализации спецификаций OLE. Когда класс ActiveX наследуется от класса QAxBindable, он также может реализовывать дополнительные интерфейсы COM.

Создайте новый подкласс QAxAggregated и используйте множественное наследование, чтобы сделать подкласс дополнительных классов интерфейсов COM.

class AxImpl : public QAxAggregated, public ISomeCOMInterface
{
public:
    AxImpl() {}

    long queryInterface(const QUuid &iid, void **iface);

    // IUnknown
    QAXAGG_IUNKNOWN

    // ISomeCOMInterface
    ...
}

Переопределите функцию QAxAggregated::queryInterface(), чтобы поддерживать дополнительные интерфейсы COM.

long AxImpl::queryInterface(const QUuid &iid, void **iface)
{
    *iface = 0;
    if (iid == IID_ISomeCOMInterface)
        *iface = (ISomeCOMInterface *)this;
    else
        return E_NOINTERFACE;

    AddRef();
    return S_OK;
}

Поскольку ISomeCOMInterface является подклассом IUnknown, вам придется реализовать функции QueryInterface(), AddRef() и Release(). Используйте макрос QAXAGG_IUNKNOWN в определении вашего класса для этого. Если вы реализуете функции IUnknown вручную, передайте вызовы указателю на интерфейс, возвращаемый функцией QAxAggregated::controllingUnknown(), например:

HRESULT AxImpl::QueryInterface(REFIID iid, void **iface)
{
    return controllingUnknown()->QueryInterface(iid, iface);
}

Не поддерживайте сам интерфейс IUnknown в вашей реализации queryInterface().

Реализуйте методы интерфейсов COM и используйте QAxAggregated::object(), если вам нужно выполнять вызовы подкласса QObject, реализующего элемент управления.

В подклассе QAxBindable, реализуйте QAxBindable::createAggregate(), чтобы вернуть новый объект подкласса QAxAggregated.

class MyActiveX : public QWidget, public QAxBindable
{
    Q_OBJECT

public:
    MyActiveX(QWidget *parent);

    QAxAggregated *createAggregate()
    {
        return new AxImpl();
    }
};

См. также ActiveQt Framework.