From 5ac6e91c4fd8e9c5778b827862d892c3c2708815 Mon Sep 17 00:00:00 2001 From: Tamas Berghammer Date: Thu, 20 Oct 2016 13:04:32 +0000 Subject: Re-generate the python and cpp reference documentation They haven't been updated since July 2013 so they missed a lot of new function added to the SB API since. Bug: llvm.org/pr30603 llvm-svn: 284725 --- .../cpp_reference/html/classlldb_1_1SBValue.html | 305 ++++++++++++++++++--- 1 file changed, 260 insertions(+), 45 deletions(-) (limited to 'lldb/www/cpp_reference/html/classlldb_1_1SBValue.html') diff --git a/lldb/www/cpp_reference/html/classlldb_1_1SBValue.html b/lldb/www/cpp_reference/html/classlldb_1_1SBValue.html index 292c95dd621..d0c65887653 100644 --- a/lldb/www/cpp_reference/html/classlldb_1_1SBValue.html +++ b/lldb/www/cpp_reference/html/classlldb_1_1SBValue.html @@ -7,7 +7,7 @@

LLDB API Documentation

- + @@ -41,107 +42,209 @@

#include <SBValue.h>

- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+

Public Member Functions

 SBValue ()
 
 SBValue (const lldb::SBValue &rhs)
 
lldb::SBValueoperator= (const lldb::SBValue &rhs)
 
 ~SBValue ()
 
bool IsValid ()
 
void Clear ()
 
SBError GetError ()
 
lldb::user_id_t GetID ()
 
const char * GetName ()
 
const char * GetTypeName ()
 
const char * GetDisplayTypeName ()
 
size_t GetByteSize ()
 
bool IsInScope ()
 
lldb::Format GetFormat ()
 
void SetFormat (lldb::Format format)
 
const char * GetValue ()
 
int64_t GetValueAsSigned (lldb::SBError &error, int64_t fail_value=0)
 
uint64_t GetValueAsUnsigned (lldb::SBError &error, uint64_t fail_value=0)
 
int64_t GetValueAsSigned (int64_t fail_value=0)
 
uint64_t GetValueAsUnsigned (uint64_t fail_value=0)
 
ValueType GetValueType ()
 
bool GetValueDidChange ()
 
const char * GetSummary ()
 
const char * GetSummary (lldb::SBStream &stream, lldb::SBTypeSummaryOptions &options)
 
const char * GetObjectDescription ()
 
const char * GetTypeValidatorResult ()
 
lldb::SBValue GetDynamicValue (lldb::DynamicValueType use_dynamic)
 
lldb::SBValue GetStaticValue ()
 
lldb::SBValue GetNonSyntheticValue ()
 
lldb::DynamicValueType GetPreferDynamicValue ()
 
void SetPreferDynamicValue (lldb::DynamicValueType use_dynamic)
 
bool GetPreferSyntheticValue ()
 
void SetPreferSyntheticValue (bool use_synthetic)
 
bool IsDynamic ()
 
bool IsSynthetic ()
 
bool IsSyntheticChildrenGenerated ()
 
void SetSyntheticChildrenGenerated (bool)
 
const char * GetLocation ()
 
bool SetValueFromCString (const char *value_str)
 
bool SetValueFromCString (const char *value_str, lldb::SBError &error)
 
lldb::SBTypeFormat GetTypeFormat ()
 
lldb::SBTypeSummary GetTypeSummary ()
 
lldb::SBTypeFilter GetTypeFilter ()
 
lldb::SBTypeSynthetic GetTypeSynthetic ()
 
lldb::SBValue GetChildAtIndex (uint32_t idx)
 
lldb::SBValue CreateChildAtOffset (const char *name, uint32_t offset, lldb::SBType type)
 
lldb::SBValue Cast (lldb::SBType type)
 
lldb::SBValue CreateValueFromExpression (const char *name, const char *expression)
 
lldb::SBValue CreateValueFromExpression (const char *name, const char *expression, SBExpressionOptions &options)
 
lldb::SBValue CreateValueFromAddress (const char *name, lldb::addr_t address, lldb::SBType type)
 
lldb::SBValue CreateValueFromData (const char *name, lldb::SBData data, lldb::SBType type)
 
lldb::SBValue GetChildAtIndex (uint32_t idx, lldb::DynamicValueType use_dynamic, bool can_create_synthetic)
 
