contrib/llvm-project/lldb/docs/python_api.rst

   1 LLDB Python API
   2 ================================
   3
   4 ..
   5   The long list of "skip" filters out several global functions that are
   6   generated by SWIG (but which are not useful as they are only the
   7   backend for their respective static functions in the classes).
   8   Without this list
   9 .. automodapi:: lldb
  10   :no-inheritance-diagram:
  11   :skip: SBBreakpoint_EventIsBreakpointEvent
  12   :skip: SBBreakpoint_GetBreakpointEventTypeFromEvent
  13   :skip: SBBreakpoint_GetBreakpointFromEvent
  14   :skip: SBBreakpoint_GetBreakpointLocationAtIndexFromEvent
  15   :skip: SBBreakpoint_GetNumBreakpointLocationsFromEvent
  16   :skip: SBCommandInterpreter_EventIsCommandInterpreterEvent
  17   :skip: SBCommandInterpreter_GetArgumentDescriptionAsCString
  18   :skip: SBCommandInterpreter_GetArgumentTypeAsCString
  19   :skip: SBCommandInterpreter_GetBroadcasterClass
  20   :skip: SBCommunication_GetBroadcasterClass
  21   :skip: SBData_CreateDataFromCString
  22   :skip: SBData_CreateDataFromDoubleArray
  23   :skip: SBData_CreateDataFromSInt32Array
  24   :skip: SBData_CreateDataFromSInt64Array
  25   :skip: SBData_CreateDataFromUInt32Array
  26   :skip: SBData_CreateDataFromUInt64Array
  27   :skip: SBDebugger_Create
  28   :skip: SBDebugger_Create
  29   :skip: SBDebugger_Destroy
  30   :skip: SBDebugger_FindDebuggerWithID
  31   :skip: SBDebugger_GetBuildConfiguration
  32   :skip: SBDebugger_GetDefaultArchitecture
  33   :skip: SBDebugger_GetInternalVariableValue
  34   :skip: SBDebugger_GetVersionString
  35   :skip: SBDebugger_Initialize
  36   :skip: SBDebugger_InitializeWithErrorHandling
  37   :skip: SBDebugger_MemoryPressureDetected
  38   :skip: SBDebugger_SetDefaultArchitecture
  39   :skip: SBDebugger_SetInternalVariable
  40   :skip: SBDebugger_StateAsCString
  41   :skip: SBDebugger_StateIsRunningState
  42   :skip: SBDebugger_StateIsStoppedState
  43   :skip: SBDebugger_Terminate
  44   :skip: SBEvent_GetCStringFromEvent
  45   :skip: SBFileSpec_ResolvePath
  46   :skip: SBFile_MakeBorrowed
  47   :skip: SBFile_MakeBorrowedForcingIOMethods
  48   :skip: SBFile_MakeForcingIOMethods
  49   :skip: SBHostOS_GetLLDBPath
  50   :skip: SBHostOS_GetLLDBPythonPath
  51   :skip: SBHostOS_GetProgramFileSpec
  52   :skip: SBHostOS_GetUserHomeDirectory
  53   :skip: SBHostOS_ThreadCancel
  54   :skip: SBHostOS_ThreadCreate
  55   :skip: SBHostOS_ThreadCreated
  56   :skip: SBHostOS_ThreadDetach
  57   :skip: SBHostOS_ThreadJoin
  58   :skip: SBLanguageRuntime_GetLanguageTypeFromString
  59   :skip: SBLanguageRuntime_GetNameForLanguageType
  60   :skip: SBModuleSpecList_GetModuleSpecifications
  61   :skip: SBModule_GarbageCollectAllocatedModules
  62   :skip: SBModule_GetNumberAllocatedModules
  63   :skip: SBPlatform_GetHostPlatform
  64   :skip: SBProcess_EventIsProcessEvent
  65   :skip: SBProcess_EventIsStructuredDataEvent
  66   :skip: SBProcess_GetBroadcasterClassName
  67   :skip: SBProcess_GetInterruptedFromEvent
  68   :skip: SBProcess_GetNumRestartedReasonsFromEvent
  69   :skip: SBProcess_GetProcessFromEvent
  70   :skip: SBProcess_GetRestartedFromEvent
  71   :skip: SBProcess_GetRestartedReasonAtIndexFromEvent
  72   :skip: SBProcess_GetStateFromEvent
  73   :skip: SBProcess_GetStructuredDataFromEvent
  74   :skip: SBReproducer_Capture
  75   :skip: SBReproducer_PassiveReplay
  76   :skip: SBReproducer_SetAutoGenerate
  77   :skip: SBReproducer_SetWorkingDirectory
  78   :skip: SBTarget_EventIsTargetEvent
  79   :skip: SBTarget_GetBroadcasterClassName
  80   :skip: SBTarget_GetModuleAtIndexFromEvent
  81   :skip: SBTarget_GetNumModulesFromEvent
  82   :skip: SBTarget_GetTargetFromEvent
  83   :skip: SBThread_EventIsThreadEvent
  84   :skip: SBThread_GetBroadcasterClassName
  85   :skip: SBThread_GetStackFrameFromEvent
  86   :skip: SBThread_GetThreadFromEvent
  87   :skip: SBTypeSummary_CreateWithFunctionName
  88   :skip: SBTypeSummary_CreateWithScriptCode
  89   :skip: SBTypeSummary_CreateWithSummaryString
  90   :skip: SBTypeSynthetic_CreateWithClassName
  91   :skip: SBTypeSynthetic_CreateWithScriptCode
  92   :skip: SBWatchpoint_EventIsWatchpointEvent
  93   :skip: SBWatchpoint_GetWatchpointEventTypeFromEvent
  94   :skip: SBWatchpoint_GetWatchpointFromEvent
  95   :skip: command
  96   :skip: in_range
  97   :skip: is_numeric_type
  98   :skip: lldb_iter