1 //===-- SWIG Interface for SBBreakpointLocation -----------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
12 "Represents one unique instance (by address) of a logical breakpoint.
14 A breakpoint location is defined by the breakpoint that produces it,
15 and the address that resulted in this particular instantiation.
16 Each breakpoint location has its settable options.
18 SBBreakpoint contains SBBreakpointLocation(s). See docstring of SBBreakpoint
19 for retrieval of an SBBreakpointLocation from an SBBreakpoint."
20 ) SBBreakpointLocation;
21 class SBBreakpointLocation
25 SBBreakpointLocation ();
27 SBBreakpointLocation (const lldb::SBBreakpointLocation &rhs);
29 ~SBBreakpointLocation ();
37 explicit operator bool() const;
46 SetEnabled(bool enabled);
58 SetIgnoreCount (uint32_t n);
60 %feature("docstring", "
61 The breakpoint location stops only if the condition expression evaluates
62 to true.") SetCondition;
64 SetCondition (const char *condition);
66 %feature("docstring", "
67 Get the condition expression for the breakpoint location.") GetCondition;
71 bool GetAutoContinue();
73 void SetAutoContinue(bool auto_continue);
75 %feature("docstring", "
76 Set the callback to the given Python function name.
77 The function takes three arguments (frame, bp_loc, dict).") SetScriptCallbackFunction;
79 SetScriptCallbackFunction (const char *callback_function_name);
81 %feature("docstring", "
82 Set the name of the script function to be called when the breakpoint is hit.
83 To use this variant, the function should take (frame, bp_loc, extra_args, dict) and
84 when the breakpoint is hit the extra_args will be passed to the callback function.") SetScriptCallbackFunction;
86 SetScriptCallbackFunction (const char *callback_function_name,
87 SBStructuredData &extra_args);
89 %feature("docstring", "
90 Provide the body for the script function to be called when the breakpoint location is hit.
91 The body will be wrapped in a function, which be passed two arguments:
92 'frame' - which holds the bottom-most SBFrame of the thread that hit the breakpoint
93 'bpno' - which is the SBBreakpointLocation to which the callback was attached.
95 The error parameter is currently ignored, but will at some point hold the Python
96 compilation diagnostics.
97 Returns true if the body compiles successfully, false if not.") SetScriptCallbackBody;
99 SetScriptCallbackBody (const char *script_body_text);
101 void SetCommandLineCommands(SBStringList &commands);
103 bool GetCommandLineCommands(SBStringList &commands);
106 SetThreadID (lldb::tid_t sb_thread_id);
112 SetThreadIndex (uint32_t index);
115 GetThreadIndex() const;
118 SetThreadName (const char *thread_name);
121 GetThreadName () const;
124 SetQueueName (const char *queue_name);
127 GetQueueName () const;
133 GetDescription (lldb::SBStream &description, DescriptionLevel level);
138 STRING_EXTENSION_LEVEL(SBBreakpointLocation, lldb::eDescriptionLevelFull)