RProvider.hxx

Go to the documentation of this file.

/*************************************************************************
 * Copyright (C) 1995-2020, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT7_Browsable_RProvider
#define ROOT7_Browsable_RProvider
 
#include <ROOT/Browsable/RElement.hxx>
 
#include <functional>
#include <map>
#include <memory>
 
class TVirtualPad;
 
namespace ROOT {
 
namespace Experimental {
class RPadBase;
} // namespace Experimental
 
namespace Browsable {
 
/** \class RProvider
\ingroup rbrowser
\brief Provider of different browsing methods for supported classes
\author Sergey Linev <S.Linev@gsi.de>
\date 2019-10-14
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
*/
 
 
class RProvider {
 
public:
 
   virtual ~RProvider();
 
   using ProgressFunc_t = std::function<void(float progress, void *handle)>;
 
   class ClassArg {
      friend class RProvider;
      const TClass *cl{nullptr};
      std::string name;
      ClassArg() = delete;
   public:
      ClassArg(const TClass *_cl) : cl(_cl) {}
      ClassArg(const std::string &_name) : name(_name) {}
      ClassArg(const char *_name) : name(_name) {}
 
      bool empty() const { return !cl && name.empty(); }
      const TClass *GetClass() const { return cl; }
      const std::string &GetName() const { return name; }
   };
 
   class ProgressHandle {
      friend class RProvider;
      void *fHandle{nullptr};
 
      ProgressHandle(const ProgressHandle &) = delete;
      ProgressHandle& operator=(const ProgressHandle &) = delete;
   public:
      explicit ProgressHandle(void *handle, ProgressFunc_t func);
      ~ProgressHandle();
      void Extend(void *handle2);
   };
 
   friend class ProgressHandle;
 
   static std::string GetClassIcon(const ClassArg &, bool = false);
   static std::string GetClassDrawOption(const ClassArg &);
   static bool SetClassDrawOption(const ClassArg &, const std::string &);
 
   static bool CanHaveChilds(const ClassArg &);
   static bool NotShowChilds(const ClassArg &);
   static bool CanDraw6(const ClassArg &);
   static bool CanDraw7(const ClassArg &);
 
   static bool IsFileFormatSupported(const std::string &extension);
   static std::shared_ptr<RElement> OpenFile(const std::string &extension, const std::string &fullname);
   static std::shared_ptr<RElement> Browse(std::unique_ptr<RHolder> &obj);
   static std::shared_ptr<RElement> BrowseNTuple(const std::string &tuplename, const std::string &filename);
   static bool Draw6(TVirtualPad *subpad, std::unique_ptr<RHolder> &obj, const std::string &opt = "");
   static bool Draw7(std::shared_ptr<ROOT::Experimental::RPadBase> &subpad, std::unique_ptr<RHolder> &obj, const std::string &opt = "");
 
   static void ExtendProgressHandle(void *handle, void *handle2);
   static bool ReportProgress(void *handle, float progress);
 
protected:
 
   using FileFunc_t = std::function<std::shared_ptr<RElement>(const std::string &)>;
   using BrowseFunc_t = std::function<std::shared_ptr<RElement>(std::unique_ptr<RHolder> &)>;
   using BrowseNTupleFunc_t = std::function<std::shared_ptr<RElement>(const std::string &, const std::string &)>;
   using Draw6Func_t = std::function<bool(TVirtualPad *, std::unique_ptr<RHolder> &, const std::string &)>;
   using Draw7Func_t = std::function<bool(std::shared_ptr<ROOT::Experimental::RPadBase> &, std::unique_ptr<RHolder> &, const std::string &)>;
 
   void RegisterFile(const std::string &extension, FileFunc_t func);
   void RegisterBrowse(const TClass *cl, BrowseFunc_t func);
   void RegisterDraw6(const TClass *cl, Draw6Func_t func);
   void RegisterDraw7(const TClass *cl, Draw7Func_t func);
   void RegisterClass(const std::string &clname,
                      const std::string &iconname,
                      const std::string &browselib = "",
                      const std::string &draw6lib = "",
                      const std::string &draw7lib = "",
                      const std::string &drawopt = "");
   void RegisterNTupleFunc(BrowseNTupleFunc_t func);
 
private:
 
   struct StructBrowse { RProvider *provider{nullptr}; BrowseFunc_t func; };
   struct StructFile { RProvider *provider{nullptr}; FileFunc_t func; };
   struct StructDraw6 { RProvider *provider{nullptr}; Draw6Func_t func; };
   struct StructDraw7 { RProvider *provider{nullptr}; Draw7Func_t func; };
   struct StructProgress { void *handle{nullptr}, *handle2{nullptr}; ProgressFunc_t func; };
 
   struct StructClass {
      RProvider *provider{nullptr};
      bool can_have_childs{false};
      std::string iconname, browselib, draw6lib, draw7lib, drawopt;
      bool dummy() const { return !provider; }
   };
 
   using ClassMap_t = std::multimap<std::string, StructClass>;
   using FileMap_t = std::multimap<std::string, StructFile>;
   using BrowseMap_t = std::multimap<const TClass*, StructBrowse>;
   using Draw6Map_t = std::multimap<const TClass*, StructDraw6>;
   using Draw7Map_t = std::multimap<const TClass*, StructDraw7>;
   using ProgressVect_t = std::vector<StructProgress>;
 
   static ClassMap_t &GetClassMap();
   static FileMap_t &GetFileMap();
   static BrowseMap_t &GetBrowseMap();
   static Draw6Map_t &GetDraw6Map();
   static Draw7Map_t &GetDraw7Map();
   static ProgressVect_t &GetProgressVect();
   static BrowseNTupleFunc_t gNTupleFunc;
 
   static StructClass &GetClassEntry(const ClassArg &);
 
   template<class Map_t>
   void CleanThis(Map_t &fmap)
   {
      if (fmap.empty())
         return;
      auto fiter = fmap.begin();
      while (fiter != fmap.end()) {
         if (fiter->second.provider == this)
            fiter = fmap.erase(fiter);
         else
            fiter++;
      }
   }
 
};
 
 
} // namespace Browsable
} // namespace ROOT
 
#endif