Dans cet article, nous allons étudier la mise en place et l’utilisation des callbacks au sein d’une interface graphique.

En Matlab, le callback est défini au niveau de la propriété « callback » d’une fonction graphique (ex. uicontrol, uimenu, etc.). L’attribut donné à cette propriété peut être une chaîne de caractère ou un handle de fonction.

1. Création d’un callback simple

Dans un premier temps, nous allons présenter le cas des callbacks sans argument d’entrée. On rappelle qu’un callback ne peut pas avoir d’argument de sortie.

1.1. Callback sous forme de chaîne de caractères

Étudions l’exemple suivant :

function test()
h = figure();
uicontrol(h,'Style','PushButton','Callback','quit');


L’appel à la fonction test crée une figure dont le handle est stocké dans la variable h ; ensuite, un objet de type « PushButton » (autrement dit un bouton) est affecté à cette figure. Un clic sur le bouton appelle la fonction quit, qui ferme Matlab.

Notes :

• L’écriture de callbacks sous forme de chaînes de caractères ne convient que pour des callbacks très simples, typiquement l’appel d’une fonction sans argument d’entrée.
• La chaîne de caractères décrivant la fonction de callback forme un nouveau workspace, ce qui signifie que les variables définies dans la fonction principale ne sont pas vues du callback, et qu’il faut déclarer ses globales, etc. Pour utiliser une variable de la fonction principale dans le callback, la seule solution est de remplacer la variable par sa valeur dans la chaîne définissant le callback, au moyen d’un sprintf.
• Dans l’écriture des callbacks de cette manière, il est indispensable d’utiliser des « ; » et des « , », le passage à la ligne n’étant pas interprêté puisqu’il s’agit d’une chaîne ; il faut donc mettre des virgules après les if, etc.
• Matlab ne « voit pas » les fonctions situées dans le même fichier source que celle appelant le callback ; autrement dit, si le callback consiste à appeler une fonction dont le code est dans le même fichier M, cela ne fonctionnera pas.

1.2. Callbacks sous la forme d’un handle de fonction

Reprenons l’exemple précédent, en remplaçant la chaîne de caractères par un handle de fonction :

function test()
h = figure();
uicontrol(h,'Style','PushButton','Callback',@fermer);
% end function

function fermer(obj,eventdata)
quit;
%end function

Cette fois-ci, lors d’un clic sur le bouton, Matlab va tenter d’exécuter la fonction identifiée par le handle défini en valeur de l’attribut « callback ». La façon la plus simple de d’obtenir ce handle est de taper :

@nom_de_la_fonction

Il faut bien sûr que la fonction existe, et qu’elle soit dans le path de Matlab.

Généralités
L’emploi du debugger est somme toute très classique, et une poignée de commandes spécifiques suffisent à travailler de façon efficace. Les commandes du debugger commencent généralement par « db ». Lorsque l’exécution est suspendue par un point d’arrêt, le prompt change et devient « K>> ». Toutes les commandes Matlab habituelles peuvent alors être invoquées. On peut notamment vérifier le contenu des variables, lister les variables (« who » ou, mieux, « whos »), visionner le contenu du M-file (« dbtype »), etc. La chose la plus importante est de bien comprendre la notion d’« espace de travail », ou workspace. Lorsque l’exécution s’arrête au milieu d’une fonction, le workspace est celui de la fonction en question, et donc seules les variables de cette fonction sont visibles. Au lancement de Matlab, le workspace est celui par défaut, hiérarchiquement au-dessus de tous les autres, et est appelé base workspace. Il est possible de changer de workspace, comme nous le verrons plus loin.

Points d’arrêt
Pour placer un point d’arrêt, il suffit d’insérer dans le code de la fonction la commande « keyboard ». Arrivé à cette ligne, l’interpréteur s’arrêtera et donnera la main à l’utilisateur, avec le prompt « K>> ». Il est également possible de définir des points d’arrêt « dynamiques », c’est-à-dire créés automatiquement dans certains contextes, avec la commande « dbstop ». Elle peut être lancée depuis le base workspace ou à l’intérieur d’une fonction. Quelques contextes d’utilisation sont explicités ci-dessous :

• dbstop if error place un point d’arrêt à l’endroit où la première erreur est détectée par l’interpréteur ;
• dbstop if warning fait pareil, pour une alerte ;
• dbstop if naninf arrête l’exécution lorsqu’une valeur infinie est générée, typiquement dans le cas d’une division par zéro ;
• dbstop in (mfile) at (linenumber) stoppe l’exécution lorsque l’exécution arrive à la ligne linenumber du fichier mfile ;
• dbstop in (mfile) at (subfunction) suspend l’exécution à l’entrée de la sous-fonction subfunction du fichier mfile.

Pour retirer les points d’arrêt dynamique, il suffit d’utiliser la même commande, en remplaçant « dbstop » par « dbclear ». Enfin, il est possible de visualiser l’ensemble des points d’arrêt à l’aide de « dbstatus ».

Poursuite et fin de l’exécution
Pour reprendre l’exécution après un point d’arrêt à partir du prompt, on peut soit utiliser l’instruction « dbcont », soit utiliser « return » — comme pour les fins de sous-fonctions. Pour une exécution en mode pas à pas, c’est-à-dire instruction par instruction depuis le point d’arrêt, la commande à utiliser est « dbstep ». Matlab affiche alors le contenu de l’instruction en cours. Enfin, la commande « dbquit » permet de quitter le mode debugger et de mettre fin à l’exécution. Attention à ne pas employer « quit » ou « exit », qui, en plus, fermeraient Matlab !

