added glogger to gphysics

Author: maureeungaro

.github/workflows/sanitize.yaml

@@ -25,13 +25,10 @@ jobs:
             image: jeffersonlab/geant4:g4v11.3.1-fedora36
           - name: almalinux93
             image: jeffersonlab/geant4:g4v11.3.1-almalinux94
-        # to be revisited
-        # NOTE1: `b_sanitize=memory` is not used because `libc++` needs to be re-compiled with `-fsanitize=memory`, otherwise
-        #        we are bothered by false positives (e.g., from `std::map` insertion)
-        # NOTE2: additional packages needed for the sanitizer: libasan libubsan libtsan
-        # NOTE3: address, thread, leak: some examples are not working. Need to investigate.
-        sanitize: [ none, address, thread, undefined, memory, leak ]
-        #sanitize: [ standard, undefined ]
+        # NOTE: additional packages needed for the sanitizer: libasan libubsan libtsan
+        # MacOS: address, thread, undefined
+        # Linux: address, hwaddress, leak, undefined, integer, thread, cfi, kcfi, shadowcallstack
+        sanitize: [ none, address, hwaddress, leak, undefined, integer, thread, cfi, kcfi, shadowcallstack ]
     runs-on: ubuntu-latest
     continue-on-error: true
     container: ${{ matrix.container.image }}

glogging/glogger.h

