RAttrBase.hxx

Go to the documentation of this file.

/*************************************************************************
 * Copyright (C) 1995-2021, 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_RAttrBase
#define ROOT7_RAttrBase
 
#include <ROOT/RAttrMap.hxx>
#include <ROOT/RStyle.hxx>
#include <ROOT/RDrawable.hxx>
 
namespace ROOT {
 
class RLogChannel;
 
namespace Experimental {
 
/// Log channel for GPad diagnostics.
ROOT::RLogChannel &GPadLog();
 
/** \class RAttrBase
\ingroup GpadROOT7
\author Sergey Linev <s.linev@gsi.de>
\date 2019-09-17
\brief Base class for all attributes, used with RDrawable
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
*/
 
class RAttrBase {
 
   friend class RAttrMap;
 
   enum {kDrawable, kParent, kOwnAttr} fKind{kDrawable}; ///<!  kind of data
 
   union {
      RDrawable *drawable;  // either drawable to which attributes belongs to
      RAttrBase *parent;    // or aggregation of attributes
      RAttrMap  *ownattr;   // or just own container with values
   } fD{nullptr};  ///<!  data
 
   const char *fPrefix{nullptr}; ///<! name prefix for all attributes values
 
   void ClearData();
   RAttrMap *CreateOwnAttr();
 
protected:
 
   RDrawable *GetDrawable() const { return fKind == kDrawable ? fD.drawable : nullptr; }
   RAttrBase *GetParent() const { return fKind == kParent ? fD.parent : nullptr; }
   RAttrMap *GetOwnAttr() const { return fKind == kOwnAttr ? fD.ownattr : nullptr; }
 
   virtual RAttrMap CollectDefaults() const = 0;
 
   virtual bool IsAggregation() const { return false; }
 
   ///////////////////////////////////////////////////////////////////////////////
 
   struct Rec_t {
      RAttrMap *attr{nullptr};
      std::string fullname;
      RDrawable *drawable{nullptr};
      operator bool() const { return !!attr; }
   };
 
   /// Find attributes container and full-qualified name for value
   const Rec_t AccessAttr(const std::string &name) const
   {
      const RAttrBase *prnt = this;
      std::string fullname = name;
      while (prnt) {
         if (prnt->IsAggregation() && prnt->fPrefix) {
            fullname.insert(0, "_");        // fullname = prnt->fPrefix + _ + fullname
            fullname.insert(0, prnt->fPrefix);
         }
         if (auto dr = prnt->GetDrawable())
            return { &dr->fAttr, fullname, dr };
         if (auto attr = prnt->GetOwnAttr())
            return { attr, fullname, nullptr };
         prnt = prnt->GetParent();
      }
      return {nullptr, fullname, nullptr};
   }
 
   struct Val_t {
      const RAttrMap::Value_t *value{nullptr};
      std::shared_ptr<RStyle> style;
      operator bool() const { return !!value; }
   };
 
   /** Search value with given name in attributes */
   const Val_t AccessValue(const std::string &name, bool use_style = true) const
   {
      if (auto access = AccessAttr(name)) {
         if (auto rec = access.attr->Find(access.fullname))
            return {rec, nullptr};
         if (access.drawable && use_style)
            if (auto observe = access.drawable->fStyle.lock()) {
               if (auto rec = observe->Eval(access.fullname, *access.drawable))
                  return {rec, observe};
            }
      }
 
      return {nullptr, nullptr};
   }
 
   /// Ensure attribute with give name exists - creates container for attributes if required
 
   Rec_t EnsureAttr(const std::string &name)
   {
      auto prnt = this;
      std::string fullname = name;
      while (prnt) {
         if (prnt->IsAggregation() && prnt->fPrefix) {
            fullname.insert(0, "_");        // fullname = prnt->fPrefix + _ + fullname
            fullname.insert(0, prnt->fPrefix);
         }
         if (auto dr = prnt->GetDrawable())
            return { &dr->fAttr, fullname, dr };
         if (prnt->fKind != kParent)
            return { prnt->CreateOwnAttr(), fullname, nullptr };
         prnt = prnt->GetParent();
      }
      return {nullptr, fullname, nullptr};
   }
 
   RAttrBase(const char *prefix)
   {
      fKind = kOwnAttr;
      fD.ownattr = nullptr;
      fPrefix = prefix;
   }
 
   RAttrBase(RDrawable *drawable, const char *prefix = nullptr)
   {
      fKind = kDrawable;
      fD.drawable = drawable;
      fPrefix = prefix;
   }
 
   RAttrBase(RAttrBase *parent, const char *prefix = nullptr)
   {
      fKind = kParent;
      fD.parent = parent;
      fPrefix = prefix;
   }
 
   void SetNoValue(const std::string &name);
 
   const char *GetPrefix() const { return fPrefix; }
 
   void ClearValue(const std::string &name);
 
   void MoveTo(RAttrBase &tgt);
 
public:
   RAttrBase() = default;
 
   virtual ~RAttrBase() { ClearData(); }
 
   virtual void Clear() = 0;
 
};
 
} // namespace Experimental
} // namespace ROOT
 
#endif