xref: /freebsd/contrib/llvm-project/lldb/docs/python_api_enums.rst (revision c8e7f78a3d28ff6e6223ed136ada8e1e2f34965e)
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
7Python API enumerators and constants
8====================================
9
10.. py:currentmodule:: lldb
11
12Constants
13*********
14
15Generic 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
70Invalid 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
90CPU 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
99Option 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
116Miscellaneous 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
125Enumerators
126***********
127
128
129.. _State:
130
131State
132-----
133
134.. py:data:: eStateInvalid
135.. py:data:: eStateUnloaded
136
137   Process is object is valid, but not currently loaded.
138
139.. py:data:: eStateConnected
140
141   Process is connected to remote debug services, but not
142   launched or attached to anything yet.
143
144.. py:data:: eStateAttaching
145
146   Process is in the process of launching.
147
148.. py:data:: eStateLaunching
149
150   Process is in the process of launching.
151
152.. py:data:: eStateStopped
153
154   Process or thread is stopped and can be examined.
155
156.. py:data:: eStateRunning
157
158   Process or thread is running and can't be examined.
159
160.. py:data:: eStateStepping
161
162   Process or thread is in the process of stepping and can
163   not be examined.
164
165.. py:data:: eStateCrashed
166
167   Process or thread has crashed and can be examined.
168
169.. py:data:: eStateDetached
170
171   Process has been detached and can't be examined.
172
173.. py:data:: eStateExited
174
175   Process has exited and can't be examined.
176
177.. py:data:: eStateSuspended
178
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.
182
183
184.. _LaunchFlag:
185
186LaunchFlag
187----------
188
189.. py:data:: eLaunchFlagNone
190.. py:data:: eLaunchFlagExec
191
192   Exec when launching and turn the calling process into a new process.
193
194.. py:data:: eLaunchFlagDebug
195
196   Stop as soon as the process launches to allow the process to be debugged.
197
198.. py:data:: eLaunchFlagStopAtEntry
199
200   Stop at the program entry point instead of auto-continuing when launching or attaching at entry point.
201
202.. py:data:: eLaunchFlagDisableASLR
203
204   Disable Address Space Layout Randomization.
205
206.. py:data:: eLaunchFlagDisableSTDIO
207
208   Disable stdio for inferior process (e.g. for a GUI app).
209
210.. py:data:: eLaunchFlagLaunchInTTY
211
212   Launch the process in a new TTY if supported by the host.
213
214.. py:data:: eLaunchFlagLaunchInShell
215
216   Launch the process inside a shell to get shell expansion.
217
218.. py:data:: eLaunchFlagLaunchInSeparateProcessGroup
219
220   Launch the process in a separate process group if you are going to hand the process off (e.g. to debugserver)
221
222.. py:data:: eLaunchFlagDontSetExitStatus
223
224   set this flag so lldb & the handee don't race to set its exit status.
225
226.. py:data:: eLaunchFlagDetachOnError
227
228   If set, then the client stub should detach rather than killing  the debugee
229   if it loses connection with lldb.
230
231.. py:data:: eLaunchFlagShellExpandArguments
232
233   Perform shell-style argument expansion
234
235.. py:data:: eLaunchFlagCloseTTYOnExit
236
237   Close the open TTY on exit
238
239.. py:data:: eLaunchFlagInheritTCCFromParent
240
241   Don't make the inferior responsible for its own TCC
242   permissions but instead inherit them from its parent.
243
244
245.. _RunMode:
246
247RunMode
248-------
249.. py:data:: eOnlyThisThread
250.. py:data:: eAllThreads
251.. py:data:: eOnlyDuringStepping
252
253
254.. _ByteOrder:
255
256ByteOrder
257---------
258
259.. py:data:: eByteOrderInvalid
260.. py:data:: eByteOrderBig
261.. py:data:: eByteOrderPDP
262.. py:data:: eByteOrderLittle
263
264
265.. _Encoding:
266
267Encoding
268--------
269
270.. py:data:: eEncodingInvalid
271.. py:data:: eEncodingUint
272.. py:data:: eEncodingSint
273.. py:data:: eEncodingIEEE754
274.. py:data:: eEncodingVector
275
276
277.. _Format:
278
279Format
280------
281
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
324
325
326.. _DescriptionLevel:
327
328DescriptionLevel
329----------------
330
331.. py:data:: eDescriptionLevelBrief
332.. py:data:: eDescriptionLevelFull
333.. py:data:: eDescriptionLevelVerbose
334.. py:data:: eDescriptionLevelInitial
335
336
337.. _ScriptLanguage:
338
339ScriptLanguage
340--------------
341
342.. py:data:: eScriptLanguageNone
343.. py:data:: eScriptLanguagePython
344.. py:data:: eScriptLanguageLua
345.. py:data:: eScriptLanguageUnknown
346.. py:data:: eScriptLanguageDefault
347
348
349.. _RegisterKind:
350
351RegisterKind
352------------
353
354.. py:data:: eRegisterKindEHFrame
355.. py:data:: eRegisterKindDWARF
356.. py:data:: eRegisterKindGeneric
357.. py:data:: eRegisterKindProcessPlugin
358.. py:data:: eRegisterKindLLDB
359
360
361.. _StopReason:
362
363StopReason
364----------
365
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
380
381
382.. _ReturnStatus:
383
384ReturnStatus
385------------
386
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
395
396
397.. _Expression:
398
399Expression
400----------
401
402The results of expression evaluation.
403
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
414
415
416.. _SearchDepth:
417
418SearchDepth
419-----------
420
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
428
429
430.. _ConnectionStatus:
431
432ConnectionStatus
433----------------
434
435.. py:data:: eConnectionStatusSuccess
436
437   Success.
438
439.. py:data:: eConnectionStatusEndOfFile
440
441   End-of-file encountered.
442
443.. py:data:: eConnectionStatusError
444
445   Error encountered.
446
447.. py:data:: eConnectionStatusTimedOut
448
449   Request timed out.
450
451.. py:data:: eConnectionStatusNoConnection
452
453   No connection.
454
455.. py:data:: eConnectionStatusLostConnection
456
457   Lost connection while connected to a  valid connection.
458
459.. py:data:: eConnectionStatusInterrupted
460
461   Interrupted read.
462
463
464.. _ErrorType:
465
466ErrorType
467---------
468
469.. py:data:: eErrorTypeInvalid
470.. py:data:: eErrorTypeGeneric
471
472   Generic errors that can be any value.
473
474.. py:data:: eErrorTypeMachKernel
475
476   Mach kernel error codes.
477
478.. py:data:: eErrorTypePOSIX
479
480   POSIX error codes.
481
482.. py:data:: eErrorTypeExpression
483
484   These are from the ExpressionResults enum.
485
486.. py:data:: eErrorTypeWin32
487
488   Standard Win32 error codes.
489
490
491.. _ValueType:
492
493ValueType
494---------
495
496.. py:data:: eValueTypeInvalid
497.. py:data:: eValueTypeVariableGlobal
498
499   Global variable.
500
501.. py:data:: eValueTypeVariableStatic
502
503   Static variable.
504
505.. py:data:: eValueTypeVariableArgument
506
507   Funfction argument variable.
508
509.. py:data:: eValueTypeVariableLocal
510
511   Function local variable.
512
513.. py:data:: eValueTypeRegister
514
515   Stack frame register.
516
517.. py:data:: eValueTypeRegisterSet
518
519   A collection of stack frame register values.
520
521.. py:data:: eValueTypeConstResult
522
523   Constant result variables.
524
525.. py:data:: eValueTypeVariableThreadLocal
526
527   Thread local storage variable.
528
529
530.. _InputReaderGranularity:
531
532InputReaderGranularity
533----------------------
534
535Token size/granularities for Input Readers.
536
537.. py:data:: eInputReaderGranularityInvalid
538.. py:data:: eInputReaderGranularityByte
539.. py:data:: eInputReaderGranularityWord
540.. py:data:: eInputReaderGranularityLine
541.. py:data:: eInputReaderGranularityAll
542
543
544.. _SymbolContextItem:
545
546SymbolContextItem
547-----------------
548
549These mask bits allow a common interface for queries that can
550limit the amount of information that gets parsed to only the
551information that is requested. These bits also can indicate what
552actually did get resolved during query function calls.
553
554Each definition corresponds to one of the member variables
555in this class, and requests that that item be resolved, or
556indicates that the member did get resolved.
557
558.. py:data:: eSymbolContextTarget
559
560   Set when target is requested from a query, or was located
561   in query results.
562
563.. py:data:: eSymbolContextModule
564
565   Set when module is requested from a query, or was located
566   in query results.
567
568.. py:data:: eSymbolContextCompUnit
569
570   Set when compilation unit is requested from a query, or was
571   located in query results.
572
573.. py:data:: eSymbolContextFunction
574
575   Set when function is requested from a query, or was located
576   in query results.
577
578.. py:data:: eSymbolContextBlock
579
580   Set when the deepest block is requested from a query, or
581   was located in query results.
582
583.. py:data:: eSymbolContextLineEntry
584
585   Set when line entry is requested from a query, or was
586   located in query results.
587
588.. py:data:: eSymbolContextSymbol
589
590   Set when symbol is requested from a query, or was located
591   in query results
592
593.. py:data:: eSymbolContextEverything
594
595   Indicates to try and lookup everything up during a routine
596   symbol context query.
597
598.. py:data:: eSymbolContextVariable
599
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.
606
607
608.. _Permissions:
609
610Permissions
611-----------
612.. py:data:: ePermissionsWritable
613.. py:data:: ePermissionsReadable
614.. py:data:: ePermissionsExecutable
615
616
617.. _InputReader:
618
619InputReader
620-----------
621
622.. py:data:: eInputReaderActivate
623
624   Reader is newly pushed onto the reader stack.
625
626.. py:data:: eInputReaderAsynchronousOutputWritten
627
628   An async output event occurred; the reader may want to do something.
629
630.. py:data:: eInputReaderReactivate
631
632   Reader is on top of the stack again after another  reader was popped off.
633
634.. py:data:: eInputReaderDeactivate
635
636   Another reader was pushed on the stack.
637
638.. py:data:: eInputReaderGotToken
639
640   Reader got one of its tokens (granularity).
641
642.. py:data:: eInputReaderInterrupt
643
644   Reader received an interrupt signal (probably from  a control-c).
645
646.. py:data:: eInputReaderEndOfFile
647
648   Reader received an EOF char (probably from a control-d).
649
650.. py:data:: eInputReaderDone
651
652   Reader was just popped off the stack and is done.
653
654
655.. _BreakpointEventType:
656
657BreakpointEventType
658-------------------
659
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
673
674
675.. _WatchpointEventType:
676
677WatchpointEventType
678-------------------
679
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
690
691
692.. _LanguageType:
693
694LanguageType
695------------
696
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
737
738
739.. _InstrumentationRuntimeType:
740
741InstrumentationRuntimeType
742--------------------------
743
744.. py:data:: eInstrumentationRuntimeTypeAddressSanitizer
745.. py:data:: eInstrumentationRuntimeTypeThreadSanitizer
746.. py:data:: eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
747.. py:data:: eInstrumentationRuntimeTypeMainThreadChecker
748.. py:data:: eInstrumentationRuntimeTypeSwiftRuntimeReporting
749.. py:data:: eNumInstrumentationRuntimeTypes
750
751
752.. _DynamicValueType:
753
754DynamicValueType
755----------------
756
757.. py:data:: eNoDynamicValues
758.. py:data:: eDynamicCanRunTarget
759.. py:data:: eDynamicDontRunTarget
760
761
762.. _StopShowColumn:
763
764StopShowColumn
765--------------
766
767.. py:data:: eStopShowColumnAnsiOrCaret
768.. py:data:: eStopShowColumnAnsi
769.. py:data:: eStopShowColumnCaret
770.. py:data:: eStopShowColumnNone
771
772
773.. _AccessType:
774
775AccessType
776----------
777
778.. py:data:: eAccessNone
779.. py:data:: eAccessPublic
780.. py:data:: eAccessPrivate
781.. py:data:: eAccessProtected
782.. py:data:: eAccessPackage
783
784
785.. _CommandArgumentType:
786
787CommandArgumentType
788-------------------
789
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
880
881.. _SymbolType:
882
883SymbolType
884----------
885
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
916
917
918.. _SectionType:
919
920SectionType
921-----------
922
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
983
984
985.. _EmulatorInstructionOption:
986
987EmulatorInstructionOption
988-------------------------
989
990.. py:data:: eEmulateInstructionOptionNone
991.. py:data:: eEmulateInstructionOptionAutoAdvancePC
992.. py:data:: eEmulateInstructionOptionIgnoreConditions
993
994
995.. _FunctionNameType:
996
997FunctionNameType
998----------------
999
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
1007
1008
1009.. _BasicType:
1010
1011BasicType
1012---------
1013
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
1048
1049
1050.. _TraceType:
1051
1052TraceType
1053---------
1054
1055.. py:data:: eTraceTypeNone
1056.. py:data:: eTraceTypeProcessorTrace
1057
1058
1059.. _StructuredDataType:
1060
1061StructuredDataType
1062------------------
1063
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
1073
1074
1075.. _TypeClass:
1076
1077TypeClass
1078---------
1079
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
1101
1102
1103.. _TemplateArgument:
1104
1105TemplateArgument
1106----------------
1107
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
1118
1119
1120.. _TypeOption:
1121
1122TypeOption
1123----------
1124
1125Options that can be set for a formatter to alter its behavior. Not
1126all of these are applicable to all formatter types.
1127
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
1139
1140
1141
1142.. _FrameCompare:
1143
1144FrameCompare
1145------------
1146
1147This is the return value for frame comparisons.  If you are comparing frame
1148A to frame B the following cases arise:
1149
1150   1) When frame A pushes frame B (or a frame that ends up pushing
1151      B) A is Older than B.
1152
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.
1155
1156   3) When frame A and frame B have the same StackID, they are
1157      Equal.
1158
1159   4) When frame A and frame B have the same immediate parent
1160      frame, but are not equal, the comparison yields SameParent.
1161
1162   5) If the two frames are on different threads or processes the
1163      comparison is Invalid.
1164
1165   6) If for some reason we can't figure out what went on, we
1166      return Unknown.
1167
1168.. py:data:: eFrameCompareInvalid
1169.. py:data:: eFrameCompareUnknown
1170.. py:data:: eFrameCompareEqual
1171.. py:data:: eFrameCompareSameParent
1172.. py:data:: eFrameCompareYounger
1173.. py:data:: eFrameCompareOlder
1174
1175
1176.. _FilePermissions:
1177
1178FilePermissions
1179---------------
1180
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
1207
1208
1209.. _QueueItem:
1210
1211QueueItem
1212---------
1213.. py:data:: eQueueItemKindUnknown
1214.. py:data:: eQueueItemKindFunction
1215.. py:data:: eQueueItemKindBlock
1216
1217
1218.. _QueueKind:
1219
1220QueueKind
1221---------
1222
1223libdispatch aka Grand Central Dispatch (GCD) queues can be either
1224serial (executing on one thread) or concurrent (executing on
1225multiple threads).
1226
1227.. py:data:: eQueueKindUnknown
1228.. py:data:: eQueueKindSerial
1229.. py:data:: eQueueKindConcurrent
1230
1231
1232.. _ExpressionEvaluationPhase:
1233
1234ExpressionEvaluationPhase
1235-------------------------
1236
1237These are the cancellable stages of expression evaluation, passed
1238to the expression evaluation callback, so that you can interrupt
1239expression evaluation at the various points in its lifecycle.
1240
1241.. py:data:: eExpressionEvaluationParse
1242.. py:data:: eExpressionEvaluationIRGen
1243.. py:data:: eExpressionEvaluationExecution
1244.. py:data:: eExpressionEvaluationComplete
1245
1246
1247.. _WatchpointKind:
1248
1249WatchpointKind
1250--------------
1251
1252Indicates what types of events cause the watchpoint to fire. Used by Native
1253-Protocol-related classes.
1254
1255.. py:data:: eWatchpointKindWrite
1256.. py:data:: eWatchpointKindRead
1257
1258
1259.. _GdbSignal:
1260
1261GdbSignal
1262---------
1263
1264.. py:data:: eGdbSignalBadAccess
1265.. py:data:: eGdbSignalBadInstruction
1266.. py:data:: eGdbSignalArithmetic
1267.. py:data:: eGdbSignalEmulation
1268.. py:data:: eGdbSignalSoftware
1269.. py:data:: eGdbSignalBreakpoint
1270
1271.. _PathType:
1272
1273PathType
1274--------
1275
1276Used with `SBHostOS.GetLLDBPath` to find files that are
1277related to LLDB on the current host machine. Most files are
1278relative to LLDB or are in known locations.
1279
1280.. py:data:: ePathTypeLLDBShlibDir
1281
1282   The directory where the lldb.so (unix) or LLDB mach-o file in
1283   LLDB.framework (MacOSX) exists.
1284
1285.. py:data:: ePathTypeSupportExecutableDir
1286
1287   Find LLDB support executable directory (debugserver, etc).
1288
1289.. py:data:: ePathTypeHeaderDir
1290
1291   Find LLDB header file directory.
1292
1293.. py:data:: ePathTypePythonDir
1294
1295   Find Python modules (PYTHONPATH) directory.
1296
1297.. py:data:: ePathTypeLLDBSystemPlugins
1298
1299   System plug-ins directory
1300
1301.. py:data:: ePathTypeLLDBUserPlugins
1302
1303   User plug-ins directory
1304
1305.. py:data:: ePathTypeLLDBTempSystemDir
1306
1307   The LLDB temp directory for this system that will be cleaned up on exit.
1308
1309.. py:data:: ePathTypeGlobalLLDBTempSystemDir
1310
1311   The LLDB temp directory for this system, NOT cleaned up on a process
1312   exit.
1313
1314.. py:data:: ePathTypeClangDir
1315
1316   Find path to Clang builtin headers.
1317
1318
1319.. _MemberFunctionKind:
1320
1321MemberFunctionKind
1322------------------
1323
1324.. py:data:: eMemberFunctionKindUnknown
1325.. py:data:: eMemberFunctionKindConstructor
1326
1327   A function used to create instances.
1328
1329.. py:data:: eMemberFunctionKindDestructor
1330
1331   A function used to tear down existing instances.
1332
1333.. py:data:: eMemberFunctionKindInstanceMethod
1334
1335   A function that applies to a specific instance.
1336
1337.. py:data:: eMemberFunctionKindStaticMethod
1338
1339   A function that applies to a type rather than any instance,
1340
1341
1342.. _TypeFlags:
1343
1344TypeFlags
1345---------
1346
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
1359
1360
1361.. _CommandFlags:
1362
1363CommandFlags
1364---------------
1365
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
1375
1376
1377.. _TypeSummary:
1378
1379TypeSummary
1380-----------
1381
1382Whether a summary should cap how much data it returns to users or not.
1383
1384.. py:data:: eTypeSummaryCapped
1385.. py:data:: eTypeSummaryUncapped
1386
1387
1388.. _CommandInterpreterResult:
1389
1390CommandInterpreterResult
1391------------------------
1392
1393The result from a command interpreter run.
1394
1395.. py:data:: eCommandInterpreterResultSuccess
1396
1397   Command interpreter finished successfully.
1398
1399.. py:data:: eCommandInterpreterResultInferiorCrash
1400
1401   Stopped because the corresponding option was set and the inferior
1402   crashed.
1403
1404.. py:data:: eCommandInterpreterResultCommandError
1405
1406   Stopped because the corresponding option was set and a command returned
1407   an error.
1408
1409.. py:data:: eCommandInterpreterResultQuitRequested
1410
1411   Stopped because quit was requested.
1412
1413
1414.. _WatchPointValueKind:
1415
1416WatchPointValueKind
1417-------------------
1418
1419The type of value that the watchpoint was created to monitor.
1420
1421.. py:data:: eWatchPointValueKindInvalid
1422
1423   Invalid kind.
1424
1425.. py:data:: eWatchPointValueKindVariable
1426
1427   Watchpoint was created watching a variable
1428
1429.. py:data:: eWatchPointValueKindExpression
1430
1431   Watchpoint was created watching the result of an expression that was
1432   evaluated at creation time.
1433