Google Git
Sign in
android / platform / external / swig / 0ffab894f917fcbbd031eaab870fbabaefe5daaa / . / Lib / python / README
blob: fa8ef61e7d3e9f303a19fbdcf0c5cef1e31ff0f6 [file] [log] [blame]
William S Fulton79731712006-03-07 22:02:54 +0000[diff] [blame]1/* -----------------------------------------------------------------------------
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]2 *
3 * User interfaces: include these ones as needed
4 *
William S Fulton79731712006-03-07 22:02:54 +0000[diff] [blame]5 * ----------------------------------------------------------------------------- */
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]6
7/* -----------------------------------------------------------------------------
8 * Special types and user helpers
9 * ----------------------------------------------------------------------------- */
10
11argcargv.iHandler for (int argc, char **argv)
12attribute.iConvert a pair of set/get methods into a "native" python attribute
13ccomplex.i C99 complex type
14complex.i C99 or C++ complex type
15cstring.iVarious forms of C character string handling
16cwstring.iVarious forms of C wchar_t string handling
17embed.i embedding the Python interpreter in something else
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]18file.i FILE C type
19implicit.iAllow the use of implicit C++ constructors
20wchar.iwchar_t C type
21
22/* -----------------------------------------------------------------------------
23 * C++ STD + STL
24 * ----------------------------------------------------------------------------- */
25
26std_alloc.i allocator
27std_basic_string.i basic string
28std_char_traits.ichar traits
29std_complex.i complex
30std_deque.i deque
31std_except.i exceptions
32std_ios.i ios
33std_iostream.i istream/ostream
34std_list.i list
35std_map.i map
36std_multimap.i multimap
37std_multiset.i multiset
38std_pair.i pair
39std_set.iset
40std_sstream.istring stream
41std_streambuf.i streambuf
42std_string.istring
43std_vector.i vector
44std_wios.i wios
45std_wiostream.i wistream/wostream
46std_wsstream.i wstring stream
47std_wstreambuf.i wstreambuf
48std_wstring.i wstring
49
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]50
51
William S Fulton79731712006-03-07 22:02:54 +0000[diff] [blame]52/* -----------------------------------------------------------------------------
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]53/*
Olly Betts20954f92008-05-14 14:53:10 +0000[diff] [blame]54 * Implementation files: don't look at them unless you are really drunk
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]55 *
William S Fulton79731712006-03-07 22:02:54 +0000[diff] [blame]56 * ----------------------------------------------------------------------------- */
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]57
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]58/* -----------------------------------------------------------------------------
59 * Basic files
60 * ----------------------------------------------------------------------------- */
61
62python.swgMain language file, it just includes what is needed.
63pyuserdir.swgUser visible directives (%pythonnondynamic, etc)
64pymacros.swgInternal macros used for typemaps
65pyfragments.swgAllow the user to overload the default fragments
66pyopers.swgPython operations (+=, *=, etc)
67pythonkw.swgPython keywords and special names
68pyinit.swgPython Init method
69
70/* -----------------------------------------------------------------------------
71 * The runtime part
72 * ----------------------------------------------------------------------------- */
73
74pyruntime.swgMain runtime file definition
Olly Betts20954f92008-05-14 14:53:10 +0000[diff] [blame]75pyapi.swg SWIG/Python API declarations
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]76pyrun.swgPython run-time code
77
78/* -----------------------------------------------------------------------------
79 * Internal typemap specializations
80 * ----------------------------------------------------------------------------- */
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]81
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]82pyswigtype.swg SWIGTYPE
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]83pystrings.swgChar strings (char *)
84pywstrings.swgWchar Strings (wchar_t *)
85pyprimtypes.swgPrimitive types (shot,int,double,etc)
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]86pycomplex.swgPyComplex and helper for C/C++ complex types
87pydocs.swgTypemaps documentation
88
89/* -----------------------------------------------------------------------------
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]90 * C++ STD + STL
91 * ----------------------------------------------------------------------------- */
92
93pycontainer.swg python container iterators
Olly Betts20954f92008-05-14 14:53:10 +0000[diff] [blame]94std_common.i general common code for the STD/STL implementation
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]95std_container.i general common code for the STD/STL containers
96
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]97
Marcelo Matus7e5e4fd2005-10-18 13:24:15 +0000[diff] [blame]98/*-----------------------------------------------------------------------------
99 * Backward compatibility and deprecated
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]100 * ----------------------------------------------------------------------------- */
Marcelo Matus31a81482005-09-10 23:28:36 +0000[diff] [blame]101
Marcelo Matus7e5e4fd2005-10-18 13:24:15 +0000[diff] [blame]102std_vectora.i vector + allocator (allocators are now supported in STD/STL)
Olly Betts20954f92008-05-14 14:53:10 +0000[diff] [blame]103typemaps.i old in/out typemaps (doesn't need to be included)
Marcelo Matusdc4409a2004-10-10 06:42:15 +0000[diff] [blame]104defarg.swg for processing default arguments with shadow classes