added GEMC_PLUGIN_PATH and fixed case where nullptr for GDigitizedData was not picked up in gEventAction.cc

Author: maureeungaro

.github/workflows/test.yml

@@ -16,26 +16,17 @@ concurrency:
   cancel-in-progress: true
 
 on:
+  workflow_dispatch:
   pull_request:
     paths-ignore:
       - "**/*.md"
-      - "**/README*"
-      - "**/LICENSE*"
-      - "**/CODE_OF_CONDUCT.md"
-      - "**/CONTRIBUTING.md"
-      - "**/SECURITY.md"
+
   merge_group:
   push:
     branches: [ main ]
     tags: [ '*' ]
     paths-ignore:
       - "**/*.md"
-      - "**/README*"
-      - "**/CODE_OF_CONDUCT.md"
-      - "**/CONTRIBUTING.md"
-      - "**/SECURITY.md"
-      - "releases/**"
-      - "doc/**"
 
 jobs:
   discover:

gemc/actions/event/gEventAction.cc

@@ -2,7 +2,7 @@
 #include "../gactionConventions.h"
 
 // geant4
-#include "G4EventManager.hh"
+#include "G4Event.hh"
 #include "G4Threading.hh"
 
 // gemc
@@ -140,7 +140,9 @@ void GEventAction::EndOfEventAction([[maybe_unused]] const G4Event* event) {
 			auto digi_data = digitization_routine->digitizeHit(this_hit, hitIndex);
 
 			if (collection_mode == CollectionMode::event) {
-				eventDataCollection->addDetectorDigitizedData(hcSDName, std::move(digi_data));
+				if (digi_data != nullptr) {
+					eventDataCollection->addDetectorDigitizedData(hcSDName, std::move(digi_data));
+				}
 				eventDataCollection->addDetectorTrueInfoData(hcSDName, std::move(true_data));
 				has_event_mode_payload = true;
 			}

gemc/gfactory/gdl.h

@@ -9,6 +9,9 @@
 #include <dlfcn.h>
 
 // c++
+#include <cstdlib>
+#include <filesystem>
+#include <sstream>
 #include <sys/stat.h> // to check if file exists
 #include <string>
 
@@ -83,6 +86,24 @@ struct DynamicLib
 		log->debug(CONSTRUCTOR, "Instantiating ", path);
 		log->debug(NORMAL, "Trying ", dlFileName);
 
+		// Try GEMC_PLUGIN_PATH directories before falling back to gemc installation paths.
+		if (!doesFileExists(dlFileName)) {
+			log->debug(NORMAL, dlFileName, " not found...");
+
+			if (const char* envPath = std::getenv("GEMC_PLUGIN_PATH")) {
+				std::istringstream ss(envPath);
+				std::string        dir;
+				while (std::getline(ss, dir, ':')) {
+					const std::string candidate = dir + "/" + path;
+					if (doesFileExists(candidate)) {
+						dlFileName = candidate;
+						break;
+					}
+				}
+			}
+			log->debug(NORMAL, "Trying ", dlFileName);
+		}
+
 		// Try installation path + "/lib" if not found at the provided location.
 		if (!doesFileExists(dlFileName)) {
 			log->debug(NORMAL, dlFileName, " not found...");
@@ -113,7 +134,14 @@ struct DynamicLib
 			}
 			else { log->info(1, "Loaded ", dlFileName); }
 		}
-		else { log->error(ERR_DLNOTFOUND, "could not find ", dlFileName); }
+		else {
+				const char* envPath = std::getenv("GEMC_PLUGIN_PATH");
+				log->error(ERR_DLNOTFOUND,
+				           "could not find ", dlFileName, "\n",
+				           "  GEMC_PLUGIN_PATH = ", (envPath ? envPath : "(not set)"), "\n",
+				           "  Hint: set GEMC_PLUGIN_PATH or use -plugin_path=<dir> to the directory ",
+				           "containing *.gplugin files.");
+			}
 	}
 
 	/**

gemc/gfactory/gfactory.h

@@ -13,7 +13,9 @@
  */
 
 // C++
+#include <filesystem>
 #include <memory>
+#include <sstream>
 #include <string>
 #include <string_view>
 #include <unordered_map>
@@ -128,7 +130,7 @@ class GManager : public GBase<GManager>
 	 *
 	 * \note The manager uses the `PLUGIN_LOGGER` channel for plugin-related output.
 	 */