Changement de workspace
Lors du debug, il est souvent nécessaire de connaître les valeurs des variables ou de tester des commandes à la fois dans une sous-fonction et dans la fonction appelante. Pour celà, il faut changer de workspace, car le debugger se place celui de la fonction exécutée au moment du point d’arrêt. Les workspaces suivent la même hiérarchie parent-enfant que les fonctions appelantes par rapport aux fonctions appelées. Ainsi, si la fonction A appelle la fonction B et que le point d’arrêt est dans la fonction B, il faut monter d’un niveau pour se placer dans le workspace de la fonction A. Pour accéder au base workspace, il faut à nouveau monter d’un niveau car toutes les fonctions sont appelées au niveau du base workspace. La commande pour monter d’un niveau est « dbup », celle pour descendre « dbdown ».

Exemple :

Ajout de commentaires
Les commentaires sont introduits par le caractère « % ». L’interpréteur Matlab ignore tous les caractères entre le « % » et la fin de la ligne, exactement comme le « // » du C++. Il n’existe malheureusement pas de commande pour commenter tout un bloc de code comme en C. Cependant, la plupart des éditeurs de texte ainsi que l’éditeur intégré de Matlab permettent de le faire, en ajoutant un « % » au début de chaque ligne du code sélectionné. Il existe enfin une alternative, quelque peu « sauvage », mais qui marche très bien, qui consiste tout simplement à inclure le bloc à commenter dans une structure « if » toujours fausse :
if 0
(votre code)
end

Aide de la fonction
Chaque fois que vous écrivez une fonction, commencez par l’aide de la fonction, même sommairement, quitte à la compléter plus tard. Le mieux est de la mettre à jour à mesure, quand vous ajoutez une nouvelle option, de nouveaux arguments, etc. Le bloc de commentaires servant d’aide doit être placé immédiatement avant ou après la déclaration de la fonction :

Première solution :
%Commentaire de l'aide
function [output1, output2] = MaFonction(input1, input2)
(votre code)
Seconde solution :
function [output1, output2] = MaFonction(input1, input2)
%Commentaire de l'aide
(votre code)
Il est à noter que vous pouvez sauter autant de lignes que vous le souhaitez entre ce commentaire et la déclaration de la fonction ou le code. Pour ma part je préfère la première solution, que je trouve plus claire à la lecture du code, mais les fonctions écrites par The Mathworks privilégient la seconde. Une fois l’aide écrite, il suffira de lancer la commande :

>> help MaFonction

pour voir s’afficher :

Commentaire de l’aide

À présent, penchons-nous sur le contenu de cette aide. Vous pouvez y mettre ce que vous désirez, néanmoins une bonne pratique consiste à :

• mettre sur la première ligne le nom de la fonction, suivi d’une brève description de son rôle ;
• détailler le comportement de la fonction suivant les arguments d’entrée et de sortie ;
• renvoyer à d’autres fonctions similaires, ou bien, dans le cadre d’un projet, aux fonctions que vous avez écrites appelées par cette fonction, ou encore la ou les fonctions qui appellent votre fonction ;
• éventuellement, signer et mettre une mention de copyright ou de licence (mais vous pouvez le faire dans un autre bloc de commentaire juste en-dessous, qui ne sera pas affiché mais qui sera lisible par ceux qui regarderont votre code) ;
• préciser, si vous ne travaillez pas avec un système de management de version (CVS, etc.), la date de début de développement de la fonction, ainsi que les dates de toutes les modifications avec une description des changements apportés ;
• tout écrire en anglais, si vous le pouvez, surtout si d’autres personnes sont amenées à reprendre votre code.

Pour ma part, j’ai adopté les conventions des fonctions Matlab de base, ce qui donne :

%MAFONCTION Brève description de ma fonction
% MAFONCTION(IN1) fait ceci.
%
% MAFONCTION(IN1,IN2) fait en outre cela.
%
% OUT = MAFONCTION(...) renvoie le résultat dans OUT.
%
% See also AUTREFONCTION1, AUTREFONCTION2.

Lors de l’appel de la fonction help, Matlab affiche le bloc en retirant les caractères « % » de début de ligne. Notons que j’ai utilisé ici des lettres capitales pour le nom des fonctions et pour les arguments d’entrée et de sortie afin d’améliorer la lisibilité de l’aide, alors que les véritables noms sont écrits en bas de casse. N’utilisez pas cette convention si vos noms de fonctions ou de variables comportent des capitales.

Nous verrons dans un prochain article comment écrire une fonction permettant d’afficher de différentes manières l’aide de toutes les fonctions d’un projet.

Indication de fin de fonction
Pour terminer, il est conseillé de bien délimiter la fin de vos fonctions, même si — ce qui est souhaitable — vous ne mettez qu’une seule fonction par M-file. La commande « end function » posant parfois problème, un commentaire fait tout aussi bien l’affaire !

Les codes présentés sur MatlabFR ont pour la plupart été testés sur Matlab 7 Release 14. Ils sont donnés à titre pédagogique, sans aucune garantie, et ne sauraient engager la responsabilité de leur auteur. Enfin, MatlabFR n’est lié d’aucune façon à The Mathworks.