fix: adapt the clego setup to windows

Reviewed-on: P4Pillon/Krys4lide#1

.gitignore

@@ -1,6 +1,14 @@
-# Ignore Rust target directory
-/target
+# ---> Rust
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
 
-# Ignore .env files
-.env
-.env.build
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# IDEs and editors
+.vscode

Cargo.lock

@@ -2,6 +2,14 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "clego"
+version = "0.1.0"
+dependencies = [
+ "dotenv",
+ "libc",
+]
+
 [[package]]
 name = "dotenv"
 version = "0.15.0"
@@ -13,11 +21,3 @@ name = "libc"
 version = "0.2.155"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c"
-
-[[package]]
-name = "utils-debug-c-lib"
-version = "0.1.0"
-dependencies = [
- "dotenv",
- "libc",
-]

Cargo.toml

@@ -1,12 +1,5 @@
-[package]
-name = "utils-debug-c-lib"
-version = "0.1.0"
-edition = "2021"
-build = "build.rs"
-
-[dependencies]
-dotenv = "0.15"
-libc = "0.2"
-
-[build-dependencies]
-dotenv = "0.15"
+[workspace]
+members = [
+       "clego"
+]
+resolver = "2"

README.md

@@ -1,46 +1,3 @@
-## Requirements
+# Krys4lide
 
