Delphi и COM

Анатолий Тенцер

Delphi

   Введение

   Базовые понятия

      Интерфейс

      Автоматическое управление памятью и подсчет ссылок

      Объявление интерфейсов

      IUnknown

      Реализация интерфейсов

      Реализация интерфейсов (расширенное рассмотрение)

      Интерфейсы и TComponent

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

      Использование интерфейсов для реализации Plug-In

      COM-сервер, структура и использование

         COM-сервер

            Сервер в виде DLL

            Сервер в виде исполнимого файла

         Регистрация сервера

         Потоки и «комнаты»

               STA

               MTA

            Передача интерфейсов и параметров

            Инициализация COM

            Активация сервера

         Создание COM-сервера

            Сервер без библиотеки типов

            Сервер с библиотекой типов

         Создание Plug-In в виде COM-сервера

         Автоматическая регистрация серверов из своей программы

      OLE Automation

         IDispatch

         Поддержка IDispatch, тип данных Variant

         Dispinterface

         DualInterfaces

      Создание Automation-серверов

         События в COM

         Создание Automation- сервера (продолжение)

         Создание обработчика событий COM

Delphi и COM

Введение

COM (Component Object Model) — модель объектных компонентов — одна из основных технологий, на которых основывается Windows. Более  того, все новые технологии в Windows (Shell, Scripting, поддержка HTML и т.п.) реализуют свои API именно в виде COM-интерфейсов. Таким образом, в настоящее время профессиональное программирование требует понимания модели COM и умения с ней работать. В этой главе мы рассмотрим основные понятия COM и особенности их поддержки в Delphi.

Базовые понятия

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

Интерфейс

Интерфейс, образно говоря,  является «контрактом» между программистом и компилятором.

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

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

Объявление интерфейса включает в себя описание методов и их параметров, но не включает их реализации. Кроме того, в объявлении может указываться идентификатор интерфейса — уникальное 16-байтовое число, сгенерированное по специальным правилам, гарантирующим его статистическую уникальность (GUID — Global Unique Identifier).

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

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

• Интерфейс не является классом. Класс может выступать реализацией интерфейса, но класс содержит код методов на конкретном языке программирования, а интерфейс — нет.
• Интерфейс строго типизирован. Как клиент, так и реализация интерфейса должны использовать точно те же методы и параметры, что указаны в описании интерфейса.
• Интерфейс является «неизменным контрактом». Нельзя определять новую версию того же интерфейса с измененным набором методов (или их параметров), но с тем же идентификатором.

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

Реализация интерфейса — это код, который реализует эти методы. При этом, за несколькими исключениями, не накладывается никаких ограничений на то, каким образом будет выглядеть реализация. Физически реализация представляет собой массив указателей на методы, адрес которого и используется в клиенте для доступа к COM-объекту. Любая реализация интерфейса имеет метод QueryInterface, позволяющий запросить ссылку на конкретный интерфейс из числа реализуемых.

Автоматическое управление памятью и подсчет ссылок

Кроме предоставления независимого от языка программирования доступа к методам объектов, COM реализует автоматическое управление памятью для COM-объектов. Оно основано на идее подсчета ссылок на объект. Любой клиент, желающий использовать COM-объект после его создания, должен вызвать заранее предопределенный метод, который увеличивает внутренний счетчик ссылок на объект на единицу. По завершении использования объекта клиент вызывает другой его метод, уменьшающий значение этого же счетчика. По достижении счетчиком ссылок нулевого значения COM-объект автоматически удаляет себя из памяти. Такая модель позволяет клиентам не вдаваться в подробности реализации объекта, а объекту — обслуживать несколько клиентов и корректно очистить память по завершении работы с последним из них.

Объявление интерфейсов

Для поддержки интерфейсов Delphi расширяет синтаксис языка Pascal дополнительными ключевыми словами. Объявление интерфейса в Delphi реализуется ключевым словом interface:

type
     IMyInterface = interface
     ['{412AFF00-5C21-11D4-84DD-C8393F763A13}']
       procedure DoSomething(var I: Integer); stdcall;
       function DoSomethingAnother(S: String): Boolean;
     end;

  IMyInterface2 = interface(IMyInterface)
   ['{412AFF01-5C21-11D4-84DD-C8393F763A13}']
     procedure DoAdditional(var I: Integer); stdcall;
   end;

Для генерации нового значения GUID в IDE Delphi служит сочетание клавиш Ctrl+Shift+G.

IUnknown

Базовым интерфейсом в модели COM является IUnknown. Любой интерфейс наследуется от IUnknown и обязан реализовать объявленные в нем методы. IUnknown объявлен в модуле System.pas следующим образом:

type
     IUnknown = interface
       ['{00000000-0000-0000-C000-000000000046}']
       function QueryInterface(const IID: TGUID; out Obj): HResult;    stdcall;
       function _AddRef: Integer; stdcall;
       function _Release: Integer; stdcall;
     end;

Рассмотрим назначение методов IUnknown более подробно.

Последние два метода предназначены для реализации механизма подсчета ссылок.

function _AddRef: Integer; stdcall;

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

function _Release: Integer; stdcall;

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

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

function QueryInterface(const IID: TGUID; out Obj): HResult; stdcall;

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

1. возвращает ссылку на него в параметре Obj;
2. вызывает метод _AddRef полученного интерфейса;
3. возвращает 0.

В противном случае — функция возвращает код ошибки E_NOINTERFACE.

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

В модуле System.pas объявлен класс TInterfacedObject, реализующий IUnknown и его методы. Рекомендуется использовать этот класс для создания реализаций своих интерфейсов.

Кроме того, поддержка интерфейсов реализована в базовом классе TObject. Он имеет метод

function TObject.GetInterface(const IID: TGUID; out Obj): Boolean;

Если класс реализует запрошенный интерфейс, то функция:

1. возвращает ссылку на него в параметре Obj;
2. вызывает метод _AddRef полученного интерфейса;
3. возвращает TRUE.

В противном случае — функция возвращает FALSE.

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

Реализация интерфейсов

Реализацией интерфейса в Delphi всегда выступает класс. Для этого в объявлении класса необходимо указать, какие интерфейсы он реализует.

type
   TMyClass = class(TComponent, IMyInterface, IDropTarget)
     // Реализация методов
   end;

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

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

Рассмотрим более подробный пример.

type
   ITest = interface
   ['{61F26D40-5CE9-11D4-84DD-F1B8E3A70313}']
     procedure Beep;
   end;
 
 

  TTest = class(TInterfacedObject, ITest)
     procedure Beep;
     destructor Destroy; override;
   end;

…

procedure TTest.Beep;
 begin
   Windows.Beep(0,0);
 end;

destructor TTest.Destroy;
 begin
   inherited;
   MessageBox(0, 'TTest.Destroy', NIL, 0);
 end;

Здесь класс TTest реализует интерфейс ITest. Рассмотрим использование интерфейса из программы.

procedure TForm1.Button1Click(Sender: TObject);
 var
   Test: ITest;
 begin
   Test := TTest.Create;
   Test.Beep;
 end;

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

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

Во-вторых, код не содержит никаких попыток освободить память, выделенную под объект TTest. Тем не менее, если выполнить эту программу, на экран будет выведено сообщение о том, что деструктор был вызван. Это происходит потому, что при выходе переменной, ссылающейся на интерфейс, за область видимости (либо при присвоении ей другого значения) компилятор Delphi генерирует код для вызова метода _Release, информируя реализацию о том, что ссылка на нее больше не нужна.

 

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

Так, следующий код приведет к ошибке в момент выхода из функции:

var
   Test: ITest;
   T: TTest;
 begin
   T := TTest.Create;
   Test := T;
   Test.Beep;
   T.Free;
 end;   // в этот момент произойдет ошибка

Если вы хотите уничтожить реализацию интерфейса немедленно, не дожидаясь выхода переменной за область видимости, – просто присвойте ей значение NIL:

