WWW.DISSERS.RU

БЕСПЛАТНАЯ ЭЛЕКТРОННАЯ БИБЛИОТЕКА

   Добро пожаловать!

Pages:     | 1 || 3 | 4 |   ...   | 5 |

«Основы 2-е издание, исправленное и переработанное Дейл Роджерсон Оглавление ОТ АВТОРА ...»

-- [ Страница 2 ] --

они полезны, когда компонент поддерживает много интерфейсов. Нельзя, однако, использовать оператор case*, поскольку идентификатор интерфейса — структура, а не константа.

Обратите внимание, что QueryInterface устанавливает указатель интерфейса в NULL, если интерфейс не поддерживается. Это не только требование СОМ, это вообще полезно;

NULL вызовет фатальную ошибку в клиентах, которые не проверяют возвращаемые значения. Это менее опасно, чем позволить клиенту выполнять произвольный код, содержащийся по неинициализированному указателю. Кстати, вызов AddRef в конце QueryInterface в настоящий момент ничего не делает. Реализацией AddRef мы займемся в гл. 4.

Основы приведения типов Вы, вероятно, заметили, что QueryInterface выполняет приведение указателя this, прежде чем сохранить его в ppv.

Это очень важно. В зависимости от приведения, значение, сохраняемое в ppv, может изменяться. Да-да, приведение this к указателю на IX дает не тот же адрес, что приведение к указателю на IY. Например:

* Словом case этот оператор чаще называется в языках семейства Pascal. В С и С++ соответствующий оператор называется switch, хотя ключевое слово case также используется в синтаксисе данного оператора. — Прим. перев.

static_cast(this) != static_cast(this) static_cast(this) != static_cast(this) или, для тех, кому привычнее старый стиль, (IX*)this != (IY*)this (void*)this != (IY*)this Изменение указателя this при приведении типа обусловлено тем, как в С++ реализовано множественное наследование. Более подробно об этом рассказывает врезка «Множественное наследование и приведение типов».

Перед присваиванием указателю, описанному как void, надо всегда явно приводить this к нужному типу.

Интересная проблема связана с возвратом указателя на IUnknown. Можно было бы написать:

// неоднозначность *ppv = static_cast(this);

Однако такое приведение неоднозначно, поскольку IUnknown наследуют оба интерфейса, IX и IY. Таким образом, следует выбрать, какой из указателей — static_cast(static_cast(this)) или static_cast(static_cast(this)) — возвращать. В данном случае выбор не существенен, поскольку реализации указателей идентичны. Однако Вы должны действовать по всей программе единообразно, поскольку указатели не идентичны — а СОМ требует, чтобы для IUnknown всегда возвращался один и тот же указатель. Это требование будет обсуждаться далее в этой главе.

Множественное наследование и приведение типов Обычно приведение указателя к другому типу не изменяет значения. Однако для поддержки множественного наследования С++ в некоторых случаях изменяет указатель на экземпляр класса. Большинство программистов на С++ не знают об этом побочном эффекте множественного наследования. Предположим, что у нас есть С++ класс CA:

class CA : public IX, public IY {... } Так как CA наследует и IX, и IY, то мы можем использовать указатель на CA везде, где можно использовать указатель на IX или IY. Указатель на CA можно передать функции, принимающей указатель на IX или IY, и функция будет работать правильно. Например:

void foo(IX* pIX);

void bar(IY* pIY);

int main() { CA* pA = new CA;

foo(pA);

bar(pA);

delete pA;

return 0;

} foo требуется указатель на указатель таблицы виртуальных функций IX, тогда как bar — указатель на указатель таблицы виртуальный функций IY. Содержимое таблиц виртуальных функций IX и IY, конечно же, разное. Мы не можем передать bar указатель vtbl IX и ожидать, что функция будет работать. Таким образом, компилятор не может передавать один и тот же указатель и foo, и bar, он должен модифицировать указатель на CA так, чтобы тот указывал на подходящий указатель виртуальной таблицы. На рис. 3-3 показан формат размещения объекта CA в памяти.

CA::this IY IX Указатель vtbl Таблица виртуальных (IX*)CA::this функций IY Указатель vtbl (IY*)CA::this QueryInterface Данные AddRef экземпляра для CA IX Release Fx CA QueryInterface AddRef IY Release Fx Рис. 3-3 Формат памяти для класса CA, который множественно наследует IX и IY Из рис. 3-3 видно, что указатель this для CA указывает на указатель таблицы виртуальных функций IX. Таким образом, мы можем без изменения использовать для CA указатель this вместо указателя на IX. Однако очевидно, что указатель this для CA не указывает на указатель vtbl IY. Следовательно, указатель this CA надо модифицировать, прежде чем передавать функции, ожидающей указатель на IY. Для этого компилятор добавляет к указателю this CA смещение указателя vtbl IY (IY). Приведенный ниже код:

IY* pC = pA;

компилятор транслирует во что-то вроде IY* pC = (char*)pA + IY;

Более подробную информацию Вы можете найти в разделе «Multiple Inheritance and Casting» книги Маргарет А. Эллис (Margaret A. Ellis) и Бьерна Страуструпа (Bjarne Strourstrup) The Annotated C++ Reference Manual.

Компиляторы С++ не обязаны реализовывать vtbl при множественном наследовании именно так, как это показано на рис. 3-3.

А теперь все вместе Давайте соберем вместе все элементы и рассмотрим полный пример реализации и использования QueryInterface.

В листинге 3-1 представлен полный текст этой простой программы. Копию программы можно найти на прилагаемом к книге диске. Программа состоит из трех частей.

В первой части объявляются интерфейсы IX, IY и IZ. Интерфейс IUnknown объявлен в заголовочном файле UNKNWN.H Win32 SDK.

Вторая часть — это реализация компонента. Класс CA реализует компонент, поддерживающий интерфейсы IX и IY. Реализация QueryInterface совпадает с той, что была представлена в предыдущем разделе книги. Функция CreateInstance определена после класса CA. Клиент использует ее, чтобы создать компонент, предоставляемый при помощи CA, и получить указатель на IUnknown этого компонента.

После CreateInstance следуют определения IID для интерфейсов. Как видно их этих определений, IID — весьма громоздкая структура (более подробно мы рассмотрим ее в гл. 7). Наш пример программы компонуется с UUID.LIB, чтобы получить определения для IID_IUnknown (т.е. IID для IUnknown).

Третья и последняя часть — функция main, которая выступает в качестве клиента.

IUNKNOWN.CPP // // IUnknown.cpp // Чтобы скомпилировать: cl IUnknown.cpp UUID.lib // #include #include void trace(const char* msg) { cout << msg << endl;

} // Интерфейсы interface IX : IUnknown { virtual void stdcall Fx() = 0;

};

interface IY : IUnknown { virtual void stdcall Fy() = 0;

};

interface IZ : IUnknown { virtual void stdcall Fz() = 0;

};

// Предварительные объявления GUID extern const IID IID_IX;

extern const IID IID_IY;

extern const IID IID_IZ;

// // Компонент // class CA : public IX, public IY { // Реализация IUnknown virtual HRESULT stdcall QueryInterface(const IID& iid, void** ppv);

virtual ULONG stdcall AddRef() { return 0;

} virtual ULONG stdcall Release() { return 0;

} // Реализация интерфейса IX virtual void stdcall Fx() { cout << "Fx" << endl;

} // Реализация интерфейса IY virtual void stdcall Fy() { cout << "Fy" << endl;

} };

HRESULT stdcall CA::QueryInterface(const IID& iid, void** ppv) { if (iid == IID_IUnknown) { trace("QueryInterface: Вернуть указатель на IUnknown");

*ppv = static_cast(this);

} else if (iid == IID_IX) { trace("QueryInterface: Вернуть указатель на IX");

*ppv = static_cast(this);

} else if (iid == IID_IY) { trace("QueryInterface: Вернуть указатель на IY");

*ppv = static_cast(this);

} else { trace("QueryInterface: Интерфейс не поддерживается");

*ppv = NULL;

return E_NOINTERFACE;

} reinterpret_cast(*ppv)->AddRef();

// См. гл. return S_OK;

} // // Функция создания // IUnknown* CreateInstance() { IUnknown* pI = static_cast(new CA);

pI->AddRef();

return pI;

} // // IID // // {32bb8320-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8321-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IY = {0x32bb8321, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8322-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IZ = {0x32bb8322, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// // Клиент // int main() { HRESULT hr;

trace("Клиент: Получить указатель на IUnknown");

IUnknown* pIUnknown = CreateInstance();

trace("Клиент: Получить указатель на IX");

IX* pIX = NULL;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

if (SUCCEEDED(hr)) { trace("Клиент: IX получен успешно");

// Использовать интерфейс IX pIX->Fx();

} trace("Клиент: Получить указатель на IY");

IY* pIY = NULL;

hr = pIUnknown->QueryInterface(IID_IY, (void**)&pIY);

if (SUCCEEDED(hr)) { trace("Клиент: IY получен успешно");

// Использовать интерфейс IY pIY->Fy();

} trace("Клиент: Запросить неподдерживаемый интерфейс");

IZ* pIZ = NULL;

hr = pIUnknown->QueryInterface(IID_IZ, (void**)&pIZ);

if (SUCCEEDED(hr)) { trace("Клиент: Интерфейс IZ получен успешно");

pIZ->Fz();

} else { trace("Клиент: Не могу получить интерфейс IZ");

} trace("Клиент: Получить интерфейс IY через интерфейс IX");

IY* pIYfromIX = NULL;

hr = pIX->QueryInterface(IID_IY, (void**)&pIYfromIX);

if (SUCCEEDED(hr)) { trace("Клиент: IY получен успешно");

pIYfromIX->Fy();

} trace("Клиент: Получить интерфейс IUnknown через IY");

IUnknown* pIUnknownFromIY = NULL;

hr = pIY->QueryInterface(IID_IUnknown, (void**)&pIUnknownFromIY);

if (SUCCEEDED(hr)) { cout << "Совпадают ли указатели на IUnknown? ";

if (pIUnknownFromIY == pIUnknown) { cout << "Да, pIUnknownFromIY == pIUnknown" << endl;

} else { cout << "Нет, pIUnknownFromIY != pIUnknown" << endl;

} } // Удалить компонент delete pIUnknown;

return 0;

} Листинг 3-1 Использование QueryInterface Эта программа выдает на экран следующее:

Клиент: Получить указатель на IUnknown Клиент: Получить интерфейс IX QueryInterface: Вернуть указатель на IX Клиент: IX получен успешно Fx Клиент: Получить интерфейс IY QueryInterface: Вернуть указатель на IY Клиент: IY получен успешно Fy Клиент: Запросить неподдерживаемый интерфейс QueryInterface: Интерфейс не поддерживается Клиент: Не могу получить интерфейс IZ Клиент: Получить интерфейс IY через IX QueryInterface: Вернуть указатель на IY Клиент: IY получен успешно Fy Клиент: Получить интерфейс IUnknown через IY QueryInterface: Вернуть указатель на IUnknown Совпадают ли указатели на IUnknown? Да, pIUnknownFromIY == pIUnknown Клиент начинает с создания компонента при помощи CreateInstance. CreateInstance возвращает указатель на интерфейс IUnknown компонента. Клиент при помощи QueryInterface запрашивает через интерфейс IUnknown указатель на интерфейс IX компонента. Для проверки успешного окончания используется макрос SUCCEEDED.

Если указатель на IX получен успешно, то клиент с его помощью вызывает функцию этого интерфейса Fx.

Затем клиент использует указатель на IUnknown, чтобы получить указатель на интерфейс IY. В случае успеха клиент пользуется этим указателем. Поскольку класс CA реализует как IX, так и IY, QueryInterface успешно обрабатывает запросы на эти интерфейсы. Однако CA не реализует интерфейс IZ. Поэтому — когда клиент запрашивает этот интерфейс, QueryInterface возвращается код ошибки E_NOINTERFACE. Макрос SUCCEEDED возвращает FALSE, и pIZ не используется (для доступа к функциям-членам IZ).

Теперь мы дошли до по-настоящему интересных вещей. Клиент запрашивает указатель на интерфейс IY через указатель на интерфейс IX, pIX. Поскольку компонент поддерживает IY, этот запрос будет успешным, и клиент сможет использовать возвращенный указатель на интерфейс IY так же, как он использовал первый указатель.

Наконец, клиент запрашивает интерфейс IUnknown через указатель на IY. Поскольку все интерфейсы СОМ наследуют IUnknown, этот запрос должен быть успешным. Однако самое интересное, что возвращенный указатель на IUnknown, pIUnknownFromIY, совпадает с первым указателем на IUnknown, pIUnknown. Как мы увидим далее, это одно из требований СОМ: QueryInterface должна возвращать один и тот же указатель на все запросы к IUnknown.

Пример показывает, что при помощи QueryInterface можно получить любой из интерфейсов CA через любой другой. Это одно из важных правил реализации QueryInterface. Давайте более подробно рассмотрим его и другие правила.

Правила и соглашения QueryInterface В этом разделе представлены некоторые правила, которым должны следовать все реализации QueryInterface.

Если их выполнять, клиент сможет узнать о компоненте достаточно, чтобы (надеяться) управлять им и использовать его в своих целях. Без этих правил поведение QueryInterface было бы неопределенным, и писать программы было бы невозможно.

!" Вы всегда получаете один и тот же IUnknown.

!" Вы можете получить интерфейс снова, если смогли получить его раньше.

!" Вы можете снова получить интерфейс, который у Вас уже есть.

!" Вы всегда можете вернуться туда, откуда начали.

!" Если Вы смогли попасть куда-то хоть откуда-нибудь, Вы можете попасть туда откуда угодно.

Теперь рассмотрим эти правила подробно.

Вы всегда получаете один и тот же IUnknown У данного экземпляра компонента есть только один интерфейс IUnknown. Всегда, когда Вы запрашиваете у компонента IUnknown (не важно, через какой интерфейс), в ответ вы получите одно и то же значение указателя.

Вы можете определить, указывают ли два интерфейса на один компонент, запросив у каждого из них IUnknown и сравнив результаты. Приведенная ниже функция SameComponents определяет, указывают ли pIX и pIY на интерфейсы одного компонента:

BOOL SameComponents(IX* pIX, IY* pIY) { IUnknown* pI1 = NULL;

IUnknown* pI2 = NULL;

// Получить указатель на IUnknown через pIX pIX->QueryInterface(IID_IUnknown, (void**)&pI1);

// Получить указатель на IUnknown через pIY pIY->QueryInterface(IID_IUnknown, (void**)&pI2);

// Сравнить полученные указатели return pI1 == pI2;

} Это важное правило. Без него нельзя было бы определить, указывают ли два интерфейса на один и тот же компонент.

Вы можете получить интерфейс снова, если смогли получить его раньше Если QueryInterface однажды успешно обработала запрос на некоторый интерфейс, то все последующие запросы для того же компонента будут успешными. Если же запрос был неудачным, то для этого интерфейса QueryInterface всегда будет возвращать ошибку. Это правило относится только к конкретному экземпляру компонента. Ко вновь созданному экземпляру оно неприменимо.

Представьте себе, что произошло бы, если бы набор поддерживаемых интерфейсов мог изменяться со временем.

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

Без фиксированного набора интерфейсов клиент не мог бы сколько-нибудь уверенно определить возможности компонента.

Вы можете снова получить интерфейс, который у Вас уже есть Если у Вас есть интерфейс IX, то Вы можете запросить через него интерфейс IX и получите в ответ указатель на IX. Код выглядит так:

