Massive updated to the package

Author: divital-coder

Project.toml

@@ -8,8 +8,14 @@ CodecZstd = "6b39b394-51ab-5f42-8807-6242bab2b4c2"
 CxxWrap = "1f15a43c-97ca-5a2a-ae31-89f07a497df4"
 HepMC3_jll = "b85c3e40-22db-5268-bacb-02bd65cb4e01"
 Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
 
 [compat]
 CxxWrap = "0.16.0"
 HepMC3_jll = "3.3.0"
+
+[extras]
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Test"]

caveats.md

@@ -309,3 +309,92 @@ julia build.jl
 ```
 
 Run the test file 
+
+
+
+Critical Issue we encountered and fixed 
+
+
+SOltuion : dual typing C++ functions, 
+
+since shared pointer version work with jet reconstruction pipeline
+and 
+non shared_pointer function work with runtests.jl
+
+
+   mod.method("particles_size", &particles_size);
+    mod.method("vertices_size", &vertices_size);
+    mod.method("get_particle_at", &get_particle_at);
+    mod.method("get_vertex_at", &get_vertex_at);
+
+
+    // For raw pointers
+    mod.method("particles_size_raw", &particles_size_raw);
+    mod.method("vertices_size_raw", &vertices_size_raw);
+    mod.method("get_particle_at_raw", &get_particle_at_raw);
+    mod.method("get_vertex_at_raw", &get_vertex_at_raw);
+
+
+    after which we exposed interfaces for non_shared pointer for runtests.jl
+    ```
+
+    # ============================================================================
+# WRAPPER METHODS FOR SHARED_PTR COMPATIBILITY
+# ============================================================================
+
+# Create alias for the generated type
+const GenEventAllocated = var"HepMC3!GenEventAllocated"
+export GenEventAllocated
+
+
+
+# Replace the existing wrapper functions (around lines 942-977) with these:
+
+# ============================================================================
+# WRAPPER METHODS FOR TEST COMPATIBILITY (using _raw functions)
+# ============================================================================
+
+# Wrapper methods for GenEventAllocated (the type used in tests)
+function particles_size(event::GenEventAllocated)
+    event_raw_ptr = event.cpp_object  # This is GenEvent*
+    return particles_size_raw(event_raw_ptr)
+end
+
+function vertices_size(event::GenEventAllocated)
+    event_raw_ptr = event.cpp_object
+    return vertices_size_raw(event_raw_ptr)
+end
+
+function get_particle_at(event::GenEventAllocated, index::Integer)
+    event_raw_ptr = event.cpp_object
+    return get_particle_at_raw(event_raw_ptr, index - 1)  # Convert to 0-based indexing
+end
+
+function get_vertex_at(event::GenEventAllocated, index::Integer)
+    event_raw_ptr = event.cpp_object
+    return get_vertex_at_raw(event_raw_ptr, index - 1)
+end
+
+# Same for GenEvent type
+function particles_size(event::GenEvent)
+    event_raw_ptr = event.cpp_object
+    return particles_size_raw(event_raw_ptr)
+end
+
+function vertices_size(event::GenEvent)
+    event_raw_ptr = event.cpp_object
+    return vertices_size_raw(event_raw_ptr)
+end
+
+function get_particle_at(event::GenEvent, index::Integer)
+    event_raw_ptr = event.cpp_object
+    return get_particle_at_raw(event_raw_ptr, index - 1)
+end
+
+function get_vertex_at(event::GenEvent, index::Integer)
+    event_raw_ptr = event.cpp_object
+    return get_vertex_at_raw(event_raw_ptr, index - 1)
+end
+
+
+```

directions.md

@@ -7,26 +7,31 @@ cd gen
 rm -rf build/ cpp/jlHepMC3.* jl/
 julia build.jl
 ```
-## Apply patch to include manual wrappers, since we only define on Jlcxx module
+### Apply patch to include manual wrappers, since we only define on Jlcxx module
 ```bash
 sed -i '/#include "HepMC3\/Units.h"/a #include "HepMC3Wrap.h"' gen/cpp/jlHepMC3.cxx
 
 sed -i '/for(const auto& w: wrappers) w->add_methods();/a \  add_manual_hepmc3_methods(jlModule);' gen/cpp/jlHepMC3.cxx 
 ```
 
-## After applying patch rebuild the binary
+### After applying patch rebuild the binary
 
 ```julia
 cd gen/build
 
 cmake --build . --config Release --parallel 8
 ```
 
-# Executing a basic example
+### Executing a basic example
 
 ```julia
 cd ../..
 julia --project=. examples/basic_tree_julia.jl
 ```
 
 
+### Running Tests
+```julia
+julia --project=. -e "using Pkg; Pkg.build()"   
+julia --project=. -e "using Pkg; Pkg.test()"
+```   

gen/cpp/HepMC3Wrap.cxx

