foreach tirera sa révérence avec Qt 5.9

Qt 4 a défini une macro Q_FOREACH (aussi accessible comme pseudo mot clé foreach) pour faciliter l’itération dans ses conteneurs (comme QList ou QStringList). Cependant, son mode de fonctionnement n’est pas idéal : tout le conteneur est copié dans une instance de QForeachContainer avant que la boucle commence effectivement, cette syntaxe n’est pas non plus compatible avec des tableaux C. Dès Qt 5.9 (ou un peu après), cette construction devrait être marquée comme obsolète dans Qt : C++11 propose une construction très similaire, qui sera dorénavant privilégiée (les développeurs de Qt peuvent maintenant utiliser cette nouvelle version de C++, la compatibilité avec C++03 n’étant plus garantie depuis la version 5.7).

Q_FOREACH(int i, container) // Dès Qt 4
for (int i : container) // C++ 11

De manière générale, cependant, foreach ne pose que peu de problèmes : l’instance de QForeachContainer n’est pas obligée de faire une copie en profondeur du conteneur sur lequel l’itération se passe (contrairement à une boucle utilisant directement l’API des itérateurs de la STL).

Cette implémentation peut même être tirée à profit dans certains bouts de code : puisque l’itération se passe sur une copie du conteneur initial, il est possible d’ajouter des éléments dans ce conteneur initial sans affecter l’itération. Bien sûr, dans ce cas, une copie en profondeur doit avoir lieu, mais le code fonctionne (contrairement à sa version C++11).

Q_FOREACH(const QString &lang, languages)
    languages += getSynonymsFor(lang);

Les vrais problèmes arrivent quand quelqu’un d’autre lit ce code, à cause de cette dépendance à un détail d’implémentation de Qt : la situation serait bien plus claire si le développeur avait pris le temps de copier le conteneur avant d’itérer (et de modifier le conteneur initial) — ou, si les modifications se limitent à l’ajout d’éléments à la fin, de s’assurer qu’aucune lecture n’aura lieu après la fin du conteneur au moment où la boucle débute. Cet exemple indique déjà qu’il ne sera pas si facile de migrer tout le code vers la construction “équivalente” de C++11 (remarquer de manière automatique ces cas particuliers serait très ardu).

const auto languagesCopy = languages; 
for(const auto& lang : languagesCopy)
    languages += getSynonymsFor(lang);

Au niveau de la performance, si le conteneur n’est pas défini comme constant, alors le compilateur C++ sera obligé d’effectuer une copie (comme Qt auparavant avec foreach). Pour éviter ce cas particulier, il est nécessaire d’en changer le type pour indiquer qu’il sera constant pendant l’itération : C++11 fournit la fonction std::as_const(), Qt 5.7 qAsConst(). Ainsi, la lisibilité du code est gardée, mais avec une performance idéale.
De manière générale, utiliser foreach consomme une centaine d’octets de plus que la même boucle avec la construction C++11 : ce gain peut être appréciable dans le monde de l’embarqué, où la mémoire est une ressource rare.

Source et exemples de code : Goodbye, Q_FOREACH.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s