var
   Test: ITest;
   T: TTest;
 begin
   T := TTest.Create;
   Test := T;
   Test.Beep;
   Test := NIL;  // Неявно вызывается IUnknown._Release;
 end;

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

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

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

Например, следующий код будет успешно откомпилирован, но при выполнении вызовет ошибку «Interface not supported»:

var
   Test: ITest;
 begin
   Test := TInterfacedObject.Create as ITest;
   Test.Beep;
 end;

В то же время код

var
   Test: ITest;
 begin
   Test := TTest.Create as ITest;
   Test.Beep;
 end;

будет успешно компилироваться и выполняться.

Реализация интерфейсов (расширенное рассмотрение)

Рассмотрим вопросы реализации интерфейсов подробнее.

Объявим два интерфейса:

type
   ITest = interface
   ['{61F26D40-5CE9-11D4-84DD-F1B8E3A70313}']
     procedure Beep;
   end;

  ITest2 = interface
   ['{61F26D42-5CE9-11D4-84DD-F1B8E3A70313}']
     procedure Beep;
   end;

Теперь создадим класс, который будет реализовывать оба этих интерфейса:

  TTest2 = class(TInterfacedObject, ITest, ITest2)
     procedure Beep1;
     procedure Beep2;
     procedure ITest.Beep = Beep1;
     procedure ITest2.Beep = Beep2;
   end;

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

Если реализация методов TTest2.Beep1 и TTest2.Beep2 идентична, то можно не создавать два разных метода, а объявить класс следующим образом:

  TTest2 = class(TInterfacedObject, ITest, ITest2)
     procedure MyBeep;
     procedure ITest.Beep = MyBeep;
     procedure ITest2.Beep = MyBeep;
   end;

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

type
   TBeeper = class
     procedure Beep;
   end;

  TMessager = class
     procedure ShowMessage(const S: String);
   end;

  TTest3 = class(TInterfacedObject, ITest, IAnotherTest)
   private
     FBeeper: TBeeper;
     FMessager: TMessager;
     property Beeper: TBeeper read FBeeper implements ITest;
     property Messager: TMessager read FMessager implements IAnotherTest;
   public
     constructor Create;
     destructor Destroy; override;
   end;

Для делегирования реализации интерфейса другому классу служит ключевое слово implements.

{ TBeeper }
 
 procedure TBeeper.Beep;
 begin
   Windows.Beep(0,0);
 end;

{ TMessager }
 
 procedure TMessager.ShowMessage(const S: String);
 begin
   MessageBox(0, PChar(S), NIL, 0);
 end;

{ TTest3 }
 
 constructor TTest3.Create;
 begin
   inherited;
   // Создаем экземпляры дочерних классов
   FBeeper := TBeeper.Create;
   FMessager := TMessager.Create;
 end;

destructor TTest3.Destroy;
 begin
   // Освобождаем экземпляры дочерних классов
   FBeeper.Free;
   FMessager.Free;
   inherited;
 end;

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

Обращаться к полученному классу можно точно так же, как и к любому классу, реализующему интерфейсы:

var
   Test: ITest;
   Test2: IAnotherTest;
 begin
   Test2 := TTest3.Create;
   Test2.ShowMessage('Hi');
   Test := Test2 as ITest;
   Test.Beep;
 end;

Интерфейсы и TComponent

В базовом классе VCL TComponent имеется полный набор методов, позволяющих реализовать интерфейс IUnknown, хотя сам класс данный интерфейс не реализует. Это позволяет наследникам TComponent реализовывать интерфейсы, не заботясь о реализации IUnknown. Однако методы TComponent._AddRef и TComponent._Release на этапе выполнения программы не реализуют механизм подсчета ссылок, и, следовательно, для классов-наследников TComponent, реализующих интерфейсы, не действует автоматическое управление памятью. Это позволяет запрашивать у них интерфейсы, не опасаясь, что объект будет удален из памяти при выходе переменной за область видимости. Таким образом, следующий код совершенно корректен и безопасен:

type
   IGetData = interface
   ['{B5266AE0-5E77-11D4-84DD-9153115ABFC3}']
     function GetData: String;
   end;

  TForm1 = class(TForm, IGetData)
   private
     function GetData: String;
   end;

…

var
   I: Integer;
   GD: IGetData;
   S: String;
 begin
   S := '';
   for I := 0 to Pred(Screen.FormCount) do begin
     if Screen.Forms[I].GetInterface(IGetData, GD) then
       S := S + GD.GetData + #13;
   end;
   ShowMessage(S);
 end;

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

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

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

В качестве примера рассмотрим MDI-приложение, имеющее много различных форм и единую панель инструментов. Предположим, что на этой панели инструментов имеются команды «Сохранить», «Загрузить» и «Очистить», однако каждое из окон реагирует на эти команды по-разному.

Создадим модуль с объявлениями интерфейсов:

unit ToolbarInterface;
 
 interface
 
 type
   TCommandType = (ctSave, ctLoad, ctClear);
   TCommandTypes = set of TCommandType;
   TSaveType = (stSave, stSaveAS);
 
   IToolBarCommands = interface
   ['{B5266AE1-5E77-11D4-84DD-9153115ABFC3}']
     function SupportedCommands: TCommandTypes;
     function Save(AType: TSaveType): Boolean;
     procedure Load;
     procedure Clear;
   end;
 
 implementation
 
 end.

Интерфейс IToolBarCommands описывает набор методов, которые должны реализовать формы, поддерживающие работу с панелью кнопок. Метод SupportedCommands возвращает список поддерживаемых формой команд.

Создадим три дочерние формы — Form2, Form3 и Form4 — и установим им свойство FormStyle = fsMDIChild.

Form2 умеет выполнять все три команды:

type
   TForm2 = class(TForm, IToolBarCommands)
   private
     function SupportedCommands: TCommandTypes;
     function Save(AType: TSaveType): Boolean;
     procedure Load;
     procedure Clear;
   end;
 
 

{ TForm2 }  

procedure TForm2.Clear;
 begin
   ShowMessage('TForm2.Clear');
 end;

procedure TForm2.Load;
 begin
   ShowMessage('TForm2.Load');
 end;

function TForm2.Save(AType: TSaveType): Boolean;
 begin
   ShowMessage('TForm2.Save');
   Result := TRUE;
 end;

function TForm2.SupportedCommands: TCommandTypes;
 begin
   Result := [ctSave, ctLoad, ctClear]
 end;

Form3 умеет выполнять только команду Clear:

type
   TForm3 = class(TForm, IToolBarCommands)
   private
     function SupportedCommands: TCommandTypes;
     function Save(AType: TSaveType): Boolean;
     procedure Load;
     procedure Clear;
   end;
 
 

{ TForm3 }  

procedure TForm3.Clear;
 begin
   ShowMessage('TForm3.Clear');
 end;

procedure TForm3.Load;
 begin
   // Метод ничего не делает, но должен присутствовать
   // для корректной реализации интерфейса
 end;  

function TForm3.Save(AType: TSaveType): Boolean;
 begin
 end;

function TForm3.SupportedCommands: TCommandTypes;
 begin
   Result := [ctClear]
 end;

И наконец, Form4 вообще не реализует интерфейс IToolBarCommands и не откликается ни на одну команду.

На главной форме приложения поместим ActionList и создадим три компонента TAction. Кроме того, разместим на ней TToolBar и назначим ее кнопкам соответствующие TAction.

type
   TForm1 = class(TForm)
     ToolBar1: TToolBar;
     ImageList1: TImageList;
     ActionList1: TActionList;
     acLoad: TAction;
     acSave: TAction;
     acClear: TAction;
     tbSave: TToolButton;
     tbLoad: TToolButton;
     tbClear: TToolButton;
     procedure acLoadExecute(Sender: TObject);
     procedure ActionList1Update(Action: TBasicAction;
       var Handled: Boolean);
     procedure acSaveExecute(Sender: TObject);
     procedure acClearExecute(Sender: TObject);
   end;

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

