TEnum.h

Go to the documentation of this file.

// @(#)root/meta:$Id$
// Author: Bianca-Cristina Cristescu   09/07/13
 
/*************************************************************************
 * Copyright (C) 1995-2013, 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 ROOT_TEnum
#define ROOT_TEnum
 
//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TEnum                                                                //
//                                                                      //
// TEnum class defines enum type.                                       //
//                                                                      //
//////////////////////////////////////////////////////////////////////////
 
#include "TDataType.h"
#include "TDictionary.h"
#include "THashList.h"
 
#include <string>
 
class ClassInfo_t;
class TClass;
class TEnumConstant;
 
class TEnum : public TDictionary {
 
private:
   THashList    fConstantList;            // List of constants the enum type
   ClassInfo_t *fInfo  = nullptr;         //!Interpreter information, owned by TEnum
   TClass      *fClass = nullptr;         //!Owning class
   std::string  fQualName;                // Fully qualified type name
   EDataType    fUnderlyingType = kInt_t; // Type (size) used to store the enum in memory
 
   enum EStatusBits {
      kBitIsScopedEnum = BIT(14), ///< The enum is an enum class.
      kBitIsValid = BIT(15)       ///< The TEnum object was read from file (assumed valid)
   };
 
public:
 
   enum ESearchAction {kNone                 = 0,
                       kAutoload             = 1,
                       kInterpLookup         = 2,
                       kALoadAndInterpLookup = 3
                      };
 
   TEnum() : TDictionary()  {}
   TEnum(const char *name, DeclId_t declid, TClass *cls);
   TEnum(const TEnum &);
   TEnum& operator=(const TEnum &);
 
   virtual ~TEnum();
 
   void                  AddConstant(TEnumConstant *constant);
   TClass               *GetClass() const { return fClass; }
   const TSeqCollection *GetConstants() const { return &fConstantList; }
   const TEnumConstant  *GetConstant(const char *name) const { return (TEnumConstant *)fConstantList.FindObject(name); }
   DeclId_t              GetDeclId() const;
 
   /// Get the underlying integer type of the enum:
   ///     enum E { kOne }; //  ==> int
   ///     enum F: long; //  ==> long
   /// Returns kNumDataTypes if the enum is unknown / invalid.
   EDataType             GetUnderlyingType() const { return fUnderlyingType; };
 
   Bool_t                IsValid();
   Long_t                Property() const override;
   void                  SetClass(TClass *cl) { fClass = cl; }
   void                  Update(DeclId_t id);
   const char*           GetQualifiedName() const { return fQualName.c_str(); }
   static TEnum         *GetEnum(const std::type_info &ti, ESearchAction sa = kALoadAndInterpLookup);
   static TEnum         *GetEnum(const char *enumName, ESearchAction sa = kALoadAndInterpLookup);
 
   ClassDefOverride(TEnum, 2) //Enum type class
};
 
#endif