karellen-llvm-lldb 20.1.7.post16__cp313-cp313-manylinux2014_x86_64.whl → 21.1.0__cp313-cp313-manylinux2014_x86_64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of karellen-llvm-lldb might be problematic. Click here for more details.

Files changed (44) hide show
  1. karellen_llvm_lldb-21.1.0.data/data/bin/lldb +0 -0
  2. karellen_llvm_lldb-21.1.0.data/data/bin/lldb-argdumper +0 -0
  3. karellen_llvm_lldb-21.1.0.data/data/bin/lldb-dap +0 -0
  4. karellen_llvm_lldb-21.1.0.data/data/bin/lldb-instr +0 -0
  5. karellen_llvm_lldb-21.1.0.data/data/bin/lldb-server +0 -0
  6. karellen_llvm_lldb-20.1.7.post16.data/data/lib/liblldb.so.20.1.7 → karellen_llvm_lldb-21.1.0.data/data/lib/liblldb.so.21.1.0 +0 -0
  7. karellen_llvm_lldb-21.1.0.data/data/lib/liblldbIntelFeatures.so.21.1 +0 -0
  8. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/__init__.py +2631 -592
  9. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/cpp/libcxx.py +9 -5
  10. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/scripted_process.py +1 -1
  11. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/utils/symbolication.py +3 -3
  12. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/METADATA +2 -2
  13. karellen_llvm_lldb-21.1.0.dist-info/RECORD +36 -0
  14. karellen_llvm_lldb-21.1.0.dist-info/symlinks.txt +5 -0
  15. karellen_llvm_lldb-20.1.7.post16.data/data/bin/lldb +0 -0
  16. karellen_llvm_lldb-20.1.7.post16.data/data/bin/lldb-argdumper +0 -0
  17. karellen_llvm_lldb-20.1.7.post16.data/data/bin/lldb-dap +0 -0
  18. karellen_llvm_lldb-20.1.7.post16.data/data/bin/lldb-instr +0 -0
  19. karellen_llvm_lldb-20.1.7.post16.data/data/bin/lldb-server +0 -0
  20. karellen_llvm_lldb-20.1.7.post16.data/data/lib/liblldbIntelFeatures.so.20.1 +0 -0
  21. karellen_llvm_lldb-20.1.7.post16.dist-info/RECORD +0 -36
  22. karellen_llvm_lldb-20.1.7.post16.dist-info/symlinks.txt +0 -5
  23. /karellen_llvm_lldb-20.1.7.post16.data/purelib/karellen_llvm_lldb-20.1.7.post16.pth → /karellen_llvm_lldb-21.1.0.data/purelib/karellen_llvm_lldb-21.1.0.pth +0 -0
  24. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/embedded_interpreter.py +0 -0
  25. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/Logger.py +0 -0
  26. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/__init__.py +0 -0
  27. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/attrib_fromdict.py +0 -0
  28. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/cache.py +0 -0
  29. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/cpp/__init__.py +0 -0
  30. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/cpp/gnu_libstdcpp.py +0 -0
  31. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/metrics.py +0 -0
  32. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/formatters/synth.py +0 -0
  33. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/__init__.py +0 -0
  34. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/operating_system.py +0 -0
  35. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/parsed_cmd.py +0 -0
  36. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/scripted_platform.py +0 -0
  37. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/plugins/scripted_thread_plan.py +0 -0
  38. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/utils/__init__.py +0 -0
  39. {karellen_llvm_lldb-20.1.7.post16.data → karellen_llvm_lldb-21.1.0.data}/purelib/lldb/utils/in_call_stack.py +0 -0
  40. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/WHEEL +0 -0
  41. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/axle.lck +0 -0
  42. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/namespace_packages.txt +0 -0
  43. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/require-libpython +0 -0
  44. {karellen_llvm_lldb-20.1.7.post16.dist-info → karellen_llvm_lldb-21.1.0.dist-info}/top_level.txt +0 -0
@@ -164,7 +164,7 @@ LLDB_REGNUM_GENERIC_ARG8 = _lldb.LLDB_REGNUM_GENERIC_ARG8
164
164
  LLDB_REGNUM_GENERIC_TP = _lldb.LLDB_REGNUM_GENERIC_TP
165
165
 
166
166
  LLDB_INVALID_STOP_ID = _lldb.LLDB_INVALID_STOP_ID
167
-
167
+ r"""Invalid value definitions"""
168
168
  LLDB_INVALID_ADDRESS = _lldb.LLDB_INVALID_ADDRESS
169
169
 
170
170
  LLDB_INVALID_INDEX32 = _lldb.LLDB_INVALID_INDEX32
@@ -200,7 +200,7 @@ LLDB_INVALID_CPU_ID = _lldb.LLDB_INVALID_CPU_ID
200
200
  LLDB_INVALID_WATCHPOINT_RESOURCE_ID = _lldb.LLDB_INVALID_WATCHPOINT_RESOURCE_ID
201
201
 
202
202
  LLDB_ARCH_DEFAULT = _lldb.LLDB_ARCH_DEFAULT
203
-
203
+ r"""CPU Type definitions"""
204
204
  LLDB_ARCH_DEFAULT_32BIT = _lldb.LLDB_ARCH_DEFAULT_32BIT
205
205
 
206
206
  LLDB_ARCH_DEFAULT_64BIT = _lldb.LLDB_ARCH_DEFAULT_64BIT
@@ -208,7 +208,7 @@ LLDB_ARCH_DEFAULT_64BIT = _lldb.LLDB_ARCH_DEFAULT_64BIT
208
208
  LLDB_INVALID_CPUTYPE = _lldb.LLDB_INVALID_CPUTYPE
209
209
 
210
210
  LLDB_MAX_NUM_OPTION_SETS = _lldb.LLDB_MAX_NUM_OPTION_SETS
211
-
211
+ r"""Option Set definitions"""
212
212
  LLDB_OPT_SET_ALL = _lldb.LLDB_OPT_SET_ALL
213
213
 
214
214
  LLDB_OPT_SET_1 = _lldb.LLDB_OPT_SET_1
@@ -236,67 +236,94 @@ LLDB_OPT_SET_11 = _lldb.LLDB_OPT_SET_11
236
236
  LLDB_OPT_SET_12 = _lldb.LLDB_OPT_SET_12
237
237
 
238
238
  LLDB_INVALID_ADDRESS_MASK = _lldb.LLDB_INVALID_ADDRESS_MASK
239
-
239
+ r"""
240
+ Address Mask
241
+ Bits not used for addressing are set to 1 in the mask;
242
+ all mask bits set is an invalid value.
243
+ """
240
244
  eStateInvalid = _lldb.eStateInvalid
241
245
 
242
246
  eStateUnloaded = _lldb.eStateUnloaded
243
-
247
+ r"""Process is object is valid, but not currently loaded"""
244
248
  eStateConnected = _lldb.eStateConnected
245
-
249
+ r"""Process is connected to remote debug services, but not"""
246
250
  eStateAttaching = _lldb.eStateAttaching
247
-
251
+ r"""launched or attached to anything yet Process is currently trying to attach"""
248
252
  eStateLaunching = _lldb.eStateLaunching
249
-
253
+ r"""Process is in the process of launching"""
250
254
  eStateStopped = _lldb.eStateStopped
251
-
255
+ r"""Process or thread is stopped and can be examined."""
252
256
  eStateRunning = _lldb.eStateRunning
253
-
257
+ r"""Process or thread is running and can't be examined."""
254
258
  eStateStepping = _lldb.eStateStepping
255
-
259
+ r"""Process or thread is in the process of stepping and can"""
256
260
  eStateCrashed = _lldb.eStateCrashed
257
-
261
+ r"""not be examined. Process or thread has crashed and can be examined."""
258
262
  eStateDetached = _lldb.eStateDetached
259
-
263
+ r"""Process has been detached and can't be examined."""
260
264
  eStateExited = _lldb.eStateExited
261
-
265
+ r"""Process has exited and can't be examined."""
262
266
  eStateSuspended = _lldb.eStateSuspended
263
-
267
+ r"""
268
+ Process or thread is in a suspended state as far
269
+ as the debugger is concerned while other processes
270
+ or threads get the chance to run.
271
+ """
264
272
  kLastStateType = _lldb.kLastStateType
265
273
 
266
274
  eLaunchFlagNone = _lldb.eLaunchFlagNone
267
275
 
268
276
  eLaunchFlagExec = _lldb.eLaunchFlagExec
269
-
277
+ r"""Exec when launching and turn the calling"""
270
278
  eLaunchFlagDebug = _lldb.eLaunchFlagDebug
271
-
279
+ r"""process into a new process Stop as soon as the process launches to"""
272
280
  eLaunchFlagStopAtEntry = _lldb.eLaunchFlagStopAtEntry
273
-
281
+ r"""allow the process to be debugged Stop at the program entry point"""
274
282
  eLaunchFlagDisableASLR = _lldb.eLaunchFlagDisableASLR
275
-
283
+ r"""
284
+ instead of auto-continuing when
285
+ launching or attaching at entry point Disable Address Space Layout Randomization
286
+ """
276
287
  eLaunchFlagDisableSTDIO = _lldb.eLaunchFlagDisableSTDIO
277
-
288
+ r"""Disable stdio for inferior process (e.g. for a GUI app)"""
278
289
  eLaunchFlagLaunchInTTY = _lldb.eLaunchFlagLaunchInTTY
279
-
290
+ r"""Launch the process in a new TTY if supported by the host"""
280
291
  eLaunchFlagLaunchInShell = _lldb.eLaunchFlagLaunchInShell
281
-
292
+ r"""Launch the process inside a shell to get shell expansion"""
282
293
  eLaunchFlagLaunchInSeparateProcessGroup = _lldb.eLaunchFlagLaunchInSeparateProcessGroup
283
-
294
+ r"""
295
+ Launch the process in a separate process group
296
+ If you are going to hand the process off (e.g. to
297
+ debugserver)
298
+ """
284
299
  eLaunchFlagDontSetExitStatus = _lldb.eLaunchFlagDontSetExitStatus
285
-
300
+ r"""set this flag so lldb & the handee don't race to set its exit status."""
286
301
  eLaunchFlagDetachOnError = _lldb.eLaunchFlagDetachOnError
287
-
302
+ r"""
303
+ If set, then the client stub
304
+ should detach rather than killing
305
+ the debugee
306
+ if it loses connection with lldb.
307
+ """
288
308
  eLaunchFlagShellExpandArguments = _lldb.eLaunchFlagShellExpandArguments
289
-
309
+ r"""Perform shell-style argument expansion"""
290
310
  eLaunchFlagCloseTTYOnExit = _lldb.eLaunchFlagCloseTTYOnExit
291
-
311
+ r"""Close the open TTY on exit"""
292
312
  eLaunchFlagInheritTCCFromParent = _lldb.eLaunchFlagInheritTCCFromParent
293
-
313
+ r"""
314
+ Don't make the inferior responsible for its own TCC
315
+ permissions but instead inherit them from its parent.
316
+ """
294
317
  eOnlyThisThread = _lldb.eOnlyThisThread
295
318
 
296
319
  eAllThreads = _lldb.eAllThreads
297
320
 
298
321
  eOnlyDuringStepping = _lldb.eOnlyDuringStepping
299
322
 
323
+ eRunForward = _lldb.eRunForward
324
+
325
+ eRunReverse = _lldb.eRunReverse
326
+
300
327
  eByteOrderInvalid = _lldb.eByteOrderInvalid
301
328
 
302
329
  eByteOrderBig = _lldb.eByteOrderBig
@@ -308,13 +335,13 @@ eByteOrderLittle = _lldb.eByteOrderLittle
308
335
  eEncodingInvalid = _lldb.eEncodingInvalid
309
336
 
310
337
  eEncodingUint = _lldb.eEncodingUint
311
-
338
+ r"""unsigned integer"""
312
339
  eEncodingSint = _lldb.eEncodingSint
313
-
340
+ r"""signed integer"""
314
341
  eEncodingIEEE754 = _lldb.eEncodingIEEE754
315
-
342
+ r"""float"""
316
343
  eEncodingVector = _lldb.eEncodingVector
317
-
344
+ r"""vector registers"""
318
345
  eFormatDefault = _lldb.eFormatDefault
319
346
 
320
347
  eFormatInvalid = _lldb.eFormatInvalid
@@ -330,13 +357,13 @@ eFormatBytesWithASCII = _lldb.eFormatBytesWithASCII
330
357
  eFormatChar = _lldb.eFormatChar
331
358
 
332
359
  eFormatCharPrintable = _lldb.eFormatCharPrintable
333
-
360
+ r"""Only printable characters, '.' if not printable"""
334
361
  eFormatComplex = _lldb.eFormatComplex
335
-
362
+ r"""Floating point complex type"""
336
363
  eFormatComplexFloat = _lldb.eFormatComplexFloat
337
364
 
338
365
  eFormatCString = _lldb.eFormatCString
339
-
366
+ r"""NULL terminated C strings"""
340
367
  eFormatDecimal = _lldb.eFormatDecimal
341
368
 
342
369
  eFormatEnum = _lldb.eFormatEnum
@@ -350,7 +377,10 @@ eFormatFloat = _lldb.eFormatFloat
350
377
  eFormatOctal = _lldb.eFormatOctal
351
378
 
352
379
  eFormatOSType = _lldb.eFormatOSType
353
-
380
+ r"""
381
+ OS character codes encoded into an integer 'PICT' 'text'
382
+ etc...
383
+ """
354
384
  eFormatUnicode16 = _lldb.eFormatUnicode16
355
385
 
356
386
  eFormatUnicode32 = _lldb.eFormatUnicode32
@@ -386,17 +416,24 @@ eFormatVectorOfFloat64 = _lldb.eFormatVectorOfFloat64
386
416
  eFormatVectorOfUInt128 = _lldb.eFormatVectorOfUInt128
387
417
 
388
418
  eFormatComplexInteger = _lldb.eFormatComplexInteger
389
-
419
+ r"""Integer complex type"""
390
420
  eFormatCharArray = _lldb.eFormatCharArray
391
-
421
+ r"""
422
+ Print characters with no single quotes, used for
423
+ character arrays that can contain non printable
424
+ characters
425
+ """
392
426
  eFormatAddressInfo = _lldb.eFormatAddressInfo
393
-
427
+ r"""
428
+ Describe what an address points to (func + offset
429
+ with file/line, symbol + offset, data, etc)
430
+ """
394
431
  eFormatHexFloat = _lldb.eFormatHexFloat
395
-
432
+ r"""ISO C99 hex float string"""
396
433
  eFormatInstruction = _lldb.eFormatInstruction
397
-
434
+ r"""Disassemble an opcode"""
398
435
  eFormatVoid = _lldb.eFormatVoid
399
-
436
+ r"""Do not print this"""
400
437
  eFormatUnicode8 = _lldb.eFormatUnicode8
401
438
 
402
439
  kNumFormats = _lldb.kNumFormats
@@ -422,15 +459,21 @@ eScriptLanguageUnknown = _lldb.eScriptLanguageUnknown
422
459
  eScriptLanguageDefault = _lldb.eScriptLanguageDefault
423
460
 
424
461
  eRegisterKindEHFrame = _lldb.eRegisterKindEHFrame
425
-
462
+ r"""the register numbers seen in eh_frame"""
426
463
  eRegisterKindDWARF = _lldb.eRegisterKindDWARF
427
-
464
+ r"""the register numbers seen DWARF"""
428
465
  eRegisterKindGeneric = _lldb.eRegisterKindGeneric
429
-
466
+ r"""
467
+ insn ptr reg, stack ptr reg, etc not specific to
468
+ any particular target
469
+ """
430
470
  eRegisterKindProcessPlugin = _lldb.eRegisterKindProcessPlugin
431
-
471
+ r"""
472
+ num used by the process plugin - e.g. by the
473
+ remote gdb-protocol stub program
474
+ """
432
475
  eRegisterKindLLDB = _lldb.eRegisterKindLLDB
433
-
476
+ r"""lldb's internal register numbers"""
434
477
  kNumRegisterKinds = _lldb.kNumRegisterKinds
435
478
 
436
479
  eStopReasonInvalid = _lldb.eStopReasonInvalid
@@ -448,7 +491,7 @@ eStopReasonSignal = _lldb.eStopReasonSignal
448
491
  eStopReasonException = _lldb.eStopReasonException
449
492
 
450
493
  eStopReasonExec = _lldb.eStopReasonExec
451
-
494
+ r"""Program was re-exec'ed"""
452
495
  eStopReasonPlanComplete = _lldb.eStopReasonPlanComplete
453
496
 
454
497
  eStopReasonThreadExiting = _lldb.eStopReasonThreadExiting
@@ -464,6 +507,8 @@ eStopReasonVFork = _lldb.eStopReasonVFork
464
507
  eStopReasonVForkDone = _lldb.eStopReasonVForkDone
465
508
 
466
509
  eStopReasonInterrupt = _lldb.eStopReasonInterrupt
510
+ r"""Thread requested interrupt"""
511
+ eStopReasonHistoryBoundary = _lldb.eStopReasonHistoryBoundary
467
512
 
468
513
  eReturnStatusInvalid = _lldb.eReturnStatusInvalid
469
514
 
@@ -518,53 +563,56 @@ eSearchDepthAddress = _lldb.eSearchDepthAddress
518
563
  kLastSearchDepthKind = _lldb.kLastSearchDepthKind
519
564
 
520
565
  eConnectionStatusSuccess = _lldb.eConnectionStatusSuccess
521
-
566
+ r"""Success"""
522
567
  eConnectionStatusEndOfFile = _lldb.eConnectionStatusEndOfFile
523
-
568
+ r"""End-of-file encountered"""
524
569
  eConnectionStatusError = _lldb.eConnectionStatusError
525
-
570
+ r"""Check GetError() for details"""
526
571
  eConnectionStatusTimedOut = _lldb.eConnectionStatusTimedOut
527
-
572
+ r"""Request timed out"""
528
573
  eConnectionStatusNoConnection = _lldb.eConnectionStatusNoConnection
529
-
574
+ r"""No connection"""
530
575
  eConnectionStatusLostConnection = _lldb.eConnectionStatusLostConnection
531
-
576
+ r"""
577
+ Lost connection while connected to a
578
+ valid connection
579
+ """
532
580
  eConnectionStatusInterrupted = _lldb.eConnectionStatusInterrupted
533
-
581
+ r"""Interrupted read"""
534
582
  eErrorTypeInvalid = _lldb.eErrorTypeInvalid
535
583
 
536
584
  eErrorTypeGeneric = _lldb.eErrorTypeGeneric
537
-
585
+ r"""Generic errors that can be any value."""
538
586
  eErrorTypeMachKernel = _lldb.eErrorTypeMachKernel
539
-
587
+ r"""Mach kernel error codes."""
540
588
  eErrorTypePOSIX = _lldb.eErrorTypePOSIX
541
-
589
+ r"""POSIX error codes."""
542
590
  eErrorTypeExpression = _lldb.eErrorTypeExpression
543
-
591
+ r"""These are from the ExpressionResults enum."""
544
592
  eErrorTypeWin32 = _lldb.eErrorTypeWin32
545
-
593
+ r"""Standard Win32 error codes."""
546
594
  eValueTypeInvalid = _lldb.eValueTypeInvalid
547
595
 
548
596
  eValueTypeVariableGlobal = _lldb.eValueTypeVariableGlobal
549
-
597
+ r"""globals variable"""
550
598
  eValueTypeVariableStatic = _lldb.eValueTypeVariableStatic
551
-
599
+ r"""static variable"""
552
600
  eValueTypeVariableArgument = _lldb.eValueTypeVariableArgument
553
-
601
+ r"""function argument variables"""
554
602
  eValueTypeVariableLocal = _lldb.eValueTypeVariableLocal
555
-
603
+ r"""function local variables"""
556
604
  eValueTypeRegister = _lldb.eValueTypeRegister
557
-
605
+ r"""stack frame register value"""
558
606
  eValueTypeRegisterSet = _lldb.eValueTypeRegisterSet
559
-
607
+ r"""A collection of stack frame register values"""
560
608
  eValueTypeConstResult = _lldb.eValueTypeConstResult
561
-
609
+ r"""constant result variables"""
562
610
  eValueTypeVariableThreadLocal = _lldb.eValueTypeVariableThreadLocal
563
-
611
+ r"""thread local storage variable"""
564
612
  eValueTypeVTable = _lldb.eValueTypeVTable
565
-
613
+ r"""virtual function table"""
566
614
  eValueTypeVTableEntry = _lldb.eValueTypeVTableEntry
567
-
615
+ r"""function pointer in virtual function table"""
568
616
  eInputReaderGranularityInvalid = _lldb.eInputReaderGranularityInvalid
569
617
 
570
618
  eInputReaderGranularityByte = _lldb.eInputReaderGranularityByte
@@ -576,23 +624,54 @@ eInputReaderGranularityLine = _lldb.eInputReaderGranularityLine
576
624
  eInputReaderGranularityAll = _lldb.eInputReaderGranularityAll
577
625
 
578
626
  eSymbolContextTarget = _lldb.eSymbolContextTarget
579
-
627
+ r"""
628
+ Set when *target* is requested from a query, or was located
629
+ in query results
630
+ """
580
631
  eSymbolContextModule = _lldb.eSymbolContextModule
581
-
632
+ r"""
633
+ Set when *module* is requested from a query, or was located
634
+ in query results
635
+ """
582
636
  eSymbolContextCompUnit = _lldb.eSymbolContextCompUnit
583
-
637
+ r"""
638
+ Set when *comp_unit* is requested from a query, or was
639
+ located in query results
640
+ """
584
641
  eSymbolContextFunction = _lldb.eSymbolContextFunction
585
-
642
+ r"""
643
+ Set when *function* is requested from a query, or was located
644
+ in query results
645
+ """
586
646
  eSymbolContextBlock = _lldb.eSymbolContextBlock
587
-
647
+ r"""
648
+ Set when the deepest *block* is requested from a query, or
649
+ was located in query results
650
+ """
588
651
  eSymbolContextLineEntry = _lldb.eSymbolContextLineEntry
589
-
652
+ r"""
653
+ Set when *line_entry* is requested from a query, or was
654
+ located in query results
655
+ """
590
656
  eSymbolContextSymbol = _lldb.eSymbolContextSymbol
591
-
657
+ r"""
658
+ Set when *symbol* is requested from a query, or was located
659
+ in query results
660
+ """
592
661
  eSymbolContextEverything = _lldb.eSymbolContextEverything
593
-
662
+ r"""
663
+ Indicates to try and lookup everything up during a routine
664
+ symbol context query.
665
+ """
594
666
  eSymbolContextVariable = _lldb.eSymbolContextVariable
595
-
667
+ r"""
668
+ Set when *global* or static variable is requested from a
669
+ query, or was located in query results.
670
+ eSymbolContextVariable is potentially expensive to lookup so
671
+ it isn't included in eSymbolContextEverything which stops it
672
+ from being used during frame PC lookups and many other
673
+ potential address to symbol context lookups.
674
+ """
596
675
  eSymbolContextLastItem = _lldb.eSymbolContextLastItem
597
676
 
598
677
  ePermissionsWritable = _lldb.ePermissionsWritable
@@ -602,21 +681,34 @@ ePermissionsReadable = _lldb.ePermissionsReadable
602
681
  ePermissionsExecutable = _lldb.ePermissionsExecutable
603
682
 
604
683
  eInputReaderActivate = _lldb.eInputReaderActivate
605
-
684
+ r"""reader is newly pushed onto the reader stack"""
606
685
  eInputReaderAsynchronousOutputWritten = _lldb.eInputReaderAsynchronousOutputWritten
607
-
686
+ r"""
687
+ an async output event occurred;
688
+ the reader may want to do
689
+ something
690
+ """
608
691
  eInputReaderReactivate = _lldb.eInputReaderReactivate
609
-
692
+ r"""
693
+ reader is on top of the stack again after another
694
+ reader was popped off
695
+ """
610
696
  eInputReaderDeactivate = _lldb.eInputReaderDeactivate
611
-
697
+ r"""another reader was pushed on the stack"""
612
698
  eInputReaderGotToken = _lldb.eInputReaderGotToken
613
-
699
+ r"""reader got one of its tokens (granularity)"""
614
700
  eInputReaderInterrupt = _lldb.eInputReaderInterrupt
615
-
701
+ r"""
702
+ reader received an interrupt signal (probably from
703
+ a control-c)
704
+ """
616
705
  eInputReaderEndOfFile = _lldb.eInputReaderEndOfFile
617
-
706
+ r"""
707
+ reader received an EOF char (probably from a
708
+ control-d)
709
+ """
618
710
  eInputReaderDone = _lldb.eInputReaderDone
619
-
711
+ r"""reader was just popped off the stack and is done"""
620
712
  eBreakpointEventTypeInvalidType = _lldb.eBreakpointEventTypeInvalidType
621
713
 
622
714
  eBreakpointEventTypeAdded = _lldb.eBreakpointEventTypeAdded
@@ -624,7 +716,11 @@ eBreakpointEventTypeAdded = _lldb.eBreakpointEventTypeAdded
624
716
  eBreakpointEventTypeRemoved = _lldb.eBreakpointEventTypeRemoved
625
717
 
626
718
  eBreakpointEventTypeLocationsAdded = _lldb.eBreakpointEventTypeLocationsAdded
627
-
719
+ r"""
720
+ Locations added doesn't
721
+ get sent when the
722
+ breakpoint is created
723
+ """
628
724
  eBreakpointEventTypeLocationsRemoved = _lldb.eBreakpointEventTypeLocationsRemoved
629
725
 
630
726
  eBreakpointEventTypeLocationsResolved = _lldb.eBreakpointEventTypeLocationsResolved
@@ -664,83 +760,93 @@ eWatchpointEventTypeThreadChanged = _lldb.eWatchpointEventTypeThreadChanged
664
760
  eWatchpointEventTypeTypeChanged = _lldb.eWatchpointEventTypeTypeChanged
665
761
 
666
762
  eWatchpointWriteTypeDisabled = _lldb.eWatchpointWriteTypeDisabled
667
-
763
+ r"""Don't stop when the watched memory region is written to."""
668
764
  eWatchpointWriteTypeAlways = _lldb.eWatchpointWriteTypeAlways
669
-
765
+ r"""
766
+ Stop on any write access to the memory region, even if
767
+ the value doesn't change. On some architectures, a write
768
+ near the memory region may be falsely reported as a match,
769
+ and notify this spurious stop as a watchpoint trap.
770
+ """
670
771
  eWatchpointWriteTypeOnModify = _lldb.eWatchpointWriteTypeOnModify
671
-
772
+ r"""
773
+ Stop on a write to the memory region that changes its value.
774
+ This is most likely the behavior a user expects, and is the
775
+ behavior in gdb. lldb can silently ignore writes near the
776
+ watched memory region that are reported as accesses to lldb.
777
+ """
672
778
  eLanguageTypeUnknown = _lldb.eLanguageTypeUnknown
673
-
779
+ r"""Unknown or invalid language value."""
674
780
  eLanguageTypeC89 = _lldb.eLanguageTypeC89
675
-
781
+ r"""ISO C:1989."""
676
782
  eLanguageTypeC = _lldb.eLanguageTypeC
677
-
783
+ r"""Non-standardized C, such as K&R."""
678
784
  eLanguageTypeAda83 = _lldb.eLanguageTypeAda83
679
-
785
+ r"""ISO Ada:1983."""
680
786
  eLanguageTypeC_plus_plus = _lldb.eLanguageTypeC_plus_plus
681
-
787
+ r"""ISO C++:1998."""
682
788
  eLanguageTypeCobol74 = _lldb.eLanguageTypeCobol74
683
-
789
+ r"""ISO Cobol:1974."""
684
790
  eLanguageTypeCobol85 = _lldb.eLanguageTypeCobol85
685
-
791
+ r"""ISO Cobol:1985."""
686
792
  eLanguageTypeFortran77 = _lldb.eLanguageTypeFortran77
687
-
793
+ r"""ISO Fortran 77."""
688
794
  eLanguageTypeFortran90 = _lldb.eLanguageTypeFortran90
689
-
795
+ r"""ISO Fortran 90."""
690
796
  eLanguageTypePascal83 = _lldb.eLanguageTypePascal83
691
-
797
+ r"""ISO Pascal:1983."""
692
798
  eLanguageTypeModula2 = _lldb.eLanguageTypeModula2
693
-
799
+ r"""ISO Modula-2:1996."""
694
800
  eLanguageTypeJava = _lldb.eLanguageTypeJava
695
-
801
+ r"""Java."""
696
802
  eLanguageTypeC99 = _lldb.eLanguageTypeC99
697
-
803
+ r"""ISO C:1999."""
698
804
  eLanguageTypeAda95 = _lldb.eLanguageTypeAda95
699
-
805
+ r"""ISO Ada:1995."""
700
806
  eLanguageTypeFortran95 = _lldb.eLanguageTypeFortran95
701
-
807
+ r"""ISO Fortran 95."""
702
808
  eLanguageTypePLI = _lldb.eLanguageTypePLI
703
-
809
+ r"""ANSI PL/I:1976."""
704
810
  eLanguageTypeObjC = _lldb.eLanguageTypeObjC
705
-
811
+ r"""Objective-C."""
706
812
  eLanguageTypeObjC_plus_plus = _lldb.eLanguageTypeObjC_plus_plus
707
-
813
+ r"""Objective-C++."""
708
814
  eLanguageTypeUPC = _lldb.eLanguageTypeUPC
709
-
815
+ r"""Unified Parallel C."""
710
816
  eLanguageTypeD = _lldb.eLanguageTypeD
711
-
817
+ r"""D."""
712
818
  eLanguageTypePython = _lldb.eLanguageTypePython
713
-
819
+ r"""Python."""
714
820
  eLanguageTypeOpenCL = _lldb.eLanguageTypeOpenCL
715
-
821
+ r"""OpenCL."""
716
822
  eLanguageTypeGo = _lldb.eLanguageTypeGo
717
-
823
+ r"""Go."""
718
824
  eLanguageTypeModula3 = _lldb.eLanguageTypeModula3
719
-
825
+ r"""Modula 3."""
720
826
  eLanguageTypeHaskell = _lldb.eLanguageTypeHaskell
721
-
827
+ r"""Haskell."""
722
828
  eLanguageTypeC_plus_plus_03 = _lldb.eLanguageTypeC_plus_plus_03
