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:: eLanguageTypeExtRenderScript
735.. py:data:: eNumLanguageTypes
736
737
738.. _InstrumentationRuntimeType:
739
740InstrumentationRuntimeType
741--------------------------
742
743.. py:data:: eInstrumentationRuntimeTypeAddressSanitizer
744.. py:data:: eInstrumentationRuntimeTypeThreadSanitizer
745.. py:data:: eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
746.. py:data:: eInstrumentationRuntimeTypeMainThreadChecker
747.. py:data:: eInstrumentationRuntimeTypeSwiftRuntimeReporting
748.. py:data:: eNumInstrumentationRuntimeTypes
749
750
751.. _DynamicValueType:
752
753DynamicValueType
754----------------
755
756.. py:data:: eNoDynamicValues
757.. py:data:: eDynamicCanRunTarget
758.. py:data:: eDynamicDontRunTarget
759
760
761.. _StopShowColumn:
762
763StopShowColumn
764--------------
765
766.. py:data:: eStopShowColumnAnsiOrCaret
767.. py:data:: eStopShowColumnAnsi
768.. py:data:: eStopShowColumnCaret
769.. py:data:: eStopShowColumnNone
770
771
772.. _AccessType:
773
774AccessType
775----------
776
777.. py:data:: eAccessNone
778.. py:data:: eAccessPublic
779.. py:data:: eAccessPrivate
780.. py:data:: eAccessProtected
781.. py:data:: eAccessPackage
782
783
784.. _CommandArgumentType:
785
786CommandArgumentType
787-------------------
788
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
878
879.. _SymbolType:
880
881SymbolType
882----------
883
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
914
915
916.. _SectionType:
917
918SectionType
919-----------
920
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
981
982
983.. _EmulatorInstructionOption:
984
985EmulatorInstructionOption
986-------------------------
987
988.. py:data:: eEmulateInstructionOptionNone
989.. py:data:: eEmulateInstructionOptionAutoAdvancePC
990.. py:data:: eEmulateInstructionOptionIgnoreConditions
991
992
993.. _FunctionNameType:
994
995FunctionNameType
996----------------
997
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
1005
1006
1007.. _BasicType:
1008
1009BasicType
1010---------
1011
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:: eBasicTypeShort
1023.. py:data:: eBasicTypeUnsignedShort
1024.. py:data:: eBasicTypeInt
1025.. py:data:: eBasicTypeUnsignedInt
1026.. py:data:: eBasicTypeLong
1027.. py:data:: eBasicTypeUnsignedLong
1028.. py:data:: eBasicTypeLongLong
1029.. py:data:: eBasicTypeUnsignedLongLong
1030.. py:data:: eBasicTypeInt128
1031.. py:data:: eBasicTypeUnsignedInt128
1032.. py:data:: eBasicTypeBool
1033.. py:data:: eBasicTypeHalf
1034.. py:data:: eBasicTypeFloat
1035.. py:data:: eBasicTypeDouble
1036.. py:data:: eBasicTypeLongDouble
1037.. py:data:: eBasicTypeFloatComplex
1038.. py:data:: eBasicTypeDoubleComplex
1039.. py:data:: eBasicTypeLongDoubleComplex
1040.. py:data:: eBasicTypeObjCID
1041.. py:data:: eBasicTypeObjCClass
1042.. py:data:: eBasicTypeObjCSel
1043.. py:data:: eBasicTypeNullPtr
1044.. py:data:: eBasicTypeOther
1045
1046
1047.. _TraceType:
1048
1049TraceType
1050---------
1051
1052.. py:data:: eTraceTypeNone
1053.. py:data:: eTraceTypeProcessorTrace
1054
1055
1056.. _StructuredDataType:
1057
1058StructuredDataType
1059------------------
1060
1061.. py:data:: eStructuredDataTypeInvalid
1062.. py:data:: eStructuredDataTypeNull
1063.. py:data:: eStructuredDataTypeGeneric
1064.. py:data:: eStructuredDataTypeArray
1065.. py:data:: eStructuredDataTypeInteger
1066.. py:data:: eStructuredDataTypeFloat
1067.. py:data:: eStructuredDataTypeBoolean
1068.. py:data:: eStructuredDataTypeString
1069.. py:data:: eStructuredDataTypeDictionary
1070
1071
1072.. _TypeClass:
1073
1074TypeClass
1075---------
1076
1077.. py:data:: eTypeClassInvalid
1078.. py:data:: eTypeClassArray
1079.. py:data:: eTypeClassBlockPointer
1080.. py:data:: eTypeClassBuiltin
1081.. py:data:: eTypeClassClass
1082.. py:data:: eTypeClassFloat
1083.. py:data:: eTypeClassComplexInteger
1084.. py:data:: eTypeClassComplexFloat
1085.. py:data:: eTypeClassFunction
1086.. py:data:: eTypeClassMemberPointer
1087.. py:data:: eTypeClassObjCObject
1088.. py:data:: eTypeClassObjCInterface
1089.. py:data:: eTypeClassObjCObjectPointer
1090.. py:data:: eTypeClassPointer
1091.. py:data:: eTypeClassReference
1092.. py:data:: eTypeClassStruct
1093.. py:data:: eTypeClassTypedef
1094.. py:data:: eTypeClassUnion
1095.. py:data:: eTypeClassVector
1096.. py:data:: eTypeClassOther
1097.. py:data:: eTypeClassAny
1098
1099
1100.. _TemplateArgument:
1101
1102TemplateArgument
1103----------------
1104
1105.. py:data:: eTemplateArgumentKindNull
1106.. py:data:: eTemplateArgumentKindType
1107.. py:data:: eTemplateArgumentKindDeclaration
1108.. py:data:: eTemplateArgumentKindIntegral
1109.. py:data:: eTemplateArgumentKindTemplate
1110.. py:data:: eTemplateArgumentKindTemplateExpansion
1111.. py:data:: eTemplateArgumentKindExpression
1112.. py:data:: eTemplateArgumentKindPack
1113.. py:data:: eTemplateArgumentKindNullPtr
1114.. py:data:: eTemplateArgumentKindUncommonValue
1115
1116
1117.. _TypeOption:
1118
1119TypeOption
1120----------
1121
1122Options that can be set for a formatter to alter its behavior. Not
1123all of these are applicable to all formatter types.
1124
1125.. py:data:: eTypeOptionNone
1126.. py:data:: eTypeOptionCascade
1127.. py:data:: eTypeOptionSkipPointers
1128.. py:data:: eTypeOptionSkipReferences
1129.. py:data:: eTypeOptionHideChildren
1130.. py:data:: eTypeOptionHideValue
1131.. py:data:: eTypeOptionShowOneLiner
1132.. py:data:: eTypeOptionHideNames
1133.. py:data:: eTypeOptionNonCacheable
1134.. py:data:: eTypeOptionHideEmptyAggregates
1135.. py:data:: eTypeOptionFrontEndWantsDereference
1136
1137
1138
1139.. _FrameCompare:
1140
1141FrameCompare
1142------------
1143
1144This is the return value for frame comparisons.  If you are comparing frame
1145A to frame B the following cases arise:
1146
1147   1) When frame A pushes frame B (or a frame that ends up pushing
1148      B) A is Older than B.
1149
1150   2) When frame A pushed frame B (or if frameA is on the stack
1151      but B is not) A is Younger than B.
1152
1153   3) When frame A and frame B have the same StackID, they are
1154      Equal.
1155
1156   4) When frame A and frame B have the same immediate parent
1157      frame, but are not equal, the comparison yields SameParent.
1158
1159   5) If the two frames are on different threads or processes the
1160      comparison is Invalid.
1161
1162   6) If for some reason we can't figure out what went on, we
1163      return Unknown.
1164
1165.. py:data:: eFrameCompareInvalid
1166.. py:data:: eFrameCompareUnknown
1167.. py:data:: eFrameCompareEqual
1168.. py:data:: eFrameCompareSameParent
1169.. py:data:: eFrameCompareYounger
1170.. py:data:: eFrameCompareOlder
1171
1172
1173.. _FilePermissions:
1174
1175FilePermissions
1176---------------
1177
1178.. py:data:: eFilePermissionsUserRead
1179.. py:data:: eFilePermissionsUserWrite
1180.. py:data:: eFilePermissionsUserExecute
1181.. py:data:: eFilePermissionsGroupRead
1182.. py:data:: eFilePermissionsGroupWrite
1183.. py:data:: eFilePermissionsGroupExecute
1184.. py:data:: eFilePermissionsWorldRead
1185.. py:data:: eFilePermissionsWorldWrite
1186.. py:data:: eFilePermissionsWorldExecute
1187.. py:data:: eFilePermissionsUserRW
1188.. py:data:: eFileFilePermissionsUserRX
1189.. py:data:: eFilePermissionsUserRWX
1190.. py:data:: eFilePermissionsGroupRW
1191.. py:data:: eFilePermissionsGroupRX
1192.. py:data:: eFilePermissionsGroupRWX
1193.. py:data:: eFilePermissionsWorldRW
1194.. py:data:: eFilePermissionsWorldRX
1195.. py:data:: eFilePermissionsWorldRWX
1196.. py:data:: eFilePermissionsEveryoneR
1197.. py:data:: eFilePermissionsEveryoneW
1198.. py:data:: eFilePermissionsEveryoneX
1199.. py:data:: eFilePermissionsEveryoneRW
1200.. py:data:: eFilePermissionsEveryoneRX
1201.. py:data:: eFilePermissionsEveryoneRWX
1202.. py:data:: eFilePermissionsFileDefault = eFilePermissionsUserRW,
1203.. py:data:: eFilePermissionsDirectoryDefault
1204
1205
1206.. _QueueItem:
1207
1208QueueItem
1209---------
1210.. py:data:: eQueueItemKindUnknown
1211.. py:data:: eQueueItemKindFunction
1212.. py:data:: eQueueItemKindBlock
1213
1214
1215.. _QueueKind:
1216
1217QueueKind
1218---------
1219
1220libdispatch aka Grand Central Dispatch (GCD) queues can be either
1221serial (executing on one thread) or concurrent (executing on
1222multiple threads).
1223
1224.. py:data:: eQueueKindUnknown
1225.. py:data:: eQueueKindSerial
1226.. py:data:: eQueueKindConcurrent
1227
1228
1229.. _ExpressionEvaluationPhase:
1230
1231ExpressionEvaluationPhase
1232-------------------------
1233
1234These are the cancellable stages of expression evaluation, passed
1235to the expression evaluation callback, so that you can interrupt
1236expression evaluation at the various points in its lifecycle.
1237
1238.. py:data:: eExpressionEvaluationParse
1239.. py:data:: eExpressionEvaluationIRGen
1240.. py:data:: eExpressionEvaluationExecution
1241.. py:data:: eExpressionEvaluationComplete
1242
1243
1244.. _WatchpointKind:
1245
1246WatchpointKind
1247--------------
1248
1249Indicates what types of events cause the watchpoint to fire. Used by Native
1250-Protocol-related classes.
1251
1252.. py:data:: eWatchpointKindWrite
1253.. py:data:: eWatchpointKindRead
1254
1255
1256.. _GdbSignal:
1257
1258GdbSignal
1259---------
1260
1261.. py:data:: eGdbSignalBadAccess
1262.. py:data:: eGdbSignalBadInstruction
1263.. py:data:: eGdbSignalArithmetic
1264.. py:data:: eGdbSignalEmulation
1265.. py:data:: eGdbSignalSoftware
1266.. py:data:: eGdbSignalBreakpoint
1267
1268.. _PathType:
1269
1270PathType
1271--------
1272
1273Used with `SBHostOS.GetLLDBPath` to find files that are
1274related to LLDB on the current host machine. Most files are
1275relative to LLDB or are in known locations.
1276
1277.. py:data:: ePathTypeLLDBShlibDir
1278
1279   The directory where the lldb.so (unix) or LLDB mach-o file in
1280   LLDB.framework (MacOSX) exists.
1281
1282.. py:data:: ePathTypeSupportExecutableDir
1283
1284   Find LLDB support executable directory (debugserver, etc).
1285
1286.. py:data:: ePathTypeHeaderDir
1287
1288   Find LLDB header file directory.
1289
1290.. py:data:: ePathTypePythonDir
1291
1292   Find Python modules (PYTHONPATH) directory.
1293
1294.. py:data:: ePathTypeLLDBSystemPlugins
1295
1296   System plug-ins directory
1297
1298.. py:data:: ePathTypeLLDBUserPlugins
1299
1300   User plug-ins directory
1301
1302.. py:data:: ePathTypeLLDBTempSystemDir
1303
1304   The LLDB temp directory for this system that will be cleaned up on exit.
1305
1306.. py:data:: ePathTypeGlobalLLDBTempSystemDir
1307
1308   The LLDB temp directory for this system, NOT cleaned up on a process
1309   exit.
1310
1311.. py:data:: ePathTypeClangDir
1312
1313   Find path to Clang builtin headers.
1314
1315
1316.. _MemberFunctionKind:
1317
1318MemberFunctionKind
1319------------------
1320
1321.. py:data:: eMemberFunctionKindUnknown
1322.. py:data:: eMemberFunctionKindConstructor
1323
1324   A function used to create instances.
1325
1326.. py:data:: eMemberFunctionKindDestructor
1327
1328   A function used to tear down existing instances.
1329
1330.. py:data:: eMemberFunctionKindInstanceMethod
1331
1332   A function that applies to a specific instance.
1333
1334.. py:data:: eMemberFunctionKindStaticMethod
1335
1336   A function that applies to a type rather than any instance,
1337
1338
1339.. _TypeFlags:
1340
1341TypeFlags
1342---------
1343
1344.. py:data:: eTypeHasChildren
1345.. py:data:: eTypeIsArray
1346.. py:data:: eTypeIsBuiltIn
1347.. py:data:: eTypeIsCPlusPlus
1348.. py:data:: eTypeIsFuncPrototype
1349.. py:data:: eTypeIsObjC
1350.. py:data:: eTypeIsReference
1351.. py:data:: eTypeIsTemplate
1352.. py:data:: eTypeIsVector
1353.. py:data:: eTypeIsInteger
1354.. py:data:: eTypeIsComplex
1355.. py:data:: eTypeInstanceIsPointer
1356
1357
1358.. _CommandFlags:
1359
1360CommandFlags
1361---------------
1362
1363.. py:data:: eCommandRequiresTarget
1364.. py:data:: eCommandRequiresProcess
1365.. py:data:: eCommandRequiresThread
1366.. py:data:: eCommandRequiresFrame
1367.. py:data:: eCommandRequiresRegContext
1368.. py:data:: eCommandTryTargetAPILock
1369.. py:data:: eCommandProcessMustBeLaunched
1370.. py:data:: eCommandProcessMustBePaused
1371.. py:data:: eCommandProcessMustBeTraced
1372
1373
1374.. _TypeSummary:
1375
1376TypeSummary
1377-----------
1378
1379Whether a summary should cap how much data it returns to users or not.
1380
1381.. py:data:: eTypeSummaryCapped
1382.. py:data:: eTypeSummaryUncapped
1383
1384
1385.. _CommandInterpreterResult:
1386
1387CommandInterpreterResult
1388------------------------
1389
1390The result from a command interpreter run.
1391
1392.. py:data:: eCommandInterpreterResultSuccess
1393
1394   Command interpreter finished successfully.
1395
1396.. py:data:: eCommandInterpreterResultInferiorCrash
1397
1398   Stopped because the corresponding option was set and the inferior
1399   crashed.
1400
1401.. py:data:: eCommandInterpreterResultCommandError
1402
1403   Stopped because the corresponding option was set and a command returned
1404   an error.
1405
1406.. py:data:: eCommandInterpreterResultQuitRequested
1407
1408   Stopped because quit was requested.
1409