[lldb] Mark most SBAPI methods involving private types as protected or private

Many SB classes have public constructors or methods involving types that
are private. Some are more obvious (e.g. containing lldb_private in the
name) than others (lldb::FooSP is usually std::shared_pointer<lldb_private::Foo>).

This commit explicitly does not address FileSP, so I'm leaving that one
alone for now.

Some of these were for other SB classes to use and should have been made
protected/private with a friend class entry added. Some of these were
public for some of the swig python helpers to use. I put all of those
functions into a class and made them static methods. The relevant SB
classes mark that class as a friend so they can access those
private/protected members.

I've also removed an outdated SBStructuredData test (can you guess which
constructor it was using?) and updated the other relevant tests.

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

1 files changed, 175 insertions, 152 deletions

diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/SWIGPythonBridge.h b/lldb/source/Plugins/ScriptInterpreter/Python/SWIGPythonBridge.h
index 78b1375..1d8ed87 100644
--- a/lldb/source/Plugins/ScriptInterpreter/Python/SWIGPythonBridge.h
+++ b/lldb/source/Plugins/ScriptInterpreter/Python/SWIGPythonBridge.h
@@ -61,187 +61,210 @@ private:
   T *m_sb;
 };
 
-PythonObject ToSWIGWrapper(lldb::ValueObjectSP value_sp);
-PythonObject ToSWIGWrapper(lldb::TargetSP target_sp);
-PythonObject ToSWIGWrapper(lldb::ProcessSP process_sp);
-PythonObject ToSWIGWrapper(lldb::ThreadPlanSP thread_plan_sp);
-PythonObject ToSWIGWrapper(lldb::BreakpointSP breakpoint_sp);
-PythonObject ToSWIGWrapper(const Status &status);
-PythonObject ToSWIGWrapper(const StructuredDataImpl &data_impl);
-PythonObject ToSWIGWrapper(lldb::ThreadSP thread_sp);
-PythonObject ToSWIGWrapper(lldb::StackFrameSP frame_sp);
-PythonObject ToSWIGWrapper(lldb::DebuggerSP debugger_sp);
-PythonObject ToSWIGWrapper(lldb::WatchpointSP watchpoint_sp);
-PythonObject ToSWIGWrapper(lldb::BreakpointLocationSP bp_loc_sp);
-PythonObject ToSWIGWrapper(lldb::ExecutionContextRefSP ctx_sp);
-PythonObject ToSWIGWrapper(const TypeSummaryOptions &summary_options);
-PythonObject ToSWIGWrapper(const SymbolContext &sym_ctx);
-
-PythonObject ToSWIGWrapper(lldb::ProcessAttachInfoSP attach_info_sp);
-PythonObject ToSWIGWrapper(lldb::ProcessLaunchInfoSP launch_info_sp);
-PythonObject ToSWIGWrapper(lldb::DataExtractorSP data_extractor_sp);
-
-PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBValue> value_sb);
-PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBStream> stream_sb);
-PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBStructuredData> data_sb);
-
-python::ScopedPythonObject<lldb::SBCommandReturnObject>
-ToSWIGWrapper(CommandReturnObject &cmd_retobj);
-python::ScopedPythonObject<lldb::SBEvent> ToSWIGWrapper(Event *event);
+// TODO: We may want to support other languages in the future w/ SWIG (we
+// already support Lua right now, for example). We could create a generic
+// SWIGBridge class and have this one specialize it, something like this:
+//
+// <typename T>
+// class SWIGBridge {
+//   static T ToSWIGWrapper(...);
+// };
+//
+// class SWIGPythonBridge : public SWIGBridge<PythonObject> {
+//   template<> static PythonObject ToSWIGWrapper(...);
+// };
+//
+// And we should be able to more easily support things like Lua
+class SWIGBridge {
+public:
+  static PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBValue> value_sb);
+  static PythonObject ToSWIGWrapper(lldb::ValueObjectSP value_sp);
+  static PythonObject ToSWIGWrapper(lldb::TargetSP target_sp);
+  static PythonObject ToSWIGWrapper(lldb::ProcessSP process_sp);
+  static PythonObject ToSWIGWrapper(lldb::ThreadPlanSP thread_plan_sp);
+  static PythonObject ToSWIGWrapper(lldb::BreakpointSP breakpoint_sp);
+  static PythonObject ToSWIGWrapper(const Status &status);
+  static PythonObject ToSWIGWrapper(const StructuredDataImpl &data_impl);
+  static PythonObject ToSWIGWrapper(lldb::ThreadSP thread_sp);
+  static PythonObject ToSWIGWrapper(lldb::StackFrameSP frame_sp);
+  static PythonObject ToSWIGWrapper(lldb::DebuggerSP debugger_sp);
+  static PythonObject ToSWIGWrapper(lldb::WatchpointSP watchpoint_sp);
+  static PythonObject ToSWIGWrapper(lldb::BreakpointLocationSP bp_loc_sp);
+  static PythonObject ToSWIGWrapper(lldb::TypeImplSP type_impl_sp);
+  static PythonObject ToSWIGWrapper(lldb::ExecutionContextRefSP ctx_sp);
+  static PythonObject ToSWIGWrapper(const TypeSummaryOptions &summary_options);
+  static PythonObject ToSWIGWrapper(const SymbolContext &sym_ctx);
+
+  static PythonObject ToSWIGWrapper(lldb::ProcessAttachInfoSP attach_info_sp);
+  static PythonObject ToSWIGWrapper(lldb::ProcessLaunchInfoSP launch_info_sp);
+  static PythonObject ToSWIGWrapper(lldb::DataExtractorSP data_extractor_sp);
+
+  static PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBStream> stream_sb);
+  static PythonObject
+  ToSWIGWrapper(std::unique_ptr<lldb::SBStructuredData> data_sb);
+
+  static python::ScopedPythonObject<lldb::SBCommandReturnObject>
+  ToSWIGWrapper(CommandReturnObject &cmd_retobj);
+  static python::ScopedPythonObject<lldb::SBEvent> ToSWIGWrapper(Event *event);
+  // These prototypes are the Pythonic implementations of the required
+  // callbacks. Although these are scripting-language specific, their definition
+  // depends on the public API.
+
+  static python::PythonObject LLDBSwigPythonCreateScriptedObject(
+      const char *python_class_name, const char *session_dictionary_name,
+      lldb::ExecutionContextRefSP exe_ctx_sp,
+      const lldb_private::StructuredDataImpl &args_impl,
+      std::string &error_string);
+
+  static llvm::Expected<bool> LLDBSwigPythonBreakpointCallbackFunction(
+      const char *python_function_name, const char *session_dictionary_name,
+      const lldb::StackFrameSP &sb_frame,
+      const lldb::BreakpointLocationSP &sb_bp_loc,
+      const lldb_private::StructuredDataImpl &args_impl);
+
+  static bool LLDBSwigPythonWatchpointCallbackFunction(
+      const char *python_function_name, const char *session_dictionary_name,
+      const lldb::StackFrameSP &sb_frame, const lldb::WatchpointSP &sb_wp);
+
+  static bool
+  LLDBSwigPythonFormatterCallbackFunction(const char *python_function_name,
+                                          const char *session_dictionary_name,
+                                          lldb::TypeImplSP type_impl_sp);
 
