Переменные типа ссылки

Синтаксис объявления переменной-ссылки (далее просто ссылки) следующий:

<ссылка> = <имя-ссылки> : <тип-ссылки> [ new | noAuto ];

<имя-ссылки> - имя переменной-ссылки.

<имя-ссылки> = <идентификатор>

<тип-ссылки> - тип переменной-ссылки определяется интерфейсом, на который переменная может ссылаться:

<тип-ссылки> = <vip-интерфейс>
  | <obj-интерфейс> [ (<vip-интерфейс-инициализации>) ]
  | objRef

<vip-интерфейс> - имя vip-интерфейса, ссылка на который может храниться в переменной.

<vip-интерфейс> = <идентификатор>

<obj-интерфейс> - имя obj-интерфейса, ссылка на который может храниться в переменной.

<obj-интерфейс> = <идентификатор>

<vip-интерфейс-инициализации> - автоматическая инициализация ссылки на obj-интерфейс значением ссылки на vip-интерфейс. Тот факт, что указанный vip-интерфейс реализует нужный obj-интерфейс проверяется во время компиляции. Если на момент исполнения vip-интерфейс не найден, то выдаётся ошибка.

<vip-интерфейс-инициализации> = <идентификатор>

objRef - абстрактная ссылка. Это ссылка на произвольный vip или obj-интерфейс. Ссылке такого типа можно присвоить ссылку произвольного типа, и наоборот (см. Пример 2).

new - переменная инициализируется ссылкой на индивидуальный экземпляр интерфейса. Индивидуальный экземпляр создается каждый раз, когда запрашивается ссылка такого рода. Для получения ссылок на индивидуальные экземпляры используются функции LoadVipInterface и LoadVipRef.

Если опция new не указана, то переменная инициализируется ссылкой на разделяемый vip-интерфейс. Разделяемый экземпляр всегда один (для данной среды исполнения), сколько бы ссылок на него не запрашивалось; ссылки на разделяемые экземпляры запрашиваются с помощью функций GetVipInterface и GetVipRef.

noAuto - выключить автоинициализацию. Такие переменные необходимо инициализировать самостоятельно.

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

Если не указана опция noAuto, то происходит автоматическая инициализация переменной. Автоматическая инициализация происходит в момент первого использования переменной (присвоения, приведения типа, вызова метода, использования в фактических параметрах функций и т.д.).

В случае непосредственной передачи автоинициализируемой ссылки в NullVipRef автоинициализация не происходит. Под непосредственной передачей понимается явная передача ссылки в эту функцию. Если ссылка в функцию NullVipRef передаётся неявно (как результат вычисления функции, свойства объекта и пр.), автоинициализация происходит. См. пример 2 в конце раздела.

Выгрузка копии интерфейса и освобождение ссылки (деинициализация) выполняются функцией FreeVipInterface. С помощью функции NullVipRef можно проверить - инициализирована ли переменная типа ссылки.

Для всех переменных типа ссылки поддерживается автоматическое освобождение ссылки при выходе из области существования переменной. Автоматическое освобождение равносильно вызову функции FreeVipInterface.

Для всех экземпляров (и разделяемых, и индивидуальных) Vip-интерфейсов ведется подсчет количества активных ссылок. Счетчик ссылок увеличивается каждый раз, когда значение ссылки помещается в переменную. Счетчик ссылок уменьшается каждый раз, когда значение ссылки теряется - либо в результате присвоения другого значения ссылки, либо при выходе переменной из области существования, либо в результате явного освобождания ссылки с помощью функции FreeVipInterface.

В качестве нулевой ссылки используется константа NullRef. Нулевая ссылка имеет абстрактный тип, поэтому ее можно присваивать ссылке на любой интерфейс. Присвоение NullRef любой проинициализированной переменной типа ссылки аналогично вызову FreeVipInterface. NullRef также можно передавать в качестве фактического параметра функции. См. также Пример 3.

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

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

ExObjIfcNoInit - при попытке вызова метода с использованием переменной типа ссылки на объектный интерфейс, которая не была проинициализирована (а такая переменная не может быть проинициализирована автоматически);
ExObjIfcNoLoad - при попытке автоматической инициализации переменной типа ссылки на VIP-интерфейс, если этот Vip-интерфейс не может быть найден ни в списке загруженных, ни в одном из подключенных ресурсов;
ExObjIfcNoImpl - при вызове функций LoadVipRef и GetVipRef, если указанный VIP-интерфейс не реализует запрошенный объектный интерфейс;
ExObjIfcBadVar - при попытке использования переменной типа ссылки на VIP-интерфейс с функциями LoadVipRef или GetVipRef, и при попытке использования переменной типа ссылки на объектный интерфейс с функциями LoadVipInterface или GetVipInterface.

