[Driver] Remove ignored Flag form of -fauto-profile/-fprofile-sample-use
[llvm-project.git] / lldb / docs / python_api_enums.rst
blobb6a2497ea878e08b649f000ba78be3ac7c4760d3
1 ..
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.
5 :orphan:
7 Python API enumerators and constants
8 ====================================
10 .. py:currentmodule:: lldb
12 Constants
13 *********
15 Generic register numbers
16 ------------------------
18 .. py:data:: LLDB_REGNUM_GENERIC_PC
20    Program counter.
22 .. py:data:: LLDB_REGNUM_GENERIC_SP
24    Stack pointer.
25 .. py:data:: LLDB_REGNUM_GENERIC_FP
27    Frame pointer.
29 .. py:data:: LLDB_REGNUM_GENERIC_RA
31    Return address.
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
90 CPU types
91 ---------
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
125 Enumerators
126 ***********
129 .. _State:
131 State
132 -----
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
163    not be examined.
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.
184 .. _LaunchFlag:
186 LaunchFlag
187 ----------
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.
245 .. _RunMode:
247 RunMode
248 -------
249 .. py:data:: eOnlyThisThread
250 .. py:data:: eAllThreads
251 .. py:data:: eOnlyDuringStepping
254 .. _ByteOrder:
256 ByteOrder
257 ---------
259 .. py:data:: eByteOrderInvalid
260 .. py:data:: eByteOrderBig
261 .. py:data:: eByteOrderPDP
262 .. py:data:: eByteOrderLittle
265 .. _Encoding:
267 Encoding
268 --------
270 .. py:data:: eEncodingInvalid
271 .. py:data:: eEncodingUint
272 .. py:data:: eEncodingSint
273 .. py:data:: eEncodingIEEE754
274 .. py:data:: eEncodingVector
277 .. _Format:
279 Format
280 ------
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:
328 DescriptionLevel
329 ----------------
331 .. py:data:: eDescriptionLevelBrief
332 .. py:data:: eDescriptionLevelFull
333 .. py:data:: eDescriptionLevelVerbose
334 .. py:data:: eDescriptionLevelInitial
337 .. _ScriptLanguage:
339 ScriptLanguage
340 --------------
342 .. py:data:: eScriptLanguageNone
343 .. py:data:: eScriptLanguagePython
344 .. py:data:: eScriptLanguageLua
345 .. py:data:: eScriptLanguageUnknown
346 .. py:data:: eScriptLanguageDefault
349 .. _RegisterKind:
351 RegisterKind
352 ------------
354 .. py:data:: eRegisterKindEHFrame
355 .. py:data:: eRegisterKindDWARF
356 .. py:data:: eRegisterKindGeneric
357 .. py:data:: eRegisterKindProcessPlugin
358 .. py:data:: eRegisterKindLLDB
361 .. _StopReason:
363 StopReason
364 ----------
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
382 .. _ReturnStatus:
384 ReturnStatus
385 ------------
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
397 .. _Expression:
399 Expression
400 ----------
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
416 .. _SearchDepth:
418 SearchDepth
419 -----------
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:
432 ConnectionStatus
433 ----------------
435 .. py:data:: eConnectionStatusSuccess
437    Success.
439 .. py:data:: eConnectionStatusEndOfFile
441    End-of-file encountered.
443 .. py:data:: eConnectionStatusError
445    Error encountered.
447 .. py:data:: eConnectionStatusTimedOut
449    Request timed out.
451 .. py:data:: eConnectionStatusNoConnection
453    No connection.
455 .. py:data:: eConnectionStatusLostConnection
457    Lost connection while connected to a  valid connection.
459 .. py:data:: eConnectionStatusInterrupted
461    Interrupted read.
464 .. _ErrorType:
466 ErrorType
467 ---------
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
480    POSIX error codes.
482 .. py:data:: eErrorTypeExpression
484    These are from the ExpressionResults enum.
486 .. py:data:: eErrorTypeWin32
488    Standard Win32 error codes.
491 .. _ValueType:
493 ValueType
494 ---------
496 .. py:data:: eValueTypeInvalid
497 .. py:data:: eValueTypeVariableGlobal
499    Global variable.
501 .. py:data:: eValueTypeVariableStatic
503    Static variable.
505 .. py:data:: eValueTypeVariableArgument
507    Function 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:
546 SymbolContextItem
547 -----------------
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
561    in query results.
563 .. py:data:: eSymbolContextModule
565    Set when module is requested from a query, or was located
566    in query results.
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
576    in query results.
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
591    in query results
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.
608 .. _Permissions:
610 Permissions
611 -----------
612 .. py:data:: ePermissionsWritable
613 .. py:data:: ePermissionsReadable
614 .. py:data:: ePermissionsExecutable
617 .. _InputReader:
619 InputReader
620 -----------
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:
657 BreakpointEventType
658 -------------------
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:
677 WatchpointEventType
678 -------------------
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
692 .. _LanguageType:
694 LanguageType
695 ------------
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:
754 DynamicValueType
755 ----------------
757 .. py:data:: eNoDynamicValues
758 .. py:data:: eDynamicCanRunTarget
759 .. py:data:: eDynamicDontRunTarget
762 .. _StopShowColumn:
764 StopShowColumn
765 --------------
767 .. py:data:: eStopShowColumnAnsiOrCaret
768 .. py:data:: eStopShowColumnAnsi
769 .. py:data:: eStopShowColumnCaret
770 .. py:data:: eStopShowColumnNone
773 .. _AccessType:
775 AccessType
776 ----------
778 .. py:data:: eAccessNone
779 .. py:data:: eAccessPublic
780 .. py:data:: eAccessPrivate
781 .. py:data:: eAccessProtected
782 .. py:data:: eAccessPackage
785 .. _CommandArgumentType:
787 CommandArgumentType
788 -------------------
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
879 .. py:data:: eArgTypeCompletionType
881 .. _SymbolType:
883 SymbolType
884 ----------
886 .. py:data:: eSymbolTypeAny
887 .. py:data:: eSymbolTypeInvalid
888 .. py:data:: eSymbolTypeAbsolute
889 .. py:data:: eSymbolTypeCode
890 .. py:data:: eSymbolTypeResolver
891 .. py:data:: eSymbolTypeData
892 .. py:data:: eSymbolTypeTrampoline
893 .. py:data:: eSymbolTypeRuntime
894 .. py:data:: eSymbolTypeException
895 .. py:data:: eSymbolTypeSourceFile
896 .. py:data:: eSymbolTypeHeaderFile
897 .. py:data:: eSymbolTypeObjectFile
898 .. py:data:: eSymbolTypeCommonBlock
899 .. py:data:: eSymbolTypeBlock
900 .. py:data:: eSymbolTypeLocal
901 .. py:data:: eSymbolTypeParam
902 .. py:data:: eSymbolTypeVariable
903 .. py:data:: eSymbolTypeVariableType
904 .. py:data:: eSymbolTypeLineEntry
905 .. py:data:: eSymbolTypeLineHeader
906 .. py:data:: eSymbolTypeScopeBegin
907 .. py:data:: eSymbolTypeScopeEnd
908 .. py:data:: eSymbolTypeAdditional
909 .. py:data:: eSymbolTypeCompiler
910 .. py:data:: eSymbolTypeInstrumentation
911 .. py:data:: eSymbolTypeUndefined
912 .. py:data:: eSymbolTypeObjCClass
913 .. py:data:: eSymbolTypeObjCMetaClass
914 .. py:data:: eSymbolTypeObjCIVar
915 .. py:data:: eSymbolTypeReExported
918 .. _SectionType:
920 SectionType
921 -----------
923 .. py:data:: eSectionTypeInvalid
924 .. py:data:: eSectionTypeCode
925 .. py:data:: eSectionTypeContainer
926 .. py:data:: eSectionTypeData
927 .. py:data:: eSectionTypeDataCString
928 .. py:data:: eSectionTypeDataCStringPointers
929 .. py:data:: eSectionTypeDataSymbolAddress
930 .. py:data:: eSectionTypeData4
931 .. py:data:: eSectionTypeData8
932 .. py:data:: eSectionTypeData16
933 .. py:data:: eSectionTypeDataPointers
934 .. py:data:: eSectionTypeDebug
935 .. py:data:: eSectionTypeZeroFill
936 .. py:data:: eSectionTypeDataObjCMessageRefs
937 .. py:data:: eSectionTypeDataObjCCFStrings
938 .. py:data:: eSectionTypeDWARFDebugAbbrev
939 .. py:data:: eSectionTypeDWARFDebugAddr
940 .. py:data:: eSectionTypeDWARFDebugAranges
941 .. py:data:: eSectionTypeDWARFDebugCuIndex
942 .. py:data:: eSectionTypeDWARFDebugFrame
943 .. py:data:: eSectionTypeDWARFDebugInfo
944 .. py:data:: eSectionTypeDWARFDebugLine
945 .. py:data:: eSectionTypeDWARFDebugLoc
946 .. py:data:: eSectionTypeDWARFDebugMacInfo
947 .. py:data:: eSectionTypeDWARFDebugMacro
948 .. py:data:: eSectionTypeDWARFDebugPubNames
949 .. py:data:: eSectionTypeDWARFDebugPubTypes
950 .. py:data:: eSectionTypeDWARFDebugRanges
951 .. py:data:: eSectionTypeDWARFDebugStr
952 .. py:data:: eSectionTypeDWARFDebugStrOffsets
953 .. py:data:: eSectionTypeDWARFAppleNames
954 .. py:data:: eSectionTypeDWARFAppleTypes
955 .. py:data:: eSectionTypeDWARFAppleNamespaces
956 .. py:data:: eSectionTypeDWARFAppleObjC
957 .. py:data:: eSectionTypeELFSymbolTable
958 .. py:data:: eSectionTypeELFDynamicSymbols
959 .. py:data:: eSectionTypeELFRelocationEntries
960 .. py:data:: eSectionTypeELFDynamicLinkInfo
961 .. py:data:: eSectionTypeEHFrame
962 .. py:data:: eSectionTypeARMexidx
963 .. py:data:: eSectionTypeARMextab
964 .. py:data:: eSectionTypeCompactUnwind
965 .. py:data:: eSectionTypeGoSymtab
966 .. py:data:: eSectionTypeAbsoluteAddress
967 .. py:data:: eSectionTypeDWARFGNUDebugAltLink
968 .. py:data:: eSectionTypeDWARFDebugTypes
969 .. py:data:: eSectionTypeDWARFDebugNames
970 .. py:data:: eSectionTypeOther
971 .. py:data:: eSectionTypeDWARFDebugLineStr
972 .. py:data:: eSectionTypeDWARFDebugRngLists
973 .. py:data:: eSectionTypeDWARFDebugLocLists
974 .. py:data:: eSectionTypeDWARFDebugAbbrevDwo
975 .. py:data:: eSectionTypeDWARFDebugInfoDwo
976 .. py:data:: eSectionTypeDWARFDebugStrDwo
977 .. py:data:: eSectionTypeDWARFDebugStrOffsetsDwo
978 .. py:data:: eSectionTypeDWARFDebugTypesDwo
979 .. py:data:: eSectionTypeDWARFDebugRngListsDwo
980 .. py:data:: eSectionTypeDWARFDebugLocDwo
981 .. py:data:: eSectionTypeDWARFDebugLocListsDwo
982 .. py:data:: eSectionTypeDWARFDebugTuIndex
985 .. _EmulatorInstructionOption:
987 EmulatorInstructionOption
988 -------------------------
990 .. py:data:: eEmulateInstructionOptionNone
991 .. py:data:: eEmulateInstructionOptionAutoAdvancePC
992 .. py:data:: eEmulateInstructionOptionIgnoreConditions
995 .. _FunctionNameType:
997 FunctionNameType
998 ----------------
1000 .. py:data:: eFunctionNameTypeNone
1001 .. py:data:: eFunctionNameTypeAuto
1002 .. py:data:: eFunctionNameTypeFull
1003 .. py:data:: eFunctionNameTypeBase
1004 .. py:data:: eFunctionNameTypeMethod
1005 .. py:data:: eFunctionNameTypeSelector
1006 .. py:data:: eFunctionNameTypeAny
1009 .. _BasicType:
1011 BasicType
1012 ---------
1014 .. py:data:: eBasicTypeInvalid
1015 .. py:data:: eBasicTypeVoid
1016 .. py:data:: eBasicTypeChar
1017 .. py:data:: eBasicTypeSignedChar
1018 .. py:data:: eBasicTypeUnsignedChar
1019 .. py:data:: eBasicTypeWChar
1020 .. py:data:: eBasicTypeSignedWChar
1021 .. py:data:: eBasicTypeUnsignedWChar
1022 .. py:data:: eBasicTypeChar16
1023 .. py:data:: eBasicTypeChar32
1024 .. py:data:: eBasicTypeChar8
1025 .. py:data:: eBasicTypeShort
1026 .. py:data:: eBasicTypeUnsignedShort
1027 .. py:data:: eBasicTypeInt
1028 .. py:data:: eBasicTypeUnsignedInt
1029 .. py:data:: eBasicTypeLong
1030 .. py:data:: eBasicTypeUnsignedLong
1031 .. py:data:: eBasicTypeLongLong
1032 .. py:data:: eBasicTypeUnsignedLongLong
1033 .. py:data:: eBasicTypeInt128
1034 .. py:data:: eBasicTypeUnsignedInt128
1035 .. py:data:: eBasicTypeBool
1036 .. py:data:: eBasicTypeHalf
1037 .. py:data:: eBasicTypeFloat
1038 .. py:data:: eBasicTypeDouble
1039 .. py:data:: eBasicTypeLongDouble
1040 .. py:data:: eBasicTypeFloatComplex
1041 .. py:data:: eBasicTypeDoubleComplex
1042 .. py:data:: eBasicTypeLongDoubleComplex
1043 .. py:data:: eBasicTypeObjCID
1044 .. py:data:: eBasicTypeObjCClass
1045 .. py:data:: eBasicTypeObjCSel
1046 .. py:data:: eBasicTypeNullPtr
1047 .. py:data:: eBasicTypeOther
1050 .. _TraceType:
1052 TraceType
1053 ---------
1055 .. py:data:: eTraceTypeNone
1056 .. py:data:: eTraceTypeProcessorTrace
1059 .. _StructuredDataType:
1061 StructuredDataType
1062 ------------------
1064 .. py:data:: eStructuredDataTypeInvalid
1065 .. py:data:: eStructuredDataTypeNull
1066 .. py:data:: eStructuredDataTypeGeneric
1067 .. py:data:: eStructuredDataTypeArray
1068 .. py:data:: eStructuredDataTypeInteger
1069 .. py:data:: eStructuredDataTypeFloat
1070 .. py:data:: eStructuredDataTypeBoolean
1071 .. py:data:: eStructuredDataTypeString
1072 .. py:data:: eStructuredDataTypeDictionary
1075 .. _TypeClass:
1077 TypeClass
1078 ---------
1080 .. py:data:: eTypeClassInvalid
1081 .. py:data:: eTypeClassArray
1082 .. py:data:: eTypeClassBlockPointer
1083 .. py:data:: eTypeClassBuiltin
1084 .. py:data:: eTypeClassClass
1085 .. py:data:: eTypeClassFloat
1086 .. py:data:: eTypeClassComplexInteger
1087 .. py:data:: eTypeClassComplexFloat
1088 .. py:data:: eTypeClassFunction
1089 .. py:data:: eTypeClassMemberPointer
1090 .. py:data:: eTypeClassObjCObject
1091 .. py:data:: eTypeClassObjCInterface
1092 .. py:data:: eTypeClassObjCObjectPointer
1093 .. py:data:: eTypeClassPointer
1094 .. py:data:: eTypeClassReference
1095 .. py:data:: eTypeClassStruct
1096 .. py:data:: eTypeClassTypedef
1097 .. py:data:: eTypeClassUnion
1098 .. py:data:: eTypeClassVector
1099 .. py:data:: eTypeClassOther
1100 .. py:data:: eTypeClassAny
1103 .. _TemplateArgument:
1105 TemplateArgument
1106 ----------------
1108 .. py:data:: eTemplateArgumentKindNull
1109 .. py:data:: eTemplateArgumentKindType
1110 .. py:data:: eTemplateArgumentKindDeclaration
1111 .. py:data:: eTemplateArgumentKindIntegral
1112 .. py:data:: eTemplateArgumentKindTemplate
1113 .. py:data:: eTemplateArgumentKindTemplateExpansion
1114 .. py:data:: eTemplateArgumentKindExpression
1115 .. py:data:: eTemplateArgumentKindPack
1116 .. py:data:: eTemplateArgumentKindNullPtr
1117 .. py:data:: eTemplateArgumentKindUncommonValue
1120 .. _TypeOption:
1122 TypeOption
1123 ----------
1125 Options that can be set for a formatter to alter its behavior. Not
1126 all of these are applicable to all formatter types.
1128 .. py:data:: eTypeOptionNone
1129 .. py:data:: eTypeOptionCascade
1130 .. py:data:: eTypeOptionSkipPointers
1131 .. py:data:: eTypeOptionSkipReferences
1132 .. py:data:: eTypeOptionHideChildren
1133 .. py:data:: eTypeOptionHideValue
1134 .. py:data:: eTypeOptionShowOneLiner
1135 .. py:data:: eTypeOptionHideNames
1136 .. py:data:: eTypeOptionNonCacheable
1137 .. py:data:: eTypeOptionHideEmptyAggregates
1138 .. py:data:: eTypeOptionFrontEndWantsDereference
1142 .. _FrameCompare:
1144 FrameCompare
1145 ------------
1147 This is the return value for frame comparisons.  If you are comparing frame
1148 A to frame B the following cases arise:
1150    1) When frame A pushes frame B (or a frame that ends up pushing
1151       B) A is Older than B.
1153    2) When frame A pushed frame B (or if frameA is on the stack
1154       but B is not) A is Younger than B.
1156    3) When frame A and frame B have the same StackID, they are
1157       Equal.
1159    4) When frame A and frame B have the same immediate parent
1160       frame, but are not equal, the comparison yields SameParent.
1162    5) If the two frames are on different threads or processes the
1163       comparison is Invalid.
1165    6) If for some reason we can't figure out what went on, we
1166       return Unknown.
1168 .. py:data:: eFrameCompareInvalid
1169 .. py:data:: eFrameCompareUnknown
1170 .. py:data:: eFrameCompareEqual
1171 .. py:data:: eFrameCompareSameParent
1172 .. py:data:: eFrameCompareYounger
1173 .. py:data:: eFrameCompareOlder
1176 .. _FilePermissions:
1178 FilePermissions
1179 ---------------
1181 .. py:data:: eFilePermissionsUserRead
1182 .. py:data:: eFilePermissionsUserWrite
1183 .. py:data:: eFilePermissionsUserExecute
1184 .. py:data:: eFilePermissionsGroupRead
1185 .. py:data:: eFilePermissionsGroupWrite
1186 .. py:data:: eFilePermissionsGroupExecute
1187 .. py:data:: eFilePermissionsWorldRead
1188 .. py:data:: eFilePermissionsWorldWrite
1189 .. py:data:: eFilePermissionsWorldExecute
1190 .. py:data:: eFilePermissionsUserRW
1191 .. py:data:: eFileFilePermissionsUserRX
1192 .. py:data:: eFilePermissionsUserRWX
1193 .. py:data:: eFilePermissionsGroupRW
1194 .. py:data:: eFilePermissionsGroupRX
1195 .. py:data:: eFilePermissionsGroupRWX
1196 .. py:data:: eFilePermissionsWorldRW
1197 .. py:data:: eFilePermissionsWorldRX
1198 .. py:data:: eFilePermissionsWorldRWX
1199 .. py:data:: eFilePermissionsEveryoneR
1200 .. py:data:: eFilePermissionsEveryoneW
1201 .. py:data:: eFilePermissionsEveryoneX
1202 .. py:data:: eFilePermissionsEveryoneRW
1203 .. py:data:: eFilePermissionsEveryoneRX
1204 .. py:data:: eFilePermissionsEveryoneRWX
1205 .. py:data:: eFilePermissionsFileDefault = eFilePermissionsUserRW,
1206 .. py:data:: eFilePermissionsDirectoryDefault
1209 .. _QueueItem:
1211 QueueItem
1212 ---------
1213 .. py:data:: eQueueItemKindUnknown
1214 .. py:data:: eQueueItemKindFunction
1215 .. py:data:: eQueueItemKindBlock
1218 .. _QueueKind:
1220 QueueKind
1221 ---------
1223 libdispatch aka Grand Central Dispatch (GCD) queues can be either
1224 serial (executing on one thread) or concurrent (executing on
1225 multiple threads).
1227 .. py:data:: eQueueKindUnknown
1228 .. py:data:: eQueueKindSerial
1229 .. py:data:: eQueueKindConcurrent
1232 .. _ExpressionEvaluationPhase:
1234 ExpressionEvaluationPhase
1235 -------------------------
1237 These are the cancellable stages of expression evaluation, passed
1238 to the expression evaluation callback, so that you can interrupt
1239 expression evaluation at the various points in its lifecycle.
1241 .. py:data:: eExpressionEvaluationParse
1242 .. py:data:: eExpressionEvaluationIRGen
1243 .. py:data:: eExpressionEvaluationExecution
1244 .. py:data:: eExpressionEvaluationComplete
1247 .. _WatchpointKind:
1249 WatchpointKind
1250 --------------
1252 Indicates what types of events cause the watchpoint to fire. Used by Native
1253 -Protocol-related classes.
1255 .. py:data:: eWatchpointKindWrite
1256 .. py:data:: eWatchpointKindRead
1259 .. _GdbSignal:
1261 GdbSignal
1262 ---------
1264 .. py:data:: eGdbSignalBadAccess
1265 .. py:data:: eGdbSignalBadInstruction
1266 .. py:data:: eGdbSignalArithmetic
1267 .. py:data:: eGdbSignalEmulation
1268 .. py:data:: eGdbSignalSoftware
1269 .. py:data:: eGdbSignalBreakpoint
1271 .. _PathType:
1273 PathType
1274 --------
1276 Used with `SBHostOS.GetLLDBPath` to find files that are
1277 related to LLDB on the current host machine. Most files are
1278 relative to LLDB or are in known locations.
1280 .. py:data:: ePathTypeLLDBShlibDir
1282    The directory where the lldb.so (unix) or LLDB mach-o file in
1283    LLDB.framework (MacOSX) exists.
1285 .. py:data:: ePathTypeSupportExecutableDir
1287    Find LLDB support executable directory (debugserver, etc).
1289 .. py:data:: ePathTypeHeaderDir
1291    Find LLDB header file directory.
1293 .. py:data:: ePathTypePythonDir
1295    Find Python modules (PYTHONPATH) directory.
1297 .. py:data:: ePathTypeLLDBSystemPlugins
1299    System plug-ins directory
1301 .. py:data:: ePathTypeLLDBUserPlugins
1303    User plug-ins directory
1305 .. py:data:: ePathTypeLLDBTempSystemDir
1307    The LLDB temp directory for this system that will be cleaned up on exit.
1309 .. py:data:: ePathTypeGlobalLLDBTempSystemDir
1311    The LLDB temp directory for this system, NOT cleaned up on a process
1312    exit.
1314 .. py:data:: ePathTypeClangDir
1316    Find path to Clang builtin headers.
1319 .. _MemberFunctionKind:
1321 MemberFunctionKind
1322 ------------------
1324 .. py:data:: eMemberFunctionKindUnknown
1325 .. py:data:: eMemberFunctionKindConstructor
1327    A function used to create instances.
1329 .. py:data:: eMemberFunctionKindDestructor
1331    A function used to tear down existing instances.
1333 .. py:data:: eMemberFunctionKindInstanceMethod
1335    A function that applies to a specific instance.
1337 .. py:data:: eMemberFunctionKindStaticMethod
1339    A function that applies to a type rather than any instance,
1342 .. _TypeFlags:
1344 TypeFlags
1345 ---------
1347 .. py:data:: eTypeHasChildren
1348 .. py:data:: eTypeIsArray
1349 .. py:data:: eTypeIsBuiltIn
1350 .. py:data:: eTypeIsCPlusPlus
1351 .. py:data:: eTypeIsFuncPrototype
1352 .. py:data:: eTypeIsObjC
1353 .. py:data:: eTypeIsReference
1354 .. py:data:: eTypeIsTemplate
1355 .. py:data:: eTypeIsVector
1356 .. py:data:: eTypeIsInteger
1357 .. py:data:: eTypeIsComplex
1358 .. py:data:: eTypeInstanceIsPointer
1361 .. _CommandFlags:
1363 CommandFlags
1364 ---------------
1366 .. py:data:: eCommandRequiresTarget
1367 .. py:data:: eCommandRequiresProcess
1368 .. py:data:: eCommandRequiresThread
1369 .. py:data:: eCommandRequiresFrame
1370 .. py:data:: eCommandRequiresRegContext
1371 .. py:data:: eCommandTryTargetAPILock
1372 .. py:data:: eCommandProcessMustBeLaunched
1373 .. py:data:: eCommandProcessMustBePaused
1374 .. py:data:: eCommandProcessMustBeTraced
1377 .. _TypeSummary:
1379 TypeSummary
1380 -----------
1382 Whether a summary should cap how much data it returns to users or not.
1384 .. py:data:: eTypeSummaryCapped
1385 .. py:data:: eTypeSummaryUncapped
1388 .. _CommandInterpreterResult:
1390 CommandInterpreterResult
1391 ------------------------
1393 The result from a command interpreter run.
1395 .. py:data:: eCommandInterpreterResultSuccess
1397    Command interpreter finished successfully.
1399 .. py:data:: eCommandInterpreterResultInferiorCrash
1401    Stopped because the corresponding option was set and the inferior
1402    crashed.
1404 .. py:data:: eCommandInterpreterResultCommandError
1406    Stopped because the corresponding option was set and a command returned
1407    an error.
1409 .. py:data:: eCommandInterpreterResultQuitRequested
1411    Stopped because quit was requested.
1414 .. _WatchPointValueKind:
1416 WatchPointValueKind
1417 -------------------
1419 The type of value that the watchpoint was created to monitor.
1421 .. py:data:: eWatchPointValueKindInvalid
1423    Invalid kind.
1425 .. py:data:: eWatchPointValueKindVariable
1427    Watchpoint was created watching a variable
1429 .. py:data:: eWatchPointValueKindExpression
1431    Watchpoint was created watching the result of an expression that was
1432    evaluated at creation time.