include/root/TEnum.h

0001 // @(#)root/meta:$Id$
0002 // Author: Bianca-Cristina Cristescu   09/07/13
0003
0004 /*************************************************************************
0005  * Copyright (C) 1995-2013, Rene Brun and Fons Rademakers.               *
0006  * All rights reserved.                                                  *
0007  *                                                                       *
0008  * For the licensing terms see $ROOTSYS/LICENSE.                         *
0009  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
0010  *************************************************************************/
0011
0012 #ifndef ROOT_TEnum
0013 #define ROOT_TEnum
0014
0015 //////////////////////////////////////////////////////////////////////////
0016 //                                                                      //
0017 // TEnum                                                                //
0018 //                                                                      //
0019 // TEnum class defines enum type.                                       //
0020 //                                                                      //
0021 //////////////////////////////////////////////////////////////////////////
0022
0023 #include "TDataType.h"
0024 #include "TDictionary.h"
0025 #include "THashList.h"
0026
0027 #include <string>
0028
0029 class ClassInfo_t;
0030 class TClass;
0031 class TEnumConstant;
0032
0033 class TEnum : public TDictionary {
0034
0035 private:
0036    THashList    fConstantList;            // List of constants the enum type
0037    ClassInfo_t *fInfo  = nullptr;         ///<!Interpreter information, owned by TEnum
0038    TClass      *fClass = nullptr;         ///<!Owning class
0039    std::string  fQualName;                // Fully qualified type name
0040    EDataType    fUnderlyingType = kInt_t; // Type (size) used to store the enum in memory
0041
0042    enum EStatusBits {
0043       kBitIsScopedEnum = BIT(14), ///< The enum is an enum class.
0044       kBitIsValid = BIT(15)       ///< The TEnum object was read from file (assumed valid)
0045    };
0046
0047 public:
0048
0049    enum ESearchAction {
0050 // clang++ <v20 (-Wshadow) complains about shadowing GuiTypes.h global variable kNone. Let's silence warning:
0051 #if defined(__clang__) && __clang_major__ < 20
0052 #pragma clang diagnostic push
0053 #pragma clang diagnostic ignored "-Wshadow"
0054 #endif
0055                        kNone                 = 0,
0056 #if defined(__clang__) && __clang_major__ < 20
0057 #pragma clang diagnostic pop
0058 #endif
0059                        kAutoload             = 1,
0060                        kInterpLookup         = 2,
0061                        kALoadAndInterpLookup = 3
0062                       };
0063
0064    TEnum() : TDictionary()  {}
0065    TEnum(const char *name, DeclId_t declid, TClass *cls);
0066    TEnum(const TEnum &);
0067    TEnum& operator=(const TEnum &);
0068
0069    virtual ~TEnum();
0070
0071    void                  AddConstant(TEnumConstant *constant);
0072    TClass               *GetClass() const { return fClass; }
0073    const TSeqCollection *GetConstants() const { return &fConstantList; }
0074    const TEnumConstant  *GetConstant(const char *name) const { return (TEnumConstant *)fConstantList.FindObject(name); }
0075    DeclId_t              GetDeclId() const;
0076
0077    /// Get the underlying integer type of the enum:
0078    ///     enum E { kOne }; //  ==> int
0079    ///     enum F: long; //  ==> long
0080    /// Returns kNumDataTypes if the enum is unknown / invalid.
0081    EDataType             GetUnderlyingType() const { return fUnderlyingType; };
0082
0083    Bool_t                IsValid();
0084    Long_t                Property() const override;
0085    void                  SetClass(TClass *cl) { fClass = cl; }
0086    void                  Update(DeclId_t id);
0087    const char*           GetQualifiedName() const { return fQualName.c_str(); }
0088    static TEnum         *GetEnum(const std::type_info &ti, ESearchAction sa = kALoadAndInterpLookup);
0089    static TEnum         *GetEnum(const char *enumName, ESearchAction sa = kALoadAndInterpLookup);
0090
0091    ClassDefOverride(TEnum, 2) //Enum type class
0092 };
0093
0094 #endif