2 This is a sub page of the Python API docs and linked from the main API page.
3 The page isn't in any toctree, so silence the sphinx warnings by marking it as orphan.
7 Python API enumerators and constants
8 ====================================
10 .. py:currentmodule:: lldb
15 Generic register numbers
16 ------------------------
18 .. py:data:: LLDB_REGNUM_GENERIC_PC
22 .. py:data:: LLDB_REGNUM_GENERIC_SP
25 .. py:data:: LLDB_REGNUM_GENERIC_FP
29 .. py:data:: LLDB_REGNUM_GENERIC_RA
33 .. py:data:: LLDB_REGNUM_GENERIC_FLAGS
35 Processor flags register.
37 .. py:data:: LLDB_REGNUM_GENERIC_ARG1
39 The register that would contain pointer size or less argument 1 (if any).
41 .. py:data:: LLDB_REGNUM_GENERIC_ARG2
43 The register that would contain pointer size or less argument 2 (if any).
45 .. py:data:: LLDB_REGNUM_GENERIC_ARG3
47 The register that would contain pointer size or less argument 3 (if any).
49 .. py:data:: LLDB_REGNUM_GENERIC_ARG4
51 The register that would contain pointer size or less argument 4 (if any).
53 .. py:data:: LLDB_REGNUM_GENERIC_ARG5
55 The register that would contain pointer size or less argument 5 (if any).
57 .. py:data:: LLDB_REGNUM_GENERIC_ARG6
59 The register that would contain pointer size or less argument 6 (if any).
61 .. py:data:: LLDB_REGNUM_GENERIC_ARG7
63 The register that would contain pointer size or less argument 7 (if any).
65 .. py:data:: LLDB_REGNUM_GENERIC_ARG8
67 The register that would contain pointer size or less argument 8 (if any).
70 Invalid value definitions
71 -------------------------
73 .. py:data:: LLDB_INVALID_BREAK_ID
74 .. py:data:: LLDB_INVALID_WATCH_ID
75 .. py:data:: LLDB_INVALID_ADDRESS
76 .. py:data:: LLDB_INVALID_INDEX32
77 .. py:data:: LLDB_INVALID_IVAR_OFFSET
78 .. py:data:: LLDB_INVALID_IMAGE_TOKEN
79 .. py:data:: LLDB_INVALID_MODULE_VERSION
80 .. py:data:: LLDB_INVALID_REGNUM
81 .. py:data:: LLDB_INVALID_UID
82 .. py:data:: LLDB_INVALID_PROCESS_ID
83 .. py:data:: LLDB_INVALID_THREAD_ID
84 .. py:data:: LLDB_INVALID_FRAME_ID
85 .. py:data:: LLDB_INVALID_SIGNAL_NUMBER
86 .. py:data:: LLDB_INVALID_OFFSET
87 .. py:data:: LLDB_INVALID_LINE_NUMBER
88 .. py:data:: LLDB_INVALID_QUEUE_ID
93 .. py:data:: LLDB_ARCH_DEFAULT
94 .. py:data:: LLDB_ARCH_DEFAULT_32BIT
95 .. py:data:: LLDB_ARCH_DEFAULT_64BIT
96 .. py:data:: LLDB_INVALID_CPUTYPE
99 Option set definitions
100 ----------------------
102 .. py:data:: LLDB_MAX_NUM_OPTION_SETS
103 .. py:data:: LLDB_OPT_SET_ALL
104 .. py:data:: LLDB_OPT_SET_1
105 .. py:data:: LLDB_OPT_SET_2
106 .. py:data:: LLDB_OPT_SET_3
107 .. py:data:: LLDB_OPT_SET_4
108 .. py:data:: LLDB_OPT_SET_5
109 .. py:data:: LLDB_OPT_SET_6
110 .. py:data:: LLDB_OPT_SET_7
111 .. py:data:: LLDB_OPT_SET_8
112 .. py:data:: LLDB_OPT_SET_9
113 .. py:data:: LLDB_OPT_SET_10
114 .. py:data:: LLDB_OPT_SET_11
116 Miscellaneous constants
117 ------------------------
119 .. py:data:: LLDB_GENERIC_ERROR
120 .. py:data:: LLDB_DEFAULT_BREAK_SIZE
121 .. py:data:: LLDB_WATCH_TYPE_READ
122 .. py:data:: LLDB_WATCH_TYPE_WRITE
134 .. py:data:: eStateInvalid
135 .. py:data:: eStateUnloaded
137 Process is object is valid, but not currently loaded.
139 .. py:data:: eStateConnected
141 Process is connected to remote debug services, but not
142 launched or attached to anything yet.
144 .. py:data:: eStateAttaching
146 Process is in the process of launching.
148 .. py:data:: eStateLaunching
150 Process is in the process of launching.
152 .. py:data:: eStateStopped
154 Process or thread is stopped and can be examined.
156 .. py:data:: eStateRunning
158 Process or thread is running and can't be examined.
160 .. py:data:: eStateStepping
162 Process or thread is in the process of stepping and can
165 .. py:data:: eStateCrashed
167 Process or thread has crashed and can be examined.
169 .. py:data:: eStateDetached
171 Process has been detached and can't be examined.
173 .. py:data:: eStateExited
175 Process has exited and can't be examined.
177 .. py:data:: eStateSuspended
179 Process or thread is in a suspended state as far
180 as the debugger is concerned while other processes
181 or threads get the chance to run.
189 .. py:data:: eLaunchFlagNone
190 .. py:data:: eLaunchFlagExec
192 Exec when launching and turn the calling process into a new process.
194 .. py:data:: eLaunchFlagDebug
196 Stop as soon as the process launches to allow the process to be debugged.
198 .. py:data:: eLaunchFlagStopAtEntry
200 Stop at the program entry point instead of auto-continuing when launching or attaching at entry point.
202 .. py:data:: eLaunchFlagDisableASLR
204 Disable Address Space Layout Randomization.
206 .. py:data:: eLaunchFlagDisableSTDIO
208 Disable stdio for inferior process (e.g. for a GUI app).
210 .. py:data:: eLaunchFlagLaunchInTTY
212 Launch the process in a new TTY if supported by the host.
214 .. py:data:: eLaunchFlagLaunchInShell
216 Launch the process inside a shell to get shell expansion.
218 .. py:data:: eLaunchFlagLaunchInSeparateProcessGroup
220 Launch the process in a separate process group if you are going to hand the process off (e.g. to debugserver)
222 .. py:data:: eLaunchFlagDontSetExitStatus
224 set this flag so lldb & the handee don't race to set its exit status.
226 .. py:data:: eLaunchFlagDetachOnError
228 If set, then the client stub should detach rather than killing the debugee
229 if it loses connection with lldb.
231 .. py:data:: eLaunchFlagShellExpandArguments
233 Perform shell-style argument expansion
235 .. py:data:: eLaunchFlagCloseTTYOnExit
237 Close the open TTY on exit
239 .. py:data:: eLaunchFlagInheritTCCFromParent
241 Don't make the inferior responsible for its own TCC
242 permissions but instead inherit them from its parent.
249 .. py:data:: eOnlyThisThread
250 .. py:data:: eAllThreads
251 .. py:data:: eOnlyDuringStepping
259 .. py:data:: eByteOrderInvalid
260 .. py:data:: eByteOrderBig
261 .. py:data:: eByteOrderPDP
262 .. py:data:: eByteOrderLittle
270 .. py:data:: eEncodingInvalid
271 .. py:data:: eEncodingUint
272 .. py:data:: eEncodingSint
273 .. py:data:: eEncodingIEEE754
274 .. py:data:: eEncodingVector
282 .. py:data:: eFormatDefault
283 .. py:data:: eFormatInvalid
284 .. py:data:: eFormatBoolean
285 .. py:data:: eFormatBinary
286 .. py:data:: eFormatBytes
287 .. py:data:: eFormatBytesWithASCII
288 .. py:data:: eFormatChar
289 .. py:data:: eFormatCharPrintable
290 .. py:data:: eFormatComplex
291 .. py:data:: eFormatComplexFloat
292 .. py:data:: eFormatCString
293 .. py:data:: eFormatDecimal
294 .. py:data:: eFormatEnum
295 .. py:data:: eFormatHex
296 .. py:data:: eFormatHexUppercase
297 .. py:data:: eFormatFloat
298 .. py:data:: eFormatOctal
299 .. py:data:: eFormatOSType
300 .. py:data:: eFormatUnicode16
301 .. py:data:: eFormatUnicode32
302 .. py:data:: eFormatUnsigned
303 .. py:data:: eFormatPointer
304 .. py:data:: eFormatVectorOfChar
305 .. py:data:: eFormatVectorOfSInt8
306 .. py:data:: eFormatVectorOfUInt8
307 .. py:data:: eFormatVectorOfSInt16
308 .. py:data:: eFormatVectorOfUInt16
309 .. py:data:: eFormatVectorOfSInt32
310 .. py:data:: eFormatVectorOfUInt32
311 .. py:data:: eFormatVectorOfSInt64
312 .. py:data:: eFormatVectorOfUInt64
313 .. py:data:: eFormatVectorOfFloat16
314 .. py:data:: eFormatVectorOfFloat32
315 .. py:data:: eFormatVectorOfFloat64
316 .. py:data:: eFormatVectorOfUInt128
317 .. py:data:: eFormatComplexInteger
318 .. py:data:: eFormatCharArray
319 .. py:data:: eFormatAddressInfo
320 .. py:data:: eFormatHexFloat
321 .. py:data:: eFormatInstruction
322 .. py:data:: eFormatVoid
323 .. py:data:: eFormatUnicode8
326 .. _DescriptionLevel:
331 .. py:data:: eDescriptionLevelBrief
332 .. py:data:: eDescriptionLevelFull
333 .. py:data:: eDescriptionLevelVerbose
334 .. py:data:: eDescriptionLevelInitial
342 .. py:data:: eScriptLanguageNone
343 .. py:data:: eScriptLanguagePython
344 .. py:data:: eScriptLanguageLua
345 .. py:data:: eScriptLanguageUnknown
346 .. py:data:: eScriptLanguageDefault
354 .. py:data:: eRegisterKindEHFrame
355 .. py:data:: eRegisterKindDWARF
356 .. py:data:: eRegisterKindGeneric
357 .. py:data:: eRegisterKindProcessPlugin
358 .. py:data:: eRegisterKindLLDB
366 .. py:data:: eStopReasonInvalid
367 .. py:data:: eStopReasonNone
368 .. py:data:: eStopReasonTrace
369 .. py:data:: eStopReasonBreakpoint
370 .. py:data:: eStopReasonWatchpoint
371 .. py:data:: eStopReasonSignal
372 .. py:data:: eStopReasonException
373 .. py:data:: eStopReasonExec
374 .. py:data:: eStopReasonFork
375 .. py:data:: eStopReasonVFork
376 .. py:data:: eStopReasonVForkDone
377 .. py:data:: eStopReasonPlanComplete
378 .. py:data:: eStopReasonThreadExiting
379 .. py:data:: eStopReasonInstrumentation
387 .. py:data:: eReturnStatusInvalid
388 .. py:data:: eReturnStatusSuccessFinishNoResult
389 .. py:data:: eReturnStatusSuccessFinishResult
390 .. py:data:: eReturnStatusSuccessContinuingNoResult
391 .. py:data:: eReturnStatusSuccessContinuingResult
392 .. py:data:: eReturnStatusStarted
393 .. py:data:: eReturnStatusFailed
394 .. py:data:: eReturnStatusQuit
402 The results of expression evaluation.
404 .. py:data:: eExpressionCompleted
405 .. py:data:: eExpressionSetupError
406 .. py:data:: eExpressionParseError
407 .. py:data:: eExpressionDiscarded
408 .. py:data:: eExpressionInterrupted
409 .. py:data:: eExpressionHitBreakpoint
410 .. py:data:: eExpressionTimedOut
411 .. py:data:: eExpressionResultUnavailable
412 .. py:data:: eExpressionStoppedForDebug
413 .. py:data:: eExpressionThreadVanished
421 .. py:data:: eSearchDepthInvalid
422 .. py:data:: eSearchDepthTarget
423 .. py:data:: eSearchDepthModule
424 .. py:data:: eSearchDepthCompUnit
425 .. py:data:: eSearchDepthFunction
426 .. py:data:: eSearchDepthBlock
427 .. py:data:: eSearchDepthAddress
430 .. _ConnectionStatus:
435 .. py:data:: eConnectionStatusSuccess
439 .. py:data:: eConnectionStatusEndOfFile
441 End-of-file encountered.
443 .. py:data:: eConnectionStatusError
447 .. py:data:: eConnectionStatusTimedOut
451 .. py:data:: eConnectionStatusNoConnection
455 .. py:data:: eConnectionStatusLostConnection
457 Lost connection while connected to a valid connection.
459 .. py:data:: eConnectionStatusInterrupted
469 .. py:data:: eErrorTypeInvalid
470 .. py:data:: eErrorTypeGeneric
472 Generic errors that can be any value.
474 .. py:data:: eErrorTypeMachKernel
476 Mach kernel error codes.
478 .. py:data:: eErrorTypePOSIX
482 .. py:data:: eErrorTypeExpression
484 These are from the ExpressionResults enum.
486 .. py:data:: eErrorTypeWin32
488 Standard Win32 error codes.
496 .. py:data:: eValueTypeInvalid
497 .. py:data:: eValueTypeVariableGlobal
501 .. py:data:: eValueTypeVariableStatic
505 .. py:data:: eValueTypeVariableArgument
507 Funfction argument variable.
509 .. py:data:: eValueTypeVariableLocal
511 Function local variable.
513 .. py:data:: eValueTypeRegister
515 Stack frame register.
517 .. py:data:: eValueTypeRegisterSet
519 A collection of stack frame register values.
521 .. py:data:: eValueTypeConstResult
523 Constant result variables.
525 .. py:data:: eValueTypeVariableThreadLocal
527 Thread local storage variable.
530 .. _InputReaderGranularity:
532 InputReaderGranularity
533 ----------------------
535 Token size/granularities for Input Readers.
537 .. py:data:: eInputReaderGranularityInvalid
538 .. py:data:: eInputReaderGranularityByte
539 .. py:data:: eInputReaderGranularityWord
540 .. py:data:: eInputReaderGranularityLine
541 .. py:data:: eInputReaderGranularityAll
544 .. _SymbolContextItem:
549 These mask bits allow a common interface for queries that can
550 limit the amount of information that gets parsed to only the
551 information that is requested. These bits also can indicate what
552 actually did get resolved during query function calls.
554 Each definition corresponds to one of the member variables
555 in this class, and requests that that item be resolved, or
556 indicates that the member did get resolved.
558 .. py:data:: eSymbolContextTarget
560 Set when target is requested from a query, or was located
563 .. py:data:: eSymbolContextModule
565 Set when module is requested from a query, or was located
568 .. py:data:: eSymbolContextCompUnit
570 Set when compilation unit is requested from a query, or was
571 located in query results.
573 .. py:data:: eSymbolContextFunction
575 Set when function is requested from a query, or was located
578 .. py:data:: eSymbolContextBlock
580 Set when the deepest block is requested from a query, or
581 was located in query results.
583 .. py:data:: eSymbolContextLineEntry
585 Set when line entry is requested from a query, or was
586 located in query results.
588 .. py:data:: eSymbolContextSymbol
590 Set when symbol is requested from a query, or was located
593 .. py:data:: eSymbolContextEverything
595 Indicates to try and lookup everything up during a routine
596 symbol context query.
598 .. py:data:: eSymbolContextVariable
600 Set when global or static variable is requested from a
601 query, or was located in query results.
602 eSymbolContextVariable is potentially expensive to lookup so
603 it isn't included in eSymbolContextEverything which stops it
604 from being used during frame PC lookups and many other
605 potential address to symbol context lookups.
612 .. py:data:: ePermissionsWritable
613 .. py:data:: ePermissionsReadable
614 .. py:data:: ePermissionsExecutable
622 .. py:data:: eInputReaderActivate
624 Reader is newly pushed onto the reader stack.
626 .. py:data:: eInputReaderAsynchronousOutputWritten
628 An async output event occurred; the reader may want to do something.
630 .. py:data:: eInputReaderReactivate
632 Reader is on top of the stack again after another reader was popped off.
634 .. py:data:: eInputReaderDeactivate
636 Another reader was pushed on the stack.
638 .. py:data:: eInputReaderGotToken
640 Reader got one of its tokens (granularity).
642 .. py:data:: eInputReaderInterrupt
644 Reader received an interrupt signal (probably from a control-c).
646 .. py:data:: eInputReaderEndOfFile
648 Reader received an EOF char (probably from a control-d).
650 .. py:data:: eInputReaderDone
652 Reader was just popped off the stack and is done.
655 .. _BreakpointEventType:
660 .. py:data:: eBreakpointEventTypeInvalidType
661 .. py:data:: eBreakpointEventTypeAdded
662 .. py:data:: eBreakpointEventTypeRemoved
663 .. py:data:: eBreakpointEventTypeLocationsAdded
664 .. py:data:: eBreakpointEventTypeLocationsRemoved
665 .. py:data:: eBreakpointEventTypeLocationsResolved
666 .. py:data:: eBreakpointEventTypeEnabled
667 .. py:data:: eBreakpointEventTypeDisabled
668 .. py:data:: eBreakpointEventTypeCommandChanged
669 .. py:data:: eBreakpointEventTypeConditionChanged
670 .. py:data:: eBreakpointEventTypeIgnoreChanged
671 .. py:data:: eBreakpointEventTypeThreadChanged
672 .. py:data:: eBreakpointEventTypeAutoContinueChanged
675 .. _WatchpointEventType:
680 .. py:data:: eWatchpointEventTypeInvalidType
681 .. py:data:: eWatchpointEventTypeAdded
682 .. py:data:: eWatchpointEventTypeRemoved
683 .. py:data:: eWatchpointEventTypeEnabled
684 .. py:data:: eWatchpointEventTypeDisabled
685 .. py:data:: eWatchpointEventTypeCommandChanged
686 .. py:data:: eWatchpointEventTypeConditionChanged
687 .. py:data:: eWatchpointEventTypeIgnoreChanged
688 .. py:data:: eWatchpointEventTypeThreadChanged
689 .. py:data:: eWatchpointEventTypeTypeChanged
697 .. py:data:: eLanguageTypeUnknown
698 .. py:data:: eLanguageTypeC89
699 .. py:data:: eLanguageTypeC
700 .. py:data:: eLanguageTypeAda83
701 .. py:data:: eLanguageTypeC_plus_plus
702 .. py:data:: eLanguageTypeCobol74
703 .. py:data:: eLanguageTypeCobol85
704 .. py:data:: eLanguageTypeFortran77
705 .. py:data:: eLanguageTypeFortran90
706 .. py:data:: eLanguageTypePascal83
707 .. py:data:: eLanguageTypeModula2
708 .. py:data:: eLanguageTypeJava
709 .. py:data:: eLanguageTypeC99
710 .. py:data:: eLanguageTypeAda95
711 .. py:data:: eLanguageTypeFortran95
712 .. py:data:: eLanguageTypePLI
713 .. py:data:: eLanguageTypeObjC
714 .. py:data:: eLanguageTypeObjC_plus_plus
715 .. py:data:: eLanguageTypeUPC
716 .. py:data:: eLanguageTypeD
717 .. py:data:: eLanguageTypePython
718 .. py:data:: eLanguageTypeOpenCL
719 .. py:data:: eLanguageTypeGo
720 .. py:data:: eLanguageTypeModula3
721 .. py:data:: eLanguageTypeHaskell
722 .. py:data:: eLanguageTypeC_plus_plus_03
723 .. py:data:: eLanguageTypeC_plus_plus_11
724 .. py:data:: eLanguageTypeOCaml
725 .. py:data:: eLanguageTypeRust
726 .. py:data:: eLanguageTypeC11
727 .. py:data:: eLanguageTypeSwift
728 .. py:data:: eLanguageTypeJulia
729 .. py:data:: eLanguageTypeDylan
730 .. py:data:: eLanguageTypeC_plus_plus_14
731 .. py:data:: eLanguageTypeFortran03
732 .. py:data:: eLanguageTypeFortran08
733 .. py:data:: eLanguageTypeMipsAssembler
734 .. py:data:: eLanguageTypeMojo
735 .. py:data:: eLanguageTypeExtRenderScript
736 .. py:data:: eNumLanguageTypes
739 .. _InstrumentationRuntimeType:
741 InstrumentationRuntimeType
742 --------------------------
744 .. py:data:: eInstrumentationRuntimeTypeAddressSanitizer
745 .. py:data:: eInstrumentationRuntimeTypeThreadSanitizer
746 .. py:data:: eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
747 .. py:data:: eInstrumentationRuntimeTypeMainThreadChecker
748 .. py:data:: eInstrumentationRuntimeTypeSwiftRuntimeReporting
749 .. py:data:: eNumInstrumentationRuntimeTypes
752 .. _DynamicValueType:
757 .. py:data:: eNoDynamicValues
758 .. py:data:: eDynamicCanRunTarget
759 .. py:data:: eDynamicDontRunTarget
767 .. py:data:: eStopShowColumnAnsiOrCaret
768 .. py:data:: eStopShowColumnAnsi
769 .. py:data:: eStopShowColumnCaret
770 .. py:data:: eStopShowColumnNone
778 .. py:data:: eAccessNone
779 .. py:data:: eAccessPublic
780 .. py:data:: eAccessPrivate
781 .. py:data:: eAccessProtected
782 .. py:data:: eAccessPackage
785 .. _CommandArgumentType:
790 .. py:data:: eArgTypeAddress
791 .. py:data:: eArgTypeAddressOrExpression
792 .. py:data:: eArgTypeAliasName
793 .. py:data:: eArgTypeAliasOptions
794 .. py:data:: eArgTypeArchitecture
795 .. py:data:: eArgTypeBoolean
796 .. py:data:: eArgTypeBreakpointID
797 .. py:data:: eArgTypeBreakpointIDRange
798 .. py:data:: eArgTypeBreakpointName
799 .. py:data:: eArgTypeByteSize
800 .. py:data:: eArgTypeClassName
801 .. py:data:: eArgTypeCommandName
802 .. py:data:: eArgTypeCount
803 .. py:data:: eArgTypeDescriptionVerbosity
804 .. py:data:: eArgTypeDirectoryName
805 .. py:data:: eArgTypeDisassemblyFlavor
806 .. py:data:: eArgTypeEndAddress
807 .. py:data:: eArgTypeExpression
808 .. py:data:: eArgTypeExpressionPath
809 .. py:data:: eArgTypeExprFormat
810 .. py:data:: eArgTypeFileLineColumn
811 .. py:data:: eArgTypeFilename
812 .. py:data:: eArgTypeFormat
813 .. py:data:: eArgTypeFrameIndex
814 .. py:data:: eArgTypeFullName
815 .. py:data:: eArgTypeFunctionName
816 .. py:data:: eArgTypeFunctionOrSymbol
817 .. py:data:: eArgTypeGDBFormat
818 .. py:data:: eArgTypeHelpText
819 .. py:data:: eArgTypeIndex
820 .. py:data:: eArgTypeLanguage
821 .. py:data:: eArgTypeLineNum
822 .. py:data:: eArgTypeLogCategory
823 .. py:data:: eArgTypeLogChannel
824 .. py:data:: eArgTypeMethod
825 .. py:data:: eArgTypeName
826 .. py:data:: eArgTypeNewPathPrefix
827 .. py:data:: eArgTypeNumLines
828 .. py:data:: eArgTypeNumberPerLine
829 .. py:data:: eArgTypeOffset
830 .. py:data:: eArgTypeOldPathPrefix
831 .. py:data:: eArgTypeOneLiner
832 .. py:data:: eArgTypePath
833 .. py:data:: eArgTypePermissionsNumber
834 .. py:data:: eArgTypePermissionsString
835 .. py:data:: eArgTypePid
836 .. py:data:: eArgTypePlugin
837 .. py:data:: eArgTypeProcessName
838 .. py:data:: eArgTypePythonClass
839 .. py:data:: eArgTypePythonFunction
840 .. py:data:: eArgTypePythonScript
841 .. py:data:: eArgTypeQueueName
842 .. py:data:: eArgTypeRegisterName
843 .. py:data:: eArgTypeRegularExpression
844 .. py:data:: eArgTypeRunArgs
845 .. py:data:: eArgTypeRunMode
846 .. py:data:: eArgTypeScriptedCommandSynchronicity
847 .. py:data:: eArgTypeScriptLang
848 .. py:data:: eArgTypeSearchWord
849 .. py:data:: eArgTypeSelector
850 .. py:data:: eArgTypeSettingIndex
851 .. py:data:: eArgTypeSettingKey
852 .. py:data:: eArgTypeSettingPrefix
853 .. py:data:: eArgTypeSettingVariableName
854 .. py:data:: eArgTypeShlibName
855 .. py:data:: eArgTypeSourceFile
856 .. py:data:: eArgTypeSortOrder
857 .. py:data:: eArgTypeStartAddress
858 .. py:data:: eArgTypeSummaryString
859 .. py:data:: eArgTypeSymbol
860 .. py:data:: eArgTypeThreadID
861 .. py:data:: eArgTypeThreadIndex
862 .. py:data:: eArgTypeThreadName
863 .. py:data:: eArgTypeTypeName
864 .. py:data:: eArgTypeUnsignedInteger
865 .. py:data:: eArgTypeUnixSignal
866 .. py:data:: eArgTypeVarName
867 .. py:data:: eArgTypeValue
868 .. py:data:: eArgTypeWidth
869 .. py:data:: eArgTypeNone
870 .. py:data:: eArgTypePlatform
871 .. py:data:: eArgTypeWatchpointID
872 .. py:data:: eArgTypeWatchpointIDRange
873 .. py:data:: eArgTypeWatchType
874 .. py:data:: eArgRawInput
875 .. py:data:: eArgTypeCommand
876 .. py:data:: eArgTypeColumnNum
877 .. py:data:: eArgTypeModuleUUID
878 .. py:data:: eArgTypeLastArg
885 .. py:data:: eSymbolTypeAny
886 .. py:data:: eSymbolTypeInvalid
887 .. py:data:: eSymbolTypeAbsolute
888 .. py:data:: eSymbolTypeCode
889 .. py:data:: eSymbolTypeResolver
890 .. py:data:: eSymbolTypeData
891 .. py:data:: eSymbolTypeTrampoline
892 .. py:data:: eSymbolTypeRuntime
893 .. py:data:: eSymbolTypeException
894 .. py:data:: eSymbolTypeSourceFile
895 .. py:data:: eSymbolTypeHeaderFile
896 .. py:data:: eSymbolTypeObjectFile
897 .. py:data:: eSymbolTypeCommonBlock
898 .. py:data:: eSymbolTypeBlock
899 .. py:data:: eSymbolTypeLocal
900 .. py:data:: eSymbolTypeParam
901 .. py:data:: eSymbolTypeVariable
902 .. py:data:: eSymbolTypeVariableType
903 .. py:data:: eSymbolTypeLineEntry
904 .. py:data:: eSymbolTypeLineHeader
905 .. py:data:: eSymbolTypeScopeBegin
906 .. py:data:: eSymbolTypeScopeEnd
907 .. py:data:: eSymbolTypeAdditional
908 .. py:data:: eSymbolTypeCompiler
909 .. py:data:: eSymbolTypeInstrumentation
910 .. py:data:: eSymbolTypeUndefined
911 .. py:data:: eSymbolTypeObjCClass
912 .. py:data:: eSymbolTypeObjCMetaClass
913 .. py:data:: eSymbolTypeObjCIVar
914 .. py:data:: eSymbolTypeReExported
922 .. py:data:: eSectionTypeInvalid
923 .. py:data:: eSectionTypeCode
924 .. py:data:: eSectionTypeContainer
925 .. py:data:: eSectionTypeData
926 .. py:data:: eSectionTypeDataCString
927 .. py:data:: eSectionTypeDataCStringPointers
928 .. py:data:: eSectionTypeDataSymbolAddress
929 .. py:data:: eSectionTypeData4
930 .. py:data:: eSectionTypeData8
931 .. py:data:: eSectionTypeData16
932 .. py:data:: eSectionTypeDataPointers
933 .. py:data:: eSectionTypeDebug
934 .. py:data:: eSectionTypeZeroFill
935 .. py:data:: eSectionTypeDataObjCMessageRefs
936 .. py:data:: eSectionTypeDataObjCCFStrings
937 .. py:data:: eSectionTypeDWARFDebugAbbrev
938 .. py:data:: eSectionTypeDWARFDebugAddr
939 .. py:data:: eSectionTypeDWARFDebugAranges
940 .. py:data:: eSectionTypeDWARFDebugCuIndex
941 .. py:data:: eSectionTypeDWARFDebugFrame
942 .. py:data:: eSectionTypeDWARFDebugInfo
943 .. py:data:: eSectionTypeDWARFDebugLine
944 .. py:data:: eSectionTypeDWARFDebugLoc
945 .. py:data:: eSectionTypeDWARFDebugMacInfo
946 .. py:data:: eSectionTypeDWARFDebugMacro
947 .. py:data:: eSectionTypeDWARFDebugPubNames
948 .. py:data:: eSectionTypeDWARFDebugPubTypes
949 .. py:data:: eSectionTypeDWARFDebugRanges
950 .. py:data:: eSectionTypeDWARFDebugStr
951 .. py:data:: eSectionTypeDWARFDebugStrOffsets
952 .. py:data:: eSectionTypeDWARFAppleNames
953 .. py:data:: eSectionTypeDWARFAppleTypes
954 .. py:data:: eSectionTypeDWARFAppleNamespaces
955 .. py:data:: eSectionTypeDWARFAppleObjC
956 .. py:data:: eSectionTypeELFSymbolTable
957 .. py:data:: eSectionTypeELFDynamicSymbols
958 .. py:data:: eSectionTypeELFRelocationEntries
959 .. py:data:: eSectionTypeELFDynamicLinkInfo
960 .. py:data:: eSectionTypeEHFrame
961 .. py:data:: eSectionTypeARMexidx
962 .. py:data:: eSectionTypeARMextab
963 .. py:data:: eSectionTypeCompactUnwind
964 .. py:data:: eSectionTypeGoSymtab
965 .. py:data:: eSectionTypeAbsoluteAddress
966 .. py:data:: eSectionTypeDWARFGNUDebugAltLink
967 .. py:data:: eSectionTypeDWARFDebugTypes
968 .. py:data:: eSectionTypeDWARFDebugNames
969 .. py:data:: eSectionTypeOther
970 .. py:data:: eSectionTypeDWARFDebugLineStr
971 .. py:data:: eSectionTypeDWARFDebugRngLists
972 .. py:data:: eSectionTypeDWARFDebugLocLists
973 .. py:data:: eSectionTypeDWARFDebugAbbrevDwo
974 .. py:data:: eSectionTypeDWARFDebugInfoDwo
975 .. py:data:: eSectionTypeDWARFDebugStrDwo
976 .. py:data:: eSectionTypeDWARFDebugStrOffsetsDwo
977 .. py:data:: eSectionTypeDWARFDebugTypesDwo
978 .. py:data:: eSectionTypeDWARFDebugRngListsDwo
979 .. py:data:: eSectionTypeDWARFDebugLocDwo
980 .. py:data:: eSectionTypeDWARFDebugLocListsDwo
981 .. py:data:: eSectionTypeDWARFDebugTuIndex
984 .. _EmulatorInstructionOption:
986 EmulatorInstructionOption
987 -------------------------
989 .. py:data:: eEmulateInstructionOptionNone
990 .. py:data:: eEmulateInstructionOptionAutoAdvancePC
991 .. py:data:: eEmulateInstructionOptionIgnoreConditions
994 .. _FunctionNameType:
999 .. py:data:: eFunctionNameTypeNone
1000 .. py:data:: eFunctionNameTypeAuto
1001 .. py:data:: eFunctionNameTypeFull
1002 .. py:data:: eFunctionNameTypeBase
1003 .. py:data:: eFunctionNameTypeMethod
1004 .. py:data:: eFunctionNameTypeSelector
1005 .. py:data:: eFunctionNameTypeAny
1013 .. py:data:: eBasicTypeInvalid
1014 .. py:data:: eBasicTypeVoid
1015 .. py:data:: eBasicTypeChar
1016 .. py:data:: eBasicTypeSignedChar
1017 .. py:data:: eBasicTypeUnsignedChar
1018 .. py:data:: eBasicTypeWChar
1019 .. py:data:: eBasicTypeSignedWChar
1020 .. py:data:: eBasicTypeUnsignedWChar
1021 .. py:data:: eBasicTypeChar16
1022 .. py:data:: eBasicTypeChar32
1023 .. py:data:: eBasicTypeChar8
1024 .. py:data:: eBasicTypeShort
1025 .. py:data:: eBasicTypeUnsignedShort
1026 .. py:data:: eBasicTypeInt
1027 .. py:data:: eBasicTypeUnsignedInt
1028 .. py:data:: eBasicTypeLong
1029 .. py:data:: eBasicTypeUnsignedLong
1030 .. py:data:: eBasicTypeLongLong
1031 .. py:data:: eBasicTypeUnsignedLongLong
1032 .. py:data:: eBasicTypeInt128
1033 .. py:data:: eBasicTypeUnsignedInt128
1034 .. py:data:: eBasicTypeBool
1035 .. py:data:: eBasicTypeHalf
1036 .. py:data:: eBasicTypeFloat
1037 .. py:data:: eBasicTypeDouble
1038 .. py:data:: eBasicTypeLongDouble
1039 .. py:data:: eBasicTypeFloatComplex
1040 .. py:data:: eBasicTypeDoubleComplex
1041 .. py:data:: eBasicTypeLongDoubleComplex
1042 .. py:data:: eBasicTypeObjCID
1043 .. py:data:: eBasicTypeObjCClass
1044 .. py:data:: eBasicTypeObjCSel
1045 .. py:data:: eBasicTypeNullPtr
1046 .. py:data:: eBasicTypeOther
1054 .. py:data:: eTraceTypeNone
1055 .. py:data:: eTraceTypeProcessorTrace
1058 .. _StructuredDataType:
1063 .. py:data:: eStructuredDataTypeInvalid
1064 .. py:data:: eStructuredDataTypeNull
1065 .. py:data:: eStructuredDataTypeGeneric
1066 .. py:data:: eStructuredDataTypeArray
1067 .. py:data:: eStructuredDataTypeInteger
1068 .. py:data:: eStructuredDataTypeFloat
1069 .. py:data:: eStructuredDataTypeBoolean
1070 .. py:data:: eStructuredDataTypeString
1071 .. py:data:: eStructuredDataTypeDictionary
1079 .. py:data:: eTypeClassInvalid
1080 .. py:data:: eTypeClassArray
1081 .. py:data:: eTypeClassBlockPointer
1082 .. py:data:: eTypeClassBuiltin
1083 .. py:data:: eTypeClassClass
1084 .. py:data:: eTypeClassFloat
1085 .. py:data:: eTypeClassComplexInteger
1086 .. py:data:: eTypeClassComplexFloat
1087 .. py:data:: eTypeClassFunction
1088 .. py:data:: eTypeClassMemberPointer
1089 .. py:data:: eTypeClassObjCObject
1090 .. py:data:: eTypeClassObjCInterface
1091 .. py:data:: eTypeClassObjCObjectPointer
1092 .. py:data:: eTypeClassPointer
1093 .. py:data:: eTypeClassReference
1094 .. py:data:: eTypeClassStruct
1095 .. py:data:: eTypeClassTypedef
1096 .. py:data:: eTypeClassUnion
1097 .. py:data:: eTypeClassVector
1098 .. py:data:: eTypeClassOther
1099 .. py:data:: eTypeClassAny
1102 .. _TemplateArgument:
1107 .. py:data:: eTemplateArgumentKindNull
1108 .. py:data:: eTemplateArgumentKindType
1109 .. py:data:: eTemplateArgumentKindDeclaration
1110 .. py:data:: eTemplateArgumentKindIntegral
1111 .. py:data:: eTemplateArgumentKindTemplate
1112 .. py:data:: eTemplateArgumentKindTemplateExpansion
1113 .. py:data:: eTemplateArgumentKindExpression
1114 .. py:data:: eTemplateArgumentKindPack
1115 .. py:data:: eTemplateArgumentKindNullPtr
1116 .. py:data:: eTemplateArgumentKindUncommonValue
1124 Options that can be set for a formatter to alter its behavior. Not
1125 all of these are applicable to all formatter types.
1127 .. py:data:: eTypeOptionNone
1128 .. py:data:: eTypeOptionCascade
1129 .. py:data:: eTypeOptionSkipPointers
1130 .. py:data:: eTypeOptionSkipReferences
1131 .. py:data:: eTypeOptionHideChildren
1132 .. py:data:: eTypeOptionHideValue
1133 .. py:data:: eTypeOptionShowOneLiner
1134 .. py:data:: eTypeOptionHideNames
1135 .. py:data:: eTypeOptionNonCacheable
1136 .. py:data:: eTypeOptionHideEmptyAggregates
1137 .. py:data:: eTypeOptionFrontEndWantsDereference
1146 This is the return value for frame comparisons. If you are comparing frame
1147 A to frame B the following cases arise:
1149 1) When frame A pushes frame B (or a frame that ends up pushing
1150 B) A is Older than B.
1152 2) When frame A pushed frame B (or if frameA is on the stack
1153 but B is not) A is Younger than B.
1155 3) When frame A and frame B have the same StackID, they are
1158 4) When frame A and frame B have the same immediate parent
1159 frame, but are not equal, the comparison yields SameParent.
1161 5) If the two frames are on different threads or processes the
1162 comparison is Invalid.
1164 6) If for some reason we can't figure out what went on, we
1167 .. py:data:: eFrameCompareInvalid
1168 .. py:data:: eFrameCompareUnknown
1169 .. py:data:: eFrameCompareEqual
1170 .. py:data:: eFrameCompareSameParent
1171 .. py:data:: eFrameCompareYounger
1172 .. py:data:: eFrameCompareOlder
1175 .. _FilePermissions:
1180 .. py:data:: eFilePermissionsUserRead
1181 .. py:data:: eFilePermissionsUserWrite
1182 .. py:data:: eFilePermissionsUserExecute
1183 .. py:data:: eFilePermissionsGroupRead
1184 .. py:data:: eFilePermissionsGroupWrite
1185 .. py:data:: eFilePermissionsGroupExecute
1186 .. py:data:: eFilePermissionsWorldRead
1187 .. py:data:: eFilePermissionsWorldWrite
1188 .. py:data:: eFilePermissionsWorldExecute
1189 .. py:data:: eFilePermissionsUserRW
1190 .. py:data:: eFileFilePermissionsUserRX
1191 .. py:data:: eFilePermissionsUserRWX
1192 .. py:data:: eFilePermissionsGroupRW
1193 .. py:data:: eFilePermissionsGroupRX
1194 .. py:data:: eFilePermissionsGroupRWX
1195 .. py:data:: eFilePermissionsWorldRW
1196 .. py:data:: eFilePermissionsWorldRX
1197 .. py:data:: eFilePermissionsWorldRWX
1198 .. py:data:: eFilePermissionsEveryoneR
1199 .. py:data:: eFilePermissionsEveryoneW
1200 .. py:data:: eFilePermissionsEveryoneX
1201 .. py:data:: eFilePermissionsEveryoneRW
1202 .. py:data:: eFilePermissionsEveryoneRX
1203 .. py:data:: eFilePermissionsEveryoneRWX
1204 .. py:data:: eFilePermissionsFileDefault = eFilePermissionsUserRW,
1205 .. py:data:: eFilePermissionsDirectoryDefault
1212 .. py:data:: eQueueItemKindUnknown
1213 .. py:data:: eQueueItemKindFunction
1214 .. py:data:: eQueueItemKindBlock
1222 libdispatch aka Grand Central Dispatch (GCD) queues can be either
1223 serial (executing on one thread) or concurrent (executing on
1226 .. py:data:: eQueueKindUnknown
1227 .. py:data:: eQueueKindSerial
1228 .. py:data:: eQueueKindConcurrent
1231 .. _ExpressionEvaluationPhase:
1233 ExpressionEvaluationPhase
1234 -------------------------
1236 These are the cancellable stages of expression evaluation, passed
1237 to the expression evaluation callback, so that you can interrupt
1238 expression evaluation at the various points in its lifecycle.
1240 .. py:data:: eExpressionEvaluationParse
1241 .. py:data:: eExpressionEvaluationIRGen
1242 .. py:data:: eExpressionEvaluationExecution
1243 .. py:data:: eExpressionEvaluationComplete
1251 Indicates what types of events cause the watchpoint to fire. Used by Native
1252 -Protocol-related classes.
1254 .. py:data:: eWatchpointKindWrite
1255 .. py:data:: eWatchpointKindRead
1263 .. py:data:: eGdbSignalBadAccess
1264 .. py:data:: eGdbSignalBadInstruction
1265 .. py:data:: eGdbSignalArithmetic
1266 .. py:data:: eGdbSignalEmulation
1267 .. py:data:: eGdbSignalSoftware
1268 .. py:data:: eGdbSignalBreakpoint
1275 Used with `SBHostOS.GetLLDBPath` to find files that are
1276 related to LLDB on the current host machine. Most files are
1277 relative to LLDB or are in known locations.
1279 .. py:data:: ePathTypeLLDBShlibDir
1281 The directory where the lldb.so (unix) or LLDB mach-o file in
1282 LLDB.framework (MacOSX) exists.
1284 .. py:data:: ePathTypeSupportExecutableDir
1286 Find LLDB support executable directory (debugserver, etc).
1288 .. py:data:: ePathTypeHeaderDir
1290 Find LLDB header file directory.
1292 .. py:data:: ePathTypePythonDir
1294 Find Python modules (PYTHONPATH) directory.
1296 .. py:data:: ePathTypeLLDBSystemPlugins
1298 System plug-ins directory
1300 .. py:data:: ePathTypeLLDBUserPlugins
1302 User plug-ins directory
1304 .. py:data:: ePathTypeLLDBTempSystemDir
1306 The LLDB temp directory for this system that will be cleaned up on exit.
1308 .. py:data:: ePathTypeGlobalLLDBTempSystemDir
1310 The LLDB temp directory for this system, NOT cleaned up on a process
1313 .. py:data:: ePathTypeClangDir
1315 Find path to Clang builtin headers.
1318 .. _MemberFunctionKind:
1323 .. py:data:: eMemberFunctionKindUnknown
1324 .. py:data:: eMemberFunctionKindConstructor
1326 A function used to create instances.
1328 .. py:data:: eMemberFunctionKindDestructor
1330 A function used to tear down existing instances.
1332 .. py:data:: eMemberFunctionKindInstanceMethod
1334 A function that applies to a specific instance.
1336 .. py:data:: eMemberFunctionKindStaticMethod
1338 A function that applies to a type rather than any instance,
1346 .. py:data:: eTypeHasChildren
1347 .. py:data:: eTypeIsArray
1348 .. py:data:: eTypeIsBuiltIn
1349 .. py:data:: eTypeIsCPlusPlus
1350 .. py:data:: eTypeIsFuncPrototype
1351 .. py:data:: eTypeIsObjC
1352 .. py:data:: eTypeIsReference
1353 .. py:data:: eTypeIsTemplate
1354 .. py:data:: eTypeIsVector
1355 .. py:data:: eTypeIsInteger
1356 .. py:data:: eTypeIsComplex
1357 .. py:data:: eTypeInstanceIsPointer
1365 .. py:data:: eCommandRequiresTarget
1366 .. py:data:: eCommandRequiresProcess
1367 .. py:data:: eCommandRequiresThread
1368 .. py:data:: eCommandRequiresFrame
1369 .. py:data:: eCommandRequiresRegContext
1370 .. py:data:: eCommandTryTargetAPILock
1371 .. py:data:: eCommandProcessMustBeLaunched
1372 .. py:data:: eCommandProcessMustBePaused
1373 .. py:data:: eCommandProcessMustBeTraced
1381 Whether a summary should cap how much data it returns to users or not.
1383 .. py:data:: eTypeSummaryCapped
1384 .. py:data:: eTypeSummaryUncapped
1387 .. _CommandInterpreterResult:
1389 CommandInterpreterResult
1390 ------------------------
1392 The result from a command interpreter run.
1394 .. py:data:: eCommandInterpreterResultSuccess
1396 Command interpreter finished successfully.
1398 .. py:data:: eCommandInterpreterResultInferiorCrash
1400 Stopped because the corresponding option was set and the inferior
1403 .. py:data:: eCommandInterpreterResultCommandError
1405 Stopped because the corresponding option was set and a command returned
1408 .. py:data:: eCommandInterpreterResultQuitRequested
1410 Stopped because quit was requested.
1413 .. _WatchPointValueKind:
1418 The type of value that the watchpoint was created to monitor.
1420 .. py:data:: eWatchPointValueKindInvalid
1424 .. py:data:: eWatchPointValueKindVariable
1426 Watchpoint was created watching a variable
1428 .. py:data:: eWatchPointValueKindExpression
1430 Watchpoint was created watching the result of an expression that was
1431 evaluated at creation time.