2.9.3. Обработчики событий

Любой объект, кроме методов, полей и свойств, может иметь так же некоторые «события». Событие – это (для объекта) поле типа указателя на функцию, процедуру или метод. (Могут существовать так же события вне объектов, тогда это просто глобальная переменная типа указателя на процедуру, функцию или метод). Чаще всего события декларируются как свойства (что позволяет работать с ними, используя единообразный синтаксис, независимо от того, требует ли назначение обработчика событию вызова специального метода, или указатель может быть присвоен как обычное поле).

Большинство событий являются указателями методов, т.е. их тип объявлен как procedure … of object или function … of object. Для программистов это означает, что данное поле является не просто указателем, хранящий адрес процедуры, которая будет вызываться при наступлении «события», а содержит два указателя (занимая 8 байт в памяти): один указывает на экземпляр объекта, обрабатывающего событие, а другой – на его метод.

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

type TOnEvent = procedure( Sender: PObj ) of object;

Из приведенного описания данного типа события следует, что в качестве обработчика OnDestroy разрешается назначать любой метод, объявленный (в теле декларации некоторого объекта) следующим образом:

procedure ObjDestroying( Sender: PObj ); (курсивом выделены имена, которые всегда можно заменить своими). Если вы попытаетесь в своем коде присвоить данному событию в качестве обработчика процедуру обычную (т.е. не метод) или метод, описание которого отличается больше, чем использованием других имен вместо выделенных курсивом ObjDestroying и Sender, то компилятор такой код компилировать не станет, выдав сообщение об ошибке.

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

Таким образом, появляется легальная возможность обходить требование о том, чтобы обработчиками событий всегда оказывались именно методы, а не простые процедуры и функции. В KOL имеется специальная функция MakeMethod, которая позволяет "сконструировать" метод из двух указателей - указателя объекта (который может быть равен, в том числе, nil, и указателя простой процедуры или функции). Для того, чтобы сконструированный таким образом метод типа procedure of object мог быть назначен в качестве обработчика события, того же OnDestroy, достаточно его при присваивании привести к типу события. Например:

MyObj.OnDestroy := TOnEvent( MakeMethod( nil, @ MyObjDestroying ) );

Замечу, что для того, чтобы обработчик события снять, в любом случае достаточно присвоить свойству-событию значение nil - компилятор прекрасно понимает такой оператор как присваивание значения nil и указателю на метод, и указателю на объект в поле события.

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

Н

Обратите

внимание!

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

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

Т.е., следующее описание процедуры MyObjDestroying будет ошибочным:

procedure MyObjDestroying( Sender: PObj );

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

procedure MyObjDestroying( Dummy: PObj; Sender: PObj );

В первом случае при вызове процедуры на месте параметра Sender был бы передан nil, указанный при конструировании метода в качестве объекта, а указатель на объект (Sender), для которого событие произошло, теряется. Тогда как во втором случае он передается правильно. Программа, тем не менее, выполняется, и не происходит проблем с нарушением указателя стека, т.к. в Паскале по умолчанию первые три параметра передаются не через стек, а через регистры процессора. Однако, если обработчик события попробует использовать Sender, то в первом случае он всегда "увидит" значение nil. Выглядит обескураживающе, не так ли?

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