TBranchProxy.cxx

Go to the documentation of this file.

// @(#)root/base:$Id$
// Author: Philippe Canal  13/05/2003

/*************************************************************************
 * Copyright (C) 1995-2000, Rene Brun, Fons Rademakers and al.           *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

/** \class ROOT::Detail::TBranchProxy
Base class for all the proxy object. It includes the implementation
of the autoloading of branches as well as all the generic setup routine.
*/

#include "TBranchProxy.h"
#include "TLeaf.h"
#include "TBranchElement.h"
#include "TStreamerElement.h"
#include "TStreamerInfo.h"

ClassImp(ROOT::Detail::TBranchProxy);

using namespace ROOT::Internal;

ROOT::Detail::TBranchProxy::TBranchProxy() :
   fDirector(0), fInitialized(false), fIsMember(false), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(""), fParent(0), fDataMember(""),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1), fWhere(0),fCollection(0)
{
   // Constructor.
};

ROOT::Detail::TBranchProxy::TBranchProxy(TBranchProxyDirector* boss, const char* top,
                                 const char* name) :
   fDirector(boss), fInitialized(false), fIsMember(false), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(top), fParent(0), fDataMember(""),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1),  fWhere(0),fCollection(0)
{
   // Constructor.

   if (fBranchName.Length() && fBranchName[fBranchName.Length()-1]!='.' && name) {
      ((TString&)fBranchName).Append(".");
   }
   if (name) ((TString&)fBranchName).Append(name);
   boss->Attach(this);
}

ROOT::Detail::TBranchProxy::TBranchProxy(TBranchProxyDirector* boss, const char *top, const char *name, const char *membername) :
   fDirector(boss), fInitialized(false), fIsMember(true), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(top), fParent(0), fDataMember(membername),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1), fWhere(0),fCollection(0)
{
   // Constructor.

   if (name && strlen(name)) {
      if (fBranchName.Length() && fBranchName[fBranchName.Length()-1]!='.') {
         ((TString&)fBranchName).Append(".");
      }
      ((TString&)fBranchName).Append(name);
   }
   boss->Attach(this);
}

ROOT::Detail::TBranchProxy::TBranchProxy(TBranchProxyDirector* boss, Detail::TBranchProxy *parent, const char* membername, const char* top,
                                 const char* name) :
   fDirector(boss), fInitialized(false), fIsMember(true), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(top), fParent(parent), fDataMember(membername),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1), fWhere(0),fCollection(0)
{
   // Constructor.

   if (name && strlen(name)) {
      if (fBranchName.Length() && fBranchName[fBranchName.Length()-1]!='.') {
         ((TString&)fBranchName).Append(".");
      }
      ((TString&)fBranchName).Append(name);
   }
   boss->Attach(this);
}

ROOT::Detail::TBranchProxy::TBranchProxy(TBranchProxyDirector* boss, TBranch* branch, const char* membername) :
   fDirector(boss), fInitialized(false), fIsMember(membername != 0 && membername[0]), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(branch->GetName()), fParent(0), fDataMember(membername),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1), fWhere(0),fCollection(0)
{
   // Constructor.

   boss->Attach(this);
}

/// For a fullBranchName that might contain a leading friend tree path (but
/// access elements designating a leaf), but the leaf name such that it matches
/// the "path" to branch.
static std::string GetFriendBranchName(TTree* directorTree, TBranch* branch, const char* fullBranchName)
{
   // ROOT-10046: Here we need to ask for the tree with GetTree otherwise, if directorTree
   // is a chain, this check is bogus and a bug can occour (ROOT-10046)
   if (directorTree->GetTree() == branch->GetTree())
      return branch->GetName();

   // Friend case:
   std::string sFullBranchName = fullBranchName;
   std::string::size_type pos = sFullBranchName.rfind(branch->GetName());
   if (pos != std::string::npos) {
      sFullBranchName.erase(pos);
      sFullBranchName += branch->GetName();
   }
   return sFullBranchName;
}

