QaReportGenerator.h

Go to the documentation of this file.

/* Copyright (C) 2025 GSI/VECC,  Darmstadt/Kolkata
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Souvik Chattopadhyay[committer]  */
 
#pragma once
 
#include "CbmQaCheckerResult.h"
#include "CbmQaReportBuilder.h"
 
#include <TDirectory.h>
#include <TFile.h>
 
#include <memory>
#include <stdexcept>
#include <string>
#include <tuple>
#include <vector>
 
 
using cbm::qa::checker::ECmpInference;
using cbm::qa::checker::Result;

class QaReportGenerator {
 public:
  enum class EngineType
  {
    kHtml,
    kBeamer,
    kLatex
  };

  QaReportGenerator(const std::string& qaFile, const std::string& setup, const std::string& outDir,
                    EngineType engine = EngineType::kLatex, const std::string& figExt = "png", bool ignoreSame = false);

  void Generate();
 
 private:
  void GetResults(TDirectory* dir, const std::string& currentPath, const std::string& taskName);
  // Processing methods ------------------------------------------------
  void Process(const std::string& yamlFile);
  // @brief escape text for LaTeX output.
  static std::string EscapeLatex(const std::string& text);
 
  // Helpers -----------------------------------------------------------
  /* @brief Get all canvas paths in a directory.
     * @param dir    Directory to search for canvases.
     * @param prefix Optional prefix to filter canvas names.
     * @return       List of canvas paths matching the criteria.
     * 
     * This method recursively searches the directory and its subdirectories
     * for canvas objects (TCanvas) and returns their paths as strings.
    */
  static std::vector<std::string> GetCanvasPaths(TDirectory* dir, const std::string& prefix = "");
 
  // Helper to convert comparison inference to string.
  static std::string CmpInferenceToString(cbm::qa::checker::ECmpInference inf);
 
 
  // Data members ------------------------------------------------------
  std::unique_ptr<TFile> fFile;                       
  std::unique_ptr<cbm::qa::report::Builder> fReport;  
  std::string fSetup;                                 
  std::string fOutDir;                                
  EngineType fEngine;                                 
  std::vector<std::string> fObjlist;                  
  std::vector<std::string> fVersionLabel;             
  // FIXME: Optimize the data container for fResults
 
  std::unordered_map<std::string, std::vector<cbm::qa::checker::Result>> fResults;  
  bool fIgnoreSame = false;  
};