xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBWatchpointDocstrings.i (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
106c3fb27SDimitry Andric %feature("docstring",
206c3fb27SDimitry Andric "Represents an instance of watchpoint for a specific target program.
306c3fb27SDimitry Andric 
406c3fb27SDimitry Andric A watchpoint is determined by the address and the byte size that resulted in
506c3fb27SDimitry Andric this particular instantiation.  Each watchpoint has its settable options.
606c3fb27SDimitry Andric 
706c3fb27SDimitry Andric See also :py:class:`SBTarget.watchpoint_iter()` for example usage of iterating through the
806c3fb27SDimitry Andric watchpoints of the target."
906c3fb27SDimitry Andric ) lldb::SBWatchpoint;
1006c3fb27SDimitry Andric 
1106c3fb27SDimitry Andric %feature("docstring", "
12*5f757f3fSDimitry Andric     Deprecated.  Previously: Return the hardware index of the
13*5f757f3fSDimitry Andric     watchpoint register.  Now: -1 is always returned."
1406c3fb27SDimitry Andric ) lldb::SBWatchpoint::GetHardwareIndex;
1506c3fb27SDimitry Andric 
1606c3fb27SDimitry Andric %feature("docstring", "
1706c3fb27SDimitry Andric     Get the condition expression for the watchpoint."
1806c3fb27SDimitry Andric ) lldb::SBWatchpoint::GetCondition;
1906c3fb27SDimitry Andric 
2006c3fb27SDimitry Andric %feature("docstring", "
2106c3fb27SDimitry Andric     The watchpoint stops only if the condition expression evaluates to true."
2206c3fb27SDimitry Andric ) lldb::SBWatchpoint::SetCondition;
2306c3fb27SDimitry Andric 
2406c3fb27SDimitry Andric %feature("docstring", "
2506c3fb27SDimitry Andric     Returns the type recorded when the watchpoint was created. For variable
2606c3fb27SDimitry Andric     watchpoints it is the type of the watched variable. For expression
2706c3fb27SDimitry Andric     watchpoints it is the type of the provided expression."
2806c3fb27SDimitry Andric ) lldb::SBWatchpoint::GetType;
2906c3fb27SDimitry Andric 
3006c3fb27SDimitry Andric %feature("docstring", "
3106c3fb27SDimitry Andric     Returns the kind of value that was watched when the watchpoint was created.
3206c3fb27SDimitry Andric     Returns one of the following eWatchPointValueKindVariable,
3306c3fb27SDimitry Andric     eWatchPointValueKindExpression, eWatchPointValueKindInvalid.
3406c3fb27SDimitry Andric     "
3506c3fb27SDimitry Andric ) lldb::SBWatchpoint::GetWatchValueKind;
3606c3fb27SDimitry Andric 
3706c3fb27SDimitry Andric %feature("docstring", "
3806c3fb27SDimitry Andric     Get the spec for the watchpoint. For variable watchpoints this is the name
3906c3fb27SDimitry Andric     of the variable. For expression watchpoints it is empty
4006c3fb27SDimitry Andric     (may change in the future)."
4106c3fb27SDimitry Andric ) lldb::SBWatchpoint::GetWatchSpec;
4206c3fb27SDimitry Andric 
4306c3fb27SDimitry Andric %feature("docstring", "
4406c3fb27SDimitry Andric     Returns true if the watchpoint is watching reads. Returns false otherwise."
4506c3fb27SDimitry Andric ) lldb::SBWatchpoint::IsWatchingReads;
4606c3fb27SDimitry Andric 
4706c3fb27SDimitry Andric %feature("docstring", "
4806c3fb27SDimitry Andric     Returns true if the watchpoint is watching writes. Returns false otherwise."
4906c3fb27SDimitry Andric ) lldb::SBWatchpoint::IsWatchingWrites;
50