/// Constructor taking the branch name, possibly of a friended tree.
/// Used by TTreeReaderValue in place of TFriendProxy.
ROOT::Detail::TBranchProxy::TBranchProxy(TBranchProxyDirector* boss, const char* branchname, TBranch* branch, const char* membername) :
   fDirector(boss), fInitialized(false), fIsMember(membername != 0 && membername[0]), fIsClone(false), fIsaPointer(false),
   fHasLeafCount(false), fBranchName(GetFriendBranchName(boss->GetTree(), branch, branchname)), fParent(0), fDataMember(membername),
   fClassName(""), fClass(0), fElement(0), fMemberOffset(0), fOffset(0), fArrayLength(1),
   fBranch(0), fBranchCount(0),
   fNotify(this),
   fRead(-1), fWhere(0),fCollection(0)
{
   // Constructor.

   boss->Attach(this);
}

ROOT::Detail::TBranchProxy::~TBranchProxy()
{
   // Typical Destructor
   if (fNotify.IsLinked() && fDirector && fDirector->GetTree())
      fNotify.RemoveLink(*(fDirector->GetTree()));
}

void ROOT::Detail::TBranchProxy::Reset()
{
   // Completely reset the object.

   fWhere = 0;
   fBranch = 0;
   fBranchCount = 0;
   fRead = -1;
   fClass = 0;
   fElement = 0;
   fMemberOffset = 0;
   fOffset = 0;
   fArrayLength = 1;
   fIsClone = false;
   fInitialized = false;
   fHasLeafCount = false;
   delete fCollection;
   fCollection = 0;
}

void ROOT::Detail::TBranchProxy::Print()
{
   // Display the content of the object

   std::cout << "fBranchName " << fBranchName << std::endl;
   //std::cout << "fTree " << fDirector->fTree << std::endl;
   std::cout << "fBranch " << fBranch << std::endl;
   if (fBranchCount) std::cout << "fBranchCount " << fBranchCount << std::endl;
}

