[docs] Update HowToReleaseLLVM documentation.
[llvm-project.git] / lldb / docs / python_api_enums.rst
blob8fe2b7f3013068b919ef1e548f8476d035d1d1a9
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    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:
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:: eLanguageTypeExtRenderScript
735 .. py:data:: eNumLanguageTypes
738 .. _InstrumentationRuntimeType:
740 InstrumentationRuntimeType
741 --------------------------
743 .. py:data:: eInstrumentationRuntimeTypeAddressSanitizer
744 .. py:data:: eInstrumentationRuntimeTypeThreadSanitizer
745 .. py:data:: eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
746 .. py:data:: eInstrumentationRuntimeTypeMainThreadChecker
747 .. py:data:: eInstrumentationRuntimeTypeSwiftRuntimeReporting
748 .. py:data:: eNumInstrumentationRuntimeTypes
751 .. _DynamicValueType:
753 DynamicValueType
754 ----------------
756 .. py:data:: eNoDynamicValues
757 .. py:data:: eDynamicCanRunTarget
758 .. py:data:: eDynamicDontRunTarget
761 .. _StopShowColumn:
763 StopShowColumn
764 --------------
766 .. py:data:: eStopShowColumnAnsiOrCaret
767 .. py:data:: eStopShowColumnAnsi
768 .. py:data:: eStopShowColumnCaret
769 .. py:data:: eStopShowColumnNone
772 .. _AccessType:
774 AccessType
775 ----------
777 .. py:data:: eAccessNone
778 .. py:data:: eAccessPublic
779 .. py:data:: eAccessPrivate
780 .. py:data:: eAccessProtected
781 .. py:data:: eAccessPackage
784 .. _CommandArgumentType:
786 CommandArgumentType
787 -------------------
789 .. py:data:: eArgTypeAddress
790 .. py:data:: eArgTypeAddressOrExpression
791 .. py:data:: eArgTypeAliasName
792 .. py:data:: eArgTypeAliasOptions
793 .. py:data:: eArgTypeArchitecture
794 .. py:data:: eArgTypeBoolean
795 .. py:data:: eArgTypeBreakpointID
796 .. py:data:: eArgTypeBreakpointIDRange
797 .. py:data:: eArgTypeBreakpointName
798 .. py:data:: eArgTypeByteSize
799 .. py:data:: eArgTypeClassName
800 .. py:data:: eArgTypeCommandName
801 .. py:data:: eArgTypeCount
802 .. py:data:: eArgTypeDescriptionVerbosity
803 .. py:data:: eArgTypeDirectoryName
804 .. py:data:: eArgTypeDisassemblyFlavor
805 .. py:data:: eArgTypeEndAddress
806 .. py:data:: eArgTypeExpression
807 .. py:data:: eArgTypeExpressionPath
808 .. py:data:: eArgTypeExprFormat
809 .. py:data:: eArgTypeFileLineColumn
810 .. py:data:: eArgTypeFilename
811 .. py:data:: eArgTypeFormat
812 .. py:data:: eArgTypeFrameIndex
813 .. py:data:: eArgTypeFullName
814 .. py:data:: eArgTypeFunctionName
815 .. py:data:: eArgTypeFunctionOrSymbol
816 .. py:data:: eArgTypeGDBFormat
817 .. py:data:: eArgTypeHelpText
818 .. py:data:: eArgTypeIndex
819 .. py:data:: eArgTypeLanguage
820 .. py:data:: eArgTypeLineNum
821 .. py:data:: eArgTypeLogCategory
822 .. py:data:: eArgTypeLogChannel
823 .. py:data:: eArgTypeMethod
824 .. py:data:: eArgTypeName
825 .. py:data:: eArgTypeNewPathPrefix
826 .. py:data:: eArgTypeNumLines
827 .. py:data:: eArgTypeNumberPerLine
828 .. py:data:: eArgTypeOffset
829 .. py:data:: eArgTypeOldPathPrefix
830 .. py:data:: eArgTypeOneLiner
831 .. py:data:: eArgTypePath
832 .. py:data:: eArgTypePermissionsNumber
833 .. py:data:: eArgTypePermissionsString
834 .. py:data:: eArgTypePid
835 .. py:data:: eArgTypePlugin
836 .. py:data:: eArgTypeProcessName
837 .. py:data:: eArgTypePythonClass
838 .. py:data:: eArgTypePythonFunction
839 .. py:data:: eArgTypePythonScript
840 .. py:data:: eArgTypeQueueName
841 .. py:data:: eArgTypeRegisterName
842 .. py:data:: eArgTypeRegularExpression
843 .. py:data:: eArgTypeRunArgs
844 .. py:data:: eArgTypeRunMode
845 .. py:data:: eArgTypeScriptedCommandSynchronicity
846 .. py:data:: eArgTypeScriptLang
847 .. py:data:: eArgTypeSearchWord
848 .. py:data:: eArgTypeSelector
849 .. py:data:: eArgTypeSettingIndex
850 .. py:data:: eArgTypeSettingKey
851 .. py:data:: eArgTypeSettingPrefix
852 .. py:data:: eArgTypeSettingVariableName
853 .. py:data:: eArgTypeShlibName
854 .. py:data:: eArgTypeSourceFile
855 .. py:data:: eArgTypeSortOrder
856 .. py:data:: eArgTypeStartAddress
857 .. py:data:: eArgTypeSummaryString
858 .. py:data:: eArgTypeSymbol
859 .. py:data:: eArgTypeThreadID
860 .. py:data:: eArgTypeThreadIndex
861 .. py:data:: eArgTypeThreadName
862 .. py:data:: eArgTypeTypeName
863 .. py:data:: eArgTypeUnsignedInteger
864 .. py:data:: eArgTypeUnixSignal
865 .. py:data:: eArgTypeVarName
866 .. py:data:: eArgTypeValue
867 .. py:data:: eArgTypeWidth
868 .. py:data:: eArgTypeNone
869 .. py:data:: eArgTypePlatform
870 .. py:data:: eArgTypeWatchpointID
871 .. py:data:: eArgTypeWatchpointIDRange
872 .. py:data:: eArgTypeWatchType
873 .. py:data:: eArgRawInput
874 .. py:data:: eArgTypeCommand
875 .. py:data:: eArgTypeColumnNum
876 .. py:data:: eArgTypeModuleUUID
877 .. py:data:: eArgTypeLastArg
879 .. _SymbolType:
881 SymbolType
882 ----------
884 .. py:data:: eSymbolTypeAny
885 .. py:data:: eSymbolTypeInvalid
886 .. py:data:: eSymbolTypeAbsolute
887 .. py:data:: eSymbolTypeCode
888 .. py:data:: eSymbolTypeResolver
889 .. py:data:: eSymbolTypeData
890 .. py:data:: eSymbolTypeTrampoline
891 .. py:data:: eSymbolTypeRuntime
892 .. py:data:: eSymbolTypeException
893 .. py:data:: eSymbolTypeSourceFile
894 .. py:data:: eSymbolTypeHeaderFile
895 .. py:data:: eSymbolTypeObjectFile
896 .. py:data:: eSymbolTypeCommonBlock
897 .. py:data:: eSymbolTypeBlock
898 .. py:data:: eSymbolTypeLocal
899 .. py:data:: eSymbolTypeParam
900 .. py:data:: eSymbolTypeVariable
901 .. py:data:: eSymbolTypeVariableType
902 .. py:data:: eSymbolTypeLineEntry
903 .. py:data:: eSymbolTypeLineHeader
904 .. py:data:: eSymbolTypeScopeBegin
905 .. py:data:: eSymbolTypeScopeEnd
906 .. py:data:: eSymbolTypeAdditional
907 .. py:data:: eSymbolTypeCompiler
908 .. py:data:: eSymbolTypeInstrumentation
909 .. py:data:: eSymbolTypeUndefined
910 .. py:data:: eSymbolTypeObjCClass
911 .. py:data:: eSymbolTypeObjCMetaClass
912 .. py:data:: eSymbolTypeObjCIVar
913 .. py:data:: eSymbolTypeReExported
916 .. _SectionType:
918 SectionType
919 -----------
921 .. py:data:: eSectionTypeInvalid
922 .. py:data:: eSectionTypeCode
923 .. py:data:: eSectionTypeContainer
924 .. py:data:: eSectionTypeData
925 .. py:data:: eSectionTypeDataCString
926 .. py:data:: eSectionTypeDataCStringPointers
927 .. py:data:: eSectionTypeDataSymbolAddress
928 .. py:data:: eSectionTypeData4
929 .. py:data:: eSectionTypeData8
930 .. py:data:: eSectionTypeData16
931 .. py:data:: eSectionTypeDataPointers
932 .. py:data:: eSectionTypeDebug
933 .. py:data:: eSectionTypeZeroFill
934 .. py:data:: eSectionTypeDataObjCMessageRefs
935 .. py:data:: eSectionTypeDataObjCCFStrings
936 .. py:data:: eSectionTypeDWARFDebugAbbrev
937 .. py:data:: eSectionTypeDWARFDebugAddr
938 .. py:data:: eSectionTypeDWARFDebugAranges
939 .. py:data:: eSectionTypeDWARFDebugCuIndex
940 .. py:data:: eSectionTypeDWARFDebugFrame
941 .. py:data:: eSectionTypeDWARFDebugInfo
942 .. py:data:: eSectionTypeDWARFDebugLine
943 .. py:data:: eSectionTypeDWARFDebugLoc
944 .. py:data:: eSectionTypeDWARFDebugMacInfo
945 .. py:data:: eSectionTypeDWARFDebugMacro
946 .. py:data:: eSectionTypeDWARFDebugPubNames
947 .. py:data:: eSectionTypeDWARFDebugPubTypes
948 .. py:data:: eSectionTypeDWARFDebugRanges
949 .. py:data:: eSectionTypeDWARFDebugStr
950 .. py:data:: eSectionTypeDWARFDebugStrOffsets
951 .. py:data:: eSectionTypeDWARFAppleNames
952 .. py:data:: eSectionTypeDWARFAppleTypes
953 .. py:data:: eSectionTypeDWARFAppleNamespaces
954 .. py:data:: eSectionTypeDWARFAppleObjC
955 .. py:data:: eSectionTypeELFSymbolTable
956 .. py:data:: eSectionTypeELFDynamicSymbols
957 .. py:data:: eSectionTypeELFRelocationEntries
958 .. py:data:: eSectionTypeELFDynamicLinkInfo
959 .. py:data:: eSectionTypeEHFrame
960 .. py:data:: eSectionTypeARMexidx
961 .. py:data:: eSectionTypeARMextab
962 .. py:data:: eSectionTypeCompactUnwind
963 .. py:data:: eSectionTypeGoSymtab
964 .. py:data:: eSectionTypeAbsoluteAddress
965 .. py:data:: eSectionTypeDWARFGNUDebugAltLink
966 .. py:data:: eSectionTypeDWARFDebugTypes
967 .. py:data:: eSectionTypeDWARFDebugNames
968 .. py:data:: eSectionTypeOther
969 .. py:data:: eSectionTypeDWARFDebugLineStr
970 .. py:data:: eSectionTypeDWARFDebugRngLists
971 .. py:data:: eSectionTypeDWARFDebugLocLists
972 .. py:data:: eSectionTypeDWARFDebugAbbrevDwo
973 .. py:data:: eSectionTypeDWARFDebugInfoDwo
974 .. py:data:: eSectionTypeDWARFDebugStrDwo
975 .. py:data:: eSectionTypeDWARFDebugStrOffsetsDwo
976 .. py:data:: eSectionTypeDWARFDebugTypesDwo
977 .. py:data:: eSectionTypeDWARFDebugRngListsDwo
978 .. py:data:: eSectionTypeDWARFDebugLocDwo
979 .. py:data:: eSectionTypeDWARFDebugLocListsDwo
980 .. py:data:: eSectionTypeDWARFDebugTuIndex
983 .. _EmulatorInstructionOption:
985 EmulatorInstructionOption
986 -------------------------
988 .. py:data:: eEmulateInstructionOptionNone
989 .. py:data:: eEmulateInstructionOptionAutoAdvancePC
990 .. py:data:: eEmulateInstructionOptionIgnoreConditions
993 .. _FunctionNameType:
995 FunctionNameType
996 ----------------
998 .. py:data:: eFunctionNameTypeNone
999 .. py:data:: eFunctionNameTypeAuto
1000 .. py:data:: eFunctionNameTypeFull
1001 .. py:data:: eFunctionNameTypeBase
1002 .. py:data:: eFunctionNameTypeMethod
1003 .. py:data:: eFunctionNameTypeSelector
1004 .. py:data:: eFunctionNameTypeAny
1007 .. _BasicType:
1009 BasicType
1010 ---------
1012 .. py:data:: eBasicTypeInvalid
1013 .. py:data:: eBasicTypeVoid
1014 .. py:data:: eBasicTypeChar
1015 .. py:data:: eBasicTypeSignedChar
1016 .. py:data:: eBasicTypeUnsignedChar
1017 .. py:data:: eBasicTypeWChar
1018 .. py:data:: eBasicTypeSignedWChar
1019 .. py:data:: eBasicTypeUnsignedWChar
1020 .. py:data:: eBasicTypeChar16
1021 .. py:data:: eBasicTypeChar32
1022 .. py:data:: eBasicTypeChar8
1023 .. py:data:: eBasicTypeShort
1024 .. py:data:: eBasicTypeUnsignedShort
1025 .. py:data:: eBasicTypeInt
1026 .. py:data:: eBasicTypeUnsignedInt
1027 .. py:data:: eBasicTypeLong
1028 .. py:data:: eBasicTypeUnsignedLong
1029 .. py:data:: eBasicTypeLongLong
1030 .. py:data:: eBasicTypeUnsignedLongLong
1031 .. py:data:: eBasicTypeInt128
1032 .. py:data:: eBasicTypeUnsignedInt128
1033 .. py:data:: eBasicTypeBool
1034 .. py:data:: eBasicTypeHalf
1035 .. py:data:: eBasicTypeFloat
1036 .. py:data:: eBasicTypeDouble
1037 .. py:data:: eBasicTypeLongDouble
1038 .. py:data:: eBasicTypeFloatComplex
1039 .. py:data:: eBasicTypeDoubleComplex
1040 .. py:data:: eBasicTypeLongDoubleComplex
1041 .. py:data:: eBasicTypeObjCID
1042 .. py:data:: eBasicTypeObjCClass
1043 .. py:data:: eBasicTypeObjCSel
1044 .. py:data:: eBasicTypeNullPtr
1045 .. py:data:: eBasicTypeOther
1048 .. _TraceType:
1050 TraceType
1051 ---------
1053 .. py:data:: eTraceTypeNone
1054 .. py:data:: eTraceTypeProcessorTrace
1057 .. _StructuredDataType:
1059 StructuredDataType
1060 ------------------
1062 .. py:data:: eStructuredDataTypeInvalid
1063 .. py:data:: eStructuredDataTypeNull
1064 .. py:data:: eStructuredDataTypeGeneric
1065 .. py:data:: eStructuredDataTypeArray
1066 .. py:data:: eStructuredDataTypeInteger
1067 .. py:data:: eStructuredDataTypeFloat
1068 .. py:data:: eStructuredDataTypeBoolean
1069 .. py:data:: eStructuredDataTypeString
1070 .. py:data:: eStructuredDataTypeDictionary
1073 .. _TypeClass:
1075 TypeClass
1076 ---------
1078 .. py:data:: eTypeClassInvalid
1079 .. py:data:: eTypeClassArray
1080 .. py:data:: eTypeClassBlockPointer
1081 .. py:data:: eTypeClassBuiltin
1082 .. py:data:: eTypeClassClass
1083 .. py:data:: eTypeClassFloat
1084 .. py:data:: eTypeClassComplexInteger
1085 .. py:data:: eTypeClassComplexFloat
1086 .. py:data:: eTypeClassFunction
1087 .. py:data:: eTypeClassMemberPointer
1088 .. py:data:: eTypeClassObjCObject
1089 .. py:data:: eTypeClassObjCInterface
1090 .. py:data:: eTypeClassObjCObjectPointer
1091 .. py:data:: eTypeClassPointer
1092 .. py:data:: eTypeClassReference
1093 .. py:data:: eTypeClassStruct
1094 .. py:data:: eTypeClassTypedef
1095 .. py:data:: eTypeClassUnion
1096 .. py:data:: eTypeClassVector
1097 .. py:data:: eTypeClassOther
1098 .. py:data:: eTypeClassAny
1101 .. _TemplateArgument:
1103 TemplateArgument
1104 ----------------
1106 .. py:data:: eTemplateArgumentKindNull
1107 .. py:data:: eTemplateArgumentKindType
1108 .. py:data:: eTemplateArgumentKindDeclaration
1109 .. py:data:: eTemplateArgumentKindIntegral
1110 .. py:data:: eTemplateArgumentKindTemplate
1111 .. py:data:: eTemplateArgumentKindTemplateExpansion
1112 .. py:data:: eTemplateArgumentKindExpression
1113 .. py:data:: eTemplateArgumentKindPack
1114 .. py:data:: eTemplateArgumentKindNullPtr
1115 .. py:data:: eTemplateArgumentKindUncommonValue
1118 .. _TypeOption:
1120 TypeOption
1121 ----------
1123 Options that can be set for a formatter to alter its behavior. Not
1124 all of these are applicable to all formatter types.
1126 .. py:data:: eTypeOptionNone
1127 .. py:data:: eTypeOptionCascade
1128 .. py:data:: eTypeOptionSkipPointers
1129 .. py:data:: eTypeOptionSkipReferences
1130 .. py:data:: eTypeOptionHideChildren
1131 .. py:data:: eTypeOptionHideValue
1132 .. py:data:: eTypeOptionShowOneLiner
1133 .. py:data:: eTypeOptionHideNames
1134 .. py:data:: eTypeOptionNonCacheable
1135 .. py:data:: eTypeOptionHideEmptyAggregates
1136 .. py:data:: eTypeOptionFrontEndWantsDereference
1140 .. _FrameCompare:
1142 FrameCompare
1143 ------------
1145 This is the return value for frame comparisons.  If you are comparing frame
1146 A to frame B the following cases arise:
1148    1) When frame A pushes frame B (or a frame that ends up pushing
1149       B) A is Older than B.
1151    2) When frame A pushed frame B (or if frameA is on the stack
1152       but B is not) A is Younger than B.
1154    3) When frame A and frame B have the same StackID, they are
1155       Equal.
1157    4) When frame A and frame B have the same immediate parent
1158       frame, but are not equal, the comparison yields SameParent.
1160    5) If the two frames are on different threads or processes the
1161       comparison is Invalid.
1163    6) If for some reason we can't figure out what went on, we
1164       return Unknown.
1166 .. py:data:: eFrameCompareInvalid
1167 .. py:data:: eFrameCompareUnknown
1168 .. py:data:: eFrameCompareEqual
1169 .. py:data:: eFrameCompareSameParent
1170 .. py:data:: eFrameCompareYounger
1171 .. py:data:: eFrameCompareOlder
1174 .. _FilePermissions:
1176 FilePermissions
1177 ---------------
1179 .. py:data:: eFilePermissionsUserRead
1180 .. py:data:: eFilePermissionsUserWrite
1181 .. py:data:: eFilePermissionsUserExecute
1182 .. py:data:: eFilePermissionsGroupRead
1183 .. py:data:: eFilePermissionsGroupWrite
1184 .. py:data:: eFilePermissionsGroupExecute
1185 .. py:data:: eFilePermissionsWorldRead
1186 .. py:data:: eFilePermissionsWorldWrite
1187 .. py:data:: eFilePermissionsWorldExecute
1188 .. py:data:: eFilePermissionsUserRW
1189 .. py:data:: eFileFilePermissionsUserRX
1190 .. py:data:: eFilePermissionsUserRWX
1191 .. py:data:: eFilePermissionsGroupRW
1192 .. py:data:: eFilePermissionsGroupRX
1193 .. py:data:: eFilePermissionsGroupRWX
1194 .. py:data:: eFilePermissionsWorldRW
1195 .. py:data:: eFilePermissionsWorldRX
1196 .. py:data:: eFilePermissionsWorldRWX
1197 .. py:data:: eFilePermissionsEveryoneR
1198 .. py:data:: eFilePermissionsEveryoneW
1199 .. py:data:: eFilePermissionsEveryoneX
1200 .. py:data:: eFilePermissionsEveryoneRW
1201 .. py:data:: eFilePermissionsEveryoneRX
1202 .. py:data:: eFilePermissionsEveryoneRWX
1203 .. py:data:: eFilePermissionsFileDefault = eFilePermissionsUserRW,
1204 .. py:data:: eFilePermissionsDirectoryDefault
1207 .. _QueueItem:
1209 QueueItem
1210 ---------
1211 .. py:data:: eQueueItemKindUnknown
1212 .. py:data:: eQueueItemKindFunction
1213 .. py:data:: eQueueItemKindBlock
1216 .. _QueueKind:
1218 QueueKind
1219 ---------
1221 libdispatch aka Grand Central Dispatch (GCD) queues can be either
1222 serial (executing on one thread) or concurrent (executing on
1223 multiple threads).
1225 .. py:data:: eQueueKindUnknown
1226 .. py:data:: eQueueKindSerial
1227 .. py:data:: eQueueKindConcurrent
1230 .. _ExpressionEvaluationPhase:
1232 ExpressionEvaluationPhase
1233 -------------------------
1235 These are the cancellable stages of expression evaluation, passed
1236 to the expression evaluation callback, so that you can interrupt
1237 expression evaluation at the various points in its lifecycle.
1239 .. py:data:: eExpressionEvaluationParse
1240 .. py:data:: eExpressionEvaluationIRGen
1241 .. py:data:: eExpressionEvaluationExecution
1242 .. py:data:: eExpressionEvaluationComplete
1245 .. _WatchpointKind:
1247 WatchpointKind
1248 --------------
1250 Indicates what types of events cause the watchpoint to fire. Used by Native
1251 -Protocol-related classes.
1253 .. py:data:: eWatchpointKindWrite
1254 .. py:data:: eWatchpointKindRead
1257 .. _GdbSignal:
1259 GdbSignal
1260 ---------
1262 .. py:data:: eGdbSignalBadAccess
1263 .. py:data:: eGdbSignalBadInstruction
1264 .. py:data:: eGdbSignalArithmetic
1265 .. py:data:: eGdbSignalEmulation
1266 .. py:data:: eGdbSignalSoftware
1267 .. py:data:: eGdbSignalBreakpoint
1269 .. _PathType:
1271 PathType
1272 --------
1274 Used with `SBHostOS.GetLLDBPath` to find files that are
1275 related to LLDB on the current host machine. Most files are
1276 relative to LLDB or are in known locations.
1278 .. py:data:: ePathTypeLLDBShlibDir
1280    The directory where the lldb.so (unix) or LLDB mach-o file in
1281    LLDB.framework (MacOSX) exists.
1283 .. py:data:: ePathTypeSupportExecutableDir
1285    Find LLDB support executable directory (debugserver, etc).
1287 .. py:data:: ePathTypeHeaderDir
1289    Find LLDB header file directory.
1291 .. py:data:: ePathTypePythonDir
1293    Find Python modules (PYTHONPATH) directory.
1295 .. py:data:: ePathTypeLLDBSystemPlugins
1297    System plug-ins directory
1299 .. py:data:: ePathTypeLLDBUserPlugins
1301    User plug-ins directory
1303 .. py:data:: ePathTypeLLDBTempSystemDir
1305    The LLDB temp directory for this system that will be cleaned up on exit.
1307 .. py:data:: ePathTypeGlobalLLDBTempSystemDir
1309    The LLDB temp directory for this system, NOT cleaned up on a process
1310    exit.
1312 .. py:data:: ePathTypeClangDir
1314    Find path to Clang builtin headers.
1317 .. _MemberFunctionKind:
1319 MemberFunctionKind
1320 ------------------
1322 .. py:data:: eMemberFunctionKindUnknown
1323 .. py:data:: eMemberFunctionKindConstructor
1325    A function used to create instances.
1327 .. py:data:: eMemberFunctionKindDestructor
1329    A function used to tear down existing instances.
1331 .. py:data:: eMemberFunctionKindInstanceMethod
1333    A function that applies to a specific instance.
1335 .. py:data:: eMemberFunctionKindStaticMethod
1337    A function that applies to a type rather than any instance,
1340 .. _TypeFlags:
1342 TypeFlags
1343 ---------
1345 .. py:data:: eTypeHasChildren
1346 .. py:data:: eTypeIsArray
1347 .. py:data:: eTypeIsBuiltIn
1348 .. py:data:: eTypeIsCPlusPlus
1349 .. py:data:: eTypeIsFuncPrototype
1350 .. py:data:: eTypeIsObjC
1351 .. py:data:: eTypeIsReference
1352 .. py:data:: eTypeIsTemplate
1353 .. py:data:: eTypeIsVector
1354 .. py:data:: eTypeIsInteger
1355 .. py:data:: eTypeIsComplex
1356 .. py:data:: eTypeInstanceIsPointer
1359 .. _CommandFlags:
1361 CommandFlags
1362 ---------------
1364 .. py:data:: eCommandRequiresTarget
1365 .. py:data:: eCommandRequiresProcess
1366 .. py:data:: eCommandRequiresThread
1367 .. py:data:: eCommandRequiresFrame
1368 .. py:data:: eCommandRequiresRegContext
1369 .. py:data:: eCommandTryTargetAPILock
1370 .. py:data:: eCommandProcessMustBeLaunched
1371 .. py:data:: eCommandProcessMustBePaused
1372 .. py:data:: eCommandProcessMustBeTraced
1375 .. _TypeSummary:
1377 TypeSummary
1378 -----------
1380 Whether a summary should cap how much data it returns to users or not.
1382 .. py:data:: eTypeSummaryCapped
1383 .. py:data:: eTypeSummaryUncapped
1386 .. _CommandInterpreterResult:
1388 CommandInterpreterResult
1389 ------------------------
1391 The result from a command interpreter run.
1393 .. py:data:: eCommandInterpreterResultSuccess
1395    Command interpreter finished successfully.
1397 .. py:data:: eCommandInterpreterResultInferiorCrash
1399    Stopped because the corresponding option was set and the inferior
1400    crashed.
1402 .. py:data:: eCommandInterpreterResultCommandError
1404    Stopped because the corresponding option was set and a command returned
1405    an error.
1407 .. py:data:: eCommandInterpreterResultQuitRequested
1409    Stopped because quit was requested.
1412 .. _WatchPointValueKind:
1414 WatchPointValueKind
1415 -------------------
1417 The type of value that the watchpoint was created to monitor.
1419 .. py:data:: eWatchPointValueKindInvalid
1421    Invalid kind.
1423 .. py:data:: eWatchPointValueKindVariable
1425    Watchpoint was created watching a variable
1427 .. py:data:: eWatchPointValueKindExpression
1429    Watchpoint was created watching the result of an expression that was
1430    evaluated at creation time.