723
-
829
+ r"""ISO C++:2003."""
724
830
  eLanguageTypeC_plus_plus_11 = _lldb.eLanguageTypeC_plus_plus_11
725
-
831
+ r"""ISO C++:2011."""
726
832
  eLanguageTypeOCaml = _lldb.eLanguageTypeOCaml
727
-
833
+ r"""OCaml."""
728
834
  eLanguageTypeRust = _lldb.eLanguageTypeRust
729
-
835
+ r"""Rust."""
730
836
  eLanguageTypeC11 = _lldb.eLanguageTypeC11
731
-
837
+ r"""ISO C:2011."""
732
838
  eLanguageTypeSwift = _lldb.eLanguageTypeSwift
733
-
839
+ r"""Swift."""
734
840
  eLanguageTypeJulia = _lldb.eLanguageTypeJulia
735
-
841
+ r"""Julia."""
736
842
  eLanguageTypeDylan = _lldb.eLanguageTypeDylan
737
-
843
+ r"""Dylan."""
738
844
  eLanguageTypeC_plus_plus_14 = _lldb.eLanguageTypeC_plus_plus_14
739
-
845
+ r"""ISO C++:2014."""
740
846
  eLanguageTypeFortran03 = _lldb.eLanguageTypeFortran03
741
-
847
+ r"""ISO Fortran 2003."""
742
848
  eLanguageTypeFortran08 = _lldb.eLanguageTypeFortran08
743
-
849
+ r"""ISO Fortran 2008."""
744
850
  eLanguageTypeRenderScript = _lldb.eLanguageTypeRenderScript
745
851
 
746
852
  eLanguageTypeBLISS = _lldb.eLanguageTypeBLISS
@@ -752,9 +858,9 @@ eLanguageTypeZig = _lldb.eLanguageTypeZig
752
858
  eLanguageTypeCrystal = _lldb.eLanguageTypeCrystal
753
859
 
754
860
  eLanguageTypeC_plus_plus_17 = _lldb.eLanguageTypeC_plus_plus_17
755
-
861
+ r"""ISO C++:2017."""
756
862
  eLanguageTypeC_plus_plus_20 = _lldb.eLanguageTypeC_plus_plus_20
757
-
863
+ r"""ISO C++:2020."""
758
864
  eLanguageTypeC17 = _lldb.eLanguageTypeC17
759
865
 
760
866
  eLanguageTypeFortran18 = _lldb.eLanguageTypeFortran18
@@ -772,7 +878,7 @@ eLanguageTypeC_sharp = _lldb.eLanguageTypeC_sharp
772
878
  eLanguageTypeMojo = _lldb.eLanguageTypeMojo
773
879
 
774
880
  eLanguageTypeMipsAssembler = _lldb.eLanguageTypeMipsAssembler
775
-
881
+ r"""Mips_Assembler."""
776
882
  eNumLanguageTypes = _lldb.eNumLanguageTypes
777
883
 
778
884
  eInstrumentationRuntimeTypeAddressSanitizer = _lldb.eInstrumentationRuntimeTypeAddressSanitizer
@@ -1015,6 +1121,10 @@ eArgTypeCPUName = _lldb.eArgTypeCPUName
1015
1121
 
1016
1122
  eArgTypeCPUFeatures = _lldb.eArgTypeCPUFeatures
1017
1123
 
1124
+ eArgTypeManagedPlugin = _lldb.eArgTypeManagedPlugin
1125
+
1126
+ eArgTypeProtocol = _lldb.eArgTypeProtocol
1127
+
1018
1128
  eArgTypeLastArg = _lldb.eArgTypeLastArg
1019
1129
 
1020
1130
  eSymbolTypeAny = _lldb.eSymbolTypeAny
@@ -1062,7 +1172,10 @@ eSymbolTypeScopeBegin = _lldb.eSymbolTypeScopeBegin
1062
1172
  eSymbolTypeScopeEnd = _lldb.eSymbolTypeScopeEnd
1063
1173
 
1064
1174
  eSymbolTypeAdditional = _lldb.eSymbolTypeAdditional
1065
-
1175
+ r"""
1176
+ When symbols take more than one entry, the extra
1177
+ entries get this type
1178
+ """
1066
1179
  eSymbolTypeCompiler = _lldb.eSymbolTypeCompiler
1067
1180
 
1068
1181
  eSymbolTypeInstrumentation = _lldb.eSymbolTypeInstrumentation
@@ -1082,15 +1195,15 @@ eSectionTypeInvalid = _lldb.eSectionTypeInvalid
1082
1195
  eSectionTypeCode = _lldb.eSectionTypeCode
1083
1196
 
1084
1197
  eSectionTypeContainer = _lldb.eSectionTypeContainer
1085
-
1198
+ r"""The section contains child sections"""
1086
1199
  eSectionTypeData = _lldb.eSectionTypeData
1087
1200
 
1088
1201
  eSectionTypeDataCString = _lldb.eSectionTypeDataCString
1089
-
1202
+ r"""Inlined C string data"""
1090
1203
  eSectionTypeDataCStringPointers = _lldb.eSectionTypeDataCStringPointers
1091
-
1204
+ r"""Pointers to C string data"""
1092
1205
  eSectionTypeDataSymbolAddress = _lldb.eSectionTypeDataSymbolAddress
1093
-
1206
+ r"""Address of a symbol in the symbol table"""
1094
1207
  eSectionTypeData4 = _lldb.eSectionTypeData4
1095
1208
 
1096
1209
  eSectionTypeData8 = _lldb.eSectionTypeData8
@@ -1104,9 +1217,12 @@ eSectionTypeDebug = _lldb.eSectionTypeDebug
1104
1217
  eSectionTypeZeroFill = _lldb.eSectionTypeZeroFill
1105
1218
 
1106
1219
  eSectionTypeDataObjCMessageRefs = _lldb.eSectionTypeDataObjCMessageRefs
1107
-
1220
+ r"""Pointer to function pointer + selector"""
1108
1221
  eSectionTypeDataObjCCFStrings = _lldb.eSectionTypeDataObjCCFStrings
1109
-
1222
+ r"""
1223
+ Objective-C const CFString/NSString
1224
+ objects
1225
+ """
1110
1226
  eSectionTypeDWARFDebugAbbrev = _lldb.eSectionTypeDWARFDebugAbbrev
1111
1227
 
1112
1228
  eSectionTypeDWARFDebugAddr = _lldb.eSectionTypeDWARFDebugAddr
@@ -1146,13 +1262,13 @@ eSectionTypeDWARFAppleNamespaces = _lldb.eSectionTypeDWARFAppleNamespaces
1146
1262
  eSectionTypeDWARFAppleObjC = _lldb.eSectionTypeDWARFAppleObjC
1147
1263
 
1148
1264
  eSectionTypeELFSymbolTable = _lldb.eSectionTypeELFSymbolTable
1149
-
1265
+ r"""Elf SHT_SYMTAB section"""
1150
1266
  eSectionTypeELFDynamicSymbols = _lldb.eSectionTypeELFDynamicSymbols
1151
-
1267
+ r"""Elf SHT_DYNSYM section"""
1152
1268
  eSectionTypeELFRelocationEntries = _lldb.eSectionTypeELFRelocationEntries
1153
-
1269
+ r"""Elf SHT_REL or SHT_REL section"""
1154
1270
  eSectionTypeELFDynamicLinkInfo = _lldb.eSectionTypeELFDynamicLinkInfo
1155
-
1271
+ r"""Elf SHT_DYNAMIC section"""
1156
1272
  eSectionTypeEHFrame = _lldb.eSectionTypeEHFrame
1157
1273
 
1158
1274
  eSectionTypeARMexidx = _lldb.eSectionTypeARMexidx
@@ -1160,25 +1276,31 @@ eSectionTypeARMexidx = _lldb.eSectionTypeARMexidx
1160
1276
  eSectionTypeARMextab = _lldb.eSectionTypeARMextab
1161
1277
 
1162
1278
  eSectionTypeCompactUnwind = _lldb.eSectionTypeCompactUnwind
1163
-
1279
+ r"""
1280
+ compact unwind section in Mach-O,
1281
+ __TEXT,__unwind_info
1282
+ """
1164
1283
  eSectionTypeGoSymtab = _lldb.eSectionTypeGoSymtab
1165
1284
 
1166
1285
  eSectionTypeAbsoluteAddress = _lldb.eSectionTypeAbsoluteAddress
1167
-
1286
+ r"""
1287
+ Dummy section for symbols with absolute
1288
+ address
1289
+ """
1168
1290
  eSectionTypeDWARFGNUDebugAltLink = _lldb.eSectionTypeDWARFGNUDebugAltLink
1169
1291
 
1170
1292
  eSectionTypeDWARFDebugTypes = _lldb.eSectionTypeDWARFDebugTypes
1171
-
1293
+ r"""DWARF .debug_types section"""
1172
1294
  eSectionTypeDWARFDebugNames = _lldb.eSectionTypeDWARFDebugNames
1173
-
1295
+ r"""DWARF v5 .debug_names"""
1174
1296
  eSectionTypeOther = _lldb.eSectionTypeOther
1175
1297
 
1176
1298
  eSectionTypeDWARFDebugLineStr = _lldb.eSectionTypeDWARFDebugLineStr
1177
-
1299
+ r"""DWARF v5 .debug_line_str"""
1178
1300
  eSectionTypeDWARFDebugRngLists = _lldb.eSectionTypeDWARFDebugRngLists
1179
-
1301
+ r"""DWARF v5 .debug_rnglists"""
1180
1302
  eSectionTypeDWARFDebugLocLists = _lldb.eSectionTypeDWARFDebugLocLists
1181
-
1303
+ r"""DWARF v5 .debug_loclists"""
1182
1304
  eSectionTypeDWARFDebugAbbrevDwo = _lldb.eSectionTypeDWARFDebugAbbrevDwo
1183
1305
 
1184
1306
  eSectionTypeDWARFDebugInfoDwo = _lldb.eSectionTypeDWARFDebugInfoDwo
@@ -1214,17 +1336,33 @@ eEmulateInstructionOptionIgnoreConditions = _lldb.eEmulateInstructionOptionIgnor
1214
1336
  eFunctionNameTypeNone = _lldb.eFunctionNameTypeNone
1215
1337
 
1216
1338
  eFunctionNameTypeAuto = _lldb.eFunctionNameTypeAuto
1217
-
1339
+ r"""
1340
+ Automatically figure out which FunctionNameType
1341
+ bits to set based on the function name.
1342
+ """
1218
1343
  eFunctionNameTypeFull = _lldb.eFunctionNameTypeFull
1219
-
1344
+ r"""
1345
+ The function name.
1346
+ For C this is the same as just the name of the function For C++ this is
1347
+ the mangled or demangled version of the mangled name. For ObjC this is
1348
+ the full function signature with the + or - and the square brackets and
1349
+ the class and selector
1350
+ """
1220
1351
  eFunctionNameTypeBase = _lldb.eFunctionNameTypeBase
1221
-
1352
+ r"""
1353
+ The function name only, no namespaces
1354
+ or arguments and no class
1355
+ methods or selectors will be searched.
1356
+ """
1222
1357
  eFunctionNameTypeMethod = _lldb.eFunctionNameTypeMethod
1223
-
1358
+ r"""
1359
+ Find function by method name (C++)
1360
+ with no namespace or arguments
1361
+ """
1224
1362
  eFunctionNameTypeSelector = _lldb.eFunctionNameTypeSelector
1225
-
1363
+ r"""Find function by selector name (ObjC) names"""
1226
1364
  eFunctionNameTypeAny = _lldb.eFunctionNameTypeAny
1227
-
1365
+ r"""DEPRECATED: use eFunctionNameTypeAuto"""
1228
1366
  eBasicTypeInvalid = _lldb.eBasicTypeInvalid
1229
1367
 
1230
1368
  eBasicTypeVoid = _lldb.eBasicTypeVoid
@@ -1296,7 +1434,7 @@ eBasicTypeOther = _lldb.eBasicTypeOther
1296
1434
  eTraceTypeNone = _lldb.eTraceTypeNone
1297
1435
 
1298
1436
  eTraceTypeProcessorTrace = _lldb.eTraceTypeProcessorTrace
1299
-
1437
+ r"""Intel Processor Trace"""
1300
1438
  eStructuredDataTypeInvalid = _lldb.eStructuredDataTypeInvalid
1301
1439
 
1302
1440
  eStructuredDataTypeNull = _lldb.eStructuredDataTypeNull
@@ -1496,23 +1634,35 @@ eExpressionEvaluationExecution = _lldb.eExpressionEvaluationExecution
1496
1634
  eExpressionEvaluationComplete = _lldb.eExpressionEvaluationComplete
1497
1635
 
1498
1636
  eInstructionControlFlowKindUnknown = _lldb.eInstructionControlFlowKindUnknown
1499
-
1637
+ r"""The instruction could not be classified."""
1500
1638
  eInstructionControlFlowKindOther = _lldb.eInstructionControlFlowKindOther
1501
-
1639
+ r"""
1640
+ The instruction is something not listed below, i.e. it's a sequential
1641
+ instruction that doesn't affect the control flow of the program.
1642
+ """
1502
1643
  eInstructionControlFlowKindCall = _lldb.eInstructionControlFlowKindCall
1503
-
1644
+ r"""The instruction is a near (function) call."""
1504
1645
  eInstructionControlFlowKindReturn = _lldb.eInstructionControlFlowKindReturn
1505
-
1646
+ r"""The instruction is a near (function) return."""
1506
1647
  eInstructionControlFlowKindJump = _lldb.eInstructionControlFlowKindJump
1507
-
1648
+ r"""The instruction is a near unconditional jump."""
1508
1649
  eInstructionControlFlowKindCondJump = _lldb.eInstructionControlFlowKindCondJump
1509
-
1650
+ r"""The instruction is a near conditional jump."""
1510
1651
  eInstructionControlFlowKindFarCall = _lldb.eInstructionControlFlowKindFarCall
1511
-
1652
+ r"""
1653
+ The instruction is a call-like far transfer.
1654
+ E.g. SYSCALL, SYSENTER, or FAR CALL.
1655
+ """
1512
1656
  eInstructionControlFlowKindFarReturn = _lldb.eInstructionControlFlowKindFarReturn
1513
-
1657
+ r"""
1658
+ The instruction is a return-like far transfer.
1659
+ E.g. SYSRET, SYSEXIT, IRET, or FAR RET.
1660
+ """
1514
1661
  eInstructionControlFlowKindFarJump = _lldb.eInstructionControlFlowKindFarJump
1515
-
1662
+ r"""
1663
+ The instruction is a jump-like far transfer.
1664
+ E.g. FAR JMP.
1665
+ """
1516
1666
  eWatchpointKindWrite = _lldb.eWatchpointKindWrite
1517
1667
 
1518
1668
  eWatchpointKindRead = _lldb.eWatchpointKindRead
@@ -1530,33 +1680,55 @@ eGdbSignalSoftware = _lldb.eGdbSignalSoftware
1530
1680
  eGdbSignalBreakpoint = _lldb.eGdbSignalBreakpoint
1531
1681
 
1532
1682
  ePathTypeLLDBShlibDir = _lldb.ePathTypeLLDBShlibDir
1533
-
1683
+ r"""
1684
+ The directory where the lldb.so (unix) or LLDB
1685
+ mach-o file in LLDB.framework (MacOSX) exists
1686
+ """
1534
1687
  ePathTypeSupportExecutableDir = _lldb.ePathTypeSupportExecutableDir
1535
-
1688
+ r"""
1689
+ Find LLDB support executable directory
1690
+ (debugserver, etc)
1691
+ """
1536
1692
  ePathTypeHeaderDir = _lldb.ePathTypeHeaderDir
1537
-
1693
+ r"""Find LLDB header file directory"""
1538
1694
  ePathTypePythonDir = _lldb.ePathTypePythonDir
1539
-
1695
+ r"""Find Python modules (PYTHONPATH) directory"""
1540
1696
  ePathTypeLLDBSystemPlugins = _lldb.ePathTypeLLDBSystemPlugins
1541
-
1697
+ r"""System plug-ins directory"""
1542
1698
  ePathTypeLLDBUserPlugins = _lldb.ePathTypeLLDBUserPlugins
1543
-
1699
+ r"""User plug-ins directory"""
1544
1700
  ePathTypeLLDBTempSystemDir = _lldb.ePathTypeLLDBTempSystemDir
1545
-
1701
+ r"""
1702
+ The LLDB temp directory for this system that
1703
+ will be cleaned up on exit
1704
+ """
1546
1705
  ePathTypeGlobalLLDBTempSystemDir = _lldb.ePathTypeGlobalLLDBTempSystemDir
1547
-
1706
+ r"""
1707
+ The LLDB temp directory for this
1708
+ system, NOT cleaned up on a process
1709
+ exit.
1710
+ """
1548
1711
  ePathTypeClangDir = _lldb.ePathTypeClangDir
1549
-
1712
+ r"""Find path to Clang builtin headers"""
1550
1713
  eMemberFunctionKindUnknown = _lldb.eMemberFunctionKindUnknown
1551
-
1714
+ r"""Not sure what the type of this is"""
1552
1715
  eMemberFunctionKindConstructor = _lldb.eMemberFunctionKindConstructor
1553
-
1716
+ r"""A function used to create instances"""
1554
1717
  eMemberFunctionKindDestructor = _lldb.eMemberFunctionKindDestructor
1555
-
1718
+ r"""
1719
+ A function used to tear down existing
1720
+ instances
1721
+ """
1556
1722
  eMemberFunctionKindInstanceMethod = _lldb.eMemberFunctionKindInstanceMethod
1557
-
1723
+ r"""
1724
+ A function that applies to a specific
1725
+ instance
1726
+ """
1558
1727
  eMemberFunctionKindStaticMethod = _lldb.eMemberFunctionKindStaticMethod
1559
-
1728
+ r"""
1729
+ A function that applies to a type rather
1730
+ than any instance
1731
+ """
1560
1732
  eMatchTypeNormal = _lldb.eMatchTypeNormal
1561
1733
 
1562
1734
  eMatchTypeRegex = _lldb.eMatchTypeRegex
@@ -1612,35 +1784,105 @@ eTypeIsSigned = _lldb.eTypeIsSigned
1612
1784
  eTypeInstanceIsPointer = _lldb.eTypeInstanceIsPointer
1613
1785
 
1614
1786
  eCommandRequiresTarget = _lldb.eCommandRequiresTarget
1615
-
1787
+ r"""
1788
+ eCommandRequiresTarget
1789
+
1790
+ Ensures a valid target is contained in m_exe_ctx prior to executing the
1791
+ command. If a target doesn't exist or is invalid, the command will fail
1792
+ and CommandObject::GetInvalidTargetDescription() will be returned as the
1793
+ error. CommandObject subclasses can override the virtual function for
1794
+ GetInvalidTargetDescription() to provide custom strings when needed.
1795
+ """
1616
1796
  eCommandRequiresProcess = _lldb.eCommandRequiresProcess
1617
-
1797
+ r"""
1798
+ eCommandRequiresProcess
1799
+
1800
+ Ensures a valid process is contained in m_exe_ctx prior to executing the
1801
+ command. If a process doesn't exist or is invalid, the command will fail
1802
+ and CommandObject::GetInvalidProcessDescription() will be returned as
1803
+ the error. CommandObject subclasses can override the virtual function
1804
+ for GetInvalidProcessDescription() to provide custom strings when
1805
+ needed.
1806
+ """
1618
1807
  eCommandRequiresThread = _lldb.eCommandRequiresThread
1619
-
1808
+ r"""
1809
+ eCommandRequiresThread
1810
+
1811
+ Ensures a valid thread is contained in m_exe_ctx prior to executing the
1812
+ command. If a thread doesn't exist or is invalid, the command will fail
1813
+ and CommandObject::GetInvalidThreadDescription() will be returned as the
1814
+ error. CommandObject subclasses can override the virtual function for
1815
+ GetInvalidThreadDescription() to provide custom strings when needed.
1816
+ """
1620
1817
  eCommandRequiresFrame = _lldb.eCommandRequiresFrame
1621
-
1818
+ r"""
1819
+ eCommandRequiresFrame
1820
+
1821
+ Ensures a valid frame is contained in m_exe_ctx prior to executing the
1822
+ command. If a frame doesn't exist or is invalid, the command will fail
1823
+ and CommandObject::GetInvalidFrameDescription() will be returned as the
1824
+ error. CommandObject subclasses can override the virtual function for
1825
+ GetInvalidFrameDescription() to provide custom strings when needed.
1826
+ """
1622
1827
  eCommandRequiresRegContext = _lldb.eCommandRequiresRegContext
1623
-
1828
+ r"""
1829
+ eCommandRequiresRegContext
1830
+
1831
+ Ensures a valid register context (from the selected frame if there is a
1832
+ frame in m_exe_ctx, or from the selected thread from m_exe_ctx) is
1833
+ available from m_exe_ctx prior to executing the command. If a target
1834
+ doesn't exist or is invalid, the command will fail and
1835
+ CommandObject::GetInvalidRegContextDescription() will be returned as the
1836
+ error. CommandObject subclasses can override the virtual function for
1837
+ GetInvalidRegContextDescription() to provide custom strings when needed.
1838
+ """
1624
1839
  eCommandTryTargetAPILock = _lldb.eCommandTryTargetAPILock
1840
+ r"""
1841
+ eCommandTryTargetAPILock
1625
1842
 
1843
+ Attempts to acquire the target lock if a target is selected in the
1844
+ command interpreter. If the command object fails to acquire the API
1845
+ lock, the command will fail with an appropriate error message.
1846
+ """
1626
1847
  eCommandProcessMustBeLaunched = _lldb.eCommandProcessMustBeLaunched
1848
+ r"""
1849
+ eCommandProcessMustBeLaunched
1627
1850
 
1851
+ Verifies that there is a launched process in m_exe_ctx, if there isn't,
1852
+ the command will fail with an appropriate error message.
1853
+ """
1628
1854
  eCommandProcessMustBePaused = _lldb.eCommandProcessMustBePaused
1855
+ r"""
1856
+ eCommandProcessMustBePaused
1629
1857
 
1858
+ Verifies that there is a paused process in m_exe_ctx, if there isn't,
1859
+ the command will fail with an appropriate error message.
1860
+ """
1630
1861
  eCommandProcessMustBeTraced = _lldb.eCommandProcessMustBeTraced
1862
+ r"""
1863
+ eCommandProcessMustBeTraced
1631
1864
 
1865
+ Verifies that the process is being traced by a Trace plug-in, if it
1866
+ isn't the command will fail with an appropriate error message.
1867
+ """
1632
1868
  eTypeSummaryCapped = _lldb.eTypeSummaryCapped
1633
1869
 
1634
1870
  eTypeSummaryUncapped = _lldb.eTypeSummaryUncapped
1635
1871
 
1636
1872
  eCommandInterpreterResultSuccess = _lldb.eCommandInterpreterResultSuccess
1637
-
1873
+ r"""Command interpreter finished successfully."""
1638
1874
  eCommandInterpreterResultInferiorCrash = _lldb.eCommandInterpreterResultInferiorCrash
1639
-
1875
+ r"""
1876
+ Stopped because the corresponding option was set and the inferior
1877
+ crashed.
1878
+ """
1640
1879
  eCommandInterpreterResultCommandError = _lldb.eCommandInterpreterResultCommandError
1641
-
1880
+ r"""
1881
+ Stopped because the corresponding option was set and a command returned
1882
+ an error.
1883
+ """
1642
1884
  eCommandInterpreterResultQuitRequested = _lldb.eCommandInterpreterResultQuitRequested
1643
-
1885
+ r"""Stopped because quit was requested."""
1644
1886
  eSaveCoreUnspecified = _lldb.eSaveCoreUnspecified
1645
1887
 
1646
1888
  eSaveCoreFull = _lldb.eSaveCoreFull
@@ -1652,15 +1894,21 @@ eSaveCoreStackOnly = _lldb.eSaveCoreStackOnly
1652
1894
  eSaveCoreCustomOnly = _lldb.eSaveCoreCustomOnly
1653
1895
 
1654
1896
  eTraceEventDisabledSW = _lldb.eTraceEventDisabledSW
1655
-
1897
+ r"""Tracing was disabled for some time due to a software trigger."""
1656
1898
  eTraceEventDisabledHW = _lldb.eTraceEventDisabledHW
1657
-
1899
+ r"""Tracing was disable for some time due to a hardware trigger."""
1658
1900
  eTraceEventCPUChanged = _lldb.eTraceEventCPUChanged
1659
-
1901
+ r"""
1902
+ Event due to CPU change for a thread. This event is also fired when
1903
+ suddenly it's not possible to identify the cpu of a given thread.
1904
+ """
1660
1905
  eTraceEventHWClockTick = _lldb.eTraceEventHWClockTick
1661
-
1906
+ r"""Event due to a CPU HW clock tick."""
1662
1907
  eTraceEventSyncPoint = _lldb.eTraceEventSyncPoint
1663
-
1908
+ r"""
1909
+ The underlying tracing technology emitted a synchronization event used by
1910
+ trace processors.
1911
+ """
1664
1912
  eTraceItemKindError = _lldb.eTraceItemKindError
1665
1913
 
1666
1914
  eTraceItemKindEvent = _lldb.eTraceItemKindEvent
@@ -1668,21 +1916,27 @@ eTraceItemKindEvent = _lldb.eTraceItemKindEvent
1668
1916
  eTraceItemKindInstruction = _lldb.eTraceItemKindInstruction
1669
1917
 
1670
1918
  eTraceCursorSeekTypeBeginning = _lldb.eTraceCursorSeekTypeBeginning
1671
-
1919
+ r"""The beginning of the trace, i.e the oldest item."""
1672
1920
  eTraceCursorSeekTypeCurrent = _lldb.eTraceCursorSeekTypeCurrent
1673
-
1921
+ r"""The current position in the trace."""
1674
1922
  eTraceCursorSeekTypeEnd = _lldb.eTraceCursorSeekTypeEnd
1675
-
1923
+ r"""The end of the trace, i.e the most recent item."""
1676
1924
  eDWIMPrintVerbosityNone = _lldb.eDWIMPrintVerbosityNone
1677
-
1925
+ r"""Run `dwim-print` with no verbosity."""
1678
1926
  eDWIMPrintVerbosityExpression = _lldb.eDWIMPrintVerbosityExpression
1679
-
1927
+ r"""Print a message when `dwim-print` uses `expression` evaluation."""
1680
1928
  eDWIMPrintVerbosityFull = _lldb.eDWIMPrintVerbosityFull
1681
-
1929
+ r"""
1930
+ Always print a message indicating how `dwim-print` is evaluating its
1931
+ expression.
1932
+ """
1682
1933
  eWatchPointValueKindInvalid = _lldb.eWatchPointValueKindInvalid
1683
-
1934
+ r"""Watchpoint was created watching a variable"""
1684
1935
  eWatchPointValueKindVariable = _lldb.eWatchPointValueKindVariable
1685
-
1936
+ r"""
1937
+ Watchpoint was created watching the result of an expression that was
1938
+ evaluated at creation time.
1939
+ """
1686
1940
  eWatchPointValueKindExpression = _lldb.eWatchPointValueKindExpression
1687
1941
 
1688
1942
  eNoCompletion = _lldb.eNoCompletion
@@ -1744,9 +1998,12 @@ eThreadIDCompletion = _lldb.eThreadIDCompletion
1744
1998
  eTerminatorCompletion = _lldb.eTerminatorCompletion
1745
1999
 
1746
2000
  eRefetch = _lldb.eRefetch
1747
-
2001
+ r"""Children need to be recomputed dynamically."""
1748
2002
  eReuse = _lldb.eReuse
1749
-
2003
+ r"""
2004
+ Children did not change and don't need to be recomputed;
2005
+ re-use what we computed the last time we called Update.
2006
+ """
1750
2007
  eSymbolDownloadOff = _lldb.eSymbolDownloadOff
1751
2008
 
1752
2009
  eSymbolDownloadBackground = _lldb.eSymbolDownloadBackground
@@ -1778,17 +2035,29 @@ eBroadcastBitError = _lldb.eBroadcastBitError
1778
2035
  eBroadcastSymbolChange = _lldb.eBroadcastSymbolChange
1779
2036
 
1780
2037
  eBroadcastBitProgressCategory = _lldb.eBroadcastBitProgressCategory
1781
-
2038
+ r"""Deprecated"""
1782
2039
  eBroadcastBitExternalProgress = _lldb.eBroadcastBitExternalProgress
1783
2040
 
1784
2041
  eBroadcastBitExternalProgressCategory = _lldb.eBroadcastBitExternalProgressCategory
1785
-
2042
+ r"""Deprecated"""
1786
2043
  eSeverityError = _lldb.eSeverityError
1787
2044
 
1788
2045
  eSeverityWarning = _lldb.eSeverityWarning
1789
2046
 
1790
2047
  eSeverityInfo = _lldb.eSeverityInfo
1791
2048
 
2049
+ eCommandReturnObjectPrintCallbackSkipped = _lldb.eCommandReturnObjectPrintCallbackSkipped
2050
+ r"""The callback deferred printing the command return object."""
2051
+ eCommandReturnObjectPrintCallbackHandled = _lldb.eCommandReturnObjectPrintCallbackHandled
2052
+ r"""The callback handled printing the command return object."""
2053
+ eStopDisassemblyTypeNever = _lldb.eStopDisassemblyTypeNever
2054
+
2055
+ eStopDisassemblyTypeNoDebugInfo = _lldb.eStopDisassemblyTypeNoDebugInfo
2056
+
2057
+ eStopDisassemblyTypeNoSource = _lldb.eStopDisassemblyTypeNoSource
2058
+
2059
+ eStopDisassemblyTypeAlways = _lldb.eStopDisassemblyTypeAlways
2060
+
1792
2061
  class SBAddress(object):
