Les arguments d’un évènement

Suite à une remarque d’Antoine, je me sens obligé aujourd’hui d’expliquer un point de conception lié à la modélisation des évènements dans CK.

Néanmoins, avant de plonger dans la technique, une remarque préliminaire s'impose:

L'Académie française, dans la neuvième édition de son Dictionnaire, écrit, en accord avec les recommandations du Conseil supérieur de la langue française de 1990, évènement. La graphie ancienne événement n'est cependant pas considérée comme fautive, encore que rien ne la justifie plus. Sa survivance s'explique par le fait que la régularisation de ce mot, ainsi que de quelques autres, d'abrègement à vènerie, avait été oubliée lors de la préparation tant de la septième édition (1878) que de la huitième (1935).
www.academie-francaise.fr/langue/rectifications_1990.pdf

Hériter… ou pas.

En règle générale, les concepteurs essayent d’éviter autant que possible les arbres d’héritage profonds : une structure d’héritage « flat » (et orthogonale) est toujours préférable (à une horreur de type MFC) car elle garantit à la fois une meilleure lisibilité (et donc maintenabilité) et réutilisabilité. Pourtant, dans CK, il existe un endroit où la structure d’héritage n’est pas du tout, mais alors vraiment pas, plate… Il s’agit des objets arguments d’évènements. Par exemple, l’argument de l’évènement correspondant à l’échange des modes de deux touches réelles. Cette classe s’appelle ActualKeyModeSwappedEventArgs et voici sa chaîne d’héritage:

ActualKeyModeSwappedEventArgs Les modes de deux touches ont été échangés.
 > ActualKeyModeChangedEventArgs  Le mode d’une touche a changé.
  > ActualKeyEventArgs L’évènement concerne une touche réelle.
   > KeyEventArgs L’évènement concerne une touche.
    > KeyboardEventArgs L’évènement concerne un clavier.
     > ContextEventArgs L’évènement concerne un contexte CK.
      > EventArgs Un évènement s’est produit.

Six classes de base !

Pourquoi les arguments d’évènements s’inscrivent-ils dans une chaîne d’héritage si profonde ? Le concepteur aurait-il abusé de substances illicites ? Que nenni (enfin si mais cela n’a pas eu d’impact sur ce qui nous occupe). Nous avons là une exception qui confirme la règle de la platitude (je ne sais pas si c’est la seule exception), car cette chaîne d’héritage permet aux évènements d’être interceptés à n’importe quel niveau de précision. Et c’est bien pratique.

Le bon héritage

Relevons d’abord un aspect important : cette conception respecte totalement la sémantique de la spécialisation et ne crée aucun des problèmes souvent rencontrés lorsque l’on abuse de l’héritage.

  • Sur le respect de la sémantique d’abord, analysons la chaîne présentée ci-dessus :
    Le fait d’échanger les modes de deux touches est un (is_a) changement de mode qui est un (is_a) évènement d’une touche réelle qui est un (is_a) évènement d’une touche qui est un (is_a) évènement d’un clavier qui est un (is_a) évènement d’un contexte qui est un (is_a) évènement.
    Ce respect de la règle est un (is a en anglais) est la règle fondamentale à respecter lorsque l’on spécialise une classe. Si on ne peut pas dire A est un B, alors A ne devrait pas hériter de B (les exceptions à cette règle existent - mixins et autres héritages de réutilisation – mais ne les commettez qu’en toute connaissance de causes et d’effets).
  • Sur la mise en œuvre d’autre part, il faut noter que ces « classes évènements » sont implémentées sans mettre en œuvre de propriétés ou méthodes protégées : ici, l’héritage ne peut « casser l’encapsulation » (chercher dans votre moteur préféré « inheritance breaks encapsulation » pour plus d’information sur ce sujet parfois un peu subtil). Chaque classe apporte des propriétés publiques qui décrivent, précisent, l’évènement correspondant : aucune réutilisation d’implémentation n’est faite ici, on est dans le cas d’un sous-typage (subtyping) plutôt que d’un héritage (inheritance).

Cet usage de l’héritage est donc correct en regard des canons de l’ingénierie logicielle. Mais à quoi cela sert ?

« Client side » : je consomme l’évènement

Comme je l’ai déjà écrit ci-dessus, l’intérêt est de faciliter la prise en compte de ces évènements au « niveau de détail » que l’on souhaite. Considérons l’évènement correspondant à un des arguments ci-dessus :

public interface IKey
{
   ...
   event EventHandler ActualKeyModeChanged;
   ...
}

En tant que client, je peux inscrire ces évènements auprès de n’importe quelle fonction dont la signature respecte le type de l’argument en tenant compte de l’héritage. Je peux, bien évidemment, m’inscrire ainsi à l’évènement :

   IKey k = ...;
   k.ActualKeyModeChanged += OnKeyModeChanged;
   ...

