labath created this revision.
labath added reviewers: jingham, clayborg, zturner.
Herald added a subscriber: jdoerfert.
modify-python-lldb.py had code to insert python equality operators to
some classes. Some of those classes already had c++ equality operators,
and some didn't.
This makes the situation more consistent, by removing all equality
handilng from modify-python-lldb. Instead, I add c++ operators to
classes where they were missing, and expose them in the swig interface
files so that they are available to python too.
The only tricky case was the SBAddress class, which had an operator==
defined as a free function, which is not handled by swig. This function
cannot be removed without breaking ABI, and we cannot add an extra
operator== member, as that would make equality comparisons ambiguous.
For this class, I define a python __eq__ function by hand and have it
delegate to the operator!=, which I have defined as a member function.
This isn't fully NFC, as the semantics of some equality functions in
python changes slightly, but I believe it changes for the better (e.g.,
previously SBBreakpoint.__eq__ would consider two breakpoints with the
same ID as equal, even if they belonged to different targets; now they
are only equal if they belong to the same target).
https://reviews.llvm.org/D59819
Files:
include/lldb/API/SBAddress.h
include/lldb/API/SBFileSpec.h
include/lldb/API/SBWatchpoint.h
scripts/Python/modify-python-lldb.py
scripts/interface/SBAddress.i
scripts/interface/SBBreakpoint.i
scripts/interface/SBFileSpec.i
scripts/interface/SBModule.i
scripts/interface/SBWatchpoint.i
scripts/lldb.swig
source/API/SBAddress.cpp
source/API/SBFileSpec.cpp
source/API/SBWatchpoint.cpp
Index: source/API/SBWatchpoint.cpp
===================================================================
--- source/API/SBWatchpoint.cpp
+++ source/API/SBWatchpoint.cpp
@@ -70,6 +70,20 @@
return bool(m_opaque_wp.lock());
}
+bool SBWatchpoint::operator==(const SBWatchpoint &rhs) const {
+ LLDB_RECORD_METHOD_CONST(
+ bool, SBWatchpoint, operator==,(const SBWatchpoint &), rhs);
+
+ return GetSP() == rhs.GetSP();
+}
+
+bool SBWatchpoint::operator!=(const SBWatchpoint &rhs) const {
+ LLDB_RECORD_METHOD_CONST(
+ bool, SBWatchpoint, operator!=,(const SBWatchpoint &), rhs);
+
+ return !(*this == rhs);
+}
+
SBError SBWatchpoint::GetError() {
LLDB_RECORD_METHOD_NO_ARGS(lldb::SBError, SBWatchpoint, GetError);
@@ -303,6 +317,10 @@
LLDB_REGISTER_METHOD(lldb::watch_id_t, SBWatchpoint, GetID, ());
LLDB_REGISTER_METHOD_CONST(bool, SBWatchpoint, IsValid, ());
LLDB_REGISTER_METHOD_CONST(bool, SBWatchpoint, operator bool, ());
+ LLDB_REGISTER_METHOD_CONST(
+ bool, SBWatchpoint, operator==,(const lldb::SBWatchpoint &));
+ LLDB_REGISTER_METHOD_CONST(
+ bool, SBWatchpoint, operator!=,(const lldb::SBWatchpoint &));
LLDB_REGISTER_METHOD(lldb::SBError, SBWatchpoint, GetError, ());
LLDB_REGISTER_METHOD(int32_t, SBWatchpoint, GetHardwareIndex, ());
LLDB_REGISTER_METHOD(lldb::addr_t, SBWatchpoint, GetWatchAddress, ());
Index: source/API/SBFileSpec.cpp
===================================================================
--- source/API/SBFileSpec.cpp
+++ source/API/SBFileSpec.cpp
@@ -62,6 +62,20 @@
return *this;
}
+bool SBFileSpec::operator==(const SBFileSpec &rhs) const {
+ LLDB_RECORD_METHOD_CONST(bool, SBFileSpec, operator==,(const SBFileSpec &rhs),
+ rhs);
+
+ return ref() == rhs.ref();
+}
+
+bool SBFileSpec::operator!=(const SBFileSpec &rhs) const {
+ LLDB_RECORD_METHOD_CONST(bool, SBFileSpec, operator!=,(const SBFileSpec &rhs),
+ rhs);
+
+ return !(*this == rhs);
+}
+
bool SBFileSpec::IsValid() const {
LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBFileSpec, IsValid);
return this->operator bool();
@@ -185,6 +199,10 @@
LLDB_REGISTER_CONSTRUCTOR(SBFileSpec, (const char *, bool));
LLDB_REGISTER_METHOD(const lldb::SBFileSpec &,
SBFileSpec, operator=,(const lldb::SBFileSpec &));
+ LLDB_REGISTER_METHOD_CONST(bool,
+ SBFileSpec, operator==,(const lldb::SBFileSpec &));
+ LLDB_REGISTER_METHOD_CONST(bool,
+ SBFileSpec, operator!=,(const lldb::SBFileSpec &));
LLDB_REGISTER_METHOD_CONST(bool, SBFileSpec, IsValid, ());
LLDB_REGISTER_METHOD_CONST(bool, SBFileSpec, operator bool, ());
LLDB_REGISTER_METHOD_CONST(bool, SBFileSpec, Exists, ());
Index: source/API/SBAddress.cpp
===================================================================
--- source/API/SBAddress.cpp
+++ source/API/SBAddress.cpp
@@ -69,6 +69,13 @@
return false;
}
+bool SBAddress::operator!=(const SBAddress &rhs) const {
+ LLDB_RECORD_METHOD_CONST(bool, SBAddress, operator!=,(const SBAddress &),
+ &rhs);
+
+ return !(*this == rhs);
+}
+
bool SBAddress::IsValid() const {
LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBAddress, IsValid);
return this->operator bool();
@@ -294,6 +301,8 @@
LLDB_REGISTER_CONSTRUCTOR(SBAddress, (lldb::addr_t, lldb::SBTarget &));
LLDB_REGISTER_METHOD(const lldb::SBAddress &,
SBAddress, operator=,(const lldb::SBAddress &));
+ LLDB_REGISTER_METHOD_CONST(bool,
+ SBAddress, operator!=,(const lldb::SBAddress &));
LLDB_REGISTER_METHOD_CONST(bool, SBAddress, IsValid, ());
LLDB_REGISTER_METHOD_CONST(bool, SBAddress, operator bool, ());
LLDB_REGISTER_METHOD(void, SBAddress, Clear, ());
Index: scripts/lldb.swig
===================================================================
--- scripts/lldb.swig
+++ scripts/lldb.swig
@@ -95,8 +95,7 @@
# ==============================================================================
# The modify-python-lldb.py script is responsible for post-processing this SWIG-
# generated lldb.py module. It is responsible for adding support for: iteration
-# protocol: __iter__, rich comparison methods: __eq__ and __ne__, and built-in
-# function len(): __len__.
+# protocol: __iter__, and built-in function len(): __len__.
# ==============================================================================
%}
Index: scripts/interface/SBWatchpoint.i
===================================================================
--- scripts/interface/SBWatchpoint.i
+++ scripts/interface/SBWatchpoint.i
@@ -32,6 +32,10 @@
explicit operator bool() const;
+ bool operator==(const SBWatchpoint &rhs) const;
+
+ bool operator!=(const SBWatchpoint &rhs) const;
+
SBError
GetError();
Index: scripts/interface/SBModule.i
===================================================================
--- scripts/interface/SBModule.i
+++ scripts/interface/SBModule.i
@@ -184,6 +184,10 @@
const char *
GetUUIDString () const;
+ bool operator==(const lldb::SBModule &rhs) const;
+
+ bool operator!=(const lldb::SBModule &rhs) const;
+
lldb::SBSection
FindSection (const char *sect_name);
Index: scripts/interface/SBFileSpec.i
===================================================================
--- scripts/interface/SBFileSpec.i
+++ scripts/interface/SBFileSpec.i
@@ -42,6 +42,10 @@
~SBFileSpec ();
+ bool operator==(const SBFileSpec &rhs) const;
+
+ bool operator!=(const SBFileSpec &rhs) const;
+
bool
IsValid() const;
Index: scripts/interface/SBBreakpoint.i
===================================================================
--- scripts/interface/SBBreakpoint.i
+++ scripts/interface/SBBreakpoint.i
@@ -85,6 +85,10 @@
~SBBreakpoint();
+ bool operator==(const lldb::SBBreakpoint &rhs);
+
+ bool operator!=(const lldb::SBBreakpoint &rhs);
+
break_id_t
GetID () const;
Index: scripts/interface/SBAddress.i
===================================================================
--- scripts/interface/SBAddress.i
+++ scripts/interface/SBAddress.i
@@ -64,6 +64,15 @@
explicit operator bool() const;
+ // operator== is a free function, which swig does not handle, so we inject
+ // our own equality operator here
+ %pythoncode%{
+ def __eq__(self, other):
+ return not self.__ne__(other)
+ %}
+
+ bool operator!=(const SBAddress &rhs) const;
+
void
Clear ();
Index: scripts/Python/modify-python-lldb.py
===================================================================
--- scripts/Python/modify-python-lldb.py
+++ scripts/Python/modify-python-lldb.py
@@ -135,17 +135,6 @@
'SBModule-symbol-in-section': symbol_in_section_iter_def
}
-#
-# This dictionary defines a mapping from classname to equality method name(s).
-#
-e = {'SBAddress': ['GetFileAddress', 'GetModule'],
- 'SBBreakpoint': ['GetID'],
- 'SBWatchpoint': ['GetID'],
- 'SBFileSpec': ['GetFilename', 'GetDirectory'],
- 'SBModule': ['GetFileSpec', 'GetUUIDString'],
- }
-
-
def list_to_frag(list):
"""Transform a list to equality program fragment.
@@ -213,26 +202,19 @@
# These define the states of our finite state machine.
NORMAL = 1
DEFINING_ITERATOR = 2
-DEFINING_EQUALITY = 4
CLEANUP_DOCSTRING = 8
# Our FSM begins its life in the NORMAL state, and transitions to the
-# DEFINING_ITERATOR and/or DEFINING_EQUALITY state whenever it encounters the
-# beginning of certain class definitions, see dictionaries 'd' and 'e' above.
+# DEFINING_ITERATOR state whenever it encounters the beginning of certain class
+# definitions, see dictionary 'd' above.
#
-# Note that the two states DEFINING_ITERATOR and DEFINING_EQUALITY are
-# orthogonal in that our FSM can be in one, the other, or both states at the
-# same time. During such time, the FSM is eagerly searching for the __init__
+# In the DEFINING_ITERATOR state, the FSM is eagerly searching for the __init__
# method definition in order to insert the appropriate method(s) into the lldb
# module.
#
# The state CLEANUP_DOCSTRING can be entered from either the NORMAL or the
-# DEFINING_ITERATOR/EQUALITY states. While in this state, the FSM is fixing/
-# cleaning the Python docstrings generated by the swig docstring features.
-#
-# The FSM, in all possible states, also checks the current input for IsValid()
-# definition, and inserts a __nonzero__() method definition to implement truth
-# value testing and the built-in operation bool().
+# DEFINING_ITERATOR state. While in this state, the FSM is fixing/cleaning the
+# Python docstrings generated by the swig docstring features.
state = NORMAL
for line in content.splitlines():
@@ -254,18 +236,14 @@
if state == NORMAL:
match = class_pattern.search(line)
# If we are at the beginning of the class definitions, prepare to
- # transition to the DEFINING_ITERATOR/DEFINING_EQUALITY state for the
- # right class names.
+ # transition to the DEFINING_ITERATOR state for the right class names.
if match:
cls = match.group(1)
if cls in d:
# Adding support for iteration for the matched SB class.
state |= DEFINING_ITERATOR
- if cls in e:
- # Adding support for eq and ne for the matched SB class.
- state |= DEFINING_EQUALITY
- if (state & DEFINING_ITERATOR) or (state & DEFINING_EQUALITY):
+ if state & DEFINING_ITERATOR:
match = init_pattern.search(line)
if match:
# We found the beginning of the __init__ method definition.
@@ -280,9 +258,6 @@
if (state & DEFINING_ITERATOR):
new_content.add_line(iter_def % d[cls])
new_content.add_line(len_def % d[cls][0])
- if (state & DEFINING_EQUALITY):
- new_content.add_line(eq_def % (cls, list_to_frag(e[cls])))
- new_content.add_line(ne_def)
# SBModule has extra SBSection, SBCompileUnit iterators and
# symbol_in_section_iter()!
Index: include/lldb/API/SBWatchpoint.h
===================================================================
--- include/lldb/API/SBWatchpoint.h
+++ include/lldb/API/SBWatchpoint.h
@@ -27,6 +27,10 @@
explicit operator bool() const;
+ bool operator==(const SBWatchpoint &rhs) const;
+
+ bool operator!=(const SBWatchpoint &rhs) const;
+
bool IsValid() const;
SBError GetError();
Index: include/lldb/API/SBFileSpec.h
===================================================================
--- include/lldb/API/SBFileSpec.h
+++ include/lldb/API/SBFileSpec.h
@@ -30,6 +30,10 @@
explicit operator bool() const;
+ bool operator==(const SBFileSpec &rhs) const;
+
+ bool operator!=(const SBFileSpec &rhs) const;
+
bool IsValid() const;
bool Exists() const;
Index: include/lldb/API/SBAddress.h
===================================================================
--- include/lldb/API/SBAddress.h
+++ include/lldb/API/SBAddress.h
@@ -31,6 +31,10 @@
explicit operator bool() const;
+ // operator== is a free function
+
+ bool operator!=(const SBAddress &rhs) const;
+
bool IsValid() const;
void Clear();
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
