blob: 6be699f42c1726e77d8baf6719fdc58289a4cee6 [file] [log] [blame]
Chris Lattner24943d22010-06-08 16:52:24 +00001/*
2 lldb.swig
3
Chris Lattner24943d22010-06-08 16:52:24 +00004 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.
Chris Lattner24943d22010-06-08 16:52:24 +00007*/
8
Johnny Chenb6613ea2011-06-30 21:29:50 +00009/* Define our module docstring. */
10%define DOCSTRING
11"The lldb module contains the public APIs for Python binding.
Chris Lattner24943d22010-06-08 16:52:24 +000012
Johnny Chenb6613ea2011-06-30 21:29:50 +000013Some of the important classes are describe here:
14
15o SBTarget: Represents the target program running under the debugger.
16o SBProcess: Represents the process associated with the target program.
17o SBThread: Represents a thread of execution. SBProcess contains SBThread(s).
18o SBFrame: Represents one of the stack frames associated with a thread. SBThread
19 contains SBFrame(s).
20o SBSymbolContext: A container that stores various debugger related info.
21o SBValue: Represents the value of a variable, a register, or an expression.
22o SBModule: Represents an executable image and its associated object and symbol
Johnny Chen59efa132011-07-14 21:32:11 +000023 files. SBTarget conatins SBModule(s).
24o SBBreakpoint: Represents a logical breakpoint and its associated settings.
25 SBTarget conatins SBBreakpoint(s).
Johnny Chen61858992011-07-14 21:23:24 +000026o SBSymbol: Represents the symbol possibly associated with a stack frame.
Johnny Chenb6613ea2011-06-30 21:29:50 +000027o SBCompileUnit: Represents a compilation unit, or compiled source file.
28o SBFunction: Represents a generic function, which can be inlined or not.
29o SBBlock: Represents a lexical block. SBFunction contains SBBlock(s).
30o SBLineEntry: Specifies an association with a contiguous range of instructions
Johnny Chena0d0a7c2011-07-01 18:39:47 +000031 and a source file location. SBCompileUnit contains SBLineEntry(s)."
Johnny Chenb6613ea2011-06-30 21:29:50 +000032%enddef
33
Johnny Chen87176872011-07-16 21:27:36 +000034// The name of the module to be created.
Johnny Chenb6613ea2011-06-30 21:29:50 +000035%module(docstring=DOCSTRING) lldb
36
Johnny Chen87176872011-07-16 21:27:36 +000037// Parameter types will be used in the autodoc string.
38%feature("autodoc", "1");
Chris Lattner24943d22010-06-08 16:52:24 +000039
Greg Claytonb302dff2012-02-01 08:09:32 +000040%pythoncode%{
41import uuid
42import re
43import os
44%}
Johnny Chenf307cf72011-07-26 19:09:03 +000045%include "./Python/python-typemaps.swig"
Greg Clayton0d62dfd2011-01-14 04:54:56 +000046
Sean Callanan4761ca32012-08-09 00:53:54 +000047/* C++ headers to be included. */
48%{
49#include <string>
50%}
51
Greg Clayton461a4372010-06-12 15:34:20 +000052/* The liblldb header files to be included. */
Chris Lattner24943d22010-06-08 16:52:24 +000053%{
Greg Claytonb3448432011-03-24 21:19:54 +000054#include "lldb/lldb-public.h"
Chris Lattner24943d22010-06-08 16:52:24 +000055#include "lldb/API/SBAddress.h"
56#include "lldb/API/SBBlock.h"
57#include "lldb/API/SBBreakpoint.h"
58#include "lldb/API/SBBreakpointLocation.h"
59#include "lldb/API/SBBroadcaster.h"
Chris Lattner24943d22010-06-08 16:52:24 +000060#include "lldb/API/SBCommandInterpreter.h"
61#include "lldb/API/SBCommandReturnObject.h"
Greg Claytond8c62532010-10-07 04:19:01 +000062#include "lldb/API/SBCommunication.h"
Chris Lattner24943d22010-06-08 16:52:24 +000063#include "lldb/API/SBCompileUnit.h"
Enrico Granata91544802011-09-06 19:20:51 +000064#include "lldb/API/SBData.h"
Chris Lattner24943d22010-06-08 16:52:24 +000065#include "lldb/API/SBDebugger.h"
Enrico Granata49306142012-10-10 22:54:17 +000066#include "lldb/API/SBDeclaration.h"
Chris Lattner24943d22010-06-08 16:52:24 +000067#include "lldb/API/SBError.h"
68#include "lldb/API/SBEvent.h"
Jim Ingham47beabb2012-10-16 21:41:58 +000069#include "lldb/API/SBExpressionOptions.h"
Johnny Chen4ead2e92010-08-27 22:35:26 +000070#include "lldb/API/SBFileSpec.h"
Jim Ingham03c8ee52011-09-21 01:17:13 +000071#include "lldb/API/SBFileSpecList.h"
Chris Lattner24943d22010-06-08 16:52:24 +000072#include "lldb/API/SBFrame.h"
73#include "lldb/API/SBFunction.h"
Greg Claytond8c62532010-10-07 04:19:01 +000074#include "lldb/API/SBHostOS.h"
75#include "lldb/API/SBInputReader.h"
Greg Clayton5c4c7462010-10-06 03:09:58 +000076#include "lldb/API/SBInstruction.h"
77#include "lldb/API/SBInstructionList.h"
Chris Lattner24943d22010-06-08 16:52:24 +000078#include "lldb/API/SBLineEntry.h"
79#include "lldb/API/SBListener.h"
80#include "lldb/API/SBModule.h"
Greg Claytonf9215ba2013-07-08 22:22:41 +000081#include "lldb/API/SBModuleSpec.h"
Chris Lattner24943d22010-06-08 16:52:24 +000082#include "lldb/API/SBProcess.h"
Greg Clayton3e8c25f2011-09-24 00:52:29 +000083#include "lldb/API/SBSection.h"
Chris Lattner24943d22010-06-08 16:52:24 +000084#include "lldb/API/SBSourceManager.h"
Caroline Tice98f930f2010-09-20 05:20:02 +000085#include "lldb/API/SBStream.h"
Chris Lattner24943d22010-06-08 16:52:24 +000086#include "lldb/API/SBStringList.h"
87#include "lldb/API/SBSymbol.h"
88#include "lldb/API/SBSymbolContext.h"
Greg Claytond8c62532010-10-07 04:19:01 +000089#include "lldb/API/SBSymbolContextList.h"
Chris Lattner24943d22010-06-08 16:52:24 +000090#include "lldb/API/SBTarget.h"
91#include "lldb/API/SBThread.h"
92#include "lldb/API/SBType.h"
Enrico Granata16376ed2012-02-15 02:34:21 +000093#include "lldb/API/SBTypeCategory.h"
94#include "lldb/API/SBTypeFilter.h"
95#include "lldb/API/SBTypeFormat.h"
96#include "lldb/API/SBTypeNameSpecifier.h"
97#include "lldb/API/SBTypeSummary.h"
98#include "lldb/API/SBTypeSynthetic.h"
Chris Lattner24943d22010-06-08 16:52:24 +000099#include "lldb/API/SBValue.h"
Caroline Tice1ca48b02010-09-22 16:41:52 +0000100#include "lldb/API/SBValueList.h"
Greg Clayton1fa6b3d2011-10-13 18:08:26 +0000101#include "lldb/API/SBWatchpoint.h"
Enrico Granatad91dc812013-06-21 18:57:30 +0000102
103#include "../scripts/Python/python-swigsafecast.swig"
104
Chris Lattner24943d22010-06-08 16:52:24 +0000105%}
106
107/* Various liblldb typedefs that SWIG needs to know about. */
Johnny Chenc1955f22010-12-16 00:01:06 +0000108#define __extension__ /* Undefine GCC keyword to make Swig happy when processing glibc's stdint.h. */
Filipe Cabecinhas56de6d12012-09-19 15:22:05 +0000109%include "stdint.i"
Greg Claytond8c62532010-10-07 04:19:01 +0000110%include "lldb/lldb-defines.h"
111%include "lldb/lldb-enumerations.h"
112%include "lldb/lldb-forward.h"
Greg Claytond8c62532010-10-07 04:19:01 +0000113%include "lldb/lldb-types.h"
Johnny Chen6d91e0a2011-07-19 01:07:06 +0000114
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000115/* Forward declaration of SB classes. */
Johnny Chen335b3ee2011-07-19 21:49:34 +0000116%include "lldb/API/SBDefines.h"
Johnny Chen335b3ee2011-07-19 21:49:34 +0000117
118/* Python interface files with docstrings. */
119%include "./Python/interface/SBAddress.i"
120%include "./Python/interface/SBBlock.i"
121%include "./Python/interface/SBBreakpoint.i"
122%include "./Python/interface/SBBreakpointLocation.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000123%include "./Python/interface/SBBroadcaster.i"
124%include "./Python/interface/SBCommandInterpreter.i"
125%include "./Python/interface/SBCommandReturnObject.i"
126%include "./Python/interface/SBCommunication.i"
Johnny Chen335b3ee2011-07-19 21:49:34 +0000127%include "./Python/interface/SBCompileUnit.i"
Enrico Granata91544802011-09-06 19:20:51 +0000128%include "./Python/interface/SBData.i"
Johnny Chen335b3ee2011-07-19 21:49:34 +0000129%include "./Python/interface/SBDebugger.i"
Enrico Granata49306142012-10-10 22:54:17 +0000130%include "./Python/interface/SBDeclaration.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000131%include "./Python/interface/SBError.i"
Johnny Chen335b3ee2011-07-19 21:49:34 +0000132%include "./Python/interface/SBEvent.i"
Jim Ingham47beabb2012-10-16 21:41:58 +0000133%include "./Python/interface/SBExpressionOptions.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000134%include "./Python/interface/SBFileSpec.i"
Jim Ingham03c8ee52011-09-21 01:17:13 +0000135%include "./Python/interface/SBFileSpecList.i"
Johnny Chen335b3ee2011-07-19 21:49:34 +0000136%include "./Python/interface/SBFrame.i"
137%include "./Python/interface/SBFunction.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000138%include "./Python/interface/SBHostOS.i"
139%include "./Python/interface/SBInputReader.i"
140%include "./Python/interface/SBInstruction.i"
141%include "./Python/interface/SBInstructionList.i"
Johnny Chenfb35e2a2011-07-18 23:11:07 +0000142%include "./Python/interface/SBLineEntry.i"
143%include "./Python/interface/SBListener.i"
144%include "./Python/interface/SBModule.i"
Greg Claytonf9215ba2013-07-08 22:22:41 +0000145%include "./Python/interface/SBModuleSpec.i"
Johnny Chenc3fba812011-07-18 20:13:38 +0000146%include "./Python/interface/SBProcess.i"
Greg Clayton3e8c25f2011-09-24 00:52:29 +0000147%include "./Python/interface/SBSection.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000148%include "./Python/interface/SBSourceManager.i"
149%include "./Python/interface/SBStream.i"
150%include "./Python/interface/SBStringList.i"
Johnny Chen6d91e0a2011-07-19 01:07:06 +0000151%include "./Python/interface/SBSymbol.i"
152%include "./Python/interface/SBSymbolContext.i"
153%include "./Python/interface/SBSymbolContextList.i"
Johnny Chenebd63b22011-07-16 21:15:39 +0000154%include "./Python/interface/SBTarget.i"
Johnny Chenc3fba812011-07-18 20:13:38 +0000155%include "./Python/interface/SBThread.i"
Johnny Chen5cb6cab2011-07-19 22:41:47 +0000156%include "./Python/interface/SBType.i"
Enrico Granata16376ed2012-02-15 02:34:21 +0000157%include "./Python/interface/SBTypeCategory.i"
158%include "./Python/interface/SBTypeFilter.i"
159%include "./Python/interface/SBTypeFormat.i"
160%include "./Python/interface/SBTypeNameSpecifier.i"
161%include "./Python/interface/SBTypeSummary.i"
162%include "./Python/interface/SBTypeSynthetic.i"
Johnny Chen854a1ba2011-07-18 19:08:30 +0000163%include "./Python/interface/SBValue.i"
164%include "./Python/interface/SBValueList.i"
Greg Clayton1fa6b3d2011-10-13 18:08:26 +0000165%include "./Python/interface/SBWatchpoint.i"
Chris Lattner24943d22010-06-08 16:52:24 +0000166
Caroline Ticee49ec182010-09-22 23:01:29 +0000167%include "./Python/python-extensions.swig"
Caroline Tice59c5d5d2010-09-27 18:00:20 +0000168
Johnny Chenf307cf72011-07-26 19:09:03 +0000169%include "./Python/python-wrapper.swig"