void f(IX* pIX) { IX* pIX2 = NULL;

// Запросить IX через IX HRESULT hr = pIX->QueryInterface(IID_IX, (void**)&pIX2);

assert(SUCCEEDED(hr));

// Запрос должен быть успешным } Это правило звучит несколько странно. Зачем Вам интерфейс, который у Вас уже есть? Вспомните, однако, что все интерфейсы полиморфны относительно IUnknown и многим функциям передается указатель на IUnknown. У этих функций должна быть возможность использовать любой указатель на IUnknown и получить по нему любой другой интерфейс. Это иллюстрирует приведенный ниже пример:

void f(IUnknown* pI) { HRESULT hr;

IX* pIX = NULL;

// Запросить IX через pI hr = pI->QueryInterface(IID_IX, (void**)&pIX);

// Что-нибудь содержательное } void main() { // Получаем откуда-то указатель на IX IX* pIX = GetIX();

// Передаем его в функцию f(pIX);

} Функция f сможет получить указатель на IX по переданному ей указателю, хотя последний и так указывает на IX.

Вы всегда можете вернуться туда, откуда начали Если у Вас есть указатель на интерфейс IX и с его помощью Вы успешно получаете интерфейс IY, то можно получить «обратно» интерфейс IX через указатель на IY. Иными словами, независимо от того, какой интерфейс у Вас есть сейчас, можно снова получить интерфейс, с которого Вы начали. Это иллюстрирует следующий код:

void f(IX* pIX) { HRESULT hr;

IX* pIX2 = NULL;

IY* pIY = NULL;

// Получить IY через IX hr = pIX->QueryInterface(IID_IY, (void**)&pIY);

if (SUCCEEDED(hr)) { // Получить IX через IY hr = pIY->QueryInterface(IID_IX, (void**)&pIX2);

// QueryInterface должна отработать успешно assert(SUCCEEDED(hr));

} } Если Вы смогли попасть куда-то хоть откуда-нибудь, Вы можете попасть туда откуда угодно Если Вы можете получить у компонента некоторый интерфейс, то его можно получить с помощью любого из интерфейсов, поддерживаемых компонентом. Если можно получить интерфейс IY через IX, а IZ — через IY, то IZ можно получить и через IX. В программе это выглядит так:

void f(IX* pIX) { HRESULT hr;

IY* pIY = NULL;

// Запросить IY у IX hr = pIX->QueryInterface(IID_IY, (void**)&pIY);

if (SUCCEEDED(hr)) { IZ* pIZ = NULL;

// Запросить IZ и IY hr = pIY->QueryInterface(IID_IZ, (void**)&pIZ);

if (SUCCEEDED(hr)) { // Запросить IZ у IX hr = pIX->QueryInterface(IID_IZ, (void**)&pIZ);

// Это должно работать assert(SUCCEEDED(hr));

} } } Это правило делает QueryInterface пригодной для использования. Вообразите, что стало бы, если бы получение указателя на интерфейс зависело от того, через какой интерфейс Вы делаете запрос. Вы редактируете код своего клиента, переставляя две функции местами, — и все перестает работать. Написать клиент для такого компонента было бы практически невозможно.

Общая задача всех приведенных правил — сделать использование QueryInterface простым, логичным, последовательным и определенным. По счастью, при реализации QueryInterface для компонента следовать правилам нетрудно. Если компоненты реализуют QueryInterface корректно, то клиенту не нужды беспокоиться об этих правилах. Пожалуйста, учтите, что простота реализации и использования QueryInterface не снижают значения этой функции. В СОМ нет ничего важнее, чем QueryInterface.

QueryInterface определяет компонент QueryInterface — это самая важная часть СОМ, поскольку она определяет компонент. Интерфейсы, поддерживаемые компонентом, — это те интерфейсы, указатели на которые возвращает QueryInterface. Их определяет реализация QueryInterface, а не заголовочный файл для класса С++, реализующего компонент.

Компонент не определяется и иерархией наследования этого класса С++. Его определяет исключительно реализация QueryInterface.

Поскольку реализация QueryInterface для клиента невидима, то он не знает, какие интерфейсы поддерживаются.

Единственный способ, которым клиент может об этом узнать, — запросить компонент. Такой порядок совершенно отличен от обычного в С++, где клиент имеет заголовочный файл класса и знает обо всех членах последнего. В некотором смысле концепция СОМ больше напоминает знакомство с человеком на вечеринке, чем при приеме на работу. Придя наниматься на работу, человек предоставляет Вам резюме, его характеризующее.

Такое резюме похоже на объявление класса С++. На вечеринке же новый знакомый не вручает Вам никакой «сводки данных» о себе;

чтобы узнать о нем, Вы задаете вопросы. Это больше похоже на практику СОМ (и на игру Animal).

Вы не можете воспользоваться всеми знаниями сразу Первым вопросом, который я задал при изучении СОМ, был: «Почему я не могу сразу запросить у компонента все его интерфейсы?». Ответ в духе Дзен гласит: «Что станешь ты делать со списком интерфейсов, поддерживаемых компонентом?» Оказывается, это очень хороший ответ (хотя он и сформулирован как вопрос).

Допустим на мгновение, что клиент может запросить у компонента все поддерживаемые им интерфейсы.

Допустим, что наш компонент поддерживает интерфейсы IX и IY, но клиент был написан раньше и ничего не знает об IY. Итак, он создает компонент и запрашивает его интерфейсы. Компонент должен был бы вернуть IX и IY. Клиенту не известен интерфейс IY, поэтому он никак не может его использовать. Чтобы клиент мог сделать что-либо осмысленное с непонятным интерфейсом, он должен был бы прочитать документацию этого интерфейса и написать соответствующий код. При сегодняшнем уровне развития технологии это невозможно.

Иными словами, компонент может поддерживать только те интерфейсы, которые известны его программисту.

Точно так же клиент может поддерживать только те интерфейсы, о которых знает его программист.

СОМ все же предоставляет средство, библиотеки типа (type libraries), для определения интерфейсов, которые предоставляет компонент, во время выполнения. Хотя клиент может использовать библиотеку типа для определения параметров функций некоторого интерфейса, он по-прежнему не знает, как писать программы, использующие эти функции. Эта работа остается программисту. Библиотеки типа будут рассматриваться в гл. 11.

Во многих случаях клиенты могут использовать только компоненты, реализующие определенный набор интерфейсов. Создавать компонент, запрашивать у него интерфейсы по одному и в конце концов выяснить, что он не поддерживает один из нужных, — это пустая трата времени. Чтобы ее избежать, можно определить объединенный набор интерфейсов как категорию компонентов (component category). Затем компоненты могут опубликовать сведения о том, принадлежат ли они к некоторой категории. Эту информацию клиенты могут получить, не создавая компонентов;

подробнее об этом будет рассказано в гл. 6.

Теперь позвольте перейти к одному из самых неожиданных применений QueryInterface — работе с новыми версиями компонентов.

Работа с новыми версиями компонентов Как Вы уже знаете, интерфейсы СОМ неизменны. После того, как интерфейс опубликован и используется каким либо клиентом, он никогда не меняется. Но что именно я имею в виду, когда говорю, что интерфейсы остаются теми же? У каждого интерфейса имеется уникальный идентификатор интерфейса (IID). Вместо того, чтобы изменять интерфейс фактически нужно создать новый, с новым IID. Если QueryInterface получает запрос со старым IID, она возвращает старый интерфейс. Если же QueryInterface получает запрос с новым IID, то возвращает новый интерфейс. С точки зрения QueryInterface IID и есть интерфейс.

QueryMultipleInterfaces В распределенной СОМ (DCOM) определен новый интерфейс ImultiQI. Он имеет единственную функцию член — QueryMultipleInterfaces. Эта функция позволяет клиенту запросить у компонента несколько интерфейсов за один вызов. Один вызов QueryMultipleInterfaces заменяет несколько циклов «запрос-ответ» по сети, что повышает производительность.

Итак, интерфейс, соответствующие данному IID, неизменен. Новый интерфейс может наследовать старый или быть совершенно другим. На существующие клиенты это не влияет, так как старый интерфейс не меняется.

Новые же клиенты могут использовать как старые, так и новые компоненты, поскольку могут запрашивать как старый, так и новый интерфейс.

Основная сила этого метода работы с версиями в его прозрачности. Клиенту не требуется выполнять никаких действий, чтобы проверить, имеет ли он дело с корректной версией интерфейса. Если клиент не может найти интерфейс, то этот интерфейс некорректен. Существо интерфейса полностью связано с его версией. Если изменяется версия, то изменяется и интерфейс. Здесь не может возникнуть никакой путаницы.

В качестве примера предположим, что у нас есть программа моделирования полета, названная Pilot, которая использует средства разных поставщиков для моделирования летательных аппаратов. Для того, чтобы работать с Pilot, компонент-«летательный аппарат» должен реализовывать интерфейс IFly. Пусть у одного из поставщиков имеется такой компонент, называемый Bronco и поддерживающий интерфейс IFly. Мы решаем модернизировать Pilot и выпускаем новую версию, FastPilot. FastPilot расширяет набор «поведений» самолета при помощи интерфейса IFastFly, в дополнение к IFly. Компания, продающая Bronco, добавляет интерфейс IFastFly и создает FastBronco.

FastPilot по-прежнему поддерживает IFly, поэтому, если у пользователя есть копия Bronco, то FastPilot по прежнему может ее использовать. FastPilot будет сначала запрашивать у компонента IFlyFast, а если компонент его не поддерживает, — IFly. FastBronco по-прежнему поддерживает IFly, так что если у кого-то есть старый Pilot, то FastBronco будет работать и с ним. На рис. 3-4 возможные взаимосвязи представлены графически.

Bronco Pilot pIFly IFly FastBronco FastPilot IFly pIFly pIFlyFast IFlyFast Рис. 3-4 Различные комбинации старых и новых версий клиентов и компонентов В результате клиент и компонент смогут работать в любом сочетании.

В некоторых случаях новый компонент или клиент не могут поддерживать обратную совместимость, поскольку та сложна или слишком медленно работает. Однако и тогда обработка версий в СОМ не теряет своей силы. Как и раньше, IID интерфейса определяет его версию. Всякий раз, когда клиент получает интерфейс, он получает корректную версию, поскольку другая версия — это другой интерфейс с другим IID.

Когда нужно создавать новую версию Для того, чтобы механизм версий СОМ работал, программисты должны строго следить за присвоением новым версиям существующих интерфейсов новых IID. Вы обязаны создать новый интерфейс с новым IID, если изменили хотя бы одну из приведенных ниже характеристик:

!" число функций в интерфейсе;

!" порядок следования функций в интерфейсе;

!" число параметров функции;

!" типы параметров функции;

!" возможные возвращаемые функцией значения;

!" типы возвращаемых значений;

!" смысл параметров функции;

!" смысл функций интерфейса.

Вообще говоря, любое изменение, которое может нарушить работу любого из существующих клиентов, требует нового интерфейса. (Конечно, если Вы контролируете и клиент, и компонент, степеней свободы больше.) Имена версий интерфейсов Если Вы создаете новую версию интерфейса, следует изменить и его имя. Стандартное соглашение СОМ на этот счет заключается в добавлении номера к концу имени. Согласно ему, IFly становится IFly2, а не IFastFly.

Конечно, свои собственные интерфейсы Вы можете называть как угодно. Если же интерфейсы принадлежат кому-либо другому, то следует запросить у него разрешение, прежде чем создавать новую версию или присваивать новое имя.

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

Это можно представить себе при помощи аналогии. Юридические договоры должны ясно и четко указывать обязанности сторон. Однако, позже, сколь бы коротким и простым ни был договор, в нем всегда найдется набранное мелким шрифтом. И это обязательно будет что-то, что Вы не считали важным, когда подписывали бумаги, — но что теперь может обойтись в тысячи долларов. Размер шрифта не имеет значения, юридическая сила зависит не от него.

Интерфейс — своего рода форма договора между клиентом и компонентом. Как и во всех договорах, здесь есть кое-что «мелким шрифтом». В случае интерфейсов это способ их использования. Способ, которым клиент использует функции интерфейса, составляет предмет договора с компонентом, реализующим интерфейс. Если компонент изменяет реализацию интерфейса, он должен гарантировать, что клиент сможет пользоваться функциями прежним способом. В противном случае клиент не будет работать, и его придется перекомпилировать. Пусть, например, клиент вызывает функции Foo1, Foo2 и Foo3 в этом порядке. Если компонент изменится так, что первой нужно будет вызывать Foo3, он нарушит неявное соглашение, определяющее способ и последовательность использования функций интерфейса.

Все интерфейсы «заключают» неявные соглашения. Это становится проблемой, только если мы хотим реализовать интерфейс способом, не совместимым с принятым порядком. Чтобы избежать нарушения неявного соглашения, у Вас есть два варианта. Первый заключается в том, чтобы сделать интерфейс работоспособным независимо от последовательности и способа вызова его функций-членов. Второй вариант — заставить всех клиентов использовать интерфейс одинаково и документировать этот порядок. Теперь, если компонент изменяется и нарушает работу клиента, он разрывает явный договор, а не неявный. Оба решения требуют огромной предусмотрительности и тщательного планирования.

«У Вас две ноги?» Теперь Вы знаете, «что за животное» СОМ. QueryInterface — это единственная особенность, которая в действительности отличает создание компонентов СОМ от написания классов С++. QueryInterface дает СОМ большую часть ее гибкости и способности к инкапсуляции. QueryInterface определяет «поведения», поддерживаемые компонентом во время выполнения, и максимально использует силу динамической компоновки.

Полностью скрывая детали компонента о клиента, QueryInterface максимально защищает последний от влияния возможных изменений компонента. QueryInterface также является «становым хребтом» элегантного и прозрачного механизма работы с версиями. Этот механизм позволяет старым и новым компонентам взаимодействовать и работать вместе.

В этой главе Вы также познакомились с IUnknown — корневым интерфейсом, поддерживаемым всеми другими.

QueryInterface — это лишь одна из трех функций, составляющих IUnknown. В следующей главе мы увидим, как совместное использование двух его функций-членов, AddRef и Release, заменяет оператор delete (который мы использовали в предыдущих примерах). Но, может, перед этим немного поиграем в Animal?

Имеете ли Вы отношение к удалению компонентов из памяти?

> да Имеете ли Вы отношение к подсчету ссылок?

> да Вы AddRef?

> нет Кто же Вы?

> Release Чем Вы отличаетесь от AddRef?

> уменьшаю счетчик ссылок Спасибо 4 глава Подсчет ссылок В детстве я хотел стать пожарным. Романтика приключений и опасности привлекала меня, как и большинство мальчиков. Однако по-настоящему мне хотелось быть пожарным не потому. Дело в том, что, во-первых, пожарные ездили, повиснув сзади на пожарной машине (из-за этого я еще хотел стать мусорщиком, но это другая история). Во-вторых, у пожарных была по-настоящему крутая экипировка: металлические каски, высокие ботинки, большие плащи и кислородные баллоны. Я тоже хотел носить все эти замечательные вещи. Пожарные, казалось, никогда не расставались с ними. Даже если они всего лишь снимали кошку с дерева, то все равно делали это в касках, плащах и высоких ботинках. Пожарного было видно издалека.

Класс С++ кое в чем напоминает пожарного. Заголовок сообщает всему миру, какие сервисы и функции предоставляет класс, — точно так же, как амуниция пожарных говорит об их профессии. Однако компоненты СОМ ведут себя совершенно иначе. Компонент СОМ гораздо более скрытен, чем пожарный или класс С++.

Клиент не может посмотреть на компонент и сразу увидеть, что тот реализует пожарного. Вместо этого он должен выспрашивать: «Есть ли у Вас кислородный баллон? А топор? Носите ли Вы водонепроницаемую одежду?» На самом деле клиенту неважно, имеет ли он дело с настоящим компонентом-пожарным. Ему важно, что у компонента за «амуниция». Например, если клиент задает вопрос «Носите ли Вы водонепроницаемую одежду?», то его удовлетворят ответы не только пожарного, но и байдарочника, аквалангиста и лесоруба в непромокаемом плаще. На вопрос «Есть ли у Вас кислородный баллон?» утвердительно ответит пожарный и аквалангист. На следующий вопрос про топор положительный ответ даст уже только пожарный (или аквалангист-лесоруб, если такой найдется).

Изоляция клиента от подлинной сущности компонента делает его менее восприимчивым к изменениям последнего. Однако, поскольку клиент знает компонент только через интерфейсы, он не может прямо управлять временем жизни компонента как такового. В этой главе мы рассмотрим косвенное управление — реализованное как явное управление временем жизни отдельных интерфейсов.

Управление временем жизни Давайте разберем, почему клиент не должен управлять временем жизни компонента напрямую. Предположим, что наш клиент обращается к тому же компоненту-пожарному. В разных местах кода клиента могут быть разбросаны вызовы этого компонента через различные интерфейсы. Одна часть клиента может дышать через кислородный баллон при посредстве интерфейса IUseOxygen, а другая — крушить дом топором при помощи IUseAxe. Клиент может закончить пользоваться IUseAxe раньше, чем IUseOxygen. Однако Вы вряд ли захотите удалить компонент из памяти, когда с одним интерфейсом уже закончена, а с другим еще продолжается.

Определить момент, когда компонент можно безопасно удалить, сложно еще и потому, что мы не знаем, указывают ли два указателя на интерфейсы одного и того же компонента. Единственный способ узнать это — запросить IUnknown через оба интерфейса и сравнить результаты. По мере того, как программа усложняется, становится все труднее определить, когда можно «отпускать» компонент. Проще всего загрузить его и не выгружать до завершения приложения. Но такое решение не слишком эффективно.

Итак, наша стратегия будет такова: вместо того, чтобы удалять компоненты напрямую, мы будем сообщать компоненту, что нам нужен интерфейс или что мы закончили с ним работать. Мы точно знаем, когда начинаем использовать интерфейс, и знаем (обычно), когда перестаем его использовать. Однако, как уже ясно, мы можем не знать, что закончили использовать компонент вообще. Поэтому имеет смысл ограничиться сообщением об окончании работы с данным интерфейсом — и пусть компонент сам отслеживает, когда мы перестаем пользоваться всеми интерфейсами.

Именно для реализации этой стратегии и предназначены еще две функции-члена IUnknown — AddRef и Release. В прошлой главе было дано определение интерфейса IUnknown, которое я любезно повторю:

interface IUnknown { virtual HRESULT stdcall QueryInterface(const IID& iid, void** ppv) = 0;

virtual ULONG stdcall AddRef() = 0;

virtual ULONG stdcall Release() = 0;

};

В этой главе мы рассмотрим, как AddRef и Release дают компоненту возможность контролировать время своей жизни, а клиенту — возможность иметь дело с интерфейсами. Мы начнем с обзора подсчета ссылок, а затем посмотрим, как клиент использует AddRef и Release. Познакомившись с использованием функций, мы реализуем их в компоненте. Наконец, мы обсудим, когда вызовы AddRef и Release можно опустить для повышения производительности и подытожим наше обсуждение набором правил.

Подсчет ссылок AddRef и Release реализуют и технику управления памятью, известную как подсчет ссылок (reference counting).

Подсчет ссылок — простой и быстрый способ, позволяющий компонентам самим удалять себя. Компонент СОМ поддерживает счетчик ссылок. Когда клиент получает некоторый интерфейс, значение этого счетчика увеличивается на единицу. Когда клиент заканчивает работу с интерфейсом, значение на единицу уменьшается.

Когда оно доходит до нуля, компонент удаляет себя из памяти. Клиент также увеличивает счетчик ссылок, когда создает новую ссылку на уже имеющийся у него интерфейс. Как Вы, вероятно, догадались, увеличивается счетчик вызовом AddRef, а уменьшается — вызовом Release.

Для того, чтобы пользоваться подсчетом ссылок, необходимо знать лишь три простых правила:

1. Вызывайте AddRef перед возвратом. Функции, возвращающие интерфейсы, перед возвратом всегда должны вызывать AddRef для соответствующего указателя. Это также относится к QueryInterface и функции CreateInstance. Таким образом, Вам не нужно вызывать AddRef в своей программе после получения (от функции) указателя на интерфейс.

2. По завершении работы вызывайте Release. Когда Вы закончили работу с интерфейсом, следует вызвать для него Release.

3. Вызывайте AddRef после присваивания. Когда бы Вы ни присваивали один указатель на интерфейс другому, вызывайте AddRef. Иными словами: следует увеличить счетчик ссылок каждый раз, когда создается новая ссылка на данный интерфейс.

Вот три простых правила подсчета ссылок. Теперь рассмотрим несколько примеров. Для начала — простой пример «на первые два правила». Приведенный ниже фрагмент кода создает компонент и получает указатель на интерфейс IX. Мы не вызываем AddRef, так как за нас это делают CreateInstance и QueryInterface. Однако мы вызываем Release как для интерфейса IUnknown, возвращенного CreateInstance, так и для интерфейса IX, возвращенного QueryInterface.

// Создать компонент IUnknown* pIUnknown = CreateInstance();

// Получить интерфейс IX IX* pIX = NULL;

HRESULT hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

if (SUCCEEDED(hr)) { // Использовать интерфейс IX pIX->Fx();

// Завершить работу с IX pIX->Release();

} pIUnknown->Release();

// Завершить работу с IUnknown В приведенном выше примере мы фактически закончили работать с IUnknown сразу же после вызова QueryInterface, так что его можно освободить раньше.

// Создать компонент IUnknown* pIUnknown = CreateInstance();

// Получить интерфейс IX IX* pIX = NULL;

HRESULT hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

// Завершить работу с IUnknown pIUnknown->Release();

// Использовать IX, если он был получен успешно if (SUCCEEDED(hr)) { // Использовать интерфейс IX pIX->Fx();

// Завершить работу с IX pIX->Release();

} Легко забыть, что всякий раз, когда Вы копируете указатель на интерфейс, надо увеличить его счетчик ссылок. В приведенном далее фрагменте кода делается еще одна ссылка на интерфейс IX. В общем случае необходимо увеличивать счетчик ссылок всякий раз, когда создается копия указателя на интерфейс, о чем говорит приведенное выше правило 3.

