[RISCV] Add addu.w and slliu.w test that uses getelementptr with zero extended indices.
[lldb.git] / lldb / docs / python_api_enums.rst
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.
4
5 :orphan:
6
7 Python API enumerators and constants
8 ====================================
9
10 .. py:currentmodule:: lldb
11
12 Constants
13 *********
14
15 Generic register numbers
16 ------------------------
17
18 .. py:data:: LLDB_REGNUM_GENERIC_PC
19
20    Program counter.
21
22 .. py:data:: LLDB_REGNUM_GENERIC_SP
23
24    Stack pointer.
25 .. py:data:: LLDB_REGNUM_GENERIC_FP
26
27    Frame pointer.
28
29 .. py:data:: LLDB_REGNUM_GENERIC_RA
30
31    Return address.
32
33 .. py:data:: LLDB_REGNUM_GENERIC_FLAGS
34
35    Processor flags register.
36
37 .. py:data:: LLDB_REGNUM_GENERIC_ARG1
38
39    The register that would contain pointer size or less argument 1 (if any).
40
41 .. py:data:: LLDB_REGNUM_GENERIC_ARG2
42
43    The register that would contain pointer size or less argument 2 (if any).
44
45 .. py:data:: LLDB_REGNUM_GENERIC_ARG3
46
47    The register that would contain pointer size or less argument 3 (if any).
48
49 .. py:data:: LLDB_REGNUM_GENERIC_ARG4
50
51    The register that would contain pointer size or less argument 4 (if any).
52
53 .. py:data:: LLDB_REGNUM_GENERIC_ARG5
54
55    The register that would contain pointer size or less argument 5 (if any).
56
57 .. py:data:: LLDB_REGNUM_GENERIC_ARG6
58
59    The register that would contain pointer size or less argument 6 (if any).
60
61 .. py:data:: LLDB_REGNUM_GENERIC_ARG7
62
63    The register that would contain pointer size or less argument 7 (if any).
64
65 .. py:data:: LLDB_REGNUM_GENERIC_ARG8
66
67    The register that would contain pointer size or less argument 8 (if any).
68
69
70 Invalid value definitions
71 -------------------------
72
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
89
90 CPU types
91 ---------
92
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
97
98
99 Option set definitions
100 ----------------------
101
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
115
116 Miscellaneous constants
117 ------------------------
118
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
123
124
125 Enumerators
126 ***********
127
128 State
129 -----
130
131 .. py:data:: eStateInvalid
132 .. py:data:: eStateUnloaded
133
134    Process is object is valid, but not currently loaded.
135
136 .. py:data:: eStateConnected
137
138    Process is connected to remote debug services, but not
139    launched or attached to anything yet.
140
141 .. py:data:: eStateAttaching
142
143    Process is in the process of launching.
144
145 .. py:data:: eStateLaunching
146
147    Process is in the process of launching.
148
149 .. py:data:: eStateStopped
150
151    Process or thread is stopped and can be examined.
152
153 .. py:data:: eStateRunning
154
155    Process or thread is running and can't be examined.
156
157 .. py:data:: eStateStepping
158
159    Process or thread is in the process of stepping and can
160    not be examined.
161
162 .. py:data:: eStateCrashed
163
164    Process or thread has crashed and can be examined.
165
166 .. py:data:: eStateDetached
167
168    Process has been detached and can't be examined.
169
170 .. py:data:: eStateExited
171
172    Process has exited and can't be examined.
173
174 .. py:data:: eStateSuspended
175
176    Process or thread is in a suspended state as far
177    as the debugger is concerned while other processes
178    or threads get the chance to run.
179
180 LaunchFlag
181 ----------
182
183 .. py:data:: eLaunchFlagNone
184 .. py:data:: eLaunchFlagExec
185
186    Exec when launching and turn the calling process into a new process.
187
188 .. py:data:: eLaunchFlagDebug
189
190    Stop as soon as the process launches to allow the process to be debugged.
191
192 .. py:data:: eLaunchFlagStopAtEntry
193
194    Stop at the program entry point instead of auto-continuing when launching or attaching at entry point.
195
196 .. py:data:: eLaunchFlagDisableASLR
197
198    Disable Address Space Layout Randomization.
199
200 .. py:data:: eLaunchFlagDisableSTDIO
201
202    Disable stdio for inferior process (e.g. for a GUI app).
203
204 .. py:data:: eLaunchFlagLaunchInTTY
205
206    Launch the process in a new TTY if supported by the host.
207
208 .. py:data:: eLaunchFlagLaunchInShell
209
210    Launch the process inside a shell to get shell expansion.
211
212 .. py:data:: eLaunchFlagLaunchInSeparateProcessGroup
213
214    Launch the process in a separate process group if you are going to hand the process off (e.g. to debugserver)
215
216 .. py:data:: eLaunchFlagDontSetExitStatus
217
218    set this flag so lldb & the handee don't race to set its exit status.
219
220 .. py:data:: eLaunchFlagDetachOnError
221
222    If set, then the client stub should detach rather than killing  the debugee
223    if it loses connection with lldb.
224
225 .. py:data:: eLaunchFlagShellExpandArguments
226
227    Perform shell-style argument expansion
228
229 .. py:data:: eLaunchFlagCloseTTYOnExit
230
231    Close the open TTY on exit
232
233 .. py:data:: eLaunchFlagInheritTCCFromParent
234
235    Don't make the inferior responsible for its own TCC
236    permissions but instead inherit them from its parent.
237
238 RunMode
239 -------
240 .. py:data:: eOnlyThisThread
241 .. py:data:: eAllThreads
242 .. py:data:: eOnlyDuringStepping
243
244
245 ByteOrder
246 ---------
247
248 .. py:data:: eByteOrderInvalid
249 .. py:data:: eByteOrderBig
250 .. py:data:: eByteOrderPDP
251 .. py:data:: eByteOrderLittle
252
253 Encoding
254 --------
255
256 .. py:data:: eEncodingInvalid
257 .. py:data:: eEncodingUint
258 .. py:data:: eEncodingSint
259 .. py:data:: eEncodingIEEE754
260 .. py:data:: eEncodingVector
261
262 Format
263 ------
264
265 .. py:data:: eFormatDefault
266 .. py:data:: eFormatInvalid
267 .. py:data:: eFormatBoolean
268 .. py:data:: eFormatBinary
269 .. py:data:: eFormatBytes
270 .. py:data:: eFormatBytesWithASCII
271 .. py:data:: eFormatChar
272 .. py:data:: eFormatCharPrintable
273 .. py:data:: eFormatComplex
274 .. py:data:: eFormatComplexFloat
275 .. py:data:: eFormatCString
276 .. py:data:: eFormatDecimal
277 .. py:data:: eFormatEnum
278 .. py:data:: eFormatHex
279 .. py:data:: eFormatHexUppercase
280 .. py:data:: eFormatFloat
281 .. py:data:: eFormatOctal
282 .. py:data:: eFormatOSType
283 .. py:data:: eFormatUnicode16
284 .. py:data:: eFormatUnicode32
285 .. py:data:: eFormatUnsigned
286 .. py:data:: eFormatPointer
287 .. py:data:: eFormatVectorOfChar
288 .. py:data:: eFormatVectorOfSInt8
289 .. py:data:: eFormatVectorOfUInt8
290 .. py:data:: eFormatVectorOfSInt16
291 .. py:data:: eFormatVectorOfUInt16
292 .. py:data:: eFormatVectorOfSInt32
293 .. py:data:: eFormatVectorOfUInt32
294 .. py:data:: eFormatVectorOfSInt64
295 .. py:data:: eFormatVectorOfUInt64
296 .. py:data:: eFormatVectorOfFloat16
297 .. py:data:: eFormatVectorOfFloat32
298 .. py:data:: eFormatVectorOfFloat64
299 .. py:data:: eFormatVectorOfUInt128
300 .. py:data:: eFormatComplexInteger
301 .. py:data:: eFormatCharArray
302 .. py:data:: eFormatAddressInfo
303 .. py:data:: eFormatHexFloat
304 .. py:data:: eFormatInstruction
305 .. py:data:: eFormatVoid
306 .. py:data:: eFormatUnicode8
307
308 DescriptionLevel
309 ----------------
310
311 .. py:data:: eDescriptionLevelBrief
312 .. py:data:: eDescriptionLevelFull
313 .. py:data:: eDescriptionLevelVerbose
314 .. py:data:: eDescriptionLevelInitial
315
316 ScriptLanguage
317 --------------
318
319 .. py:data:: eScriptLanguageNone
320 .. py:data:: eScriptLanguagePython
321 .. py:data:: eScriptLanguageLua
322 .. py:data:: eScriptLanguageUnknown
323 .. py:data:: eScriptLanguageDefault
324
325 RegisterKind
326 ------------
327
328 .. py:data:: eRegisterKindEHFrame
329 .. py:data:: eRegisterKindDWARF
330 .. py:data:: eRegisterKindGeneric
331 .. py:data:: eRegisterKindProcessPlugin
332 .. py:data:: eRegisterKindLLDB
333
334 StopReason
335 ----------
336
337 .. py:data:: eStopReasonInvalid
338 .. py:data:: eStopReasonNone
339 .. py:data:: eStopReasonTrace
340 .. py:data:: eStopReasonBreakpoint
341 .. py:data:: eStopReasonWatchpoint
342 .. py:data:: eStopReasonSignal
343 .. py:data:: eStopReasonException
344 .. py:data:: eStopReasonExec
345 .. py:data:: eStopReasonPlanComplete
346 .. py:data:: eStopReasonThreadExiting
347 .. py:data:: eStopReasonInstrumentation
348
349 ReturnStatus
350 ------------
351
352 .. py:data:: eReturnStatusInvalid
353 .. py:data:: eReturnStatusSuccessFinishNoResult
354 .. py:data:: eReturnStatusSuccessFinishResult
355 .. py:data:: eReturnStatusSuccessContinuingNoResult
356 .. py:data:: eReturnStatusSuccessContinuingResult
357 .. py:data:: eReturnStatusStarted
358 .. py:data:: eReturnStatusFailed
359 .. py:data:: eReturnStatusQuit
360
361 Expression
362 ----------
363
364 The results of expression evaluation.
365
366 .. py:data:: eExpressionCompleted
367 .. py:data:: eExpressionSetupError
368 .. py:data:: eExpressionParseError
369 .. py:data:: eExpressionDiscarded
370 .. py:data:: eExpressionInterrupted
371 .. py:data:: eExpressionHitBreakpoint
372 .. py:data:: eExpressionTimedOut
373 .. py:data:: eExpressionResultUnavailable
374 .. py:data:: eExpressionStoppedForDebug
375 .. py:data:: eExpressionThreadVanished
376
377 SearchDepth
378 -----------
379
380 .. py:data:: eSearchDepthInvalid
381 .. py:data:: eSearchDepthTarget
382 .. py:data:: eSearchDepthModule
383 .. py:data:: eSearchDepthCompUnit
384 .. py:data:: eSearchDepthFunction
385 .. py:data:: eSearchDepthBlock
386 .. py:data:: eSearchDepthAddress
387
388 ConnectionStatus
389 ----------------
390
391 .. py:data:: eConnectionStatusSuccess
392
393    Success.
394
395 .. py:data:: eConnectionStatusEndOfFile
396
397    End-of-file encountered.
398
399 .. py:data:: eConnectionStatusError
400
401    Error encountered.
402
403 .. py:data:: eConnectionStatusTimedOut
404
405    Request timed out.
406
407 .. py:data:: eConnectionStatusNoConnection
408
409    No connection.
410
411 .. py:data:: eConnectionStatusLostConnection
412
413    Lost connection while connected to a  valid connection.
414
415 .. py:data:: eConnectionStatusInterrupted
416
417    Interrupted read.
418
419 ErrorType
420 ---------
421
422 .. py:data:: eErrorTypeInvalid
423 .. py:data:: eErrorTypeGeneric
424
425    Generic errors that can be any value.
426
427 .. py:data:: eErrorTypeMachKernel
428
429    Mach kernel error codes.
430
431 .. py:data:: eErrorTypePOSIX
432
433    POSIX error codes.
434
435 .. py:data:: eErrorTypeExpression
436
437    These are from the ExpressionResults enum.
438
439 .. py:data:: eErrorTypeWin32
440
441    Standard Win32 error codes.
442
443
444 ValueType
445 ---------
446
447 .. py:data:: eValueTypeInvalid
448 .. py:data:: eValueTypeVariableGlobal
449
450    Global variable.
451
452 .. py:data:: eValueTypeVariableStatic
453
454    Static variable.
455
456 .. py:data:: eValueTypeVariableArgument
457
458    Funfction argument variable.
459
460 .. py:data:: eValueTypeVariableLocal
461
462    Function local variable.
463
464 .. py:data:: eValueTypeRegister
465
466    Stack frame register.
467
468 .. py:data:: eValueTypeRegisterSet
469
470    A collection of stack frame register values.
471
472 .. py:data:: eValueTypeConstResult
473
474    Constant result variables.
475
476 .. py:data:: eValueTypeVariableThreadLocal
477
478    Thread local storage variable.
479
480 InputReader
481 -----------
482
483 Token size/granularities for Input Readers.
484
485 .. py:data:: eInputReaderGranularityInvalid
486 .. py:data:: eInputReaderGranularityByte
487 .. py:data:: eInputReaderGranularityWord
488 .. py:data:: eInputReaderGranularityLine
489 .. py:data:: eInputReaderGranularityAll
490
491 SymbolContextItem
492 -----------------
493
494 These mask bits allow a common interface for queries that can
495 limit the amount of information that gets parsed to only the
496 information that is requested. These bits also can indicate what
497 actually did get resolved during query function calls.
498
499 Each definition corresponds to a one of the member variables
500 in this class, and requests that that item be resolved, or
501 indicates that the member did get resolved.
502
503 .. py:data:: eSymbolContextTarget
504
505    Set when target is requested from a query, or was located
506    in query results.
507
508 .. py:data:: eSymbolContextModule
509
510    Set when module is requested from a query, or was located
511    in query results.
512
513 .. py:data:: eSymbolContextCompUnit
514
515    Set when compilation unit is requested from a query, or was
516    located in query results.
517
518 .. py:data:: eSymbolContextFunction
519
520    Set when function is requested from a query, or was located
521    in query results.
522
523 .. py:data:: eSymbolContextBlock
524
525    Set when the deepest block is requested from a query, or
526    was located in query results.
527
528 .. py:data:: eSymbolContextLineEntry
529
530    Set when line entry is requested from a query, or was
531    located in query results.
532
533 .. py:data:: eSymbolContextSymbol
534
535    Set when symbol is requested from a query, or was located
536    in query results
537
538 .. py:data:: eSymbolContextEverything
539
540    Indicates to try and lookup everything up during a routine
541    symbol context query.
542
543 .. py:data:: eSymbolContextVariable
544
545    Set when global or static variable is requested from a
546    query, or was located in query results.
547    eSymbolContextVariable is potentially expensive to lookup so
548    it isn't included in eSymbolContextEverything which stops it
549    from being used during frame PC lookups and many other
550    potential address to symbol context lookups.
551
552 Permissions
553 -----------
554 .. py:data:: ePermissionsWritable
555 .. py:data:: ePermissionsReadable
556 .. py:data:: ePermissionsExecutable
557
558 InputReader
559 -----------
560
561 .. py:data:: eInputReaderActivate
562
563    Reader is newly pushed onto the reader stack.
564
565 .. py:data:: eInputReaderAsynchronousOutputWritten
566
567    An async output event occurred; the reader may want to do something.
568
569 .. py:data:: eInputReaderReactivate
570
571    Reader is on top of the stack again after another  reader was popped off.
572
573 .. py:data:: eInputReaderDeactivate
574
575    Another reader was pushed on the stack.
576
577 .. py:data:: eInputReaderGotToken
578
579    Reader got one of its tokens (granularity).
580
581 .. py:data:: eInputReaderInterrupt
582
583    Reader received an interrupt signal (probably from  a control-c).
584
585 .. py:data:: eInputReaderEndOfFile
586
587    Reader received an EOF char (probably from a control-d).
588
589 .. py:data:: eInputReaderDone
590
591    Reader was just popped off the stack and is done.
592
593 BreakpointEventType
594 -------------------
595
596 .. py:data:: eBreakpointEventTypeInvalidType
597 .. py:data:: eBreakpointEventTypeAdded
598 .. py:data:: eBreakpointEventTypeRemoved
599 .. py:data:: eBreakpointEventTypeLocationsAdded
600 .. py:data:: eBreakpointEventTypeLocationsRemoved
601 .. py:data:: eBreakpointEventTypeLocationsResolved
602 .. py:data:: eBreakpointEventTypeEnabled
603 .. py:data:: eBreakpointEventTypeDisabled
604 .. py:data:: eBreakpointEventTypeCommandChanged
605 .. py:data:: eBreakpointEventTypeConditionChanged
606 .. py:data:: eBreakpointEventTypeIgnoreChanged
607 .. py:data:: eBreakpointEventTypeThreadChanged
608 .. py:data:: eBreakpointEventTypeAutoContinueChanged
609
610 WatchpointEventType
611 -------------------
612
613 .. py:data:: eWatchpointEventTypeInvalidType
614 .. py:data:: eWatchpointEventTypeAdded
615 .. py:data:: eWatchpointEventTypeRemoved
616 .. py:data:: eWatchpointEventTypeEnabled
617 .. py:data:: eWatchpointEventTypeDisabled
618 .. py:data:: eWatchpointEventTypeCommandChanged
619 .. py:data:: eWatchpointEventTypeConditionChanged
620 .. py:data:: eWatchpointEventTypeIgnoreChanged
621 .. py:data:: eWatchpointEventTypeThreadChanged
622 .. py:data:: eWatchpointEventTypeTypeChanged
623
624 .. _LanguageType:
625
626 LanguageType
627 ------------
628
629 .. py:data:: eLanguageTypeUnknown
630 .. py:data:: eLanguageTypeC89
631 .. py:data:: eLanguageTypeC
632 .. py:data:: eLanguageTypeAda83
633 .. py:data:: eLanguageTypeC_plus_plus
634 .. py:data:: eLanguageTypeCobol74
635 .. py:data:: eLanguageTypeCobol85
636 .. py:data:: eLanguageTypeFortran77
637 .. py:data:: eLanguageTypeFortran90
638 .. py:data:: eLanguageTypePascal83
639 .. py:data:: eLanguageTypeModula2
640 .. py:data:: eLanguageTypeJava
641 .. py:data:: eLanguageTypeC99
642 .. py:data:: eLanguageTypeAda95
643 .. py:data:: eLanguageTypeFortran95
644 .. py:data:: eLanguageTypePLI
645 .. py:data:: eLanguageTypeObjC
646 .. py:data:: eLanguageTypeObjC_plus_plus
647 .. py:data:: eLanguageTypeUPC
648 .. py:data:: eLanguageTypeD
649 .. py:data:: eLanguageTypePython
650 .. py:data:: eLanguageTypeOpenCL
651 .. py:data:: eLanguageTypeGo
652 .. py:data:: eLanguageTypeModula3
653 .. py:data:: eLanguageTypeHaskell
654 .. py:data:: eLanguageTypeC_plus_plus_03
655 .. py:data:: eLanguageTypeC_plus_plus_11
656 .. py:data:: eLanguageTypeOCaml
657 .. py:data:: eLanguageTypeRust
658 .. py:data:: eLanguageTypeC11
659 .. py:data:: eLanguageTypeSwift
660 .. py:data:: eLanguageTypeJulia
661 .. py:data:: eLanguageTypeDylan
662 .. py:data:: eLanguageTypeC_plus_plus_14
663 .. py:data:: eLanguageTypeFortran03
664 .. py:data:: eLanguageTypeFortran08
665 .. py:data:: eLanguageTypeMipsAssembler
666 .. py:data:: eLanguageTypeExtRenderScript
667 .. py:data:: eNumLanguageTypes
668
669 InstrumentationRuntimeType
670 --------------------------
671
672 .. py:data:: eInstrumentationRuntimeTypeAddressSanitizer
673 .. py:data:: eInstrumentationRuntimeTypeThreadSanitizer
674 .. py:data:: eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
675 .. py:data:: eInstrumentationRuntimeTypeMainThreadChecker
676 .. py:data:: eInstrumentationRuntimeTypeSwiftRuntimeReporting
677 .. py:data:: eNumInstrumentationRuntimeTypes
678
679 DynamicValueType
680 ----------------
681
682 .. py:data:: eNoDynamicValues
683 .. py:data:: eDynamicCanRunTarget
684 .. py:data:: eDynamicDontRunTarget
685
686 StopShowColumn
687 --------------
688
689 .. py:data:: eStopShowColumnAnsiOrCaret
690 .. py:data:: eStopShowColumnAnsi
691 .. py:data:: eStopShowColumnCaret
692 .. py:data:: eStopShowColumnNone
693
694 AccessType
695 ----------
696
697 .. py:data:: eAccessNone
698 .. py:data:: eAccessPublic
699 .. py:data:: eAccessPrivate
700 .. py:data:: eAccessProtected
701 .. py:data:: eAccessPackage
702
703 CommandArgumentType
704 -------------------
705
706 .. py:data:: eArgTypeAddress
707 .. py:data:: eArgTypeAddressOrExpression
708 .. py:data:: eArgTypeAliasName
709 .. py:data:: eArgTypeAliasOptions
710 .. py:data:: eArgTypeArchitecture
711 .. py:data:: eArgTypeBoolean
712 .. py:data:: eArgTypeBreakpointID
713 .. py:data:: eArgTypeBreakpointIDRange
714 .. py:data:: eArgTypeBreakpointName
715 .. py:data:: eArgTypeByteSize
716 .. py:data:: eArgTypeClassName
717 .. py:data:: eArgTypeCommandName
718 .. py:data:: eArgTypeCount
719 .. py:data:: eArgTypeDescriptionVerbosity
720 .. py:data:: eArgTypeDirectoryName
721 .. py:data:: eArgTypeDisassemblyFlavor
722 .. py:data:: eArgTypeEndAddress
723 .. py:data:: eArgTypeExpression
724 .. py:data:: eArgTypeExpressionPath
725 .. py:data:: eArgTypeExprFormat
726 .. py:data:: eArgTypeFileLineColumn
727 .. py:data:: eArgTypeFilename
728 .. py:data:: eArgTypeFormat
729 .. py:data:: eArgTypeFrameIndex
730 .. py:data:: eArgTypeFullName
731 .. py:data:: eArgTypeFunctionName
732 .. py:data:: eArgTypeFunctionOrSymbol
733 .. py:data:: eArgTypeGDBFormat
734 .. py:data:: eArgTypeHelpText
735 .. py:data:: eArgTypeIndex
736 .. py:data:: eArgTypeLanguage
737 .. py:data:: eArgTypeLineNum
738 .. py:data:: eArgTypeLogCategory
739 .. py:data:: eArgTypeLogChannel
740 .. py:data:: eArgTypeMethod
741 .. py:data:: eArgTypeName
742 .. py:data:: eArgTypeNewPathPrefix
743 .. py:data:: eArgTypeNumLines
744 .. py:data:: eArgTypeNumberPerLine
745 .. py:data:: eArgTypeOffset
746 .. py:data:: eArgTypeOldPathPrefix
747 .. py:data:: eArgTypeOneLiner
748 .. py:data:: eArgTypePath
749 .. py:data:: eArgTypePermissionsNumber
750 .. py:data:: eArgTypePermissionsString
751 .. py:data:: eArgTypePid
752 .. py:data:: eArgTypePlugin
753 .. py:data:: eArgTypeProcessName
754 .. py:data:: eArgTypePythonClass
755 .. py:data:: eArgTypePythonFunction
756 .. py:data:: eArgTypePythonScript
757 .. py:data:: eArgTypeQueueName
758 .. py:data:: eArgTypeRegisterName
759 .. py:data:: eArgTypeRegularExpression
760 .. py:data:: eArgTypeRunArgs
761 .. py:data:: eArgTypeRunMode
762 .. py:data:: eArgTypeScriptedCommandSynchronicity
763 .. py:data:: eArgTypeScriptLang
764 .. py:data:: eArgTypeSearchWord
765 .. py:data:: eArgTypeSelector
766 .. py:data:: eArgTypeSettingIndex
767 .. py:data:: eArgTypeSettingKey
768 .. py:data:: eArgTypeSettingPrefix
769 .. py:data:: eArgTypeSettingVariableName
770 .. py:data:: eArgTypeShlibName
771 .. py:data:: eArgTypeSourceFile
772 .. py:data:: eArgTypeSortOrder
773 .. py:data:: eArgTypeStartAddress
774 .. py:data:: eArgTypeSummaryString
775 .. py:data:: eArgTypeSymbol
776 .. py:data:: eArgTypeThreadID
777 .. py:data:: eArgTypeThreadIndex
778 .. py:data:: eArgTypeThreadName
779 .. py:data:: eArgTypeTypeName
780 .. py:data:: eArgTypeUnsignedInteger
781 .. py:data:: eArgTypeUnixSignal
782 .. py:data:: eArgTypeVarName
783 .. py:data:: eArgTypeValue
784 .. py:data:: eArgTypeWidth
785 .. py:data:: eArgTypeNone
786 .. py:data:: eArgTypePlatform
787 .. py:data:: eArgTypeWatchpointID
788 .. py:data:: eArgTypeWatchpointIDRange
789 .. py:data:: eArgTypeWatchType
790 .. py:data:: eArgRawInput
791 .. py:data:: eArgTypeCommand
792 .. py:data:: eArgTypeColumnNum
793 .. py:data:: eArgTypeModuleUUID
794 .. py:data:: eArgTypeLastArg
795
796 SymbolType
797 ----------
798
799 .. py:data:: eSymbolTypeAny
800 .. py:data:: eSymbolTypeInvalid
801 .. py:data:: eSymbolTypeAbsolute
802 .. py:data:: eSymbolTypeCode
803 .. py:data:: eSymbolTypeResolver
804 .. py:data:: eSymbolTypeData
805 .. py:data:: eSymbolTypeTrampoline
806 .. py:data:: eSymbolTypeRuntime
807 .. py:data:: eSymbolTypeException
808 .. py:data:: eSymbolTypeSourceFile
809 .. py:data:: eSymbolTypeHeaderFile
810 .. py:data:: eSymbolTypeObjectFile
811 .. py:data:: eSymbolTypeCommonBlock
812 .. py:data:: eSymbolTypeBlock
813 .. py:data:: eSymbolTypeLocal
814 .. py:data:: eSymbolTypeParam
815 .. py:data:: eSymbolTypeVariable
816 .. py:data:: eSymbolTypeVariableType
817 .. py:data:: eSymbolTypeLineEntry
818 .. py:data:: eSymbolTypeLineHeader
819 .. py:data:: eSymbolTypeScopeBegin
820 .. py:data:: eSymbolTypeScopeEnd
821 .. py:data:: eSymbolTypeAdditional
822 .. py:data:: eSymbolTypeCompiler
823 .. py:data:: eSymbolTypeInstrumentation
824 .. py:data:: eSymbolTypeUndefined
825 .. py:data:: eSymbolTypeObjCClass
826 .. py:data:: eSymbolTypeObjCMetaClass
827 .. py:data:: eSymbolTypeObjCIVar
828 .. py:data:: eSymbolTypeReExported
829
830 SectionType
831 -----------
832
833 .. py:data:: eSectionTypeInvalid
834 .. py:data:: eSectionTypeCode
835 .. py:data:: eSectionTypeContainer
836 .. py:data:: eSectionTypeData
837 .. py:data:: eSectionTypeDataCString
838 .. py:data:: eSectionTypeDataCStringPointers
839 .. py:data:: eSectionTypeDataSymbolAddress
840 .. py:data:: eSectionTypeData4
841 .. py:data:: eSectionTypeData8
842 .. py:data:: eSectionTypeData16
843 .. py:data:: eSectionTypeDataPointers
844 .. py:data:: eSectionTypeDebug
845 .. py:data:: eSectionTypeZeroFill
846 .. py:data:: eSectionTypeDataObjCMessageRefs
847 .. py:data:: eSectionTypeDataObjCCFStrings
848 .. py:data:: eSectionTypeDWARFDebugAbbrev
849 .. py:data:: eSectionTypeDWARFDebugAddr
850 .. py:data:: eSectionTypeDWARFDebugAranges
851 .. py:data:: eSectionTypeDWARFDebugCuIndex
852 .. py:data:: eSectionTypeDWARFDebugFrame
853 .. py:data:: eSectionTypeDWARFDebugInfo
854 .. py:data:: eSectionTypeDWARFDebugLine
855 .. py:data:: eSectionTypeDWARFDebugLoc
856 .. py:data:: eSectionTypeDWARFDebugMacInfo
857 .. py:data:: eSectionTypeDWARFDebugMacro
858 .. py:data:: eSectionTypeDWARFDebugPubNames
859 .. py:data:: eSectionTypeDWARFDebugPubTypes
860 .. py:data:: eSectionTypeDWARFDebugRanges
861 .. py:data:: eSectionTypeDWARFDebugStr
862 .. py:data:: eSectionTypeDWARFDebugStrOffsets
863 .. py:data:: eSectionTypeDWARFAppleNames
864 .. py:data:: eSectionTypeDWARFAppleTypes
865 .. py:data:: eSectionTypeDWARFAppleNamespaces
866 .. py:data:: eSectionTypeDWARFAppleObjC
867 .. py:data:: eSectionTypeELFSymbolTable
868 .. py:data:: eSectionTypeELFDynamicSymbols
869 .. py:data:: eSectionTypeELFRelocationEntries
870 .. py:data:: eSectionTypeELFDynamicLinkInfo
871 .. py:data:: eSectionTypeEHFrame
872 .. py:data:: eSectionTypeARMexidx
873 .. py:data:: eSectionTypeARMextab
874 .. py:data:: eSectionTypeCompactUnwind
875 .. py:data:: eSectionTypeGoSymtab
876 .. py:data:: eSectionTypeAbsoluteAddress
877 .. py:data:: eSectionTypeDWARFGNUDebugAltLink
878 .. py:data:: eSectionTypeDWARFDebugTypes
879 .. py:data:: eSectionTypeDWARFDebugNames
880 .. py:data:: eSectionTypeOther
881 .. py:data:: eSectionTypeDWARFDebugLineStr
882 .. py:data:: eSectionTypeDWARFDebugRngLists
883 .. py:data:: eSectionTypeDWARFDebugLocLists
884 .. py:data:: eSectionTypeDWARFDebugAbbrevDwo
885 .. py:data:: eSectionTypeDWARFDebugInfoDwo
886 .. py:data:: eSectionTypeDWARFDebugStrDwo
887 .. py:data:: eSectionTypeDWARFDebugStrOffsetsDwo
888 .. py:data:: eSectionTypeDWARFDebugTypesDwo
889 .. py:data:: eSectionTypeDWARFDebugRngListsDwo
890 .. py:data:: eSectionTypeDWARFDebugLocDwo
891 .. py:data:: eSectionTypeDWARFDebugLocListsDwo
892 .. py:data:: eSectionTypeDWARFDebugTuIndex
893
894 EmulatorInstructionOption
895 -------------------------
896
897 .. py:data:: eEmulateInstructionOptionNone
898 .. py:data:: eEmulateInstructionOptionAutoAdvancePC
899 .. py:data:: eEmulateInstructionOptionIgnoreConditions
900
901 FunctionNameType
902 ----------------
903
904 .. py:data:: eFunctionNameTypeNone
905 .. py:data:: eFunctionNameTypeAuto
906 .. py:data:: eFunctionNameTypeFull
907 .. py:data:: eFunctionNameTypeBase
908 .. py:data:: eFunctionNameTypeMethod
909 .. py:data:: eFunctionNameTypeSelector
910 .. py:data:: eFunctionNameTypeAny
911
912 BasicType
913 ---------
914
915 .. py:data:: eBasicTypeInvalid
916 .. py:data:: eBasicTypeVoid
917 .. py:data:: eBasicTypeChar
918 .. py:data:: eBasicTypeSignedChar
919 .. py:data:: eBasicTypeUnsignedChar
920 .. py:data:: eBasicTypeWChar
921 .. py:data:: eBasicTypeSignedWChar
922 .. py:data:: eBasicTypeUnsignedWChar
923 .. py:data:: eBasicTypeChar16
924 .. py:data:: eBasicTypeChar32
925 .. py:data:: eBasicTypeShort
926 .. py:data:: eBasicTypeUnsignedShort
927 .. py:data:: eBasicTypeInt
928 .. py:data:: eBasicTypeUnsignedInt
929 .. py:data:: eBasicTypeLong
930 .. py:data:: eBasicTypeUnsignedLong
931 .. py:data:: eBasicTypeLongLong
932 .. py:data:: eBasicTypeUnsignedLongLong
933 .. py:data:: eBasicTypeInt128
934 .. py:data:: eBasicTypeUnsignedInt128
935 .. py:data:: eBasicTypeBool
936 .. py:data:: eBasicTypeHalf
937 .. py:data:: eBasicTypeFloat
938 .. py:data:: eBasicTypeDouble
939 .. py:data:: eBasicTypeLongDouble
940 .. py:data:: eBasicTypeFloatComplex
941 .. py:data:: eBasicTypeDoubleComplex
942 .. py:data:: eBasicTypeLongDoubleComplex
943 .. py:data:: eBasicTypeObjCID
944 .. py:data:: eBasicTypeObjCClass
945 .. py:data:: eBasicTypeObjCSel
946 .. py:data:: eBasicTypeNullPtr
947 .. py:data:: eBasicTypeOther
948
949 TraceType
950 ---------
951
952 .. py:data:: eTraceTypeNone
953 .. py:data:: eTraceTypeProcessorTrace
954
955 StructuredDataType
956 ------------------
957
958 .. py:data:: eStructuredDataTypeInvalid
959 .. py:data:: eStructuredDataTypeNull
960 .. py:data:: eStructuredDataTypeGeneric
961 .. py:data:: eStructuredDataTypeArray
962 .. py:data:: eStructuredDataTypeInteger
963 .. py:data:: eStructuredDataTypeFloat
964 .. py:data:: eStructuredDataTypeBoolean
965 .. py:data:: eStructuredDataTypeString
966 .. py:data:: eStructuredDataTypeDictionary
967
968 TypeClass
969 ---------
970
971 .. py:data:: eTypeClassInvalid
972 .. py:data:: eTypeClassArray
973 .. py:data:: eTypeClassBlockPointer
974 .. py:data:: eTypeClassBuiltin
975 .. py:data:: eTypeClassClass
976 .. py:data:: eTypeClassFloat
977 .. py:data:: eTypeClassComplexInteger
978 .. py:data:: eTypeClassComplexFloat
979 .. py:data:: eTypeClassFunction
980 .. py:data:: eTypeClassMemberPointer
981 .. py:data:: eTypeClassObjCObject
982 .. py:data:: eTypeClassObjCInterface
983 .. py:data:: eTypeClassObjCObjectPointer
984 .. py:data:: eTypeClassPointer
985 .. py:data:: eTypeClassReference
986 .. py:data:: eTypeClassStruct
987 .. py:data:: eTypeClassTypedef
988 .. py:data:: eTypeClassUnion
989 .. py:data:: eTypeClassVector
990 .. py:data:: eTypeClassOther
991 .. py:data:: eTypeClassAny
992
993 TemplateArgument
994 ----------------
995
996 .. py:data:: eTemplateArgumentKindNull
997 .. py:data:: eTemplateArgumentKindType
998 .. py:data:: eTemplateArgumentKindDeclaration
999 .. py:data:: eTemplateArgumentKindIntegral
1000 .. py:data:: eTemplateArgumentKindTemplate
1001 .. py:data:: eTemplateArgumentKindTemplateExpansion
1002 .. py:data:: eTemplateArgumentKindExpression
1003 .. py:data:: eTemplateArgumentKindPack
1004 .. py:data:: eTemplateArgumentKindNullPtr
1005 .. py:data:: eTemplateArgumentKindUncommonValue
1006
1007 TypeOption
1008 ----------
1009
1010 Options that can be set for a formatter to alter its behavior. Not
1011 all of these are applicable to all formatter types.
1012
1013 .. py:data:: eTypeOptionNone
1014 .. py:data:: eTypeOptionCascade
1015 .. py:data:: eTypeOptionSkipPointers
1016 .. py:data:: eTypeOptionSkipReferences
1017 .. py:data:: eTypeOptionHideChildren
1018 .. py:data:: eTypeOptionHideValue
1019 .. py:data:: eTypeOptionShowOneLiner
1020 .. py:data:: eTypeOptionHideNames
1021 .. py:data:: eTypeOptionNonCacheable
1022 .. py:data:: eTypeOptionHideEmptyAggregates
1023 .. py:data:: eTypeOptionFrontEndWantsDereference
1024
1025 FrameCompare
1026 ------------
1027
1028 This is the return value for frame comparisons.  If you are comparing frame
1029 A to frame B the following cases arise:
1030
1031    1) When frame A pushes frame B (or a frame that ends up pushing
1032       B) A is Older than B.
1033
1034    2) When frame A pushed frame B (or if frameA is on the stack
1035       but B is not) A is Younger than B.
1036
1037    3) When frame A and frame B have the same StackID, they are
1038       Equal.
1039
1040    4) When frame A and frame B have the same immediate parent
1041       frame, but are not equal, the comparison yields SameParent.
1042
1043    5) If the two frames are on different threads or processes the
1044       comparison is Invalid.
1045
1046    6) If for some reason we can't figure out what went on, we
1047       return Unknown.
1048
1049 .. py:data:: eFrameCompareInvalid
1050 .. py:data:: eFrameCompareUnknown
1051 .. py:data:: eFrameCompareEqual
1052 .. py:data:: eFrameCompareSameParent
1053 .. py:data:: eFrameCompareYounger
1054 .. py:data:: eFrameCompareOlder
1055
1056 FilePermissions
1057 ---------------
1058
1059 .. py:data:: eFilePermissionsUserRead
1060 .. py:data:: eFilePermissionsUserWrite
1061 .. py:data:: eFilePermissionsUserExecute
1062 .. py:data:: eFilePermissionsGroupRead
1063 .. py:data:: eFilePermissionsGroupWrite
1064 .. py:data:: eFilePermissionsGroupExecute
1065 .. py:data:: eFilePermissionsWorldRead
1066 .. py:data:: eFilePermissionsWorldWrite
1067 .. py:data:: eFilePermissionsWorldExecute
1068 .. py:data:: eFilePermissionsUserRW
1069 .. py:data:: eFileFilePermissionsUserRX
1070 .. py:data:: eFilePermissionsUserRWX
1071 .. py:data:: eFilePermissionsGroupRW
1072 .. py:data:: eFilePermissionsGroupRX
1073 .. py:data:: eFilePermissionsGroupRWX
1074 .. py:data:: eFilePermissionsWorldRW
1075 .. py:data:: eFilePermissionsWorldRX
1076 .. py:data:: eFilePermissionsWorldRWX
1077 .. py:data:: eFilePermissionsEveryoneR
1078 .. py:data:: eFilePermissionsEveryoneW
1079 .. py:data:: eFilePermissionsEveryoneX
1080 .. py:data:: eFilePermissionsEveryoneRW
1081 .. py:data:: eFilePermissionsEveryoneRX
1082 .. py:data:: eFilePermissionsEveryoneRWX
1083 .. py:data:: eFilePermissionsFileDefault = eFilePermissionsUserRW,
1084 .. py:data:: eFilePermissionsDirectoryDefault
1085
1086 QueueItem
1087 ---------
1088 .. py:data:: eQueueItemKindUnknown
1089 .. py:data:: eQueueItemKindFunction
1090 .. py:data:: eQueueItemKindBlock
1091
1092 QueueKind
1093 ---------
1094
1095 libdispatch aka Grand Central Dispatch (GCD) queues can be either
1096 serial (executing on one thread) or concurrent (executing on
1097 multiple threads).
1098
1099 .. py:data:: eQueueKindUnknown
1100 .. py:data:: eQueueKindSerial
1101 .. py:data:: eQueueKindConcurrent
1102
1103 ExpressionEvaluationPhase
1104 -------------------------
1105
1106 These are the cancellable stages of expression evaluation, passed
1107 to the expression evaluation callback, so that you can interrupt
1108 expression evaluation at the various points in its lifecycle.
1109
1110 .. py:data:: eExpressionEvaluationParse
1111 .. py:data:: eExpressionEvaluationIRGen
1112 .. py:data:: eExpressionEvaluationExecution
1113 .. py:data:: eExpressionEvaluationComplete
1114
1115 WatchpointKind
1116 --------------
1117
1118 Indicates what types of events cause the watchpoint to fire. Used by Native
1119 -Protocol-related classes.
1120
1121 .. py:data:: eWatchpointKindWrite
1122 .. py:data:: eWatchpointKindRead
1123
1124 GdbSignal
1125 ---------
1126
1127 .. py:data:: eGdbSignalBadAccess
1128 .. py:data:: eGdbSignalBadInstruction
1129 .. py:data:: eGdbSignalArithmetic
1130 .. py:data:: eGdbSignalEmulation
1131 .. py:data:: eGdbSignalSoftware
1132 .. py:data:: eGdbSignalBreakpoint
1133
1134 PathType
1135 --------
1136
1137 Used with `SBHostOS.GetLLDBPath` to find files that are
1138 related to LLDB on the current host machine. Most files are
1139 relative to LLDB or are in known locations.
1140
1141 .. py:data:: ePathTypeLLDBShlibDir
1142
1143    The directory where the lldb.so (unix) or LLDB mach-o file in
1144    LLDB.framework (MacOSX) exists.
1145
1146 .. py:data:: ePathTypeSupportExecutableDir
1147
1148    Find LLDB support executable directory (debugserver, etc).
1149
1150 .. py:data:: ePathTypeHeaderDir
1151
1152    Find LLDB header file directory.
1153
1154 .. py:data:: ePathTypePythonDir
1155
1156    Find Python modules (PYTHONPATH) directory.
1157
1158 .. py:data:: ePathTypeLLDBSystemPlugins
1159
1160    System plug-ins directory
1161
1162 .. py:data:: ePathTypeLLDBUserPlugins
1163
1164    User plug-ins directory
1165
1166 .. py:data:: ePathTypeLLDBTempSystemDir
1167
1168    The LLDB temp directory for this system that will be cleaned up on exit.
1169
1170 .. py:data:: ePathTypeGlobalLLDBTempSystemDir
1171
1172    The LLDB temp directory for this system, NOT cleaned up on a process
1173    exit.
1174
1175 .. py:data:: ePathTypeClangDir
1176
1177    Find path to Clang builtin headers.
1178
1179 MemberFunctionKind
1180 ------------------
1181
1182 .. py:data:: eMemberFunctionKindUnknown
1183 .. py:data:: eMemberFunctionKindConstructor
1184
1185    A function used to create instances.
1186
1187 .. py:data:: eMemberFunctionKindDestructor
1188
1189    A function used to tear down existing instances.
1190
1191 .. py:data:: eMemberFunctionKindInstanceMethod
1192
1193    A function that applies to a specific instance.
1194
1195 .. py:data:: eMemberFunctionKindStaticMethod
1196
1197    A function that applies to a type rather than any instance,
1198
1199 TypeFlags
1200 ---------
1201
1202 .. py:data:: eTypeHasChildren
1203 .. py:data:: eTypeIsArray
1204 .. py:data:: eTypeIsBuiltIn
1205 .. py:data:: eTypeIsCPlusPlus
1206 .. py:data:: eTypeIsFuncPrototype
1207 .. py:data:: eTypeIsObjC
1208 .. py:data:: eTypeIsReference
1209 .. py:data:: eTypeIsTemplate
1210 .. py:data:: eTypeIsVector
1211 .. py:data:: eTypeIsInteger
1212 .. py:data:: eTypeIsComplex
1213 .. py:data:: eTypeInstanceIsPointer
1214
1215 CommandFlags
1216 ---------------
1217
1218 .. py:data:: eCommandRequiresTarget
1219 .. py:data:: eCommandRequiresProcess
1220 .. py:data:: eCommandRequiresThread
1221 .. py:data:: eCommandRequiresFrame
1222 .. py:data:: eCommandRequiresRegContext
1223 .. py:data:: eCommandTryTargetAPILock
1224 .. py:data:: eCommandProcessMustBeLaunched
1225 .. py:data:: eCommandProcessMustBePaused
1226 .. py:data:: eCommandProcessMustBeTraced
1227
1228 TypeSummary
1229 -----------
1230
1231 Whether a summary should cap how much data it returns to users or not.
1232
1233 .. py:data:: eTypeSummaryCapped
1234 .. py:data:: eTypeSummaryUncapped
1235
1236 CommandInterpreterResult
1237 ------------------------
1238
1239 The result from a command interpreter run.
1240
1241 .. py:data:: eCommandInterpreterResultSuccess
1242
1243    Command interpreter finished successfully.
1244
1245 .. py:data:: eCommandInterpreterResultInferiorCrash
1246
1247    Stopped because the corresponding option was set and the inferior
1248    crashed.
1249
1250 .. py:data:: eCommandInterpreterResultCommandError
1251
1252    Stopped because the corresponding option was set and a command returned
1253    an error.
1254
1255 .. py:data:: eCommandInterpreterResultQuitRequested
1256
1257    Stopped because quit was requested.