2 # GObject-Introspection - a framework for introspecting GObject libraries
3 # Copyright (C) 2008 Colin Walters
4 # Copyright (C) 2008 Johan Dahlin
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2 of the License, or (at your option) any later version.
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the
18 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 # Boston, MA 02111-1307, USA.
26 from .glibtransformer import IntrospectionBinary
28 # bugzilla.gnome.org/558436
29 # Compile a binary program which is then linked to a library
30 # we want to introspect, in order to call its get_type functions.
32 _PROGRAM_TEMPLATE = '''/* This file is generated, do not edit */
34 #include <girepository.h>
37 static GOptionEntry entries[] =
43 main(int argc, char **argv)
45 GOptionContext *context;
51 context = g_option_context_new ("");
52 g_option_context_add_main_entries (context, entries, "girepository-1.0");
53 g_option_context_add_group (context, g_irepository_get_option_group ());
54 if (!g_option_context_parse (context, &argc, &argv, &error))
56 g_printerr ("introspect failed (%d,%d): %s\\n",
57 error->domain, error->code,
66 class CompilerError(Exception):
70 class LinkerError(Exception):
74 class DumpCompiler(object):
76 def __init__(self, options, get_type_functions):
77 self._options = options
78 self._get_type_functions = get_type_functions
79 self._tmpdir = tempfile.mkdtemp('', 'tmp-introspect')
81 self._compiler_cmd = os.environ.get('CC', 'gcc')
82 self._linker_cmd = os.environ.get('LD', self._compiler_cmd)
83 self._pkgconfig_cmd = os.environ.get('PKG_CONFIG', 'pkg-config')
85 self._uninst_srcdir = os.environ.get(
86 'UNINSTALLED_INTROSPECTION_SRCDIR')
87 self._packages = ['gio-2.0 gthread-2.0']
88 if not self._uninst_srcdir:
89 self._packages.append('gobject-introspection-1.0')
94 print ' GEN ' + self._options.output
95 c_path = self._generate_tempfile('.c')
97 f.write(_PROGRAM_TEMPLATE)
99 # We need to reference our get_type functions to make sure they are
100 # pulled in at the linking stage if the library is a static library
101 # rather than a shared library.
102 if len(self._get_type_functions) > 0:
103 for func in self._get_type_functions:
104 f.write("extern GType " + func + "(void);\n")
105 f.write("GType (*GI_GET_TYPE_FUNCS_[])(void) = {\n")
107 for func in self._get_type_functions:
116 o_path = self._generate_tempfile('.o')
117 bin_path = self._generate_tempfile()
120 self._compile(o_path, c_path)
121 except CompilerError, e:
122 raise SystemExit('ERROR: ' + str(e))
125 self._link(bin_path, o_path)
126 except LinkerError, e:
127 raise SystemExit('ERROR: ' + str(e))
131 return IntrospectionBinary([bin_path], self._tmpdir)
135 def _generate_tempfile(self, suffix=''):
136 tmpl = '%s-%s%s' % (self._options.namespace_name,
137 self._options.namespace_version, suffix)
138 return os.path.join(self._tmpdir, tmpl)
140 def _run_pkgconfig(self, flag):
141 proc = subprocess.Popen(
142 [self._pkgconfig_cmd, flag] + self._packages,
143 stdout=subprocess.PIPE)
144 return proc.communicate()[0].split()
146 def _use_libtool_infection(self):
147 libtool_infection = not self._options.nolibtool
148 if not libtool_infection:
151 libtool_path = self._options.libtool_path
153 # Automake by default sets:
154 # LIBTOOL = $(SHELL) $(top_builddir)/libtool
155 # To be strictly correct we would have to parse shell. For now
157 return libtool_path.split(' ')
160 subprocess.check_call(['libtool', '--version'])
161 except subprocess.CalledProcessError, e:
162 # If libtool's not installed, assume we don't need it
167 def _compile(self, output, *sources):
168 # Not strictly speaking correct, but easier than parsing shell
169 args = self._compiler_cmd.split()
170 if self._compiler_cmd == 'gcc':
172 pkgconfig_flags = self._run_pkgconfig('--cflags')
173 if self._uninst_srcdir:
174 args.append('-I' + os.path.join(self._uninst_srcdir,
176 args.extend(pkgconfig_flags)
177 for include in self._options.cpp_includes:
178 args.append('-I' + include)
179 args.extend(['-c', '-o', output])
180 for source in sources:
181 if not os.path.exists(source):
183 "Could not find c source file: %s" % (source, ))
184 args.extend(list(sources))
185 subprocess.check_call(args)
187 def _link(self, output, *sources):
189 libtool = self._use_libtool_infection()
192 args.append('--mode=link')
193 args.append('--tag=CC')
194 args.append('--silent')
196 args.extend([self._linker_cmd, '-o', output])
198 # Make sure to list the library to be introspected first since it's
199 # likely to be uninstalled yet and we want the uninstalled RPATHs have
200 # priority (or we might run with installed library that is older)
202 # Search the current directory first
205 uninst_builddir = os.environ.get('UNINSTALLED_INTROSPECTION_BUILDDIR')
206 # hack for building GIRepository.gir, skip -lgirepository-1.0 since
207 # libgirepository-1.0.la is not in current directory and we refer to it
208 # explicitly below anyway
209 if (not uninst_builddir or
210 self._options.libraries[0] != 'girepository-1.0'):
211 # We only use the first library; assume others are "custom"
212 # libraries like from gir-repository. Right now those don't define
213 # new GTypes, so we don't need to introspect them.
214 args.append('-l' + self._options.libraries[0])
216 # hack for building gobject-introspection itself
218 path = os.path.join(uninst_builddir, 'girepository',
219 'libgirepository-1.0.la')
222 args.extend(self._run_pkgconfig('--libs'))
223 for source in sources:
224 if not os.path.exists(source):
226 "Could not find object file: %s" % (source, ))
227 args.extend(list(sources))
229 subprocess.check_call(args)
232 def compile_introspection_binary(options, get_type_functions):
233 dc = DumpCompiler(options, get_type_functions)