MetaObject.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

 
//
// includes
//
 
#include <SampleHandler/MetaObject.h>
 
#include <cstdlib>
#include <format>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <TList.h>
#include <TNamed.h>
#include <TBuffer.h>
#include <RootCoreUtils/Assert.h>
#include <SampleHandler/MetaData.h>
 
//
// method implementations
//
 
ClassImp (SH::MetaObject)
 
namespace SH
{
  namespace
  {
    template<class T> struct TypeName
    {
      static std::string name () {return typeid (T).name();}
    };
#define TYPENAME(X)                 \
    template<> struct TypeName<X> {         \
      static std::string name () {return #X;}; };
    TYPENAME (std::string)
    TYPENAME (double)
    TYPENAME (int)
    TYPENAME (bool)
#undef TYPENAME
 
 
    template<class From,class To> struct Convert
    {
      static void convert (const std::string& /*from*/, To& /*to*/, const std::string& field)
      {
    if (field.empty())
      return;
    throw std::runtime_error ("no conversion defined from type " + TypeName<From>::name() + " to type " + TypeName<To>::name() + " for field " + field);
      }
    };
 
    // the conversion string => type is a bit problematic, as it is
    // expected to produce an exception if the conversion cannot be
    // performed. this requires several lines of code. in order to avoid
    // duplication, this has been made into an additional preprocessor
    // macro. while a template function would have been nicer, this
    // would not allow to add the target typename to the error message,
    // which is why this approach has been chosen.
    template<class To> struct Convert<std::string,To>
    {
      static void convert (const std::string& from, To& to, const std::string& field)
      {
    std::stringstream ss (from);
    To retval;
    ss >> retval;
    if (!(ss.fail() || ss.rdbuf()->in_avail() > 0))
    {
      std::swap (retval, to);
      return;
    }
    if (field.empty())
      return;
    throw std::runtime_error ("unable to convert string '" + from + "' to type " + TypeName<To>::name() + " for field " + field);
      }
    };
 
    template<class Type> struct Convert<Type,Type>
    {
      static void convert (const Type& from, Type& to, const std::string& /*field*/)
      {
    to = from;
      }
    };
 
    template<class From> struct Convert<From,std::string>
    {
      static void convert (const From& from, std::string& to, const std::string& /*field*/)
      {
    std::ostringstream ss;
    ss << from;
    to = ss.str();
      }
    };
 
    template<> struct Convert<bool,std::string>
    {
      static void convert (const bool& from, std::string& to, const std::string& /*field*/)
      {
    if (from)
      to = "true";
    else
      to = "false";
      }
    };
 
    template<> struct Convert<std::string,bool>
    {
      static void convert (const std::string& from, bool& to, const std::string& field)
      {
    if (from == "true" || from == "True" || from == "TRUE" || from == "1")
    {
      to = true;
      return;
    }
    if (from == "false" || from == "False" || from  == "FALSE" || from == "0")
    {
      to = false;
      return;
    }
    if (field.empty())
      return;
    throw std::runtime_error ("unable to convert string '" + from + "' to type bool for field " + field);
      }
    };
 
#define DEFAULT_CONVERT(FROM,TO)                    \
    template<> struct Convert<FROM,TO> {                \
      static void convert (const FROM& from, TO& to, const std::string& /*field*/) { \
    to = from; } };
    DEFAULT_CONVERT (std::string, std::string)
    DEFAULT_CONVERT (bool, double)
    DEFAULT_CONVERT (int, double)
    DEFAULT_CONVERT (bool, int)
    DEFAULT_CONVERT (double, int)
    DEFAULT_CONVERT (int, bool)
    DEFAULT_CONVERT (double, bool)
#undef DEFAULT_CONVERT
    
 
    template<class From,class To> bool
    convertSingle (const TObject *from, To& to, const std::string& field)
    {
      const MetaData<From> *myfrom =
    dynamic_cast<const MetaData<From>* >(from);
      if (myfrom == nullptr)
    return false;
      Convert<From,To>::convert (myfrom->value, to, field);
      return true;
    }
 
    template<class To> void
    convert (const TObject *from, To& to, const std::string& field)
    {
      if (convertSingle<std::string> (from, to, field)) return;
      if (convertSingle<double> (from, to, field)) return;
      if (convertSingle<int> (from, to, field)) return;
      if (convertSingle<bool> (from, to, field)) return;
      if (!field.empty())
        throw std::runtime_error (std::format ("unknown input type {} for field {}", typeid(*from).name(), field));
    }

    std::string trim (const std::string& str)
    {
      const char *const whitespace = " \t\n\r\f\v";
      size_t startpos = str.find_first_not_of (whitespace);
      if (std::string::npos == startpos) return "";
      size_t endpos = str.find_last_not_of (whitespace);
      // rationale: only strip a surrounding pair of *matching* quotes,
      //   not a mismatched pair like '"abc' or "abc'.
      if (endpos > startpos &&
          (str[startpos] == '"' || str[startpos] == '\'') &&
          str[endpos] == str[startpos])
      {
        ++ startpos;
        -- endpos;
      }
      return str.substr (startpos, endpos + 1 - startpos);
    }
 
 
    /*
  public:
    template<class T> T getT(const std::string& name, T def_val) const;

  public:
    template<class T> static T convertT(const TObject* meta, T defval);
    */
  }
 
 
 
  std::string dbg (const MetaObject& /*obj*/, unsigned /*verbosity*/)
  {
    return "MetaObject";
  }
 
 
 
  void swap (MetaObject& a, MetaObject& b)
  {
    a.swap (b);
  }
 
 
 
  void MetaObject ::
  testInvariant () const
  {
    RCU_INVARIANT (m_dataList != nullptr);
 }
 
 
 
  MetaObject ::
  MetaObject ()
    : m_dataList (new TList)
  {
    m_dataList->SetOwner(true);
    RCU_NEW_INVARIANT (this);
  }
 
 
 
  MetaObject ::
  MetaObject (const MetaObject& that)
    : TCollection (), m_dataList (new TList)
  {
    m_dataList->SetOwner(true);
    TIter iter (&that);
    TObject *object = nullptr;
    while ((object = iter.Next()))
    {
      m_dataList->Add (object->Clone());
    }
 
    RCU_NEW_INVARIANT (this);
  }
 
 
 
  MetaObject ::
  ~MetaObject ()
  {
    RCU_DESTROY_INVARIANT (this);
 
    delete m_dataList;
  }
 
 
 
  MetaObject& MetaObject ::
  operator = (const MetaObject& that)
  {
    // no invariant used
    MetaObject tmp (that);
    tmp.swap (*this);
    return *this;
  }
 
 
 
  void MetaObject ::
  swap (MetaObject& that)
  {
    std::swap (m_dataList, that.m_dataList);
  }
 
 
 
  void MetaObject ::
  remove (const std::string& name)
  {
    RCU_CHANGE_INVARIANT (this);
 
    TObject *object = nullptr;
    while ((object = m_dataList->FindObject (name.c_str())))
      delete m_dataList->Remove (object);
  }
 
 
 
  void MetaObject ::
  addReplace (TNamed *meta_swallow)
  {
    std::unique_ptr<TNamed> meta (meta_swallow);
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE_SOFT (meta_swallow != nullptr);
 
    remove (meta_swallow->GetName());
    m_dataList->Add (meta.release());
  }
 
 
 
  TObject *MetaObject ::
  get (const std::string& name)
  {
    RCU_READ_INVARIANT (this);
    return m_dataList->FindObject (name.c_str());
  }
 
 
 
  const TObject *MetaObject ::
  get (const std::string& name) const
  {
    RCU_READ_INVARIANT (this);
    return m_dataList->FindObject (name.c_str());
  }
 
 
 
  double MetaObject ::
  getDouble (const std::string& name, double def_val) const
  {
    // no invariant used
    return castDouble (name, def_val, CAST_NOCAST_DEFAULT);
  }
 
 
 
  std::string MetaObject ::
  getString (const std::string& name, const std::string& def_val) const
  {
    // no invariant used
    return castString (name, def_val, CAST_NOCAST_DEFAULT);
  }
 
 
 
  double MetaObject ::
  castDouble (const std::string& name, double def_val,
          CastMode mode) const
  {
    return castT (name, def_val, mode);
  }
 
 
 
  std::string MetaObject ::
  castString (const std::string& name, const std::string& def_val,
          CastMode mode) const
  {
    return castT(name,def_val, mode);
  }
 
 
  int MetaObject ::
  castInteger (const std::string& name, int def_val,
           CastMode mode) const
  {
    return castT(name,def_val, mode);
  }
 
 
  bool MetaObject ::
  castBool (const std::string& name, bool def_val,
        CastMode mode) const
  {
    return castT(name,def_val, mode);
  }
 
 
  void MetaObject ::
  setDouble (const std::string& name, double value)
  {
    setT (name, value);
  }
 
 
 
  void MetaObject ::
  setString (const std::string& name, const std::string& value)
  {
    setT(name,value);
  }
 
 
  void MetaObject ::
  setInteger (const std::string& name, int value)
  {
    setT(name,value);
  }
 
 
  void MetaObject ::
  setBool (const std::string& name, bool value)
  {
    setT(name,value);
  }
 
 
  void MetaObject ::
  fetch (const MetaObject& source)
  {
    RCU_CHANGE_INVARIANT (this);
 
    TIter iter (&source);
    TObject *object = nullptr;
    while ((object = iter.Next()))
    {
      TNamed *const named = dynamic_cast<TNamed*>(object);
      if (!named)
      {
    m_dataList->Add (object->Clone());
      } else if (strncmp (named->GetName(), "nc_", 3) != 0)
      {
    addReplace (dynamic_cast<TNamed*>(named->Clone ()));
      }
    }
  }
 
 
 
  void MetaObject ::
  fetchDefaults (const MetaObject& source)
  {
    RCU_CHANGE_INVARIANT (this);
 
    TIter iter (&source);
    TObject *object = nullptr;
    while ((object = iter.Next()))
    {
      if (get (object->GetName ()) == nullptr)
    m_dataList->Add (object->Clone());
    }
  }
 
 
 
  void MetaObject ::
  Add (TObject *meta_swallow)
  {
    std::unique_ptr<TObject> meta (meta_swallow);
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE_SOFT (meta_swallow != nullptr);
    m_dataList->Add (meta.release());
  }
 
 
  void MetaObject ::
  Add (TObject *meta_swallow, Option_t*)
  {
    this->Add (meta_swallow);
  }
 
 
 
  void MetaObject ::
  Clear (Option_t *option)
  {
    RCU_CHANGE_INVARIANT (this);
    m_dataList->Clear (option);
  }
 
 
 
  void MetaObject ::
  Delete (Option_t *option)
  {
    RCU_CHANGE_INVARIANT (this);
    m_dataList->Delete (option);
  }
 
 
 
  TObject **MetaObject ::
  GetObjectRef (const TObject *const meta) const
  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (meta != nullptr);
 
    TObject **const result = m_dataList->GetObjectRef (meta);
 
    RCU_PROVIDE (result != nullptr);
    RCU_PROVIDE (*result == meta);
    return result;
  }
 
 
 
