public final class Variable extends GeneratedMessageV3 implements VariableOrBuilder
Represents a variable or an argument possibly of a compound object type.
Note how the following variables are represented:
1) A simple variable:
int x = 5
{ name: "x", value: "5", type: "int" } // Captured variable
2) A compound object:
struct T {
int m1;
int m2;
};
T x = { 3, 7 };
{ // Captured variable
name: "x",
type: "T",
members { name: "m1", value: "3", type: "int" },
members { name: "m2", value: "7", type: "int" }
}
3) A pointer where the pointee was captured:
T x = { 3, 7 };
T* p = &x;
{ // Captured variable
name: "p",
type: "T*",
value: "0x00500500",
members { name: "m1", value: "3", type: "int" },
members { name: "m2", value: "7", type: "int" }
}
4) A pointer where the pointee was not captured:
T* p = new T;
{ // Captured variable
name: "p",
type: "T*",
value: "0x00400400"
status { is_error: true, description { format: "unavailable" } }
}
The status should describe the reason for the missing value,
such as <optimized out>, <inaccessible>, <pointers limit reached>.
Note that a null pointer should not have members.
5) An unnamed value:
int* p = new int(7);
{ // Captured variable
name: "p",
value: "0x00500500",
type: "int*",
members { value: "7", type: "int" } }
6) An unnamed pointer where the pointee was not captured:
int* p = new int(7);
int** pp = &p;
{ // Captured variable
name: "pp",
value: "0x00500500",
type: "int**",
members {
value: "0x00400400",
type: "int*"
status {
is_error: true,
description: { format: "unavailable" } }
}
}
}
To optimize computation, memory and network traffic, variables that
repeat in the output multiple times can be stored once in a shared
variable table and be referenced using the var_table_index field. The
variables stored in the shared table are nameless and are essentially
a partition of the complete variable. To reconstruct the complete
variable, merge the referencing variable with the referenced variable.
When using the shared variable table, the following variables:
T x = { 3, 7 };
T* p = &x;
T& r = x;
{ name: "x", var_table_index: 3, type: "T" } // Captured variables
{ name: "p", value "0x00500500", type="T*", var_table_index: 3 }
{ name: "r", type="T&", var_table_index: 3 }
{ // Shared variable table entry #3:
members { name: "m1", value: "3", type: "int" },
members { name: "m2", value: "7", type: "int" }
}
Note that the pointer address is stored with the referencing variable
and not with the referenced variable. This allows the referenced variable
to be shared between pointers and references.
The type field is optional. The debugger agent may or may not support it.
Protobuf type google.devtools.clouddebugger.v2.Variable
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int MEMBERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int VALUE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int VAR_TABLE_INDEX_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Variable getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Variable.Builder newBuilder()
public static Variable.Builder newBuilder(Variable prototype)
| Parameter |
|---|
| Name | Description |
prototype | Variable
|
public static Variable parseDelimitedFrom(InputStream input)
public static Variable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Variable parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Variable parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Variable parseFrom(ByteString data)
public static Variable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Variable parseFrom(CodedInputStream input)
public static Variable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Variable parseFrom(InputStream input)
public static Variable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Variable parseFrom(ByteBuffer data)
public static Variable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Variable> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Variable getDefaultInstanceForType()
public Variable getMembers(int index)
Members contained or pointed to by the variable.
repeated .google.devtools.clouddebugger.v2.Variable members = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getMembersCount()
Members contained or pointed to by the variable.
repeated .google.devtools.clouddebugger.v2.Variable members = 3;
| Returns |
|---|
| Type | Description |
int | |
public List<Variable> getMembersList()
Members contained or pointed to by the variable.
repeated .google.devtools.clouddebugger.v2.Variable members = 3;
public VariableOrBuilder getMembersOrBuilder(int index)
Members contained or pointed to by the variable.
repeated .google.devtools.clouddebugger.v2.Variable members = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends VariableOrBuilder> getMembersOrBuilderList()
Members contained or pointed to by the variable.
repeated .google.devtools.clouddebugger.v2.Variable members = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.devtools.clouddebugger.v2.VariableOrBuilder> | |
Name of the variable, if any.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Name of the variable, if any.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Parser<Variable> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public StatusMessage getStatus()
Status associated with the variable. This field will usually stay
unset. A status of a single variable only applies to that variable or
expression. The rest of breakpoint data still remains valid. Variables
might be reported in error state even when breakpoint is not in final
state.
The message may refer to variable name with refers_to set to
VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE.
In either case variable value and members will be unset.
Example of error message applied to name: Invalid expression syntax.
Example of information message applied to value: Not captured.
Examples of error message applied to value:
Malformed string,Field f not found in class CNull pointer dereference
.google.devtools.clouddebugger.v2.StatusMessage status = 5;
public StatusMessageOrBuilder getStatusOrBuilder()
Status associated with the variable. This field will usually stay
unset. A status of a single variable only applies to that variable or
expression. The rest of breakpoint data still remains valid. Variables
might be reported in error state even when breakpoint is not in final
state.
The message may refer to variable name with refers_to set to
VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE.
In either case variable value and members will be unset.
Example of error message applied to name: Invalid expression syntax.
Example of information message applied to value: Not captured.
Examples of error message applied to value:
Malformed string,Field f not found in class CNull pointer dereference
.google.devtools.clouddebugger.v2.StatusMessage status = 5;
Variable type (e.g. MyClass). If the variable is split with
var_table_index, type goes next to value. The interpretation of
a type is agent specific. It is recommended to include the dynamic type
rather than a static type of an object.
string type = 6;
| Returns |
|---|
| Type | Description |
String | The type.
|
public ByteString getTypeBytes()
Variable type (e.g. MyClass). If the variable is split with
var_table_index, type goes next to value. The interpretation of
a type is agent specific. It is recommended to include the dynamic type
rather than a static type of an object.
string type = 6;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for type.
|
Simple value of the variable.
string value = 2;
| Returns |
|---|
| Type | Description |
String | The value.
|
public ByteString getValueBytes()
Simple value of the variable.
string value = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for value.
|
public Int32Value getVarTableIndex()
Reference to a variable in the shared variable table. More than
one variable can reference the same variable in the table. The
var_table_index field is an index into variable_table in Breakpoint.
.google.protobuf.Int32Value var_table_index = 4;
| Returns |
|---|
| Type | Description |
Int32Value | The varTableIndex.
|
public Int32ValueOrBuilder getVarTableIndexOrBuilder()
Reference to a variable in the shared variable table. More than
one variable can reference the same variable in the table. The
var_table_index field is an index into variable_table in Breakpoint.
.google.protobuf.Int32Value var_table_index = 4;
public boolean hasStatus()
Status associated with the variable. This field will usually stay
unset. A status of a single variable only applies to that variable or
expression. The rest of breakpoint data still remains valid. Variables
might be reported in error state even when breakpoint is not in final
state.
The message may refer to variable name with refers_to set to
VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE.
In either case variable value and members will be unset.
Example of error message applied to name: Invalid expression syntax.
Example of information message applied to value: Not captured.
Examples of error message applied to value:
Malformed string,Field f not found in class CNull pointer dereference
.google.devtools.clouddebugger.v2.StatusMessage status = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the status field is set.
|
public boolean hasVarTableIndex()
Reference to a variable in the shared variable table. More than
one variable can reference the same variable in the table. The
var_table_index field is an index into variable_table in Breakpoint.
.google.protobuf.Int32Value var_table_index = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the varTableIndex field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Variable.Builder newBuilderForType()
protected Variable.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Variable.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