procedure TForm1.ActionList1Update(Action: TBasicAction;
   var Handled: Boolean);
 var
   Supported: TCommandTypes;
   TC: IToolBarCommands;
 begin
   if Assigned(ActiveMDIChild)
      and ActiveMDIChild.GetInterface(IToolBarCommands, TC) then
     Supported := TC.SupportedCommands
   else
     Supported := [];
   acSave.Enabled := ctSave in Supported;
   acLoad.Enabled := ctLoad in Supported;
   acClear.Enabled := ctClear in Supported;
 end;

При активизации команд проверяется наличие активной дочерней формы, у нее запрашивается интерфейс IToolBarCommands и вызывается соответствующий ему метод:

procedure TForm1.acLoadExecute(Sender: TObject);
 var
   TC: IToolBarCommands;
 begin
   if Assigned(ActiveMDIChild)
      and ActiveMDIChild.GetInterface(IToolBarCommands, TC) then
     TC.Load;
 end;

procedure TForm1.acSaveExecute(Sender: TObject);
 var
   TC: IToolBarCommands;
 begin
   if Assigned(ActiveMDIChild)
      and ActiveMDIChild.GetInterface(IToolBarCommands, TC) then
     if not TC.Save(stSaveAS) then
       ShowMessage(‘Not Saved !!!’);
 end;

procedure TForm1.acClearExecute(Sender: TObject);
 var
   TC: IToolBarCommands;
 begin
   if Assigned(ActiveMDIChild)
      and ActiveMDIChild.GetInterface(IToolBarCommands, TC) then
     TC.Clear;
 end;

Работа программы представлена на рисунке.

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

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

Использование интерфейсов для реализации Plug-In

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

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

Объявим интерфейсы модуля расширения и внутреннего API программы.

unit PluginInterface;
   
   interface
   
   type
     IAPI = interface
     ['{64CFF1E0-61A3-11D4-84DD-B18D6F94141F}']
       procedure ShowMessage(const S: String);
     end;
   
 

  ILoadFilter = interface
   ['{64CFF1E1-61A3-11D4-84DD-B18D6F94141F}']
     procedure Init(const FileName: String; API: IAPI);
     function GetNextLine(var S: String): Boolean;
   end;
 
 implementation
 
 end.

Этот модуль должен использоваться как в Plug-In, так и в основной программе и гарантирует использование ими идентичных интерфейсов.

Plug-In представляет собой DLL, экспортирующую функцию CreateFilter, возвращающую ссылку на интерфейс ILoadFilter. Главный модуль сначала должен вызвать метод Init, передав в него имя файла и ссылку на интерфейс внутреннего API, а затем вызывать метод GetNextLine до тех пор, пока он не вернет FALSE.

Рассмотрим код модуля расширения:

library ImpTxt;
   
   uses
     ShareMem, SysUtils, Classes, PluginInterface;
   
   {$R *.RES}
   
   type
     TTextFilter = class(TInterfacedObject, ILoadFilter)
     private
       FAPI: IAPI;
       F: TextFile;
       Lines: Integer;
       InitSuccess: Boolean;
       procedure Init(const FileName: String; API: IAPI);
       function GetNextLine(var S: String): Boolean;
     public
       destructor Destroy; override;
     end;
   { TTextFilter }
   
   procedure TTextFilter.Init(const FileName: String; API: IAPI);
   begin
     FAPI := API;
     {$I-}
     AssignFile(F, FileName);
     Reset(F);
     {$I+}
     InitSuccess := IOResult = 0;
     if not InitSuccess then
       API.ShowMessage('Ошибка инициализации загрузки');
   end;

Метод Init выполняет две задачи: сохраняет ссылку на интерфейс API главного модуля для дальнейшего использования и пытается открыть файл с данными. Если файл открыт успешно – выставляется внутренний флаг InitSuccess.