Bool_t ROOT::Detail::TBranchProxy::Setup()
{
   // Initialize/cache the necessary information.

   // Should we check the type?

   if (!fDirector->GetTree()) {
      return false;
   }
   if (!fNotify.IsLinked()) {
      fNotify.PrependLink(*fDirector->GetTree());
   }
   if (fParent) {

      if (!fParent->Setup()) {
         return false;
      }

      TClass *pcl = fParent->GetClass();
      R__ASSERT(pcl);

      if (pcl==TClonesArray::Class()) {
         // We always skip the clones array

         Int_t i = fDirector->GetReadEntry();
         if (i<0)  fDirector->SetReadEntry(0);
         if (fParent->Read()) {
            if (i<0) fDirector->SetReadEntry(i);

            TClonesArray *clones;
            clones = (TClonesArray*)fParent->GetStart();

            if (clones) pcl = clones->GetClass();
         }
      } else if (pcl->GetCollectionProxy()) {
         // We always skip the collections.

         if (fCollection) delete fCollection;
         fCollection = pcl->GetCollectionProxy()->Generate();
         pcl = fCollection->GetValueClass();
         if (pcl == 0) {
            // coverity[dereference] fparent is checked jus a bit earlier and can not be null here
            Error("Setup","Not finding TClass for collecion for the data member %s seems no longer be in class %s",fDataMember.Data(),fParent->GetClass()->GetName());
            return false;
         }
      }

      fElement = (TStreamerElement*)pcl->GetStreamerInfo()->GetStreamerElement(fDataMember, fOffset);
      if (fElement) {
         fIsaPointer = fElement->IsaPointer();
         fClass = fElement->GetClassPointer();
         fMemberOffset = fElement->GetOffset();
         fArrayLength = fElement->GetArrayLength();
      } else {
         Error("Setup","Data member %s seems no longer be in class %s",fDataMember.Data(),pcl->GetName());
         return false;
      }

      fIsClone = (fClass==TClonesArray::Class());

      fWhere = fParent->fWhere; // not really used ... it is reset by GetStart and GetClStart

      if (fParent->IsaPointer()) {
         // fprintf(stderr,"non-split pointer de-referencing non implemented yet \n");
         // nothing to do!
      } else {
         // Accumulate offsets.
         // or not!? fOffset = fMemberOffset = fMemberOffset + fParent->fOffset;
      }

      // This is not sufficient for following pointers

   } else {

      // This does not allow (yet) to precede the branch name with
      // its mother's name
      fBranch = fDirector->GetTree()->GetBranch(fBranchName.Data());
      if (!fBranch) {
         // FIXME
         // While fixing ROOT-10019, this error was added to give to the user an even better experience
         // in presence of a problem.
         // It is not easy to distinguish the cases where this error is "expected"
         // For now we do not print anything - see conversation here: https://github.com/root-project/root/pull/3746
         //auto treeName = fDirector->GetTree()->GetName();
         //::Error("TBranchProxy::Setup", "%s", Form("Unable to find branch %s in tree %s.\n",fBranchName.Data(), treeName));
         return false;
      }

      {
         // Calculate fBranchCount for a leaf.
         TLeaf *leaf = (TLeaf*) fBranch->GetListOfLeaves()->At(0); // fBranch->GetLeaf(fLeafname);
         if (leaf) leaf = leaf->GetLeafCount();
         if (leaf) {
            fBranchCount = leaf->GetBranch();
            //          fprintf(stderr,"for leaf %s setting up leafcount %s branchcount %s\n",
            //                  fBranch->GetName(),leaf->GetName(),fBranchCount->GetName());
            //fBranchCount->Print();
         }
      }

      fWhere = (double*)fBranch->GetAddress();

      if (!fWhere && fBranch->IsA()==TBranchElement::Class()
          && ((TBranchElement*)fBranch)->GetMother()) {

         TBranchElement* be = ((TBranchElement*)fBranch);

         be->GetMother()->SetAddress(0);
         fWhere =  (double*)fBranch->GetAddress();

      }
      if (fBranch->IsA()==TBranch::Class()) {
         TLeaf *leaf2 = nullptr;
         if (fDataMember.Length()) {
            leaf2 = fBranch->GetLeaf(fDataMember);
         } else if (!fWhere) {
            leaf2 = (TLeaf*)fBranch->GetListOfLeaves()->At(0); // fBranch->GetLeaf(fLeafname);
            fWhere = leaf2->GetValuePointer();
         }
         if (leaf2) {
            fWhere = leaf2->GetValuePointer();
            fArrayLength = leaf2->GetLen();
            if (leaf2->GetLeafCount()) {
               fLeafCount = leaf2->GetLeafCount();
               fHasLeafCount = true;
            }
         }
      }

      if (!fWhere) {
         fBranch->SetAddress(0);
         fWhere = (double*)fBranch->GetAddress();
      }


      if (fWhere && fBranch->IsA()==TBranchElement::Class()) {

         TBranchElement* be = ((TBranchElement*)fBranch);

         TStreamerInfo * info = be->GetInfo();
         Int_t id = be->GetID();
         if (be->GetType() == 3) {
            fClassName = "TClonesArray";
            fClass = TClonesArray::Class();
         } else if (id>=0) {
            fOffset = info->GetElementOffset(id);
            fElement = (TStreamerElement*)info->GetElements()->At(id);
            fIsaPointer = fElement->IsaPointer();
            fClass = fElement->GetClassPointer();

            if ((fIsMember || (be->GetType()!=3 && be->GetType() !=4))
                  && (be->GetType()!=31 && be->GetType()!=41)) {

               if (fClass==TClonesArray::Class()) {
                  Int_t i = be->GetTree()->GetReadEntry();
                  if (i<0) i = 0;
                  be->GetEntry(i);

                  TClonesArray *clones;
                  if ( fIsMember && be->GetType()==3 ) {
                     clones = (TClonesArray*)be->GetObject();
                  } else if (fIsaPointer) {
                     clones = (TClonesArray*)*(void**)((char*)fWhere+fOffset);
                  } else {
                     clones = (TClonesArray*)((char*)fWhere+fOffset);
                  }
                  if (!fIsMember) fIsClone = true;
                  fClass = clones->GetClass();
               } else if (fClass && fClass->GetCollectionProxy()) {
                  delete fCollection;
                  fCollection = fClass->GetCollectionProxy()->Generate();
                  fClass = fCollection->GetValueClass();
               }

            }
            if (fClass) fClassName = fClass->GetName();
         } else {
            fClassName = be->GetClassName();
            fClass = TClass::GetClass(fClassName);
         }

         if (be->GetType()==3) {
            // top level TClonesArray

            if (!fIsMember) fIsClone = true;
            fIsaPointer = false;
            fWhere = be->GetObject();

         } else if (be->GetType()==4) {
            // top level TClonesArray

            fCollection = be->GetCollectionProxy()->Generate();
            fIsaPointer = false;
            fWhere = be->GetObject();

         } else if (id<0) {
            // top level object

            fIsaPointer = false;
            fWhere = be->GetObject();

         } else if (be->GetType()==41) {

            fCollection = be->GetCollectionProxy()->Generate();
            fWhere   = be->GetObject();
            fOffset += be->GetOffset();

         } else if (be->GetType()==31) {

            fWhere   = be->GetObject();
            fOffset += be->GetOffset();

         } else if (be->GetType()==2) {
            // this might also be the right path for GetType()==1

            fWhere = be->GetObject();

         } else {

            // fWhere = ((unsigned char*)fWhere) + fOffset;
            fWhere = ((unsigned char*)be->GetObject()) + fOffset;

         }
      } else {
         fClassName = fBranch->GetClassName();
         fClass = TClass::GetClass(fClassName);
      }


      /*
        fClassName = fBranch->GetClassName(); // What about TClonesArray?
        if ( fBranch->IsA()==TBranchElement::Class() &&
        ((TBranchElement*)fBranch)->GetType()==31 ||((TBranchElement*)fBranch)->GetType()==3 ) {

        Int_t id = ((TBranchElement*)fBranch)->GetID();
        if (id>=0) {

        fElement = ((TStreamerElement*)(((TBranchElement*)fBranch)->GetInfo())->GetElements()->At(id));
        fClass = fElement->GetClassPointer();
        if (fClass) fClassName = fClass->GetName();

        }
        }
        if (fClass==0 && fClassName.Length()) fClass = TClass::GetClass(fClassName);
      */
      //fprintf(stderr,"For %s fClass is %p which is %s\n",
      //        fBranchName.Data(),fClass,fClass==0?"not set":fClass->GetName());

      if ( fBranch->IsA()==TBranchElement::Class() &&
           (((TBranchElement*)fBranch)->GetType()==3 || fClass==TClonesArray::Class()) &&
           !fIsMember ) {
         fIsClone = true;
      }

      if (fIsMember) {
         if ( fBranch->IsA()==TBranchElement::Class() &&
              fClass==TClonesArray::Class() &&
              (((TBranchElement*)fBranch)->GetType()==31 || ((TBranchElement*)fBranch)->GetType()==3) ) {

            TBranchElement *bcount = ((TBranchElement*)fBranch)->GetBranchCount();
            TString member;
            if (bcount) {
               TString bname = fBranch->GetName();
               TString bcname = bcount->GetName();
               member = bname.Remove(0,bcname.Length()+1);
            } else {
               member = fDataMember;
            }

            fMemberOffset = fClass->GetDataMemberOffset(member);

            if (fMemberOffset<0) {
               Error("Setup","%s",Form("Negative offset %d for %s in %s",
                                  fMemberOffset,fBranch->GetName(),
                                  bcount?bcount->GetName():"unknown"));
            }

         } else if (fClass) {

            fElement = (TStreamerElement*)
               fClass->GetStreamerInfo()->GetElements()->FindObject(fDataMember);
            if (fElement)
               fMemberOffset = fElement->GetOffset();
            else {
               // Need to compose the proper sub name

               TString member;

               member += fDataMember;
               fMemberOffset = fClass->GetDataMemberOffset(member);

            }
         // The extra condition (fElement is not a TStreamerSTL) is to handle the case where fBranch is a
         // TBranchElement and fElement is a TStreamerSTL. Without the extra condition we get an error
         // message, although the vector (i.e. the TBranchElement) is accessible.
         } else if (fBranch->IsA() != TBranch::Class() && fElement->IsA() != TStreamerBasicType::Class()
                    && fElement->IsA() != TStreamerSTL::Class()) {
            Error("Setup","%s",Form("Missing TClass object for %s\n",fClassName.Data()));
         }

         if ( fBranch->IsA()==TBranchElement::Class()
              && (((TBranchElement*)fBranch)->GetType()==31 || ((TBranchElement*)fBranch)->GetType()==3) ) {

            fOffset = fMemberOffset;

         } else {

            fWhere = ((unsigned char*)fWhere) + fMemberOffset;
         }
      }
   }
   if (fClass==TClonesArray::Class()) fIsClone = true;
   if (fWhere!=0) {
      fInitialized = true;
      return true;
   } else {
      return false;
   }
}