Audit de code

Version imprimable

07/05/2019, 16h49
Jlmat

Audit de code

:lol:Bonjour à tous,

Dans la version RADStudio 10.3, il y a la possibilité de faire un Audit de son Code. Il est certes très utile et performant et s'adresse surtout à des développeurs professionnels. Cependant il ne réponds pas à mon besoin qui est simple.
Je me souviens d'une version de Borland où l'on avait la possibilité de visualiser toutes les affectations de variables dans le projet global se référant aux unités et fonctions ou procédures qui les utilisait.

Peut-être que cet outil existe et que je ne l'ai pas vu...

Ce que je cherche à faire:

1. évaluer la complexité de ce projet. Je ne suis que sûr que ce soit faisable facilement. Dans mon idée, c'est simple, je parcours les unités, repères les parties globales comme la partie, Uses et interface et décode les mots clés dans les unités qui sont des fichiers textes pour identifier les variables, les unités et noms de fonctions ou de procédures...
Ce premier point justifie que je publie ce post avant que je me lance dans l'aventure!

2. écrire un petit applicatif voir une fonction dans une unité de mon propre projet qui me recenserait
- Les variables déclarées de portée globales
- Les types de ces variables
- Les unités dans lesquelles, elles se trouvent
- Les fonctions et procédures qui les utilisent

3. imprimer ou créer un fichier qui me présente ces résultats sous forme d'un tableau croisé

4. et bien sûr publier le code et le mettre à disposition des delphistes ce code si vous le jugez utile pour vous

Pourquoi en ai-je besoin

Ben parce que en tant qu'amateur, lorsque je travaille sur un projet par petit bout de 4 à 6 heures par semaine, je ne me souviens plus de toutes mes déclarations et des doublons peuvent apparaître dans mon code, y compris des fonctions qui se ressemblent dans des unités différentes. Ce petit analyseur de code me révélerait très vite les ressemblance et les portées... afin de remettre de la cohérence sur le projet global... Entre autres

:whistle:Je sais les pros vont me rouer dans les bran quart. Avant je sortais sur imprimante mes unités et les relisais à tête reposées, mais comme je développe par petit bout, mes sorties imprimantes ne seront jamais à jour et "bouffer" de l'encre juste pour une petite modif ou un bout de code ajouté ne me paraît pas efficace non plus. De plus cet applicatif pourrait rendre bien des services à d'autres,

Voilà,

qu'en pensez-vous?
07/05/2019, 17h07
SergioMaster

Bonjour,

je n'ai lu que rapidement mais GExpert fait pas mal de ces choses et plus
07/05/2019, 19h26
Jlmat

Merci Sergio pour ce lien de GExpert.

Il faut charger la version GExperts 1.3.12 – December 2018 qui correspond à la version de rad studio 10.3 pour moi que l'on trouve ici: http://www.gexperts.org/download/

sinon, la version de la librairie rtl fait planter l'exécution.

Bon encore un monstre :weird:Sergio! Trop compliqué pour moi, je n'ai pas trouvé un recensement de synthèse des variables et leur utilisation dans le programme:cfou:. il faudrait que je passe des heures à la traduction de l'aide...
08/05/2019, 12h19
Galet

Bonjour à tous.
Je suis confronté au même problème avec des développements amateur qui peuvent s'étaler sur de longues périodes, avec, en plus, une évolution des connaissances, donc remise en cause des codes déjà écrits....

Excellente idée. Bon courage, tiens nous au courant...

1 pièce(s) jointe(s)

Merci Galet pour ton intérêt!

Oui, je crois que je vais me pencher sur le problème car conduire de Rolls alors qu'on en ai toujours à la 4L, on va se cartonner. Je suis pour la paix des ménages :?

Je ne vois pas trop de difficultés si l'on ne veut pas faire quelque chose d'exhaustif par rapport à tout ce qui existe comme référencement dans Delphi... Lister les unités, les procédures, fonctions et variables de manière isolées semble assez basique vu que les unités *.pas sont des fichiers textes.

