feat: implement a full SSV_LireConfig output parsing, using deku for a declarative bytes parsing

Co-authored-by: theo <t.lettermann@criteo.com>
Merge pull request 'Initialisation de la crate FSV, couche haut-niveau des accès aux fonctions SSV' (#71 ) from 38-fsv-high-level-lib into main
2024-10-09 22:50:38 +02:00 · 2024-10-09 22:46:41 +02:00 · 2024-10-09 22:45:01 +02:00 · 2024-10-09 22:43:25 +02:00 · 2024-10-09 22:38:53 +02:00 · 2024-10-09 22:38:53 +02:00
2 changed files with 4 additions and 9 deletions
--- a/crates/fsv-sys/README.md
+++ b/crates/fsv-sys/README.md
@ -13,13 +13,6 @@

 Les détails de l'avancement de l'implémentation des bindings FSV sont donnés dans le fichier [PROGRESS.md](PROGRESS.md)

-| Module      | Progression                        |
-|-------------|------------------------------------|
-| [SSV](#ssv) | ![](https://geps.dev/progress/5)   |
-| [SGD](#sgd) | ![](https://geps.dev/progress/0)   |
-| [SRT](#srt) | ![](https://geps.dev/progress/0)   |
-| [STS](#sts) | ![](https://geps.dev/progress/0)   |
-
 ## Utilisation

 ### Pré-requis
@ -39,5 +32,5 @@ Les détails de l'avancement de l'implémentation des bindings FSV sont donnés

 ### Pré-requis

- Pour la génération des bindings lors de la pahse de `build` à l'aide de `bindgen`, il est nécessaire d'avoir installé `clang` ([documentation](https://rust-lang.github.io/rust-bindgen/requirements.html)).
+- Pour la génération des bindings lors de la phase de `build` à l'aide de `bindgen`, il est nécessaire d'avoir installé `clang` ([documentation](https://rust-lang.github.io/rust-bindgen/requirements.html)).

--- a/crates/fsv/src/ssv/errors_ssv.rs
+++ b/crates/fsv/src/ssv/errors_ssv.rs
@ -3,6 +3,8 @@ use thiserror::Error;

 #[derive(Error, Debug, Eq, PartialEq, FromPrimitive)]
 #[repr(u16)]
+/// Liste des codes d'erreur retournés par la librairie C SSV
+/// Documentation: Manuel de programmation SSV - Annexe A (p. 215)
 pub enum SSVErrorCodes {
    #[error("La Carte du Professionnel de Santé est absente du lecteur.")]
    CPSMissing = 0xF001,
@ -17,7 +19,7 @@ pub enum SSVErrorCodes {
    /// - Sécurisation d'une série de lots en cours.
    /// - Pour les fonctions TLA (sauf Identifier TLA) : Cette erreur survient lorsque le simulateur TLA est en mode 1.50.
    /// - Lire Date Lecteur, Mettre à jour Date Lecteur, Lire Droits Vitale : Cette erreur peut survenir lorsque le Logiciel Lecteur ne connaît pas la fonction sollicitée, c'est-à-dire si la version du Logiciel Lecteur est antérieure à 2.00.
-    /// - Décharger Données Bénéficiaires : cette erreur peut survenir pour signaler que le
+    /// - Décharger Données Bénéficiaires : cette erreur peut survenir pour signaler que le format des données issues du lecteur est incompatible avec cette version de SSV.
    #[error("F022: Erreur commune à plusieurs fonctions.")]
    F022 = 0xF022,
    #[error("Message du lecteur incohérent. Débrancher et rebrancher le lecteur.")]
Author	SHA1	Message	Date
Florian Briand	8f935ab81e	feat: implement a full SSV_LireConfig output parsing, using deku for a declarative bytes parsing Co-authored-by: theo <t.lettermann@criteo.com>	2024-10-09 22:50:38 +02:00
florian_briand	c83824ae34	Merge pull request 'Initialisation de la crate FSV, couche haut-niveau des accès aux fonctions SSV' (#71 ) from 38-fsv-high-level-lib into main ### Détails - Création de la crate fsv, couche de haut niveau pour l'usage des librairies FSV - Implémentation partielle des appels "haut niveau" aux fonctions SSV_InitLIB2, SSV_LireCartePS et SSV_LireConfig - Implémentation de la gestion des erreurs numériques de la librairie C pour ces fonctions ### Pourquoi ? L'usage est de séparer les couches bas niveau, exposant des versions légèrement "rustifiées" des appels aux fonctions des librairies C, des couches "haut niveau", garantissant un usage "safe" et "user friendly". Contribue à #38 Closes #49 Reviewed-on: #71 Reviewed-by: kosssi <simon@p4pillon.org>	2024-10-09 22:46:41 +02:00
Florian Briand	1b94fefad3	fixup! feat: implémentation partielle de la fonction get_config et de ses erreurs	2024-10-09 22:45:01 +02:00
Florian Briand	5f7229c307	fixup! feat: Implémentation de la gestion des erreurs numériques de la librairie C pour la fonction InitLIB2	2024-10-09 22:43:25 +02:00
Florian Briand	d043915a29	feat: implémentation partielle de la fonction get_config et de ses erreurs	2024-10-09 22:38:53 +02:00
Florian Briand	2260b0cfa8	feat: implement LireCartePS with hardcoded reader and all errors	2024-10-09 22:38:53 +02:00
Florian Briand	203521fe01	feat: Implémentation de la gestion des erreurs numériques de la librairie C pour la fonction InitLIB2 Co-authored-by: theo <t.lettermann@criteo.com>	2024-10-09 22:38:53 +02:00
Florian Briand	3c1e691cb8	feat: Création de la crate fsv, couche de haut niveau pour l'usage des librairies FSV	2024-10-09 22:38:53 +02:00
florian_briand	add40f32c5	Merge pull request 'Création d'une sys-crate pour la gestion des librairies FSV' (#70 ) from feat/38-fsv-sys-crate into main ### Détails Début d'implémentation de bindings pour FSV SESAM-Vitale - Création de la crates/fsv-sys - Ajout des headers des versions FSV 1.40.14 et 1.40.13 dans un sous-dossier crates/fsv-sys/vendor - Génération des bindings depuis ces headers avec bindgen - Implémentation d'une structure de loading de la librairie au runtime - Un pattern similaire au "TypeState pattern" est utilisé pour gérer plusieurs versions possibles des bindings FSV - Une macro permet de générer avec un peu moins de boilerplate que nécessaire la couche d'accès aux fonctions de la librairie ### Pourquoi ? Cette PR est une étape importante du ticket #38 Une telle sys-crate, respectant (à peu près) les bonnes pratiques d'une telle implem, permet : - Pouvoir être diffusée publiquement en tant que telle, pour faciliter le travail à des copaines - De concentrer le travail très spécifique et bas niveau de gestion des librairies et des bindings dans une crate dédiée - De ne pas "forcer" une approche "orientée" sur l'API plus haut niveau qu'on décide de brancher sur ces bindings - En effet, l'implem haut niveau fait des choix non neutres, comme le choix de certains types, la technique de gestion des erreurs, etc. ### Documentation # Aide reçue sur les forums Rust - [Génération des bindings avec Bindgen](https://users.rust-lang.org/t/how-to-handle-bindgen-generating-types-aliases-instead-of-callable-functions/118083) - [Gestion des versions multiples avec la structure de loading de la librairie](https://users.rust-lang.org/t/manage-various-versions-of-a-c-library-loaded-at-runtime/118973) # Documentations - [Making a sys-crate](https://kornel.ski/rust-sys-crate) - [LibLoading](https://docs.rs/libloading/latest/libloading/) - [Bindgen](https://rust-lang.github.io/rust-bindgen/) Reviewed-on: #70 Reviewed-by: kosssi <simon@p4pillon.org>	2024-10-09 22:37:36 +02:00
Florian Briand	d8b8ce9a77	feat: improve the fsv-sys README, and add a PROGESS.md for implementation tracking	2024-10-09 22:31:26 +02:00
Florian Briand	9997ee43f8	feat: Gestion des versions multiples de FSV dans le wrapper exposant les fonctions de la librairie	2024-10-09 22:31:26 +02:00
Florian Briand	4ab8a1de81	feat: handle multi-version bindings generation	2024-10-09 22:31:26 +02:00
Florian Briand	d13f36c5e2	feat: Première implémentation de bindings pour FSV SESAM-Vitale - Création de la crates/fsv-sys - Ajout des headers de la FSV 1.40.14.13 dans crates/fsv-sys/vendor - Génération des bindings depuis ces headers avec bindgen - Implémentation d'une structure de loading de la librairie au runtime - Implémentation d'une macro permettant de générer facilement la couche d'accès aux fonctions de la librairie	2024-10-09 22:31:26 +02:00