@@ -164,7 +164,7 @@ class GLogger {
 
 private:
 	std::string verbosity_name;    ///< Verbosity name
-	std::string calling_class;     ///< Class name calling the logger constructor
+	std::string calling_class;     ///< Name of class/method calling the logger constructor
 	int         verbosity_level{}; ///< Verbosity level (0 = low, >0 = detailed)
 	int         debug_level{};     ///< Debug level: 0 = off, 1 = normal, 10/-10 = ctor/dtor
 

goptions/goptions.cc

@@ -39,7 +39,7 @@ GOptions::GOptions(int argc, char *argv[], const GOptions &user_defined_options)
 	defineSwitch("gui", "use Graphical User Interface");
 	defineSwitch("i", "use interactive batch mode");
 	defineOption(
-			GVariable("conf_yaml", "saved_configuration", "the yaml filename prefix where all used options are saved"),
+			GVariable("conf_yaml", "saved_configuration", "the prefix for filename that store the used options"),
 			"The default value appends \"_saved_configuration\" to the executable name.");
 
 	// version is a special option, not settable by the user

gphysics/examples/example.cc

@@ -0,0 +1,17 @@
+// gphysics
+#include "gphysics.h"
+#include "gphysics_options.h"
+
+// goptions
+#include "goptions.h"
+
+
+int main(int argc, char* argv[]) {
+	auto gopts = new GOptions(argc, argv, gphysics::defineOptions());
+	auto log   = std::make_shared<GLogger>(gopts, GPHYSICS_LOGGER, "gphysics_example");
+
+	[[maybe_unused]] auto gphysics = new GPhysics(gopts, log);
+
+	delete gphysics;
+	return EXIT_SUCCESS;
+}

gphysics/examples/example.yaml

@@ -2,14 +2,12 @@
 #include "gphysics.h"
 #include "gphysicsConventions.h"
 
-// glibrary
+// gemc
 #include "gutilities.h"
 
 // geant4 version
 #include "G4Version.hh"
 
-// c++
-using namespace std;
 
 // geant4
 
@@ -29,8 +27,8 @@ using namespace std;
 #include "G4PhysicsConstructorFactory.hh"
 
 
-GPhysics::GPhysics(GOptions *gopts) : physList(nullptr) {
-
+GPhysics::GPhysics(GOptions *gopts, std::shared_ptr<GLogger> logger) : physList(nullptr), log(logger) {
+	log->debug(CONSTRUCTOR, "GPhysics");
 
     bool showPhys = gopts->getSwitch("showAvailablePhysics");
     bool showPhysX = gopts->getSwitch("showAvailablePhysicsX");
@@ -50,31 +48,35 @@ GPhysics::GPhysics(GOptions *gopts) : physList(nullptr) {
     // would make this a drop-in replacement, but we'll list the explicit
     // namespace here just for clarity
     g4alt::G4PhysListFactory factory;
-    string g4physList = removeAllSpacesFromString(gphysList);
+    string g4physList = gutilities::removeAllSpacesFromString(gphysList);
 
     physList = factory.GetReferencePhysList(g4physList);
 
     if (!physList) {
-        cerr << FATALERRORL << "physics list <" << gphysList << "> could not be loaded." << endl;
-        gexit(EC__PHYSLISTERROR);
+    	log->error(ERR_PHYSLISTERROR, "physics list <" + gphysList + "> could not be loaded.");
     }
 
-    cout << GPHYSLOGHEADER << "Geant4 physics list: <" << g4physList << ">" << endl;
+	log->info(0, "G4PhysListFactory: <" + g4physList + "> loaded.");
 }
 
-GPhysics::~GPhysics() {}
+GPhysics::~GPhysics() {
+	log->debug(DESTRUCTOR, "GPhysics");
+}
 
 
 // calls PrintAvailablePhysLists
 // if verbosity is > 0 calls PrintAvailablePhysicsConstructors
 void GPhysics::printAvailable() {
 
-    cout << endl << "Geant4 Version " << replaceCharInStringWithChars(G4Version, "$", "") << "  " << G4Date << endl << endl;
+	string g4ver = gutilities::replaceCharInStringWithChars(G4Version, "$", "");
+
+	log->info(0, "Geant4 Version ", g4ver, " ", G4Date);;
 
     g4alt::G4PhysListFactory factory;
     factory.PrintAvailablePhysLists();
 
-    G4cout << GPHYSLOGHEADER << " Geant4 available physics constructor that can be added to physicsList:" << G4endl;
+	log->info(0, "Available Geant4 Physics Lists:");
+
     G4PhysicsConstructorRegistry *g4pctorFactory = G4PhysicsConstructorRegistry::Instance();
     g4pctorFactory->PrintAvailablePhysicsConstructors();
 

gphysics/examples/gphysics_example.cc

@@ -1,12 +1,12 @@
 #pragma once
 
-// glibrary
-#include "goptions.h"
+// gemc
+#include "glogger.h"
 
 // geant4
 #include "G4VModularPhysicsList.hh"
 
-// GPhysics Builds and provide a new G4VModularPhysicsList
+// GPhysics Builds and provides a new G4VModularPhysicsList
 // rather than being a class derived from G4VModularPhysicsList
 class GPhysics {
 public:
@@ -15,13 +15,13 @@ class GPhysics {
 
     ~GPhysics();
 
-    G4VModularPhysicsList *getPhysList() { return physList; }
+    [[nodiscard]] G4VModularPhysicsList *getPhysList() const { return physList; }
 
 private:
     // logs physics modules and constructors
-    void printAvailable(std::shared_ptr<GLogger> log);
-
+    void printAvailable();
     G4VModularPhysicsList *physList;
+	std::shared_ptr<GLogger> log;
 };
 
 

gphysics/gphysics.cc

@@ -2,6 +2,6 @@
 
 #define DEFAULTPHYSICSLIST "FTFP_BERT"
 
-#define EC__PHYSLISTERROR 401
+#define ERR_PHYSLISTERROR 401
+
 
-#endif

gphysics/gphysics.h

@@ -140,8 +140,8 @@ GOptions defineOptions() {
 	physicsListHelp += string(HELPFILLSPACE) + " - G4WeightWindowBiasing\n";
 	goptions.defineOption(GVariable("phys_list", DEFAULTPHYSICSLIST, "Select Physics List"), physicsListHelp);
 
-	goptions.defineSwitch("showAvailablePhysics", "Log Geant4 Physics Modules that can be used with the \\\"physicsList\\\" option");
-	goptions.defineSwitch("showAvailablePhysicsX", "Log Geant4 Physics Modules that can be used with the \\\"physicsList\\\" option and exit");
+	goptions.defineSwitch("showAvailablePhysics", "Log Geant4 Physics Modules that can be used with the \"phys_list\" option");
+	goptions.defineSwitch("showAvailablePhysicsX", "Log Geant4 Physics Modules that can be used with the \"phys_list\" option and exit");
 
 	return goptions;
 }