Voilà comment j'aborderai le problème:

Pièce jointe 473048

avec par exemple les déclarations suivantes:
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 Type TSymbole = (syVariable,syUnite,syFonction,syProcedure); TPortee = (porGlobale, porLocale,porPrivee,PorPublic); TProcUnit = record IdUnite : integer; // identification du symbole dans TabVar ListProc: TstringList; // Liste des procedures et fonctions de l'unité end; TabProcUnit = array of TProcUnit; // Liste de toutes les porocédures et fonctions de toutes les unités TabVar = record IdSymbole : integer; // numéro d'enregistrement pour recherche rapide Symbole : TSymbole; // identification du type de symbole Portee : TPortee; // portée de la variable depuis son emplacement ListUnit : TStringlist; // liste des unités qui utilise la variable ProcUnit : TProcUnit; // Liste des procedures et fonctions de l'unité end;
Voilà ma première cogit!

08/05/2019, 17h46
Papy214

https://www.peganza.com/

il le fait pas lui ??
08/05/2019, 20h15
Jlmat

merci Papy pour ce lien!

Oui, il me parait plus simple et facile à utiliser que GExpert;
J'ai installé la version Lite Pascal Analyzer Lite pour voir...

Dommage qu'il ne soit pas en français, mais son interface est intuitif et donc on peut se balader assez facilement.
Mais C'est quand même un monstre... que j'utiliserais si je devais vendre mes créations, ce qui pour l'instant n'est pas au programme.

Je crois que je vais me pencher sur une version perso ultraLite pour répondre à des besoins plus simples. Bon, je ne sais pas combien de temps, il me faudra pour créer vraiment ce dont j'ai besoin.
J'ai commencé à écrire les premières fonctions. J'ai isolé, les unités et les variables de la première page d'un projet. Ce qui est déjà assez tordu sur le recensement exact des types de variables selon la façon dont l'utilisateur les déclare.
C'est sans doute pas une méthode Pro, mais enfin, j'écris mon interpréteur de manière simple.

Bon, je mets résolu puisqu'apparemment, je sais ce qu'il me teste à faire et si j'ai bien compris la philosophie du résolu!
10/05/2019, 21h39
Jlmat

Je reviens sur GExpert

Rebonjour,

1. :whistle2: J'ai enlevé le résolu car je me suis rendu compte d'un problème suite à la désinstallation de GExpert. Or plutôt que de faire un autre post sur le sujet, il me parait plus utile de compléter le sujet ici.

2. A la suite de l'installation de GExpert recommandé par notre éminent SergioMaster, j'ai testé le logiciel par ouverture directe de GExpert. Le trouvant trop complexe, je l'ai désinstallé. Or je me suis rendu compte qu'à l'ouverture de Delphi 10.3 Tokyo pour mon travail habituel, GExpert était pris en compte par Delphi, ce que je n'avais pas demandé.
A chaque fois, donc il me met des erreur comme quoi, il ne trouve pas le projet que j'avais testé avec GExpert. Mais en voulant désinstaller GExpert cette fois de l'EDI de Delphi, je n'y suis pas arrivé et maintenant Delphi plante. Je me suis rendu compte qu'il existait toute une palette de composant dans Delphi avec les icones de fonctionnalités de GExpert.

Je n'ai donc peut-être pas évaluer correctement ce logiciel. :oops:

J'ai donc réinstallé GExpert. :?

Question 1: à quoi servent les icones de la Palette de GExpert? Est-ce pour les développeurs afin qu'ils puissent obtenir des sortes de rapports sur des requêtes?
Question 2: Comment désinstaller GExpert correctement? Car une désinstallation direct avec l'utilitaire Windows n'enlève pas la palette et paramétrage chez Delphi.

Merci
11/05/2019, 07h33
SergioMaster

Bonjour,

Citation:

Envoyé par Jlmat

notre éminent SergioMaster

c'est gentil mais l'éminent est de trop, si j'ai indiqué GExpert c'est que je l'utilise depuis presque le début (presque une vingtaine d'années l'éminence commence à être érodée)

