[lldb/docs] Silence warnings when generating website

This patch does various things to silence the warnings that show up when
generating the website documentation.

First, this patch adds the missing definition for special member methods
in every SBAPI class. If the class cannot implement one of the special
member method, we just define it as a null operation (pass).

This should fix the following warnings:

```
WARNING: missing attribute __int__ in object lldb.SB*
WARNING: missing attribute __len__ in object lldb.SB*
WARNING: missing attribute __hex__ in object lldb.SB*
WARNING: missing attribute __oct__ in object lldb.SB*
WARNING: missing attribute __iter__ in object lldb.SB*
```

Then, it un-skips the various `static` methods that we didn't generate
the methods for, since it's not necessary thanks to the automod-api module.

Finally, this comments out the `_static` directory in the sphinx config,
since we don't need it anymore.

Differential Revision: https://reviews.llvm.org/D159017

Signed-off-by: Med Ismail Bennani <[email protected]>

Author: medismailben

lldb/bindings/interface/SBAddressExtensions.i

@@ -7,6 +7,12 @@ STRING_EXTENSION_OUTSIDE(SBAddress)
     %pythoncode%{
     def __eq__(self, other):
       return not self.__ne__(other)
+
+    def __len__(self):
+        pass
+
+    def __iter__(self):
+        pass
     %}
 
     %pythoncode %{

lldb/bindings/interface/SBAttachInfoExtensions.i

@@ -0,0 +1,27 @@
+STRING_EXTENSION_OUTSIDE(SBAttachInfo)
+
+%extend lldb::SBAttachInfo {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBBlockExtensions.i

@@ -3,6 +3,21 @@ STRING_EXTENSION_OUTSIDE(SBBlock)
 %extend lldb::SBBlock {
 #ifdef SWIGPYTHON
     %pythoncode %{
+        def __int__(self):
+            pass
+
+        def __len__(self):
+            pass
+
+        def __hex__(self):
+            pass
+
+        def __oct__(self):
+            pass
+
+        def __iter__(self):
+            pass
+
         def get_range_at_index(self, idx):
             if idx < self.GetNumRanges():
                 return [self.GetRangeStartAddress(idx), self.GetRangeEndAddress(idx)]

lldb/bindings/interface/SBBreakpointExtensions.i

@@ -44,6 +44,15 @@ STRING_EXTENSION_OUTSIDE(SBBreakpoint)
             object.'''
             return self.GetNumLocations()
 
+        def __int__(self):
+            pass
+
+        def __hex__(self):
+            pass
+
+        def __oct__(self):
+            pass
+
         locations = property(get_breakpoint_location_list, None, doc='''A read only property that returns a list() of lldb.SBBreakpointLocation objects for this breakpoint.''')
         location = property(get_locations_access_object, None, doc='''A read only property that returns an object that can access locations by index (not location ID) (location = bkpt.location[12]).''')
         id = property(GetID, None, doc='''A read only property that returns the ID of this breakpoint.''')

lldb/bindings/interface/SBBreakpointListExtensions.i

@@ -0,0 +1,29 @@
+STRING_EXTENSION_OUTSIDE(SBBreakpointList)
+
+%extend lldb::SBBreakpointList {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+        pass
+
+    def __len__(self):
+        '''Return the number of breakpoints in a lldb.SBBreakpointList object.'''
+        return self.GetSize()
+
+    def __hex__(self):
+        pass
+
+    def __oct__(self):
+        pass
+
+    def __iter__(self):
+        '''Iterate over all breakpoints in a lldb.SBBreakpointList object.'''
+        return lldb_iter(self, 'GetSize', 'GetBreakpointAtIndex')
+    %}
+#endif
+}

lldb/bindings/interface/SBBreakpointLocationExtensions.i

@@ -1 +1,27 @@
 STRING_EXTENSION_LEVEL_OUTSIDE(SBBreakpointLocation, lldb::eDescriptionLevelFull)
+
+%extend lldb::SBBreakpointLocation {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBBreakpointNameExtensions.i

@@ -1 +1,27 @@
 STRING_EXTENSION_OUTSIDE(SBBreakpointName)
+
+%extend lldb::SBBreakpointName {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBBroadcastExtensions.i

@@ -0,0 +1,27 @@
+STRING_EXTENSION_OUTSIDE(SBBroadcaster)
+
+%extend lldb::SBBroadcaster {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBCommandInterpreterExtensions.i

@@ -0,0 +1,27 @@
+STRING_EXTENSION_OUTSIDE(SBCommandInterpreter)
+
+%extend lldb::SBCommandInterpreter {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBCommandInterpreterRunOptionsExtensions.i

@@ -0,0 +1,27 @@
+STRING_EXTENSION_OUTSIDE(SBCommandInterpreterRunOptions)
+
+%extend lldb::SBCommandInterpreterRunOptions {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBCommandReturnObjectExtensions.i

@@ -1,6 +1,30 @@
 STRING_EXTENSION_OUTSIDE(SBCommandReturnObject)
 
 %extend lldb::SBCommandReturnObject {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+
     // transfer_ownership does nothing, and is here for compatibility with
     // old scripts.  Ownership is tracked by reference count in the ordinary way.
 

lldb/bindings/interface/SBCommunicationExtensions.i

@@ -0,0 +1,27 @@
+STRING_EXTENSION_OUTSIDE(SBCommunication)
+
+%extend lldb::SBCommunication {
+#ifdef SWIGPYTHON
+    // 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)
+
+    def __int__(self):
+      pass
+
+    def __len__(self):
+      pass
+
+    def __hex__(self):
+      pass
+
+    def __oct__(self):
+      pass
+
+    def __iter__(self):
+      pass
+    %}
+#endif
+}

lldb/bindings/interface/SBCompileUnitExtensions.i

@@ -3,6 +3,15 @@ STRING_EXTENSION_OUTSIDE(SBCompileUnit)
 %extend lldb::SBCompileUnit {
 #ifdef SWIGPYTHON
     %pythoncode %{
+        def __int__(self):
+            pass
+
+        def __hex__(self):
+            pass
+
+        def __oct__(self):
+            pass
+
         def __iter__(self):
             '''Iterate over all line entries in a lldb.SBCompileUnit object.'''
             return lldb_iter(self, 'GetNumLineEntries', 'GetLineEntryAtIndex')

lldb/bindings/interface/SBDataExtensions.i

@@ -3,6 +3,23 @@ STRING_EXTENSION_OUTSIDE(SBData)
 %extend lldb::SBData {
 #ifdef SWIGPYTHON
     %pythoncode %{
+        def __eq__(self, other):
+            return not self.__ne__(other)
+
+        def __int__(self):
+            pass
+
+        def __hex__(self):
+            pass
+
+        def __oct__(self):
+            pass
+
+        def __len__(self):
+            return self.GetByteSize()
+
+        def __iter__(self):
+            pass
 
         class read_data_helper:
             def __init__(self, sbdata, readerfunc, item_size):

lldb/bindings/interface/SBDebuggerExtensions.i

@@ -24,6 +24,15 @@ STRING_EXTENSION_OUTSIDE(SBDebugger)
                 file = sys.stderr
             self.SetErrorFile(SBFile.Create(file, borrow=True))
 
+        def __int__(self):
+            pass
+
+        def __hex__(self):
+            pass
+
+        def __oct__(self):
+            pass
+
         def __iter__(self):
             '''Iterate over all targets in a lldb.SBDebugger object.'''
             return lldb_iter(self, 'GetNumTargets', 'GetTargetAtIndex')

lldb/bindings/interface/SBDeclarationExtensions.i

@@ -3,6 +3,21 @@ STRING_EXTENSION_OUTSIDE(SBDeclaration)
 %extend lldb::SBDeclaration {
 #ifdef SWIGPYTHON
         %pythoncode %{
+            def __int__(self):
+                pass
+
+            def __hex__(self):
+                pass
+
+            def __oct__(self):
+                pass
+
+            def __len__(self):
+                pass
+
+            def __iter__(self):
+                pass
+
             file = property(GetFileSpec, None, doc='''A read only property that returns an lldb object that represents the file (lldb.SBFileSpec) for this line entry.''')
             line = property(GetLine, None, doc='''A read only property that returns the 1 based line number for this line entry, a return value of zero indicates that no line information is available.''')
             column = property(GetColumn, None, doc='''A read only property that returns the 1 based column number for this line entry, a return value of zero indicates that no column information is available.''')