feat: fully support Iguana and add documentation webpage

.github/workflows/main.yml

@@ -15,16 +15,15 @@ defaults:
     shell: bash
 
 jobs:
+
   build_and_test:
+    name: Build and test
     runs-on: ubuntu-latest
     container:
       image: codecr.jlab.org/hallb/clas12/container-forge/base_root:latest
-
     steps:
-
       - name: checkout repository
         uses: actions/checkout@v5
-
       - name: set clas12root env vars
         run: |
           CLAS12ROOT=$GITHUB_WORKSPACE
@@ -35,14 +34,49 @@ jobs:
           echo PATH=$PATH | tee -a $GITHUB_ENV
           echo LD_LIBRARY_PATH=$LD_LIBRARY_PATH | tee -a $GITHUB_ENV
           echo ROOT_INCLUDE_PATH=$ROOT_INCLUDE_PATH | tee -a $GITHUB_ENV
-
       - name: print versions
         run: |
           cmake --version
           root --version
-
       - name: build clas12root
         run: ./installC12Root
-
       - name: run example on data file
         run: ./bin/clas12root -q ./tests/read_file.C
+
+  generate_documentation:
+    name: Generate documentation
+    runs-on: ubuntu-latest
+    container:
+      image: codecr.jlab.org/hallb/clas12/container-forge/base_root:latest
+      options: --user root
+    steps:
+      - uses: actions/checkout@v5
+      - name: install dependencies
+        run: |
+          pacman -Sy --noconfirm
+          pacman -S --noconfirm doxygen graphviz
+      - name: doxygen
+        run: docs/doxygen/generate.sh
+      - name: rename
+        run: mv share/doc/clas12root/html pages
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          retention-days: 3
+          path: pages/
+
+  deploy_webpages:
+    if: ${{ github.ref == 'refs/heads/master' }}
+    name: Deploy documentation webpage
+    needs:
+      - generate_documentation
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: deployment
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,6 +3,7 @@ bin
 build
 lib
 man
+/share
 
 # dependency installations
 ##############
@@ -54,6 +55,7 @@ ehthumbs.db
 Thumbs.db
 .nfs*
 *~
+.cache
 
 #Dropbox 
 .dropbox.attr

.ignore

@@ -0,0 +1,8 @@
+# ignore configuration file for some IDE tools
+
+# submodule source code
+lz4/**
+clas12-qadb/**
+ccdb/**
+hipo_src/**
+rcdb/**

CMakeLists.txt

@@ -13,7 +13,7 @@ endif()
 message(STATUS "Using cmake version ${CMAKE_VERSION}"  )
 
 # Define the project name, version, and language
-project(clas12root VERSION 1.9 LANGUAGES CXX)
+project(clas12root VERSION 1.9.0 LANGUAGES CXX)
 
 # ==============================================================================
 # Options

Clas12Banks/clas12reader.cpp

@@ -56,6 +56,7 @@ namespace clas12 {
       addBank(additionalBank);
 
     _applyQA=other._applyQA;
+    _readEventUserAction=other._readEventUserAction;
   }
 
   void clas12reader::initReader(){
@@ -461,8 +462,9 @@ namespace clas12 {
       _event.getStructure(*ibank.get());
     }
 
-
-    return true;
+    // now that we have read all the banks, call user's custom read action;
+    // return its return value, since it's the last thing `readEvent()` does
+    return _readEventUserAction(this);
   }
   ////////////////////////////////////////////////////////
   ///initialise next event from the reader
@@ -643,19 +645,35 @@ namespace clas12 {
     return true;
   }
 
-   ////////////////////////////////////////////////////////
-  ///Filter and return detParticles by given PID
-  std::vector<region_part_ptr> clas12reader::getByID(int id){
-    return container_filter(_detParticles, [id](region_part_ptr dr)
-			    {return dr->getPid()==id;});
+  ////////////////////////////////////////////////////////
+  // Filter and return detParticles
+
+  std::vector<region_part_ptr> clas12reader::getDetParticles(bool const& applyBankFilter) const
+  {
+    return applyBankFilter ?
+      container_filter(_detParticles, [](region_part_ptr dr) { return dr->isAllowed(); }) :
+      _detParticles;
+  }
+
+  std::vector<region_part_ptr> clas12reader::getByID(int id, bool const& applyBankFilter) const
+  {
+    return applyBankFilter ?
+      container_filter(_detParticles, [&id](region_part_ptr dr) { return dr->getPid()==id && dr->isAllowed(); }) :
+      container_filter(_detParticles, [&id](region_part_ptr dr) { return dr->getPid()==id; });
   }
-  std::vector<region_part_ptr> clas12reader::getByRegion(int ir){
-    return container_filter(_detParticles, [ir](region_part_ptr dr)
-			    {return dr->getRegion()==ir;});
+
+  std::vector<region_part_ptr> clas12reader::getByRegion(int ir, bool const& applyBankFilter) const
+  {
+    return applyBankFilter ?
+      container_filter(_detParticles, [&ir](region_part_ptr dr) { return dr->getRegion()==ir && dr->isAllowed(); }) :
+      container_filter(_detParticles, [&ir](region_part_ptr dr) { return dr->getRegion()==ir; });
   }
-  std::vector<region_part_ptr> clas12reader::getByCharge(int ch){
-    return container_filter(_detParticles, [ch](region_part_ptr dr)
-			    {return dr->par()->getCharge()==ch;});
+
+  std::vector<region_part_ptr> clas12reader::getByCharge(int ch, bool const& applyBankFilter) const
+  {
+    return applyBankFilter ?
+      container_filter(_detParticles, [&ch](region_part_ptr dr) { return dr->par()->getCharge()==ch && dr->isAllowed(); }) :
+      container_filter(_detParticles, [&ch](region_part_ptr dr) { return dr->par()->getCharge()==ch; });
   }
 
   ////////////////////////////////////////////////////////////////