// Создать компонент IUnknown* pIUnknown = CreateInstance();

IX* pIX = NULL;

HRESULT hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

pIUnknown->Release();

if (SUCCEEDED(hr)) { // Использовать интерфейс IX pIX->Fx();

// Создать копию pIX IX* pIX2 = pIX;

// Увеличить счетчик ссылок pIX2->AddRef();

// Что-то делать при помощи pIX pIX2->Fx();

// Завершить работу с pIX pIX2->Release();

// Завершить работу с pIX pIX->Release();

} Первая Ваша реакция на показанный выше код могла быть такой: «Обязательно ли нужно вызывать в этом примере AddRef и Release для pIX2?» либо «Как я запомню, что всякий раз при копировании указателя нужно вызывать AddRef и Release?» У некоторых оба эти вопроса возникают одновременно. Ответ на первый вопрос — нет. В данном примере AddRef и Release для pIX2 вызывать необязательно. В простых случаях, вроде этого, легко заметить, что увеличение и уменьшение счетчика ссылок для pIX2 излишне, поскольку время жизни pIX совпадает со временем жизни pIX. Правила оптимизации подсчета ссылок будут рассмотрены ниже в этой главе.

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

Однако, как мы увидим в гл. 10, классы smart-указателей позволяют полностью инкапсулировать подсчет ссылок.

Еще раз: клиент сообщает компоненту о своем желании использовать интерфейс, когда вызывается QueryInterface. Как мы видели выше, QueryInterface вызывает AddRef для запрашиваемого интерфейса. Когда клиент заканчивает работу с интерфейсом, он вызывает для этого интерфейса Release. Компонент остается в памяти, ожидая, пока счетчик ссылок не станет равен 0. Когда счетчик становится нулем, компонент сам себя удаляет.

Подсчет ссылок на отдельные интерфейсы Я должен отметить одну тонкую деталь. С точки зрения клиента, подсчет ссылок ведется на уровне интерфейсов, а не на уровне компонентов. Помните пожарного с амуницией? Клиент не может видеть все целиком, он видит только интерфейсы. Таким образом, клиент считает, что у каждого интерфейса — свой счетчик ссылок.

Итак, хотя с точки зрения клиентов подсчет ссылок осуществляется для интерфейсов, а не для компонентов (см.

рис. 4-1), для реализации компонента это не имеет значения. Компонент может поддерживать отдельные счетчики для каждого из интерфейсов, а может и иметь один общий счетчик. Реализация не имеет значения до тех пор, пока клиент убежден, что подсчет ссылок ведется для самих интерфейсов. Поскольку компонент может реализовывать подсчет для каждого интерфейса, постольку клиент не должен предполагать обратного.

Компонент Компонент Счетчик ссылок Клиент IUnknown Счетчик ссылок IUnknown IX IX Счетчик ссылок IY IY Счетчик ссылок Отдельные счетчики Общий счетчик ссылок ссылок для интерфейсов Рис. 4-1 Программист компонента может использовать один счетчик ссылок для всего компонента либо отдельные счетчики для каждого интерфейса Что означает для клиента подсчет ссылок для каждого интерфейса в отдельности? Он означает, что клиент должен вызывать AddRef именно для того указателя, с которым собирается работать, а не для какого-нибудь другого. Клиент также должен вызывать Release именно для того указателя, с которым закончил работу.

Например, не делайте так:

IUnknown* pIUnknown = CreateInstance();

IX* pIX = NULL;

pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

pIX->Fx();

IX* pIX2 = pIX;

// Должно быть pIX2->AddRef();

pIUnknown->AddRef();

pIX2->Fx();

pIX2->Release();

pIUnknown->Release();

// Должно быть pIX->Release();

pIUnknown->Release();

В приведенном фрагменте предполагается, что можно вызывать AddRef и Release через указатель на IUnknown, как если бы это был указатель на IX. В зависимости от реализации такой код может создавать проблемы.

Зачем программисту компонента может потребоваться реализовывать подсчет ссылок для каждого интерфейса, а не для всего компонента в целом? По двум основным причинам: для упрощения отладки и для поддержки выделения ресурсов по требованию.

Отладка Предположим, что Вы забыли вызвать Release для некоторого из интерфейсов компонента;

забыть это легко.

Компонент никогда не освободится, так как delete вызывается, только когда счетчик ссылок становится равным нулю. Проблема в том, чтобы найти, где и когда надо было освободить интерфейс;

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

Выделение ресурсов по требованию Реализация интерфейса может потребовать большего объема памяти или других ресурсов. Достаточно просто реализовать QueryInterface так, чтобы память выделялась в момент запроса интерфейса. Однако, если имеется только один счетчик ссылок на весь компонент, нельзя определить, когда можно безопасно освободить память, связанную с данным интерфейсом. Использование отдельных счетчиков упрощает задачу.

Другой, и в большинстве случаев лучший, вариант — реализовать «ресурсоемкий» интерфейс в отдельном компоненте и передавать клиенту интерфейс последнего. Эта техника, называемая агрегированием (aggregation), будет продемонстрирована в гл. 8.

Для того чтобы примеры в книге были проще, мы будем использовать в компонентах общий счетчик ссылок.

Теперь давайте рассмотрим, как реализовать подсчет ссылок.

Реализация AddRef и Release Реализация AddRef (и Release) относительно проста. В основном она сводится к операции увеличения (уменьшения) на единицу, как показано ниже.

ULONG stdcall AddRef() { return ++m_cRef;

} ULONG stdcall Release() { if (--m_cRef == 0) { delete this;

return 0;

} return m_cRef;

} AddRef увеличивает значение переменной m_cRef, счетчика ссылок. Release уменьшает m_cRef и удаляет компонент, если значение переменной становится равным нулю. Во многих случаях Вы можете встретить реализацию AddRef и Release при помощи функций Win32 InterlockedIncrement и InterlockedDecrement. Эти функции гарантируют, что значение переменной изменяет в каждый момент времени только один поток управления. В зависимости от потоковой модели, используемой Вашим объектом СОМ, параллельные потоки могут создавать проблемы. Вопросы, связанные с потоками, будут рассмотрены в гл. 12.

ULONG stdcall AddRef() { return InterlockedIncrement(&m_cRef);

} ULONG stdcall Release() { if (InterlockedDecrement(&m_cRef) == 0) { delete this;

return 0;

} return m_cRef;

} Вам также следует знать, что возвращаемые AddRef и Release значения не имеют смысла и использовать их можно только для отладки. Клиент не должен полагаться на то, что эти значения как-то связаны с числом ссылок на компонент или его интерфейсы.

Если Вы внимательно читали код гл. 3, то заметили, что я уже использовал AddRef в двух местах — в QueryInterface и CreateInstance.

HRESULT stdcall CA::QueryInterface(const IID& iid, void** ppv) { if (iid == IID_IUnknown) { *ppv = static_cast(this);

} else if (iid == IID_IX) { *ppv = static_cast(this);

} else if (iid == IID_IY) { *ppv = static_cast(this);

} else { *ppv = NULL;

return E_NOINTERFACE;

} static_cast(*ppv)->AddRef();

// См. гл. return S_OK;

} IUnknown* CreateInstance() { IUnknown* pI = static_cast(new CA);

pI->AddRef();

return pI;

} Всякий раз, создавая компонент, Вы создаете и ссылку на него. Таким образом, компонент в момент создания должен увеличивать счетчик ссылок, прежде чем возвратить клиенту указатель. Это освобождает программиста от необходимости помнить, что после CreateInstance и QueryInterface надо вызывать AddRef.

В некоторых случаях вызовы AddRef и Release можно опустить. Однако, прежде чем мы избавимся от некоторых из них, давайте рассмотрим листинг 4-1, который показывает все изложенное выше на примере. Копию кода и скомпилированную программу можно найти на прилагающемся к книге диске.

REFCOUNT.CPP // // RefCount.cpp // Копиляция: cl RefCount.cpp UUID.lib // #include #include void trace(const char* msg) { cout << msg << endl;

} // Предварительные описания GUID extern const IID IID_IX;

extern const IID IID_IY;

extern const IID IID_IZ;

// Интерфейсы interface IX : IUnknown { virtual void stdcall Fx() = 0;

};

interface IY : IUnknown { virtual void stdcall Fy() = 0;

};

interface IZ : IUnknown { virtual void stdcall Fz() = 0;

};

// // Компонент // class CA : public IX, public IY { // Реализация IUnknown virtual HRESULT stdcall QueryInterface(const IID& iid, void** ppv);

virtual ULONG stdcall AddRef();

virtual ULONG stdcall Release();

// Реализация интерфейса IX virtual void stdcall Fx() { cout << "Fx" << endl;

} // Реализация интерфейса IY virtual void stdcall Fy() { cout << "Fy" << endl;

} public:

// Конструктор CA() : m_cRef(0) {} // Деструктор ~CA() { trace("CA: Ликвидировать себя");

} private:

long m_cRef;

};