1793
2062
  r"""
1794
2063
  A section + offset based address class.
@@ -2010,15 +2279,34 @@ class SBAddressRange(object):
2010
2279
  return _lldb.SBAddressRange_Clear(self)
2011
2280
 
2012
2281
  def IsValid(self):
2013
- r"""IsValid(SBAddressRange self) -> bool"""
2282
+ r"""
2283
+ Check the address range refers to a valid base address and has a byte
2284
+ size greater than zero.
2285
+
2286
+ :rtype: boolean
2287
+ :return:
2288
+ True if the address range is valid, false otherwise.
2289
+ """
2014
2290
  return _lldb.SBAddressRange_IsValid(self)
2015
2291
 
2016
2292
  def GetBaseAddress(self):
2017
- r"""GetBaseAddress(SBAddressRange self) -> SBAddress"""
2293
+ r"""
2294
+ Get the base address of the range.
2295
+
2296
+ :rtype: :py:class:`SBAddress`
2297
+ :return:
2298
+ Base address object.
2299
+ """
2018
2300
  return _lldb.SBAddressRange_GetBaseAddress(self)
2019
2301
 
2020
2302
  def GetByteSize(self):
2021
- r"""GetByteSize(SBAddressRange self) -> lldb::addr_t"""
2303
+ r"""
2304
+ Get the byte size of this range.
2305
+
2306
+ :rtype: int
2307
+ :return:
2308
+ The size in bytes of this address range.
2309
+ """
2022
2310
  return _lldb.SBAddressRange_GetByteSize(self)
2023
2311
 
2024
2312
  def __eq__(self, rhs):
@@ -2144,8 +2432,43 @@ class SBAttachInfo(object):
2144
2432
 
2145
2433
  def SetWaitForLaunch(self, *args):
2146
2434
  r"""
2147
- SetWaitForLaunch(SBAttachInfo self, bool b)
2148
- SetWaitForLaunch(SBAttachInfo self, bool b, bool _async)
2435
+ *Overload 1:*
2436
+ Set attach by process name settings.
2437
+
2438
+ Designed to be used after a call to SBAttachInfo::SetExecutable().
2439
+ This function implies that a call to SBTarget::Attach(...) will
2440
+ be synchronous.
2441
+
2442
+ :type b: boolean, in
2443
+ :param b:
2444
+ If **false**, attach to an existing process whose name matches.
2445
+ If **true**, then wait for the next process whose name matches.
2446
+
2447
+ |
2448
+
2449
+ *Overload 2:*
2450
+ Set attach by process name settings.
2451
+
2452
+ Designed to be used after a call to SBAttachInfo::SetExecutable().
2453
+ Future calls to SBTarget::Attach(...) will be synchronous or
2454
+ asynchronous depending on the *async* argument.
2455
+
2456
+ :type b: boolean, in
2457
+ :param b:
2458
+ If **false**, attach to an existing process whose name matches.
2459
+ If **true**, then wait for the next process whose name matches.
2460
+
2461
+ :type async: boolean, in
2462
+ :param async:
2463
+ If **false**, then the SBTarget::Attach(...) call will be a
2464
+ synchronous call with no way to cancel the attach in
2465
+ progress.
2466
+ If **true**, then the SBTarget::Attach(...) function will
2467
+ return immediately and clients are expected to wait for a
2468
+ process eStateStopped event if a suitable process is
2469
+ eventually found. If the client wants to cancel the event,
2470
+ SBProcess::Stop() can be called and an eStateExited process
2471
+ event will be delivered.
2149
2472
  """
2150
2473
  return _lldb.SBAttachInfo_SetWaitForLaunch(self, *args)
2151
2474
 
@@ -2234,19 +2557,49 @@ class SBAttachInfo(object):
2234
2557
  return _lldb.SBAttachInfo_ParentProcessIDIsValid(self)
2235
2558
 
2236
2559
  def GetListener(self):
2237
- r"""GetListener(SBAttachInfo self) -> SBListener"""
2560
+ r"""
2561
+ Get the listener that will be used to receive process events.
2562
+
2563
+ If no listener has been set via a call to
2564
+ SBAttachInfo::SetListener(), then an invalid SBListener will be
2565
+ returned (SBListener::IsValid() will return false). If a listener
2566
+ has been set, then the valid listener object will be returned.
2567
+ """
2238
2568
  return _lldb.SBAttachInfo_GetListener(self)
2239
2569
 
2240
2570
  def SetListener(self, listener):
2241
- r"""SetListener(SBAttachInfo self, SBListener listener)"""
2571
+ r"""
2572
+ Set the listener that will be used to receive process events.
2573
+
2574
+ By default the SBDebugger, which has a listener, that the SBTarget
2575
+ belongs to will listen for the process events. Calling this function
2576
+ allows a different listener to be used to listen for process events.
2577
+ """
2242
2578
  return _lldb.SBAttachInfo_SetListener(self, listener)
2243
2579
 
2244
2580
  def GetShadowListener(self):
2245
- r"""GetShadowListener(SBAttachInfo self) -> SBListener"""
2581
+ r"""
2582
+ Get the shadow listener that receive public process events,
2583
+ additionally to the default process event listener.
2584
+
2585
+ If no listener has been set via a call to
2586
+ SBLaunchInfo::SetShadowListener(), then an invalid SBListener will
2587
+ be returned (SBListener::IsValid() will return false). If a listener
2588
+ has been set, then the valid listener object will be returned.
2589
+ """
2246
2590
  return _lldb.SBAttachInfo_GetShadowListener(self)
2247
2591
 
2248
2592
  def SetShadowListener(self, listener):
2249
- r"""SetShadowListener(SBAttachInfo self, SBListener listener)"""
2593
+ r"""
2594
+ Set the shadow listener that will receive public process events,
2595
+ additionally to the default process event listener.
2596
+
2597
+ By default a process have no shadow event listener.
2598
+ Calling this function allows public process events to be broadcasted to an
2599
+ additional listener on top of the default process event listener.
2600
+ If the `listener` argument is invalid (SBListener::IsValid() will
2601
+ return false), this will clear the shadow listener.
2602
+ """
2250
2603
  return _lldb.SBAttachInfo_SetShadowListener(self, listener)
2251
2604
 
2252
2605
  def GetScriptedProcessClassName(self):
@@ -2763,6 +3116,14 @@ class SBBreakpoint(object):
2763
3116
  r"""IsHardware(SBBreakpoint self) -> bool"""
2764
3117
  return _lldb.SBBreakpoint_IsHardware(self)
2765
3118
 
3119
+ def SetIsHardware(self, is_hardware):
3120
+ r"""
3121
+ Make this breakpoint a hardware breakpoint. This will replace all existing
3122
+ breakpoint locations with hardware breakpoints. Returns an error if this
3123
+ fails, e.g. when there aren't enough hardware resources available.
3124
+ """
3125
+ return _lldb.SBBreakpoint_SetIsHardware(self, is_hardware)
3126
+
2766
3127
  def AddLocation(self, address):
2767
3128
  r"""AddLocation(SBBreakpoint self, SBAddress address) -> SBError"""
2768
3129
  return _lldb.SBBreakpoint_AddLocation(self, address)
@@ -2822,6 +3183,15 @@ class SBBreakpoint(object):
2822
3183
  enabled = property(IsEnabled, SetEnabled, doc='''A read/write property that configures whether this breakpoint is enabled or not.''')
2823
3184
  one_shot = property(IsOneShot, SetOneShot, doc='''A read/write property that configures whether this breakpoint is one-shot (deleted when hit) or not.''')
2824
3185
  num_locations = property(GetNumLocations, None, doc='''A read only property that returns the count of locations of this breakpoint.''')
3186
+ auto_continue = property(GetAutoContinue, SetAutoContinue, doc='A read/write property that configures the auto-continue property of this breakpoint.')
3187
+ condition = property(GetCondition, SetCondition, doc='A read/write property that configures the condition of this breakpoint.')
3188
+ hit_count = property(GetHitCount, doc='A read only property that returns the hit count of this breakpoint.')
3189
+ ignore_count = property(GetIgnoreCount, SetIgnoreCount, doc='A read/write property that configures the ignore count of this breakpoint.')
3190
+ queue_name = property(GetQueueName, SetQueueName, doc='A read/write property that configures the queue name criteria of this breakpoint.')
3191
+ target = property(GetTarget, doc='A read only property that returns the target of this breakpoint.')
3192
+ thread_id = property(GetThreadID, SetThreadID, doc='A read/write property that configures the thread id criteria of this breakpoint.')
3193
+ thread_index = property(GetThreadIndex, SetThreadIndex, doc='A read/write property that configures the thread index criteria of this breakpoint.')
3194
+ thread_name = property(GetThreadName, SetThreadName, doc='A read/write property that configures the thread name criteria of this breakpoint.')
2825
3195
 
2826
3196
 
2827
3197
  def __eq__(self, rhs):
@@ -3065,6 +3435,19 @@ class SBBreakpointLocation(object):
3065
3435
  def __eq__(self, other):
3066
3436
  return not self.__ne__(other)
3067
3437
 
3438
+ addr = property(GetAddress, doc='A read only property that returns the address of this breakpoint location.')
3439
+ auto_continue = property(GetAutoContinue, SetAutoContinue, doc='A read/write property that configures the auto-continue property of this breakpoint location.')
3440
+ breakpoint = property(GetBreakpoint, doc='A read only property that returns the parent breakpoint of this breakpoint location.')
3441
+ condition = property(GetCondition, SetCondition, doc='A read/write property that configures the condition of this breakpoint location.')
3442
+ hit_count = property(GetHitCount, doc='A read only property that returns the hit count of this breakpoint location.')
3443
+ id = property(GetID, doc='A read only property that returns the id of this breakpoint location.')
3444
+ ignore_count = property(GetIgnoreCount, SetIgnoreCount, doc='A read/write property that configures the ignore count of this breakpoint location.')
3445
+ load_addr = property(GetLoadAddress, doc='A read only property that returns the load address of this breakpoint location.')
3446
+ queue_name = property(GetQueueName, SetQueueName, doc='A read/write property that configures the queue name criteria of this breakpoint location.')
3447
+ thread_id = property(GetThreadID, SetThreadID, doc='A read/write property that configures the thread id criteria of this breakpoint location.')
3448
+ thread_index = property(GetThreadIndex, SetThreadIndex, doc='A read/write property that configures the thread index criteria of this breakpoint location.')
3449
+ thread_name = property(GetThreadName, SetThreadName, doc='A read/write property that configures the thread name criteria of this breakpoint location.')
3450
+
3068
3451
 
3069
3452
  # Register SBBreakpointLocation in _lldb:
3070
3453
  _lldb.SBBreakpointLocation_swigregister(SBBreakpointLocation)
@@ -3255,6 +3638,16 @@ class SBBreakpointName(object):
3255
3638
  def __eq__(self, other):
3256
3639
  return not self.__ne__(other)
3257
3640
 
3641
+ auto_continue = property(GetAutoContinue, SetAutoContinue, doc='A read/write property that configures the auto-continue property of this breakpoint name.')
3642
+ condition = property(GetCondition, SetCondition, doc='A read/write property that configures the condition of this breakpoint name.')
3643
+ enabled = property(IsEnabled, SetEnabled, doc='''A read/write property that configures whether this breakpoint name is enabled or not.''')
3644
+ ignore_count = property(GetIgnoreCount, SetIgnoreCount, doc='A read/write property that configures the ignore count of this breakpoint name.')
3645
+ one_shot = property(IsOneShot, SetOneShot, doc='''A read/write property that configures whether this breakpoint name is one-shot (deleted when hit) or not.''')
3646
+ queue_name = property(GetQueueName, SetQueueName, doc='A read/write property that configures the queue name criteria of this breakpoint name.')
3647
+ thread_id = property(GetThreadID, SetThreadID, doc='A read/write property that configures the thread id criteria of this breakpoint name.')
3648
+ thread_index = property(GetThreadIndex, SetThreadIndex, doc='A read/write property that configures the thread index criteria of this breakpoint name.')
3649
+ thread_name = property(GetThreadName, SetThreadName, doc='A read/write property that configures the thread name criteria of this breakpoint name.')
3650
+
3258
3651
 
3259
3652
  # Register SBBreakpointName in _lldb:
3260
3653
  _lldb.SBBreakpointName_swigregister(SBBreakpointName)
@@ -3455,15 +3848,48 @@ class SBCommandInterpreter(object):
3455
3848
  return _lldb.SBCommandInterpreter_IsValid(self)
3456
3849
 
3457
3850
  def CommandExists(self, cmd):
3458
- r"""CommandExists(SBCommandInterpreter self, char const * cmd) -> bool"""
3851
+ r"""
3852
+ Return whether a built-in command with the passed in
3853
+ name or command path exists.
3854
+
3855
+ :type cmd: string, in
3856
+ :param cmd:
3857
+ The command or command path to search for.
3858
+
3859
+ :rtype: boolean
3860
+ :return:
3861
+ **true** if the command exists, **false** otherwise.
3862
+ """
3459
3863
  return _lldb.SBCommandInterpreter_CommandExists(self, cmd)
3460
3864
 
3461
3865
  def UserCommandExists(self, cmd):
3462
- r"""UserCommandExists(SBCommandInterpreter self, char const * cmd) -> bool"""
3866
+ r"""
3867
+ Return whether a user defined command with the passed in
3868
+ name or command path exists.
3869
+
3870
+ :type cmd: string, in
3871
+ :param cmd:
3872
+ The command or command path to search for.
3873
+
3874
+ :rtype: boolean
3875
+ :return:
3876
+ **true** if the command exists, **false** otherwise.
3877
+ """
3463
3878
  return _lldb.SBCommandInterpreter_UserCommandExists(self, cmd)
3464
3879
 
3465
3880
  def AliasExists(self, cmd):
3466
- r"""AliasExists(SBCommandInterpreter self, char const * cmd) -> bool"""
3881
+ r"""
3882
+ Return whether the passed in name or command path
3883
+ exists and is an alias to some other command.
3884
+
3885
+ :type cmd: string, in
3886
+ :param cmd:
3887
+ The command or command path to search for.
3888
+
3889
+ :rtype: boolean
3890
+ :return:
3891
+ **true** if the command exists, **false** otherwise.
3892
+ """
3467
3893
  return _lldb.SBCommandInterpreter_AliasExists(self, cmd)
3468
3894
 
3469
3895
  def GetBroadcaster(self):
@@ -3530,11 +3956,25 @@ class SBCommandInterpreter(object):
3530
3956
  return _lldb.SBCommandInterpreter_HandleCompletionWithDescriptions(self, current_line, cursor_pos, match_start_point, max_return_elements, matches, descriptions)
3531
3957
 
3532
3958
  def WasInterrupted(self):
3533
- r"""WasInterrupted(SBCommandInterpreter self) -> bool"""
3959
+ r"""
3960
+ Returns whether an interrupt flag was raised either by the SBDebugger -
3961
+ when the function is not running on the RunCommandInterpreter thread, or
3962
+ by SBCommandInterpreter::InterruptCommand if it is. If your code is doing
3963
+ interruptible work, check this API periodically, and interrupt if it
3964
+ returns true.
3965
+ """
3534
3966
  return _lldb.SBCommandInterpreter_WasInterrupted(self)
3535
3967
 
3536
3968
  def InterruptCommand(self):
3537
- r"""InterruptCommand(SBCommandInterpreter self) -> bool"""
3969
+ r"""
3970
+ Interrupts the command currently executing in the RunCommandInterpreter
3971
+ thread.
3972
+
3973
+ :rtype: boolean
3974
+ :return:
3975
+ **true** if there was a command in progress to recieve the interrupt.
3976
+ **false** if there's no command currently in flight.
3977
+ """
3538
3978
  return _lldb.SBCommandInterpreter_InterruptCommand(self)
3539
3979
 
3540
3980
  def SetCommandOverrideCallback(self, command_name, callback):
@@ -3542,11 +3982,35 @@ class SBCommandInterpreter(object):
3542
3982
  return _lldb.SBCommandInterpreter_SetCommandOverrideCallback(self, command_name, callback)
3543
3983
 
3544
3984
  def IsActive(self):
3545
- r"""IsActive(SBCommandInterpreter self) -> bool"""
3985
+ r"""
3986
+ Return true if the command interpreter is the active IO handler.
3987
+
3988
+ This indicates that any input coming into the debugger handles will
3989
+ go to the command interpreter and will result in LLDB command line
3990
+ commands being executed.
3991
+ """
3546
3992
  return _lldb.SBCommandInterpreter_IsActive(self)
3547
3993
 
3548
3994
  def GetIOHandlerControlSequence(self, ch):
3549
- r"""GetIOHandlerControlSequence(SBCommandInterpreter self, char ch) -> char const *"""
3995
+ r"""
3996
+ Get the string that needs to be written to the debugger stdin file
3997
+ handle when a control character is typed.
3998
+
3999
+ Some GUI programs will intercept "control + char" sequences and want
4000
+ to have them do what normally would happen when using a real
4001
+ terminal, so this function allows GUI programs to emulate this
4002
+ functionality.
4003
+
4004
+ :type ch: char, in
4005
+ :param ch:
4006
+ The character that was typed along with the control key
4007
+
4008
+ :rtype: string
4009
+ :return:
4010
+ The string that should be written into the file handle that is
4011
+ feeding the input stream for the debugger, or nullptr if there is
4012
+ no string for this control key.
4013
+ """
3550
4014
  return _lldb.SBCommandInterpreter_GetIOHandlerControlSequence(self, ch)
3551
4015
 
3552
4016
  def GetPromptOnQuit(self):
@@ -3558,19 +4022,32 @@ class SBCommandInterpreter(object):
3558
4022
  return _lldb.SBCommandInterpreter_SetPromptOnQuit(self, b)
3559
4023
 
3560
4024
  def AllowExitCodeOnQuit(self, allow):
3561
- r"""AllowExitCodeOnQuit(SBCommandInterpreter self, bool allow)"""
4025
+ r"""
4026
+ Sets whether the command interpreter should allow custom exit codes
4027
+ for the 'quit' command.
4028
+ """
3562
4029
  return _lldb.SBCommandInterpreter_AllowExitCodeOnQuit(self, allow)
3563
4030
 
3564
4031
  def HasCustomQuitExitCode(self):
3565
- r"""HasCustomQuitExitCode(SBCommandInterpreter self) -> bool"""
4032
+ r"""
4033
+ Returns true if the user has called the 'quit' command with a custom exit
4034
+ code.
4035
+ """
3566
4036
  return _lldb.SBCommandInterpreter_HasCustomQuitExitCode(self)
3567
4037
 
3568
4038
  def GetQuitStatus(self):
3569
- r"""GetQuitStatus(SBCommandInterpreter self) -> int"""
4039
+ r"""
4040
+ Returns the exit code that the user has specified when running the
4041
+ 'quit' command. Returns 0 if the user hasn't called 'quit' at all or
4042
+ without a custom exit code.
4043
+ """
3570
4044
  return _lldb.SBCommandInterpreter_GetQuitStatus(self)
3571
4045
 
3572
4046
  def ResolveCommand(self, command_line, result):
3573
- r"""ResolveCommand(SBCommandInterpreter self, char const * command_line, SBCommandReturnObject result)"""
4047
+ r"""
4048
+ Resolve the command just as HandleCommand would, expanding abbreviations
4049
+ and aliases. If successful, result->GetOutput has the full expansion.
4050
+ """
3574
4051
  return _lldb.SBCommandInterpreter_ResolveCommand(self, command_line, result)
3575
4052
 
3576
4053
  def GetStatistics(self):
@@ -3578,9 +4055,27 @@ class SBCommandInterpreter(object):
3578
4055
  return _lldb.SBCommandInterpreter_GetStatistics(self)
3579
4056
 
3580
4057
  def GetTranscript(self):
3581
- r"""GetTranscript(SBCommandInterpreter self) -> SBStructuredData"""
4058
+ r"""
4059
+ Returns a list of handled commands, output and error. Each element in
4060
+ the list is a dictionary with the following keys/values:
4061
+ - "command" (string): The command that was given by the user.
4062
+ - "commandName" (string): The name of the executed command.
4063
+ - "commandArguments" (string): The arguments of the executed command.
4064
+ - "output" (string): The output of the command. Empty ("") if no output.
4065
+ - "error" (string): The error of the command. Empty ("") if no error.
4066
+ - "durationInSeconds" (float): The time it took to execute the command.
4067
+ - "timestampInEpochSeconds" (int): The timestamp when the command is
4068
+ executed.
4069
+
4070
+ Turn on settings `interpreter.save-transcript` for LLDB to populate
4071
+ this list. Otherwise this list is empty.
4072
+ """
3582
4073
  return _lldb.SBCommandInterpreter_GetTranscript(self)
3583
4074
 
4075
+ def SetPrintCallback(self, callback):
4076
+ r"""SetPrintCallback(SBCommandInterpreter self, lldb::SBCommandPrintCallback callback)"""
4077
+ return _lldb.SBCommandInterpreter_SetPrintCallback(self, callback)
4078
+
3584
4079
  # Register SBCommandInterpreter in _lldb:
3585
4080
  _lldb.SBCommandInterpreter_swigregister(SBCommandInterpreter)
3586
4081
  class SBCommandInterpreterRunOptions(object):
@@ -3699,7 +4194,12 @@ class SBCommandInterpreterRunOptions(object):
3699
4194
  return _lldb.SBCommandInterpreterRunOptions_GetAllowRepeats(self)
3700
4195
 
3701
4196
  def SetAllowRepeats(self, arg2):
3702
- r"""SetAllowRepeats(SBCommandInterpreterRunOptions self, bool arg2)"""
4197
+ r"""
4198
+ By default, RunCommandInterpreter will discard repeats if the
4199
+ IOHandler being used is not interactive. Setting AllowRepeats to true
4200
+ will override this behavior and always process empty lines in the input
4201
+ as a repeat command.
4202
+ """
3703
4203
  return _lldb.SBCommandInterpreterRunOptions_SetAllowRepeats(self, arg2)
3704
4204
 
3705
4205
  # Register SBCommandInterpreterRunOptions in _lldb:
@@ -3733,6 +4233,13 @@ class SBCommandReturnObject(object):
3733
4233
  r"""IsValid(SBCommandReturnObject self) -> bool"""
3734
4234
  return _lldb.SBCommandReturnObject_IsValid(self)
3735
4235
 
4236
+ def GetCommand(self):
4237
+ r"""
4238
+ Get the command as the user typed it. Empty string if commands were run on
4239
+ behalf of lldb.
4240
+ """
4241
+ return _lldb.SBCommandReturnObject_GetCommand(self)
4242
+
3736
4243
  def GetErrorData(self):
3737
4244
  r"""GetErrorData(SBCommandReturnObject self) -> SBStructuredData"""
3738
4245
  return _lldb.SBCommandReturnObject_GetErrorData(self)
@@ -3816,6 +4323,10 @@ class SBCommandReturnObject(object):
3816
4323
  """
3817
4324
  return _lldb.SBCommandReturnObject_SetError(self, *args)
3818
4325
 
4326
+ def GetValues(self, use_dynamic):
4327
+ r"""GetValues(SBCommandReturnObject self, lldb::DynamicValueType use_dynamic) -> SBValueList"""
4328
+ return _lldb.SBCommandReturnObject_GetValues(self, use_dynamic)
4329
+
3819
4330
  def __repr__(self):
3820
4331
  r"""__repr__(SBCommandReturnObject self) -> std::string"""
3821
4332
  return _lldb.SBCommandReturnObject___repr__(self)
@@ -3856,15 +4367,15 @@ class SBCommunication(object):
3856
4367
  thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3857
4368
  __repr__ = _swig_repr
3858
4369
  eBroadcastBitDisconnected = _lldb.SBCommunication_eBroadcastBitDisconnected
3859
-
4370
+ r"""Sent when the communications connection is lost."""
3860
4371
  eBroadcastBitReadThreadGotBytes = _lldb.SBCommunication_eBroadcastBitReadThreadGotBytes
3861
-
4372
+ r"""Sent by the read thread when bytes become available."""
3862
4373
  eBroadcastBitReadThreadDidExit = _lldb.SBCommunication_eBroadcastBitReadThreadDidExit
3863
-
4374
+ r"""Sent by the read thread when it exits to inform clients."""
3864
4375
  eBroadcastBitReadThreadShouldExit = _lldb.SBCommunication_eBroadcastBitReadThreadShouldExit
3865
-
4376
+ r"""Sent by clients that need to cancel the read thread."""
3866
4377
  eBroadcastBitPacketAvailable = _lldb.SBCommunication_eBroadcastBitPacketAvailable
3867
-
4378
+ r"""Sent when data received makes a complete packet."""
3868
4379
  eAllEventBits = _lldb.SBCommunication_eAllEventBits
3869
4380
 
3870
4381
 
@@ -4127,16 +4638,13 @@ class SBSaveCoreOptions(object):
4127
4638
  SBSaveCoreOptions includes API's to specify the memory regions and threads to include
4128
4639
  when generating a core file. It extends the existing SaveCoreStyle option.
4129
4640
 
4130
- * eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in
4131
- the options object.
4641
+ * eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in the options object.
4132
4642
 
4133
- * eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified
4134
- in the options object if they are not already captured.
4643
+ * eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified in the options object if they are not already captured.
4135
4644
 
4136
4645
  * eSaveCoreStackOnly will capture all threads, but no memory regions unless specified.
4137
4646
 
4138
- * eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified.
4139
- Picking custom and specifying nothing will result in an error being returned.
4647
+ * eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified. Picking custom and specifying nothing will result in an error being returned.
4140
4648
 
4141
4649
  Note that currently ELF Core files are not supported.
4142
4650
  """
@@ -4244,6 +4752,15 @@ class SBSaveCoreOptions(object):
4244
4752
  """
4245
4753
  return _lldb.SBSaveCoreOptions_GetThreadsToSave(self)
4246
4754
 
4755
+ def GetCurrentSizeInBytes(self, error):
4756
+ r"""
4757
+ GetCurrentSizeInBytes(SBSaveCoreOptions self, SBError error) -> uint64_t
4758
+
4759
+ Get the current total number of bytes the core is expected to have, excluding the overhead of the core file format.
4760
+ Requires both a Process and a Style to be specified. An error will be returned if the provided options would result in no data being saved.
4761
+ """
4762
+ return _lldb.SBSaveCoreOptions_GetCurrentSizeInBytes(self, error)
4763
+
4247
4764
  def Clear(self):
4248
4765
  r"""
4249
4766
  Clear(SBSaveCoreOptions self)
@@ -4721,75 +5238,140 @@ class SBDebugger(object):
4721
5238
 
4722
5239
  @staticmethod
4723
5240
  def GetBroadcasterClass():
4724
- r"""GetBroadcasterClass() -> char const *"""
5241
+ r"""Get the broadcaster class name."""
4725
5242
  return _lldb.SBDebugger_GetBroadcasterClass()
4726
5243
 
4727
5244
  @staticmethod
4728
5245
  def SupportsLanguage(language):
4729
- r"""SupportsLanguage(lldb::LanguageType language) -> bool"""
5246
+ r"""Check if a specific language is supported by LLDB."""
4730
5247
  return _lldb.SBDebugger_SupportsLanguage(language)
4731
5248
 
4732
5249
  def GetBroadcaster(self):
4733
- r"""GetBroadcaster(SBDebugger self) -> SBBroadcaster"""
5250
+ r"""
5251
+ Get the broadcaster that allows subscribing to events from this
5252
+ debugger.
5253
+ """
4734
5254
  return _lldb.SBDebugger_GetBroadcaster(self)
4735
5255
 
4736
5256
  @staticmethod
4737
5257
  def GetProgressFromEvent(event):
4738
- r"""GetProgressFromEvent(SBEvent event) -> char const *"""
5258
+ r"""
5259
+ Get progress data from a SBEvent whose type is eBroadcastBitProgress.
5260
+
5261
+ :param [in]: event
5262
+ The event to extract the progress information from.
5263
+
5264
+ :param [out]: progress_id
5265
+ The unique integer identifier for the progress to report.
5266
+
5267
+ :param [out]: completed
5268
+ The amount of work completed. If *completed* is zero, then this event
5269
+ is a progress started event. If *completed* is equal to *total*, then
5270
+ this event is a progress end event. Otherwise completed indicates the
5271
+ current progress update.
5272
+
5273
+ :param [out]: total
5274
+ The total amount of work units that need to be completed. If this value
5275
+ is UINT64_MAX, then an indeterminate progress indicator should be
5276
+ displayed.
5277
+
5278
+ :param [out]: is_debugger_specific
5279
+ Set to true if this progress is specific to this debugger only. Many
5280
+ progress events are not specific to a debugger instance, like any
5281
+ progress events for loading information in modules since LLDB has a
5282
+ global module cache that all debuggers use.
5283
+
5284
+ :rtype: string
5285
+ :return: The message for the progress. If the returned value is NULL, then
5286
+ *event* was not a eBroadcastBitProgress event.
5287
+ """
4739
5288
  return _lldb.SBDebugger_GetProgressFromEvent(event)
4740
5289
 
4741
5290
  @staticmethod
4742
5291
  def GetProgressDataFromEvent(event):
4743
- r"""GetProgressDataFromEvent(SBEvent event) -> SBStructuredData"""
5292
+ r"""Get progress data from an event."""
4744
5293
  return _lldb.SBDebugger_GetProgressDataFromEvent(event)
4745
5294
 
4746
5295
  @staticmethod
4747
5296
  def GetDiagnosticFromEvent(event):
4748
- r"""GetDiagnosticFromEvent(SBEvent event) -> SBStructuredData"""
5297
+ r"""Get diagnostic information from an event."""
4749
5298
  return _lldb.SBDebugger_GetDiagnosticFromEvent(event)
4750
5299
 
4751
5300
  @staticmethod
4752
5301
  def Initialize():
4753
- r"""Initialize()"""
5302
+ r"""
5303
+ Initialize LLDB and its subsystems.
5304
+
5305
+ This function should be called before any other LLDB functions. It
5306
+ initializes all required subsystems for proper LLDB functionality.
5307
+ """
4754
5308
  return _lldb.SBDebugger_Initialize()
4755
5309
 
4756
5310
  @staticmethod
4757
5311
  def InitializeWithErrorHandling():
4758
- r"""InitializeWithErrorHandling() -> SBError"""
5312
+ r"""
5313
+ Initialize the LLDB debugger subsystem with error handling.
5314
+
5315
+ Similar to Initialize(), but returns an error if initialization fails.
5316
+ """
4759
5317
  return _lldb.SBDebugger_InitializeWithErrorHandling()
4760
5318
 
4761
5319
  @staticmethod
4762
5320
  def PrintStackTraceOnError():
4763
- r"""PrintStackTraceOnError()"""
5321
+ r"""Configure LLDB to print a stack trace when it crashes."""
4764
5322
  return _lldb.SBDebugger_PrintStackTraceOnError()
4765
5323
 
4766
5324
  @staticmethod
4767
5325
  def PrintDiagnosticsOnError():
4768
- r"""PrintDiagnosticsOnError()"""
5326
+ r"""Configure LLDB to print diagnostic information when it crashes."""
4769
5327
  return _lldb.SBDebugger_PrintDiagnosticsOnError()
4770
5328
 
4771
5329
  @staticmethod
4772
5330
  def Terminate():
4773
- r"""Terminate()"""
5331
+ r"""
5332
+ Terminate LLDB and its subsystems.
5333
+
5334
+ This should be called when LLDB is no longer needed.
5335
+ """
4774
5336
  return _lldb.SBDebugger_Terminate()
4775
5337
 
4776
5338
  @staticmethod
4777
5339
  def Create(*args):
4778
5340
  r"""
