diff options
Diffstat (limited to 'include/lldb/API/SBStructuredData.h')
| -rw-r--r-- | include/lldb/API/SBStructuredData.h | 45 |
1 files changed, 14 insertions, 31 deletions
diff --git a/include/lldb/API/SBStructuredData.h b/include/lldb/API/SBStructuredData.h index 629d4f3e35ee3..5b10133500ef1 100644 --- a/include/lldb/API/SBStructuredData.h +++ b/include/lldb/API/SBStructuredData.h @@ -1,9 +1,8 @@ //===-- SBStructuredData.h --------------------------------------*- C++ -*-===// // -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// @@ -29,6 +28,8 @@ public: lldb::SBStructuredData &operator=(const lldb::SBStructuredData &rhs); + explicit operator bool() const; + bool IsValid() const; lldb::SBError SetFromJSON(lldb::SBStream &stream); @@ -39,69 +40,51 @@ public: lldb::SBError GetDescription(lldb::SBStream &stream) const; - //------------------------------------------------------------------ /// Return the type of data in this data structure - //------------------------------------------------------------------ lldb::StructuredDataType GetType() const; - //------------------------------------------------------------------ /// Return the size (i.e. number of elements) in this data structure /// if it is an array or dictionary type. For other types, 0 will be // returned. - //------------------------------------------------------------------ size_t GetSize() const; - //------------------------------------------------------------------ /// Fill keys with the keys in this object and return true if this data /// structure is a dictionary. Returns false otherwise. - //------------------------------------------------------------------ bool GetKeys(lldb::SBStringList &keys) const; - //------------------------------------------------------------------ /// Return the value corresponding to a key if this data structure /// is a dictionary type. - //------------------------------------------------------------------ lldb::SBStructuredData GetValueForKey(const char *key) const; - //------------------------------------------------------------------ /// Return the value corresponding to an index if this data structure /// is array. - //------------------------------------------------------------------ lldb::SBStructuredData GetItemAtIndex(size_t idx) const; - //------------------------------------------------------------------ /// Return the integer value if this data structure is an integer type. - //------------------------------------------------------------------ uint64_t GetIntegerValue(uint64_t fail_value = 0) const; - //------------------------------------------------------------------ /// Return the floating point value if this data structure is a floating /// type. - //------------------------------------------------------------------ double GetFloatValue(double fail_value = 0.0) const; - //------------------------------------------------------------------ /// Return the boolean value if this data structure is a boolean type. - //------------------------------------------------------------------ bool GetBooleanValue(bool fail_value = false) const; - //------------------------------------------------------------------ /// Provides the string value if this data structure is a string type. /// - /// @param[out] dst + /// \param[out] dst /// pointer where the string value will be written. In case it is null, - /// nothing will be written at @dst. + /// nothing will be written at \a dst. /// - /// @param[in] dst_len - /// max number of characters that can be written at @dst. In case it is - /// zero, nothing will be written at @dst. If this length is not enough - /// to write the complete string value, (dst_len-1) bytes of the string - /// value will be written at @dst followed by a null character. + /// \param[in] dst_len + /// max number of characters that can be written at \a dst. In case it is + /// zero, nothing will be written at \a dst. If this length is not enough + /// to write the complete string value, (\a dst_len - 1) bytes of the + /// string value will be written at \a dst followed by a null character. /// - /// @return + /// \return /// Returns the byte size needed to completely write the string value at - /// @dst in all cases. - //------------------------------------------------------------------ + /// \a dst in all cases. size_t GetStringValue(char *dst, size_t dst_len) const; protected: |