Extends TRootSniffer for many ROOT classes.
Provides access to different ROOT collections and containers like TTree, TCanvas, TFile, ...
Definition at line 20 of file TRootSnifferFull.h.
Public Member Functions | |
TRootSnifferFull (const char *name="sniff", const char *objpath="Objects") | |
constructor | |
virtual | ~TRootSnifferFull () |
destructor | |
void * | FindInHierarchy (const char *path, TClass **cl=nullptr, TDataMember **member=nullptr, Int_t *chld=nullptr) override |
Search element with specified path. | |
ULong_t | GetItemHash (const char *itemname) override |
Get hash function for specified item. | |
ULong_t | GetStreamerInfoHash () override |
Returns hash value for streamer infos. | |
Bool_t | IsStreamerInfoItem (const char *itemname) override |
Return true if it is streamer info item name. | |
Public Member Functions inherited from TRootSniffer | |
TRootSniffer (const char *name="sniff", const char *objpath="Objects") | |
constructor | |
virtual | ~TRootSniffer () |
destructor | |
Bool_t | CanDrawItem (const char *path) |
Method verifies if object can be drawn. | |
Bool_t | CanExploreItem (const char *path) |
Method returns true when object has childs or one could try to expand item. | |
Int_t | CheckRestriction (const char *item_name) |
Checked if restriction is applied to the item full_item_name should have full path to the item. | |
Bool_t | CreateItem (const char *fullname, const char *title) |
Create item element. | |
void | CreateOwnTopFolder () |
Create own TFolder structures independent from gROOT This allows to have many independent TRootSniffer instances At the same time such sniffer lost access to all global lists and folders. | |
TObject * | FindTObjectInHierarchy (const char *path) |
Search element in hierarchy, derived from TObject. | |
const char * | GetAutoLoad () const |
return name of configured autoload scripts (or 0) | |
const char * | GetItemField (const char *fullname, const char *name) |
Return field for specified item. | |
TFolder * | GetTopFolder (Bool_t force=kFALSE) |
Returns top TFolder instance for the sniffer. | |
Bool_t | HasRestriction (const char *item_name) |
Made fast check if item with specified name is in restriction list If returns true, requires precise check with CheckRestriction() method. | |
TClass * | IsA () const override |
Bool_t | IsReadOnly () const |
Returns readonly mode. | |
Bool_t | IsScanGlobalDir () const |
Returns true when sniffer allowed to scan global directories. | |
Bool_t | Produce (const std::string &path, const std::string &file, const std::string &options, std::string &res) |
Method produce different kind of data out of object. | |
Bool_t | RegisterCommand (const char *cmdname, const char *method, const char *icon) |
Register command which can be executed from web interface. | |
Bool_t | RegisterObject (const char *subfolder, TObject *obj) |
Register object in subfolder structure. | |
void | Restrict (const char *path, const char *options) |
Restrict access to the specified location. | |
void | ScanHierarchy (const char *topname, const char *path, TRootSnifferStore *store, Bool_t only_fields=kFALSE) |
Method scans normal objects, registered in ROOT. | |
void | SetAutoLoad (const char *scripts="") |
When specified, _autoload attribute will be always add to top element of h.json/h.hml requests Used to instruct browser automatically load special code. | |
THttpCallArg * | SetCurrentCallArg (THttpCallArg *arg) |
set current http arguments, which then used in different process methods For instance, if user authorized with some user name, depending from restrictions some objects will be invisible or user get full access to the element Returns previous argument which was set before | |
Bool_t | SetItemField (const char *fullname, const char *name, const char *value) |
Set field for specified item. | |
void | SetReadOnly (Bool_t on=kTRUE) |
When readonly on (default), sniffer is not allowed to change ROOT structures For instance, it is not allowed to read new objects from files. | |
void | SetScanGlobalDir (Bool_t on=kTRUE) |
When enabled (default), sniffer scans gROOT for files, canvases, histograms. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Bool_t | UnregisterObject (TObject *obj) |
Unregister (remove) object from folders structures. | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
void | Clear (Option_t *option="") override |
Set name and title to empty strings (""). | |
TObject * | Clone (const char *newname="") const override |
Make a clone of an object using the Streamer facility. | |
Int_t | Compare (const TObject *obj) const override |
Compare two TNamed objects. | |
void | Copy (TObject &named) const override |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
const char * | GetName () const override |
Returns name of object. | |
const char * | GetTitle () const override |
Returns title of object. | |
ULong_t | Hash () const override |
Return hash value for this object. | |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
void | Print (Option_t *option="") const override |
Print TNamed name and title. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
Bool_t | IsDestructed () const |
IsDestructed. | |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification (the base implementation is no-op). | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete (void *ptr, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static Bool_t | IsDrawableClass (TClass *cl) |
return true if given class can be drawn in JSROOT | |
Static Public Member Functions inherited from TRootSniffer | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TNamed | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Protected Member Functions | |
Bool_t | CallProduceImage (const std::string &kind, const std::string &path, const std::string &options, std::string &res) override |
Invokes TRootSniffer::ProduceIamge, converting kind into TImage::EImageFileTypes type. | |
Bool_t | CanDrawClass (TClass *cl) override |
void | CreateMemFile () |
Creates TMemFile instance, which used for objects streaming. | |
Bool_t | HasStreamerInfo () const override |
Bool_t | ProduceBinary (const std::string &path, const std::string &options, std::string &res) override |
Produce binary data for specified item. | |
Bool_t | ProduceExe (const std::string &path, const std::string &options, Int_t reskind, std::string &res) override |
Execute command for specified object. | |
Bool_t | ProduceImage (Int_t kind, const std::string &path, const std::string &options, std::string &res) override |
Method to produce image from specified object. | |
Bool_t | ProduceRootFile (const std::string &path, const std::string &options, std::string &res) override |
Produce ROOT file for specified item. | |
Bool_t | ProduceXml (const std::string &path, const std::string &options, std::string &res) override |
Produce XML data for specified item. | |
void | ScanKeyProperties (TRootSnifferScanRec &rec, TKey *key, TObject *&obj, TClass *&obj_class) override |
Scans TKey properties. | |
void | ScanObjectChilds (TRootSnifferScanRec &rec, TObject *obj) override |
Scans object childs (if any) | |
void | ScanObjectProperties (TRootSnifferScanRec &rec, TObject *obj) override |
Scans object properties. | |
Protected Member Functions inherited from TRootSniffer | |
Bool_t | AccessField (TFolder *parent, TObject *item, const char *name, const char *value, TNamed **only_get=nullptr) |
Set or get field for the child. | |
TString | DecodeUrlOptionValue (const char *value, Bool_t remove_quotes=kTRUE) |
Method replaces all kind of special symbols, which could appear in URL options. | |
virtual Bool_t | ExecuteCmd (const std::string &path, const std::string &options, std::string &res) |
Execute command marked as _kind=='Command'. | |
TObject * | GetItem (const char *fullname, TFolder *&parent, Bool_t force=kFALSE, Bool_t within_objects=kTRUE) |
Return item from the subfolders structure. | |
const char * | GetItemField (TFolder *parent, TObject *item, const char *name) |
Return field for specified item. | |
TFolder * | GetSubFolder (const char *foldername, Bool_t force=kFALSE) |
Creates subfolder where objects can be registered. | |
Bool_t | IsItemField (TObject *obj) const |
Return true when object is TNamed with kItemField bit set. | |
virtual Bool_t | ProduceItem (const std::string &path, const std::string &options, std::string &res, Bool_t asjson=kTRUE) |
Produce JSON/XML for specified item. | |
virtual Bool_t | ProduceJson (const std::string &path, const std::string &options, std::string &res) |
Produce JSON data for specified item For object conversion TBufferJSON is used. | |
virtual Bool_t | ProduceMulti (const std::string &path, const std::string &options, std::string &res, Bool_t asjson=kTRUE) |
Process several requests, packing all results into binary or JSON buffer. | |
void | ScanCollection (TRootSnifferScanRec &rec, TCollection *lst, const char *foldername=nullptr, TCollection *keys_lst=nullptr) |
Scan collection content. | |
void | ScanObjectMembers (TRootSnifferScanRec &rec, TClass *cl, char *ptr) |
scan object data members some members like enum or static members will be excluded | |
virtual void | ScanRoot (TRootSnifferScanRec &rec) |
scan complete ROOT objects hierarchy For the moment it includes objects in gROOT directory and list of canvases and files Also all registered objects are included. | |
Int_t | WithCurrentUserName (const char *option) |
return 2 when option match to current user name return 1 when option==all return 0 when option does not match user name | |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
TMemFile * | fMemFile {nullptr} |
! file used to manage streamer infos | |
TList * | fSinfo {nullptr} |
! last produced streamer info | |
Protected Attributes inherited from TRootSniffer | |
TString | fAutoLoad |
! scripts names, which are add as _autoload parameter to h.json request | |
TString | fCurrentAllowedMethods |
! list of allowed methods, extracted when analyzed object restrictions | |
THttpCallArg * | fCurrentArg {nullptr} |
! current http arguments (if any) | |
Int_t | fCurrentRestrict {0} |
! current restriction for last-found object | |
TString | fObjectsPath |
! default path for registered objects | |
Bool_t | fReadOnly {kTRUE} |
! indicate if sniffer allowed to change ROOT structures - like read objects from file | |
TList | fRestrictions |
! list of restrictions for different locations | |
Bool_t | fScanGlobalDir {kTRUE} |
! when enabled (default), scan gROOT for histograms, canvases, open files | |
std::unique_ptr< TFolder > | fTopFolder |
! own top TFolder object, used for registering objects | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
#include <TRootSnifferFull.h>
TRootSnifferFull::TRootSnifferFull | ( | const char * | name = "sniff" , |
const char * | objpath = "Objects" |
||
) |
constructor
Definition at line 58 of file TRootSnifferFull.cxx.
|
virtual |
destructor
Definition at line 65 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Invokes TRootSniffer::ProduceIamge, converting kind into TImage::EImageFileTypes type.
Reimplemented from TRootSniffer.
Definition at line 491 of file TRootSnifferFull.cxx.
Reimplemented from TRootSniffer.
Definition at line 33 of file TRootSnifferFull.h.
|
protected |
Creates TMemFile instance, which used for objects streaming.
One could not use TBufferFile directly, while one also require streamer infos list
Definition at line 203 of file TRootSnifferFull.cxx.
|
overridevirtual |
Search element with specified path.
Returns pointer on element
Optionally one could obtain element class, member description and number of childs. When chld!=0, not only element is searched, but also number of childs are counted. When member!=0, any object will be scanned for its data members (disregard of extra options)
Reimplemented from TRootSniffer.
Definition at line 258 of file TRootSnifferFull.cxx.
|
overridevirtual |
Get hash function for specified item.
Used to detect any changes in the specified object
Reimplemented from TRootSniffer.
Definition at line 189 of file TRootSnifferFull.cxx.
|
overridevirtual |
Returns hash value for streamer infos.
At the moment - just number of items in streamer infos list.
Reimplemented from TRootSniffer.
Definition at line 168 of file TRootSnifferFull.cxx.
|
inlineoverrideprotectedvirtual |
Reimplemented from TRootSniffer.
Definition at line 35 of file TRootSnifferFull.h.
return true if given class can be drawn in JSROOT
Definition at line 75 of file TRootSnifferFull.cxx.
|
overridevirtual |
Return true if it is streamer info item name.
Reimplemented from TRootSniffer.
Definition at line 176 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Produce binary data for specified item.
if "zipped" option specified in query, buffer will be compressed
Reimplemented from TRootSniffer.
Definition at line 276 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Execute command for specified object.
options include method and extra list of parameters sniffer should be not-readonly to allow execution of the commands
reskind | defines kind of result 0 - debug, 1 - json, 2 - binary |
Reimplemented from TRootSniffer.
Definition at line 536 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Method to produce image from specified object.
kind | image kind TImage::kPng, TImage::kJpeg, TImage::kGif |
path | path to object |
options | extra options |
res | std::string with binary data |
By default, image 300x200 is produced In options string one could provide following parameters:
opt - draw options
For instance:
http://localhost:8080/Files/hsimple.root/hpx/get.png?w=500&h=500&opt=lego1
Reimplemented from TRootSniffer.
Definition at line 397 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Produce ROOT file for specified item.
File created in memory using TMemFile class.
Reimplemented from TRootSniffer.
Definition at line 333 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Produce XML data for specified item.
For object conversion TBufferXML is used
Reimplemented from TRootSniffer.
Definition at line 510 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Scans TKey properties.
in special cases load objects from the file
Reimplemented from TRootSniffer.
Definition at line 120 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Scans object childs (if any)
here one scans collection, branches, trees and so on
Reimplemented from TRootSniffer.
Definition at line 147 of file TRootSnifferFull.cxx.
|
overrideprotectedvirtual |
Scans object properties.
here such fields as _autoload
or _icon
properties depending on class or object name could be assigned By default properties, coded in the Class title are scanned. Example:
ClassDef(UserClassName, 1) // class comments *SNIFF* _field1=value _field2="string value"
Here SNIFF mark is important. After it all expressions like field=value are parsed One could use double quotes to code string values with spaces. Fields separated from each other with spaces
Reimplemented from TRootSniffer.
Definition at line 102 of file TRootSnifferFull.cxx.
|
protected |
! file used to manage streamer infos
Definition at line 22 of file TRootSnifferFull.h.
|
protected |
! last produced streamer info
Definition at line 23 of file TRootSnifferFull.h.