void OnKeyModeChanged( object source, ActualKeyModeChangedEventArgs e )
{
   ...
}

Mais, je peux aussi m’intéresser à ce même évènement ainsi :

   IKey k = ...;
   ...
   k.ActualKeyModeChanged += OnSomethingChangedInKey;
   k.KeyPropertyChanged += OnSomethingChangedInKey;
   ...

void OnSomethingChangedInKey( object source, KeyEventArgs e )
{
   ...
}

Ou même :

   IKey k = ...;
   ...
   k.ActualKeyModeChanged += OnSomethingHappened;
   k.Keyboard.AvailableModeChanged += OnSomethingHappened;
   k.Context.CurrentKeyboardChanged += OnSomethingHappened;
   ...

void OnSomethingHappened( object source, EventArgs e )
{
   ...
}

Vous voyez l’idée : comme le changement de mode d’une touche réelle est un (is_a) évènement, je peux y souscrire justement comme à un évènement quelconque, je ne suis pas contraint d’utiliser le type précis de l’argument.

« Server Side » : j’émets un évènement

Il existe une autre utilisation possible de cet héritage si l’on se place de l’autre coté de la barrière : celui où on émet l’évènement plutôt que de le recevoir. En l’occurrence, il se trouve que ActualKeyModeSwappedEventArgs et ActualKeyModeChangedEventArgs illustrent cette utilisation.

Le premier correspond à l’échange des modes de deux touches, le deuxième (qui généralise le premier) à un changement de mode d’une touche.
Les interfaces IKey et IKeyboard exposent toutes deux l’évènement ActualKeyModeChanged. Le fait que le changement soit dû à un échange plutôt qu’à un changement direct est un détail pour la grande majorité des clients (les plugins en l’occurrence), mais on souhaite quand même exposer la cause de l’évènement à ceux qui sont susceptibles de s’y intéresser. La première idée est d’exposer un deuxième évènement :

public interface IKey
{
   ...
   event EventHandler<ActualKeyModeChangedEventArgs> ActualKeyModeChanged;
   event EventHandler<ActualKeyModeSwappedEventArgs> ActualKeyModeSwapped;
   ...
}

Mais cela pose un vrai problème de conception : tout déclenchement de l’évènement Swapped doit être doublé d’un déclenchement de Changed sinon un client qui ne s’est inscrit qu’au premier ne verra jamais les changements causés par un échange de mode. Outre la pollution de l’interface IKey par un évènement peu utilisé, cela entraîne aussi le fait que le client qui s’intéresse aux deux devra dédoublonner les évènements pour éviter de les prendre en compte deux fois… Ce ne sera pas fait. Ou mal fait. C’est ce qu’on appelle une usine à bugs.

La bonne solution consiste à utiliser l’héritage dans l’autre sens. On ne publie qu’un seul évènement :

public interface IKey
{
   ...
   /// 
   /// Fires whenever the mode of one of our <see cref="ActualKeys"/> changed.
   /// The event argument may be an instance of the 
   /// <see cref="ActualKeyModeSwappedEventArgs"/> class if the change 
   /// is the result of a call to <see cref="IActualKey.SwapModes"/> 
   /// instead of <see cref="IActualKey.ChangeMode"/>.
   /// 
   event EventHandler<ActualKeyModeChangedEventArgs> ActualKeyModeChanged;
   ...
}

Et son argument sera du type ActualKeyModeSwappedEventArgs dans le cas du Swap, ce qui est facile à tester par les clients que cela intéresse :

void OnKeyModeChanged( object source, ActualKeyModeChangedEventArgs e )
{
   ActualKeyModeSwappedEventArgs eSwap = e as ActualKeyModeSwappedEventArgs;
   if( eSwap != null )
   {
      // The change is due to a swap. The event argument gives us the swapped key.
      IActualKey other = eSwap.SwappedKey;
      ...
   }
   else
   {
     // Handle ChangeMode event.
     ...
   }
}

En résumé, cette technique permet de ne pas polluer les interfaces avec des évènements rarement utilisés et de permettre une prise en compte simple et efficace de « sous-catégories » précises d’évènements.

Conclusion

Le modèle des évènements de .Net, qui repose sur les délégués (delegates) et la signature standard (object source, EventArgs e) est simple et puissant. A condition de l’exploiter correctement, et donc de l’avoir compris.

Cette discussion, qui nous a amené à traiter du bon usage de l’héritage, introduit deux aspects de l’utilisation de l’héritage en conception. Pour aller plus loin, je vous encourage à regarder du coté de la co-variance et de la contra-variance qui sont des notions très proches de ce que nous avons présenté ici.

Dans un prochain post traitant des évènements, j’aborderai de ce que je considère comme une des (rares) erreurs de conception du framework .Net : la classe EventArgs elle-même…