4779
- Create() -> SBDebugger
4780
- Create(bool source_init_files) -> SBDebugger
4781
- Create(bool source_init_files, lldb::LogOutputCallback log_callback) -> SBDebugger
5341
+ *Overload 1:*
5342
+ Create a new debugger instance (deprecated).
5343
+
5344
+ |
5345
+
5346
+ *Overload 2:*
5347
+ Create a new debugger instance.
5348
+
5349
+ If source_init_files is true, the debugger will source .lldbinit files
5350
+ from the home directory and current directory.
5351
+
5352
+ |
5353
+
5354
+ *Overload 3:*
5355
+ Create a new debugger instance with a custom log handler and user data
5356
+ passed to the log callback.
5357
+
5358
+ If source_init_files is true, the debugger will source .lldbinit files
5359
+ from the home directory and current directory.
4782
5360
  """
4783
5361
  return _lldb.SBDebugger_Create(*args)
4784
5362
 
4785
5363
  @staticmethod
4786
5364
  def Destroy(debugger):
4787
- r"""Destroy(SBDebugger debugger)"""
5365
+ r"""Destroy a debugger instance."""
4788
5366
  return _lldb.SBDebugger_Destroy(debugger)
4789
5367
 
4790
5368
  @staticmethod
4791
5369
  def MemoryPressureDetected():
4792
- r"""MemoryPressureDetected()"""
5370
+ r"""
5371
+ Notify the debugger that system memory pressure has been detected.
5372
+
5373
+ This can be used to free up memory resources by clearing caches.
5374
+ """
4793
5375
  return _lldb.SBDebugger_MemoryPressureDetected()
4794
5376
 
4795
5377
  def __nonzero__(self):
@@ -4799,121 +5381,170 @@ class SBDebugger(object):
4799
5381
 
4800
5382
 
4801
5383
  def IsValid(self):
4802
- r"""IsValid(SBDebugger self) -> bool"""
5384
+ r"""Check if this is a valid SBDebugger object."""
4803
5385
  return _lldb.SBDebugger_IsValid(self)
4804
5386
 
4805
5387
  def Clear(self):
4806
- r"""Clear(SBDebugger self)"""
5388
+ r"""
5389
+ Clear this debugger instance.
5390
+
5391
+ This will close all IO handlers and reset the debugger to its initial
5392
+ state.
5393
+ """
4807
5394
  return _lldb.SBDebugger_Clear(self)
4808
5395
 
4809
5396
  def GetSetting(self, setting=None):
4810
- r"""GetSetting(SBDebugger self, char const * setting=None) -> SBStructuredData"""
5397
+ r"""
5398
+ Get debugger settings as structured data.
5399
+
5400
+ Client can specify empty string or null to get all settings.
5401
+
5402
+ Example usages:
5403
+ lldb::SBStructuredData settings = debugger.GetSetting();
5404
+ lldb::SBStructuredData settings = debugger.GetSetting(nullptr);
5405
+ lldb::SBStructuredData settings = debugger.GetSetting("");
5406
+ lldb::SBStructuredData settings = debugger.GetSetting("target.arg0");
5407
+ lldb::SBStructuredData settings = debugger.GetSetting("target");
5408
+ """
4811
5409
  return _lldb.SBDebugger_GetSetting(self, setting)
4812
5410
 
4813
5411
  def SetAsync(self, b):
4814
- r"""SetAsync(SBDebugger self, bool b)"""
5412
+ r"""
5413
+ Set whether the debugger should run in asynchronous mode.
5414
+
5415
+ When in asynchronous mode, events are processed on a background thread.
5416
+ """
4815
5417
  return _lldb.SBDebugger_SetAsync(self, b)
4816
5418
 
4817
5419
  def GetAsync(self):
4818
- r"""GetAsync(SBDebugger self) -> bool"""
5420
+ r"""Get whether the debugger is running in asynchronous mode."""
4819
5421
  return _lldb.SBDebugger_GetAsync(self)
4820
5422
 
4821
5423
  def SkipLLDBInitFiles(self, b):
4822
- r"""SkipLLDBInitFiles(SBDebugger self, bool b)"""
5424
+ r"""Set whether to skip loading .lldbinit files."""
4823
5425
  return _lldb.SBDebugger_SkipLLDBInitFiles(self, b)
4824
5426
 
4825
5427
  def SkipAppInitFiles(self, b):
4826
- r"""SkipAppInitFiles(SBDebugger self, bool b)"""
5428
+ r"""Set whether to skip loading application-specific .lldbinit files."""
4827
5429
  return _lldb.SBDebugger_SkipAppInitFiles(self, b)
4828
5430
 
4829
5431
  def SetInputString(self, data):
4830
- r"""SetInputString(SBDebugger self, char const * data) -> SBError"""
5432
+ r"""Set the input from a string."""
4831
5433
  return _lldb.SBDebugger_SetInputString(self, data)
4832
5434
 
4833
5435
  def SetInputFile(self, *args):
4834
5436
  r"""
4835
- SetInputFile(SBDebugger self, SBFile file) -> SBError
4836
- SetInputFile(SBDebugger self, lldb::FileSP file) -> SBError
5437
+ *Overload 1:*
5438
+ Set the input file for the debugger.
5439
+
5440
+ |
5441
+
5442
+ *Overload 2:*
5443
+ Set the input file for the debugger using a FileSP.
4837
5444
  """
4838
5445
  return _lldb.SBDebugger_SetInputFile(self, *args)
4839
5446
 
4840
5447
  def SetOutputFile(self, *args):
4841
5448
  r"""
4842
- SetOutputFile(SBDebugger self, SBFile file) -> SBError
4843
- SetOutputFile(SBDebugger self, lldb::FileSP file) -> SBError
5449
+ *Overload 1:*
5450
+ Set the output file for the debugger.
5451
+
5452
+ |
5453
+
5454
+ *Overload 2:*
5455
+ Set the output file for the debugger using a FileSP.
4844
5456
  """
4845
5457
  return _lldb.SBDebugger_SetOutputFile(self, *args)
4846
5458
 
4847
5459
  def SetErrorFile(self, *args):
4848
5460
  r"""
4849
- SetErrorFile(SBDebugger self, SBFile file) -> SBError
4850
- SetErrorFile(SBDebugger self, lldb::FileSP file) -> SBError
5461
+ *Overload 1:*
5462
+ Set the error file for the debugger.
5463
+
5464
+ |
5465
+
5466
+ *Overload 2:*
5467
+ Set the error file for the debugger using a FileSP.
4851
5468
  """
4852
5469
  return _lldb.SBDebugger_SetErrorFile(self, *args)
4853
5470
 
4854
5471
  def GetInputFile(self):
4855
- r"""GetInputFile(SBDebugger self) -> SBFile"""
5472
+ r"""Get the input file for the debugger."""
4856
5473
  return _lldb.SBDebugger_GetInputFile(self)
4857
5474
 
4858
5475
  def GetOutputFile(self):
4859
- r"""GetOutputFile(SBDebugger self) -> SBFile"""
5476
+ r"""Get the output file for the debugger."""
4860
5477
  return _lldb.SBDebugger_GetOutputFile(self)
4861
5478
 
4862
5479
  def GetErrorFile(self):
4863
- r"""GetErrorFile(SBDebugger self) -> SBFile"""
5480
+ r"""Get the error file for the debugger."""
4864
5481
  return _lldb.SBDebugger_GetErrorFile(self)
4865
5482
 
4866
5483
  def SaveInputTerminalState(self):
4867
- r"""SaveInputTerminalState(SBDebugger self)"""
5484
+ r"""
5485
+ Save the current terminal state.
5486
+
5487
+ This should be called before modifying terminal settings.
5488
+ """
4868
5489
  return _lldb.SBDebugger_SaveInputTerminalState(self)
4869
5490
 
4870
5491
  def RestoreInputTerminalState(self):
4871
- r"""RestoreInputTerminalState(SBDebugger self)"""
5492
+ r"""Restore the previously saved terminal state."""
4872
5493
  return _lldb.SBDebugger_RestoreInputTerminalState(self)
4873
5494
 
4874
5495
  def GetCommandInterpreter(self):
4875
- r"""GetCommandInterpreter(SBDebugger self) -> SBCommandInterpreter"""
5496
+ r"""Get the command interpreter for this debugger."""
4876
5497
  return _lldb.SBDebugger_GetCommandInterpreter(self)
4877
5498
 
4878
5499
  def HandleCommand(self, command):
4879
- r"""HandleCommand(SBDebugger self, char const * command)"""
5500
+ r"""Execute a command in the command interpreter."""
4880
5501
  return _lldb.SBDebugger_HandleCommand(self, command)
4881
5502
 
4882
5503
  def RequestInterrupt(self):
4883
- r"""RequestInterrupt(SBDebugger self)"""
5504
+ r"""Request an interrupt of the current operation."""
4884
5505
  return _lldb.SBDebugger_RequestInterrupt(self)
4885
5506
 
4886
5507
  def CancelInterruptRequest(self):
4887
- r"""CancelInterruptRequest(SBDebugger self)"""
5508
+ r"""Cancel a previously requested interrupt."""
4888
5509
  return _lldb.SBDebugger_CancelInterruptRequest(self)
4889
5510
 
4890
5511
  def InterruptRequested(self):
4891
- r"""InterruptRequested(SBDebugger self) -> bool"""
5512
+ r"""Check if an interrupt has been requested."""
4892
5513
  return _lldb.SBDebugger_InterruptRequested(self)
4893
5514
 
4894
5515
  def GetListener(self):
4895
- r"""GetListener(SBDebugger self) -> SBListener"""
5516
+ r"""Get the listener associated with this debugger."""
4896
5517
  return _lldb.SBDebugger_GetListener(self)
4897
5518
 
4898
5519
  def HandleProcessEvent(self, *args):
4899
5520
  r"""
4900
- HandleProcessEvent(SBDebugger self, SBProcess process, SBEvent event, SBFile out, SBFile err)
4901
- HandleProcessEvent(SBDebugger self, SBProcess process, SBEvent event, lldb::FileSP arg4, lldb::FileSP arg5)
5521
+ *Overload 1:*
5522
+ Handle a process event.
5523
+
5524
+ |
5525
+
5526
+ *Overload 2:*
5527
+ Handle a process event using FileSP objects.
4902
5528
  """
4903
5529
  return _lldb.SBDebugger_HandleProcessEvent(self, *args)
4904
5530
 
4905
5531
  def CreateTargetWithFileAndTargetTriple(self, filename, target_triple):
4906
- r"""CreateTargetWithFileAndTargetTriple(SBDebugger self, char const * filename, char const * target_triple) -> SBTarget"""
5532
+ r"""Create a target with the specified file and target triple."""
4907
5533
  return _lldb.SBDebugger_CreateTargetWithFileAndTargetTriple(self, filename, target_triple)
4908
5534
 
4909
5535
  def CreateTargetWithFileAndArch(self, filename, archname):
4910
- r"""CreateTargetWithFileAndArch(SBDebugger self, char const * filename, char const * archname) -> SBTarget"""
5536
+ r"""Create a target with the specified file and architecture."""
4911
5537
  return _lldb.SBDebugger_CreateTargetWithFileAndArch(self, filename, archname)
4912
5538
 
4913
5539
  def CreateTarget(self, *args):
4914
5540
  r"""
4915
- CreateTarget(SBDebugger self, char const * filename, char const * target_triple, char const * platform_name, bool add_dependent_modules, SBError error) -> SBTarget
4916
- CreateTarget(SBDebugger self, char const * filename) -> SBTarget
5541
+ *Overload 1:*
5542
+ Create a target with the specified parameters.
5543
+
5544
+ |
5545
+
5546
+ *Overload 2:*
5547
+ Create a target with the specified file.
4917
5548
  """
4918
5549
  return _lldb.SBDebugger_CreateTarget(self, *args)
4919
5550
 
@@ -4932,39 +5563,39 @@ class SBDebugger(object):
4932
5563
  return _lldb.SBDebugger_DeleteTarget(self, target)
4933
5564
 
4934
5565
  def GetTargetAtIndex(self, idx):
4935
- r"""GetTargetAtIndex(SBDebugger self, uint32_t idx) -> SBTarget"""
5566
+ r"""Get a target by index."""
4936
5567
  return _lldb.SBDebugger_GetTargetAtIndex(self, idx)
4937
5568
 
4938
5569
  def GetIndexOfTarget(self, target):
4939
- r"""GetIndexOfTarget(SBDebugger self, SBTarget target) -> uint32_t"""
5570
+ r"""Get the index of a target."""
4940
5571
  return _lldb.SBDebugger_GetIndexOfTarget(self, target)
4941
5572
 
4942
5573
  def FindTargetWithProcessID(self, pid):
4943
- r"""FindTargetWithProcessID(SBDebugger self, lldb::pid_t pid) -> SBTarget"""
5574
+ r"""Find a target with the specified process ID."""
4944
5575
  return _lldb.SBDebugger_FindTargetWithProcessID(self, pid)
4945
5576
 
4946
5577
  def FindTargetWithFileAndArch(self, filename, arch):
4947
- r"""FindTargetWithFileAndArch(SBDebugger self, char const * filename, char const * arch) -> SBTarget"""
5578
+ r"""Find a target with the specified file and architecture."""
4948
5579
  return _lldb.SBDebugger_FindTargetWithFileAndArch(self, filename, arch)
4949
5580
 
4950
5581
  def GetNumTargets(self):
4951
- r"""GetNumTargets(SBDebugger self) -> uint32_t"""
5582
+ r"""Get the number of targets in the debugger."""
4952
5583
  return _lldb.SBDebugger_GetNumTargets(self)
4953
5584
 
4954
5585
  def GetSelectedTarget(self):
4955
- r"""GetSelectedTarget(SBDebugger self) -> SBTarget"""
5586
+ r"""Get the currently selected target."""
4956
5587
  return _lldb.SBDebugger_GetSelectedTarget(self)
4957
5588
 
4958
5589
  def SetSelectedTarget(self, target):
4959
- r"""SetSelectedTarget(SBDebugger self, SBTarget target)"""
5590
+ r"""Set the selected target."""
4960
5591
  return _lldb.SBDebugger_SetSelectedTarget(self, target)
4961
5592
 
4962
5593
  def GetSelectedPlatform(self):
4963
- r"""GetSelectedPlatform(SBDebugger self) -> SBPlatform"""
5594
+ r"""Get the selected platform."""
4964
5595
  return _lldb.SBDebugger_GetSelectedPlatform(self)
4965
5596
 
4966
5597
  def SetSelectedPlatform(self, platform):
4967
- r"""SetSelectedPlatform(SBDebugger self, SBPlatform platform)"""
5598
+ r"""Set the selected platform."""
4968
5599
  return _lldb.SBDebugger_SetSelectedPlatform(self, platform)
4969
5600
 
4970
5601
  def GetNumPlatforms(self):
@@ -5001,244 +5632,257 @@ class SBDebugger(object):
5001
5632
  return _lldb.SBDebugger_GetAvailablePlatformInfoAtIndex(self, idx)
5002
5633
 
5003
5634
  def GetSourceManager(self):
5004
- r"""GetSourceManager(SBDebugger self) -> SBSourceManager"""
5635
+ r"""Get the source manager for this debugger."""
5005
5636
  return _lldb.SBDebugger_GetSourceManager(self)
5006
5637
 
5007
5638
  def SetCurrentPlatform(self, platform_name):
5008
- r"""SetCurrentPlatform(SBDebugger self, char const * platform_name) -> SBError"""
5639
+ r"""Set the current platform by name."""
5009
5640
  return _lldb.SBDebugger_SetCurrentPlatform(self, platform_name)
5010
5641
 
5011
5642
  def SetCurrentPlatformSDKRoot(self, sysroot):
5012
- r"""SetCurrentPlatformSDKRoot(SBDebugger self, char const * sysroot) -> bool"""
5643
+ r"""Set the SDK root for the current platform."""
5013
5644
  return _lldb.SBDebugger_SetCurrentPlatformSDKRoot(self, sysroot)
5014
5645
 
5015
5646
  def SetUseExternalEditor(self, input):
5016
- r"""SetUseExternalEditor(SBDebugger self, bool input) -> bool"""
5647
+ r"""Set whether to use an external editor."""
5017
5648
  return _lldb.SBDebugger_SetUseExternalEditor(self, input)
5018
5649
 
5019
5650
  def GetUseExternalEditor(self):
5020
- r"""GetUseExternalEditor(SBDebugger self) -> bool"""
5651
+ r"""Get whether an external editor is being used."""
5021
5652
  return _lldb.SBDebugger_GetUseExternalEditor(self)
5022
5653
 
5023
5654
  def SetUseColor(self, use_color):
5024
- r"""SetUseColor(SBDebugger self, bool use_color) -> bool"""
5655
+ r"""Set whether to use color in output."""
5025
5656
  return _lldb.SBDebugger_SetUseColor(self, use_color)
5026
5657
 
5027
5658
  def GetUseColor(self):
5028
- r"""GetUseColor(SBDebugger self) -> bool"""
5659
+ r"""Get whether color is being used in output."""
5029
5660
  return _lldb.SBDebugger_GetUseColor(self)
5030
5661
 
5031
- def SetShowInlineDiagnostics(self, arg2):
5032
- r"""SetShowInlineDiagnostics(SBDebugger self, bool arg2) -> bool"""
5033
- return _lldb.SBDebugger_SetShowInlineDiagnostics(self, arg2)
5662
+ def SetShowInlineDiagnostics(self, b):
5663
+ r"""Set whether to show inline diagnostics."""
5664
+ return _lldb.SBDebugger_SetShowInlineDiagnostics(self, b)
5034
5665
 
5035
5666
  def SetUseSourceCache(self, use_source_cache):
5036
- r"""SetUseSourceCache(SBDebugger self, bool use_source_cache) -> bool"""
5667
+ r"""Set whether to use the source cache."""
5037
5668
  return _lldb.SBDebugger_SetUseSourceCache(self, use_source_cache)
5038
5669
 
5039
5670
  def GetUseSourceCache(self):
5040
- r"""GetUseSourceCache(SBDebugger self) -> bool"""
5671
+ r"""Get whether the source cache is being used."""
5041
5672
  return _lldb.SBDebugger_GetUseSourceCache(self)
5042
5673
 
5043
5674
  @staticmethod
5044
5675
  def GetDefaultArchitecture(arch_name, arch_name_len):
5045
- r"""GetDefaultArchitecture(char * arch_name, size_t arch_name_len) -> bool"""
5676
+ r"""Get the default architecture."""
5046
5677
  return _lldb.SBDebugger_GetDefaultArchitecture(arch_name, arch_name_len)
5047
5678
 
5048
5679
  @staticmethod
5049
5680
  def SetDefaultArchitecture(arch_name):
5050
- r"""SetDefaultArchitecture(char const * arch_name) -> bool"""
5681
+ r"""Set the default architecture."""
5051
5682
  return _lldb.SBDebugger_SetDefaultArchitecture(arch_name)
5052
5683
 
5053
5684
  def GetScriptingLanguage(self, script_language_name):
5054
- r"""GetScriptingLanguage(SBDebugger self, char const * script_language_name) -> lldb::ScriptLanguage"""
5685
+ r"""Get the scripting language by name."""
5055
5686
  return _lldb.SBDebugger_GetScriptingLanguage(self, script_language_name)
5056
5687
 
5057
- def GetScriptInterpreterInfo(self, arg2):
5058
- r"""GetScriptInterpreterInfo(SBDebugger self, lldb::ScriptLanguage arg2) -> SBStructuredData"""
5059
- return _lldb.SBDebugger_GetScriptInterpreterInfo(self, arg2)
5688
+ def GetScriptInterpreterInfo(self, language):
5689
+ r"""Get information about a script interpreter as structured data."""
5690
+ return _lldb.SBDebugger_GetScriptInterpreterInfo(self, language)
5060
5691
 
5061
5692
  @staticmethod
5062
5693
  def GetVersionString():
5063
- r"""GetVersionString() -> char const *"""
5694
+ r"""Get the LLDB version string."""
5064
5695
  return _lldb.SBDebugger_GetVersionString()
5065
5696
 
5066
5697
  @staticmethod
5067
5698
  def StateAsCString(state):
5068
- r"""StateAsCString(lldb::StateType state) -> char const *"""
5699
+ r"""Convert a state type to a string."""
5069
5700
  return _lldb.SBDebugger_StateAsCString(state)
5070
5701
 
5071
5702
  @staticmethod
5072
5703
  def GetBuildConfiguration():
5073
- r"""GetBuildConfiguration() -> SBStructuredData"""
5704
+ r"""Get the build configuration as structured data."""
5074
5705
  return _lldb.SBDebugger_GetBuildConfiguration()
5075
5706
 
5076
5707
  @staticmethod
5077
5708
  def StateIsRunningState(state):
5078
- r"""StateIsRunningState(lldb::StateType state) -> bool"""
5709
+ r"""Check if a state is a running state."""
5079
5710
  return _lldb.SBDebugger_StateIsRunningState(state)
5080
5711
 
5081
5712
  @staticmethod
5082
5713
  def StateIsStoppedState(state):
5083
- r"""StateIsStoppedState(lldb::StateType state) -> bool"""
5714
+ r"""Check if a state is a stopped state."""
5084
5715
  return _lldb.SBDebugger_StateIsStoppedState(state)
5085
5716
 
5086
5717
  def EnableLog(self, channel, categories):
5087
- r"""EnableLog(SBDebugger self, char const * channel, char const ** categories) -> bool"""
5718
+ r"""Enable logging for a specific channel and category."""
5088
5719
  return _lldb.SBDebugger_EnableLog(self, channel, categories)
5089
5720
 
5090
5721
  def SetLoggingCallback(self, log_callback):
5091
- r"""SetLoggingCallback(SBDebugger self, lldb::LogOutputCallback log_callback)"""
5722
+ r"""Set a callback for log output."""
5092
5723
  return _lldb.SBDebugger_SetLoggingCallback(self, log_callback)
5093
5724
 
5094
5725
  def SetDestroyCallback(self, destroy_callback):
5095
- r"""SetDestroyCallback(SBDebugger self, lldb::SBDebuggerDestroyCallback destroy_callback)"""
5726
+ r"""Set a callback for when the debugger is destroyed (deprecated)."""
5096
5727
  return _lldb.SBDebugger_SetDestroyCallback(self, destroy_callback)
5097
5728
 
5098
5729
  def AddDestroyCallback(self, destroy_callback):
5099
- r"""AddDestroyCallback(SBDebugger self, lldb::SBDebuggerDestroyCallback destroy_callback) -> lldb::callback_token_t"""
5730
+ r"""
5731
+ Add a callback for when the debugger is destroyed. Returns a token that
5732
+ can be used to remove the callback.
5733
+ """
5100
5734
  return _lldb.SBDebugger_AddDestroyCallback(self, destroy_callback)
5101
5735
 
5102
5736
  def RemoveDestroyCallback(self, token):
5103
- r"""RemoveDestroyCallback(SBDebugger self, lldb::callback_token_t token) -> bool"""
5737
+ r"""Remove a destroy callback."""
5104
5738
  return _lldb.SBDebugger_RemoveDestroyCallback(self, token)
5105
5739
 
5106
5740
  def DispatchInput(self, data):
5107
- r"""DispatchInput(SBDebugger self, void const * data)"""
5741
+ r"""Dispatch input to the debugger."""
5108
5742
  return _lldb.SBDebugger_DispatchInput(self, data)
5109
5743
 
5110
5744
  def DispatchInputInterrupt(self):
5111
- r"""DispatchInputInterrupt(SBDebugger self)"""
5745
+ r"""Interrupt the current input dispatch."""
5112
5746
  return _lldb.SBDebugger_DispatchInputInterrupt(self)
5113
5747
 
5114
5748
  def DispatchInputEndOfFile(self):
5115
- r"""DispatchInputEndOfFile(SBDebugger self)"""
5749
+ r"""Signal end-of-file to the current input dispatch."""
5116
5750
  return _lldb.SBDebugger_DispatchInputEndOfFile(self)
5117
5751
 
5118
5752
  def GetInstanceName(self):
5119
- r"""GetInstanceName(SBDebugger self) -> char const *"""
5753
+ r"""Get the instance name of this debugger."""
5120
5754
  return _lldb.SBDebugger_GetInstanceName(self)
5121
5755
 
5122
5756
  @staticmethod
5123
5757
  def FindDebuggerWithID(id):
5124
- r"""FindDebuggerWithID(int id) -> SBDebugger"""
5758
+ r"""Find a debugger by ID. Returns an invalid debugger if not found."""
5125
5759
  return _lldb.SBDebugger_FindDebuggerWithID(id)
5126
5760
 
5127
5761
  @staticmethod
5128
5762
  def SetInternalVariable(var_name, value, debugger_instance_name):
5129
- r"""SetInternalVariable(char const * var_name, char const * value, char const * debugger_instance_name) -> SBError"""
5763
+ r"""Set an internal variable."""
5130
5764
  return _lldb.SBDebugger_SetInternalVariable(var_name, value, debugger_instance_name)
5131
5765
 
5132
5766
  @staticmethod
5133
5767
  def GetInternalVariableValue(var_name, debugger_instance_name):
5134
- r"""GetInternalVariableValue(char const * var_name, char const * debugger_instance_name) -> SBStringList"""
5768
+ r"""Get the value of an internal variable."""
5135
5769
  return _lldb.SBDebugger_GetInternalVariableValue(var_name, debugger_instance_name)
5136
5770
 
5137
5771
  def GetDescription(self, description):
5138
- r"""GetDescription(SBDebugger self, SBStream description) -> bool"""
5772
+ r"""Get a description of this debugger."""
5139
5773
  return _lldb.SBDebugger_GetDescription(self, description)
5140
5774
 
5141
5775
  def GetTerminalWidth(self):
5142
- r"""GetTerminalWidth(SBDebugger self) -> uint32_t"""
5776
+ r"""Get the terminal width."""
5143
5777
  return _lldb.SBDebugger_GetTerminalWidth(self)
5144
5778
 
5145
5779
  def SetTerminalWidth(self, term_width):
5146
- r"""SetTerminalWidth(SBDebugger self, uint32_t term_width)"""
5780
+ r"""Set the terminal width."""
5147
5781
  return _lldb.SBDebugger_SetTerminalWidth(self, term_width)
5148
5782
 
5149
5783
  def GetTerminalHeight(self):
5150
- r"""GetTerminalHeight(SBDebugger self) -> uint32_t"""
5784
+ r"""Get the terminal height."""
5151
5785
  return _lldb.SBDebugger_GetTerminalHeight(self)
5152
5786
 
5153
5787
  def SetTerminalHeight(self, term_height):
5154
- r"""SetTerminalHeight(SBDebugger self, uint32_t term_height)"""
5788
+ r"""Set the terminal height."""
5155
5789
  return _lldb.SBDebugger_SetTerminalHeight(self, term_height)
5156
5790
 
5157
5791
  def GetID(self):
5158
- r"""GetID(SBDebugger self) -> lldb::user_id_t"""
5792
+ r"""Get the unique ID of this debugger."""
5159
5793
  return _lldb.SBDebugger_GetID(self)
5160
5794
 
5161
5795
  def GetPrompt(self):
5162
- r"""GetPrompt(SBDebugger self) -> char const *"""
5796
+ r"""Get the command prompt string."""
5163
5797
  return _lldb.SBDebugger_GetPrompt(self)
5164
5798
 
5165
5799
  def SetPrompt(self, prompt):
5166
- r"""SetPrompt(SBDebugger self, char const * prompt)"""
5800
+ r"""Set the command prompt string."""
5167
5801
  return _lldb.SBDebugger_SetPrompt(self, prompt)
5168
5802
 
5169
5803
  def GetReproducerPath(self):
5170
- r"""GetReproducerPath(SBDebugger self) -> char const *"""
5804
+ r"""Get the path to the reproducer."""
5171
5805
  return _lldb.SBDebugger_GetReproducerPath(self)
5172
5806
 
5173
5807
  def GetScriptLanguage(self):
5174
- r"""GetScriptLanguage(SBDebugger self) -> lldb::ScriptLanguage"""
5808
+ r"""Get the current scripting language."""
5175
5809
  return _lldb.SBDebugger_GetScriptLanguage(self)
5176
5810
 
5177
5811
  def SetScriptLanguage(self, script_lang):
5178
- r"""SetScriptLanguage(SBDebugger self, lldb::ScriptLanguage script_lang)"""
5812
+ r"""Set the current scripting language."""
5179
5813
  return _lldb.SBDebugger_SetScriptLanguage(self, script_lang)
5180
5814
 
5181
5815
  def GetREPLLanguage(self):
5182
- r"""GetREPLLanguage(SBDebugger self) -> lldb::LanguageType"""
5816
+ r"""Get the current REPL language."""
5183
5817
  return _lldb.SBDebugger_GetREPLLanguage(self)
5184
5818
 
5185
5819
  def SetREPLLanguage(self, repl_lang):
5186
- r"""SetREPLLanguage(SBDebugger self, lldb::LanguageType repl_lang)"""
5820
+ r"""Set the current REPL language."""
5187
5821
  return _lldb.SBDebugger_SetREPLLanguage(self, repl_lang)
5188
5822
 
5189
5823
  def GetCloseInputOnEOF(self):
5190
- r"""GetCloseInputOnEOF(SBDebugger self) -> bool"""
5824
+ r"""Get whether to close input on EOF (deprecated)."""
5191
5825
  return _lldb.SBDebugger_GetCloseInputOnEOF(self)
5192
5826
 
5193
5827
  def SetCloseInputOnEOF(self, b):
5194
- r"""SetCloseInputOnEOF(SBDebugger self, bool b)"""
5828
+ r"""Set whether to close input on EOF (deprecated)."""
5195
5829
  return _lldb.SBDebugger_SetCloseInputOnEOF(self, b)
5196
5830
 
5197
5831
  def GetCategory(self, *args):
5198
5832
  r"""
