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
7class TBuffer;
9class TObjArray;
10
11#include "TObject.h"
12#include "TNamed.h"
13#include "Rtypes.h"
14#include "TString.h"
15
16#include <vector>
17#include <utility>
18
19namespace ROOT {
20
21 class TSchemaRule: public TObject
22 {
23 public:
24
25 class TSources : public TNamed {
26 private:
28 public:
29 TSources(const char *name = 0, const char *title = 0, const char *dims = 0) : TNamed(name,title),fDimensions(dims) {}
30 const char *GetDimensions() { return fDimensions; }
31
33 };
34
35 typedef enum
36 {
39 kNone = 99999
41
42 typedef void (*ReadFuncPtr_t)( char*, TVirtualObject* );
43 typedef void (*ReadRawFuncPtr_t)( char*, TBuffer&);
44
46 virtual ~TSchemaRule();
47
48 TSchemaRule( const TSchemaRule& rhs );
49 TSchemaRule& operator = ( const TSchemaRule& rhs );
50 Bool_t operator == ( const TSchemaRule& rhs ) const;
51
52
53 void Clear(Option_t * /*option*/ ="");
54 Bool_t SetFromRule( const char *rule );
55
56 const char *GetVersion( ) const;
57 Bool_t SetVersion( const TString& version );
58 Bool_t TestVersion( Int_t version ) const;
59 Bool_t SetChecksum( const TString& checksum );
60 Bool_t TestChecksum( UInt_t checksum ) const;
61 void SetSourceClass( const TString& classname );
62 const char *GetSourceClass() const;
63 void SetTargetClass( const TString& classname );
64 const char *GetTargetClass() const;
65 void SetTarget( const TString& target );
66 const TObjArray* GetTarget() const;
67 const char *GetTargetString() const;
68 void SetSource( const TString& source );
69 const TObjArray* GetSource() const;
70 void SetEmbed( Bool_t embed );
71 Bool_t GetEmbed() const;
72 Bool_t IsAliasRule() const;
73 Bool_t IsRenameRule() const;
74 Bool_t IsValid() const;
75 void SetCode( const TString& code );
76 const char *GetCode() const;
77 void SetAttributes( const TString& attributes );
78 const char *GetAttributes() const;
79 Bool_t HasTarget( const TString& target ) const;
80
81 Bool_t HasSource( const TString& source ) const;
86 void SetInclude( const TString& include );
87 const TObjArray* GetInclude() const;
89 RuleType_t GetRuleType() const;
90 Bool_t Conflicts( const TSchemaRule* rule ) const;
91
92 void AsString( TString &out, const char *options = "" ) const;
93 void ls(Option_t *option="") const;
94
96
97 private:
98
99 Bool_t ProcessVersion( const TString& version ) const;
100 Bool_t ProcessChecksum( const TString& checksum ) const;
101 UInt_t ParseChecksum( const char* checksum ) const;
102 static void ProcessList( TObjArray* array, const TString& list );
103 static void ProcessDeclaration( TObjArray* array, const TString& list );
104
105 TString fVersion; // Source version string
106 mutable std::vector<std::pair<Int_t, Int_t> >* fVersionVect; //! Source version vector (for searching purposes)
107 TString fChecksum; // Source checksum string
108 mutable std::vector<UInt_t>* fChecksumVect; //! Source checksum vector (for searching purposes)
109 TString fSourceClass; // Source class
110 TString fTargetClass; // Target class, this is the owner of this rule object.
111 TString fTarget; // Target data mamber string
112 mutable TObjArray* fTargetVect; //! Target data member vector (for searching purposes)
113 TString fSource; // Source data member string
114 mutable TObjArray* fSourceVect; //! Source data member vector (for searching purposes)
115 TString fInclude; // Includes string
116 mutable TObjArray* fIncludeVect; //! Includes vector
117 TString fCode; // User specified code snippet
118 Bool_t fEmbed; // Value determining if the rule should be embedded
119 ReadFuncPtr_t fReadFuncPtr; //! Conversion function pointer for read rule
120 ReadRawFuncPtr_t fReadRawFuncPtr; //! Conversion function pointer for readraw rule
121 RuleType_t fRuleType; // Type of the rule
122 TString fAttributes; // Attributes to be applied to the member (like Owner/NotOwner)
123 };
124} // End of namespace ROOT
125
126#endif // ROOT_TSchemaRule
int Int_t
Definition: RtypesCore.h:41
unsigned int UInt_t
Definition: RtypesCore.h:42
bool Bool_t
Definition: RtypesCore.h:59
const char Option_t
Definition: RtypesCore.h:62
#define ClassDef(name, id)
Definition: Rtypes.h:326
char name[80]
Definition: TGX11.cxx:109
int type
Definition: TGX11.cxx:120
typedef void((*Func_t)())
const char * GetDimensions()
Definition: TSchemaRule.h:30
TSources(const char *name=0, const char *title=0, const char *dims=0)
Definition: TSchemaRule.h:29
void SetRuleType(RuleType_t type)
Set the type of the rule.
TObjArray * fSourceVect
Definition: TSchemaRule.h:114
void SetCode(const TString &code)
Set the source code of this rule.
TString fCode
Includes vector.
Definition: TSchemaRule.h:117
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:119
TObjArray * fIncludeVect
Definition: TSchemaRule.h:116
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).
std::vector< UInt_t > * fChecksumVect
Definition: TSchemaRule.h:108
void ls(Option_t *option="") const
The ls function lists the contents of a class on stdout.
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.
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:113
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:42
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:43
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:115
TObjArray * fTargetVect
Definition: TSchemaRule.h:112
TString fChecksum
Source version vector (for searching purposes)
Definition: TSchemaRule.h:107
TString fTargetClass
Definition: TSchemaRule.h:110
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:109
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:106
ReadRawFuncPtr_t fReadRawFuncPtr
Conversion function pointer for read rule.
Definition: TSchemaRule.h:120
RuleType_t fRuleType
Conversion function pointer for readraw rule.
Definition: TSchemaRule.h:121
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:90
Bool_t SetChecksum(const TString &checksum)
Set the checksum string - returns kFALSE if the format is incorrect.
void Clear(Option_t *="")
Zero out this rule object.
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:42
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
An array of TObjects.
Definition: TObjArray.h:37
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:131
Wrapper around an object and giving indirect access to its content even if the object is not of a cla...
VSD Structures.
Definition: StringConv.hxx:21