HRESULT stdcall CA::QueryInterface(const IID& iid, void** ppv) { if (iid == IID_IUnknown) { trace("CA QI: Возвратить указатель на IUnknown");

*ppv = static_cast(this);

} else if (iid == IID_IX) { trace("CA QI: Возвратить указатель на IX");

*ppv = static_cast(this);

} else if (iid == IID_IY) { trace("CA QI: Возвратить указатель на IY");

*ppv = static_cast(this);

} else { trace("CA QI: Интерфейс не поддерживается");

*ppv = NULL;

return E_NOINTERFACE;

} reinterpret_cast(*ppv)->AddRef();

return S_OK;

} ULONG stdcall CA::AddRef() { cout << "CA: AddRef = " << m_cRef+1 << endl;

return InterlockedIncrement(&m_cRef);

} ULONG stdcall CA::Release() { cout << "CA: Release = " << m_cRef-1 << endl;

if (InterlockedDecrement(&m_cRef) == 0) { delete this;

return 0;

} return m_cRef;

} // // Функция создания // IUnknown* CreateInstance() { IUnknown* pI = static_cast(new CA);

pI->AddRef();

return pI;

} // // IID // // {32bb8320-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8321-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IY = {0x32bb8321, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8322-b41b-11cf-a6bb-0080c7b2d682} static const IID IID_IZ = {0x32bb8322, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// // Клиент // int main() { HRESULT hr;

trace("Клиент: Получить указатель на IUnknown");

IUnknown* pIUnknown = CreateInstance();

trace("Клиент: Получить интерфейс IX");

IX* pIX = NULL;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

if (SUCCEEDED(hr)) { trace("Клиент: IX получен успешно");

// Использовать интерфейс IX pIX->Fx();

pIX->Release();

} trace("Клиент: Получить интерфейс IY");

IY* pIY = NULL;

hr = pIUnknown->QueryInterface(IID_IY, (void**)&pIY);

if (SUCCEEDED(hr)) { trace("Клиент: IY получен успешно");

// Использовать интерфейс IY pIY->Fy();

pIY->Release();

} trace("Клиент: Запросить неподдерживаемый интерфейс");

IZ* pIZ = NULL;

hr = pIUnknown->QueryInterface(IID_IZ, (void**)&pIZ);

if (SUCCEEDED(hr)) { trace("Клиент: Интерфейс IZ получен успешно");

pIZ->Fz();

pIZ->Release();

} else { trace("Клиент: Не могу получить интерфейс IZ");

} trace("Клиент: Освободить интерфейс IUnknown");

pIUnknown->Release();

return 0;

} Листинг 4-1 Полный пример подсчета ссылок Эта программа выводит на экран следующее:

Клиент: Получить указатель на IUnknown CA: AddRef = Клиент: Получить указатель на IX CA QI: Вернуть указатель на IX CA: AddRef = Клиент: IX получен успешно Fx CA: Release = Клиент: Получить интерфейс IY CA QI: Вернуть указатель на IY CA: AddRef = Клиент: IY получен успешно Fy CA: Release = Клиент: Запросить неподдерживаемый интерфейс CA QI: Интерфейс не поддерживается Клиент: Не могу получить интерфейс IZ Клиент: Освободить интерфейс IUnknown CA: Release = CA: Ликвидировать себя Это та же программа, что и в примере гл. 3, но к ней добавлен подсчет ссылок. К компоненту добавлены реализации AddRef и Release. Единственное отличие в клиенте — добавлены вызовы Release, чтобы обозначить окончание работы с различными интерфейсами. Обратите также внимание, что клиент больше не использует оператор delete. В данном примере клиенту нет надобности в AddRef, так как эту функцию для соответствующих указателей вызывают CreateInstance и QueryInterface.

Когда подсчитывать ссылки Теперь пора разобраться с тем, когда нужно вести подсчет ссылок. Мы увидим, что иногда можно безопасно опустить пары вызовов AddRef/Release, тем самым оптимизируя код. Сочетая изложенные ранее принципы с новыми навыками оптимизации, мы определим некоторые общие правила подсчета ссылок.

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

HRESULT hr;

IUnknown* pIUnknown = CreateInstance();

IX* pIX = NULL;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

pIUnknown->Release();