5199
- GetCategory(SBDebugger self, char const * category_name) -> SBTypeCategory
5200
- GetCategory(SBDebugger self, lldb::LanguageType lang_type) -> SBTypeCategory
5833
+ *Overload 1:*
5834
+ Get a type category by name.
5835
+
5836
+ |
5837
+
5838
+ *Overload 2:*
5839
+ Get a type category by language.
5201
5840
  """
5202
5841
  return _lldb.SBDebugger_GetCategory(self, *args)
5203
5842
 
5204
5843
  def CreateCategory(self, category_name):
5205
- r"""CreateCategory(SBDebugger self, char const * category_name) -> SBTypeCategory"""
5844
+ r"""Create a new type category."""
5206
5845
  return _lldb.SBDebugger_CreateCategory(self, category_name)
5207
5846
 
5208
5847
  def DeleteCategory(self, category_name):
5209
- r"""DeleteCategory(SBDebugger self, char const * category_name) -> bool"""
5848
+ r"""Delete a type category."""
5210
5849
  return _lldb.SBDebugger_DeleteCategory(self, category_name)
5211
5850
 
5212
5851
  def GetNumCategories(self):
5213
- r"""GetNumCategories(SBDebugger self) -> uint32_t"""
5852
+ r"""Get the number of type categories."""
5214
5853
  return _lldb.SBDebugger_GetNumCategories(self)
5215
5854
 
5216
- def GetCategoryAtIndex(self, arg2):
5217
- r"""GetCategoryAtIndex(SBDebugger self, uint32_t arg2) -> SBTypeCategory"""
5218
- return _lldb.SBDebugger_GetCategoryAtIndex(self, arg2)
5855
+ def GetCategoryAtIndex(self, index):
5856
+ r"""Get a type category by index."""
5857
+ return _lldb.SBDebugger_GetCategoryAtIndex(self, index)
5219
5858
 
5220
5859
  def GetDefaultCategory(self):
5221
- r"""GetDefaultCategory(SBDebugger self) -> SBTypeCategory"""
5860
+ r"""Get the default type category."""
5222
5861
  return _lldb.SBDebugger_GetDefaultCategory(self)
5223
5862
 
5224
- def GetFormatForType(self, arg2):
5225
- r"""GetFormatForType(SBDebugger self, SBTypeNameSpecifier arg2) -> SBTypeFormat"""
5226
- return _lldb.SBDebugger_GetFormatForType(self, arg2)
5863
+ def GetFormatForType(self, type_name_spec):
5864
+ r"""Get the format for a type."""
5865
+ return _lldb.SBDebugger_GetFormatForType(self, type_name_spec)
5227
5866
 
5228
- def GetSummaryForType(self, arg2):
5229
- r"""GetSummaryForType(SBDebugger self, SBTypeNameSpecifier arg2) -> SBTypeSummary"""
5230
- return _lldb.SBDebugger_GetSummaryForType(self, arg2)
5867
+ def GetSummaryForType(self, type_name_spec):
5868
+ r"""Get the summary for a type."""
5869
+ return _lldb.SBDebugger_GetSummaryForType(self, type_name_spec)
5231
5870
 
5232
- def GetFilterForType(self, arg2):
5233
- r"""GetFilterForType(SBDebugger self, SBTypeNameSpecifier arg2) -> SBTypeFilter"""
5234
- return _lldb.SBDebugger_GetFilterForType(self, arg2)
5871
+ def GetFilterForType(self, type_name_spec):
5872
+ r"""Get the filter for a type."""
5873
+ return _lldb.SBDebugger_GetFilterForType(self, type_name_spec)
5235
5874
 
5236
- def GetSyntheticForType(self, arg2):
5237
- r"""GetSyntheticForType(SBDebugger self, SBTypeNameSpecifier arg2) -> SBTypeSynthetic"""
5238
- return _lldb.SBDebugger_GetSyntheticForType(self, arg2)
5875
+ def GetSyntheticForType(self, type_name_spec):
5876
+ r"""Get the synthetic for a type."""
5877
+ return _lldb.SBDebugger_GetSyntheticForType(self, type_name_spec)
5239
5878
 
5240
5879
  def ResetStatistics(self):
5241
- r"""ResetStatistics(SBDebugger self)"""
5880
+ r"""
5881
+ Clear collected statistics for targets belonging to this debugger.
5882
+
5883
+ This includes clearing symbol table and debug info parsing/index time for
5884
+ all modules, breakpoint resolve time, and target statistics.
5885
+ """
5242
5886
  return _lldb.SBDebugger_ResetStatistics(self)
5243
5887
 
5244
5888
  def RunCommandInterpreter(self, auto_handle_events, spawn_thread, options, num_errors, quit_requested, stopped_for_crash):
@@ -5270,11 +5914,28 @@ class SBDebugger(object):
5270
5914
  return _lldb.SBDebugger_RunCommandInterpreter(self, auto_handle_events, spawn_thread, options, num_errors, quit_requested, stopped_for_crash)
5271
5915
 
5272
5916
  def RunREPL(self, language, repl_options):
5273
- r"""RunREPL(SBDebugger self, lldb::LanguageType language, char const * repl_options) -> SBError"""
5917
+ r"""Run a REPL (Read-Eval-Print Loop) for the specified language."""
5274
5918
  return _lldb.SBDebugger_RunREPL(self, language, repl_options)
5275
5919
 
5276
5920
  def LoadTraceFromFile(self, error, trace_description_file):
5277
- r"""LoadTraceFromFile(SBDebugger self, SBError error, SBFileSpec trace_description_file) -> SBTrace"""
5921
+ r"""
5922
+ Load a trace from a trace description file.
5923
+
5924
+ This will create Targets, Processes and Threads based on the contents of
5925
+ the file.
5926
+
5927
+ :type error: :py:class:`SBError`, out
5928
+ :param error:
5929
+ An error if the trace could not be created.
5930
+
5931
+ :type trace_description_file: :py:class:`SBFileSpec`, in
5932
+ :param trace_description_file:
5933
+ The file containing the necessary information to load the trace.
5934
+
5935
+ :rtype: :py:class:`SBTrace`
5936
+ :return:
5937
+ An SBTrace object representing the loaded trace.
5938
+ """
5278
5939
  return _lldb.SBDebugger_LoadTraceFromFile(self, error, trace_description_file)
5279
5940
 
5280
5941
  def __repr__(self):
@@ -5323,6 +5984,16 @@ class SBDebugger(object):
5323
5984
  r"""GetErrorFileHandle(SBDebugger self) -> lldb::FileSP"""
5324
5985
  return _lldb.SBDebugger_GetErrorFileHandle(self)
5325
5986
 
5987
+ class staticproperty:
5988
+ def __init__(self, func):
5989
+ self.func = func
5990
+ def __get__(self, instance, owner):
5991
+ return self.func()
5992
+ @staticproperty
5993
+ def version():
5994
+ return SBDebugger.GetVersionString()
5995
+
5996
+
5326
5997
  # Register SBDebugger in _lldb:
5327
5998
  _lldb.SBDebugger_swigregister(SBDebugger)
5328
5999
  class SBDeclaration(object):
@@ -5476,7 +6147,12 @@ class SBError(object):
5476
6147
  __swig_destroy__ = _lldb.delete_SBError
5477
6148
 
5478
6149
  def GetCString(self):
5479
- r"""GetCString(SBError self) -> char const *"""
6150
+ r"""
6151
+ Get the error string as a NULL terminated UTF8 c-string.
6152
+
6153
+ This SBError object owns the returned string and this object must be kept
6154
+ around long enough to use the returned string.
6155
+ """
5480
6156
  return _lldb.SBError_GetCString(self)
5481
6157
 
5482
6158
  def Clear(self):
@@ -5492,11 +6168,14 @@ class SBError(object):
5492
6168
  return _lldb.SBError_Success(self)
5493
6169
 
5494
6170
  def GetError(self):
5495
- r"""GetError(SBError self) -> uint32_t"""
6171
+ r"""Get the error code."""
5496
6172
  return _lldb.SBError_GetError(self)
5497
6173
 
5498
6174
  def GetErrorData(self):
5499
- r"""GetErrorData(SBError self) -> SBStructuredData"""
6175
+ r"""
6176
+ Get the error in machine-readable form. Particularly useful for
6177
+ compiler diagnostics.
6178
+ """
5500
6179
  return _lldb.SBError_GetErrorData(self)
5501
6180
 
5502
6181
  def GetType(self):
@@ -5577,43 +6256,134 @@ class SBEnvironment(object):
5577
6256
  __swig_destroy__ = _lldb.delete_SBEnvironment
5578
6257
 
5579
6258
  def Get(self, name):
5580
- r"""Get(SBEnvironment self, char const * name) -> char const *"""
6259
+ r"""
6260
+ Return the value of a given environment variable.
6261
+
6262
+ :param [in]: name
6263
+ The name of the environment variable.
6264
+
6265
+ :rtype: string
6266
+ :return:
6267
+ The value of the environment variable or null if not present.
6268
+ If the environment variable has no value but is present, a valid
6269
+ pointer to an empty string will be returned.
6270
+ """
5581
6271
  return _lldb.SBEnvironment_Get(self, name)
5582
6272
 
5583
6273
  def GetNumValues(self):
5584
- r"""GetNumValues(SBEnvironment self) -> size_t"""
6274
+ r"""
6275
+ :rtype: int
6276
+ :return:
6277
+ The number of environment variables.
6278
+ """
5585
6279
  return _lldb.SBEnvironment_GetNumValues(self)
5586
6280
 
5587
6281
  def GetNameAtIndex(self, index):
5588
- r"""GetNameAtIndex(SBEnvironment self, size_t index) -> char const *"""
6282
+ r"""
6283
+ Return the name of the environment variable at a given index from the
6284
+ internal list of environment variables.
6285
+
6286
+ :param [in]: index
6287
+ The index of the environment variable in the internal list.
6288
+
6289
+ :rtype: string
6290
+ :return:
6291
+ The name at the given index or null if the index is invalid.
6292
+ """
5589
6293
  return _lldb.SBEnvironment_GetNameAtIndex(self, index)
5590
6294
 
5591
6295
  def GetValueAtIndex(self, index):
5592
- r"""GetValueAtIndex(SBEnvironment self, size_t index) -> char const *"""
6296
+ r"""
6297
+ Return the value of the environment variable at a given index from the
6298
+ internal list of environment variables.
6299
+
6300
+ :param [in]: index
6301
+ The index of the environment variable in the internal list.
6302
+
6303
+ :rtype: string
6304
+ :return:
6305
+ The value at the given index or null if the index is invalid.
6306
+ If the environment variable has no value but is present, a valid
6307
+ pointer to an empty string will be returned.
6308
+ """
5593
6309
  return _lldb.SBEnvironment_GetValueAtIndex(self, index)
5594
6310
 
5595
6311
  def GetEntries(self):
5596
- r"""GetEntries(SBEnvironment self) -> SBStringList"""
6312
+ r"""
6313
+ Return all environment variables contained in this object. Each variable
6314
+ is returned as a string with the following format
6315
+ name=value
6316
+
6317
+ :rtype: :py:class:`SBStringList`
6318
+ :return:
6319
+ Return an lldb::SBStringList object with the environment variables.
6320
+ """
5597
6321
  return _lldb.SBEnvironment_GetEntries(self)
5598
6322
 
5599
6323
  def PutEntry(self, name_and_value):
5600
- r"""PutEntry(SBEnvironment self, char const * name_and_value)"""
6324
+ r"""
6325
+ Add or replace an existing environment variable. The input must be a
6326
+ string with the format
6327
+ name=value
6328
+
6329
+ :param [in]: name_and_value
6330
+ The entry to set which conforms to the format mentioned above.
6331
+ """
5601
6332
  return _lldb.SBEnvironment_PutEntry(self, name_and_value)
5602
6333
 
5603
6334
  def SetEntries(self, entries, append):
5604
- r"""SetEntries(SBEnvironment self, SBStringList entries, bool append)"""
6335
+ r"""
6336
+ Update this object with the given environment variables. The input is a
6337
+ list of entries with the same format required by SBEnvironment::PutEntry.
6338
+
6339
+ If append is false, the provided environment will replace the existing
6340
+ environment. Otherwise, existing values will be updated of left untouched
6341
+ accordingly.
6342
+
6343
+ :param [in]: entries
6344
+ The environment variable entries.
6345
+
6346
+ :param [in]: append
6347
+ Flag that controls whether to replace the existing environment.
6348
+ """
5605
6349
  return _lldb.SBEnvironment_SetEntries(self, entries, append)
5606
6350
 
5607
6351
  def Set(self, name, value, overwrite):
5608
- r"""Set(SBEnvironment self, char const * name, char const * value, bool overwrite) -> bool"""
6352
+ r"""
6353
+ Set the value of a given environment variable.
6354
+ If the variable exists, its value is updated only if overwrite is true.
6355
+
6356
+ :param [in]: name
6357
+ The name of the environment variable to set.
6358
+
6359
+ :param [in]: value
6360
+ The value of the environment variable to set.
6361
+
6362
+ :param [in]: overwrite
6363
+ Flag that indicates whether to overwrite an existing environment
6364
+ variable.
6365
+
6366
+ :rtype: boolean
6367
+ :return:
6368
+ Return whether the variable was added or modified.
6369
+ """
5609
6370
  return _lldb.SBEnvironment_Set(self, name, value, overwrite)
5610
6371
 
5611
6372
  def Unset(self, name):
5612
- r"""Unset(SBEnvironment self, char const * name) -> bool"""
6373
+ r"""
6374
+ Unset an environment variable if exists.
6375
+
6376
+ :param [in]: name
6377
+ The name of the environment variable to unset.
6378
+
6379
+ :rtype: boolean
6380
+ :return:
6381
+ Return whether a variable was actually unset.
6382
+ """
5613
6383
  return _lldb.SBEnvironment_Unset(self, name)
5614
6384
 
5615
6385
  def Clear(self):
5616
- r"""Clear(SBEnvironment self)"""
6386
+ r"""Delete all the environment variables."""
5617
6387
  return _lldb.SBEnvironment_Clear(self)
5618
6388
 
5619
6389
  # Register SBEnvironment in _lldb:
@@ -6504,7 +7274,10 @@ class SBFrame(object):
6504
7274
  return _lldb.SBFrame_IsArtificial(self, *args)
6505
7275
 
6506
7276
  def IsHidden(self):
6507
- r"""IsHidden(SBFrame self) -> bool"""
7277
+ r"""
7278
+ Return whether a frame recognizer decided this frame should not
7279
+ be displayes in backtraces etc.
7280
+ """
6508
7281
  return _lldb.SBFrame_IsHidden(self)
6509
7282
 
6510
7283
  def EvaluateExpression(self, *args):
@@ -6520,7 +7293,11 @@ class SBFrame(object):
6520
7293
  return _lldb.SBFrame_EvaluateExpression(self, *args)
6521
7294
 
6522
7295
  def GetLanguageSpecificData(self):
6523
- r"""GetLanguageSpecificData(SBFrame self) -> SBStructuredData"""
7296
+ r"""
7297
+ Language plugins can use this API to report language-specific
7298
+ runtime information about this compile unit, such as additional
7299
+ language version details or feature flags.
7300
+ """
6524
7301
  return _lldb.SBFrame_GetLanguageSpecificData(self)
6525
7302
 
6526
7303
  def GetFrameBlock(self):
@@ -6578,7 +7355,22 @@ class SBFrame(object):
6578
7355
  return _lldb.SBFrame_GetVariables(self, *args)
6579
7356
 
6580
7357
  def GetRegisters(self):
6581
- r"""GetRegisters(SBFrame self) -> SBValueList"""
7358
+ r"""
7359
+ GetRegisters(SBFrame self) -> SBValueList
7360
+
7361
+ Returns an SBValueList which is an array of one or more register
7362
+ sets that exist for this thread.
7363
+ Each SBValue in the SBValueList represents one register-set.
7364
+ The first register-set will be the general purpose registers --
7365
+ the registers printed by the `register read` command-line in lldb, with
7366
+ no additional arguments.
7367
+ The register-set SBValue will have a name, e.g.
7368
+ SBFrame::GetRegisters().GetValueAtIndex(0).GetName()
7369
+ By convention, certain stubs choose to name their general-purpose
7370
+ register-set the 'General Purpose Registers', but that is not required.
7371
+ A register-set SBValue will have children, one child per register
7372
+ in the register-set.
7373
+ """
6582
7374
  return _lldb.SBFrame_GetRegisters(self)
6583
7375
 
6584
7376
  def FindRegister(self, name):
@@ -6648,7 +7440,24 @@ class SBFrame(object):
6648
7440
  return _lldb.SBFrame_GetDescription(self, description)
6649
7441
 
6650
7442
  def GetDescriptionWithFormat(self, format, output):
6651
- r"""GetDescriptionWithFormat(SBFrame self, SBFormat format, SBStream output) -> SBError"""
7443
+ r"""
7444
+ Similar to *GetDescription()* but the format of the description can be
7445
+ configured via the ``format`` parameter. See
7446
+ https://lldb.llvm.org/use/formatting.html for more information on format
7447
+ strings.
7448
+
7449
+ :type format: :py:class:`SBFormat`, in
7450
+ :param format:
7451
+ The format to use for generating the description.
7452
+
7453
+ :type output: :py:class:`SBStream`, out
7454
+ :param output:
7455
+ The stream where the description will be written to.
7456
+
7457
+ :rtype: :py:class:`SBError`
7458
+ :return:
7459
+ An error object with an error message in case of failures.
7460
+ """
6652
7461
  return _lldb.SBFrame_GetDescriptionWithFormat(self, format, output)
6653
7462
 
6654
7463
  def __repr__(self):
@@ -6739,8 +7548,8 @@ class SBFrame(object):
6739
7548
  args = property(get_arguments, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.''')
6740
7549
  arguments = property(get_arguments, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.''')
6741
7550
  statics = property(get_statics, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the static variables in this stack frame.''')
6742
- registers = property(GetRegisters, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.''')
6743
- regs = property(GetRegisters, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.''')
7551
+ registers = property(GetRegisters, None, doc='''Returns the register sets for this thread as a list(). See SBFrame::GetRegisters() for details.''')
7552
+ regs = property(GetRegisters, None, doc='''Returns the register sets for this thread as a list(). See SBFrame::GetRegisters() for details.''')
6744
7553
  register = property(get_registers_access, None, doc='''A read only property that returns an helper object providing a flattened indexable view of the CPU registers for this stack frame.''')
6745
7554
  reg = property(get_registers_access, None, doc='''A read only property that returns an helper object providing a flattened indexable view of the CPU registers for this stack frame''')
6746
7555
  parent = property(get_parent_frame, None, doc='''A read only property that returns the parent (caller) frame of the current frame.''')
@@ -7157,9 +7966,12 @@ class SBInstructionList(object):
7157
7966
  """
7158
7967
  return _lldb.SBInstructionList_Print(self, *args)
7159
7968
 
7160
- def GetDescription(self, description):
7161
- r"""GetDescription(SBInstructionList self, SBStream description) -> bool"""
7162
- return _lldb.SBInstructionList_GetDescription(self, description)
7969
+ def GetDescription(self, *args):
7970
+ r"""
7971
+ GetDescription(SBInstructionList self, SBStream description) -> bool
7972
+ GetDescription(SBInstructionList self, SBStream description, SBExecutionContext exe_ctx) -> bool
7973
+ """
7974
+ return _lldb.SBInstructionList_GetDescription(self, *args)
7163
7975
 
7164
7976
  def DumpEmulationForAllInstructions(self, triple):
7165
7977
  r"""DumpEmulationForAllInstructions(SBInstructionList self, char const * triple) -> bool"""
@@ -7204,88 +8016,6 @@ class SBInstructionList(object):
7204
8016
 
7205
8017
  # Register SBInstructionList in _lldb:
7206
8018
  _lldb.SBInstructionList_swigregister(SBInstructionList)
7207
- eLanguageNameAda = _lldb.eLanguageNameAda
7208
-
7209
- eLanguageNameBLISS = _lldb.eLanguageNameBLISS
7210
-
7211
- eLanguageNameC = _lldb.eLanguageNameC
7212
-
7213
- eLanguageNameC_plus_plus = _lldb.eLanguageNameC_plus_plus
7214
-
7215
- eLanguageNameCobol = _lldb.eLanguageNameCobol
7216
-
7217
- eLanguageNameCrystal = _lldb.eLanguageNameCrystal
7218
-
7219
- eLanguageNameD = _lldb.eLanguageNameD
7220
-
7221
- eLanguageNameDylan = _lldb.eLanguageNameDylan
7222
-
7223
- eLanguageNameFortran = _lldb.eLanguageNameFortran
7224
-
7225
- eLanguageNameGo = _lldb.eLanguageNameGo
7226
-
7227
- eLanguageNameHaskell = _lldb.eLanguageNameHaskell
7228
-
7229
- eLanguageNameJava = _lldb.eLanguageNameJava
7230
-
7231
- eLanguageNameJulia = _lldb.eLanguageNameJulia
7232
-
7233
- eLanguageNameKotlin = _lldb.eLanguageNameKotlin
7234
-
7235
- eLanguageNameModula2 = _lldb.eLanguageNameModula2
7236
-
7237
- eLanguageNameModula3 = _lldb.eLanguageNameModula3
7238
-
7239
- eLanguageNameObjC = _lldb.eLanguageNameObjC
7240
-
7241
- eLanguageNameObjC_plus_plus = _lldb.eLanguageNameObjC_plus_plus
7242
-
7243
- eLanguageNameOCaml = _lldb.eLanguageNameOCaml
7244
-
7245
- eLanguageNameOpenCL_C = _lldb.eLanguageNameOpenCL_C
7246
-
7247
- eLanguageNamePascal = _lldb.eLanguageNamePascal
7248
-
7249
- eLanguageNamePLI = _lldb.eLanguageNamePLI
7250
-
7251
- eLanguageNamePython = _lldb.eLanguageNamePython
7252
-
7253
- eLanguageNameRenderScript = _lldb.eLanguageNameRenderScript
7254
-
7255
- eLanguageNameRust = _lldb.eLanguageNameRust
7256
-
7257
- eLanguageNameSwift = _lldb.eLanguageNameSwift
7258
-
7259
- eLanguageNameUPC = _lldb.eLanguageNameUPC
7260
-
7261
- eLanguageNameZig = _lldb.eLanguageNameZig
7262
-
7263
- eLanguageNameAssembly = _lldb.eLanguageNameAssembly
7264
-
7265
- eLanguageNameC_sharp = _lldb.eLanguageNameC_sharp
7266
-
7267
- eLanguageNameMojo = _lldb.eLanguageNameMojo
7268
-
7269
- eLanguageNameGLSL = _lldb.eLanguageNameGLSL
7270
-
7271
- eLanguageNameGLSL_ES = _lldb.eLanguageNameGLSL_ES
7272
-
7273
- eLanguageNameHLSL = _lldb.eLanguageNameHLSL
7274
-
7275
- eLanguageNameOpenCL_CPP = _lldb.eLanguageNameOpenCL_CPP
7276
-
7277
- eLanguageNameCPP_for_OpenCL = _lldb.eLanguageNameCPP_for_OpenCL
7278
-
7279
- eLanguageNameSYCL = _lldb.eLanguageNameSYCL
7280
-
7281
- eLanguageNameRuby = _lldb.eLanguageNameRuby
7282
-
7283
- eLanguageNameMove = _lldb.eLanguageNameMove
7284
-
7285
- eLanguageNameHylo = _lldb.eLanguageNameHylo
7286
-
7287
- eLanguageNameMetal = _lldb.eLanguageNameMetal
7288
-
7289
8019
  class SBLanguageRuntime(object):
7290
8020
  r"""Utility functions for :ref:`LanguageType`"""
7291
8021
 
@@ -7304,37 +8034,50 @@ class SBLanguageRuntime(object):
7304
8034
 
7305
8035
  @staticmethod
7306
8036
  def LanguageIsCPlusPlus(language):
7307
- r"""LanguageIsCPlusPlus(lldb::LanguageType language) -> bool"""
8037
+ r"""Returns whether the given language is any version of C++."""
7308
8038
  return _lldb.SBLanguageRuntime_LanguageIsCPlusPlus(language)
7309
8039
 
7310
8040
  @staticmethod
7311
8041
  def LanguageIsObjC(language):
7312
- r"""LanguageIsObjC(lldb::LanguageType language) -> bool"""
8042
+ r"""Returns whether the given language is Obj-C or Obj-C++."""
7313
8043
  return _lldb.SBLanguageRuntime_LanguageIsObjC(language)
7314
8044
 
7315
8045
  @staticmethod
7316
8046
  def LanguageIsCFamily(language):
7317
- r"""LanguageIsCFamily(lldb::LanguageType language) -> bool"""
8047
+ r"""Returns whether the given language is any version of C, C++ or Obj-C."""
7318
8048
  return _lldb.SBLanguageRuntime_LanguageIsCFamily(language)
7319
8049
 
7320
8050
  @staticmethod
7321
8051
  def SupportsExceptionBreakpointsOnThrow(language):
7322
- r"""SupportsExceptionBreakpointsOnThrow(lldb::LanguageType language) -> bool"""
8052
+ r"""
8053
+ Returns whether the given language supports exception breakpoints on
8054
+ throw statements.
8055
+ """
7323
8056
  return _lldb.SBLanguageRuntime_SupportsExceptionBreakpointsOnThrow(language)
7324
8057
 
7325
8058
  @staticmethod
7326
8059
  def SupportsExceptionBreakpointsOnCatch(language):
7327
- r"""SupportsExceptionBreakpointsOnCatch(lldb::LanguageType language) -> bool"""
8060
+ r"""
8061
+ Returns whether the given language supports exception breakpoints on
8062
+ catch statements.
8063
+ """
7328
8064
  return _lldb.SBLanguageRuntime_SupportsExceptionBreakpointsOnCatch(language)
7329
8065
 
7330
8066
  @staticmethod
7331
8067
  def GetThrowKeywordForLanguage(language):
7332
- r"""GetThrowKeywordForLanguage(lldb::LanguageType language) -> char const *"""
8068
+ r"""
8069
+ Returns the keyword used for throw statements in the given language, e.g.
8070
+ Python uses **raise**. Returns **nullptr** if the language is not supported.
8071
+ """
7333
8072
  return _lldb.SBLanguageRuntime_GetThrowKeywordForLanguage(language)
7334
8073
 
7335
8074
  @staticmethod
7336
8075
  def GetCatchKeywordForLanguage(language):
7337
- r"""GetCatchKeywordForLanguage(lldb::LanguageType language) -> char const *"""
8076
+ r"""
8077
+ Returns the keyword used for catch statements in the given language, e.g.
8078
+ Python uses **except**. Returns **nullptr** if the language is not
8079
+ supported.
8080
+ """
7338
8081
  return _lldb.SBLanguageRuntime_GetCatchKeywordForLanguage(language)
7339
8082
 
7340
8083
  def __init__(self):
@@ -7344,6 +8087,88 @@ class SBLanguageRuntime(object):
7344
8087
 
7345
8088
  # Register SBLanguageRuntime in _lldb:
7346
8089
  _lldb.SBLanguageRuntime_swigregister(SBLanguageRuntime)
8090
+ eLanguageNameAda = _lldb.eLanguageNameAda
8091
+ r"""ISO Ada."""
8092
+ eLanguageNameBLISS = _lldb.eLanguageNameBLISS
8093
+ r"""BLISS."""
8094
+ eLanguageNameC = _lldb.eLanguageNameC
8095
+ r"""C (K&R and ISO)."""
8096
+ eLanguageNameC_plus_plus = _lldb.eLanguageNameC_plus_plus
8097
+ r"""ISO C++."""
8098
+ eLanguageNameCobol = _lldb.eLanguageNameCobol
8099
+ r"""ISO Cobol."""
8100
+ eLanguageNameCrystal = _lldb.eLanguageNameCrystal
8101
+ r"""Crystal."""
8102
+ eLanguageNameD = _lldb.eLanguageNameD
8103
+ r"""D."""
8104
+ eLanguageNameDylan = _lldb.eLanguageNameDylan
8105
+ r"""Dylan."""
8106
+ eLanguageNameFortran = _lldb.eLanguageNameFortran
8107
+ r"""ISO Fortran."""
8108
+ eLanguageNameGo = _lldb.eLanguageNameGo
8109
+ r"""Go."""
8110
+ eLanguageNameHaskell = _lldb.eLanguageNameHaskell
8111
+ r"""Haskell."""
8112
+ eLanguageNameJava = _lldb.eLanguageNameJava
8113
+ r"""Java."""
8114
+ eLanguageNameJulia = _lldb.eLanguageNameJulia
8115
+ r"""Julia."""
8116
+ eLanguageNameKotlin = _lldb.eLanguageNameKotlin
8117
+ r"""Kotlin."""
8118
+ eLanguageNameModula2 = _lldb.eLanguageNameModula2
8119
+ r"""Modula 2."""
8120
+ eLanguageNameModula3 = _lldb.eLanguageNameModula3
8121
+ r"""Modula 3."""
8122
+ eLanguageNameObjC = _lldb.eLanguageNameObjC
8123
+ r"""Objective C."""
8124
+ eLanguageNameObjC_plus_plus = _lldb.eLanguageNameObjC_plus_plus
8125
+ r"""Objective C++."""
8126
+ eLanguageNameOCaml = _lldb.eLanguageNameOCaml
8127
+ r"""OCaml."""
8128
+ eLanguageNameOpenCL_C = _lldb.eLanguageNameOpenCL_C
8129
+ r"""OpenCL C."""
8130
+ eLanguageNamePascal = _lldb.eLanguageNamePascal
8131
+ r"""ISO Pascal."""
8132
+ eLanguageNamePLI = _lldb.eLanguageNamePLI
8133
+ r"""ANSI PL/I."""
8134
+ eLanguageNamePython = _lldb.eLanguageNamePython
8135
+ r"""Python."""
8136
+ eLanguageNameRenderScript = _lldb.eLanguageNameRenderScript
8137
+ r"""RenderScript Kernel Language."""
8138
+ eLanguageNameRust = _lldb.eLanguageNameRust
8139
+ r"""Rust."""
8140
+ eLanguageNameSwift = _lldb.eLanguageNameSwift
8141
+ r"""Swift."""
8142
+ eLanguageNameUPC = _lldb.eLanguageNameUPC
8143
+ r"""Unified Parallel C (UPC)."""
8144
+ eLanguageNameZig = _lldb.eLanguageNameZig
8145
+ r"""Zig."""
8146
+ eLanguageNameAssembly = _lldb.eLanguageNameAssembly
8147
+ r"""Assembly."""
8148
+ eLanguageNameC_sharp = _lldb.eLanguageNameC_sharp
8149
+ r"""C#."""
8150
+ eLanguageNameMojo = _lldb.eLanguageNameMojo
8151
+ r"""Mojo."""
8152
+ eLanguageNameGLSL = _lldb.eLanguageNameGLSL
8153
+ r"""OpenGL Shading Language."""
8154
+ eLanguageNameGLSL_ES = _lldb.eLanguageNameGLSL_ES
8155
+ r"""OpenGL ES Shading Language."""
8156
+ eLanguageNameHLSL = _lldb.eLanguageNameHLSL
8157
+ r"""High Level Shading Language."""
8158
+ eLanguageNameOpenCL_CPP = _lldb.eLanguageNameOpenCL_CPP
8159
+ r"""OpenCL C++."""
8160
+ eLanguageNameCPP_for_OpenCL = _lldb.eLanguageNameCPP_for_OpenCL
8161
+ r"""C++ for OpenCL."""
8162
+ eLanguageNameSYCL = _lldb.eLanguageNameSYCL
8163
+ r"""SYCL."""
8164
+ eLanguageNameRuby = _lldb.eLanguageNameRuby
8165
+ r"""Ruby."""
8166
+ eLanguageNameMove = _lldb.eLanguageNameMove
8167
+ r"""Move."""
8168
+ eLanguageNameHylo = _lldb.eLanguageNameHylo
8169
+ r"""Hylo."""
8170
+ eLanguageNameMetal = _lldb.eLanguageNameMetal
8171
+ r"""Metal."""
7347
8172
  class SBLaunchInfo(object):