-	explicit GManager(const std::shared_ptr<GOptions>& gopt) : GBase(gopt, PLUGIN_LOGGER) {
+	explicit GManager(const std::shared_ptr<GOptions>& gopt) : GBase(gopt, PLUGIN_LOGGER), gopts_(gopt) {
 	}
 
 	/// No copy – the manager owns unique resources (factory objects and loaded libraries).
@@ -218,6 +220,9 @@ class GManager : public GBase<GManager>
 	/// Map from plugin key to the loaded library handle.
 	std::unordered_map<std::string, std::shared_ptr<DynamicLib>> dlMap_;
 
+	/// Options retained so registerDL can read plugin_path at load time.
+	std::shared_ptr<GOptions> gopts_;
+
 	/// Optional human-readable manager name (currently unused here).
 	std::string gname;
 };
@@ -230,14 +235,32 @@ inline void GManager::clearDLMap() noexcept {
 }
 
 inline void GManager::registerDL(std::string_view name) {
-	// Convention: plugins are packaged as "<name>.gplugin".
-	const std::string filename = std::string{name} + ".gplugin";
+	const std::string basename = std::string{name} + ".gplugin";
+
+	// Build the colon-separated search path: -plugin_path option takes
+	// precedence, then GEMC_PLUGIN_PATH env var, then CWD / system library path.
+	std::string filename = basename;
+	if (gopts_) {
+		std::string searchPath = gopts_->getScalarString("plugin_path");
+		if (searchPath.empty()) {
+			if (const char* env = std::getenv("GEMC_PLUGIN_PATH")) { searchPath = env; }
+		}
+		if (!searchPath.empty()) {
+			std::istringstream ss(searchPath);
+			std::string dir;
+			while (std::getline(ss, dir, ':')) {
+				const std::string candidate = dir + "/" + basename;
+				if (std::filesystem::exists(candidate)) {
+					filename = candidate;
+					break;
+				}
+			}
+		}
+	}
 
-	// Store the DynamicLib in a shared_ptr so it can be safely captured by
-	// a shared_ptr deleter in LoadAndRegisterObjectFromLibrary().
 	dlMap_.emplace(std::string{name},
 	               std::make_shared<DynamicLib>(log, filename));
-	log->debug(NORMAL, "Loading DL ", name);
+	log->debug(NORMAL, "Loading DL ", name, " (resolved: ", filename, ")");
 }
 
 template <class Derived>
@@ -291,5 +314,10 @@ std::shared_ptr<T> GManager::LoadAndRegisterObjectFromLibrary(std::string_view
 		});
 	}
 
-	log->error(ERR_DLHANDLENOTFOUND, "Plugin ", name, " could not be loaded.");
+	const char* envPath = std::getenv("GEMC_PLUGIN_PATH");
+	log->error(ERR_DLHANDLENOTFOUND,
+	           "Plugin ", name, ".gplugin could not be loaded.\n",
+	           "  GEMC_PLUGIN_PATH = ", (envPath ? envPath : "(not set)"), "\n",
+	           "  Hint: set GEMC_PLUGIN_PATH or use -plugin_path=<dir> to point to the directory ",
+	           "containing *.gplugin files.");
 }

gemc/gfactory/gfactory_options.cc

