blob: 23c27d8905ed7f88826aa6237d8957b24be47b9e [file] [log] [blame]
Greg Clayton1fa6b3d2011-10-13 18:08:26 +00001//===-- SWIG Interface for SBWatchpoint -----------------*- C++ -*-===//
Johnny Chen092bd152011-09-27 01:19:20 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10namespace lldb {
11
12%feature("docstring",
Johnny Chenecd4feb2011-10-14 00:42:25 +000013"Represents an instance of watchpoint for a specific target program.
Johnny Chen092bd152011-09-27 01:19:20 +000014
Johnny Chenecd4feb2011-10-14 00:42:25 +000015A watchpoint is determined by the address and the byte size that resulted in
16this particular instantiation. Each watchpoint has its settable options.
Johnny Chen092bd152011-09-27 01:19:20 +000017
Johnny Chen2395ede2011-10-26 00:44:40 +000018See also SBTarget.watchpoint_iter() for example usage of iterating through the
19watchpoints of the target."
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000020) SBWatchpoint;
21class SBWatchpoint
Johnny Chen092bd152011-09-27 01:19:20 +000022{
23public:
24
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000025 SBWatchpoint ();
Johnny Chen092bd152011-09-27 01:19:20 +000026
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000027 SBWatchpoint (const lldb::SBWatchpoint &rhs);
Johnny Chen092bd152011-09-27 01:19:20 +000028
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000029 ~SBWatchpoint ();
Johnny Chen092bd152011-09-27 01:19:20 +000030
Johnny Chen092bd152011-09-27 01:19:20 +000031 bool
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000032 IsValid();
Johnny Chen092bd152011-09-27 01:19:20 +000033
Johnny Chen41a55ef2011-10-14 19:15:48 +000034 SBError
35 GetError();
36
37 watch_id_t
38 GetID ();
39
Johnny Chen092bd152011-09-27 01:19:20 +000040 %feature("docstring", "
41 //------------------------------------------------------------------
42 /// With -1 representing an invalid hardware index.
43 //------------------------------------------------------------------
44 ") GetHardwareIndex;
45 int32_t
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000046 GetHardwareIndex ();
Johnny Chen092bd152011-09-27 01:19:20 +000047
48 lldb::addr_t
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000049 GetWatchAddress ();
Johnny Chen092bd152011-09-27 01:19:20 +000050
51 size_t
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000052 GetWatchSize();
Johnny Chen092bd152011-09-27 01:19:20 +000053
54 void
55 SetEnabled(bool enabled);
56
57 bool
58 IsEnabled ();
59
60 uint32_t
Greg Clayton1fa6b3d2011-10-13 18:08:26 +000061 GetHitCount ();
Johnny Chen092bd152011-09-27 01:19:20 +000062
63 uint32_t
64 GetIgnoreCount ();
65
66 void
67 SetIgnoreCount (uint32_t n);
68
Johnny Chena5dd2bb2011-10-18 19:13:06 +000069 %feature("docstring", "
70 //------------------------------------------------------------------
71 /// Get the condition expression for the watchpoint.
72 //------------------------------------------------------------------
73 ") GetCondition;
Johnny Chen712a6282011-10-17 18:58:00 +000074 const char *
75 GetCondition ();
76
Johnny Chena5dd2bb2011-10-18 19:13:06 +000077 %feature("docstring", "
78 //--------------------------------------------------------------------------
79 /// The watchpoint stops only if the condition expression evaluates to true.
80 //--------------------------------------------------------------------------
81 ") SetCondition;
Johnny Chen712a6282011-10-17 18:58:00 +000082 void
83 SetCondition (const char *condition);
84
Johnny Chen092bd152011-09-27 01:19:20 +000085 bool
86 GetDescription (lldb::SBStream &description, DescriptionLevel level);
87};
88
89} // namespace lldb