if (SUCCEEDED(hr)) { // Скопировать pIX IX* pIX2 = pIX;

// Время жизни pIX2 «вложено» во время существования pIX // Увеличить счетчик ссылок pIX2->AddRef();

// Использовать интерфейс IX pIX->Fx();

// Сделать что-нибудь при помощи pIX pIX2->Fx();

// Конец работы с pIX pIX2->Release();

// Конец работы с IX pIX->Release();

// А также конец работы с компонентом } Представленный фрагмент не выгружает компонент до тех пор, пока клиент не освободит pIX. Клиент не освобождает pIX до тех пор, пока не закончит работу как с pIX, так и с pIX2. Поскольку компонент не выгружается, пока не освобожден pIX, постольку он гарантированно остается в памяти на протяжении всей жизни pIX2. Таким образом, нам на самом деле нет необходимости вызывать AddRef и Release для pIX2, поэтому две строки кода, выделенные полужирным шрифтом, можно сократить.

Подсчет ссылок для pIX — это все, что необходимо для удерживания компонента в памяти. Принципиально то, что время жизни pIX2 содержится внутри времени существования pIX. Чтобы подчеркнуть это, я увеличил отступы для строк, где используется pIX2. На рис. 4-2 вложение времени существования pIX и pIX2 показано в виде графика. Здесь столбиками обозначены времена жизни различных интерфейсов и время жизни самого компонента. Ось времени направлена сверху вниз. Операции, оказывающие воздействие на продолжительность жизни, перечислены в левой части рисунка. Горизонтальные линии показывают, как эти операции начинают или завершают период существования интерфейсов.

Из рис. 4-2 легко видеть, что жизни pIX2 начинается после начала жизни pIX и заканчивается до окончания жизни pIX. Таким образом, счетчик ссылок pIX будет сохранять компонент в памяти все время жизни pIX2. Если бы жизнь pIX2 не содержалась внутри жизни pIX, но перекрывалась с нею, то для pIX2 потребовалось бы подсчитывать ссылки. Например, в следующем фрагменте кода жизни pIX2 и pIX перекрываются:

HRESULT hr;

IUnknown* pIUnknown = CreateInstance();

IX* pIX = NULL;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

pIUnknown->Release();

if (SUCCEEDED(hr)) { // Скопировать pIX IX* pIX2 = pIX;

// Начало жизни pIX pIX2->AddRef();

pIX->Fx();

// Конец жизни IX pIX->Release();

pIX2->Fx();

// Конец жизни pIX pIX2->Release();

// А также конец работы с компонентом } Операция Компонент IUnknown pIX pIX CreateInstance QueryInterface pIUnknown->Release() Время pIX2 = pIX pIX2->AddRef() pIX2->Release() pIX->Release() Столбиками показаны времена жизни различных элементов Рис. 4-2 Вложенность времен жизни указателей на интерфейсы. Ссылки для указателя со вложенным временем жизни подсчитывать не требуется.

В этом примере мы обязаны вызывать AddRef для pIX2, так как pIX2 освобождается после освобождения pIX.

Графически это представлено на рис. 4-3.

IUnknown pIX pIX Операция Компонент CreateInstance QueryInterface pIUnknown->Release() Время pIX2 = pIX pIX2->AddRef() Перекрывание времен жизни pIX->Release() pIX2->Release() Столбиками показаны времена жизни различных элементов Рис. 4-3 Перекрывание времен жизни указателей на интерфейсы. Здесь надо подсчитывать ссылки на оба интерфейса.

В таких простых примерах легко определить, нужно ли подсчитывать ссылки. Однако достаточно лишь немного приблизиться к реальности, как идентифицировать вложенность времен жизни будет затруднительно. Тем не менее, иногда соотношение времен жизни по-прежнему очевидно. Один такой случай — функции. Для нижеследующего кода очевидно, что время работы foo содержится внутри времени жизни pIX. Таким образом, нет необходимости вызывать AddRef и Release для передаваемых в функцию указателей на интерфейсы.

void foo(IX* pIX2) { // Использование интерфейса IX pIX2->Fx();

} void main() { HRESULT hr;

IUnknown* pIUnknown = CreateInstance();

IX* pIX = NULL;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

pIUnknown->Release();

if (SUCCEEDED(hr)) { // Передать pIX процедуре foo(pIX);

// Завершить работу с IX pIX->Release();

// А также и с компонентом } } Внутри функции незачем подсчитывать ссылки для указателей на интерфейсы, хранящиеся в локальных переменных. Время жизни локальной переменной совпадает со временем работы функции, т.е. содержится внутри времени жизни вызывающей программы. Однако подсчет ссылок необходим при всяком копировании указателя в глобальную переменную или из нее — глобальная переменная может освободиться в любой момент и в любой функции.

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

Однако правила, представленные в следующем разделе, учитывают некоторые типичные случаи, когда пары AddRef / Release можно опустить без большой опасности внести в программу ошибку.

Правила подсчета ссылок Эти правила объединяют идеи оптимизации из предыдущего раздела с правилами подсчета ссылок, приведенными в начале главы. Читая их, помните, что клиент должен работать с каждым интерфейсом так, как если бы у того был отдельный счетчик ссылок. Следовательно, клиент должен выполнять подсчет ссылок для разных указателей на интерфейсы, хотя бы их времена жизни и были вложенными.

Правило для выходных параметров Выходной параметр (out parameter) — это параметр функции, в котором вызывающей программе возвращается некоторое значение. Функция устанавливает это значение;

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

Пример выходного значения параметра — второй параметр функции QueryInterface.

HRESULT QueryInterface(const IID&, void**);

Любая функция, возвращающая указатель на интерфейс через выходной параметр или как свое собственное возвращаемое значение, должна вызывать AddRef для этого указателя. Это то же самое правило, что и «Вызывайте AddRef перед возвратом» из начала главы, но сформулировано оно по-другому. QueryInterface следует этому правилу, вызывая AddRef для возвращаемого ею указателя на интерфейс. Наша функция создания компонентов CreateInstance также следует ему.

Правило для входных параметров Входной параметр (in parameter) — это параметр, через который функции передается некоторое значение.

Функция использует это значение, но не изменяет его и ничего не возвращает в нем вызывающей программе. В С++ такие параметры представляются константами или передаваемыми по значению аргументами функции.

Ниже указатель на интерфейс передается как входной параметр:

void foo(IX* pIX) { pIX->Fx();

} Указатель на интерфейс, переданный в функцию, не требует обращений к AddRef и Release, так как время жизни функции всегда вложено во время жизни вызывающей программы. Это правило легко запомнить, если попробовать мысленно подставить код функции в точку ее вызова. Возьмем в качестве примера следующий фрагмент:

// Автоматический вызов AddRef IX* pIX = CreateInstance();

foo(IX);

pIX->Release();

В варианте с «развернутым» кодом foo этот фрагмент имел бы вид:

// Автоматический вызов AddRef IX* pIX = CreateInstance();

// foo(pIX);

// Подстановка функции foo pIX->Fx();

pIX->Release();

После установки foo становится очевидно, что время ее жизни вложено во время жизни вызывающей программы.

Правило для параметров типа вход-выход Параметр типа вход-выход (in-out parameter) может одновременно быть и входным, и выходным. Функция использует переданное ей значение такого параметра, затем изменяет его и возвращает вызывающей программе.

Функция обязана вызвать Release для указателя на интерфейс, переданного ей как произвольный параметр, прежде чем записать на его место новый указатель. Перед возвратом в вызывающую программу функция также должна вызвать AddRef для нового значения параметра.

void ExchangeForChangedPtr(int i, IX** ppIX) { // Делаем что-нибудь с входным параметром (**ppIX)->Fx();

// Освобождаем входной параметр (**ppIX)->Release();

// Выбираем указатель из кэша *ppIX = g_Cache[i];

// Вызываем для него AddRef (**ppIX)->AddRef();

// Делаем что-нибудь с выходным параметром (**ppIX)->Fx();

} Правило для локальных переменных Локальные копии указателей на интерфейсы, конечно, существуют только во время выполнения функций и не требуют пар AddRef / Release. Это правило непосредственно вытекает из правила для входных параметров. В приведенном далее примере pIX2 гарантированно будет существовать только во время выполнения функции foo.

Таким образом, его существование вложено во время жизни указателя pIX, переданного как входной параметр, — так что вызывать AddRef или Release для pIX2 не нужно.

void foo(IX* pIX) { IX* pIX2 = pIX;

pIX2->Fx();

} Правило для глобальных переменных Если указатель на интерфейс сохраняется в глобальной переменной, то прежде чем передавать управление другой функции, необходимо вызвать AddRef. Поскольку переменная является глобальной, любая функция может вызвать Release и закончить жизнь этого указателя. Указатели на интерфейсы, сохраняемые в переменных членах, должны обрабатываться аналогично. Любая функция-член класса может изменить состояние такого указателя.

Правило для сомнительных случаев Всякий раз, когда у Вас возникает сомнение, вставляйте пару AddRef / Release. Ее отсутствие редко дает значительный выигрыш в производительности или экономию памяти, зато легко может привести к созданию компонента, который никогда не удаляется из памяти. Кроме того, Вы можете потратить много времени на поиск ошибки, вызванной неправильным подсчетом ссылок. Как обычно, с помощью профилировщика можно определить, дает ли оптимизация существенный выигрыш. Помимо этого, если Вы все же решили применить оптимизацию, обязательно пометьте указатель, для которого не выполняется подсчет ссылок, соответствующим комментарием. Другому программисту, модифицирующему Ваш код, очень легко запутаться во временах жизни и нарушить правильность оптимизированного подсчета ссылок.

Пропущенный вызов Release труднее обнаружить, чем отсутствие вызова AddRef. Программисты на С++ легко могут забыть вызвать Release или, еще хуже, попытаться использовать delete вместо Release. В гл. 10 показано, как smart-указатели могут полностью инкапсулировать подсчет ссылок.

Амуниция пожарного, резюме Методы IUnknown дают нам полный контроль над интерфейсами. Как мы видели в предыдущей главе, указатели на интерфейсы, поддерживаемые компонентом, можно получить через QueryInterface. В этой главе мы видели, как AddRef и Release управляют временами жизни полученных интерфейсов. AddRef сообщает компоненту, что мы собираемся использовать интерфейс. Release сообщает, что использование интерфейса закончено. Release также предоставляет компоненту некоторую способность управлять своим временем жизни. Клиент никогда не выгружает компонент напрямую;

вместо этого Release сигнализирует, что клиент завершил работу с интерфейсом. Если ни один из интерфейсов никем не используется, компонент может удалить себя сам.

Хотя теперь мы имеем все возможности управления интерфейсами, у нас нет одной важной составляющей компонентной архитектуры — динамической компоновки. Компонент без динамической компоновки — это все равно что пожарный без каски и плаща. В следующей главе мы добавим к нашим компонентам динамическую компоновку.

5 глава Динамическая компоновка Что же это получается? Еще в первой главе я говорил, как важна динамическая компоновка для построения системы из «кирпичиков». И вот мы добрались уже до пятой главы — и не только по-прежнему компонуем клиента с компонентом статически, но и располагаем их все время в одном и том же файле! На самом деле у меня были основательные причины отложить обсуждение динамической компоновки. Главная из них в том, что пока мы не реализовали полностью IUnknown, клиент был слишком сильно связан с компонентом.

Сначала компонент нельзя было изменить так, чтобы не потребовалось изменять и клиент. Затем при помощи QueryInterface мы перешли на следующий уровень абстракции и представили компонент как набор независимых интерфейсов. Раздробив компонент на интерфейсы, мы сделали первый шаг к тому, чтобы раздробить монолитное приложение. Затем нам понадобился способ управления временем жизни компонента. Подсчитывая ссылки на каждый интерфейс, клиент управляет их временем жизни, компонент же сам определяет, когда ему себя выгрузить. Теперь, когда мы реализовали IUnknown, клиент и компонент связаны не титановой цепью, а тонкой ниткой. Столь непрочная связь уже не мешает компоненту и клиенту изменяться, не задевая друг друга.

В этой главе мы попробуем поместить компонент в DLL. Обратите внимание — я не сказал, что мы собираемся сделать компонент DLL. Компонент — это не DLL, думать так значило бы слишком ограничивать концепцию компонента. DLL для компонента — сервер, или средство доставки. Компонент — это набор интерфейсов, которые реализованы в DLL. DLL — это грузовик, а компонент — груз.

Чтобы познакомиться с динамической компоновкой, мы посмотрим, как клиент создает компонент, содержащийся в DLL. Затем мы возьмем листинг 4-1 из гл. 4 и разобьем его на отдельные файлы для клиента и компонента. Разобрав полученный код, мы создадим три разных клиента и три разных компонента, использующие разные комбинации трех интерфейсов. Для чего все это? В качестве грандиозного финала мы сконструируем компанию клиентов и компонентов, где каждый сможет общаться с каждым.

Если Вы уже знакомы с DLL, то большая часть содержания этой главы Вам известна. Однако Вы можете полюбопытствовать, как я «растащу» клиент и компонент по разным файлам (раздел «Разбиваем монолит»).

Надеюсь, Вам понравится сочетание разных клиентов и компонентов в разделе «Связки объектов» в конце главы.

Создание компонента В этом разделе мы увидим, как компонент динамически компонуется клиентом. Мы начнем с клиента, создающего компонент. Это временная мера;

в последующих главах мы увидим, как изолировать клиент от компонента еще сильнее.

Прежде чем запросить указатель на интерфейс, клиент должен загрузить DLL в свой процесс и создать компонент. В гл. 3 функция CreateInstance создавала компонент и возвращала клиенту указатель на интерфейс IUnknown. Это единственная функция в DLL, с которой клиент должен быть скомпонован явно. Ко всем прочим функциям компонента клиент может получить доступ через указатель на интерфейс. Таким образом, чтобы клиент мог вызывать функцию CreateInstance, ее надо экспортировать.

Экспорт функции из DLL Экспорт функции из DLL осуществляется без проблем. Сначала необходимо обеспечить использование компоновки С (C linkage), пометив функцию как extern “C”. Например, функция CreateInstance в файле CMPNT1.CPP выгляди так:

// // Функция создания // extern “C” IUnknown* CreateInstance() { IUnknown* pI = (IUnknown*)(void*)new CA;

PI->AddRef();

return pI;

} Слово extern “C” в описании нужно, чтобы компилятор С++ не «довешивал» к имени функции информацию о типе. Без extern “C” Microsoft Visual C++ 5.0 превратит CreateInstance в ?CreateInstance@@YAPAUIUnknown@@XZ Другие компиляторы используют иные схемы дополнения имени информацией о типе. На дополненные имена нет стандарта, так что они не переносимы. Кроме того, работать с ними — изрядная морока.

Дамп экспортов Если Вы пользуетесь Microsoft Visual C++, то при помощи DUMPBIN.EXE можете получить листинг символов, экспортированных из DLL. Следующая команда dumpbin –exports Cmpnt1.dll генерирует для CMPNT1.DLL такие результаты:

Microsoft (R) COFF Binary File Dumper Version 4.20. Copyright (C) Microsoft Corp 1992-1996. All rights reserved.

Dump of file Cmpnt1.dll File Type: DLL Section contains the following Exports for Cmpnt1.dll 0 characteristics 325556C5 time date stamp Fri Oct 04 11:26:13 0.00 version 1 ordinal base 1 number of functions 1 number of names ordinal hint name 1 0 CreateInstance (00001028) Summary 7000.data 1000.idata 3000.rdata 2000.reloc 10000.text Конечно, чтобы экспортировать функцию, недостаточно пометить ее как extern “C”. Необходимо еще сообщить компоновщику, что функция экспортируется. Для этого надо создать надоедливый файл DEF. Файлы DEF так надоедливы потому, что очень легко позабыть внести в файл имя функции;

если же Вы об этом забыли, компоновка этой функции будет невозможна. Из-за такой забывчивости я лишился изрядной части волос.

Создавать файлы DEF очень легко. Вы можете скопировать их из примеров и изменить несколько строк. DEF файл для CMPNT1.DLL показан в листинге 5-1.

CMPNT1.DEF ;

;

Файл определения модуля для Cmpnt ;

LIBRARY Cmpnt1.dll DESCRIPTION ‘(c)1996-1997 Dale E. Rogerson’ EXPORTS CreateInstance @1 PRIVATE Листинг 5-1 В файле определения модуля перечислены функции, экспортированные динамически компонуемой библиотекой Все, что Вам нужно сделать, — перечислить экспортируемые функции в разделе EXPORTS данного файла. При желании можно назначить каждой функции порядковый номер (ordinal number). В строке LIBRARY следует указать фактическое имя DLL.

Таковы основы экспорта функций из DLL. Теперь мы посмотрим, как загрузить DLL и обратиться к функции.

Загрузка DLL Файлы CREATE.H и CREATE.CPP реализуют функцию CreateInstance. CreateInstance принимает имя DLL в качестве параметра, загружает эту DLL и пытается вызвать экспортированную функцию с именем CreateInstance.

Соответствующий код показан в листинге 5-2.

CREATE.CPP // // Create.cpp // #include // Объявление IUnknown #include #include "Create.h" typedef IUnknown* (*CREATEFUNCPTR)();

IUnknown* CallCreateInstance(char* name) { // Загрузить в процесс динамическую библиотеку HINSTANCE hComponent = ::LoadLibrary(name);

if (hComponent == NULL) { cout << "CallCreateInstance:\tОшибка: Не могу загрузить компонент" << endl;

return NULL;

} // Получить адрес функции CreateInstance CREATEFUNCPTR CreateInstance = (CREATEFUNCPTR)::GetProcAddress(hComponent, "CreateInstance");

if (CreateInstance == NULL) { cout << "CallCreateInstance:\tОшибка: " << "Не могу найти функцию CreateInstance" << endl;

return NULL;

} return CreateInstance();

} Листинг 5-2 Используя LoadLibrary и GetProcAddress, клиент может динамически компоноваться с компонентом Для загрузки DLL CreateInstance вызывает функцию Win32 LoadLibrary:

HINSTANCE LoadLibrary( // Имя файла DLL LPCTSTR lpLibFileName );

LoadLibrary принимает в качестве параметра имя файла DLL и возвращает описатель загруженной DLL. Функция Win32 GetProcAddress принимает этот описатель и имя функции (CreateInstance), возвращая адрес последней:

FARPROC GetProcAddress( // Описатель модуля DLL HMODULE hModule, // Имя функции LPCSTR lpProcName } С помощью этих двух функций клиент может загрузить DLL в свое адресное пространство и получить адрес CreateInstance. Имея этот адрес, создать компонент и получить указатель на его IUnknown не составляет труда.

CallCreateInstance приводит возвращенный указатель к типу, пригодному для использования, и, в соответствии со своим назначением, вызывает CreateInstance.

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

Почему можно использовать DLL Почему DLL можно использовать для размещения компонентов? Потому, что DLL используют адресное пространство приложения, с которым скомпонованы.

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

Клиент также должен «понимать» адреса, помещенные компонентом в vtbl. В Windows клиент может работать с vtbl, так как динамически компонуемая библиотека использует то же адресное пространство, что и он сам.

В Windows исполняющаяся программа называется процессом. Каждое приложение (EXE) исполняется в отдельном процесса, и у каждого процесса имеется свое адресное пространство в 4 Гбайт. Адрес в одном процессе отличен от того же адреса в другом процессе. Указатели не могут передаваться из одного приложения в другое, поскольку они находятся в разных адресных пространствах. Пусть у нас есть некий адрес, скажем, дом 369 по Персиковой аллее. Этот дом может оказаться как супермаркетом в Атланте, так и кофейней в Сиэтле. Если не указан город, адрес на самом деле не имеет смысла. В рамках этой аналогии процессы — это города. Указатели в двух процессах могут иметь одно и то же значение, но фактически они будут указывать на разные участки памяти.

К счастью, динамически компонуемая библиотека располагается в том же процессе, что и использующее ее приложение. Поскольку и DLL, и EXE используют один и тот же процесс, они используют одно и то же адресное пространство. По этой причине DLL часто называют серверами внутри процесса (in-proc server). В гл. 10 мы рассмотрим сервера вне процесса (out-of-proc), или локальные и удаленные серверы, которые реализуются как EXE-модули. Серверы вне процесса имеют адресные пространства, отличные от адресных пространств своих клиентов, но мы по-прежнему будем использовать DLL для поддержки связи такого сервера с его клиентом. На рис. 5-1 показано размещение DLL в адресном пространстве ее клиентского приложения.

Процесс 1 Процесс Память приложения Память приложения Память DLL 1 Память DLL 4 Гбайт 4 Гбайт Память DLL 2 Память DLL Память DLL Свободно Свободно Рис. 5-1 Динамически компонуемые библиотеки резмещаются в адресном пространстве процесса, содержащего приложение, с которым они скомпонованы Важно отметить, что после того, как клиент получил у компонента указатель на интерфейс, все, что их связывает, — это двоичная «развертка» интерфейса. Когда клиент запрашивает у компонента интерфейс, он запрашивает участок памяти определенного формата. Возвращая указатель на интерфейс, компонент сообщает клиенту, где находится этот участок. Поскольку интерфейс располагается в памяти, доступной и клиенту, и компоненту, ситуация аналогична той, когда клиент и компонент расположены в одном и том же EXE файле. С точки зрения клиента, единственное различие динамической и статической компоновки состоит в способе, которым он получает указатель на интерфейс.

В гл. 6 и 7 мы разъединим клиент и компонент, используя более общий и гибкий метод создания компонентов. В гл. 7 функция CoCreateInstance библиотеки СОМ заменит CallCreateInstance, пока же CallCreateInstance нам будет достаточно.

Разбиваем монолит Мой отец всегда подтрунивал надо мной, когда я говорил «большой гигант». Он спрашивал: «А ты уверен, что это был не маленький гигант?» Итак, специально для моего отца я разбиваю наш маленький монолит-пример на отдельные файлы. В этом разделе мы выясним, как можно разделить программу листинга 4-1 на несколько файлов, которые мы затем рассмотрим по отдельности. Файлы с этими примерами помещены в каталоге CHAP на прилагающемся диске. В этом каталоге достаточно файлов для реализации трех клиентов и трех компонентов.

На рис. 5-2 показаны файлы, содержащие по одному клиенту и компоненту.

Файлы клиента Общие файлы Файлы компонента CLIENT1.CPP IFACE.H CMPNT1.CPP CREATE.H GUIDS.CPP CMPNT1.DEF CREATE.CPP Рис. 5-2 Файлы клиента и компонента Теперь клиент находится в файле CLIENT1.CPP. Он включает файл CREATE.H и компонуется вместе с файлом CLIENT1.CPP. Эти два файла инкапсулируют создание компонента, находящегося в DLL. (Файл CREATE.CPP мы уже видели в листинге 5-2.) В гл. 7 два этих файла исчезнут, их заменят функции, предоставляемые библиотекой СОМ.

Компонент теперь размещается в файле CMPNT1.CPP. Для динамической компоновки требуется файл определения модуля, в котором перечисляются функции, экспортируемые из DLL. Это файл CMPNT1.DEF, приведенный в листинге 5-1.

Компонент и клиент используют два общих файла. Файл IFACE.H содержит объявления всех интерфейсов, поддерживаемых CMPNT1. Там же содержатся объявления для идентификаторов этих интерфейсов. Определения данных идентификаторов находятся в файле GUIDS.CPP (потерпите, о GUID мы поговорим в следующей главе).

Собрать клиент и компонент можно с помощью следующих команд:

cl Client.cpp Create.cpp GUIDS.cpp UUID.lib cl /LD Cmpnt1.cpp GUIDS.cpp UUID.lib Cmpnt1.def Однако, поскольку у нас три клиента и три компонента, я решил заранее создать для Вас make-файл. Правда, я хороший парень? И потом, я не просто создал make-файл, я попытался еще и сделать его читабельным. Я знаю, что это практически невыполнимая задача, но надеюсь, Вы без особых усилий разберетесь, что происходит в этом файле. Для того, чтобы собрать все компоненты и все клиенты, введите следующую командную строку:

nmake –f makefile Это был краткий обзор файлов примеров. Имена и назначение файлов останутся практически теми же до конца книги (хотя их содержимое и подлежит настройке перед поставкой).

Тексты программ Теперь давайте рассмотрим код, особенно клиента, поскольку по-настоящему новое и интересное находится именно там. Код, реализующий клиент, представлен в листинге 5-3. Клиент запрашивает у пользователя имя файла используемой DLL. Это имя он передает функции CallCreateInstance, которая загружает DLL и вызывает экспортированную из нее функцию CreateInstance.

CLIENT1.CPP // // Client1.cpp // Комиляция: cl Client1.cpp Create.cpp GUIDs.cpp UUID.lib // #include #include #include "Iface.h" #include "Create.h" void trace(const char* msg) { cout << "Клиент 1:\t" << msg << endl;

} // // Клиент // int main() { HRESULT hr;

// Считать имя компонента char name[40];

<< "Введите имя файла компонента [Cmpnt?.dll]: ";

cout cin >> name;

cout << endl;

// Создать компонент вызовом функции CreateInstance из DLL trace("Получить указатель на IUnknown");

IUnknown* pIUnknown = CallCreateInstance(name);

if (pIUnknown == NULL) { trace("Вызов CallCreateInstance неудачен");

return 1;

} trace("Получить интерфейс IX");

IX* pIX;

hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX);

if (SUCCEEDED(hr)) { trace("IX получен успешно");

// Использовать интерфейс IX pIX->Fx();

pIX->Release();

} else { trace("Не могу получить интерфейс IX");

} trace("Освободить интерфейс IUnknown");

pIUnknown->Release();

return 0;

} Листинг 5-3 Клиент запрашивает имя DLL, содержащей компонент. Он загружает DLL, создает компонент и работает с его интерфейсами.

В листинге 5-4 приведен код компонента. За исключением спецификации extern “C” для CreateInstance, он остался практически неизменным. Только теперь компонент находится в своем собственном файле — CMPNT1.CPP. CMPNT1.CPP компилируется с использование флажка /LD. Кроме того, он компонуется с CMPNT1.DEF, который мы уже видели в листинге 5-1.

CMPNT1.CPP // // Cmpnt1.cpp // Компиляция: cl /LD Cmpnt1.cpp GUIDs.cpp UUID.lib Cmpnt1.def // #include #include #include "Iface.h" void trace(const char* msg) { cout << "Компонент 1:\t" << msg << endl;

} // // Компонент // class CA : public IX { // Реализация IUnknown virtual HRESULT stdcall QueryInterface(const IID& iid, void** ppv);

virtual ULONG stdcall AddRef();

virtual ULONG stdcall Release();

// Реализация интерфейса IX virtual void stdcall Fx() { cout << "Fx" << endl;

} public:

// Конструктор CA() : m_cRef(0) {} // Деструктор ~CA() { trace("Ликвидировать себя");

} private:

long m_cRef;

};

HRESULT stdcall CA::QueryInterface(const IID& iid, void** ppv) { if (iid == IID_IUnknown) { trace("Возвратить указатель на IUnknown");

*ppv = static_cast(this);

} else if (iid == IID_IX) { trace("Возвратить указатель на IX");

*ppv = static_cast(this);

} else { trace("Интерфейс не поддерживается");

*ppv = NULL;

return E_NOINTERFACE;

} reinterpret_cast(*ppv)->AddRef();

return S_OK;

} ULONG stdcall CA::AddRef() { return InterlockedIncrement(&m_cRef);

} ULONG stdcall CA::Release() { if (InterlockedDecrement(&m_cRef) == 0) { delete this;

return 0;

} return m_cRef;

} // // Функция создания // extern "C" IUnknown* CreateInstance() { IUnknown* pI = static_cast(new CA);