uint32_t GetIndexOfChildWithName (const char *name)
 
lldb::SBValue GetChildMemberWithName (const char *name)
 
lldb::SBValue GetChildMemberWithName (const char *name, lldb::DynamicValueType use_dynamic)
 
lldb::SBValue GetValueForExpressionPath (const char *expr_path)
 
lldb::SBValue AddressOf ()
 
lldb::addr_t GetLoadAddress ()
 
lldb::SBAddress GetAddress ()
 
lldb::SBData GetPointeeData (uint32_t item_idx=0, uint32_t item_count=1)
 
lldb::SBData GetData ()
 
bool SetData (lldb::SBData &data, lldb::SBError &error)
 
lldb::SBDeclaration GetDeclaration ()
 
bool MightHaveChildren ()
 
bool IsRuntimeSupportValue ()
 
uint32_t GetNumChildren ()
 
uint32_t GetNumChildren (uint32_t max)
 
void * GetOpaqueType ()
 
lldb::SBTarget GetTarget ()
 
lldb::SBProcess GetProcess ()
 
lldb::SBThread GetThread ()
 
lldb::SBFrame GetFrame ()
 
lldb::SBValue Dereference ()
 
bool TypeIsPointerType ()
 
lldb::SBType GetType ()
 
lldb::SBValue Persist ()
 
bool GetDescription (lldb::SBStream &description)
 
bool GetExpressionPath (lldb::SBStream &description)
 
bool GetExpressionPath (lldb::SBStream &description, bool qualify_cxx_base_classes)
 
 SBValue (const lldb::ValueObjectSP &value_sp)
 
lldb::SBWatchpoint Watch (bool resolve_location, bool read, bool write, SBError &error)
 
lldb::SBWatchpoint Watch (bool resolve_location, bool read, bool write)
 
lldb::SBWatchpoint WatchPointee (bool resolve_location, bool read, bool write, SBError &error)
 
lldb::ValueObjectSP GetSP () const
 
- - + + + + + + +

+

Protected Member Functions

lldb::ValueObjectSP GetSP (ValueLocker &value_locker) const
lldb::ValueObjectSP GetSP (ValueLocker &value_locker) const
 
void SetSP (const lldb::ValueObjectSP &sp)
 
void SetSP (const lldb::ValueObjectSP &sp, bool use_synthetic)
 
void SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic)
 
void SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic, bool use_synthetic)
 
void SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic, bool use_synthetic, const char *name)
 
- - + + + + +

+

Friends

class ValueLocker
class SBBlock
 
class SBFrame
 
class SBTarget
 
class SBThread
 
class SBValueList
 
-

Detailed Description

+

Detailed Description

Definition at line 22 of file SBValue.h.

-

Constructor & Destructor Documentation

+

Constructor & Destructor Documentation

@@ -204,7 +307,7 @@ Friends
-

Member Function Documentation

+

Member Function Documentation

@@ -496,16 +599,17 @@ Friends

Get a child value by index from a value.

-

Structs, unions, classes, arrays and and pointers have child values that can be access by index.

+

Structs, unions, classes, arrays and pointers have child values that can be access by index.

Structs and unions access child members using a zero based index for each child member. For

Classes reserve the first indexes for base classes that have members (empty base classes are omitted), and all members of the current class will then follow the base classes.