  TIterator *MetaObject ::
  MakeIterator (Bool_t dir) const
  {
    RCU_READ_INVARIANT (this);
 
    std::unique_ptr<TIterator> result (m_dataList->MakeIterator (dir));
 
    RCU_PROVIDE2 (result.get() != nullptr, "result != 0");
    return result.release();
  }
 
 
 
  TObject *MetaObject ::
  Remove (TObject *meta)
  {
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE_SOFT (meta != nullptr);
    return m_dataList->Remove (meta);
  }
 
 
 
  void MetaObject ::
  Streamer (TBuffer& b)
  {
    if (b.IsReading())
    {
      RCU_CHANGE_INVARIANT (this);
      TObject::Streamer (b);
      m_dataList->Clear ();
      m_dataList->Streamer (b);
      // rationale: re-assert ownership of the list after reading, so
      //   that objects written by builds predating the SetOwner(true)
      //   calls do not read back as a non-owning list that leaks every
      //   Meta on destruction.
      m_dataList->SetOwner (true);
    } else
    {
      RCU_READ_INVARIANT (this);
      TObject::Streamer (b);
      m_dataList->Streamer (b);
    }
  }
 
  
  template<class T> T MetaObject ::
  castT (const std::string& name, T def_val, CastMode mode) const 
  {
    RCU_READ_INVARIANT (this);
    const TObject* meta = get (name);
    if (meta == nullptr)
      return def_val;
    const MetaData<T> *const retval = dynamic_cast<const MetaData<T>*>(meta);
    if (retval) 
      return retval->value;
    switch (mode)
    {
    case CAST_ERROR_THROW:
      {
    T result = def_val;
    convert (meta, result, name);
    return result;
      }
    case CAST_ERROR_DEFAULT:
      {
    T result = def_val;
    convert (meta, result, "");
    return result;
      }
    case CAST_NOCAST_THROW:
      throw std::runtime_error ("invalid input value for " + name);
    case CAST_NOCAST_DEFAULT:
      return def_val;
    }
    RCU_ASSERT0 ("invalid cast value");
    return def_val; //compiler dummy
  }
  
 
  void MetaObject ::
  fetchFromString(const std::string& source){
    size_t oldpos = 0;
    while (oldpos < source.size())
    {
      size_t split = source.find ("=", oldpos);
      size_t pos = source.find (",", oldpos);
      if (pos == std::string::npos)
        pos = source.size();
      // rationale: tolerate empty segments and a trailing separator
      //   (e.g. "a=b,") by skipping empty segments.
      if (pos == oldpos)
      {
        oldpos = pos + 1;
        continue;
      }
      if (split < pos)
      {
    std::string key = trim (source.substr (oldpos, split - oldpos));
    std::string value = trim (source.substr (split + 1, pos - split - 1));
    this->setString (key, value);
      } else {
        throw std::runtime_error ("unable to parse string '" + source + "'");
      }
      oldpos = pos + 1;
    }
  }
 
  std::string MetaObject ::
  dumpToString() const {
    std::stringstream ss;
    std::unique_ptr<TIterator> itr (this->MakeIterator());
    TObject* obj = nullptr;
    while( (obj = itr->Next()) ){
      Meta* m = dynamic_cast<Meta*>(obj);
      if(!m) continue;
      if(!ss.str().empty()) ss << ", ";
      ss << m->GetName() << "=";
      MetaData<std::string>* s = dynamic_cast<MetaData<std::string>* >(m);
      if(s){
    ss << "\"" << s->value << "\"";
      } else {
    std::string mystring;
    convert<std::string> (m, mystring, m->GetName());
    ss << mystring;
      }
    }
    return ss.str();
  }
 
  Int_t MetaObject ::
  GetEntries() const {
    return this->m_dataList->GetEntries();
  }
 
  Int_t MetaObject ::
  GetSize() const {
    // rationale: TCollection::GetSize() is not overridden by
    //   GetEntries(), and fSize is never maintained, so the default
    //   returns 0 (e.g. PyROOT's len()); delegate to the backing list.
    return this->m_dataList->GetSize();
  }
 
}