Logo ROOT  
Reference Guide
TSchemaRule.h
Go to the documentation of this file.
1// @(#)root/core:$Id$
2// author: Lukasz Janyst <ljanyst@cern.ch>
3
4#ifndef ROOT_TSchemaRule
5#define ROOT_TSchemaRule
6
7#include "TNamed.h"
8#include "TString.h"
9
10#include <vector>
11#include <utility>
12
13class TBuffer;
14class TVirtualObject;
15class TObjArray;
16
17namespace ROOT {
18
19 class TSchemaRule : public TObject
20 {
21 public:
22
23 class TSources : public TNamed {
24 private:
26 public:
27 TSources(const char *name = nullptr, const char *title = nullptr, const char *dims = nullptr) : TNamed(name,title), fDimensions(dims) {}
28 const char *GetDimensions() { return fDimensions; }
29
31 };
32
33 typedef enum
34 {
37 kNone = 99999
39
40 typedef void (*ReadFuncPtr_t)( char*, TVirtualObject* );
41 typedef void (*ReadRawFuncPtr_t)( char*, TBuffer&);
42
44 virtual ~TSchemaRule();
45
46 TSchemaRule( const TSchemaRule& rhs );
47 TSchemaRule& operator = ( const TSchemaRule& rhs );
48 Bool_t operator == ( const TSchemaRule& rhs ) const;
49
50
51 void Clear(Option_t * /*option*/ ="") override;
52 Bool_t SetFromRule( const char *rule );
53
54 const char *GetVersion( ) const;
55 Bool_t SetVersion( const TString& version );
56 Bool_t TestVersion( Int_t version ) const;
57 Bool_t SetChecksum( const TString& checksum );
58 Bool_t TestChecksum( UInt_t checksum ) const;
59 void SetSourceClass( const TString& classname );
60 const char *GetSourceClass() const;
61 void SetTargetClass( const TString& classname );
62 const char *GetTargetClass() const;
63 void SetTarget( const TString& target );
64 const TObjArray* GetTarget() const;
65 const char *GetTargetString() const;
66 void SetSource( const TString& source );
67 const TObjArray* GetSource() const;
68 void SetEmbed( Bool_t embed );
69 Bool_t GetEmbed() const;
70 Bool_t IsAliasRule() const;
71 Bool_t IsRenameRule() const;
72 Bool_t IsValid() const;
73 void SetCode( const TString& code );
74 const char *GetCode() const;
75 void SetAttributes( const TString& attributes );
76 const char *GetAttributes() const;
77 Bool_t HasTarget( const TString& target ) const;
78
79 Bool_t HasSource( const TString& source ) const;
84 void SetInclude( const TString& include );
85 const TObjArray* GetInclude() const;
87 RuleType_t GetRuleType() const;
88 Bool_t Conflicts( const TSchemaRule* rule ) const;
89
90 void AsString( TString &out, const char *options = "" ) const;
91 void ls(Option_t *option="") const override;
92
93 private:
94
95 Bool_t ProcessVersion( const TString& version ) const;
96 Bool_t ProcessChecksum( const TString& checksum ) const;
97 UInt_t ParseChecksum( const char* checksum ) const;
98 static void ProcessList( TObjArray* array, const TString& list );
99 static void ProcessDeclaration( TObjArray* array, const TString& list );
100
101 TString fVersion; // Source version string
102 mutable std::vector<std::pair<Int_t, Int_t> >* fVersionVect; //! Source version vector (for searching purposes)
103 TString fChecksum; // Source checksum string
104 mutable std::vector<UInt_t>* fChecksumVect; //! Source checksum vector (for searching purposes)
105 TString fSourceClass; // Source class
106 TString fTargetClass; // Target class, this is the owner of this rule object.
107 TString fTarget; // Target data mamber string
108 mutable TObjArray* fTargetVect; //! Target data member vector (for searching purposes)
109 TString fSource; // Source data member string
110 mutable TObjArray* fSourceVect; //! Source data member vector (for searching purposes)
111 TString fInclude; // Includes string
112 mutable TObjArray* fIncludeVect; //! Includes vector
113 TString fCode; // User specified code snippet
114 Bool_t fEmbed; // Value determining if the rule should be embedded
115 ReadFuncPtr_t fReadFuncPtr; //! Conversion function pointer for read rule
116 ReadRawFuncPtr_t fReadRawFuncPtr; //! Conversion function pointer for readraw rule
117 RuleType_t fRuleType; // Type of the rule
118 TString fAttributes; // Attributes to be applied to the member (like Owner/NotOwner)
119
121
122 };
123} // End of namespace ROOT
124
125#endif // ROOT_TSchemaRule
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t target
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition: TGX11.cxx:110
const char * GetDimensions()
Definition: TSchemaRule.h:28
TSources(const char *name=nullptr, const char *title=nullptr, const char *dims=nullptr)
Definition: TSchemaRule.h:27
void SetRuleType(RuleType_t type)
Set the type of the rule.
TObjArray * fSourceVect
Definition: TSchemaRule.h:110
void SetCode(const TString &code)
Set the source code of this rule.
TString fCode
Includes vector.
Definition: TSchemaRule.h:113
void SetTarget(const TString &target)
Set the target member of this rule (i.e. the in memory data member).
ReadFuncPtr_t fReadFuncPtr
Definition: TSchemaRule.h:115
TObjArray * fIncludeVect
Definition: TSchemaRule.h:112
void SetReadRawFunctionPointer(ReadRawFuncPtr_t ptr)
Set the pointer to the function to be run for the rule (if it is a raw read rule).
void SetInclude(const TString &include)
Set the comma separated list of header files to include to be able to compile this rule.
void AsString(TString &out, const char *options="") const
Add to the string 'out' the string representation of the rule.
const TObjArray * GetSource() const
Get the list of source members as a TObjArray of TNamed object, with the name being the member name a...
void SetReadFunctionPointer(ReadFuncPtr_t ptr)
Set the pointer to the function to be run for the rule (if it is a read rule).
void ls(Option_t *option="") const override
The ls function lists the contents of a class on stdout.
std::vector< UInt_t > * fChecksumVect
Definition: TSchemaRule.h:104
UInt_t ParseChecksum(const char *checksum) const
Parse the checksum in the given string.
static void ProcessList(TObjArray *array, const TString &list)
Split the list as a comma separated list into a TObjArray of TObjString.
Bool_t operator==(const TSchemaRule &rhs) const
Return true if the rule have the same effects.
Bool_t SetFromRule(const char *rule)
Set the content fot this object from the rule See TClass::AddRule for details on the syntax.
void Clear(Option_t *="") override
Zero out this rule object.
Bool_t TestVersion(Int_t version) const
Check if given version number is defined in this rule.
TString fSource
Target data member vector (for searching purposes)
Definition: TSchemaRule.h:109
Bool_t HasSource(const TString &source) const
Return true if one of the rule's data member source is 'source'.
ReadRawFuncPtr_t GetReadRawFunctionPointer() const
Get the pointer to the function to be run for the rule (if it is a raw read rule).
const TObjArray * GetTarget() const
Get the target data members of this rule (i.e. the in memory data member).
Bool_t ProcessChecksum(const TString &checksum) const
Check if specified checksum string is correct and build checksum vector.
void(* ReadFuncPtr_t)(char *, TVirtualObject *)
Definition: TSchemaRule.h:40
void SetEmbed(Bool_t embed)
Set whether this rule should be save in the ROOT file (if true)
RuleType_t GetRuleType() const
Return the type of the rule.
Bool_t Conflicts(const TSchemaRule *rule) const
Check if this rule conflicts with the given one.
TSchemaRule & operator=(const TSchemaRule &rhs)
Copy operator.
void SetTargetClass(const TString &classname)
Set the target class of this rule (i.e. the in memory class).
void(* ReadRawFuncPtr_t)(char *, TBuffer &)
Definition: TSchemaRule.h:41
const char * GetSourceClass() const
Get the source class of this rule (i.e. the onfile class).
virtual ~TSchemaRule()
Destructor.
Bool_t TestChecksum(UInt_t checksum) const
Check if given checksum is defined in this rule.
Bool_t SetVersion(const TString &version)
Set the version string - returns kFALSE if the format is incorrect.
TString fInclude
Source data member vector (for searching purposes)
Definition: TSchemaRule.h:111
TObjArray * fTargetVect
Definition: TSchemaRule.h:108
TString fChecksum
Source version vector (for searching purposes)
Definition: TSchemaRule.h:103
TString fTargetClass
Definition: TSchemaRule.h:106
void SetSource(const TString &source)
Set the list of source members.
Bool_t IsRenameRule() const
Return kTRUE if the rule is a strict renaming of the class to a new name.
void SetAttributes(const TString &attributes)
Set the attributes code of this rule.
TString fSourceClass
Source checksum vector (for searching purposes)
Definition: TSchemaRule.h:105
Bool_t HasTarget(const TString &target) const
Return true if one of the rule's data member target is 'target'.
const char * GetTargetString() const
Get the target data members of this rule as a simple string (i.e. the in memory data member).
std::vector< std::pair< Int_t, Int_t > > * fVersionVect
Definition: TSchemaRule.h:102
ReadRawFuncPtr_t fReadRawFuncPtr
Conversion function pointer for read rule.
Definition: TSchemaRule.h:116
RuleType_t fRuleType
Conversion function pointer for readraw rule.
Definition: TSchemaRule.h:117
Bool_t IsValid() const
Return kTRUE if this rule is valid.
ReadFuncPtr_t GetReadFunctionPointer() const
Get the pointer to the function to be run for the rule (if it is a read rule).
const char * GetVersion() const
Get the version string.
const char * GetAttributes() const
Get the attributes code of this rule.
Bool_t GetEmbed() const
Return true if this rule should be saved in the ROOT File.
const char * GetCode() const
Get the source code of this rule.
void SetSourceClass(const TString &classname)
Set the source class of this rule (i.e. the onfile class).
TSchemaRule()
Default Constructor.
Definition: TSchemaRule.cxx:89
Bool_t SetChecksum(const TString &checksum)
Set the checksum string - returns kFALSE if the format is incorrect.
const TObjArray * GetInclude() const
Return the list of header files to include to be able to compile this rule as a TObjArray of TObjStri...
Bool_t IsAliasRule() const
Return kTRUE if the rule is a strict renaming of one of the data member of the class.
const char * GetTargetClass() const
Get the targte class of this rule (i.e. the in memory class).
static void ProcessDeclaration(TObjArray *array, const TString &list)
Split the list as a declaration into as a TObjArray of TNamed(name,type).
Bool_t ProcessVersion(const TString &version) const
Check if specified version string is correct and build version vector.
Buffer base class used for serializing objects.
Definition: TBuffer.h:43
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
An array of TObjects.
Definition: TObjArray.h:31
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:136
Wrapper around an object and giving indirect access to its content even if the object is not of a cla...
void(off) SmallVectorTemplateBase< T
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.