@@ -3,13 +3,17 @@
 // project goption to a system
 namespace gfactory {
 
-// returns array of options definitions
 GOptions defineOptions() {
 
-	// Construct the options container for the plugin logger channel.
-	// Individual flags can be added here as the module evolves.
 	GOptions goptions(PLUGIN_LOGGER);
 
+	goptions.defineOption(
+		GVariable("plugin_path", "", "colon-separated list of directories to search for .gplugin files"),
+		"Additional directories searched for GEMC plugin libraries (*.gplugin) before the\n"
+		"current working directory and the system library path (LD_LIBRARY_PATH / DYLD_LIBRARY_PATH).\n"
+		"Example: -plugin_path=/opt/clas12/lib:/usr/local/gemc/plugins"
+	);
+
 	return goptions;
 }
 

gemc/gstreamer/factories/ROOT/gstreamerROOTFactory.cc

@@ -74,6 +74,7 @@ const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateHeaderTr
 const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateTrueInfoDataTree(
 	const std::string&   detectorName,
 	const GTrueInfoData* gdata) {
+	rootfile->cd();
 	std::string treeName = TRUEINFONAMEPREFIX + detectorName;
 
 	auto& treePtr = gRootTrees[treeName];
@@ -90,6 +91,7 @@ const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateTrueInfo
 const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateDigitizedDataTree(
 	const std::string&    detectorName,
 	const GDigitizedData* gdata) {
+	rootfile->cd();
 	std::string treeName = DIGITIZEDNAMEPREFIX + detectorName;
 
 	auto& treePtr = gRootTrees[treeName];
@@ -104,6 +106,7 @@ const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateDigitize
 const std::unique_ptr<GRootTree>& GstreamerRootFactory::getOrInstantiateGeneratedParticleTree(
 	const std::string& treeName,
 	const GGeneratedParticleBank& particles) {
+	rootfile->cd();
 	auto& treePtr = gRootTrees[treeName];
 	if (!treePtr) {
 		log->info(2, "GstreamerRootFactory", "Creating generated-particle ROOT tree for ", treeName);

meson.build

@@ -247,7 +247,6 @@ pkg.generate(
     version : meson.project_version(),
     libraries : all_libs,
     libraries_private : [yaml_cpp_dep, clhep_deps, geant4_core_deps, zlib_dep],
-    subdirs : 'gemc',
 )
 
 # test gemc options. Adjust root to fit the geometry

meson/meson.build

@@ -174,6 +174,13 @@ assimp_dep = assimp_proj.dependency('assimp')
 yaml_cpp_proj = cmake.subproject('yaml-cpp', options : cmake_opts)
 yaml_cpp_dep = yaml_cpp_proj.dependency('yaml-cpp')
 
+# yaml-cpp headers are part of gemc's public API (goption.h includes yaml-cpp/yaml.h)
+# so they must be installed alongside the gemc headers.
+install_subdir(
+    meson.project_source_root() / 'subprojects' / 'yaml-cpp' / 'include' / 'yaml-cpp',
+    install_dir : get_option('includedir'),
+)
+
 # sanitizer settings
 project_test_env = environment()
 project_test_env.set(

releases/0.3.md

@@ -8,6 +8,8 @@ This version includes:
 - Theme-aware SVG toggle icons for display options
 - Volume inspection from the geometry tree
 - Unified `value*unit` notation for `gparticle` kinematic fields
+- `GEMC_PLUGIN_PATH` and `-plugin_path` for external plugin discovery
+- ROOT gstreamer and event-action bug fixes
 
 <br/>
 
@@ -323,6 +325,19 @@ Both x86_64 and ARM64 platforms are supported.
   `/vis/scene/add/volume <name> -1`, sets white background and a `text2D` label,
   flushes, then restores focus with `/vis/viewer/select`; button text is set to
   "Inspect `<volumename>`" when a volume node is selected in the tree.
+- Added `plugin_path` option and `GEMC_PLUGIN_PATH` environment variable support to `GManager::registerDL`
+  so plugins installed to a separate prefix are found without touching `LD_LIBRARY_PATH`.
+- Extended `DynamicLib` constructor to search `GEMC_PLUGIN_PATH` directories before the existing
+  `<gemc_root>/lib/` and `<gemc_root>/build/` fallbacks; diagnostic output on failure shows the current
+  env-var value and a usage hint for both `GEMC_PLUGIN_PATH` and `-plugin_path`.
+- Fixed a segmentation fault in the ROOT gstreamer plugin: `getOrInstantiateDigitizedDataTree`,
+  `getOrInstantiateTrueInfoDataTree`, and `getOrInstantiateGeneratedParticleTree` now call `rootfile->cd()`
+  before creating `TTree` objects, matching the existing pattern in `getOrInstantiateHeaderTree`; without
+  this, ROOT's thread-local `gDirectory` on a Geant4 worker thread does not point at the output file.
+- Fixed event-mode null-pointer crash in `gEventAction.cc`: `GDigitizedData` pointers returned as `nullptr`
+  by `digitizeHitImpl` (the base-class default for plugins that have not yet implemented digitization) are now
+  skipped instead of being inserted into the collection, matching the existing run-mode null guard and
+  preventing the ROOT streamer from dereferencing a null pointer when building the tree schema.
 - Removed `punit`, `aunit`, and `vunit` from the `gparticle` option schema.
   Added `parseG4Value()` in `gparticle_options.cc`: reads each kinematic YAML
   field as a string, calls `gutilities::getG4Number()` directly when a `*unit`