include/lldb/Interpreter/Property.h

//===-- Property.h ----------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_Property_h_
#define liblldb_Property_h_

// C Includes
// C++ Includes
#include <string>

// Other libraries and framework includes
// Project includes
#include "lldb/lldb-defines.h"
#include "lldb/Core/ConstString.h"
#include "lldb/Core/Flags.h"
#include "lldb/Interpreter/OptionValue.h"

namespace lldb_private {

    // A structure that can be used to create a global table for all properties.
    // Property class instances can be constructed using one of these.
    struct PropertyDefinition
    {
        const char *name;
        OptionValue::Type type;
        bool global;
        uintptr_t default_uint_value;
        const char *default_cstr_value;
        OptionEnumValueElement *enum_values;
        const char *description;
    };
    
    class Property
    {
    public:
        Property (const PropertyDefinition &definition);
        
        Property (const ConstString &name,
                  const ConstString &desc,
                  bool is_global,
                  const lldb::OptionValueSP &value_sp);
        
        const ConstString &
        GetName() const
        {
            return m_name;
        }
        
        const char *
        GetDescription () const
        {
            return m_description.GetCString();
        }
        
        const lldb::OptionValueSP &
        GetValue() const
        {
            return m_value_sp;
        }
        
        void
        SetOptionValue (const lldb::OptionValueSP &value_sp)
        {
            m_value_sp = value_sp;
        }
        
        
        bool
        IsValid() const
        {
            return (bool)m_value_sp;
        }
        
        bool
        IsGlobal () const
        {
            return m_is_global;
        }
        
        void
        Dump (const ExecutionContext *exe_ctx,
              Stream &strm,
              uint32_t dump_mask) const;
        
        bool
        DumpQualifiedName(Stream &strm) const;

        void
        DumpDescription (CommandInterpreter &interpreter,
                         Stream &strm,
                         uint32_t output_width,
                         bool display_qualified_name) const;

    protected:
        ConstString m_name;
        ConstString m_description;
        lldb::OptionValueSP m_value_sp;
        bool m_is_global;
    };

} // namespace lldb_private

#endif  // liblldb_Property_h_