lldb/API/SBTypeFormat.h

0001 //===-- SBTypeFormat.h --------------------------------------------*- C++
0002 //-*-===//
0003 //
0004 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0005 // See https://llvm.org/LICENSE.txt for license information.
0006 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0007 //
0008 //===----------------------------------------------------------------------===//
0009
0010 #ifndef LLDB_API_SBTYPEFORMAT_H
0011 #define LLDB_API_SBTYPEFORMAT_H
0012
0013 #include "lldb/API/SBDefines.h"
0014
0015 namespace lldb {
0016
0017 class LLDB_API SBTypeFormat {
0018 public:
0019   SBTypeFormat();
0020
0021   SBTypeFormat(lldb::Format format,
0022                uint32_t options = 0); // see lldb::eTypeOption values
0023
0024   SBTypeFormat(const char *type,
0025                uint32_t options = 0); // see lldb::eTypeOption values
0026
0027   SBTypeFormat(const lldb::SBTypeFormat &rhs);
0028
0029   ~SBTypeFormat();
0030
0031   explicit operator bool() const;
0032
0033   bool IsValid() const;
0034
0035   lldb::Format GetFormat();
0036
0037   const char *GetTypeName();
0038
0039   uint32_t GetOptions();
0040
0041   void SetFormat(lldb::Format);
0042
0043   void SetTypeName(const char *);
0044
0045   void SetOptions(uint32_t);
0046
0047   bool GetDescription(lldb::SBStream &description,
0048                       lldb::DescriptionLevel description_level);
0049
0050   lldb::SBTypeFormat &operator=(const lldb::SBTypeFormat &rhs);
0051
0052   bool IsEqualTo(lldb::SBTypeFormat &rhs);
0053
0054   bool operator==(lldb::SBTypeFormat &rhs);
0055
0056   bool operator!=(lldb::SBTypeFormat &rhs);
0057
0058 protected:
0059   friend class SBDebugger;
0060   friend class SBTypeCategory;
0061   friend class SBValue;
0062
0063   lldb::TypeFormatImplSP GetSP();
0064
0065   void SetSP(const lldb::TypeFormatImplSP &typeformat_impl_sp);
0066
0067   lldb::TypeFormatImplSP m_opaque_sp;
0068
0069   SBTypeFormat(const lldb::TypeFormatImplSP &);
0070
0071   enum class Type { eTypeKeepSame, eTypeFormat, eTypeEnum };
0072
0073   bool CopyOnWrite_Impl(Type);
0074 };
0075
0076 } // namespace lldb
0077
0078 #endif // LLDB_API_SBTYPEFORMAT_H