Ограничения для переменной типа ссылки:

переменная типа ссылки на VIP-интерфейс может быть присвоена другой переменной типа ссылки на интерфейс. При этом обе ссылки должны быть на один и тот же интерфейс;
ссылка может участвовать в операции сравнения с другой ссылкой (сравнения на равенство и неравенство, остальные варианты сравнения не имеют смысла). Ссылки считаются равными в том, и только в том случае, если они ссылаются на одну и ту же загруженную копию интерфейса;
ссылка не может быть явно или неявно приведена ни к какому числовому или строковому типу. Как следствие - такая переменная не может участвовать в арифметических и строковых выражениях;
переменная типа ссылки на VIP-интерфейс не может быть описана как глобальная (в файле проекта или вне тела VIP-интерфейса), а также в секциях .var и .fields в шаблонах форм (до версии 5.0);
Переменные типа ссылки (как и других сложных типов) не могут быть использованы в выражениях, вычисляемых по Ctrl+F4 или через функцию CompileExpression.

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

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

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

<вызов-метода-внешнего-интерфейса> =
  <имя-ссылки>.<вызов-метода>

<имя-ссылки> - имя ссылки, задается при объявлении ссылки (см. выше).

<вызов-метода> - обычное обращение к методу:

<вызов-метода> =
  <имя-метода> [ (<список-фактических-параметров>) ]

Примеры

Пример 1. Переменные типа ссылки

В примере объявлены переменные:

x, являющаяся ссылкой на интерфейс ISelectPodr, автоматически инициализированная ссылкой на разделяемый экзкмпляр;
aMyIfc, являющаяся ссылкой на интерфейс MyInterface, автоматически инициализированная ссылкой на индивидуальный экзкмпляр;
aIfc2, являющаяся ссылкой на интерфейс MyInterface, не будет автоматически инициализироваться.

var
  x : ISelectPodr;
  aMyIfc : MyInterface new;
  aIfc2  : MyInterface noAuto;
........

Пример 2. Переменная типа абстрактной ссылки

var ref1, ref2 : Vip1;
var oRef : objRef;
  ...
  oref := ref1;
  ref2 := oref;

Пример 3. Использование нулевой ссылки

var ref1 : vip1;
...
ref1.DoSomething(NullRef); // автоинициализация + вызов метода
ref1 := NullRef; 	 // освобождение ссылки
if (ref1 = NullRef)		// снова автоинициализация
  Message('Ok'); 	 // это сообщение никто не увидит ...

Пример 4.

//=========================================================
vipInterface VipInterface01;

//=========================================================
interface VipInterface01;
end.

//=========================================================
objInterface ObjInterface02;
 property pVI01: VipInterface01 read write;
end;

//=========================================================
vipInterface VipInterface02 implements ObjInterface02;

//=========================================================
interface VipInterface02;

var pTmp: VipInterface01;
var pRef: VipInterface01;

property pVI01: VipInterface01 absolute pTmp;

//---------------------------------------------------------
function CheckRef: boolean;
{
  result := NullVipRef(pRef);
}

//---------------------------------------------------------
function GetRef: VipInterface01;
{
  GetRef := pRef;
}

//---------------------------------------------------------
procedure Msg(s: string; b: boolean);
{
  Message(s + ' is' + String(If(b, '', ' not')) + ' null');
}

//---------------------------------------------------------
handleEvent

cmInit:
{
  var i: VipInterface01;
  var oi: ObjInterface02(VipInterface02);

  Msg('i', NullVipRef(i)); //сообщение: "i is null"
  Msg('i', i=NullRef);  //сообщение: "i is not null"
  Msg('i', NullVipRef(i)); //сообщение: "i is not null"

  Msg('Ref', CheckRef); 	 //сообщение: "Ref is null"
  Msg('Ref', NullVipRef(GetRef)); //сообщение: "Ref is not null"
  Msg('Ref', CheckRef); 	 //сообщение: "Ref is not null"

  Msg('pVI01', NullVipRef(pTmp));  //сообщение: "pVI01 is null"
//сообщение: "pVI01 is not null":
  Msg('pVI01', NullVipRef(ObjInterface02(self).pVI01));
  Msg('pVI01', NullVipRef(pTmp));  //сообщение: "pVI01 is not null"
}

end;

end.

События, связанные с использованием внешних интерфейсов

Версия

Начиная с версии 5.0 переменная типа ссылки на vip-интерфейс может быть описана как глобальная, а также в секциях .var и .fields в шаблонах форм.