pI->AddRef();

return pI;

} Листинг 5-4 Компонент, расположенный теперь в своем файле, практически не изменился по сравнению с гл. 4.

Теперь нам осталось взглянуть лишь на два общих файла — IFACE.H и GUIDS.CPP. В файле IFACE.H объявлены все интерфейсы, используемые клиентом и компонентом.

IFACE.H // // Iface.h // // Интерфейсы interface IX : IUnknown { virtual void stdcall Fx() = 0;

};

interface IY : IUnknown { virtual void stdcall Fy() = 0;

};

interface IZ : IUnknown { virtual void stdcall Fz() = 0;

};

// Предварительные объявления GUIDs extern "C" { extern const IID IID_IX;

extern const IID IID_IY;

extern const IID IID_IZ;

} Листинг 5-5 Объявления интерфейсов Как видите, клиент и компонент по-прежнему используют интерфейсы IX, IY и IZ. Идентификаторы этих интерфейсов объявлены в конце IFACE.H. IID будут обсуждаться в следующей главе. Определения идентификаторов интерфейсов находятся в файле GUIDS.CPP, который показан в листинге 5-6.

GUIDS.CPP // // GUIDs.cpp – Идентификаторы интерфейсов // #include extern "C" { // {32bb8320-b41b-11cf-a6bb-0080c7b2d682} extern const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8321-b41b-11cf-a6bb-0080c7b2d682} extern const IID IID_IY = {0x32bb8321, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// {32bb8322-b41b-11cf-a6bb-0080c7b2d682} extern const IID IID_IZ = {0x32bb8322, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

// extern необходим, чтобы для констант C++ была выделена память } Листинг 5-6 Идентификаторы интерфейсов определены в GUIDS.CPP. С этим файлом компонуются и клиент, и компонент.

Это были детали реализации компонента в DLL. Давайте немного поиграем с такими компонентами.

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

это Клиент 1, Клиент 2 и Клиент 3. Здесь же находится код трех компонентов, которые мы обозначим как Компонент 1, Компонент 2 и Компонент 3. Код в IFACE.H определяет три интерфейса: IX, IY и IZ. Клиент 1 и Компонент 1 поддерживают интерфейс IX. Клиент 2 и Компонент поддерживают интерфейсы IX и IY. Клиент 3 и Компонент 3 поддерживают все три интерфейса. В табл. 5- показан набор интерфейсов, поддерживаемых каждым клиентом и компонентом.

Таблица 5-1 Эта таблица показывает, какие интерфейсы поддерживаются каждым клиентом и компонентом IX IY IZ # Клиент 1 Компонент # # Клиент 2 Компонент # # # Клиент 3 Компонент Все клиенты и компоненты компилируются по команде nmake –f makefile Каждый из клиентов при запуске спрашивает, какой компонент он должен использовать. Введите имя компонента и нажмите . Клиент с соответствующим партнером. Затем он запросит у компонента каждый известный ему интерфейс. Если компонент поддерживает интерфейс, клиент вызовет функцию этого интерфейса.

В противном случае клиент сломается.

Я хотел просто посмотреть, не заснули ли Вы. Клиент не сломается, а компонент напечатает симпатичное маленькое сообщение о том, что не поддерживает интерфейс. Ниже приведен пример работы Клиента 2 и Компонентом 2 и Клиента 3 с Компонентом 1.

C:\client Введите имя файла компонента [Cmpnt?.dll]: cmpnt2.dll Клиент 2: Получить указатель на IUnknown Компонент 2: Возвратить указатель на IUnknown Клиент 2: Получить интерфейс IX Компонент 2: Возвратить указатель на IX Клиент 2: IX получен успешно Fx Клиент 2: Получить интерфейс IY Компонент 2: Возвратить указатель на IY Клиент 2: IY получен успешно Fy Клиент 2: Освободить интерфейс IUnknown Компонент 2: Ликвидировать себя C:\client Введите имя файла компонента [Cmpnt?.dll]: cmpnt1.dll Клиент 3: Получить указатель на IUnknown Клиент 3: Получить интерфейс IX Компонент 1: Возвратить указатель на IX Клиент 3: IX получен успешно Fx Клиент 3: Получить интерфейс IY Компонент 1: Интерфейс не поддерживается Клиент 3: Не могу получить интерфейс IY Клиент 3: Получить интерфейс IZ Компонент 1: Интерфейс не поддерживается Клиент 3: Не могу получить интерфейс IZ Клиент 3: Освободить интерфейс IUnknown Компонент 1: Ликвидировать себя Компонент 2 реализует все интерфейсы, нужные клиенту 2. Компонент 1 реализует только IX, тогда как Компоненту 3 нужны все три интерфейса: IX, IY и IZ. Попробуйте другие комбинации компонентов и клиентов.

Вам понравилось? По-моему, это замечательно. Мы успешно создали архитектуру, которая позволяет подключать друг к другу компоненты и клиенты во время выполнения. Подозреваю, что Вы хотите пойти это отметить, так что я закругляюсь.

Негибкое связывание, резюме В этой главе мы добавили нашим компонентам одно свойство — динамическую компоновку. Поместив компоненты в DLL, мы можем заменять их во время выполнения. Как Вы видели из примеров, один клиент может легко работать с разными компонентами без перекомпоновки или перекомпиляции. Динамическая компоновка в сочетании с хорошо спроектированными интерфейсами может обеспечить создание невероятно гибких приложений, которые будут эволюционировать с течением времени.

Как бы ни были гибки наши компоненты, по-прежнему остается один момент, в котором гибкости не хватает, — момент создания. CallCreateInstance требует, чтобы клиент знал имя DLL, в которой реализован компонент. Имя DLL — это деталь реализации, которую нам хотелось бы скрыть от клиента. Компонент должен быть способен изменить имя DLL, в которую он погружен, и не повлиять на клиентов. Хотелось бы также поддерживать в одной DLL несколько компонентов. Эти вопросам и посвящены следующие две главы.

6 глава HRESULT, GUID, Реестр и другие детали Дух братьев Райт все еще жив. Каждый год сотни людей в своих гаражах строят самолеты из наборов «Сделай сам». Они делают не пластиковые игрушки, радиоуправляемые модели или легковесные матерчатые конструкции. Они строят современные двухместные самолеты с полностью закрытой кабиной из современнейших композитных материалов. По правилам FAA* достаточно, чтобы производитель набора выполнил только 49% всей работы по постройке самолета. Оставшийся 51% конструктор-любитель делает сам.

Постройка 51% самолета занимает, в зависимости от модели, примерно от 250 до 5000 часов. Большинство производителей предлагают наборы «для быстрого приготовления», в которых многие части уже собраны, например, сварены рамы и пропитаны детали из композитных материалов. Используя такие заготовки, можно быстро сделать нечто, похожее на самолет. Однако это будет еще далеко не настоящий самолет. Куча времени уходит на разные мелочи — установку панели управления и приборов, сидений, ремней безопасности, огнетушителей, покрытия, сигнализации, табличек, кабелей управления, электропроводки, лампочек, батарей, брандмауэров, вентиляционных люков, крыши пилотской кабины, отопителя, окон, замков и ручек на дверях и еще многого другого.

Многие энтузиасты самолетостроения приходят в уныние, разочаровываются и даже бросают это занятие, потратив на сборку многие часы. Точно так же многие начинают изучать сложный предмет, например СОМ, лишь затем, чтобы захлебнуться в деталях и все бросить. В первых пяти главах книги я пытался максимально избегать подробностей, чтобы Вы сосредоточились на общей картине. В этой главе я собираюсь обсудить некоторые их тех деталей, которые раньше пропускал или скрывал. Я хочу рассмотреть и другие детали, которые понадобятся нам в следующих главах.

Сначала мы обсудим HRESULT — тему, впервые возникшую в гл. 3 в связи с QueryInterface. Затем мы рассмотрим GUID. Один из примеров GUID — структура IID, передаваемая QueryInterface. После обсуждения этих типов мы познакомимся с тем, как компоненты публикуют в Реестре данные о своем местонахождении (это позволяет клиентам находить и создавать компоненты). В заключение мы рассмотрим некоторые полезные функции и утилиты библиотеки СОМ.

HRESULT Во всех самолетах есть приборы, и самодельные самолеты — не исключение. Хотя в некоторых таких самолетах роль приборов играет компьютер с цветным графическим дисплеем (иногда даже «под» Windows NT), обычно ставят что-нибудь подешевле. Металлическая полоса, например, — простейший индикатор скорости. Чем быстрее Вы летите, тем сильнее она изгибается.

Хотя приборы и могут сообщить в деталях, что происходит с самолетом и отдельными системами, их основное назначение — предупреждать пилота об опасности. На индикаторе скорости есть красная полоска, отмечающая слишком высокую (или низкую) скорость. Часто приборы снабжаются аварийными лампочками и зуммерами.

У компонентом СОМ нет приборов. Вместо шкал или лампочек для сообщений о текущем состоянии дел они используют HRESULT. QueryInterface возвращает HRESULT. И, как мы увидим в оставшейся части книги, большинство функций интерфейсов СОМ также возвращает HRESULT. Хотя из названия HRESULT можно было бы заключить, что это описатель (handle) результата, на самом деле это не так. HRESULT — это 32-разрядное значение, разделенное на три поля. Значение полей, составляющих HRESULT, поясняет рис. 6-1. Название возникло по историческим причинам;

просто расшифровывайте его как «вот результат» (here’s the result), а не «описатель результата» (handle of result).

* Federal Aviation Agency, Федеральное авиационное агентство США. — Прим. перев.

Определенные системой значения HRESULT содержатся в заголовочном файле Win32 WINERROR.H. В начале файла расположены коды ошибок Win32, так что его нужно пролистать, чтобы добраться до HRESULT.

HRESULT похож на код ошибки Win32, но это не одно и то же, и смешивать их не следует.

Старший бит HRESULT, как показано на рис. 6-1, отмечает, успешно или нет выполнена функция. Это позволяет определить много кодов возврата и для успеха, и для неудачи. Последние 16 битов содержат собственно код возврата. Остальные 15 битов содержат дополнительную информацию о типе и источнике ошибки.

Признак критичности 15 битов 16 битов Средство Код возврата 31 30 16 15 Рис. 6-1 Формат HRESULT В табл. 6-1 приведены наиболее часто используемые коды. По соглашению в названиях успешных кодов содержится S_, а в названиях кодов ошибок — E_.

Таблица 6-1 Распространенные значения HRESULT Название Значение S_OK Функция отработала успешно. В некоторых случаях этот код также означает, что функция возвращает логическую истину.

Значение S_OK равно NOERROR То же, что S_OK S_FALSE Функция отработала успешно и возвращает логическую ложь.

Значение S_FALSE равно E_UNEXPECTED Неожиданная ошибка E_NOIMPL Метод не реализован E_NOINTERFACE Компонент не поддерживает запрашиваемый интерфейс.

Возвращается QueryInterface E_OUTOFMEMORY Компонент не может выделить требуемый объем памяти E_FAIL Ошибка по неуказанной причине Обратите внимание, что значение S_FALSE равно 1, а значение S_OK — 0. Это противоречит обычной практике программирования на С/С++, где 0 — это ложь, а не-0 — истина. Поэтому при использовании HRESULT обязательно явно сравнивайте коды возврата с S_FALSE или S_OK.

Пятнадцать битов — с 30-го по 16-й — содержат идентификатор средства (facility). Он указывает, какая часть операционной системы выдает данный код возврата. Поскольку операционную систему разрабатывает Microsoft, она зарезервировала право определения идентификаторов средств за собой. Идентификаторы средств, определенные в настоящее время, приведены в табл. 6-2.

Таблица 6-2 Идентификаторы средств, определенные в настоящее время FACILITY_WINDOWS FACILITY_STORAGE FACILITY_SSPI FACILITY_RPC FACILITY_Win32 FACILITY_CONTROL FACILITY_NULL FACILITY_ITF FACILITY_DISPATCH FACILITY_CERT Идентификатор средства освобождает, например, разработчиков Microsoft, занятых RPC (FACILITY_RPC), от необходимости согласовывать значения кодов возврата с теми, кто работает над управляющими элементами ActiveX (FACILITY_CONTROL). Поскольку группы разработчиков используют разные идентификаторы средств, коды возврата разных средств не будут конфликтовать. Разработчикам специализированных интерфейсов повезло меньше.

Все идентификаторы средств, кроме FACILITY_ITF, задают определенные СОМ универсальные коды возврата.

Эти коды всегда и везде одни и те же. FACILITY_ITF — исключение;

ему отвечают коды, специфичные для данного интерфейса. Чтобы определить средство для данного HRESULT, используйте макрос HRESULT_FACILITY, определенный в WINERROR.H. Как Вы увидите в разделе «Определение собственных кодов возврата», коды FACILITY_ITF не уникальны и могут иметь разные значения в зависимости от интерфейса, возвратившего код. Но прежде чем определять собственные коды, давайте рассмотрим использование HRESULT.

Поиск HRESULT Как уже отмечалось, определение всех кодов состояния СОМ (и OLE — точнее, уже ActiveX), генерируемых системой в настоящее время, содержится в WINERROR.H. Обычно коды заданы как шестнадцатеричные числа;

запись для E_NOINTERFACE выглядит так:

// MessageID: E_NOINTERFACE // // MessageText:

// // Данный интерфейс не поддерживается* // #define E_NOINTERFACE 0x80004002L Однако если идентификатор средства HRESULT равен FACILITY_WIN32, Вы можете не найти его среди других.

Часто это будет код ошибки Win32, преобразованный в HRESULT. Чтобы найти его значение, отыщите код ошибки Win32, совпадающий с последними 16 битами. Пусть, например, интерфейс возвращает код ошибки 0x80070103. Число 7 в середине — это идентификатор средства FACILITY_WIN32. В файле WINERROR.H Вы не найдете этот код там, где перечислены другие HRESULT. Поэтому переведите последние 16 битов из шестнадцатеричного представления в двоичное;

получится число 259, которое уже можно найти в списке кодов Win32.

// MessageID: ERROR_NO_MORE_ITEMS // // MessageText:

// // Больше элементов нет // #define ERROR_NO_MORE_ITEMS 259L Искать HRESULT в WINERROR.H вполне допустимо, когда мы пишем код. Однако нашим программам необходим способ получить сообщение об ошибке, соответствующее данному HRESULT, и отобразить его пользователю. Для отображения сообщений о стандартных ошибках СОМ (а также ActiveX, ранее OLE, и Win32) можно использовать API Win32 FormatMessage:

void ErrorMessage(LPCTSTR str, HRESULT hr) { void* pMsgBuf;

::FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, NULL, hr, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&pMsgBuf, 0, NULL );

// Отобразить строку cout << str << “\r\n”;

cout << “Error (” << hex << hr << “): ” << (LPTSTR)pMsgBuf << endl;

* В WINERROR это сообщение, как Вы могли догадаться, приведено по-английски. — Прим. перев.

// Освободить буффер LocalFree(pMsgBuf);

} Использование HRESULT Как видите, использовать HRESULT несколько сложнее, чем обычные булевы коды возврата. Среди потенциально чреватых осложнениями особенностей можно назвать:

!" множественность кодов как успешного, так и ошибочного завершения;

!" тот факт, что коды ошибок могут изменяться.