Citation:

j'ai testé le logiciel par ouverture directe de GExpert.

Ah bon ça pouvait se faire 8O ! Je l'ai toujours utilisé au sein de l'EDI.

Du coup il y a peut-être une trace dans les registres qui pose problème

Citation:

Envoyé par FAQ Gexpert

Vos fichiers de données GExperts (les fichiers .xml et .fs stockés dans le répertoire de stockage défini dans la boîte de dialogue de configuration de GExperts)

Citation:

Je me suis rendu compte qu'il existait toute une palette de composant dans Delphi avec les icones de fonctionnalités de GExpert.

ce ne sont pas des composants, dans le sens où ce ne sont pas des objets que l'on peut mettre sur une forme, mais des ajouts à l'EDI (on parle de OTA Open Tool API)

Citation:

à quoi servent les icones de la Palette de GExpert?

il lancent les différents outils

Citation:

Est-ce pour les développeurs afin qu'ils puissent obtenir des sortes de rapports sur des requêtes?

une partie Oui, d'autres permettent de créer des macros de faire des recherches (grep) etc.
Il y a beaucoup de redondance avec les nouveaux EDI (par exemple pour les recherches)
Mais aussi des "améliorations" par rapport à certaines fonctions (en exemple la TodoList qui peut être imprimée, j'avoue que c'est ce genre de choses qui m'intéresse le plus avec les macros )

Citation:

Comment désinstaller GExpert correctement?

Bonne question ! mon "éminence" tombe dans les bas fonds :mouarf: je n'en ai aucune idée, j'aurais écrit avec l'utilitaire windows ou le programme unins00.exe du répertoire de Gexpert.
Toutefois lire le readme.text est judicieux, on y lit que certaines valeurs de registre sont inscrites.

Citation:

Car une désinstallation direct avec l'utilitaire Windows n'enlève pas la palette et paramétrage chez Delphi.

vérifier les registres
Ordinateur\HKEY_CURRENT_USER\Software\GExperts
Ordinateur\HKEY_CURRENT_USER\Software\Embarcadero\BDS\20.0\GExperts-1.3 etc. AMHA lors de ta désinstallation tu as oublié d'indiquer de supprimer les entrées de registre (à moins que cette option n'y soit pas :koi:)
11/05/2019, 09h10
Jlmat

Merci Sergio,

Il me faut réinstaller correctement d'abord GExpert, ce qui n'est pas le cas actuellement...

Je vais donc désinstaller à nouveau et voir au niveau de la base de registre... Je suis étonné que l'on ne puisse désinstaller à partir de l'EDI Delphi, ça aurait plus facile...

A+
11/05/2019, 09h45
SergioMaster

1 pièce(s) jointe(s)

Ben justement, GExpert propose un outil "Expert manager" qui permet de gérer les outils installés
Pièce jointe 474006
Mais c'est peut-être se tirer une balle dans le pied que d'utiliser l'outil pour désinstaller l'outil :mouarf:
12/05/2019, 00h14
Jlmat

@ Sergio:

;)Après avoir réinstallé, Gexpert, je l'ai re-désinstaller avec unins000.exe de son répertoire. Tout a été enlevé correctement. Delphi ne plante plus. Peut-être le problème venait du fait que je l'avais désinstallé alors que Delphi était ouvert. Je ne savais pas alors que GExpert s'invitait dans Delphi Directement dans un nouveau Menu (pas une palette).

Du coup, je l'ai réinstallé pour voir si avec les commandes directes dans l'EDI, c'est plus convivial bien qu'en anglais! Ce qui m'intéresserait, ça serait de savoir si je n'ai pas déclaré des variables qui sont proches en terme d'utilisation dans l'ensemble de mes unités. Par exemple au niveaux des booléens, j'en ai un tas dont le rôle est de m'indiquer d'où provient l'appel d'une fonction (contexte)... Ou de savoir dans qu'elles unités sont utiliser certaines variables. Une recherche permet de faire cela pour un variable, mais pour toutes les variables d'une unité, c'est plus long à faire et un peu fastidieux, on a pas une vue d'ensemble...