Pointers differ depending on what they point to. If the pointer points to a simple type, the child at index zero is the only child value available, unless synthetic_allowed is true, in which case the pointer will be used as an array and can create 'synthetic' child values using positive or negative indexes. If the pointer points to an aggregate type (an array, class, union, struct), then the pointee is transparently skipped and any children are going to be the indexes of the child values within the aggregate type. For example if we have a 'Point' type and we have a SBValue that contains a pointer to a 'Point' type, then the child at index zero will be the 'x' member, and the child at index 1 will be the 'y' member (the child at index zero won't be a 'Point' instance).

+

If you actually need an SBValue that represents the type pointed to by a SBValue for which GetType().IsPointeeType() returns true, regardless of the pointee type, you can do that with SBValue::Dereference.

Arrays have a preset number of children that can be accessed by index and will returns invalid child values for indexes that are out of bounds unless the synthetic_allowed is true. In this case the array can create 'synthetic' child values for indexes that aren't in the array bounds using positive or negative indexes.

Parameters
- - + +
[in]idxThe index of the child value to get
[in]use_dynamicAn enumeration that specifies wether to get dynamic values, and also if the target can be run to figure out the dynamic type of the child value.
[in]synthetic_allowedIf true, then allow child values to be created by index for pointers and arrays for indexes that normally wouldn't be allowed.
[in]use_dynamicAn enumeration that specifies whether to get dynamic values, and also if the target can be run to figure out the dynamic type of the child value.
[in]can_create_syntheticIf true, then allow child values to be created by index for pointers and arrays for indexes that normally wouldn't be allowed.
@@ -602,6 +706,21 @@ Friends
+
+
+ +
+
+ + + + + + + +
const char* lldb::SBValue::GetDisplayTypeName ()
+
+
@@ -811,6 +930,22 @@ Friends
+
+ + +
+
+ + + + + + + + +
uint32_t lldb::SBValue::GetNumChildren (uint32_t max)
+
+
@@ -951,7 +1086,7 @@ Friends lldb::ValueObjectSP lldb::SBValue::GetSP ( - ValueLocker &  + ValueLocker &  value_locker) const @@ -1001,6 +1136,32 @@ Friends
+
+ + +
+
+ + + + + + + + + + + + + + + + + + +
const char* lldb::SBValue::GetSummary (lldb::SBStreamstream,
lldb::SBTypeSummaryOptionsoptions 
)
+
+
@@ -1121,6 +1282,21 @@ Friends
+
+ + +
+
+ + + + + + + +
const char* lldb::SBValue::GetTypeValidatorResult ()
+
+
@@ -1296,6 +1472,21 @@ Friends
+
+ + +
+
+ + + + + + + +
bool lldb::SBValue::IsRuntimeSupportValue ()
+
+
@@ -1311,6 +1502,21 @@ Friends
+
+ + +
+
+ + + + + + + +
bool lldb::SBValue::IsSyntheticChildrenGenerated ()
+
+
@@ -1361,6 +1567,21 @@ Friends
+
+ + +
+
+ + + + + + + +
lldb::SBValue lldb::SBValue::Persist ()
+
+
@@ -1613,6 +1834,22 @@ Friends
+
+ + +
+
+ + + + + + + + +
void lldb::SBValue::SetSyntheticChildrenGenerated (bool )
+
+
@@ -1714,7 +1951,7 @@ Friends [in]resolve_locationResolve the location of this value once and watch its address. This value must currently be set to true as watching all locations of a variable or a variable path is not yet supported, though we plan to support it in the future. [in]readStop when this value is accessed. [in]writeStop when this value is modified - [out]Anerror object. Contains the reason if there is some failure. + [out]errorAn error object. Contains the reason if there is some failure. @@ -1796,7 +2033,7 @@ Friends [in]resolve_locationResolve the location of this value once and watch its address. This value must currently be set to true as watching all locations of a variable or a variable path is not yet supported, though we plan to support it in the future. [in]readStop when this value is accessed. [in]writeStop when this value is modified - [out]Anerror object. Contains the reason if there is some failure. + [out]errorAn error object. Contains the reason if there is some failure. @@ -1804,7 +2041,7 @@ Friends -

Friends And Related Function Documentation

+

Friends And Related Function Documentation

@@ -1823,7 +2060,7 @@ Friends
-

Definition at line 434 of file SBValue.h.

+

Definition at line 390 of file SBValue.h.

@@ -1845,7 +2082,7 @@ Friends
-

Definition at line 435 of file SBValue.h.

+

Definition at line 391 of file SBValue.h.

@@ -1867,7 +2104,7 @@ Friends
-

Definition at line 436 of file SBValue.h.

+

Definition at line 392 of file SBValue.h.

@@ -1889,7 +2126,7 @@ Friends
-

Definition at line 437 of file SBValue.h.

+

Definition at line 393 of file SBValue.h.

@@ -1911,29 +2148,7 @@ Friends
-

Definition at line 438 of file SBValue.h.

- -
- - -
-
- - - - - -
- - - - -
friend class ValueLocker
-
-friend
-
- -

Definition at line 24 of file SBValue.h.

+

Definition at line 394 of file SBValue.h.

@@ -1943,9 +2158,9 @@ Friends

-- cgit v1.2.3