Множественность кодов завершения Как правило, в зависимости от обстоятельств функции возвращают различные коды как успешного, так и ошибочного завершения. Именно поэтому мы использовали SUCCEEDED и FAILED. Для проверки успешного завершения нельзя сравнивать HRESULT с каким-либо одним кодом, например S_OK;

равно как и для проверки неудачного завершения HRESULT нельзя сравнивать с каким-то одним кодом, например E_FAIL. Иными словами, нельзя писать:

HRESULT hr = CreateInstance(...);

// Не делайте так!

if (hr == E_FAIL) return;

hr = pI->QueryInterface(...);

// Не делайте так!

if (hr == S_OK) { pIX->Fx();

pIX->Release();

} pI->Release();

Вместо этого надо использовать макросы SUCCEEDED и FAILED.

HRESULT hr = CreateInstance(...);

if (FAILED(hr)) return;

hr = pI->QueryInterface(...);

if (SUCCEEDED(hr)) { pIX->Fx();

pIX->Release();

} pI->Release();

Коды ошибок могут изменяться После того, как Ваш клиент закончен, другие разработчики могут определить новые коды ошибок для HRESULT, с которыми столкнется клиент. Поскольку компоненты, используемые клиентом, могут меняться, могут изменяться и возвращаемые ими коды ошибок. Предположим, мы пишем компонент как сервер внутри процесса.

Некоторое время спустя мы решили модернизировать его, сделав удаленным сервером на другой машине. Первая версия компонента не возвращала никаких кодов ошибок сети, тогда как вторая версия может это делать. Клиент не может заранее знать обо всех возможных ошибках, поэтому он должен быть готов к обработке неожиданных ошибок. Обрабатывайте все неожиданные ошибки так же, как E_UNEXPECTED.

С кодами успешного окончания этой проблемы нет. Набор этих кодов для Вашей функции должен быть статичным. Коды успешного завершения — часть интерфейса и поэтому не могут изменяться. Клиент, использующий интерфейс, должен быть способен понять, предсказать и обработать все возможные случаи успешного завершения, поскольку ему надо будет продолжать работу. Клиенту нет необходимости обрабатывать все возможные коды ошибок — он не обязан продолжать работу, если ему встретился неожиданный код.

HRESULT и сеть Часто связь с удаленной машиной по сети неожиданно прерывается. Если клиент работает с удаленным компонентом, он должен уметь элегантно обрабатывать разрыв сетевого соединения. Это означает, что у каждого вызова функции, который может выполняться по сети, должен быть некий способ индикации разрыва связи. По этой причине все методы, которые могут выполняться на удаленной машине, должны возвращать HRESULT. Избегайте других типов возвращаемого значения, например:

double GetCordLength(double BladeSection);

Вместо этого возвращайте из функции HRESULT, а все результаты передавайте через выходные параметры:

HRESULT GetCordLength(/* in */ double BladeSection, /* out */ double* pLength);

HRESULT передает клиенту информацию, необходимую для обнаружения сетевых ошибок. Вызовы функций в Автоматизации (ранее OLE Автоматизация) удовлетворяют этому требованию. Более подробно удаленные компоненты будут рассмотрены в гл. 10.

Определение собственных кодов ошибки СОМ определяет универсальные коды возврата, таки как S_OK и E_UNEXPECTED. Разработчики интерфейсов ответственны за коды возврата, специфичные для их интерфейсов. HRESULT, содержащий специфичный для интерфейса код возврата, должен также содержать идентификатор средства FACILITY_ITF. Он указывает клиенту, что код специфичен для данного интерфейса.

Хотя смысл кода возврата, отмеченного с помощью FACILITY_ITF, специфичен для возвращающего его интерфейса, само по себе соответствующее число не уникально — возможны только 216 разных значений. Тысячи разработчиков пишут свои компоненты СОМ со своими кодами возврата. Все такие коды помечены с помощью FACILITY_ITF. Поэтому не просто с очень большой вероятностью, но и с гарантией разные интерфейсы придадут разный смысл одним и тем же кодам возврата. Тридцати двух разрядов недостаточно, чтобы дать каждому разработчику ввести свой собственный идентификатор средства, а большая длина HRESULT снизила бы эффективность. В качестве кодов возврата GUID не являются разумной альтернативой длинным целым значениям, поскольку размер GUID слишком велик. Однако, поскольку FACILITY_ITF отмечает каждый код возврата как специфичный для интерфейса, постольку такой код возврата связан с идентификатором интерфейса (IID).

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

Например, предположим, что первый клиент вызывает функцию IX::Fx, которая затем вызывает IY::Fy. Если IY::Fy возвращает HRESULT с FACILITY_ITF, то IX::Fx не может передать этот код первому клиенту. Данный клиент знает только о IX — и будет полагать, что HRESULT относится к IX, а не IY. Следовательно, IX::Fx должна транслировать возвращаемые IY значения HRESULT с FACILITY_ITF в такие значения, которые понятны первому клиенту. Для неизвестных ошибок у IX нет иного выбора, кроме как возвращать E_UNEXPECTED. Для кодов успешного завершения IX должен возвращать свои собственные, документированные коды возврата.

Вот некоторые основные правила определения собственных HRESULT:

!" Не назначайте кодам возврата значения из диапазона 0x0000 — 0x01FF. Они зарезервированы для кодов FACILITY_ITF, определенных СОМ.

!" Не возвращайте клиенту коды с признаком FACILITY_ITF без изменения.

!" Используйте универсальные коды успеха и ошибки СОМ всегда, когда только возможно.

!" Избегайте определения собственных HRESULT;

вместо этого используйте выходные параметры Вашей функции.

Теперь, когда Вы получили некоторое представление о HRESULT, создадим полный код при помощи макроса MAKE_HRESULT. По заданному признаку критичности, идентификатору средства и коду завершения MAKE_HRESULT создает HRESULT. Вот два примера:

MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 512);

MAKE_HRESULT(SEVERITY_SUCCESS, FACILITY_ITF, 513);

По соглашению нестандартным кодам завершения дается в качестве префикса имя компонента или интерфейса.

Например, двум приведенным выше кодам можно было бы дать имена AIRPLANE_E_LANDINGWITHGEARUP HELICOPTER_S_ROTORRPMGREEN Сказанного о HRESULT более чем достаточно. Теперь пора снять завесу таинственности с GUID.

GUID В США всем обычным летательным аппаратам FAA присваивает N-номер (N number), который идентифицирует самолет, — как номерной знак идентифицирует Вашу машину. Этот номер уникален для каждого самолета и используется пилотом в переговорах с авиадиспетчерами. В этом разделе мы обсудим GUID, которые являются такими «опознавательными знаками» компонентов и интерфейсов.

В гл. 3 я предложил Вам представлять себе IID как константу, идентифицирующую данный интерфейс. Однако, как Вы могли видеть из определения IID_IX, IID — это константа особого рода:

extern const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

На самом деле IID представляет собой тип, определенный как структура длинной 128 битов (16 байтов) под названием GUID. GUID — аббревиатура Globally Unique IDentifier (глобально уникальный идентификатор;

произносится как «гуид» — как первая часть в слове geoduck1 и последняя — в druid).

Зачем нужен GUID?

Почему мы используем GUID, а не длинное целое (long integer)? С помощью длинных целых можно однозначно задать 232 интерфейсов. Я сильно сомневаюсь, что большее их число когда либо понадобится. Однако настоящая проблема не в том, сколь много интерфейсов мы сможем однозначно задать, но в том, как гарантировать уникальность идентификатора интерфейса. Если два идентификатора совпадают, клиент легко может получить от QueryInterface неверный указатель на интерфейс. Проблема усложняется тем, что компоненты создаются разработчиками по всему земному шару. Если Сара в Ако и Линн в Таксоне разрабатывают новые интерфейсы СОМ, то как им удостовериться, что идентификаторы интерфейсов не будут конфликтовать? Можно было бы договориться о чем-нибудь вроде N-номеров летательных аппаратов и учредить некое центральное агентство, наподобие FAA, для выделения идентификаторов. Централизованная организация подходит для относительно ограниченного числа летательных аппаратов;

но я сомневаюсь, что какое-нибудь агентство смогло бы столь же успешно, как FAA, работать с тем количеством интерфейсов, которое необходимо для средней программы.

Для GUID есть более удачное решение. Уникальный GUID можно сгенерировать программно, без какой-либо координирующей организации. Microsoft Visual C++ предоставляет для генерации GUID две программы — утилиту командной строки UUIDGEN.EXE и диалоговую программу на VC++, GUIDGEN.EXE. Если я сейчас запущу UUIDGEN.EXE, то получу строку, представляющую некоторый GUID:

{166769E1-88E8-11CF-A6BB-0080C7B2D692} При всяком новом запуске UUIDGEN получается иной GUID. Если Вы запустите UUIDGEN на своей машине, то получите GUID, отличный от моего. Если миллионы (я надеюсь) людей, читающих эту книгу, сейчас запустят UUIDGEN, они получат миллион разных GUID.

Исходный текст GUIDGEN.EXE можно найти в примерах программ Microsoft Visual C++. Но я и так могу сказать Вам, как работает эта программа: она просто вызывает функцию библиотеки СОМ Microsoft CoCreateGuid, которая вызывает функцию RPC UuidCreate.

Теория GUID GUID по определению уникален «в пространстве и во времени». Для обеспечения «географической» уникальности каждый GUID использует 48-битовое значение, уникальное для компьютера, на котором он генерируется. Обычно в качестве такого значения берется адрес сетевой платы. Такой подход гарантирует, что любой GUID, полученный на моем компьютере, будет отличаться от любого, сгенерированного на Вашем компьютере. Для тех компьютеров, в которых не установлен сетевой адаптер, используется другой алгоритм генерации уникальных значений. В каждом GUID 60 битов отведено для указания времени. Туда заносится число 100-наносекундных интервалов, прошедших с 00:00:00:00 15 октября 1582 года. Используемый в настоящее время алгоритм генерации GUID начнет выдавать повторяющиеся значения примерно в 3400 году.

(Я подозреваю, что очень немногие из нынешних программ, за исключением некоторых на Фортране, еще будут использоваться в 3400 году;

но я верю, что к этому времени уже выйдет Windows 2000.) GUID придумали толковые ребята из Open Software Foundation (OSF);

правда, они использовали термин UUID (Universally Unique IDentifiers — вселенски уникальные идентификаторы). UUID разработали для использования в среде распределенных вычислений (DCE, Distributed Computing Environment). Вызовы удаленных процедур (RPC) DCE используют UUID для идентификации вызываемого, т.е. практически затем же, зачем и мы.

Нормальные люди произносят это как «gooey duck». Программисты же говорят «GUI duck».

Дополнительно о генерации UUID или GUID можно прочитать в CAE Specification X/Open DCE: Remote Procedure Call.

Объявление и определение GUID Поскольку размер GUID велик (128 битов), не хотелось бы, чтобы они повторялись в нашем коде повсюду. В гл.

5 GUID определялись в файле GUIDS.CPP примерно так:

extern const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

Объявлены они были в файле IFACE.H так:

extern “C” const IID IID_IX;

Ввести для GUID два файла, один с определениями, а другой с объявлениями — изрядная морока. Чтобы определить и объявить GUID одним оператором, используйте макрос DEFINE_GUID, который определен в OBJBASE.H. Для использования DEFINE_GUID генерируйте GUID с помощью GUIDGEN.EXE. Эта программа генерирует GUID в различных форматах — выберите второй из них. Этот формат используется в следующем примере.

// {32bb8320-b41b-11cf-a6bb-0080c7b2d682} DEFINE_GUID(<>, {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

Вставьте сгенерированный GUID в заголовочный файл. Замените <> идентификатором, используемым в Вашем коде, — например, IID_IX:

// {32bb8320-b41b-11cf-a6bb-0080c7b2d682} DEFINE_GUID(IID_IX, {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

В соответствии с определением в OBJBASE, DEFINE_GUID генерирует что-то вроде:

extern “C” const GUID IID_IX;

Однако, если после OBJBASE.H включить заголовочный файл INITGUID.H, макрос DEFINE_GUID будет раскрываться так:

extern “C” const IID IID_IX = {0x32bb8320, 0xb41b, 0x11cf, {0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}};

Механизм работы этих заголовочных файлов представлен на рис. 6-2. Заголовок IFACE.H использует макрос DEFINE_GUID для объявления IID_IX. Идентификатор IID_IX определен в файле GUIDS.H. Он определен там потому, что заголовочный файл INITGUID.H включен после OBJBASE.H и перед IFACE.H. С другой стороны, в файле CMPNT.CPP IID_IX объявлен но не определен, поскольку заголовочный файл INITGUID.H здесь не включен.

Так как я старался сделать примеры в книге максимально ясными, то DEFINE_GUID я в них не использовал, но явно определял используемые GUID.

GUIDS.CPP IID_IX определяется, #include так как INITGUID.H #include включен #include "Iface.h" IFACE.H DEFINE_GUID(IID_IX, 0x32bb8320, 0xb41b, 0x11cf, 0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82);

CMPNT.CPP IID_IX объявляется, #include так как INITGUID.H #include "Iface.h" не включен (здесь идет код) Рис. 6-2 Включение INITGUID.H заставляет макрос DEFINE_GUID определить GUID Сравнение GUID Для сравнения GUID в OBJBASE.H определен operator==:

inline BOOL operator ==(const GUID& guid1, const GUID& guid2) { return !memcmp(&guid1, &guid2, sizeof(GUID));

} Нам уже приходилось использовать эту операцию в QueryInterface. Если Вы не любите упрятывать истинный код во внешние простенькие операторы, OBJBASE.H дает определения эквивалентных по смыслу функций IsEqualGUID, IsEqualIID и IsEqualCLSID.

Использование GUID в качестве идентификаторов компонентов Помимо уникальной идентификации интерфейсов, GUID используется и для уникальной идентификации компонентов. В гл. 5 мы определили для создания компонентов функцию CallCreateInstance. Параметром этой функции служит строка с именем DLL, в которой содержится компонент:

IUnknown* CallCreateInstance(char* name);

В следующей главе мы заменим эту функцию на функцию библиотеки СОМ CoCreateInstance. Последняя использует для идентификации компонента не строку, а GUID. Такой GUID в СОМ называется идентификатором класса. Чтобы отличать идентификаторы классов от IID, для них используют тип CLSID.

Передача GUID по ссылке Поскольку размер GUID 16 байтов, мы будем передавать их не по значению, а по ссылке. Именно поэтому параметром QueryInterface является ссылка на константу. Если для Вас утомительно все время писать const IID& можете использовать эквивалентное выражение REFID. Точно так же для передачи идентификаторов классов можно использовать REFCLSID, а для передачи GUID — REFGUID.

Теперь давайте рассмотрим, как компоненты регистрируются в системе (чтобы клиенты смогли их найти и использовать).

Реестр Windows FAA ведет реестр всех летательных аппаратов, включая самодельные. По этому реестру можно определить, кто хозяин самолета. В этой главе мы рассмотрим чем-то похожий реестр, позволяющий определить, какой DLL принадлежит данный компонент.

В гл. 5 при создании компонента мы передавали функции CallCreateInstance имя файла соответствующей DLL. В следующей главе мы собираемся заменить CallCreateInstance функцией библиотеки СОМ CoCreateInstance. Для идентификации компонента CoCreateInstance вместо имени файла использует CLSID (по нему определяется имя файла DLL). Компоненты помещают имена своих файлов, индексированные CLSID, в Реестр Windows.

CoCreateInstance отыскивает имя файла, используя CLSID как ключ.

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

клиенты могут искать там нужные компоненты. Но прежде чем поместить свою информацию в Реестр, надо узнать, как он устроен.