-- Installer le [package FSV](https://industriels.sesam-vitale.fr/group/fournitures-sesam-vitale)
-    - Les librairies dynamiques (.lib, .dll, ...) fournies ne sont pas installés dans les emplacements standard du système, il faudra donc configurer leur chemin d'installation dans le fichier de configuration `.env.build` (voir ci-dessous)
-        - Le détail des chemins d'installation est donné dans la documentation du package FSV `fsv-mi-004_pack-FSV1.40.14_V2.3.pdf`
-            - Linux - par défaut : `/opt/santesocial/fsv/1.40.13/lib`
-            - Windows - par défaut : `C:\Program Files\santesocial\santesocial\fsv\1.40.14\lib` (ou dans Program Files (x86) si c'est le package 32bits qui a été installé)
-
-- Installer la [CryptolibCPS](https://industriels.sesam-vitale.fr/group/galss-cryptolib-cps)
-    - Ce package fourni également l'utilitaire "CPS Gestion" pour obtenir des informations sur le lecteur de carte, etc.
-        - Linux : `cpgeslux`
-        - Windows : `...`
-
-## Setup
-
-- Créer et éditer le fichier de configuration de build `.env.build` en s'inspirant d'un des fichiers d'exemple (`.env.build.linux.example`, `.env.build.win.example`...)
-    - Ce fichier est nécessaire pour le build du package Rust
-- Créer et éditer le fichier de configuration de l'exécution `.env` en s'inspirant d'un des fichiers d'exemple (`.env.linux.example`, `.env.win.example`...)
-    - Ce fichier est nécessaire pour l'exécution du package Rust compilé, et doit donc être présent aux côtés de l'exécutable généré, le cas échéant
-
-## Build
-
-### Compilation C
-
-Ce package s'appuie sur deux librairies :
-- Une librairie statique, compilée à partir des sources (`*.c`, `*.h`) fournies dans le dossier `./src`
-- Une librairie dynamique, fournie par le package FSV
-    - Windows : on fournit les headers, non présents dans la `.dll` en compilant les fichiers `src/*.def` en leur version binaire `lib/*.lib`
-
-Pour compiler les fichiers de librairie :
-
-- Windows : `.\make.bat`
-- Linux : `make`
-
-Pour nettoyer le dossier `./lib` :
-
-- Windows : `.\make.bat /clean`
-- Linux : `make clean`
-
-### Compilation Rust
-
-`cargo build`
-
-## Run
-
-`cargo run`
+Logiciel de pharmacie

clego/.gitignore

@@ -0,0 +1,9 @@
+# Ignore Rust target directory
+/target
+
+# Ignore .env files
+.env
+.env.build
+
+# Ignore exploitation files - only usefull for local debugging on windows
+lib/*.exp

clego/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "clego"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dotenv = "0.15"
+libc = "0.2"
+
+[build-dependencies]
+dotenv = "0.15"

clego/README.md

@@ -0,0 +1,33 @@
+## Requirements
+
+- Installer le [package FSV](https://industriels.sesam-vitale.fr/group/fournitures-sesam-vitale)
+    - Les librairies dynamiques (.lib, .dll, ...) fournies ne sont pas installés dans les emplacements standard du système, il faudra donc configurer leur chemin d'installation dans le fichier de configuration `.env.build` (voir ci-dessous)
+        - Le détail des chemins d'installation est donné dans la documentation du package FSV `fsv-mi-004_pack-FSV1.40.14_V2.3.pdf`
+            - Linux - par défaut : `/opt/santesocial/fsv/1.40.13/lib`
+            - Windows - par défaut : `C:\Program Files\santesocial\santesocial\fsv\1.40.14\lib` (ou dans Program Files (x86) si c'est le package 32bits qui a été installé)
+
+- Installer la [CryptolibCPS](https://industriels.sesam-vitale.fr/group/galss-cryptolib-cps)
+    - Ce package fourni également l'utilitaire "CPS Gestion" pour obtenir des informations sur le lecteur de carte, etc.
+        - Linux : `cpgeslux`
+        - Windows : `...`
+
+## Setup
+
+- Créer et éditer le fichier de configuration de build `.env.build` en s'inspirant d'un des fichiers d'exemple (`.env.build.linux.example`, `.env.build.win.example`...)
+    - Ce fichier est nécessaire pour le build du package Rust
+- Créer et éditer le fichier de configuration de l'exécution `.env` en s'inspirant d'un des fichiers d'exemple (`.env.linux.example`, `.env.win.example`...)
+    - Ce fichier est nécessaire pour l'exécution du package Rust compilé, et doit donc être présent aux côtés de l'exécutable généré, le cas échéant
+
+## Build
+
+### Windows - Compilation des headers FSV
+
+Sous windows, la librairie dynamique fournie par le package FSV nécessite des header qui ne sont pas présents dans la `.dll`. Il est donc nécessaire de fournir ces headers, en les renseignant dans des fichiers `src/ssv_headers_c/*.def` qui seront compilés en leur version binaire `lib/*.lib`.
+
+En cas de modification des fichiers `.def`, pour re-compiler ces headers, faire appel au script `make.bat` du dossier `src/ssv_headers_c`.
+
+
+## À creuser
+
+- Compilation cross platform facilitée par du Docker : https://github.com/cross-rs/cross
+- Pour éviter l'usage de dotenv pour la configuration, on peut utiliser https://direnv.net/

clego/build.rs

@@ -4,23 +4,28 @@ use std::env;
 use std::path::PathBuf;
 
 fn main() {
+    // Load the .env.build file for build-time environment variables
     dotenv::from_filename(".env.build").ok();
     println!("cargo::rerun-if-changed=.env.build");
 
     let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
 
+    // Add local lib directory to the linker search path (for def files and static libs)
     let static_lib_path = PathBuf::from(manifest_dir).join("lib");
     println!("cargo::rustc-link-search=native={}", static_lib_path.display());
-    println!("cargo::rustc-link-lib=static=p4pillondebuglib");
 
+    // Add the SESAM_FSV_LIB_PATH to the linker search path
     let fsv_lib_path = PathBuf::from(env::var("SESAM_FSV_LIB_PATH").unwrap());
     println!("cargo::rustc-link-search=native={}", fsv_lib_path.display());
-    println!("cargo::rustc-link-lib=dylib={}", env::var("SESAM_FSV_SSVLIB").unwrap());
 
+    // Add the SESAM_FSV_LIB_PATH to the PATH environment variable
     if cfg!(target_os = "windows") {
         let path = env::var("PATH").unwrap_or(String::new());
         println!("cargo:rustc-env=PATH={};{}", fsv_lib_path.display(), path);
     } else if cfg!(target_os = "linux") {
         println!("cargo:rustc-env=LD_LIBRARY_PATH={}", fsv_lib_path.display());
     }
+
+    // Link the SESAM_FSV_SSVLIB dynamic library
+    println!("cargo::rustc-link-lib=dylib={}", env::var("SESAM_FSV_SSVLIB").unwrap());
 }

clego/src/main.rs

@@ -0,0 +1,5 @@
+mod ssvlib_demo;
+
+fn main() {
+    ssvlib_demo::demo();
+}

clego/src/ssv_headers_c/make.bat

@@ -0,0 +1,28 @@
+@echo off
+rem Set variables
+set LIB_DIR=..\..\lib
+
+rem Create the %LIB_DIR% directory if it does not exist
+if not exist %LIB_DIR% mkdir %LIB_DIR%
+
+if "%1"=="/clean" (
+    goto clean
+)
+
+rem Set the environment for the x64 platform
+call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
+
+rem Create a ssvw64.lib file from the ssvw64.def file
+lib /def:ssvw64.def /out:%LIB_DIR%\ssvw64.lib /machine:x64
+
+rem Build complete
+pause
+exit /b 0
+
+:clean
+del %LIB_DIR%\*.lib
+del %LIB_DIR%\*.exp
+
+rem Clean complete
+pause
+exit /b 0

make.bat

@@ -1,36 +0,0 @@
-@echo off
-rem Set variables
-set SRC_DIR=src
-set LIB_DIR=lib
-
-rem Create the %LIB_DIR% directory if it does not exist
-if not exist %LIB_DIR% mkdir %LIB_DIR%
-
-if "%1"=="/clean" (
-    goto clean
-)
-
-rem Configure the environment for Visual Studio
-call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
-
-rem Build %SRC_DIR%\*.c files
-cl /c /Fd:%LIB_DIR%\ /Fo:%LIB_DIR%\ /Iinclude\ /I%SRC_DIR%\ %SRC_DIR%\*.c
-
-rem Link the object files into a static library
-lib %LIB_DIR%\*.obj
-
-rem Create a ssvw64.lib file from a ssvw64.def file
-lib /def:%SRC_DIR%\ssvw64.def /out:%LIB_DIR%\ssvw64.lib /machine:x64
-
-rem Build complete
-pause
-exit /b 0
-
-:clean
-del %LIB_DIR%\*.obj
-del %LIB_DIR%\*.lib
-del %LIB_DIR%\*.exp
-
-rem Clean complete
-pause
-exit /b 0

makefile

@@ -1,32 +0,0 @@
-# Detect the operating system
-ifeq ($(OS),Windows_NT)
-    MKDIR = if not exist $(LIB_DIR) mkdir $(LIB_DIR)
-    RM = del
-else
-    MKDIR = mkdir -p $(LIB_DIR)
-    RM = rm -f
-endif
-
-CC = gcc
-AR = ar
-CFLAGS = -Wall -fPIC
-SRC_DIR = src
-LIB_DIR = lib
-SRC_FILES = $(wildcard $(SRC_DIR)/*.c)
-OBJ_FILES = $(SRC_FILES:$(SRC_DIR)/%.c=$(LIB_DIR)/%.o)
-STATIC_LIB = $(LIB_DIR)/libp4pillondebuglib.a
-
-all: $(STATIC_LIB)
-
-$(STATIC_LIB): $(OBJ_FILES)
-	$(MKDIR)
-	$(AR) rcs $@ $^
-
-$(LIB_DIR)/%.o: $(SRC_DIR)/%.c
-	$(MKDIR)
-	$(CC) $(CFLAGS) -c $< -o $@
-
-clean:
-	$(RM) $(OBJ_FILES) $(STATIC_LIB)
-
-.PHONY: all clean

src/main.rs

@@ -1,7 +0,0 @@
-mod p4pillondebuglib_demo;
-mod ssvlib_demo;
-
-fn main() {
-    p4pillondebuglib_demo::demo();
-    ssvlib_demo::demo();
-}

src/p4pillondebuglib.c

@@ -1,57 +0,0 @@
-// mylib.c
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-
-char* hello() {
-    return "Hello, World!";
-}
-
-char* helloName(const char *name) {
-    char *result = (char *)malloc(strlen(name) + 9);
-    if (result) {
-        sprintf(result, "Hello, %s!", name);
-    }
-    return result;
-}
-
-void helloPtr(char *result) {
-    sprintf(result, "Hello, World!");
-}
-
-void helloPtrPtr(char **result, size_t *size) {
-    const char *message = "Hello, World!";
-    *size = strlen(message) + 1; // +1 for null terminator
-    *result = (char *)malloc(*size);
-    if (*result) {
-        strcpy(*result, message);
-    }
-}
-
-void helloVoidPtrPtr(void **result, size_t *size) {
-    const char *message = "Hello, World!";
-    *size = strlen(message) + 1; // +1 for null terminator
-    *result = malloc(*size);
-    if (*result != NULL) {
-        strcpy((char *)*result, message);
-    }
-}
-
-int add(int a, int b) {
-    return a + b;
-}
-
-// Add function returning result in a pointer
-void addPtr(int a, int b, int *result) {
-    *result = a + b;
-}
-
-void fillHexValues(void **result, size_t *size) {
-    unsigned char values[5] = {0x05, 0xE7, 0x02, 0x00, 0x00};
-
-    *size = sizeof(values);
-    *result = malloc(*size);
-    if (*result != NULL) {
-        memcpy(*result, values, *size);
-    }
-}

src/p4pillondebuglib.h

@@ -1,15 +0,0 @@
-#ifndef P4PILLONDEBUGLIB_H
-#define P4PILLONDEBUGLIB_H
-
-#include <stddef.h>
-
-char* hello();
-char* helloName(const char *name);
-void helloPtr(char *result);
-void helloPtrPtr(char **result, size_t *size);
-void helloVoidPtrPtr(void **result, size_t *size);
-int add(int a, int b);
-void addPtr(int a, int b, int *result);
-void fillHexValues(void **result, size_t *size);
-
-#endif // P4PILLONDEBUGLIB_H

src/p4pillondebuglib_demo.rs

@@ -1,101 +0,0 @@
-extern crate libc;
-
-use libc::{ c_char, c_int, c_void, size_t };
-use std::ffi::{ CStr, CString };
-use std::ptr;
-
-#[link(name = "p4pillondebuglib")]
-extern "C" {
-    fn hello() -> *const c_char;
-    fn helloName(name: *const c_char) -> *const c_char;
-    fn helloPtr(result: *mut c_char);
-    fn helloPtrPtr(result: *mut *mut c_char, size: *mut size_t);
-    fn helloVoidPtrPtr(result: *mut *mut c_void, size: *mut size_t);
-    fn add(a: c_int, b: c_int) -> c_int;
-    fn addPtr(a: c_int, b: c_int, result: *mut c_int);
-    fn fillHexValues(result: *mut *mut c_void, size: *mut size_t);
-}
-
-pub fn demo() {
-    println!("------- Demo for the P4PillonDebugLib ---");
-    
-    unsafe {
-        let c_str = hello();
-        let r_str: &str = CStr::from_ptr(c_str).to_str().unwrap();
-        println!("{} from C", r_str);
-    }
-
-    let name = CString::new("John").expect("CString::new failed");
-    unsafe {
-        let c_str = helloName(name.as_ptr());
-        let r_str = CStr::from_ptr(c_str).to_str().expect("Conversion failed");
-        println!("{} from C with name", r_str);
-
-        libc::free(c_str as *mut c_void);
-    }
-
-    let mut buffer: [c_char; 50] = [0; 50];
-    unsafe {
-        helloPtr(buffer.as_mut_ptr());
-        let c_str = CStr::from_ptr(buffer.as_ptr());
-        let r_str = c_str.to_str().unwrap();
-        println!("{} from C Ptr", r_str);
-    }
-
-    let mut buffer: *mut c_char = ptr::null_mut();
-    let mut size: size_t = 0;
-    unsafe {
-        helloPtrPtr(&mut buffer, &mut size);
-        
-        if !buffer.is_null() {
-            let c_str = CStr::from_ptr(buffer);
-            let r_str = c_str.to_str().unwrap();
-            println!("{} from C Ptr Ptr (size: {})", r_str, size);
-
-            libc::free(buffer as *mut c_void);
-        }
-    }
-
-    let mut buffer: *mut c_void = ptr::null_mut();
-    let mut size: size_t = 0;
-    unsafe {
-        helloVoidPtrPtr(&mut buffer, &mut size);
-        
-        if !buffer.is_null() {
-            let c_str = CStr::from_ptr(buffer as *const c_char);
-            let r_str = c_str.to_str().unwrap();
-            println!("{} from C Void Ptr Ptr (size: {})", r_str, size);
-
-            libc::free(buffer);
-        }
-    }
-
-    unsafe {
-        let result = add(1, 2);
-        println!("Result of 1 + 2 = {}", result);
-    }
-
-    unsafe {
-        let mut result = 0;
-        addPtr(1, 2, &mut result);
-        println!("Result Ptr of 1 + 2 = {}", result);
-    }
-
-    let mut buffer: *mut c_void = ptr::null_mut();
-    let mut size: size_t = 0;
-    unsafe {
-        fillHexValues(&mut buffer, &mut size);
-        
-        if !buffer.is_null() {
-            let hex_values = std::slice::from_raw_parts(buffer as *const u8, size);
-            for &byte in hex_values {
-                print!("{:02X} ", byte);
-            }
-            println!();
-
-            libc::free(buffer);
-        }
-    }
-
-    println!("-----------------------------------------");
-}