Evolution de l'unité uParam.pas vers Olf.RTL.Params.pas

Afin de distinguer les unités et les différents projets proposés sur GitHub comme ailleurs, je me mets progressivement à rebaptiser tout ce que je publie et est susceptible d'être utilisé par des tiers.

Mes fichiers sources réutilisables seront désormais diffusés avec la racine Olf.RTL, Olf.VCL, Olf.FMX selon le type de contenu ou de projet. Les nouveaux composants auront également une racine en TOlf comme le font d'autres éditeurs et développeurs de composants pour développeurs Delphi.

J'aurais pu faire TPP avec mes initiales mais j'ai préféré garder le nom historique que j'utilise sur les choses que je diffuse sur PC et ailleurs depuis 1990.

Stocker facilement vos paramètres logiciels en format JSON

Première unité à faire ce renommage : uParams.pas de ma boite à outils.

Pour des raisons de compatibilité ascendante vous retrouverez toujours l'ancienne unité mais elle dépendra de la nouvelle version et affiche un WARNING lors de la compilation des projets.

Dans le cas présent j'ai fait pas mal de changements sur la classe d'archivage de paramètres aujourd'hui et c'était l'occasion.

Dans les nouveautés sur l'unité Olf.RTL.Params.pas (anciennement uParam.pas donc) vous trouverez :

- des commentaires XMLDoc (en anglais) pour bénéficier de l'aide à la saisie fournie par l'IDE de Delphi

- des valeurs par défaut sur les valeurs par défaut dans les méthodes getValue() afin de ne pas avoir à les saisir vous même dans la plupart des cas d'utilisation

- l'accès au nom du fichier par défaut pour le stockage des paramètres et la possibilité de le modifier ou le déplacer

- une nouvelle paire setValue() getValue() permettant de stocker des TJSONValue (ou descendants)

- la possibilité d'accéder à la structure de stockage en TJSONObject ou la cloner

- la possibilité d'exporter le contenu des paramètres sous forme d'objet JSON serializé

- une nouvelle classe TParamsFile qui fournit ces fonctionnalités pour un fichier de paramètre spécifié, vous permettant d'en gérer plusieurs dans le meme logiciel

- une modification de la classe TParams qui pointe désormais vers un TParamsFile par défaut (géré dans l'implémentation de l'unité) pour la compatibilité ascendante et aussi si vous n'avez pas envie de vous embêter à changer le fichier de stockage des infos géré en standard par cette unité

La classe TParams contient uniquement des méthodes de classes et ne doit pas être instantiée pour être utilisée.

La classe TParamsFile travaille sur un fichier à spécifier par le développeur (ou le même fichier par défaut que TParams) mais doit être instantiée et peut faire l'objet d'une descendance si vous avez des besoins complémentaires.

L'unité uParam.pas ne déclare que la classe TParams historique en bénéficiant de toutes les fonctionnalités implémentées dedans. Si vous désirez utiliser TParamsFile vous devrez utiliser l'unité Olf.RTL.Params.pas

Migration pour les projets existants

Si vous aviez copié le fichier uParam.pas dans le dossier de vos projets vous devez le remplacer par sa nouvelle version et lui joindre Olf.RTL.Params.pas

Si vous aviez ajouté une dépendance à uParam.pas dans un dossier contenant tous les fichiers de la librairie, mettez simplement ce dossier à jour. Eventuellement ajoutez Olf.RTL.Param.pas à votre projet si la compilation ne passe pas du premier coup (ce qui dépend surtout de l'ajout ou pas du dossier au chemin de recherche de l'IDE).

Utilisation sur les nouveaux projets

Idéalement faites une dépendance vers le projet GitHub si vous utilisez git comme système de versionning. Il vous suffit de créer un sous-dossier "modules" ou "lib-externes" quelque part dans votre arborescence, puis de lancer git-bash dedans et y saisir la commande :

git submodule add https://github.com/DeveloppeurPascal/librairies.git

Si vous préférez n'en avoir qu'un exemplaire sur votre ordinateur et ne pas gérer la dépendance, vous pouvez soit cloner le dépôt de code sur votre ordinateur, soit télécharger le ZIP.

L'avantage du clonage ou son utilisation en module dans vos projets est que vous pourrez gérer sa mise à jour plus facilement, directement avec

git pull origin master

Si vous avez opté pour un sous module, incluez dans votre projet les fichiers de la boite à outils qui vous sont utiles.

Si vous avez opté pour un dossier unique sur votre disque dur, ajoutez le simplement aux chemins de recherche dans les options de l'environnement. Vous pouvez aussi faire un ajout des fichiers utiles dans vos projets, mais attention : les chemins d'accès sont en dur et ça, c'est pas top quand on travaille à plusieurs ou change d'ordinateur régulièrement...


Liens associés

Ces liens s'ouvrent dans la même fenêtre que cette page. En cliquant dessus vous quitterez Les trucs et astuces d'un développeur Pascal.
Pensez à les ouvrir dans un nouvel onglet si vous préférez rester ici pour y revenir plus facilement.