7348
8173
  r"""Describes how a target or program should be launched."""
7349
8174
 
@@ -7388,23 +8213,77 @@ class SBLaunchInfo(object):
7388
8213
  return _lldb.SBLaunchInfo_GetExecutableFile(self)
7389
8214
 
7390
8215
  def SetExecutableFile(self, exe_file, add_as_first_arg):
7391
- r"""SetExecutableFile(SBLaunchInfo self, SBFileSpec exe_file, bool add_as_first_arg)"""
8216
+ r"""
8217
+ Set the executable file that will be used to launch the process and
8218
+ optionally set it as the first argument in the argument vector.
8219
+
8220
+ This only needs to be specified if clients wish to carefully control
8221
+ the exact path will be used to launch a binary. If you create a
8222
+ target with a symlink, that symlink will get resolved in the target
8223
+ and the resolved path will get used to launch the process. Calling
8224
+ this function can help you still launch your process using the
8225
+ path of your choice.
8226
+
8227
+ If this function is not called prior to launching with
8228
+ SBTarget::Launch(...), the target will use the resolved executable
8229
+ path that was used to create the target.
8230
+
8231
+ :type exe_file: :py:class:`SBFileSpec`, in
8232
+ :param exe_file:
8233
+ The override path to use when launching the executable.
8234
+
8235
+ :type add_as_first_arg: boolean, in
8236
+ :param add_as_first_arg:
8237
+ If true, then the path will be inserted into the argument vector
8238
+ prior to launching. Otherwise the argument vector will be left
8239
+ alone.
8240
+ """
7392
8241
  return _lldb.SBLaunchInfo_SetExecutableFile(self, exe_file, add_as_first_arg)
7393
8242
 
7394
8243
  def GetListener(self):
7395
- r"""GetListener(SBLaunchInfo self) -> SBListener"""
8244
+ r"""
8245
+ Get the listener that will be used to receive process events.
8246
+
8247
+ If no listener has been set via a call to
8248
+ SBLaunchInfo::SetListener(), then an invalid SBListener will be
8249
+ returned (SBListener::IsValid() will return false). If a listener
8250
+ has been set, then the valid listener object will be returned.
8251
+ """
7396
8252
  return _lldb.SBLaunchInfo_GetListener(self)
7397
8253
 
7398
8254
  def SetListener(self, listener):
7399
- r"""SetListener(SBLaunchInfo self, SBListener listener)"""
8255
+ r"""
8256
+ Set the listener that will be used to receive process events.
8257
+
8258
+ By default the SBDebugger, which has a listener, that the SBTarget
8259
+ belongs to will listen for the process events. Calling this function
8260
+ allows a different listener to be used to listen for process events.
8261
+ """
7400
8262
  return _lldb.SBLaunchInfo_SetListener(self, listener)
7401
8263
 
7402
8264
  def GetShadowListener(self):
7403
- r"""GetShadowListener(SBLaunchInfo self) -> SBListener"""
8265
+ r"""
8266
+ Get the shadow listener that receive public process events,
8267
+ additionally to the default process event listener.
8268
+
8269
+ If no listener has been set via a call to
8270
+ SBLaunchInfo::SetShadowListener(), then an invalid SBListener will
8271
+ be returned (SBListener::IsValid() will return false). If a listener
8272
+ has been set, then the valid listener object will be returned.
8273
+ """
7404
8274
  return _lldb.SBLaunchInfo_GetShadowListener(self)
7405
8275
 
7406
8276
  def SetShadowListener(self, listener):
7407
- r"""SetShadowListener(SBLaunchInfo self, SBListener listener)"""
8277
+ r"""
8278
+ Set the shadow listener that will receive public process events,
8279
+ additionally to the default process event listener.
8280
+
8281
+ By default a process have no shadow event listener.
8282
+ Calling this function allows public process events to be broadcasted to an
8283
+ additional listener on top of the default process event listener.
8284
+ If the `listener` argument is invalid (SBListener::IsValid() will
8285
+ return false), this will clear the shadow listener.
8286
+ """
7408
8287
  return _lldb.SBLaunchInfo_SetShadowListener(self, listener)
7409
8288
 
7410
8289
  def GetNumArguments(self):
@@ -7428,15 +8307,48 @@ class SBLaunchInfo(object):
7428
8307
  return _lldb.SBLaunchInfo_GetEnvironmentEntryAtIndex(self, idx)
7429
8308
 
7430
8309
  def SetEnvironmentEntries(self, envp, append):
7431
- r"""SetEnvironmentEntries(SBLaunchInfo self, char const ** envp, bool append)"""
8310
+ r"""
8311
+ Update this object with the given environment variables.
8312
+
8313
+ If append is false, the provided environment will replace the existing
8314
+ environment. Otherwise, existing values will be updated of left untouched
8315
+ accordingly.
8316
+
8317
+ :param [in]: envp
8318
+ The new environment variables as a list of strings with the following
8319
+ format
8320
+ name=value
8321
+
8322
+ :param [in]: append
8323
+ Flag that controls whether to replace the existing environment.
8324
+ """
7432
8325
  return _lldb.SBLaunchInfo_SetEnvironmentEntries(self, envp, append)
7433
8326
 
7434
8327
  def SetEnvironment(self, env, append):
7435
- r"""SetEnvironment(SBLaunchInfo self, SBEnvironment env, bool append)"""
8328
+ r"""
8329
+ Update this object with the given environment variables.
8330
+
8331
+ If append is false, the provided environment will replace the existing
8332
+ environment. Otherwise, existing values will be updated of left untouched
8333
+ accordingly.
8334
+
8335
+ :param [in]: env
8336
+ The new environment variables.
8337
+
8338
+ :param [in]: append
8339
+ Flag that controls whether to replace the existing environment.
8340
+ """
7436
8341
  return _lldb.SBLaunchInfo_SetEnvironment(self, env, append)
7437
8342
 
7438
8343
  def GetEnvironment(self):
7439
- r"""GetEnvironment(SBLaunchInfo self) -> SBEnvironment"""
8344
+ r"""
8345
+ Return the environment variables of this object.
8346
+
8347
+ :rtype: :py:class:`SBEnvironment`
8348
+ :return:
8349
+ An lldb::SBEnvironment object which is a copy of the SBLaunchInfo's
8350
+ environment.
8351
+ """
7440
8352
  return _lldb.SBLaunchInfo_GetEnvironment(self)
7441
8353
 
7442
8354
  def Clear(self):
@@ -7791,31 +8703,77 @@ class SBMemoryRegionInfo(object):
7791
8703
  return _lldb.SBMemoryRegionInfo_Clear(self)
7792
8704
 
7793
8705
  def GetRegionBase(self):
7794
- r"""GetRegionBase(SBMemoryRegionInfo self) -> lldb::addr_t"""
8706
+ r"""
8707
+ Get the base address of this memory range.
8708
+
8709
+ :rtype: int
8710
+ :return:
8711
+ The base address of this memory range.
8712
+ """
7795
8713
  return _lldb.SBMemoryRegionInfo_GetRegionBase(self)
7796
8714
 
7797
8715
  def GetRegionEnd(self):
7798
- r"""GetRegionEnd(SBMemoryRegionInfo self) -> lldb::addr_t"""
8716
+ r"""
8717
+ Get the end address of this memory range.
8718
+
8719
+ :rtype: int
8720
+ :return:
8721
+ The base address of this memory range.
8722
+ """
7799
8723
  return _lldb.SBMemoryRegionInfo_GetRegionEnd(self)
7800
8724
 
7801
8725
  def IsReadable(self):
7802
- r"""IsReadable(SBMemoryRegionInfo self) -> bool"""
8726
+ r"""
8727
+ Check if this memory address is marked readable to the process.
8728
+
8729
+ :rtype: boolean
8730
+ :return:
8731
+ true if this memory address is marked readable
8732
+ """
7803
8733
  return _lldb.SBMemoryRegionInfo_IsReadable(self)
7804
8734
 
7805
8735
  def IsWritable(self):
7806
- r"""IsWritable(SBMemoryRegionInfo self) -> bool"""
8736
+ r"""
8737
+ Check if this memory address is marked writable to the process.
8738
+
8739
+ :rtype: boolean
8740
+ :return:
8741
+ true if this memory address is marked writable
8742
+ """
7807
8743
  return _lldb.SBMemoryRegionInfo_IsWritable(self)
7808
8744
 
7809
8745
  def IsExecutable(self):
7810
- r"""IsExecutable(SBMemoryRegionInfo self) -> bool"""
8746
+ r"""
8747
+ Check if this memory address is marked executable to the process.
8748
+
8749
+ :rtype: boolean
8750
+ :return:
8751
+ true if this memory address is marked executable
8752
+ """
7811
8753
  return _lldb.SBMemoryRegionInfo_IsExecutable(self)
7812
8754
 
7813
8755
  def IsMapped(self):
7814
- r"""IsMapped(SBMemoryRegionInfo self) -> bool"""
8756
+ r"""
8757
+ Check if this memory address is mapped into the process address
8758
+ space.
8759
+
8760
+ :rtype: boolean
8761
+ :return:
8762
+ true if this memory address is in the process address space.
8763
+ """
7815
8764
  return _lldb.SBMemoryRegionInfo_IsMapped(self)
7816
8765
 
7817
8766
  def GetName(self):
7818
- r"""GetName(SBMemoryRegionInfo self) -> char const *"""
8767
+ r"""
8768
+ Returns the name of the memory region mapped at the given
8769
+ address.
8770
+
8771
+ :rtype: string
8772
+ :return:
8773
+ In case of memory mapped files it is the absolute path of
8774
+ the file otherwise it is a name associated with the memory
8775
+ region. If no name can be determined the returns nullptr.
8776
+ """
7819
8777
  return _lldb.SBMemoryRegionInfo_GetName(self)
7820
8778
 
7821
8779
  def HasDirtyMemoryPageList(self):
@@ -7937,8 +8895,8 @@ class SBMemoryRegionInfoList(object):
7937
8895
  '''Iterate over all the memory regions in a lldb.SBMemoryRegionInfoList object.'''
7938
8896
  import lldb
7939
8897
  size = self.GetSize()
7940
- region = lldb.SBMemoryRegionInfo()
7941
8898
  for i in range(size):
8899
+ region = lldb.SBMemoryRegionInfo()
7942
8900
  self.GetMemoryRegionAtIndex(i, region)
7943
8901
  yield region
7944
8902
 
@@ -8107,11 +9065,41 @@ class SBModule(object):
8107
9065
  return _lldb.SBModule_SetPlatformFileSpec(self, platform_file)
8108
9066
 
8109
9067
  def GetRemoteInstallFileSpec(self):
8110
- r"""GetRemoteInstallFileSpec(SBModule self) -> SBFileSpec"""
9068
+ r"""
9069
+ Get accessor for the remote install path for a module.
9070
+
9071
+ When debugging to a remote platform by connecting to a remote
9072
+ platform, the install path of the module can be set. If the
9073
+ install path is set, every time the process is about to launch
9074
+ the target will install this module on the remote platform prior
9075
+ to launching.
9076
+
9077
+ :rtype: :py:class:`SBFileSpec`
9078
+ :return:
9079
+ A file specification object.
9080
+ """
8111
9081
  return _lldb.SBModule_GetRemoteInstallFileSpec(self)
8112
9082
 
8113
9083
  def SetRemoteInstallFileSpec(self, file):
8114
- r"""SetRemoteInstallFileSpec(SBModule self, SBFileSpec file) -> bool"""
9084
+ r"""
9085
+ Set accessor for the remote install path for a module.
9086
+
9087
+ When debugging to a remote platform by connecting to a remote
9088
+ platform, the install path of the module can be set. If the
9089
+ install path is set, every time the process is about to launch
9090
+ the target will install this module on the remote platform prior
9091
+ to launching.
9092
+
9093
+ If *file* specifies a full path to an install location, the
9094
+ module will be installed to this path. If the path is relative
9095
+ (no directory specified, or the path is partial like "usr/lib"
9096
+ or "./usr/lib", then the install path will be resolved using
9097
+ the platform's current working directory as the base path.
9098
+
9099
+ :type file: :py:class:`SBFileSpec`, in
9100
+ :param file:
9101
+ A file specification object.
9102
+ """
8115
9103
  return _lldb.SBModule_SetRemoteInstallFileSpec(self, file)
8116
9104
 
8117
9105
  def GetByteOrder(self):
@@ -8280,7 +9268,24 @@ class SBModule(object):
8280
9268
  return _lldb.SBModule_FindTypes(self, type)
8281
9269
 
8282
9270
  def GetTypeByID(self, uid):
8283
- r"""GetTypeByID(SBModule self, lldb::user_id_t uid) -> SBType"""
9271
+ r"""
9272
+ Get a type using its type ID.
9273
+
9274
+ Each symbol file reader will assign different user IDs to their
9275
+ types, but it is sometimes useful when debugging type issues to
9276
+ be able to grab a type using its type ID.
9277
+
9278
+ For DWARF debug info, the type ID is the DIE offset.
9279
+
9280
+ :type uid: int, in
9281
+ :param uid:
9282
+ The type user ID.
9283
+
9284
+ :rtype: :py:class:`SBType`
9285
+ :return:
9286
+ An SBType for the given type ID, or an empty SBType if the
9287
+ type was not found.
9288
+ """
8284
9289
  return _lldb.SBModule_GetTypeByID(self, uid)
8285
9290
 
8286
9291
  def GetBasicType(self, type):
@@ -8307,11 +9312,64 @@ class SBModule(object):
8307
9312
  return _lldb.SBModule_GetTypes(self, *args)
8308
9313
 
8309
9314
  def GetVersion(self):
8310
- r"""GetVersion(SBModule self) -> uint32_t"""
9315
+ r"""
9316
+ Get the module version numbers.
9317
+
9318
+ Many object files have a set of version numbers that describe
9319
+ the version of the executable or shared library. Typically there
9320
+ are major, minor and build, but there may be more. This function
9321
+ will extract the versions from object files if they are available.
9322
+
9323
+ If *versions* is NULL, or if *num_versions* is 0, the return
9324
+ value will indicate how many version numbers are available in
9325
+ this object file. Then a subsequent call can be made to this
9326
+ function with a value of *versions* and *num_versions* that
9327
+ has enough storage to store some or all version numbers.
9328
+
9329
+ :type versions: int, out
9330
+ :param versions:
9331
+ A pointer to an array of uint32_t types that is *num_versions*
9332
+ long. If this value is NULL, the return value will indicate
9333
+ how many version numbers are required for a subsequent call
9334
+ to this function so that all versions can be retrieved. If
9335
+ the value is non-NULL, then at most *num_versions* of the
9336
+ existing versions numbers will be filled into *versions*.
9337
+ If there is no version information available, *versions*
9338
+ will be filled with *num_versions* UINT32_MAX values
9339
+ and zero will be returned.
9340
+
9341
+ :type num_versions: int, in
9342
+ :param num_versions:
9343
+ The maximum number of entries to fill into *versions*. If
9344
+ this value is zero, then the return value will indicate
9345
+ how many version numbers there are in total so another call
9346
+ to this function can be make with adequate storage in
9347
+ *versions* to get all of the version numbers. If
9348
+ *num_versions* is less than the actual number of version
9349
+ numbers in this object file, only *num_versions* will be
9350
+ filled into *versions* (if *versions* is non-NULL).
9351
+
9352
+ :rtype: int
9353
+ :return:
9354
+ This function always returns the number of version numbers
9355
+ that this object file has regardless of the number of
9356
+ version numbers that were copied into *versions*.
9357
+ """
8311
9358
  return _lldb.SBModule_GetVersion(self)
8312
9359
 
8313
9360
  def GetSymbolFileSpec(self):
8314
- r"""GetSymbolFileSpec(SBModule self) -> SBFileSpec"""
9361
+ r"""
9362
+ Get accessor for the symbol file specification.
9363
+
9364
+ When debugging an object file an additional debug information can
9365
+ be provided in separate file. Therefore if you debugging something
9366
+ like '/usr/lib/liba.dylib' then debug information can be located
9367
+ in folder like '/usr/lib/liba.dylib.dSYM/'.
9368
+
9369
+ :rtype: :py:class:`SBFileSpec`
9370
+ :return:
9371
+ A const reference to the file specification object.
9372
+ """
8315
9373
  return _lldb.SBModule_GetSymbolFileSpec(self)
8316
9374
 
8317
9375
  def GetObjectFileHeaderAddress(self):
@@ -8769,6 +9827,42 @@ class SBModuleSpecList(object):
8769
9827
 
8770
9828
  # Register SBModuleSpecList in _lldb:
8771
9829
  _lldb.SBModuleSpecList_swigregister(SBModuleSpecList)
9830
+ class SBMutex(object):
9831
+ r"""Proxy of C++ lldb::SBMutex class."""
9832
+
9833
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
9834
+ __repr__ = _swig_repr
9835
+
9836
+ def __init__(self, *args):
9837
+ r"""
9838
+ __init__(SBMutex self) -> SBMutex
9839
+ __init__(SBMutex self, SBMutex rhs) -> SBMutex
9840
+ """
9841
+ _lldb.SBMutex_swiginit(self, _lldb.new_SBMutex(*args))
9842
+ __swig_destroy__ = _lldb.delete_SBMutex
9843
+
9844
+ def IsValid(self):
9845
+ r"""Returns true if this lock has ownership of the underlying mutex."""
9846
+ return _lldb.SBMutex_IsValid(self)
9847
+
9848
+ def lock(self):
9849
+ r"""Blocking operation that takes ownership of this lock."""
9850
+ return _lldb.SBMutex_lock(self)
9851
+
9852
+ def unlock(self):
9853
+ r"""Releases ownership of this lock."""
9854
+ return _lldb.SBMutex_unlock(self)
9855
+
9856
+ def __enter__(self):
9857
+ self.lock()
9858
+ return self
9859
+
9860
+ def __exit__(self, exc_type, exc_value, traceback):
9861
+ self.unlock()
9862
+
9863
+
9864
+ # Register SBMutex in _lldb:
9865
+ _lldb.SBMutex_swigregister(SBMutex)
8772
9866
  class SBPlatformConnectOptions(object):
8773
9867
  r"""Describes how :py:class:`SBPlatform.ConnectRemote` connects to a remote platform."""
8774
9868
 
@@ -9038,11 +10132,29 @@ class SBPlatform(object):
9038
10132
  return _lldb.SBPlatform_GetUnixSignals(self)
9039
10133
 
9040
10134
  def GetEnvironment(self):
9041
- r"""GetEnvironment(SBPlatform self) -> SBEnvironment"""
10135
+ r"""
10136
+ Return the environment variables of the remote platform connection
10137
+ process.
10138
+
10139
+ :rtype: :py:class:`SBEnvironment`
10140
+ :return:
10141
+ An lldb::SBEnvironment object which is a copy of the platform's
10142
+ environment.
10143
+ """
9042
10144
  return _lldb.SBPlatform_GetEnvironment(self)
9043
10145
 
9044
10146
  def SetLocateModuleCallback(self, callback):
9045
- r"""SetLocateModuleCallback(SBPlatform self, lldb::SBPlatformLocateModuleCallback callback) -> SBError"""
10147
+ r"""
10148
+ Set a callback as an implementation for locating module in order to
10149
+ implement own module cache system. For example, to leverage distributed
10150
+ build system, to bypass pulling files from remote platform, or to search
10151
+ symbol files from symbol servers. The target will call this callback to
10152
+ get a module file and a symbol file, and it will fallback to the LLDB
10153
+ implementation when this callback failed or returned non-existent file.
10154
+ This callback can set either module_file_spec or symbol_file_spec, or both
10155
+ module_file_spec and symbol_file_spec. The callback will be cleared if
10156
+ nullptr or None is set.
10157
+ """
9046
10158
  return _lldb.SBPlatform_SetLocateModuleCallback(self, callback)
9047
10159
 
9048
10160
  # Register SBPlatform in _lldb:
@@ -9300,6 +10412,10 @@ class SBProcess(object):
9300
10412
  r"""Continue(SBProcess self) -> SBError"""
9301
10413
  return _lldb.SBProcess_Continue(self)
9302
10414
 
10415
+ def ContinueInDirection(self, direction):
10416
+ r"""ContinueInDirection(SBProcess self, lldb::RunDirection direction) -> SBError"""
10417
+ return _lldb.SBProcess_ContinueInDirection(self, direction)
10418
+
9303
10419
  def Stop(self):
9304
10420
  r"""Stop(SBProcess self) -> SBError"""
9305
10421
  return _lldb.SBProcess_Stop(self)
@@ -9346,11 +10462,28 @@ class SBProcess(object):
9346
10462
  return _lldb.SBProcess_GetStopID(self, include_expression_stops)
9347
10463
 
9348
10464
  def GetStopEventForStopID(self, stop_id):
9349
- r"""GetStopEventForStopID(SBProcess self, uint32_t stop_id) -> SBEvent"""
10465
+ r"""
10466
+ Gets the stop event corresponding to stop ID.
10467
+ Note that it wasn't fully implemented and tracks only the stop
10468
+ event for the last natural stop ID.
10469
+
10470
+ :param [in]: stop_id
10471
+ The ID of the stop event to return.
10472
+
10473
+ :rtype: :py:class:`SBEvent`
10474
+ :return:
10475
+ The stop event corresponding to stop ID.
10476
+ """
9350
10477
  return _lldb.SBProcess_GetStopEventForStopID(self, stop_id)
9351
10478
 
9352
10479
  def ForceScriptedState(self, new_state):
9353
- r"""ForceScriptedState(SBProcess self, lldb::StateType new_state)"""
10480
+ r"""
10481
+ If the process is a scripted process, changes its state to the new state.
10482
+ No-op otherwise.
10483
+
10484
+ :param [in]: new_state
10485
+ The new state that the scripted process should be set to.
10486
+ """
9354
10487
  return _lldb.SBProcess_ForceScriptedState(self, new_state)
9355
10488
 
9356
10489
  def ReadMemory(self, addr, buf, error):
@@ -9516,8 +10649,57 @@ class SBProcess(object):
9516
10649
 
9517
10650
  def LoadImage(self, *args):
9518
10651
  r"""
9519
- LoadImage(SBProcess self, SBFileSpec remote_image_spec, SBError error) -> uint32_t
9520
- LoadImage(SBProcess self, SBFileSpec local_image_spec, SBFileSpec remote_image_spec, SBError error) -> uint32_t
10652
+ *Overload 1:*
10653
+ Load a shared library into this process.
10654
+
10655
+ :type remote_image_spec: :py:class:`SBFileSpec`, in
10656
+ :param remote_image_spec:
10657
+ The path for the shared library on the target what you want
10658
+ to load.
10659
+
10660
+ :type error: :py:class:`SBError`, out
10661
+ :param error:
10662
+ An error object that gets filled in with any errors that
10663
+ might occur when trying to load the shared library.
10664
+
10665
+ :rtype: int
10666
+ :return:
10667
+ A token that represents the shared library that can be
10668
+ later used to unload the shared library. A value of
10669
+ LLDB_INVALID_IMAGE_TOKEN will be returned if the shared
10670
+ library can't be opened.
10671
+
10672
+ |
10673
+
10674
+ *Overload 2:*
10675
+ Load a shared library into this process.
10676
+
10677
+ :type local_image_spec: :py:class:`SBFileSpec`, in
10678
+ :param local_image_spec:
10679
+ The file spec that points to the shared library that you
10680
+ want to load if the library is located on the host. The
10681
+ library will be copied over to the location specified by
10682
+ remote_image_spec or into the current working directory with
10683
+ the same filename if the remote_image_spec isn't specified.
10684
+
10685
+ :type remote_image_spec: :py:class:`SBFileSpec`, in
10686
+ :param remote_image_spec:
10687
+ If local_image_spec is specified then the location where the
10688
+ library should be copied over from the host. If
10689
+ local_image_spec isn't specified, then the path for the
10690
+ shared library on the target what you want to load.
10691
+
10692
+ :type error: :py:class:`SBError`, out
10693
+ :param error:
10694
+ An error object that gets filled in with any errors that
10695
+ might occur when trying to load the shared library.
10696
+
10697
+ :rtype: int
10698
+ :return:
10699
+ A token that represents the shared library that can be
10700
+ later used to unload the shared library. A value of
10701
+ LLDB_INVALID_IMAGE_TOKEN will be returned if the shared
10702
+ library can't be opened.
9521
10703
  """
9522
10704
  return _lldb.SBProcess_LoadImage(self, *args)
9523
10705
 
@@ -9563,28 +10745,84 @@ class SBProcess(object):
9563
10745
  """
9564
10746
  return _lldb.SBProcess_GetExtendedBacktraceTypeAtIndex(self, idx)
9565
10747
 
9566
- def GetHistoryThreads(self, addr):
9567
- r"""GetHistoryThreads(SBProcess self, lldb::addr_t addr) -> SBThreadCollection"""
9568
- return _lldb.SBProcess_GetHistoryThreads(self, addr)
10748
+ def GetHistoryThreads(self, addr):
10749
+ r"""GetHistoryThreads(SBProcess self, lldb::addr_t addr) -> SBThreadCollection"""
10750
+ return _lldb.SBProcess_GetHistoryThreads(self, addr)
10751
+
10752
+ def IsInstrumentationRuntimePresent(self, type):
10753
+ r"""IsInstrumentationRuntimePresent(SBProcess self, lldb::InstrumentationRuntimeType type) -> bool"""
10754
+ return _lldb.SBProcess_IsInstrumentationRuntimePresent(self, type)
10755
+
10756
+ def SaveCore(self, *args):
10757
+ r"""
10758
+ *Overload 1:*
10759
+ Save the state of the process in a core file.
10760
+
10761
+ :type file_name: string, in
10762
+ :param file_name: - The name of the file to save the core file to.
10763
+
10764
+ :type flavor: string, in
10765
+ :param flavor: - Specify the flavor of a core file plug-in to save.
10766
+ Currently supported flavors include "mach-o" and "minidump"
10767
+
10768
+ :type core_style: int, in
10769
+ :param core_style: - Specify the style of a core file to save.
10770
+
10771
+ |
10772
+
10773
+ *Overload 2:*
10774
+ Save the state of the process with the a flavor that matches the
10775
+ current process' main executable (if supported).
10776
+
10777
+ :type file_name: string, in
10778
+ :param file_name: - The name of the file to save the core file to.
10779
+
10780
+ |
9569
10781
 
9570
- def IsInstrumentationRuntimePresent(self, type):
9571
- r"""IsInstrumentationRuntimePresent(SBProcess self, lldb::InstrumentationRuntimeType type) -> bool"""
9572
- return _lldb.SBProcess_IsInstrumentationRuntimePresent(self, type)
10782
+ *Overload 3:*
10783
+ Save the state of the process with the desired settings
10784
+ as defined in the options object.
9573
10785
 
9574
- def SaveCore(self, *args):
9575
- r"""
9576
- SaveCore(SBProcess self, char const * file_name, char const * flavor, lldb::SaveCoreStyle core_style) -> SBError
9577
- SaveCore(SBProcess self, char const * file_name) -> SBError
9578
- SaveCore(SBProcess self, SBSaveCoreOptions options) -> SBError
10786
+ :type options: :py:class:`SBSaveCoreOptions`, in
10787
+ :param options: - The options to use when saving the core file.
9579
10788
  """
9580
10789
  return _lldb.SBProcess_SaveCore(self, *args)
9581
10790
 
9582
10791
  def GetMemoryRegionInfo(self, load_addr, region_info):
9583
- r"""GetMemoryRegionInfo(SBProcess self, lldb::addr_t load_addr, SBMemoryRegionInfo region_info) -> SBError"""
10792
+ r"""
10793
+ Query the address load_addr and store the details of the memory
10794
+ region that contains it in the supplied SBMemoryRegionInfo object.
10795
+ To iterate over all memory regions use GetMemoryRegionList.
10796
+
10797
+ :type load_addr: int, in
10798
+ :param load_addr:
10799
+ The address to be queried.
10800
+
10801
+ :type region_info: :py:class:`SBMemoryRegionInfo`, out
10802
+ :param region_info:
10803
+ A reference to an SBMemoryRegionInfo object that will contain
10804
+ the details of the memory region containing load_addr.
10805
+
10806
+ :rtype: :py:class:`SBError`
10807
+ :return:
10808
+ An error object describes any errors that occurred while
10809
+ querying load_addr.
10810
+ """
9584
10811
  return _lldb.SBProcess_GetMemoryRegionInfo(self, load_addr, region_info)
9585
10812
 
9586
10813
  def GetMemoryRegions(self):
