ClassIDSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CLIDCOMPS_CLASSIDSVC_H
# define CLIDCOMPS_CLASSIDSVC_H
 
#include <unordered_map>
#include <mutex>
#include <set>
#include <string>
#include <vector>
#include <utility> // for std::pair
 
#include "GaudiKernel/IIncidentListener.h"
#include "GaudiKernel/IClassIDSvc.h"
#include "GaudiKernel/Service.h"
#include "GaudiKernel/DirSearchPath.h"
 
#include "AthenaKernel/CLIDRegistry.h"
 

 
class ClassIDSvc : public extends<Service, IClassIDSvc, IIncidentListener>
{
private:
  typedef std::pair<std::string, std::string> TypeName; //typename+typeinfoname
  typedef std::unordered_map<CLID, TypeName> CLIDMap; 
  typedef std::unordered_map<std::string, CLID> NameMap; 
 
public:
  // Locking convention: public methods (except for gaudi state-change methods)
  // take the lock.  Protected/private methods do not take the lock.
  // Public methods do not call each other.
 
  //========================================================================

  virtual CLID nextAvailableID() const override;
  virtual bool isIDInUse(const CLID& id) const override;
  virtual bool isNameInUse(const std::string& name) const override;
  virtual StatusCode getTypeNameOfID(const CLID& id, std::string& typeName) const  override;
  virtual StatusCode getTypeInfoNameOfID(const CLID& id, std::string& typeInfoName) const override;
  virtual StatusCode getIDOfTypeName(const std::string& typeName, CLID& id) const  override;
  virtual StatusCode getIDOfTypeInfoName(const std::string& typeInfoName, CLID& id) const override;
  virtual StatusCode setTypeForID(const CLID& id,
                                  const std::string& typeName,
                                  const std::string& typeInfoName = "") override;
 
  //========================================================================

  void dump() const;
 
  
  //========================================================================


  virtual StatusCode initialize() override;
  virtual StatusCode reinitialize() override;
  virtual StatusCode finalize() override;

  void handle(const Incident &inc) override;
 
  // Standard Constructor
  ClassIDSvc(const std::string& name, ISvcLocator* svc);
 
private:
  std::vector<CLID> sortedIDs() const;

  StatusCode fillDB();
  bool processCLIDDB(const std::string& fileName);
  bool getRegistryEntries(const std::string& moduleName);

  StatusCode 
  uncheckedSetTypePackageForID(const CLID& id, 
                               const std::string& typeName,
                               const std::string& typeInfoName);

  bool maybeRescan() const;


  Gaudi::Property<std::vector<std::string>> m_DBFiles{this, "CLIDDBFiles", {"clid.db"},
    "List of db files with (CLID, class_name) entries. Loaded at init in svc maps. Files are looked up in DATAPATH",
    "OrderedSet<std::string>"};
 
  Gaudi::Property<std::string> m_outputFileName{this, "OutputFileName", "NULL",
    "Path to clid.db file for writing. By default ('NULL') to not create the file."};
 
  Gaudi::Property<std::set<CLID>> m_clidIgnore{this, "IgnoreCLIDs", {},
    "Set of CLIDs to ignore. Can also be set via the ATLAS_CLID_IGNORE environment variable (comma-separated). "
    "Useful for testing the removal of EDM classes in a local build."};

  CLIDMap m_clidMap;
  NameMap m_nameMap;
  NameMap m_tiNameMap;

  DirSearchPath m_clidDBPath;
 
  // Mutex to protect internal structures.
  typedef std::mutex mutex_t;
  typedef std::lock_guard<mutex_t> lock_t;
  mutable mutex_t m_mutex;
};
 
 
#endif // CLIDCOMPS_CLASSIDSVC_H