TFunction.cxx

Go to the documentation of this file.

// @(#)root/meta:$Id$
// Author: Fons Rademakers   07/02/97
 
/*************************************************************************
 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
/** \class TFunction
Global functions class (global functions are obtained from CINT).
This class describes one single global function.
The TROOT class contains a list of all currently defined global
functions (accessible via TROOT::GetListOfGlobalFunctions()).
*/
 
#include "TFunction.h"
#include "TMethodArg.h"
#include "TList.h"
#include "TROOT.h"
#include "TInterpreter.h"
#include "Strlen.h"
 
#include <iostream>
#include "TVirtualMutex.h"
 
 
////////////////////////////////////////////////////////////////////////////////
/// Default TFunction ctor. TFunctions are constructed in TROOT via
/// a call to TCling::UpdateListOfGlobalFunctions().
 
TFunction::TFunction(MethodInfo_t *info) : TDictionary()
{
   fInfo       = info;
   fMethodArgs = nullptr;
   if (fInfo) {
      // The next calls into TClingMethodInfo methods lock the interpreter. Lock
      // once here instead of locking/unlocking every time.
      R__LOCKGUARD(gInterpreterMutex);
      SetName(gCling->MethodInfo_Name(fInfo));
      SetTitle(gCling->MethodInfo_Title(fInfo));
      fMangledName = gCling->MethodInfo_GetMangledName(fInfo);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Copy operator.
 
TFunction::TFunction(const TFunction &orig) : TDictionary(orig)
{
   if (orig.fInfo) {
      // The next call locks the interpreter mutex.
      fInfo = gCling->MethodInfo_FactoryCopy(orig.fInfo);
      fMangledName = orig.fMangledName;
   } else
      fInfo = nullptr;
   fMethodArgs = nullptr;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Assignment operator.
 
TFunction& TFunction::operator=(const TFunction &rhs)
{
   if (this != &rhs) {
      // The next calls lock the interpreter mutex. Lock once here instead of
      // locking/unlocking every time.
      R__LOCKGUARD(gInterpreterMutex);
      gCling->MethodInfo_Delete(fInfo);
      if (fMethodArgs) fMethodArgs->Delete();
      delete fMethodArgs;
      if (rhs.fInfo) {
         fInfo = gCling->MethodInfo_FactoryCopy(rhs.fInfo);
         SetName(gCling->MethodInfo_Name(fInfo));
         SetTitle(gCling->MethodInfo_Title(fInfo));
         fMangledName = gCling->MethodInfo_GetMangledName(fInfo);
      } else
         fInfo = nullptr;
      fMethodArgs = nullptr;
   }
   return *this;
}
 
////////////////////////////////////////////////////////////////////////////////
/// TFunction dtor deletes adopted CINT MethodInfo.
 
TFunction::~TFunction()
{
   gCling->MethodInfo_Delete(fInfo);
 
   if (fMethodArgs) fMethodArgs->Delete();
   delete fMethodArgs;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Clone method.
 
TObject *TFunction::Clone(const char *newname) const
{
   // The constructor locks the interpreter mutex.
   TNamed *newobj = new TFunction(*this);
   if (newname && strlen(newname)) newobj->SetName(newname);
   return newobj;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Using the CINT method arg information to create a complete signature string.
 
void TFunction::CreateSignature()
{
   // The next call locks the interpreter mutex. The result is cached in the
   // fSignature data member.
   gCling->MethodInfo_CreateSignature(fInfo, fSignature);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return signature of function.
 
const char *TFunction::GetSignature()
{
   if (fInfo && fSignature.IsNull())
      // The next call locks the interpreter mutex.
      // The result is cached in the fSignature data member.
      CreateSignature();
 
   return fSignature.Data();
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return list containing the TMethodArgs of a TFunction.
 
TList *TFunction::GetListOfMethodArgs()
{
   if (!fMethodArgs && fInfo) {
      if (!gInterpreter)
         Fatal("GetListOfMethodArgs", "gInterpreter not initialized");
 
      // The next call locks the interpreter mutex.
      gInterpreter->CreateListOfMethodArgs(this);
   }
   return fMethodArgs;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Get full type description of function return type, e,g.: "class TDirectory*".
 
const char *TFunction::GetReturnTypeName() const
{
   // The next calls lock the interpreter mutex.
   if (fInfo == nullptr || gCling->MethodInfo_Type(fInfo) == nullptr) return "Unknown";
   return gCling->MethodInfo_TypeName(fInfo);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Get the normalized name of the return type.  A normalized name is fully
/// qualified and has all typedef desugared except for the 'special' typedef
/// which include Double32_t, Float16_t, [U]Long64_t and std::string.  It
/// also has std:: removed [This is subject to change].
///
 
std::string TFunction::GetReturnTypeNormalizedName() const
{
   // The next calls lock the interpreter mutex.
   if (fInfo == nullptr || gCling->MethodInfo_Type(fInfo) == nullptr) return "Unknown";
   return gCling->MethodInfo_TypeNormalizedName(fInfo);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Number of function arguments.
 
Int_t TFunction::GetNargs() const
{
   if (fInfo) return gCling->MethodInfo_NArg(fInfo);
   else if (fMethodArgs) return fMethodArgs->GetEntries();
   else return 0;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Number of function optional (default) arguments.
 
Int_t TFunction::GetNargsOpt() const
{
   // FIXME: when unload this is an over-estimate.
   return fInfo ? gCling->MethodInfo_NDefaultArg(fInfo) : GetNargs();
}
 
////////////////////////////////////////////////////////////////////////////////
/// Get property description word. For meaning of bits see EProperty.
 
Long_t TFunction::Property() const
{
   // The next call locks the interpreter mutex.
   return fInfo ? gCling->MethodInfo_Property(fInfo) : 0;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Get property description word. For meaning of bits see EProperty.
 
Long_t TFunction::ExtraProperty() const
{
   // The next call locks the interpreter mutex.
   return fInfo ? gCling->MethodInfo_ExtraProperty(fInfo) : 0;
}
 
////////////////////////////////////////////////////////////////////////////////
 
TDictionary::DeclId_t TFunction::GetDeclId() const
{
   // The next call locks the interpreter mutex.
   return gInterpreter->GetDeclId(fInfo);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return pointer to the interface method. Using this pointer we
/// can find which TFunction belongs to a CINT MethodInfo object.
/// Both need to have the same InterfaceMethod pointer.
 
void *TFunction::InterfaceMethod() const
{
   // The next call locks the interpreter mutex.
   return fInfo ? gCling->MethodInfo_InterfaceMethod(fInfo) : nullptr;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return true if this function object is pointing to a currently
/// loaded function.  If a function is unloaded after the TFunction
/// is created, the TFunction will be set to be invalid.
 
Bool_t TFunction::IsValid()
{
   // Register the transaction when checking the validity of the object.
   if (!fInfo && UpdateInterpreterStateMarker()) {
      // Only for global functions. For data member functions TMethod does it.
      // The next calls lock the interpreter mutex.
      DeclId_t newId = gInterpreter->GetFunction(nullptr, fName);
      if (newId) {
         // The next call locks the interpreter mutex. (TODO: why?)
         MethodInfo_t *info = gInterpreter->MethodInfo_Factory(newId);
         Update(info);
      }
      return newId != nullptr;
   }
   return fInfo != nullptr;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns the mangled name as defined by CINT, or 0 in case of error.
 
const char *TFunction::GetMangledName() const
{
   return fMangledName;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns the prototype of a function as defined by CINT, or 0 in
/// case of error.
 
const char *TFunction::GetPrototype() const
{
   if (fInfo) {
      // The next call locks the interpreter mutex.
      return gCling->MethodInfo_GetPrototype(fInfo);
   } else
      return nullptr;
}
 
////////////////////////////////////////////////////////////////////////////////
/// List TFunction name and title.
 
void TFunction::ls(Option_t *options /* ="" */) const
{
   TDictionary::ls(options);
   TROOT::IndentLevel();
   std::cout << "     " << GetPrototype() << '\n';
}
 
////////////////////////////////////////////////////////////////////////////////
/// Print TFunction name and title.
 
void TFunction::Print(Option_t *options /* ="" */) const
{
   TDictionary::Print(options);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Update the TFunction to reflect the new info.
///
/// This can be used to implement unloading (info == 0) and then reloading
/// (info being the 'new' decl address).
 
Bool_t TFunction::Update(MethodInfo_t *info)
{
   // This function needs to lock access to the interpreter multiple times.
   // Take the lock at the beginning of the function so that we don't incur
   // in too much locking/unlocking.
   R__LOCKGUARD(gInterpreterMutex);
   if (info == nullptr) {
 
      if (fInfo) {
         // The next call locks the interpreter mutex.
         gCling->MethodInfo_Delete(fInfo);
      }
      fInfo = nullptr;
      if (fMethodArgs) {
        for (Int_t i = 0; i < fMethodArgs->LastIndex() + 1; i ++) {
           TMethodArg *arg = (TMethodArg *) fMethodArgs->At( i );
           arg->Update(nullptr);
        }
      }
      return kTRUE;
   } else {
      if (fInfo) {
         // The next call locks the interpreter mutex.
         gCling->MethodInfo_Delete(fInfo);
      }
      fInfo = info;
      // The next call locks the interpreter mutex.
      TString newMangledName = gCling->MethodInfo_GetMangledName(fInfo);
      if (newMangledName != fMangledName) {
         Error("Update","TFunction object updated with the 'wrong' MethodInfo (%s vs %s).",
               fMangledName.Data(),newMangledName.Data());
         fInfo = nullptr;
         return false;
      }
      // The next call locks the interpreter mutex.
      SetTitle(gCling->MethodInfo_Title(fInfo));
      if (fMethodArgs) {
         // TODO: Check for MethodArgInfo thread-safety
         MethodArgInfo_t *arg = gCling->MethodArgInfo_Factory(fInfo);
         Int_t i = 0;
         while (gCling->MethodArgInfo_Next(arg)) {
            if (gCling->MethodArgInfo_IsValid(arg)) {
               MethodArgInfo_t *new_arg = gCling->MethodArgInfo_FactoryCopy(arg);
               ((TMethodArg *) fMethodArgs->At( i ))->Update(new_arg);
               ++i;
            }
         }
      }
      return kTRUE;
   }
}