J'ai parcouru l'ensemble du Menu GExpert dans l'EDI, c'est très complet mais j'avoue ne pas avoir trouvé où je pouvais lister les variables... Il semblerait qu'il y a un dictionnaire des directives en fonction de la plateforme utilisé ou de la version Delphi utilisé. C'est très utile, ça... pour le suivi des mises à jour des applications.

Bon enfin, voilà. Si tu as un exemple d'utilisation puisque tu l'utilises! Quel outil du Menu tu utilises?

Je vois par exemple qu'il y a une fonction de conversion de string. Est-ce que ça rajoute des string(...) de string pour régler le problème de compilation W1057:

Code:

String(ShortString);

A+
12/05/2019, 08h45
SergioMaster

Bonjour,

pour ce qui est de ces questions

Citation:

Quel outil du Menu tu utilises?

de moins en moins de choses puisque la plupart sont en doublon et que je travaille de plus en plus en FMX ce qui change un peu la donne
Je me cantonne maintenant surtout à la table des caractères, le nettoyage (clean) des répertoires, les backups, les macros, liste des unités, liste des procédures, liste des todo (pour imprimer)
en vcl j'utilisais beaucoup la création de dialogue, Grep et le remplacement de type de composant

Citation:

lister les variables...

là j'avoue, aucune idée. Déjà, tu parles des variables définies dans la partie interface ou au sein de l'implémentation ?

Pendant que j'y pense et au vu de tes demandes il y a aussi PasDoc ou d'autres analyseurs de sources totalement indépendant de Delphi mais orienté documentation .
Je cite PasDoc car c'est le seul qui fournisse un résultat en français (du moins à ma connaissance) cela dit :
- ~~j'ai encore un problème avec les caractères accentués~~ :weird: ~~(je sais qu'il faudrait que je recompile Pasdoc avec une version UTF8 mais la flemme !)~~ [Edit] du coup j'ai téléchargé le dernier snapshot et plus de problème de ce côté !
- j'ai surtout du mal avec la "syntaxe" et positionnements des commentaires (d'ailleurs quelques petites macros m'aident à les rédiger ;))
18/05/2019, 20h38
Jlmat

Merci Sergio pour tes dernières réponses!

Excuse moi pour le retard pour ma réponse...

1. J'ai testé PasDoc:whistle2:. On peut choisir les menus et options du logiciel en français mais l'aide en ligne reste en anglais. Bien qu'il semble assez simple d'utilisation, je n'ai pas réussi à avoir des tableaux croisés de variables utilisées dans les procédures de toutes les unités... il se contente de recensement simples par unité ou fonction...

j'ai vu dans le même ordre d'idée sur une page voisine http://www.graphviz.org/ une analyse sous forme de graph, ce qui se rapprocherait de la lisibilité que je recherche. mais il faut installer le package GitLab ce qui me rebute!

2.

Citation:

tu parles des variables définies dans la partie interface ou au sein de l'implémentation ?

Oui, ce qui m'intéresse ce sont les variables publique de l'interface qui sont utilisées par diverses unités. Les variables de la partie implémentation ne me posent pas de problème... en général

3. Ma conclusion est que l'on n'est jamais mieux servi que par soi-même.:pc: Je vais continuer à développer mon programme de scan... Et quand j'aurais plus de temps, j'envisagerai de vous soumettre mon code pour savoir s'il est digne d'être sur ce site. Et quand j'aurai la possibilité de créer une page de sources (blog) sur ce site.

3. Je remets "résolu" jusqu'à nouvel ordre!

A+
19/05/2019, 07h05
SergioMaster

Bonjour,

Je continuerai à suivre ça de près. De mon côté j'ai toujours en tête de faire un outil pour "lister" la partie des liaisons (Livebindings) incluses dans le fichier dfm/fmx, je m'y mettrai un jour ;)