scripts/lldb.swig

   1 /*
   2    lldb.swig
   3
   4    This is the input file for SWIG, to create the appropriate C++ wrappers and
   5    functions for various scripting languages, to enable them to call the
   6    liblldb Script Bridge functions.
   7 */
   8
   9 /* Define our module docstring. */
  10 %define DOCSTRING
  11 "The lldb module contains the public APIs for Python binding.
  12
  13 Some of the important classes are described here:
  14
  15 o SBTarget: Represents the target program running under the debugger.
  16 o SBProcess: Represents the process associated with the target program.
  17 o SBThread: Represents a thread of execution. SBProcess contains SBThread(s).
  18 o SBFrame: Represents one of the stack frames associated with a thread. SBThread
  19       contains SBFrame(s).
  20 o SBSymbolContext: A container that stores various debugger related info.
  21 o SBValue: Represents the value of a variable, a register, or an expression.
  22 o SBModule: Represents an executable image and its associated object and symbol
  23       files.  SBTarget contains SBModule(s).
  24 o SBBreakpoint: Represents a logical breakpoint and its associated settings.
  25       SBTarget contains SBBreakpoint(s).
  26 o SBSymbol: Represents the symbol possibly associated with a stack frame.
  27 o SBCompileUnit: Represents a compilation unit, or compiled source file.
  28 o SBFunction: Represents a generic function, which can be inlined or not.
  29 o SBBlock: Represents a lexical block. SBFunction contains SBBlock(s).
  30 o SBLineEntry: Specifies an association with a contiguous range of instructions
  31       and a source file location. SBCompileUnit contains SBLineEntry(s)."
  32 %enddef
  33
  34 // The name of the module to be created.
  35 %module(docstring=DOCSTRING) lldb
  36
  37 // Parameter types will be used in the autodoc string.
  38 %feature("autodoc", "1");
  39
  40 %pythoncode%{
  41 import uuid
  42 import re
  43 import os
  44
  45 import six
  46 %}
  47 %include "./Python/python-typemaps.swig"
  48
  49 /* C++ headers to be included. */
  50 %{
  51 #include <algorithm>
  52 #include <string>
  53 %}
  54
  55 /* The liblldb header files to be included. */
  56 %{
  57 #include "lldb/lldb-public.h"
  58 #include "lldb/API/SBAddress.h"
  59 #include "lldb/API/SBAttachInfo.h"
  60 #include "lldb/API/SBBlock.h"
  61 #include "lldb/API/SBBreakpoint.h"
  62 #include "lldb/API/SBBreakpointLocation.h"
  63 #include "lldb/API/SBBroadcaster.h"
  64 #include "lldb/API/SBCommandInterpreter.h"
  65 #include "lldb/API/SBCommandReturnObject.h"
  66 #include "lldb/API/SBCommunication.h"
  67 #include "lldb/API/SBCompileUnit.h"
  68 #include "lldb/API/SBData.h"
  69 #include "lldb/API/SBDebugger.h"
  70 #include "lldb/API/SBDeclaration.h"
  71 #include "lldb/API/SBError.h"
  72 #include "lldb/API/SBEvent.h"
  73 #include "lldb/API/SBExecutionContext.h"
  74 #include "lldb/API/SBExpressionOptions.h"
  75 #include "lldb/API/SBFileSpec.h"
  76 #include "lldb/API/SBFileSpecList.h"
  77 #include "lldb/API/SBFrame.h"
  78 #include "lldb/API/SBFunction.h"
  79 #include "lldb/API/SBHostOS.h"
  80 #include "lldb/API/SBInstruction.h"
  81 #include "lldb/API/SBInstructionList.h"
  82 #include "lldb/API/SBLanguageRuntime.h"
  83 #include "lldb/API/SBLaunchInfo.h"
  84 #include "lldb/API/SBLineEntry.h"
  85 #include "lldb/API/SBListener.h"
  86 #include "lldb/API/SBMemoryRegionInfo.h"
  87 #include "lldb/API/SBMemoryRegionInfoList.h"
  88 #include "lldb/API/SBModule.h"
  89 #include "lldb/API/SBModuleSpec.h"
  90 #include "lldb/API/SBPlatform.h"
  91 #include "lldb/API/SBProcess.h"
  92 #include "lldb/API/SBQueue.h"
  93 #include "lldb/API/SBQueueItem.h"
  94 #include "lldb/API/SBSection.h"
  95 #include "lldb/API/SBSourceManager.h"
  96 #include "lldb/API/SBStream.h"
  97 #include "lldb/API/SBStringList.h"
  98 #include "lldb/API/SBStructuredData.h"
  99 #include "lldb/API/SBSymbol.h"
 100 #include "lldb/API/SBSymbolContext.h"
 101 #include "lldb/API/SBSymbolContextList.h"
 102 #include "lldb/API/SBTarget.h"
 103 #include "lldb/API/SBThread.h"
 104 #include "lldb/API/SBThreadCollection.h"
 105 #include "lldb/API/SBThreadPlan.h"
 106 #include "lldb/API/SBType.h"
 107 #include "lldb/API/SBTypeCategory.h"
 108 #include "lldb/API/SBTypeEnumMember.h"
 109 #include "lldb/API/SBTypeFilter.h"
 110 #include "lldb/API/SBTypeFormat.h"
 111 #include "lldb/API/SBTypeNameSpecifier.h"
 112 #include "lldb/API/SBTypeSummary.h"
 113 #include "lldb/API/SBTypeSynthetic.h"
 114 #include "lldb/API/SBValue.h"
 115 #include "lldb/API/SBValueList.h"
 116 #include "lldb/API/SBVariablesOptions.h"
 117 #include "lldb/API/SBWatchpoint.h"
 118 #include "lldb/API/SBUnixSignals.h"
 119
 120 #include "../source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h"
 121
 122 #include "../scripts/Python/python-swigsafecast.swig"
 123 %}
 124
 125 /* Various liblldb typedefs that SWIG needs to know about.  */
 126 #define __extension__ /* Undefine GCC keyword to make Swig happy when processing glibc's stdint.h. */
 127 /* The ISO C99 standard specifies that in C++ implementations limit macros such
 128    as INT32_MAX should only be defined if __STDC_LIMIT_MACROS is. */
 129 #define __STDC_LIMIT_MACROS
 130 %include "stdint.i"
 131
 132 %include "lldb/lldb-defines.h"
 133 %include "lldb/lldb-enumerations.h"
 134 %include "lldb/lldb-forward.h"
 135 %include "lldb/lldb-types.h"
 136
 137 /* Forward declaration of SB classes. */
 138 %include "lldb/API/SBDefines.h"
 139
 140 /* Python interface files with docstrings. */
 141 %include "./interface/SBAddress.i"
 142 %include "./interface/SBAttachInfo.i"
 143 %include "./interface/SBBlock.i"
 144 %include "./interface/SBBreakpoint.i"
 145 %include "./interface/SBBreakpointLocation.i"
 146 %include "./interface/SBBroadcaster.i"
 147 %include "./interface/SBCommandInterpreter.i"
 148 %include "./interface/SBCommandReturnObject.i"
 149 %include "./interface/SBCommunication.i"
 150 %include "./interface/SBCompileUnit.i"
 151 %include "./interface/SBData.i"
 152 %include "./interface/SBDebugger.i"
 153 %include "./interface/SBDeclaration.i"
 154 %include "./interface/SBError.i"
 155 %include "./interface/SBEvent.i"
 156 %include "./interface/SBExecutionContext.i"
 157 %include "./interface/SBExpressionOptions.i"
 158 %include "./interface/SBFileSpec.i"
 159 %include "./interface/SBFileSpecList.i"
 160 %include "./interface/SBFrame.i"
 161 %include "./interface/SBFunction.i"
 162 %include "./interface/SBHostOS.i"
 163 %include "./interface/SBInstruction.i"
 164 %include "./interface/SBInstructionList.i"
 165 %include "./interface/SBLanguageRuntime.i"
 166 %include "./interface/SBLaunchInfo.i"
 167 %include "./interface/SBLineEntry.i"
 168 %include "./interface/SBListener.i"
 169 %include "./interface/SBMemoryRegionInfo.i"
 170 %include "./interface/SBMemoryRegionInfoList.i"
 171 %include "./interface/SBModule.i"
 172 %include "./interface/SBModuleSpec.i"
 173 %include "./interface/SBPlatform.i"
 174 %include "./interface/SBProcess.i"
 175 %include "./interface/SBQueue.i"
 176 %include "./interface/SBQueueItem.i"
 177 %include "./interface/SBSection.i"
 178 %include "./interface/SBSourceManager.i"
 179 %include "./interface/SBStream.i"
 180 %include "./interface/SBStringList.i"
 181 %include "./interface/SBStructuredData.i"
 182 %include "./interface/SBSymbol.i"
 183 %include "./interface/SBSymbolContext.i"
 184 %include "./interface/SBSymbolContextList.i"
 185 %include "./interface/SBTarget.i"
 186 %include "./interface/SBThread.i"
 187 %include "./interface/SBThreadCollection.i"
 188 %include "./interface/SBThreadPlan.i"
 189 %include "./interface/SBType.i"
 190 %include "./interface/SBTypeCategory.i"
 191 %include "./interface/SBTypeEnumMember.i"
 192 %include "./interface/SBTypeFilter.i"
 193 %include "./interface/SBTypeFormat.i"
 194 %include "./interface/SBTypeNameSpecifier.i"
 195 %include "./interface/SBTypeSummary.i"
 196 %include "./interface/SBTypeSynthetic.i"
 197 %include "./interface/SBValue.i"
 198 %include "./interface/SBValueList.i"
 199 %include "./interface/SBVariablesOptions.i"
 200 %include "./interface/SBWatchpoint.i"
 201 %include "./interface/SBUnixSignals.i"
 202
 203 %include "./Python/python-extensions.swig"
 204
 205 %include "./Python/python-wrapper.swig"