Организация Реестра Реестр имеет иерархическую структуру. Каждый ее элемент называется разделом (key). Раздел может включать в себя набор подразделов, набор именованных параметров и/или один безымянный параметр — параметр по умолчанию (default value). Подразделы, но не параметры, могут содержать другие подразделы и параметры.

Параметры могут быть разного типа, но чаще всего мы будем записывать в Реестр строки. Структура Реестра показана на рис. 6-3.

Редактор Реестра Реестр содержит очень много информации. По счастью, нас интересует лишь малое подмножество. Лучше всего изучать Реестр, запустив Редактор Реестра — Windows-программу, позволяющую просматривать и редактировать записи. Эта программа называется REGEDT32.EXE в Windows NT и REGEDIT.EXE в Windows 95*. Одно предостережение: редактируя Реестр, чрезвычайно легко повредить систему, так что будьте осторожны.

Корень Именованный параметр Именованный параметр Параметр по Раздел умолчанию Именованный параметр Параметр по Раздел умолчанию Раздел Именованный параметр Параметр по Раздел умолчанию Раздел Рис. 6-3 Структура Реестра Windows Необходимый минимум СОМ использует только одну ветвь дерева данных Реестра: HKEY_CLASSES_ROOT. Ниже HKEY_CLASSES_ROOT отыщите раздел CLSID. В этом разделе перечислены CLSID всех компонентов, установленных в системе. CLSID хранится в Реестре как строка формата {xxxxxxxx-xxxx-xxxx-xxxx xxxxxxxxxxxx}. Искать CLSID в Реестре — занятие не слишком привлекательное. Поэтому в каждом разделе CLSID параметр по умолчанию задает «дружественное» имя компонента.

Пока в разделе каждого CLSID нас интересует только один подраздел — InprocServer32. Его параметр по умолчанию — имя файла DLL. Название InprocServer32 используется потому, что DLL — это сервер в процессе (in-proc);

она загружается в процесс клиента и предоставляет ему сервисы. На рис. 6-4 показан пример ветви CLSID Реестра.

Как видно из рисунка, в разделе Реестра HKEY_CLASSES_ROOT\CLSID хранится CLSID компонента Tail Rotor Simulator. Дружественное имя зарегистрировано как параметр по умолчанию для CLSID компонента. Подраздел InprocServer32 содержит имя файла DLL — C:\Helicopter\TailRotor.dll.

Имя файла и CLSID — две наиболее важные составляющие данных Реестра. Для многих компонентов СОМ ничего больше и не потребуется. Однако в некоторых случаях нужна дополнительная информация.

Другие детали Реестра Давайте совершим краткую экскурсию по подразделам HKEY_CLASSES_ROOT. Мы уже знакомы с CLSID, и далее мы рассмотрим, какая дополнительная информация для классов хранится в этом подразделе. В начале HKEY_CLASSES_ROOT Вы можете видеть группу расширений имен файлов, зарегистрированных разными программами. После расширений следует множество других имен. По большей части это так называемые ProgID — что расшифровывается как программный идентификатор (program identifier). Мы поговорим о ProgID немного ниже. Некоторые из имен — не ProgID, а специальные разделы реестра, похожие на CLSID. Эти разделы связывают GUID с некоторыми другими данными, например, именами файлов. Такие разделы перечислены ниже.

!" AppID — Подразделы данного раздела связывают APPID (application identifier — идентификатор приложения) с именем удаленного сервера. Этот раздел использует DCOM и будет обсуждаться в гл. 10.

* В Windows NT 4.0 также имеется программа REGEDIT.EXE — Прим. перев.

!" Component Categories — Эта ветвь Реестра связывает CATID (component category ID — идентификатор категории компонентов) с соответствующей категорией. Категории компонентов рассматриваются ниже.

!" Interface — Данный раздел связывает IID с информацией, специфичной для интерфейса. Эта информация нужна в основном для доступа к интерфейсу «через границы» процессов. Мы рассмотрим этот раздел в гл. 10.

!" Licenses — Раздел Licenses хранит лицензии на право использования компонентов СОМ. В этой книге лицензии рассматриваться не будут.

!" TypeLib — Помимо других данных, библиотеки типа содержат информацию о параметрах функций членов интерфейсов. Этот раздел связывает LIBID с именем файла, в котором хранится библиотека типа.

Библиотеки типов будут обсуждаться в гл. 11.

Мой компьютер HKEY_CLASSES_ROOT Первыми перечислены зарегистрированные расширения имен файлов CLSID Дружественное имя компонента {00000300-0000-0000-C000-000000000046} StdOleLink InprocServer32 ole32.dll Местоположение компонента Дружественное имя компонента {166769E1-88E8-11CF-A6BB-0080C7B2D682} Tail Rotor Simulator InprocServer32 C:\Helicopter\TailRotor.dll Местоположение компонента Рис. 6-4 Структура подраздела CLSID Реестра ProgID Теперь рассмотрим ProgID более подробно. Большая часть подразделов в ветви Реестра HKEY_CLASSES_ROOT — это ProgID. ProgID отображает «дружественную», понятную программисту строку в CLSID. Некоторые языки программирования, такие как Visual Basic, идентифицируют компоненты по ProgID, а не по CLSID.

Уникальность ProgID не гарантируется, поэтому существует принципиальная опасность конфликта имен. Однако с ProgID легче работать. (Кроме того, некоторые языки программирования не поддерживают структур, и в них пришлось бы использовать строковое представление GUID.) Соглашение об именовании ProgID По соглашению ProgID имеет следующий формат:

<Программа>.<Компонент>.<Версия> Вот несколько примеров из Реестра:

Visio.Application. Visio.Drawing. RealAudio.ReadAudio ActiveX Control (32-bit). Office.Binder. MSDEV.APPLICATION JuiceComponent.RareCat. Но этот формат — лишь соглашение, а не жесткое правило, и в Реестре на моей машине полно компонентов, которые ему не следуют.

Во многих случаях клиента не интересует версия компонента, к которой он подключается. Таким образом, у компонента часто имеется ProgID, не зависящий от версии. Этот ProgID связывается с самой последней версией компонента из установленных в системе. Соглашение об именовании не зависящих от версии ProgID сводится к отбрасыванию номера версии. Пример такого ProgID, следующего соглашению, — MSDEV.APPLICATION.

ProgID в Реестре ProgID и не зависящий от версии ProgID компонента приводятся в разделе CLSID. Однако основное назначение ProgID — обеспечить получение соответсвующего CLSID. Просматривать все разделы CLSID для поиска ProgID было бы неэффективно. В связи с этим ProgID указывается непосредственно и в разделе HKEY_CLASSES_ROOT.

ProgID не предназначены для представления конечным пользователям, поэтому по умолчанию значение любого раздела ProgID — дружественное для пользователя имя. В разделе ProgID имеется подраздел с именем CLSID, который содержит CLSID компонента в качестве значения по умолчанию. Не зависящий от версии ProgID также приводится непосредственно в разделе HKEY_CLASSES_ROOT. У него есть дополнительный подраздел CurVer, содержащий ProgID текущей версии компонента.

На рис. 6-5 представлен расширенный пример с рис. 6-4, включающий ProgID. В раздел CLSID компонента добавлен раздел с именем ProgID, и в него помещено значение Helicopter.TailRotor.1 — ProgID компонента. Не зависящий от версии ProgID сохранен в разделе VersionIndependentProgID. В данном примере не зависящий от версии ProgID — Helicopter.TailRotor.

HKEY_CLASSES_ROOT CLSID {166769E1-88E8-11CF-A6BB-0080C7B2D682} Модель хвостового винта InprocServer32 C:\Helicopter\TailRotor.dll ProgID Helicopter.TailRotor. Не зависящий от VesionIndependentProgID Helicopter.TailRotor версии ProgID Helicopter.TailRotor Модель хвостового винта CLSID {166769E1-88E8-11CF-A6BB-0080C7B2D682} CurVer Helicopter.TailRotor. Helicopter.TailRotor.1 Модель хвостового винта ProgID CLSID {166769E1-88E8-11CF-A6BB-0080C7B2D682} Рис. 6-5 Организация разделов Реестра, в которых содержится информация, имеющая отношение к ProgID На рисунке также показаны отдельные разделы Helicopter.TailRotor и Helicopter.TailRotor.1, расположенные непосредственно в HKEY_CLASSES_ROOT. В разделе Helicopter.TailRotor.1 имеется единственный подраздел — CLSID, который содержит CLSID компонента. Не зависящий от версии ProgID Helicopter.TailRotor содержит подразделы CLSID и CurVer. Значение по умолчанию подраздела CurVer — ProgID текущей версии компонента, Helicopter.TailRotor.1.

От ProgID к CLSID После того, как Вы поместили в Реестр нужную информацию, получить CLSID по ProgID и наоборот легко.

Библиотека СОМ предоставляет две функции — CLSIDFromProgID и ProgIDFromCLSID, — которые производят необходимые манипуляции с Реестром:

CLSID clsid;

CLSIDFromProgID(“Helicopter.TailRotor”, &clsid);

Саморегистрация Каким образом информация о компоненте попадает в Реестр Windows? Так как DLL знает о содержащемся в ней компоненте, она может поместить эту информацию в Реестр. Но, поскольку DLL ничего не делает сама по себе, Вам следует экспортировать следующие две функции:

STDAPI DllRegisterServer();

STDAPI DllUnregisterServer();

STDAPI определен в OBJBASE.H как #define STDAPI EXTERN_C HRESULT STDAPICALLTYPE что раскрывается в extern “C” HRESULT stdcall С помощью программы REGSVR32.EXE эти функции можно вызвать для регистрации компонента. Эта вездесущая утилита, вероятно, уже есть на Вашем компьютере. В примерах программ ряда последующих глав этой книги make-файлы будут вызывать REGSVR32.EXE для регистрации соответствующих компонентов.

Большинство программ установки вызывают DllRegisterServer в процессе своей работы. Для этого нужно просто загрузить DLL с помощью LoadLibrary, получить адрес функции с помощью GetProcAddress и потом, наконец, вызвать функцию.

Реализация DllRegisterServer Реализация DllRegisterServer — простой код обновления Реестра. Win32 содержит множество функций, добавляющих и удаляющих разделы Реестра. Для регистрации наших компонентов и удаления их из Реестра понадобятся только шесть функций:

RegOpenKeyEx RegCreateKeyEx RegSetValueEx RegEnumKeyEx RegDeleteKey RegCloseKey Об этих функциях много написано в других книгах, поэтому я не собираюсь детально рассматривать их здесь.

Чтобы использовать эти функции, включите в Ваш исходный файл WINREG.H и WINDOWS.H и скомпонуйте программу с ADVAPI32.LIB. Увидеть эти функции в действии Вы сможете в файлах REGISTRY.H и REGISTRY.CPP из примера следующей, седьмой главы.

Категории компонентов Минималистский взгляд на Реестр Windows состоит в том, что это длинный список CLSID, с каждым из которых связано имя файла. Клиент может просмотреть эти CLSID и выбрать подходящий компонент. Но как клиент определяет, какой именно компонент следует использовать? Один из вариантов — вывести список дружественных имен компонентов и предоставить пользователю выбирать. Однако пользователю вряд ли понравится, если, выбрав компонент из длинного списка, он в итоге узнает, что тот не работает. Загружать каждый из компонентов, упомянутых в Реестре, и запрашивать у них необходимые нам интерфейсы — слишком затяжное мероприятие. Надо как-то уметь определять, поддерживает ли компонент нужные интерфейсы, до создания экземпляра этого компонента.

Решение этой проблемы дают категории компонентов (component categories). Категория компонентов — это набор интерфейсов, которым присвоен CLSID, называемый в данном случае CATID. Компоненты, реализующие все интерфейсы некоторой категории, могут зарегистрироваться как члены данной категории. Это позволяет клиентам более осмысленно выбирать компоненты из реестра, рассматривая только те, которые принадлежат к некоторой категории.

Категория компонентов — тоже своего рода договор между компонентом и клиентом. Регистрируя себя в некоторой категории, компонент тем самым гарантирует, что поддерживает все входящие в категорию интерфейсы. Категории могут использоваться для типизации компонентов. Использование категорий аналогично использованию абстрактных базовых классов в С++. Абстрактный базовый класс — это набор функций, которые производный класс обязан реализовать;

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

Компонент может входить в произвольное число категорий. Компонент не обязан поддерживать исключительно те интерфейсы, которые определены категорией;

он может поддерживать любой интерфейс в дополнение к ним.

Одно из применений категорий — задание набора интерфейсов, которые компонент обязан поддерживать.

Альтернативой служит задание набора интерфейсов, которые компонент требует от своего клиента. Компоненту для нормальной работы могут потребоваться от клиента некоторые сервисы. Например, трехмерному графическому объекту для работы может потребоваться определенная графическая библиотека (graphic engine).

Реализация категорий компонентов Самое приятное в категориях компонентов то, что для их использования Вам не нужно возиться с Реестром самостоятельно. В системах Windows имеется стандартный Диспетчер категорий компонентов (Component Category Manager), который проделает за Вас всю работу. Этот Диспетчер (CLSID_StdComponentCategoryMgr) — стандартный компонент СОМ, реализующий два интерфейса, ICatRegister и ICatInformation. ICatRegister используется для регистрации и удаления категорий. Он также может использоваться для добавления и удаления компонентов к категории. ICatInformation применяется для получения информации о категориях в системе. С помощью этого интерфейса Вы можете найти:

!" все категории, зарегистрированные в системе;

!" все компоненты, принадлежащие данной категории;

!" все категории, к которым принадлежит данный компонент.

Более полная документация Диспетчера категорий компонентов содержится на прилагающемся к книге диске.

Поищите ICatRegister и ICatInformation в файле ACTIVEX.MVB.

С помощью Диспетчера категорий легко добавлять и удалять категории. Использование Диспетчера показано в примере программы из этой главы, который можно найти на диске. Программа выдает список зарегистрированных в системе категорий компонентов, добавляет новую категорию и, наконец, удаляет эту категорию. Если у Вас эта программа не работает, то возможно, что на Вашем компьютере не установлены некоторые файлы. В прилагаемом к примеру файле README указаны файлы, которые могут отсутствовать, и поясняется, как их установить.

Даже если Вам не нужны категории компонентов, данный пример все равно представляет интерес, так как это первый случай использования нами компонента СОМ, реализованного кем-то другим.

OleView Редактор Реестра показывает Реестр «в чистом виде», что полезно для изучения. Вы должны знать организацию Реестра, чтобы реализовать самостоятельно регистрирующиеся компоненты или клиентов, которые будут опрашивать Реестр. Однако если Вам нужна дополнительная информация об установленных на компьютере компонентах, использование Редактора Реестра может потребовать слишком много времени. Ведь он, по существу, показывает все данные в виде списка CLSID.

Другая программа из Win32 SDK — OleView — представляет информацию на более высоком уровне. Вместо длинного списка CLSID и других GUID OleView отображает деревья, содержащие элементы с дружественными именами. Кроме того, OleView позволяет просматривать категории компонентов, установленных в системе. Для изучения лучше всего запустить OleView и поработать. Я использовал эту программу для проверки моего кода саморегистрации. Если OleView может найти информацию, то, скорее всего, эта информация помещена в правильное место.

Pages:     | 1 || 3 | 4 |   ...   | 5 |



© 2011 www.dissers.ru - «Бесплатная электронная библиотека»

Материалы этого сайта размещены для ознакомления, все права принадлежат их авторам.
Если Вы не согласны с тем, что Ваш материал размещён на этом сайте, пожалуйста, напишите нам, мы в течении 1-2 рабочих дней удалим его.