@@ -110,7 +110,14 @@ void add_manual_hepmc3_methods(jlcxx::Module& mod) {
     mod.method("vertices_size", &vertices_size);
     mod.method("get_particle_at", &get_particle_at);
     mod.method("get_vertex_at", &get_vertex_at);
-    
+
+
+    // For raw pointers
+    mod.method("particles_size_raw", &particles_size_raw);
+    mod.method("vertices_size_raw", &vertices_size_raw);
+    mod.method("get_particle_at_raw", &get_particle_at_raw);
+    mod.method("get_vertex_at_raw", &get_vertex_at_raw);
+
     // Run info support
     mod.method("create_gen_run_info", &create_gen_run_info);
     mod.method("set_event_run_info", &set_event_run_info);
@@ -123,10 +130,6 @@ void add_manual_hepmc3_methods(jlcxx::Module& mod) {
     mod.method("get_end_vertex_safe", &get_end_vertex_safe);
 
 
-
-
-
-
     mod.method("read_all_events_from_file", &read_all_events_from_file);
     mod.method("get_event_from_vector", &get_event_from_vector);
     mod.method("get_events_vector_size", &get_events_vector_size);

gen/cpp/HepMC3Wrap.h

@@ -142,6 +142,15 @@ extern "C" {
     void* get_event_from_vector(void* events_vector, int index);
     int get_events_vector_size(void* events_vector);
     void delete_events_vector(void* events_vector);
+
+
+
+    // New raw pointer functions for test compatibility
+    int particles_size_raw(void* event);
+    int vertices_size_raw(void* event);
+    void* get_particle_at_raw(void* event, int index);
+    void* get_vertex_at_raw(void* event, int index);
+
 }
 
 #endif

gen/cpp/HepMC3WrapImpl.cpp

@@ -391,32 +391,54 @@ void free_weights(double* weights) {
     delete[] weights;
 }
 
-int particles_size(void* event) {
-    auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
-    return (*e)->particles().size();
-}
 
-int vertices_size(void* event) {
-    auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
-    return (*e)->vertices().size();
-}
+
+
+// int particles_size(void* event) {
+//     // CHANGE: Input casting from shared_ptr* to GenEvent*
+//     auto e = static_cast<HepMC3::GenEvent*>(event);  // ← Was: std::shared_ptr<HepMC3::GenEvent>*
+//     return e->particles().size();
+// }
+
+// int vertices_size(void* event) {
+//     // CHANGE: Input casting from shared_ptr* to GenEvent*
+//     auto e = static_cast<HepMC3::GenEvent*>(event);  // ← Was: std::shared_ptr<HepMC3::GenEvent>*
+//     return e->vertices().size();
+// }
 
 // void* get_particle_at(void* event, int index) {
-//     auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
-//     if (index >= 0 && index < (int)(*e)->particles().size()) {
-//         return new std::shared_ptr<HepMC3::GenParticle>((*e)->particles()[index]);
+//     // CHANGE: Input casting from shared_ptr* to GenEvent*
+//     auto e = static_cast<HepMC3::GenEvent*>(event);  // ← Was: std::shared_ptr<HepMC3::GenEvent>*
+//     auto particles = e->particles();
+//     if (index >= 0 && index < (int)particles.size()) {
+//         // KEEP: Return shared_ptr for compatibility with JetReconstruction
+//         return new std::shared_ptr<HepMC3::GenParticle>(particles[index]);  // ← KEEP THIS
 //     }
 //     return nullptr;
 // }
 
 // void* get_vertex_at(void* event, int index) {
-//     auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
-//     if (index >= 0 && index < (int)(*e)->vertices().size()) {
-//         return new std::shared_ptr<HepMC3::GenVertex>((*e)->vertices()[index]);
+//     // CHANGE: Input casting from shared_ptr* to GenEvent*
+//     auto e = static_cast<HepMC3::GenEvent*>(event);  // ← Was: std::shared_ptr<HepMC3::GenEvent>*
+//     auto vertices = e->vertices();
+//     if (index >= 0 && index < (int)vertices.size()) {
+//         // KEEP: Return shared_ptr for compatibility with JetReconstruction
+//         return new std::shared_ptr<HepMC3::GenVertex>(vertices[index]);  // ← KEEP THIS
 //     }
 //     return nullptr;
 // }
 
+
+int particles_size(void* event) {
+    auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
+    return (*e)->particles().size();
+}
+
+int vertices_size(void* event) {
+    auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);  // ← Use shared_ptr
+    return (*e)->vertices().size();
+}
+
 void* get_particle_at(void* event, int index) {
     auto e = static_cast<std::shared_ptr<HepMC3::GenEvent>*>(event);
     auto particles = (*e)->particles();
@@ -436,6 +458,37 @@ void* get_vertex_at(void* event, int index) {
     }
     return nullptr;
 }
+
+// ADD these new functions for test compatibility (raw GenEvent* input)
+int particles_size_raw(void* event) {
+    auto e = static_cast<HepMC3::GenEvent*>(event);  // Raw pointer
+    return e->particles().size();
+}
+
+int vertices_size_raw(void* event) {
+    auto e = static_cast<HepMC3::GenEvent*>(event);  // Raw pointer
+    return e->vertices().size();
+}
+
+void* get_particle_at_raw(void* event, int index) {
+    auto e = static_cast<HepMC3::GenEvent*>(event);  // Raw pointer
+    auto particles = e->particles();
+    if (index >= 0 && index < (int)particles.size()) {
+        return new std::shared_ptr<HepMC3::GenParticle>(particles[index]);  // Still return shared_ptr
+    }
+    return nullptr;
+}
+
+void* get_vertex_at_raw(void* event, int index) {
+    auto e = static_cast<HepMC3::GenEvent*>(event);  // Raw pointer
+    auto vertices = e->vertices();
+    if (index >= 0 && index < (int)vertices.size()) {
+        return new std::shared_ptr<HepMC3::GenVertex>(vertices[index]);  // Still return shared_ptr
+    }
+    return nullptr;
+}
+
+
 // Run info support
 void* create_gen_run_info() {
     return new std::shared_ptr<HepMC3::GenRunInfo>(std::make_shared<HepMC3::GenRunInfo>());