9587
- r"""GetMemoryRegions(SBProcess self) -> SBMemoryRegionInfoList"""
10814
+ r"""
10815
+ GetMemoryRegions(SBProcess self) -> SBMemoryRegionInfoList
10816
+
10817
+ Get a list of all the memory regions associated with this process. ::
10818
+
10819
+ readable_regions = []
10820
+ for region in process.GetMemoryRegions():
10821
+ if region.IsReadable():
10822
+ readable_regions.append(region)
10823
+
10824
+
10825
+ """
9588
10826
  return _lldb.SBProcess_GetMemoryRegions(self)
9589
10827
 
9590
10828
  def GetProcessInfo(self):
@@ -9602,7 +10840,16 @@ class SBProcess(object):
9602
10840
  return _lldb.SBProcess_GetProcessInfo(self)
9603
10841
 
9604
10842
  def GetCoreFile(self):
9605
- r"""GetCoreFile(SBProcess self) -> SBFileSpec"""
10843
+ r"""
10844
+ Get the file specification for the core file that is currently being used
10845
+ for the process. If the process is not loaded from a core file, then an
10846
+ invalid file specification will be returned.
10847
+
10848
+ :rtype: :py:class:`SBFileSpec`
10849
+ :return:
10850
+ The path to the core file for this target or an invalid file spec if
10851
+ the process isn't loaded from a core file.
10852
+ """
9606
10853
  return _lldb.SBProcess_GetCoreFile(self)
9607
10854
 
9608
10855
  def GetAddressMask(self, *args):
@@ -9935,6 +11182,54 @@ class SBProgress(object):
9935
11182
  Progress::Increment() is called, and also will make sure that a progress
9936
11183
  completed update is reported even if the user doesn't explicitly cause one
9937
11184
  to be sent.
11185
+
11186
+ Progress can either be deterministic, incrementing up to a known total or non-deterministic
11187
+ with an unbounded total. Deterministic is better if you know the items of work in advance, but non-deterministic
11188
+ exposes a way to update a user during a long running process that work is taking place.
11189
+
11190
+ For all progresses the details provided in the constructor will be sent until an increment detail
11191
+ is provided. This detail will also continue to be broadcasted on any subsequent update that doesn't
11192
+ specify a new detail. Some implementations differ on throttling updates and this behavior differs primarily
11193
+ if the progress is deterministic or non-deterministic. For DAP, non-deterministic update messages have a higher
11194
+ throttling rate than deterministic ones.
11195
+
11196
+ Below are examples in Python for deterministic and non-deterministic progresses. ::
11197
+
11198
+ deterministic_progress1 = lldb.SBProgress('Deterministic Progress', 'Detail', 3, lldb.SBDebugger)
11199
+ for i in range(3):
11200
+ deterministic_progress1.Increment(1, f'Update {i}')
11201
+ # The call to Finalize() is a no-op as we already incremented the right amount of
11202
+ # times and caused the end event to be sent.
11203
+ deterministic_progress1.Finalize()
11204
+
11205
+ deterministic_progress2 = lldb.SBProgress('Deterministic Progress', 'Detail', 10, lldb.SBDebugger)
11206
+ for i in range(3):
11207
+ deterministic_progress2.Increment(1, f'Update {i}')
11208
+ # Cause the progress end event to be sent even if we didn't increment the right
11209
+ # number of times. Real world examples would be in a try-finally block to ensure
11210
+ # progress clean-up.
11211
+ deterministic_progress2.Finalize()
11212
+
11213
+ If you don't call Finalize() when the progress is not done, the progress object will eventually get
11214
+ garbage collected by the Python runtime, the end event will eventually get sent, but it is best not to
11215
+ rely on the garbage collection when using lldb.SBProgress.
11216
+
11217
+ Non-deterministic progresses behave the same, but omit the total in the constructor. ::
11218
+
11219
+ non_deterministic_progress = lldb.SBProgress('Non deterministic progress', 'Detail', lldb.SBDebugger)
11220
+ for i in range(10):
11221
+ non_deterministic_progress.Increment(1)
11222
+ # Explicitly send a progressEnd, otherwise this will be sent
11223
+ # when the python runtime cleans up this object.
11224
+ non_deterministic_progress.Finalize()
11225
+
11226
+ Additionally for Python, progress is supported in a with statement. ::
11227
+ with lldb.SBProgress('Non deterministic progress', 'Detail', lldb.SBDebugger) as progress:
11228
+ for i in range(10):
11229
+ progress.Increment(1)
11230
+ # The progress object is automatically finalized when the with statement
11231
+
11232
+
9938
11233
  """
9939
11234
 
9940
11235
  thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
@@ -9942,8 +11237,35 @@ class SBProgress(object):
9942
11237
 
9943
11238
  def __init__(self, *args):
9944
11239
  r"""
9945
- __init__(SBProgress self, char const * title, char const * details, SBDebugger debugger) -> SBProgress
9946
- __init__(SBProgress self, char const * title, char const * details, uint64_t total_units, SBDebugger debugger) -> SBProgress
11240
+ *Overload 1:*
11241
+ Construct a progress object with a title, details and a given debugger.
11242
+ :type title: string
11243
+ :param title:
11244
+ The title of the progress object.
11245
+ :type details: string
11246
+ :param details:
11247
+ The details of the progress object.
11248
+ :type debugger: :py:class:`SBDebugger`
11249
+ :param debugger:
11250
+ The debugger for this progress object to report to.
11251
+
11252
+ |
11253
+
11254
+ *Overload 2:*
11255
+ Construct a progress object with a title, details, the total units of work
11256
+ to be done, and a given debugger.
11257
+ :type title: string
11258
+ :param title:
11259
+ The title of the progress object.
11260
+ :type details: string
11261
+ :param details:
11262
+ The details of the progress object.
11263
+ :type total_units: int
11264
+ :param total_units:
11265
+ The total number of units of work to be done.
11266
+ :type debugger: :py:class:`SBDebugger`
11267
+ :param debugger:
11268
+ The debugger for this progress object to report to.
9947
11269
  """
9948
11270
  _lldb.SBProgress_swiginit(self, _lldb.new_SBProgress(*args))
9949
11271
  __swig_destroy__ = _lldb.delete_SBProgress
@@ -9952,6 +11274,26 @@ class SBProgress(object):
9952
11274
  r"""Increment(SBProgress self, uint64_t amount, char const * description=None)"""
9953
11275
  return _lldb.SBProgress_Increment(self, amount, description)
9954
11276
 
11277
+ def Finalize(self):
11278
+ r"""
11279
+ Finalize(SBProgress self)
11280
+ Finalize the SBProgress, which will cause a progress end event to be emitted. This
11281
+ happens automatically when the SBProcess object is destroyed, but can be done explicitly
11282
+ with Finalize to avoid having to rely on the language semantics for destruction.
11283
+
11284
+ Note once finalized, no further increments will be processed.
11285
+ """
11286
+ return _lldb.SBProgress_Finalize(self)
11287
+
11288
+ def __enter__(self):
11289
+ '''No-op for with statement'''
11290
+ pass
11291
+
11292
+ def __exit__(self, exc_type, exc_value, traceback):
11293
+ '''Finalize the progress object'''
11294
+ self.Finalize()
11295
+
11296
+
9955
11297
  # Register SBProgress in _lldb:
9956
11298
  _lldb.SBProgress_swigregister(SBProgress)
9957
11299
  class SBQueue(object):
@@ -10111,7 +11453,13 @@ class SBReproducer(object):
10111
11453
 
10112
11454
  @staticmethod
10113
11455
  def SetWorkingDirectory(path):
10114
- r"""SetWorkingDirectory(char const * path)"""
11456
+ r"""
11457
+ The working directory is set to the current working directory when the
11458
+ reproducers are initialized. This method allows setting a different
11459
+ working directory. This is used by the API test suite which temporarily
11460
+ changes the directory to where the test lives. This is a NO-OP in every
11461
+ mode but capture.
11462
+ """
10115
11463
  return _lldb.SBReproducer_SetWorkingDirectory(path)
10116
11464
 
10117
11465
  def __init__(self):
@@ -10269,7 +11617,19 @@ class SBSection(object):
10269
11617
  return _lldb.SBSection_GetSectionType(self)
10270
11618
 
10271
11619
  def GetPermissions(self):
10272
- r"""GetPermissions(SBSection self) -> uint32_t"""
11620
+ r"""
11621
+ Gets the permissions (RWX) of the section of the object file
11622
+
11623
+ Returns a mask of bits of enum lldb::Permissions for this section.
11624
+ Sections for which permissions are not defined, 0 is returned for
11625
+ them. The binary representation of this value corresponds to [XRW]
11626
+ i.e. for a section having read and execute permissions, the value
11627
+ returned is 6
11628
+
11629
+ :rtype: int
11630
+ :return:
11631
+ Returns an unsigned value for Permissions for the section.
11632
+ """
10273
11633
  return _lldb.SBSection_GetPermissions(self)
10274
11634
 
10275
11635
  def GetTargetByteSize(self):
@@ -10287,7 +11647,13 @@ class SBSection(object):
10287
11647
  return _lldb.SBSection_GetTargetByteSize(self)
10288
11648
 
10289
11649
  def GetAlignment(self):
10290
- r"""GetAlignment(SBSection self) -> uint32_t"""
11650
+ r"""
11651
+ Return the alignment of the section in bytes
11652
+
11653
+ :rtype: int
11654
+ :return:
11655
+ The alignment of the section in bytes
11656
+ """
10291
11657
  return _lldb.SBSection_GetAlignment(self)
10292
11658
 
10293
11659
  def __eq__(self, rhs):
@@ -10428,7 +11794,16 @@ class SBStatisticsOptions(object):
10428
11794
  return _lldb.SBStatisticsOptions_GetSummaryOnly(self)
10429
11795
 
10430
11796
  def SetIncludeTargets(self, b):
10431
- r"""SetIncludeTargets(SBStatisticsOptions self, bool b)"""
11797
+ r"""
11798
+ If true, dump statistics for the targets, including breakpoints,
11799
+ expression evaluations, frame variables, etc.
11800
+
11801
+ Defaults to true, unless the `SummaryOnly` mode is enabled, in which case
11802
+ this is turned off unless specified.
11803
+
11804
+ If both `IncludeTargets` and `IncludeModules` are true, a list of module
11805
+ identifiers will be added to the "targets" section.
11806
+ """
10432
11807
  return _lldb.SBStatisticsOptions_SetIncludeTargets(self, b)
10433
11808
 
10434
11809
  def GetIncludeTargets(self):
@@ -10436,7 +11811,17 @@ class SBStatisticsOptions(object):
10436
11811
  return _lldb.SBStatisticsOptions_GetIncludeTargets(self)
10437
11812
 
10438
11813
  def SetIncludeModules(self, b):
10439
- r"""SetIncludeModules(SBStatisticsOptions self, bool b)"""
11814
+ r"""
11815
+ If true, dump statistics for the modules, including time and size of
11816
+ various aspects of the module and debug information, type system, path,
11817
+ etc.
11818
+
11819
+ Defaults to true, unless the `SummaryOnly` mode is enabled, in which case
11820
+ this is turned off unless specified.
11821
+
11822
+ If both `IncludeTargets` and `IncludeModules` are true, a list of module
11823
+ identifiers will be added to the "targets" section.
11824
+ """
10440
11825
  return _lldb.SBStatisticsOptions_SetIncludeModules(self, b)
10441
11826
 
10442
11827
  def GetIncludeModules(self):
@@ -10444,7 +11829,13 @@ class SBStatisticsOptions(object):
10444
11829
  return _lldb.SBStatisticsOptions_GetIncludeModules(self)
10445
11830
 
10446
11831
  def SetIncludeTranscript(self, b):
10447
- r"""SetIncludeTranscript(SBStatisticsOptions self, bool b)"""
11832
+ r"""
11833
+ If true and the setting `interpreter.save-transcript` is enabled, include
11834
+ a JSON array with all commands the user and/or scripts executed during a
11835
+ debug session.
11836
+
11837
+ Defaults to false.
11838
+ """
10448
11839
  return _lldb.SBStatisticsOptions_SetIncludeTranscript(self, b)
10449
11840
 
10450
11841
  def GetIncludeTranscript(self):
@@ -10688,31 +12079,43 @@ class SBStructuredData(object):
10688
12079
  return _lldb.SBStructuredData_GetDescription(self, stream)
10689
12080
 
10690
12081
  def GetType(self):
10691
- r"""GetType(SBStructuredData self) -> lldb::StructuredDataType"""
12082
+ r"""Return the type of data in this data structure"""
10692
12083
  return _lldb.SBStructuredData_GetType(self)
10693
12084
 
10694
12085
  def GetSize(self):
10695
- r"""GetSize(SBStructuredData self) -> size_t"""
12086
+ r"""
12087
+ Return the size (i.e. number of elements) in this data structure
12088
+ if it is an array or dictionary type. For other types, 0 will be
12089
+ """
10696
12090
  return _lldb.SBStructuredData_GetSize(self)
10697
12091
 
10698
12092
  def GetKeys(self, keys):
10699
- r"""GetKeys(SBStructuredData self, SBStringList keys) -> bool"""
12093
+ r"""
12094
+ Fill keys with the keys in this object and return true if this data
12095
+ structure is a dictionary. Returns false otherwise.
12096
+ """
10700
12097
  return _lldb.SBStructuredData_GetKeys(self, keys)
10701
12098
 
10702
12099
  def GetValueForKey(self, key):
10703
- r"""GetValueForKey(SBStructuredData self, char const * key) -> SBStructuredData"""
12100
+ r"""
12101
+ Return the value corresponding to a key if this data structure
12102
+ is a dictionary type.
12103
+ """
10704
12104
  return _lldb.SBStructuredData_GetValueForKey(self, key)
10705
12105
 
10706
12106
  def GetItemAtIndex(self, idx):
10707
- r"""GetItemAtIndex(SBStructuredData self, size_t idx) -> SBStructuredData"""
12107
+ r"""
12108
+ Return the value corresponding to an index if this data structure
12109
+ is array.
12110
+ """
10708
12111
  return _lldb.SBStructuredData_GetItemAtIndex(self, idx)
10709
12112
 
10710
12113
  def GetUnsignedIntegerValue(self, fail_value=0):
10711
- r"""GetUnsignedIntegerValue(SBStructuredData self, uint64_t fail_value=0) -> uint64_t"""
12114
+ r"""Return the integer value if this data structure is an integer type."""
10712
12115
  return _lldb.SBStructuredData_GetUnsignedIntegerValue(self, fail_value)
10713
12116
 
10714
12117
  def GetSignedIntegerValue(self, fail_value=0):
10715
- r"""GetSignedIntegerValue(SBStructuredData self, int64_t fail_value=0) -> int64_t"""
12118
+ r"""Return the integer value if this data structure is an integer type."""
10716
12119
  return _lldb.SBStructuredData_GetSignedIntegerValue(self, fail_value)
10717
12120
 
10718
12121
  def GetIntegerValue(self, fail_value=0):
@@ -10720,19 +12123,41 @@ class SBStructuredData(object):
10720
12123
  return _lldb.SBStructuredData_GetIntegerValue(self, fail_value)
10721
12124
 
10722
12125
  def GetFloatValue(self, fail_value=0.0):
10723
- r"""GetFloatValue(SBStructuredData self, double fail_value=0.0) -> double"""
12126
+ r"""
12127
+ Return the floating point value if this data structure is a floating
12128
+ type.
12129
+ """
10724
12130
  return _lldb.SBStructuredData_GetFloatValue(self, fail_value)
10725
12131
 
10726
12132
  def GetBooleanValue(self, fail_value=False):
10727
- r"""GetBooleanValue(SBStructuredData self, bool fail_value=False) -> bool"""
12133
+ r"""Return the boolean value if this data structure is a boolean type."""
10728
12134
  return _lldb.SBStructuredData_GetBooleanValue(self, fail_value)
10729
12135
 
10730
12136
  def GetStringValue(self, dst):
10731
- r"""GetStringValue(SBStructuredData self, char * dst) -> size_t"""
12137
+ r"""
12138
+ Provides the string value if this data structure is a string type.
12139
+
12140
+ :type dst: string, out
12141
+ :param dst:
12142
+ pointer where the string value will be written. In case it is null,
12143
+ nothing will be written at *dst*.
12144
+
12145
+ :type dst_len: int, in
12146
+ :param dst_len:
12147
+ max number of characters that can be written at *dst*. In case it is
12148
+ zero, nothing will be written at *dst*. If this length is not enough
12149
+ to write the complete string value, (*dst_len* - 1) bytes of the
12150
+ string value will be written at *dst* followed by a null character.
12151
+
12152
+ :rtype: int
12153
+ :return:
12154
+ Returns the byte size needed to completely write the string value at
12155
+ *dst* in all cases.
12156
+ """
10732
12157
  return _lldb.SBStructuredData_GetStringValue(self, dst)
10733
12158
 
10734
12159
  def GetGenericValue(self):
10735
- r"""GetGenericValue(SBStructuredData self) -> SBScriptObject"""
12160
+ r"""Return the generic pointer if this data structure is a generic type."""
10736
12161
  return _lldb.SBStructuredData_GetGenericValue(self)
10737
12162
 
10738
12163
  def __repr__(self):
@@ -10799,19 +12224,59 @@ class SBSymbol(object):
10799
12224
  return _lldb.SBSymbol_GetInstructions(self, *args)
10800
12225
 
10801
12226
  def GetStartAddress(self):
10802
- r"""GetStartAddress(SBSymbol self) -> SBAddress"""
12227
+ r"""
12228
+ Get the start address of this symbol
12229
+
12230
+ :rtype: :py:class:`SBAddress`
12231
+ :return:
12232
+ If the symbol's value is not an address, an invalid SBAddress object
12233
+ will be returned. If the symbol's value is an address, a valid SBAddress
12234
+ object will be returned.
12235
+ """
10803
12236
  return _lldb.SBSymbol_GetStartAddress(self)
10804
12237
 
10805
12238
  def GetEndAddress(self):
10806
- r"""GetEndAddress(SBSymbol self) -> SBAddress"""
12239
+ r"""
12240
+ Get the end address of this symbol
12241
+
12242
+ :rtype: :py:class:`SBAddress`
12243
+ :return:
12244
+ If the symbol's value is not an address, an invalid SBAddress object
12245
+ will be returned. If the symbol's value is an address, a valid SBAddress
12246
+ object will be returned.
12247
+ """
10807
12248
  return _lldb.SBSymbol_GetEndAddress(self)
10808
12249
 
10809
12250
  def GetValue(self):
10810
- r"""GetValue(SBSymbol self) -> uint64_t"""
12251
+ r"""
12252
+ Get the raw value of a symbol.
12253
+
12254
+ This accessor allows direct access to the symbol's value from the symbol
12255
+ table regardless of what the value is. The value can be a file address or
12256
+ it can be an integer value that depends on what the symbol's type is. Some
12257
+ symbol values are not addresses, but absolute values or integer values
12258
+ that can be mean different things. The GetStartAddress() accessor will
12259
+ only return a valid SBAddress if the symbol's value is an address, so this
12260
+ accessor provides a way to access the symbol's value when the value is
12261
+ not an address.
12262
+
12263
+ :rtype: int
12264
+ :return:
12265
+ Returns the raw integer value of a symbol from the symbol table.
12266
+ """
10811
12267
  return _lldb.SBSymbol_GetValue(self)
10812
12268
 
10813
12269
  def GetSize(self):
10814
- r"""GetSize(SBSymbol self) -> uint64_t"""
12270
+ r"""
12271
+ Get the size of the symbol.
12272
+
12273
+ This accessor allows direct access to the symbol's size from the symbol
12274
+ table regardless of what the value is (address or integer value).
12275
+
12276
+ :rtype: int
12277
+ :return:
12278
+ Returns the size of a symbol from the symbol table.
12279
+ """
10815
12280
  return _lldb.SBSymbol_GetSize(self)
10816
12281
 
10817
12282
  def GetPrologueByteSize(self):
@@ -11256,22 +12721,56 @@ class SBTarget(object):
11256
12721
  return _lldb.SBTarget_GetProcess(self)
11257
12722
 
11258
12723
  def SetCollectingStats(self, v):
11259
- r"""SetCollectingStats(SBTarget self, bool v)"""
12724
+ r"""
12725
+ Sets whether we should collect statistics on lldb or not.
12726
+
12727
+ :type v: boolean, in
12728
+ :param v:
12729
+ A boolean to control the collection.
12730
+ """
11260
12731
  return _lldb.SBTarget_SetCollectingStats(self, v)
11261
12732
 
11262
12733
  def GetCollectingStats(self):
11263
- r"""GetCollectingStats(SBTarget self) -> bool"""
12734
+ r"""
12735
+ Returns whether statistics collection are enabled.
12736
+
12737
+ :rtype: boolean
12738
+ :return:
12739
+ true if statistics are currently being collected, false
12740
+ otherwise.
12741
+ """
11264
12742
  return _lldb.SBTarget_GetCollectingStats(self)
11265
12743
 
11266
12744
  def GetStatistics(self, *args):
11267
12745
  r"""
11268
- GetStatistics(SBTarget self) -> SBStructuredData
11269
- GetStatistics(SBTarget self, SBStatisticsOptions options) -> SBStructuredData
12746
+ *Overload 1:*
12747
+ Returns a dump of the collected statistics.
12748
+
12749
+ :rtype: :py:class:`SBStructuredData`
12750
+ :return:
12751
+ A SBStructuredData with the statistics collected.
12752
+
12753
+ |
12754
+
12755
+ *Overload 2:*
12756
+ Returns a dump of the collected statistics.
12757
+
12758
+ :type options: :py:class:`SBStatisticsOptions`, in
12759
+ :param options:
12760
+ An objects object that contains all options for the statistics dumping.
12761
+
12762
+ :rtype: :py:class:`SBStructuredData`
12763
+ :return:
12764
+ A SBStructuredData with the statistics collected.
11270
12765
  """
11271
12766
  return _lldb.SBTarget_GetStatistics(self, *args)
11272
12767
 
11273
12768
  def ResetStatistics(self):
11274
- r"""ResetStatistics(SBTarget self)"""
12769
+ r"""
12770
+ Reset the statistics collected for this target.
12771
+ This includes clearing symbol table and debug info parsing/index time for
12772
+ all modules, breakpoint resolve time and target statistics.
12773
+ """
11275
12774
  return _lldb.SBTarget_ResetStatistics(self)
11276
12775
 
11277
12776
  def GetPlatform(self):
@@ -11289,7 +12788,15 @@ class SBTarget(object):
11289
12788
  return _lldb.SBTarget_GetPlatform(self)
11290
12789
 
11291
12790
  def GetEnvironment(self):
11292
- r"""GetEnvironment(SBTarget self) -> SBEnvironment"""
12791
+ r"""
12792
+ Return the environment variables that would be used to launch a new
12793
+ process.
12794
+
12795
+ :rtype: :py:class:`SBEnvironment`
12796
+ :return:
12797
+ An lldb::SBEnvironment object which is a copy of the target's
12798
+ environment.
12799
+ """
11293
12800
  return _lldb.SBTarget_GetEnvironment(self)
11294
12801
 
11295
12802
  def Install(self):
@@ -11594,6 +13101,26 @@ class SBTarget(object):
11594
13101
  r"""SetLabel(SBTarget self, char const * label) -> SBError"""
11595
13102
  return _lldb.SBTarget_SetLabel(self, label)
11596
13103
 
13104
+ def GetMinimumOpcodeByteSize(self):
13105
+ r"""
13106
+ Architecture opcode byte size width accessor
13107
+
13108
+ :rtype: int
13109
+ :return:
13110
+ The minimum size in 8-bit (host) bytes of an opcode.
13111
+ """
13112
+ return _lldb.SBTarget_GetMinimumOpcodeByteSize(self)
13113
+
13114
+ def GetMaximumOpcodeByteSize(self):
13115
+ r"""
13116
+ Architecture opcode byte size width accessor
13117
+
13118
+ :rtype: int
13119
+ :return:
13120
+ The maximum size in 8-bit (host) bytes of an opcode.
13121
+ """
13122
+ return _lldb.SBTarget_GetMaximumOpcodeByteSize(self)
13123
+
11597
13124
  def GetDataByteSize(self):
11598
13125
  r"""
11599
13126
  GetDataByteSize(SBTarget self) -> uint32_t
@@ -11619,23 +13146,88 @@ class SBTarget(object):
11619
13146
  return _lldb.SBTarget_GetCodeByteSize(self)
11620
13147
 
11621
13148
  def GetMaximumNumberOfChildrenToDisplay(self):
11622
- r"""GetMaximumNumberOfChildrenToDisplay(SBTarget self) -> uint32_t"""
13149
+ r"""
13150
+ Gets the target.max-children-count value
13151
+ It should be used to limit the number of
13152
+ children of large data structures to be displayed.
13153
+ """
11623
13154
  return _lldb.SBTarget_GetMaximumNumberOfChildrenToDisplay(self)
11624
13155
 
11625
13156
  def SetSectionLoadAddress(self, section, section_base_addr):
11626
- r"""SetSectionLoadAddress(SBTarget self, SBSection section, lldb::addr_t section_base_addr) -> SBError"""
13157
+ r"""
13158
+ Set the base load address for a module section.
13159
+
13160
+ :type section: :py:class:`SBSection`, in
13161
+ :param section:
13162
+ The section whose base load address will be set within this
13163
+ target.
13164
+
13165
+ :type section_base_addr: int, in
13166
+ :param section_base_addr:
13167
+ The base address for the section.
13168
+
13169
+ :rtype: :py:class:`SBError`
13170
+ :return:
13171
+ An error to indicate success, fail, and any reason for
13172
+ failure.
13173
+ """
11627
13174
  return _lldb.SBTarget_SetSectionLoadAddress(self, section, section_base_addr)
11628
13175
 
11629
13176
  def ClearSectionLoadAddress(self, section):
11630
- r"""ClearSectionLoadAddress(SBTarget self, SBSection section) -> SBError"""
13177
+ r"""
13178
+ Clear the base load address for a module section.
13179
+
13180
+ :type section: :py:class:`SBSection`, in
13181
+ :param section:
13182
+ The section whose base load address will be cleared within
13183
+ this target.
13184
+
13185
+ :rtype: :py:class:`SBError`
13186
+ :return:
13187
+ An error to indicate success, fail, and any reason for
13188
+ failure.
13189
+ """
11631
13190
  return _lldb.SBTarget_ClearSectionLoadAddress(self, section)
11632
13191
 
11633
13192
  def SetModuleLoadAddress(self, module, sections_offset):
11634
- r"""SetModuleLoadAddress(SBTarget self, SBModule module, uint64_t sections_offset) -> SBError"""
13193
+ r"""
13194
+ Slide all file addresses for all module sections so that *module*
13195
+ appears to loaded at these slide addresses.
13196
+
13197
+ When you need all sections within a module to be loaded at a
13198
+ rigid slide from the addresses found in the module object file,
13199
+ this function will allow you to easily and quickly slide all
13200
+ module sections.
13201
+
13202
+ :type module: :py:class:`SBModule`, in
13203
+ :param module:
13204
+ The module to load.
13205
+
13206
+ :type sections_offset: int, in
13207
+ :param sections_offset:
13208
+ An offset that will be applied to all section file addresses
13209
+ (the virtual addresses found in the object file itself).
13210
+
13211
+ :rtype: :py:class:`SBError`
13212
+ :return:
13213
+ An error to indicate success, fail, and any reason for
13214
+ failure.
13215
+ """
11635
13216
  return _lldb.SBTarget_SetModuleLoadAddress(self, module, sections_offset)
11636
13217
 
11637
13218
  def ClearModuleLoadAddress(self, module):
11638
- r"""ClearModuleLoadAddress(SBTarget self, SBModule module) -> SBError"""
13219
+ r"""
13220
+ Clear the section base load addresses for all sections in a module.
13221
+
13222
+ :type module: :py:class:`SBModule`, in
13223
+ :param module:
13224
+ The module to unload.
13225
+
13226
+ :rtype: :py:class:`SBError`
13227
+ :return:
13228
+ An error to indicate success, fail, and any reason for
13229
+ failure.
13230
+ """
11639
13231
  return _lldb.SBTarget_ClearModuleLoadAddress(self, module)
11640
13232
 
11641
13233
  def FindFunctions(self, *args):
@@ -11694,7 +13286,25 @@ class SBTarget(object):
11694
13286
  return _lldb.SBTarget_FindGlobalVariables(self, *args)
11695
13287
 
11696
13288
  def FindGlobalFunctions(self, name, max_matches, matchtype):
11697
- r"""FindGlobalFunctions(SBTarget self, char const * name, uint32_t max_matches, lldb::MatchType matchtype) -> SBSymbolContextList"""
13289
+ r"""
13290
+ Find global functions by their name with pattern matching.
13291
+
13292
+ :type name: string, in
13293
+ :param name:
13294
+ The pattern to search for global or static variables
13295
+
13296
+ :type max_matches: int, in
13297
+ :param max_matches:
13298
+ Allow the number of matches to be limited to *max_matches*.
13299
+
13300
+ :type matchtype: int, in
13301
+ :param matchtype:
13302
+ The match type to use.
13303
+
13304
+ :rtype: :py:class:`SBSymbolContextList`
13305
+ :return:
13306
+ A list of matched variables in an SBValueList.
13307
+ """
11698
13308
  return _lldb.SBTarget_FindGlobalFunctions(self, name, max_matches, matchtype)
11699
13309
 
11700
13310
  def Clear(self):
@@ -11715,11 +13325,49 @@ class SBTarget(object):
11715
13325
  return _lldb.SBTarget_ResolveFileAddress(self, file_addr)
11716
13326
 
11717
13327
  def ResolveLoadAddress(self, vm_addr):
11718
- r"""ResolveLoadAddress(SBTarget self, lldb::addr_t vm_addr) -> SBAddress"""
13328
+ r"""
13329
+ Resolve a current load address into a section offset address.
13330
+
13331
+ :type vm_addr: int, in
13332
+ :param vm_addr:
13333
+ A virtual address from the current process state that is to
13334
+ be translated into a section offset address.
13335
+
13336
+ :rtype: :py:class:`SBAddress`
13337
+ :return:
13338
+ An SBAddress which will be valid if *vm_addr* was
13339
+ successfully resolved into a section offset address, or an
13340
+ invalid SBAddress if *vm_addr* doesn't resolve to a section
13341
+ in a module.
13342
+ """
11719
13343
  return _lldb.SBTarget_ResolveLoadAddress(self, vm_addr)
