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