lldb.swig revision b302dffacdadeef509d28133a4c66299418122f8 
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
13Some 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
23      files.  SBTarget conatins SBModule(s).
24o SBBreakpoint: Represents a logical breakpoint and its associated settings.
25      SBTarget conatins SBBreakpoint(s).
26o SBSymbol: Represents the symbol possibly associated with a stack frame.
27o 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
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%{
41import uuid
42import re
43import os
44%}
45%include "./Python/python-typemaps.swig"
46
47/* The liblldb header files to be included. */
48%{
49#include "lldb/lldb-public.h"
50#include "lldb/API/SBAddress.h"
51#include "lldb/API/SBBlock.h"
52#include "lldb/API/SBBreakpoint.h"
53#include "lldb/API/SBBreakpointLocation.h"
54#include "lldb/API/SBBroadcaster.h"
55#include "lldb/API/SBCommandInterpreter.h"
56#include "lldb/API/SBCommandReturnObject.h"
57#include "lldb/API/SBCommunication.h"
58#include "lldb/API/SBCompileUnit.h"
59#include "lldb/API/SBData.h"
60#include "lldb/API/SBDebugger.h"
61#include "lldb/API/SBError.h"
62#include "lldb/API/SBEvent.h"
63#include "lldb/API/SBFileSpec.h"
64#include "lldb/API/SBFileSpecList.h"
65#include "lldb/API/SBFrame.h"
66#include "lldb/API/SBFunction.h"
67#include "lldb/API/SBHostOS.h"
68#include "lldb/API/SBInputReader.h"
69#include "lldb/API/SBInstruction.h"
70#include "lldb/API/SBInstructionList.h"
71#include "lldb/API/SBLineEntry.h"
72#include "lldb/API/SBListener.h"
73#include "lldb/API/SBModule.h"
74#include "lldb/API/SBProcess.h"
75#include "lldb/API/SBSection.h"
76#include "lldb/API/SBSourceManager.h"
77#include "lldb/API/SBStream.h"
78#include "lldb/API/SBStringList.h"
79#include "lldb/API/SBSymbol.h"
80#include "lldb/API/SBSymbolContext.h"
81#include "lldb/API/SBSymbolContextList.h"
82#include "lldb/API/SBTarget.h"
83#include "lldb/API/SBThread.h"
84#include "lldb/API/SBType.h"
85#include "lldb/API/SBValue.h"
86#include "lldb/API/SBValueList.h"
87#include "lldb/API/SBWatchpoint.h"
88%}
89
90/* Various liblldb typedefs that SWIG needs to know about.  */
91#define __extension__ /* Undefine GCC keyword to make Swig happy when processing glibc's stdint.h. */
92%include <stdint.h>
93%include "lldb/lldb-defines.h"
94%include "lldb/lldb-enumerations.h"
95%include "lldb/lldb-forward.h"
96%include "lldb/lldb-types.h"
97
98/* Forward declaration of SB classes. */
99%include "lldb/API/SBDefines.h"
100
101/* Python interface files with docstrings. */
102%include "./Python/interface/SBAddress.i"
103%include "./Python/interface/SBBlock.i"
104%include "./Python/interface/SBBreakpoint.i"
105%include "./Python/interface/SBBreakpointLocation.i"
106%include "./Python/interface/SBBroadcaster.i"
107%include "./Python/interface/SBCommandInterpreter.i"
108%include "./Python/interface/SBCommandReturnObject.i"
109%include "./Python/interface/SBCommunication.i"
110%include "./Python/interface/SBCompileUnit.i"
111%include "./Python/interface/SBData.i"
112%include "./Python/interface/SBDebugger.i"
113%include "./Python/interface/SBError.i"
114%include "./Python/interface/SBEvent.i"
115%include "./Python/interface/SBFileSpec.i"
116%include "./Python/interface/SBFileSpecList.i"
117%include "./Python/interface/SBFrame.i"
118%include "./Python/interface/SBFunction.i"
119%include "./Python/interface/SBHostOS.i"
120%include "./Python/interface/SBInputReader.i"
121%include "./Python/interface/SBInstruction.i"
122%include "./Python/interface/SBInstructionList.i"
123%include "./Python/interface/SBLineEntry.i"
124%include "./Python/interface/SBListener.i"
125%include "./Python/interface/SBModule.i"
126%include "./Python/interface/SBProcess.i"
127%include "./Python/interface/SBSection.i"
128%include "./Python/interface/SBSourceManager.i"
129%include "./Python/interface/SBStream.i"
130%include "./Python/interface/SBStringList.i"
131%include "./Python/interface/SBSymbol.i"
132%include "./Python/interface/SBSymbolContext.i"
133%include "./Python/interface/SBSymbolContextList.i"
134%include "./Python/interface/SBTarget.i"
135%include "./Python/interface/SBThread.i"
136%include "./Python/interface/SBType.i"
137%include "./Python/interface/SBValue.i"
138%include "./Python/interface/SBValueList.i"
139%include "./Python/interface/SBWatchpoint.i"
140
141%include "./Python/python-extensions.swig"
142
143%include "./Python/python-wrapper.swig"
144