function TTextFilter.GetNextLine(var S: String): Boolean;
   begin
     if InitSuccess then begin
       Inc(Lines);
       Result := not Eof(F);
       if Result then begin
         Readln(F, S);
         FAPI.ShowMessage('Загружено ' + IntToStr(Lines)    + ' строк.');
       end; 
     end else
       Result := FALSE;
   end;

Метод GetNextLine считывает следующую строку данных и возвращает либо TRUE, если это удалось, либо FALSE — в случае окончания файла. Кроме того, при помощи API, предоставляемого главным модулем, данный метод информирует пользователя о ходе загрузки.

destructor TTextFilter.Destroy;
   begin
     FAPI := NIL;
     if InitSuccess then

    CloseFile(F);
   inherited;
 end;

В деструкторе мы обнуляем ссылку на API главного модуля, уничтожая его, и закрываем файл.

function CreateFilter: ILoadFilter;
   begin
     Result := TTextFilter.Create;
   end;

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

exports
     CreateFilter;  // Функция должна быть экспортирована из DLL
   
   begin
   end. 

Теперь полученную DLL можно использовать из основной программы.

type
     TAPI = class(TInterfacedObject, IAPI)
       procedure ShowMessage(const S: String);
     end;
   
   
 

{ TAPI }
 
 procedure TAPI.ShowMessage(const S: String);
 begin
   with (Application.MainForm as TForm1).StatusBar1 do begin
     SimpleText := S;
     Update;
   end;
 end;

Класс TAPI реализует API, предоставляемый модулю расширения. Функция ShowMessage выводит сообщения модуля в Status Bar главной формы приложения.

type
     TCreateFilter = function: ILoadFilter;
   
   procedure TForm1.LoadData(FileName: String);
   var
     PluginName: String;
     Ext: String;
     hPlugIn: THandle;
     CreateFilter: TCreateFilter;
     Filter: ILoadFilter;
     S: String;
   begin

Подготавливаем TMemo к загрузке данных:

  Memo1.Lines.Clear;
     Memo1.Lines.BeginUpdate;

Получаем имя модуля с фильтром для выбранного расширения файла. Описания модулей хранятся в файле plugins.ini в секции Filters в виде строк формата:

 <расширение> = <имя модуля>, например:

[Filters]
 TXT=ImpTXT.DLL

  try
     Ext := ExtractFileExt(FileName);
     Delete(Ext, 1, 1);
     with TIniFile.Create(ExtractFilePath(ParamStr(0)) + 'plugins.ini') do
     try
       PlugInName := ReadString('Filters', Ext, '');
     finally
       Free;
     end;

Теперь попытаемся загрузить модуль и найти в нем функцию CreateFilter:

    hPlugIn := LoadLibrary(PChar(PluginName));
       try
         CreateFilter := GetProcAddress(hPlugIn, 'CreateFilter');
         if Assigned(CreateFilter) then begin

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

        Filter := CreateFilter;
         try
           Filter.Init(FileName, TAPI.Create);

Загружаем данные при помощи созданного фильтра:

          while Filter.GetNextLine(S)    do
               Memo1.Lines.Add(S);

Перед выгрузкой DLL из памяти необходимо обязательно освободить ссылку на интерфейс Plug-In, иначе это произойдет по выходе из функции и вызовет Access Violation.

        finally
             Filter := NIL;
           end;
         end else raise Exception.Create('Не могу загрузить    фильтр');

Выгружаем DLL и обновляем TMemo:

    finally
         FreeLibrary(hPlugIn);
       end;
     finally
       Memo1.Lines.EndUpdate;
     end;
   end;

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

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

 

Внимание! Поскольку в EXE и DLL используются длинные строки, не забудьте включить в список uses обоих проектов модуль ShareMem. Другим вариантом решения проблемы передачи строк является использование типа данных WideString. Для них распределением памяти занимается OLE, причем делает это независимо от модуля, из которого была создана строка.