-} // namespace python
+  static bool LLDBSwigPythonCallTypeScript(
+      const char *python_function_name, const void *session_dictionary,
+      const lldb::ValueObjectSP &valobj_sp, void **pyfunct_wrapper,
+      const lldb::TypeSummaryOptionsSP &options_sp, std::string &retval);
 
-void *LLDBSWIGPython_CastPyObjectToSBData(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBBreakpoint(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBAttachInfo(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBLaunchInfo(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBError(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBValue(PyObject *data);
-void *LLDBSWIGPython_CastPyObjectToSBMemoryRegionInfo(PyObject *data);
+  static python::PythonObject
+  LLDBSwigPythonCreateSyntheticProvider(const char *python_class_name,
+                                        const char *session_dictionary_name,
+                                        const lldb::ValueObjectSP &valobj_sp);
 
-// These prototypes are the Pythonic implementations of the required callbacks.
-// Although these are scripting-language specific, their definition depends on
-// the public API.
-
-python::PythonObject LLDBSwigPythonCreateScriptedObject(
-    const char *python_class_name, const char *session_dictionary_name,
-    lldb::ExecutionContextRefSP exe_ctx_sp,
-    const lldb_private::StructuredDataImpl &args_impl,
-    std::string &error_string);
-
-llvm::Expected<bool> LLDBSwigPythonBreakpointCallbackFunction(
-    const char *python_function_name, const char *session_dictionary_name,
-    const lldb::StackFrameSP &sb_frame,
-    const lldb::BreakpointLocationSP &sb_bp_loc,
-    const lldb_private::StructuredDataImpl &args_impl);
-
-bool LLDBSwigPythonWatchpointCallbackFunction(
-    const char *python_function_name, const char *session_dictionary_name,
-    const lldb::StackFrameSP &sb_frame, const lldb::WatchpointSP &sb_wp);
-
-bool LLDBSwigPythonFormatterCallbackFunction(
-    const char *python_function_name, const char *session_dictionary_name,
-    lldb::TypeImplSP type_impl_sp);
-
-bool LLDBSwigPythonCallTypeScript(const char *python_function_name,
-                                  const void *session_dictionary,
-                                  const lldb::ValueObjectSP &valobj_sp,
-                                  void **pyfunct_wrapper,
-                                  const lldb::TypeSummaryOptionsSP &options_sp,
-                                  std::string &retval);
-
-python::PythonObject
-LLDBSwigPythonCreateSyntheticProvider(const char *python_class_name,
-                                      const char *session_dictionary_name,
-                                      const lldb::ValueObjectSP &valobj_sp);
+  static python::PythonObject
+  LLDBSwigPythonCreateCommandObject(const char *python_class_name,
+                                    const char *session_dictionary_name,
+                                    lldb::DebuggerSP debugger_sp);
 
-python::PythonObject
-LLDBSwigPythonCreateCommandObject(const char *python_class_name,
-                                  const char *session_dictionary_name,
-                                  lldb::DebuggerSP debugger_sp);
+  static python::PythonObject LLDBSwigPythonCreateScriptedThreadPlan(
+      const char *python_class_name, const char *session_dictionary_name,
+      const StructuredDataImpl &args_data, std::string &error_string,
+      const lldb::ThreadPlanSP &thread_plan_sp);
 
-python::PythonObject LLDBSwigPythonCreateScriptedThreadPlan(
-    const char *python_class_name, const char *session_dictionary_name,
-    const StructuredDataImpl &args_data, std::string &error_string,
-    const lldb::ThreadPlanSP &thread_plan_sp);
+  static bool LLDBSWIGPythonCallThreadPlan(void *implementor,
+                                           const char *method_name,
+                                           lldb_private::Event *event_sp,
+                                           bool &got_error);
 
-bool LLDBSWIGPythonCallThreadPlan(void *implementor, const char *method_name,
-                                  lldb_private::Event *event_sp,
-                                  bool &got_error);
-                                  
-bool LLDBSWIGPythonCallThreadPlan(void *implementor, 
-                                  const char *method_name,
-                                  lldb_private::Stream *stream,
-                                  bool &got_error);
+  static bool LLDBSWIGPythonCallThreadPlan(void *implementor,
+                                           const char *method_name,
+                                           lldb_private::Stream *stream,
+                                           bool &got_error);
 
-python::PythonObject LLDBSwigPythonCreateScriptedBreakpointResolver(
-    const char *python_class_name, const char *session_dictionary_name,
-    const StructuredDataImpl &args, const lldb::BreakpointSP &bkpt_sp);
+  static python::PythonObject LLDBSwigPythonCreateScriptedBreakpointResolver(
+      const char *python_class_name, const char *session_dictionary_name,
+      const StructuredDataImpl &args, const lldb::BreakpointSP &bkpt_sp);
 
-unsigned int
-LLDBSwigPythonCallBreakpointResolver(void *implementor, const char *method_name,
-                                     lldb_private::SymbolContext *sym_ctx);
+  static unsigned int
+  LLDBSwigPythonCallBreakpointResolver(void *implementor,
+                                       const char *method_name,
+                                       lldb_private::SymbolContext *sym_ctx);
 
-python::PythonObject LLDBSwigPythonCreateScriptedStopHook(
-    lldb::TargetSP target_sp, const char *python_class_name,
-    const char *session_dictionary_name, const StructuredDataImpl &args,
-    lldb_private::Status &error);
+  static python::PythonObject LLDBSwigPythonCreateScriptedStopHook(
+      lldb::TargetSP target_sp, const char *python_class_name,
+      const char *session_dictionary_name, const StructuredDataImpl &args,
+      lldb_private::Status &error);
 
-bool LLDBSwigPythonStopHookCallHandleStop(void *implementor,
-                                          lldb::ExecutionContextRefSP exc_ctx,
-                                          lldb::StreamSP stream);
+  static bool
+  LLDBSwigPythonStopHookCallHandleStop(void *implementor,
+                                       lldb::ExecutionContextRefSP exc_ctx,
+                                       lldb::StreamSP stream);
 
-size_t LLDBSwigPython_CalculateNumChildren(PyObject *implementor, uint32_t max);
+  static size_t LLDBSwigPython_CalculateNumChildren(PyObject *implementor,
+                                                    uint32_t max);
 
-PyObject *LLDBSwigPython_GetChildAtIndex(PyObject *implementor, uint32_t idx);
+  static PyObject *LLDBSwigPython_GetChildAtIndex(PyObject *implementor,
+                                                  uint32_t idx);
 
-int LLDBSwigPython_GetIndexOfChildWithName(PyObject *implementor,
-                                           const char *child_name);
+  static int LLDBSwigPython_GetIndexOfChildWithName(PyObject *implementor,
+                                                    const char *child_name);
 
-lldb::ValueObjectSP LLDBSWIGPython_GetValueObjectSPFromSBValue(void *data);
+  static lldb::ValueObjectSP
+  LLDBSWIGPython_GetValueObjectSPFromSBValue(void *data);
 
-bool LLDBSwigPython_UpdateSynthProviderInstance(PyObject *implementor);
+  static bool LLDBSwigPython_UpdateSynthProviderInstance(PyObject *implementor);
 
-bool LLDBSwigPython_MightHaveChildrenSynthProviderInstance(
-    PyObject *implementor);
+  static bool
+  LLDBSwigPython_MightHaveChildrenSynthProviderInstance(PyObject *implementor);
 
-PyObject *LLDBSwigPython_GetValueSynthProviderInstance(PyObject *implementor);
+  static PyObject *
+  LLDBSwigPython_GetValueSynthProviderInstance(PyObject *implementor);
 
-bool LLDBSwigPythonCallCommand(const char *python_function_name,
-                               const char *session_dictionary_name,
-                               lldb::DebuggerSP debugger, const char *args,
-                               lldb_private::CommandReturnObject &cmd_retobj,
-                               lldb::ExecutionContextRefSP exe_ctx_ref_sp);
+  static bool
+  LLDBSwigPythonCallCommand(const char *python_function_name,
+                            const char *session_dictionary_name,
+                            lldb::DebuggerSP debugger, const char *args,
+                            lldb_private::CommandReturnObject &cmd_retobj,
+                            lldb::ExecutionContextRefSP exe_ctx_ref_sp);
 
-bool LLDBSwigPythonCallCommandObject(
-    PyObject *implementor, lldb::DebuggerSP debugger, const char *args,
-    lldb_private::CommandReturnObject &cmd_retobj,
-    lldb::ExecutionContextRefSP exe_ctx_ref_sp);
+  static bool
+  LLDBSwigPythonCallCommandObject(PyObject *implementor,
+                                  lldb::DebuggerSP debugger, const char *args,
+                                  lldb_private::CommandReturnObject &cmd_retobj,
+                                  lldb::ExecutionContextRefSP exe_ctx_ref_sp);
 
-bool LLDBSwigPythonCallModuleInit(const char *python_module_name,
-                                  const char *session_dictionary_name,
-                                  lldb::DebuggerSP debugger);
+  static bool LLDBSwigPythonCallModuleInit(const char *python_module_name,
+                                           const char *session_dictionary_name,
+                                           lldb::DebuggerSP debugger);
 
-python::PythonObject
-LLDBSWIGPythonCreateOSPlugin(const char *python_class_name,
-                             const char *session_dictionary_name,
-                             const lldb::ProcessSP &process_sp);
+  static python::PythonObject
+  LLDBSWIGPythonCreateOSPlugin(const char *python_class_name,
+                               const char *session_dictionary_name,
+                               const lldb::ProcessSP &process_sp);
 
-python::PythonObject
-LLDBSWIGPython_CreateFrameRecognizer(const char *python_class_name,
-                                     const char *session_dictionary_name);
+  static python::PythonObject
+  LLDBSWIGPython_CreateFrameRecognizer(const char *python_class_name,
+                                       const char *session_dictionary_name);
 
-PyObject *
-LLDBSwigPython_GetRecognizedArguments(PyObject *implementor,
-                                      const lldb::StackFrameSP &frame_sp);
+  static PyObject *
+  LLDBSwigPython_GetRecognizedArguments(PyObject *implementor,
+                                        const lldb::StackFrameSP &frame_sp);
 
-bool LLDBSWIGPythonRunScriptKeywordProcess(const char *python_function_name,
-                                           const char *session_dictionary_name,
-                                           const lldb::ProcessSP &process,
-                                           std::string &output);
+  static bool LLDBSWIGPythonRunScriptKeywordProcess(
+      const char *python_function_name, const char *session_dictionary_name,
+      const lldb::ProcessSP &process, std::string &output);
 
-std::optional<std::string>
-LLDBSWIGPythonRunScriptKeywordThread(const char *python_function_name,
-                                     const char *session_dictionary_name,
-                                     lldb::ThreadSP thread);
+  static std::optional<std::string>
+  LLDBSWIGPythonRunScriptKeywordThread(const char *python_function_name,
+                                       const char *session_dictionary_name,
+                                       lldb::ThreadSP thread);
 
-bool LLDBSWIGPythonRunScriptKeywordTarget(const char *python_function_name,
-                                          const char *session_dictionary_name,
-                                          const lldb::TargetSP &target,
-                                          std::string &output);
+  static bool LLDBSWIGPythonRunScriptKeywordTarget(
+      const char *python_function_name, const char *session_dictionary_name,
+      const lldb::TargetSP &target, std::string &output);
 
-std::optional<std::string>
-LLDBSWIGPythonRunScriptKeywordFrame(const char *python_function_name,
-                                    const char *session_dictionary_name,
-                                    lldb::StackFrameSP frame);
+  static std::optional<std::string>
+  LLDBSWIGPythonRunScriptKeywordFrame(const char *python_function_name,
+                                      const char *session_dictionary_name,
+                                      lldb::StackFrameSP frame);
 
-bool LLDBSWIGPythonRunScriptKeywordValue(const char *python_function_name,
-                                         const char *session_dictionary_name,
-                                         const lldb::ValueObjectSP &value,
-                                         std::string &output);
+  static bool LLDBSWIGPythonRunScriptKeywordValue(
+      const char *python_function_name, const char *session_dictionary_name,
+      const lldb::ValueObjectSP &value, std::string &output);
+
+  static void *
+  LLDBSWIGPython_GetDynamicSetting(void *module, const char *setting,
+                                   const lldb::TargetSP &target_sp);
+};
 
-void *LLDBSWIGPython_GetDynamicSetting(void *module, const char *setting,
-                                       const lldb::TargetSP &target_sp);
+void *LLDBSWIGPython_CastPyObjectToSBData(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBBreakpoint(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBAttachInfo(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBLaunchInfo(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBError(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBValue(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBMemoryRegionInfo(PyObject *data);
+} // namespace python
 
 } // namespace lldb_private