11720
13344
 
11721
13345
  def ResolvePastLoadAddress(self, stop_id, vm_addr):
11722
- r"""ResolvePastLoadAddress(SBTarget self, uint32_t stop_id, lldb::addr_t vm_addr) -> SBAddress"""
13346
+ r"""
13347
+ Resolve a current load address into a section offset address
13348
+ using the process stop ID to identify a time in the past.
13349
+
13350
+ :type stop_id: int, in
13351
+ :param stop_id:
13352
+ Each time a process stops, the process stop ID integer gets
13353
+ incremented. These stop IDs are used to identify past times
13354
+ and can be used in history objects as a cheap way to store
13355
+ the time at which the sample was taken. Specifying
13356
+ UINT32_MAX will always resolve the address using the
13357
+ currently loaded sections.
13358
+
13359
+ :type vm_addr: int, in
13360
+ :param vm_addr:
13361
+ A virtual address from the current process state that is to
13362
+ be translated into a section offset address.
13363
+
13364
+ :rtype: :py:class:`SBAddress`
13365
+ :return:
13366
+ An SBAddress which will be valid if *vm_addr* was
13367
+ successfully resolved into a section offset address, or an
13368
+ invalid SBAddress if *vm_addr* doesn't resolve to a section
13369
+ in a module.
13370
+ """
11723
13371
  return _lldb.SBTarget_ResolvePastLoadAddress(self, stop_id, vm_addr)
11724
13372
 
11725
13373
  def ResolveSymbolContextForAddress(self, addr, resolve_scope):
@@ -12139,13 +13787,32 @@ class SBTarget(object):
12139
13787
  return _lldb.SBTarget_SetLaunchInfo(self, launch_info)
12140
13788
 
12141
13789
  def GetTrace(self):
12142
- r"""GetTrace(SBTarget self) -> SBTrace"""
13790
+ r"""
13791
+ Get a *SBTrace* object the can manage the processor trace information of
13792
+ this target.
13793
+
13794
+ :rtype: :py:class:`SBTrace`
13795
+ :return:
13796
+ The trace object. The returned SBTrace object might not be valid, so it
13797
+ should be checked with a call to "bool SBTrace::IsValid()".
13798
+ """
12143
13799
  return _lldb.SBTarget_GetTrace(self)
12144
13800
 
12145
13801
  def CreateTrace(self, error):
12146
- r"""CreateTrace(SBTarget self, SBError error) -> SBTrace"""
13802
+ r"""
13803
+ Create a *Trace* object for the current target using the using the
13804
+ default supported tracing technology for this process.
13805
+
13806
+ :type error: :py:class:`SBError`, out
13807
+ :param error:
13808
+ An error if a Trace already exists or the trace couldn't be created.
13809
+ """
12147
13810
  return _lldb.SBTarget_CreateTrace(self, error)
12148
13811
 
13812
+ def GetAPIMutex(self):
13813
+ r"""GetAPIMutex(SBTarget self) -> SBMutex"""
13814
+ return _lldb.SBTarget_GetAPIMutex(self)
13815
+
12149
13816
  def __repr__(self):
12150
13817
  r"""__repr__(SBTarget self) -> std::string"""
12151
13818
  return _lldb.SBTarget___repr__(self)
@@ -12729,7 +14396,24 @@ class SBThread(object):
12729
14396
  return _lldb.SBThread_GetDescription(self, *args)
12730
14397
 
12731
14398
  def GetDescriptionWithFormat(self, format, output):
12732
- r"""GetDescriptionWithFormat(SBThread self, SBFormat format, SBStream output) -> SBError"""
14399
+ r"""
14400
+ Similar to *GetDescription()* but the format of the description can be
14401
+ configured via the ``format`` parameter. See
14402
+ https://lldb.llvm.org/use/formatting.html for more information on format
14403
+ strings.
14404
+
14405
+ :type format: :py:class:`SBFormat`, in
14406
+ :param format:
14407
+ The format to use for generating the description.
14408
+
14409
+ :type output: :py:class:`SBStream`, out
14410
+ :param output:
14411
+ The stream where the description will be written to.
14412
+
14413
+ :rtype: :py:class:`SBError`
14414
+ :return:
14415
+ An error object with an error message in case of failures.
14416
+ """
12733
14417
  return _lldb.SBThread_GetDescriptionWithFormat(self, format, output)
12734
14418
 
12735
14419
  def GetStatus(self, status):
@@ -13073,6 +14757,10 @@ class SBThreadPlan(object):
13073
14757
  """
13074
14758
  return _lldb.SBThreadPlan_QueueThreadPlanForStepOut(self, *args)
13075
14759
 
14760
+ def QueueThreadPlanForStepSingleInstruction(self, step_over, error):
14761
+ r"""QueueThreadPlanForStepSingleInstruction(SBThreadPlan self, bool step_over, SBError error) -> SBThreadPlan"""
14762
+ return _lldb.SBThreadPlan_QueueThreadPlanForStepSingleInstruction(self, step_over, error)
14763
+
13076
14764
  def QueueThreadPlanForRunToAddress(self, *args):
13077
14765
  r"""
13078
14766
  QueueThreadPlanForRunToAddress(SBThreadPlan self, SBAddress address) -> SBThreadPlan
@@ -13097,37 +14785,149 @@ class SBTrace(object):
13097
14785
  __repr__ = _swig_repr
13098
14786
 
13099
14787
  def __init__(self):
13100
- r"""__init__(SBTrace self) -> SBTrace"""
14788
+ r"""Default constructor for an invalid Trace object."""
13101
14789
  _lldb.SBTrace_swiginit(self, _lldb.new_SBTrace())
13102
14790
 
13103
14791
  @staticmethod
13104
14792
  def LoadTraceFromFile(error, debugger, trace_description_file):
13105
- r"""LoadTraceFromFile(SBError error, SBDebugger debugger, SBFileSpec trace_description_file) -> SBTrace"""
14793
+ r"""See SBDebugger::LoadTraceFromFile."""
13106
14794
  return _lldb.SBTrace_LoadTraceFromFile(error, debugger, trace_description_file)
13107
14795
 
13108
14796
  def CreateNewCursor(self, error, thread):
13109
- r"""CreateNewCursor(SBTrace self, SBError error, SBThread thread) -> SBTraceCursor"""
14797
+ r"""
14798
+ Get a *TraceCursor* for the given thread's trace.
14799
+
14800
+ :type error: :py:class:`SBError`, out
14801
+ :param error:
14802
+ This will be set with an error in case of failures.
14803
+ :type thread: :py:class:`SBThread`, in
14804
+ :param thread:
14805
+ The thread to get a *TraceCursor* for.
14806
+ :rtype: :py:class:`SBTraceCursor`
14807
+ :return:
14808
+ A *SBTraceCursor*. If the thread is not traced or its trace
14809
+ information failed to load, an invalid *SBTraceCursor* is returned
14810
+ and the ``error`` parameter is set.
14811
+ """
13110
14812
  return _lldb.SBTrace_CreateNewCursor(self, error, thread)
13111
14813
 
13112
14814
  def SaveToDisk(self, error, bundle_dir, compact=False):
13113
- r"""SaveToDisk(SBTrace self, SBError error, SBFileSpec bundle_dir, bool compact=False) -> SBFileSpec"""
14815
+ r"""
14816
+ Save the trace to the specified directory, which will be created if
14817
+ needed. This will also create a file <directory>/trace.json with the
14818
+ main properties of the trace session, along with others files which
14819
+ contain the actual trace data. The trace.json file can be used later as
14820
+ input for the "trace load" command to load the trace in LLDB, or for the
14821
+ method *SBDebugger.LoadTraceFromFile()*.
14822
+
14823
+ :type error: :py:class:`SBError`, out
14824
+ :param error:
14825
+ This will be set with an error in case of failures.
14826
+
14827
+ :type bundle_dir: :py:class:`SBFileSpec`, in
14828
+ :param bundle_dir:
14829
+ The directory where the trace files will be saved.
14830
+
14831
+ :type compact: boolean, in, optional
14832
+ :param compact:
14833
+ Try not to save to disk information irrelevant to the traced processes.
14834
+ Each trace plug-in implements this in a different fashion.
14835
+
14836
+ :rtype: :py:class:`SBFileSpec`
14837
+ :return:
14838
+ A *SBFileSpec* pointing to the bundle description file.
14839
+ """
13114
14840
  return _lldb.SBTrace_SaveToDisk(self, error, bundle_dir, compact)
13115
14841
 
13116
14842
  def GetStartConfigurationHelp(self):
13117
- r"""GetStartConfigurationHelp(SBTrace self) -> char const *"""
14843
+ r"""
14844
+ :rtype: string
14845
+ :return:
14846
+ A description of the parameters to use for the *SBTrace::Start*
14847
+ method, or **null** if the object is invalid.
14848
+ """
13118
14849
  return _lldb.SBTrace_GetStartConfigurationHelp(self)
13119
14850
 
13120
14851
  def Start(self, *args):
13121
14852
  r"""
13122
- Start(SBTrace self, SBStructuredData configuration) -> SBError
13123
- Start(SBTrace self, SBThread thread, SBStructuredData configuration) -> SBError
14853
+ *Overload 1:*
14854
+ Start tracing all current and future threads in a live process using a
14855
+ provided configuration. This is referred as "process tracing" in the
14856
+ documentation.
14857
+
14858
+ This is equivalent to the command "process trace start".
14859
+
14860
+ This operation fails if it is invoked twice in a row without
14861
+ first stopping the process trace with *SBTrace::Stop()*.
14862
+
14863
+ If a thread is already being traced explicitly, e.g. with
14864
+ *SBTrace::Start(const* SBThread &thread, const SBStructuredData
14865
+ &configuration), it is left unaffected by this operation.
14866
+
14867
+ :type configuration: :py:class:`SBStructuredData`, in
14868
+ :param configuration:
14869
+ Dictionary object with custom fields for the corresponding trace
14870
+ technology.
14871
+
14872
+ Full details for the trace start parameters that can be set can be
14873
+ retrieved by calling *SBTrace::GetStartConfigurationHelp()*.
14874
+
14875
+ :rtype: :py:class:`SBError`
14876
+ :return:
14877
+ An error explaining any failures.
14878
+
14879
+ |
14880
+
14881
+ *Overload 2:*
14882
+ Start tracing a specific thread in a live process using a provided
14883
+ configuration. This is referred as "thread tracing" in the documentation.
14884
+
14885
+ This is equivalent to the command "thread trace start".
14886
+
14887
+ If the thread is already being traced by a "process tracing" operation,
14888
+ e.g. with *SBTrace::Start(const* SBStructuredData &configuration), this
14889
+ operation fails.
14890
+
14891
+ :type configuration: :py:class:`SBStructuredData`, in
14892
+ :param configuration:
14893
+ Dictionary object with custom fields for the corresponding trace
14894
+ technology.
14895
+
14896
+ Full details for the trace start parameters that can be set can be
14897
+ retrieved by calling *SBTrace::GetStartConfigurationHelp()*.
14898
+
14899
+ :rtype: :py:class:`SBError`
14900
+ :return:
14901
+ An error explaining any failures.
13124
14902
  """
13125
14903
  return _lldb.SBTrace_Start(self, *args)
13126
14904
 
13127
14905
  def Stop(self, *args):
13128
14906
  r"""
13129
- Stop(SBTrace self) -> SBError
13130
- Stop(SBTrace self, SBThread thread) -> SBError
14907
+ *Overload 1:*
14908
+ Stop tracing all threads in a live process.
14909
+
14910
+ If a "process tracing" operation is active, e.g. *SBTrace::Start(const*
14911
+ SBStructuredData &configuration), this effectively prevents future threads
14912
+ from being traced.
14913
+
14914
+ This is equivalent to the command "process trace stop".
14915
+
14916
+ :rtype: :py:class:`SBError`
14917
+ :return:
14918
+ An error explaining any failures.
14919
+
14920
+ |
14921
+
14922
+ *Overload 2:*
14923
+ Stop tracing a specific thread in a live process regardless of whether the
14924
+ thread was traced explicitly or as part of a "process tracing" operation.
14925
+
14926
+ This is equivalent to the command "thread trace stop".
14927
+
14928
+ :rtype: :py:class:`SBError`
14929
+ :return:
14930
+ An error explaining any failures.
13131
14931
  """
13132
14932
  return _lldb.SBTrace_Stop(self, *args)
13133
14933
 
@@ -13151,75 +14951,213 @@ class SBTraceCursor(object):
13151
14951
  __repr__ = _swig_repr
13152
14952
 
13153
14953
  def __init__(self):
13154
- r"""__init__(SBTraceCursor self) -> SBTraceCursor"""
14954
+ r"""Default constructor for an invalid *SBTraceCursor* object."""
13155
14955
  _lldb.SBTraceCursor_swiginit(self, _lldb.new_SBTraceCursor())
13156
14956
 
13157
14957
  def SetForwards(self, forwards):
13158
- r"""SetForwards(SBTraceCursor self, bool forwards)"""
14958
+ r"""
14959
+ Set the direction to use in the *SBTraceCursor::Next()* method.
14960
+
14961
+ :type forwards: boolean, in
14962
+ :param forwards:
14963
+ If **true**, then the traversal will be forwards, otherwise backwards.
14964
+ """
13159
14965
  return _lldb.SBTraceCursor_SetForwards(self, forwards)
13160
14966
 
13161
14967
  def IsForwards(self):
13162
- r"""IsForwards(SBTraceCursor self) -> bool"""
14968
+ r"""
14969
+ Check if the direction to use in the *SBTraceCursor::Next()* method is
14970
+ forwards.
14971
+
14972
+ :rtype: boolean
14973
+ :return:
14974
+ **true** if the current direction is forwards, **false** if backwards.
14975
+ """
13163
14976
  return _lldb.SBTraceCursor_IsForwards(self)
13164
14977
 
13165
14978
  def Next(self):
13166
- r"""Next(SBTraceCursor self)"""
14979
+ r"""
14980
+ Move the cursor to the next item (instruction or error).
14981
+
14982
+ Direction:
14983
+ The traversal is done following the current direction of the trace. If
14984
+ it is forwards, the instructions are visited forwards
14985
+ chronologically. Otherwise, the traversal is done in
14986
+ the opposite direction. By default, a cursor moves backwards unless
14987
+ changed with *SBTraceCursor::SetForwards()*.
14988
+ """
13167
14989
  return _lldb.SBTraceCursor_Next(self)
13168
14990
 
13169
14991
  def HasValue(self):
13170
- r"""HasValue(SBTraceCursor self) -> bool"""
14992
+ r"""
14993
+ :rtype: boolean
14994
+ :return:
14995
+ **true** if the cursor is pointing to a valid item. **false** if the
14996
+ cursor has reached the end of the trace.
14997
+ """
13171
14998
  return _lldb.SBTraceCursor_HasValue(self)
13172
14999
 
13173
15000
  def GoToId(self, id):
13174
- r"""GoToId(SBTraceCursor self, lldb::user_id_t id) -> bool"""
15001
+ r"""
15002
+ Instruction identifiers:
15003
+
15004
+ When building complex higher level tools, fast random accesses in the
15005
+ trace might be needed, for which each instruction requires a unique
15006
+ identifier within its thread trace. For example, a tool might want to
15007
+ repeatedly inspect random consecutive portions of a trace. This means that
15008
+ it will need to first move quickly to the beginning of each section and
15009
+ then start its iteration. Given that the number of instructions can be in
15010
+ the order of hundreds of millions, fast random access is necessary.
15011
+
15012
+ An example of such a tool could be an inspector of the call graph of a
15013
+ trace, where each call is represented with its start and end instructions.
15014
+ Inspecting all the instructions of a call requires moving to its first
15015
+ instruction and then iterating until the last instruction, which following
15016
+ the pattern explained above.
15017
+
15018
+ Instead of using 0-based indices as identifiers, each Trace plug-in can
15019
+ decide the nature of these identifiers and thus no assumptions can be made
15020
+ regarding their ordering and sequentiality. The reason is that an
15021
+ instruction might be encoded by the plug-in in a way that hides its actual
15022
+ 0-based index in the trace, but it's still possible to efficiently find
15023
+ it.
15024
+
15025
+ Requirements:
15026
+ - For a given thread, no two instructions have the same id.
15027
+ - In terms of efficiency, moving the cursor to a given id should be as
15028
+ fast as possible, but not necessarily O(1). That's why the recommended
15029
+ way to traverse sequential instructions is to use the
15030
+ *SBTraceCursor::Next()* method and only use *SBTraceCursor::GoToId(id)*
15031
+ sparingly.
15032
+ Make the cursor point to the item whose identifier is ``id``.
15033
+
15034
+ :rtype: boolean
15035
+ :return:
15036
+ **true** if the given identifier exists and the cursor effectively
15037
+ moved to it. Otherwise, **false** is returned and the cursor now points
15038
+ to an invalid item, i.e. calling *HasValue()* will return **false**.
15039
+ """
13175
15040
  return _lldb.SBTraceCursor_GoToId(self, id)
13176
15041
 
13177
15042
  def HasId(self, id):
13178
- r"""HasId(SBTraceCursor self, lldb::user_id_t id) -> bool"""
15043
+ r"""
15044
+ :rtype: boolean
15045
+ :return:
15046
+ **true** if and only if there's an instruction item with the given
15047
+ ``id``.
15048
+ """
13179
15049
  return _lldb.SBTraceCursor_HasId(self, id)
13180
15050
 
13181
15051
  def GetId(self):
13182
- r"""GetId(SBTraceCursor self) -> lldb::user_id_t"""
15052
+ r"""
15053
+ :rtype: int
15054
+ :return:
15055
+ A unique identifier for the instruction or error this cursor is
15056
+ pointing to.
15057
+ """
13183
15058
  return _lldb.SBTraceCursor_GetId(self)
13184
15059
 
13185
15060
  def Seek(self, offset, origin):
13186
- r"""Seek(SBTraceCursor self, int64_t offset, lldb::TraceCursorSeekType origin) -> bool"""
15061
+ r"""
15062
+ Make the cursor point to an item in the trace based on an origin point and
15063
+ an offset.
15064
+
15065
+ The resulting position of the trace is
15066
+ origin + offset
15067
+
15068
+ If this resulting position would be out of bounds, the trace then points
15069
+ to an invalid item, i.e. calling *HasValue()* returns **false**.
15070
+
15071
+ :type offset: int, in
15072
+ :param offset:
15073
+ How many items to move forwards (if positive) or backwards (if
15074
+ negative) from the given origin point. For example, if origin is
15075
+ **End**, then a negative offset would move backward in the trace, but a
15076
+ positive offset would move past the trace to an invalid item.
15077
+
15078
+ :type origin: int, in
15079
+ :param origin:
15080
+ The reference point to use when moving the cursor.
15081
+
15082
+ :rtype: boolean
15083
+ :return:
15084
+ **true** if and only if the cursor ends up pointing to a valid item.
15085
+ """
13187
15086
  return _lldb.SBTraceCursor_Seek(self, offset, origin)
13188
15087
 
13189
15088
  def GetItemKind(self):
13190
- r"""GetItemKind(SBTraceCursor self) -> lldb::TraceItemKind"""
15089
+ r"""
15090
+ Trace item information (instructions, errors and events)
15091
+
15092
+ :rtype: int
15093
+ :return:
15094
+ The kind of item the cursor is pointing at.
15095
+ """
13191
15096
  return _lldb.SBTraceCursor_GetItemKind(self)
13192
15097
 
13193
15098
  def IsError(self):
13194
- r"""IsError(SBTraceCursor self) -> bool"""
15099
+ r"""
15100
+ :rtype: boolean
15101
+ :return:
15102
+ Whether the cursor points to an error or not.
15103
+ """
13195
15104
  return _lldb.SBTraceCursor_IsError(self)
13196
15105
 
13197
15106
  def GetError(self):
13198
- r"""GetError(SBTraceCursor self) -> char const *"""
15107
+ r"""
15108
+ :rtype: string
15109
+ :return:
15110
+ The error message the cursor is pointing at.
15111
+ """
13199
15112
  return _lldb.SBTraceCursor_GetError(self)
13200
15113
 
13201
15114
  def IsEvent(self):
13202
- r"""IsEvent(SBTraceCursor self) -> bool"""
15115
+ r"""
15116
+ :rtype: boolean
15117
+ :return:
15118
+ Whether the cursor points to an event or not.
15119
+ """
13203
15120
  return _lldb.SBTraceCursor_IsEvent(self)
13204
15121
 
13205
15122
  def GetEventType(self):
13206
- r"""GetEventType(SBTraceCursor self) -> lldb::TraceEvent"""
15123
+ r"""
15124
+ :rtype: int
15125
+ :return:
15126
+ The specific kind of event the cursor is pointing at.
15127
+ """
13207
15128
  return _lldb.SBTraceCursor_GetEventType(self)
13208
15129
 
13209
15130
  def GetEventTypeAsString(self):
13210
- r"""GetEventTypeAsString(SBTraceCursor self) -> char const *"""
15131
+ r"""
15132
+ :rtype: string
15133
+ :return:
15134
+ A human-readable description of the event this cursor is pointing at.
15135
+ """
13211
15136
  return _lldb.SBTraceCursor_GetEventTypeAsString(self)
13212
15137
 
13213
15138
  def IsInstruction(self):
13214
- r"""IsInstruction(SBTraceCursor self) -> bool"""
15139
+ r"""
15140
+ :rtype: boolean
15141
+ :return:
15142
+ Whether the cursor points to an instruction.
15143
+ """
13215
15144
  return _lldb.SBTraceCursor_IsInstruction(self)
13216
15145
 
13217
15146
  def GetLoadAddress(self):
13218
- r"""GetLoadAddress(SBTraceCursor self) -> lldb::addr_t"""
15147
+ r"""
15148
+ :rtype: int
15149
+ :return:
15150
+ The load address of the instruction the cursor is pointing at.
15151
+ """
13219
15152
  return _lldb.SBTraceCursor_GetLoadAddress(self)
13220
15153
 
13221
15154
  def GetCPU(self):
13222
- r"""GetCPU(SBTraceCursor self) -> lldb::cpu_id_t"""
15155
+ r"""
15156
+ :rtype: int
15157
+ :return:
15158
+ The requested CPU id, or LLDB_INVALID_CPU_ID if this information is
15159
+ not available for the current item.
15160
+ """
13223
15161
  return _lldb.SBTraceCursor_GetCPU(self)
13224
15162
 
13225
15163
  def IsValid(self):
@@ -14064,6 +16002,16 @@ class SBType(object):
14064
16002
  """
14065
16003
  return _lldb.SBType_GetTemplateArgumentType(self, idx)
14066
16004
 
16005
+ def GetTemplateArgumentValue(self, target, idx):
16006
+ r"""
16007
+ Returns the value of the non-type template parameter at index ``idx``.
16008
+ If ``idx`` is out-of-bounds or the template parameter doesn't have
16009
+ a value, returns an empty SBValue.
16010
+
16011
+ This function will expand parameter packs.
16012
+ """
16013
+ return _lldb.SBType_GetTemplateArgumentValue(self, target, idx)
16014
+
14067
16015
  def GetTemplateArgumentKind(self, idx):
14068
16016
  r"""
14069
16017
  GetTemplateArgumentKind(SBType self, uint32_t idx) -> lldb::TemplateArgumentKind
@@ -15258,6 +17206,14 @@ class SBTypeSummary(object):
15258
17206
  r"""SetFunctionCode(SBTypeSummary self, char const * data)"""
15259
17207
  return _lldb.SBTypeSummary_SetFunctionCode(self, data)
15260
17208
 
17209
+ def GetPtrMatchDepth(self):
17210
+ r"""GetPtrMatchDepth(SBTypeSummary self) -> uint32_t"""
17211
+ return _lldb.SBTypeSummary_GetPtrMatchDepth(self)
17212
+
17213
+ def SetPtrMatchDepth(self, ptr_match_depth):
17214
+ r"""SetPtrMatchDepth(SBTypeSummary self, uint32_t ptr_match_depth)"""
17215
+ return _lldb.SBTypeSummary_SetPtrMatchDepth(self, ptr_match_depth)
17216
+
15261
17217
  def GetOptions(self):
15262
17218
  r"""GetOptions(SBTypeSummary self) -> uint32_t"""
15263
17219
  return _lldb.SBTypeSummary_GetOptions(self)
@@ -15782,7 +17738,7 @@ class SBValue(object):
15782
17738
  def GetChildAtIndex(self, *args):
15783
17739
  r"""
15784
17740
  GetChildAtIndex(SBValue self, uint32_t idx) -> SBValue
15785
- GetChildAtIndex(SBValue self, uint32_t idx, lldb::DynamicValueType use_dynamic, bool can_create_synthetic) -> SBValue
17741
+ GetChildAtIndex(SBValue self, uint32_t idx, lldb::DynamicValueType use_dynamic, bool treat_as_array) -> SBValue
15786
17742
 
15787
17743
  Get a child value by index from a value.
15788
17744
 
@@ -15941,7 +17897,12 @@ class SBValue(object):
15941
17897
  return _lldb.SBValue_SetData(self, data, error)
15942
17898
 
15943
17899
  def Clone(self, new_name):
15944
- r"""Clone(SBValue self, char const * new_name) -> SBValue"""
17900
+ r"""
17901
+ Creates a copy of the SBValue with a new name and setting the current
17902
+ SBValue as its parent. It should be used when we want to change the
17903
+ name of a SBValue without modifying the actual SBValue itself
17904
+ (e.g. sythetic child provider).
17905
+ """
15945
17906
  return _lldb.SBValue_Clone(self, new_name)
15946
17907
 
15947
17908
  def GetDeclaration(self):
@@ -15949,7 +17910,23 @@ class SBValue(object):
15949
17910
  return _lldb.SBValue_GetDeclaration(self)
15950
17911
 
15951
17912
  def MightHaveChildren(self):
15952
- r"""MightHaveChildren(SBValue self) -> bool"""
17913
+ r"""
17914
+ Find out if a SBValue might have children.
17915
+
17916
+ This call is much more efficient than GetNumChildren() as it
17917
+ doesn't need to complete the underlying type. This is designed
17918
+ to be used in a UI environment in order to detect if the
17919
+ disclosure triangle should be displayed or not.
17920
+
17921
+ This function returns true for class, union, structure,
17922
+ pointers, references, arrays and more. Again, it does so without
17923
+ doing any expensive type completion.
17924
+
17925
+ :rtype: boolean
17926
+ :return:
17927
+ Returns **true** if the SBValue might have children, or
17928
+ **false** otherwise.
17929
+ """
15953
17930
  return _lldb.SBValue_MightHaveChildren(self)
15954
17931
 
15955
17932
  def IsRuntimeSupportValue(self):
@@ -15958,8 +17935,25 @@ class SBValue(object):
15958
17935
 
15959
17936
  def GetNumChildren(self, *args):
15960
17937
  r"""
15961
- GetNumChildren(SBValue self) -> uint32_t
15962
- GetNumChildren(SBValue self, uint32_t max) -> uint32_t
17938
+ *Overload 1:*
17939
+ Return the number of children of this variable. Note that for some
17940
+ variables this operation can be expensive. If possible, prefer calling
17941
+ GetNumChildren(max) with the maximum number of children you are interested
17942
+ in.
17943
+
17944
+ |
17945
+
17946
+ *Overload 2:*
17947
+ Return the numer of children of this variable, with a hint that the
17948
+ caller is interested in at most *max* children. Use this function to
17949
+ avoid expensive child computations in some cases. For example, if you know
17950
+ you will only ever display 100 elements, calling GetNumChildren(100) can
17951
+ avoid enumerating all the other children. If the returned value is smaller
17952
+ than *max*, then it represents the true number of children, otherwise it
17953
+ indicates that their number is at least *max*. Do not assume the returned
17954
+ number will always be less than or equal to *max*, as the implementation
17955
+ may choose to return a larger (but still smaller than the actual number of
17956
+ children) value.
15963
17957
  """
15964
17958
  return _lldb.SBValue_GetNumChildren(self, *args)
15965
17959
 
@@ -16039,7 +18033,52 @@ class SBValue(object):
16039
18033
  return _lldb.SBValue_WatchPointee(self, resolve_location, read, write, error)
16040
18034
 
16041
18035
  def GetVTable(self):
16042
- r"""GetVTable(SBValue self) -> SBValue"""
18036
+ r"""
18037
+ If this value represents a C++ class that has a vtable, return an value
18038
+ that represents the virtual function table.
18039
+
18040
+ SBValue::GetError() will be in the success state if this value represents
18041
+ a C++ class with a vtable, or an appropriate error describing that the
18042
+ object isn't a C++ class with a vtable or not a C++ class.
18043
+
18044
+ SBValue::GetName() will be the demangled symbol name for the virtual
18045
+ function table like "vtable for <classname>".
18046
+
18047
+ SBValue::GetValue() will be the address of the first vtable entry if the
18048
+ current SBValue is a class with a vtable, or nothing the current SBValue
18049
+ is not a C++ class or not a C++ class that has a vtable.
18050
+
18051
+ SBValue::GetValueAtUnsigned(...) will return the address of the first
18052
+ vtable entry.
18053
+
18054
+ SBValue::GetLoadAddress() will return the address of the vtable pointer
18055
+ found in the parent SBValue.
18056
+
18057
+ SBValue::GetNumChildren() will return the number of virtual function
18058
+ pointers in the vtable, or zero on error.
18059
+
18060
+ SBValue::GetChildAtIndex(...) will return each virtual function pointer
18061
+ as a SBValue object.
18062
+
18063
+ The child SBValue objects will have the following values:
18064
+
18065
+ SBValue::GetError() will indicate success if the vtable entry was
18066
+ successfully read from memory, or an error if not.
18067
+
18068
+ SBValue::GetName() will be the vtable function index in the form "[%u]"
18069
+ where %u is the index.
18070
+
18071
+ SBValue::GetValue() will be the virtual function pointer value as a
18072
+ string.
18073
+
18074
+ SBValue::GetValueAtUnsigned(...) will return the virtual function
18075
+ pointer value.
18076
+
18077
+ SBValue::GetLoadAddress() will return the address of the virtual function
18078
+ pointer.
18079
+
18080
+ SBValue::GetNumChildren() returns 0
18081
+ """
16043
18082
  return _lldb.SBValue_GetVTable(self)
16044
18083
 
16045
18084
  def __repr__(self):