giscanner/scannermain.py

   1 #!/usr/bin/env python
   2 # -*- Mode: Python -*-
   3 # GObject-Introspection - a framework for introspecting GObject libraries
   4 # Copyright (C) 2008-2010 Johan Dahlin
   5 # Copyright (C) 2009 Red Hat, Inc.
   6 #
   7 # This program is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License
   9 # as published by the Free Software Foundation; either version 2
  10 # of the License, or (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20 # 02110-1301, USA.
  21 #
  22
  23 import errno
  24 import optparse
  25 import os
  26 import shutil
  27 import subprocess
  28 import sys
  29 import tempfile
  30
  31 from giscanner import message
  32 from giscanner.annotationparser import AnnotationParser
  33 from giscanner.ast import Include, Namespace
  34 from giscanner.dumper import compile_introspection_binary
  35 from giscanner.gdumpparser import GDumpParser, IntrospectionBinary
  36 from giscanner.introspectablepass import IntrospectablePass
  37 from giscanner.girparser import GIRParser
  38 from giscanner.girwriter import GIRWriter
  39 from giscanner.maintransformer import MainTransformer
  40 from giscanner.shlibs import resolve_shlibs
  41 from giscanner.sourcescanner import SourceScanner
  42 from giscanner.transformer import Transformer
  43 from . import utils
  44
  45 def get_preprocessor_option_group(parser):
  46     group = optparse.OptionGroup(parser, "Preprocessor options")
  47     group.add_option("-I", help="Pre-processor include file",
  48                      action="append", dest="cpp_includes",
  49                      default=[])
  50     group.add_option("-D", help="Pre-processor define",
  51                      action="append", dest="cpp_defines",
  52                      default=[])
  53     group.add_option("-U", help="Pre-processor undefine",
  54                      action="append", dest="cpp_undefines",
  55                      default=[])
  56     group.add_option("-p", dest="", help="Ignored")
  57     return group
  58
  59 def _get_option_parser():
  60     parser = optparse.OptionParser('%prog [options] sources')
  61     parser.add_option('', "--quiet",
  62                       action="store_true", dest="quiet",
  63                       default=False,
  64                       help="If passed, do not print details of normal" \
  65                           + " operation")
  66     parser.add_option("", "--format",
  67                       action="store", dest="format",
  68                       default="gir",
  69                       help="format to use, one of gidl, gir")
  70     parser.add_option("-i", "--include",
  71                       action="append", dest="includes", default=[],
  72                       help="Add specified gir file as dependency")
  73     parser.add_option("", "--include-uninstalled",
  74                       action="append", dest="includes_uninstalled", default=[],
  75                       help=("""A file path to a dependency; only use this "
  76                             "when building multiple .gir files inside a "
  77                             "single module."""))
  78     parser.add_option("", "--add-include-path",
  79                       action="append", dest="include_paths", default=[],
  80                       help="include paths for other GIR files")
  81     parser.add_option("", "--program",
  82                       action="store", dest="program", default=None,
  83                       help="program to execute")
  84     parser.add_option("", "--program-arg",
  85                       action="append", dest="program_args", default=[],
  86                       help="extra arguments to program")
  87     parser.add_option("", "--libtool",
  88                       action="store", dest="libtool_path", default=None,
  89                       help="full path to libtool")
  90     parser.add_option("", "--no-libtool",
  91                       action="store_true", dest="nolibtool", default=False,
  92                       help="do not use libtool")
  93     parser.add_option("", "--external-library",
  94                       action="store_true", dest="external_library", default=False,
  95                       help=("""If true, the library is located on the system,""" +
  96                             """not in the current directory"""))
  97     parser.add_option("-l", "--library",
  98                       action="append", dest="libraries", default=[],
  99                       help="libraries of this unit")
 100     parser.add_option("-L", "--library-path",
 101                       action="append", dest="library_paths", default=[],
 102                       help="directories to search for libraries")
 103     parser.add_option("-n", "--namespace",
 104                       action="store", dest="namespace_name",
 105                       help=("name of namespace for this unit, also "
 106                             "used to compute --identifier-prefix and --symbol-prefix"))
 107     parser.add_option("", "--nsversion",
 108                       action="store", dest="namespace_version",
 109                       help="version of namespace for this unit")
 110     parser.add_option("", "--strip-prefix",
 111                       action="store", dest="strip_prefix",
 112                       help="""Option --strip-prefix is deprecated, please see --identifier-prefix
 113 and --symbol-prefix.""")
 114     parser.add_option("", "--identifier-prefix",
 115                       action="append", dest="identifier_prefixes", default=[],
 116                       help="""Remove this prefix from C identifiers (structure typedefs, etc.).
 117 May be specified multiple times.  This is also used as the default for --symbol-prefix if
 118 the latter is not specified.""")
 119     parser.add_option("", "--symbol-prefix",
 120                       action="append", dest="symbol_prefixes", default=[],
 121                       help="Remove this prefix from C symbols (function names)")
 122     parser.add_option("", "--accept-unprefixed",
 123                       action="store_true", dest="accept_unprefixed", default=False,
 124                       help="""If specified, accept symbols and identifiers that do not
 125 match the namespace prefix.""")
 126     parser.add_option("", "--add-init-section",
 127                       action="append", dest="init_sections", default=[],
 128             help="add extra initialization code in the introspection program")
 129     parser.add_option("-o", "--output",
 130                       action="store", dest="output", default="-",
 131                       help="output filename to write to, defaults to - (stdout)")
 132     parser.add_option("", "--pkg",
 133                       action="append", dest="packages", default=[],
 134                       help="pkg-config packages to get cflags from")
 135     parser.add_option("", "--pkg-export",
 136                       action="append", dest="packages_export", default=[],
 137                       help="Associated pkg-config packages for this library")
 138     parser.add_option('', "--warn-all",
 139                       action="store_true", dest="warn_all", default=False,
 140                       help="If true, enable all warnings for introspection")
 141     parser.add_option('', "--warn-error",
 142                       action="store_true", dest="warn_fatal",
 143                       help="Turn warnings into fatal errors")
 144     parser.add_option("-v", "--verbose",
 145                       action="store_true", dest="verbose",
 146                       help="be verbose")
 147     parser.add_option("", "--c-include",
 148                       action="append", dest="c_includes", default=[],
 149                       help="headers which should be included in C programs")
 150
 151     group = get_preprocessor_option_group(parser)
 152     parser.add_option_group(group)
 153
 154     # Private options
 155     parser.add_option('', "--generate-typelib-tests",
 156                       action="store", dest="test_codegen", default=None,
 157                       help=optparse.SUPPRESS_HELP)
 158     parser.add_option('', "--passthrough-gir",
 159                       action="store", dest="passthrough_gir", default=None,
 160                       help=optparse.SUPPRESS_HELP)
 161     parser.add_option('', "--reparse-validate",
 162                       action="store_true", dest="reparse_validate_gir", default=False,
 163                       help=optparse.SUPPRESS_HELP)
 164     parser.add_option("", "--typelib-xml",
 165                       action="store_true", dest="typelib_xml",
 166                       help=optparse.SUPPRESS_HELP)
 167
 168     return parser
 169
 170
 171 def _error(msg):
 172     raise SystemExit('ERROR: %s' % (msg, ))
 173
 174 def passthrough_gir(path, f):
 175     parser = GIRParser()
 176     parser.parse(path)
 177
 178     writer = GIRWriter(parser.get_namespace(),
 179                        parser.get_shared_libraries(),
 180                        parser.get_includes(),
 181                        parser.get_pkgconfig_packages(),
 182                        parser.get_c_includes())
 183     f.write(writer.get_xml())
 184
 185 def test_codegen(optstring):
 186     (namespace, out_h_filename, out_c_filename) = optstring.split(',')
 187     if namespace == 'Everything':
 188         from .testcodegen import EverythingCodeGenerator
 189         gen = EverythingCodeGenerator(out_h_filename, out_c_filename)
 190         gen.write()
 191     else:
 192         _error("Invaild namespace %r" % (namespace, ))
 193     return 0
 194
 195 def process_options(output, allowed_flags):
 196     for option in output.split():
 197         for flag in allowed_flags:
 198             if not option.startswith(flag):
 199                 continue
 200             yield option
 201             break
 202
 203 def process_packages(options, packages):
 204     args = ['pkg-config', '--cflags']
 205     args.extend(packages)
 206     output = subprocess.Popen(args,
 207                               stdout=subprocess.PIPE).communicate()[0]
 208     if output is None:
 209         # the error output should have already appeared on our stderr,
 210         # so we just exit
 211         return 1
 212     # Some pkg-config files on Windows have options we don't understand,
 213     # so we explicitly filter to only the ones we need.
 214     options_whitelist = ['-I', '-D', '-U', '-l', '-L']
 215     filtered_output = list(process_options(output, options_whitelist))
 216     parser = _get_option_parser()
 217     pkg_options, unused = parser.parse_args(filtered_output)
 218     options.cpp_includes.extend(pkg_options.cpp_includes)
 219     options.cpp_defines.extend(pkg_options.cpp_defines)
 220     options.cpp_undefines.extend(pkg_options.cpp_undefines)
 221
 222 def extract_filenames(args):
 223     filenames = []
 224     for arg in args:
 225         # We don't support real C++ parsing yet, but we should be able
 226         # to understand C API implemented in C++ files.
 227         if (arg.endswith('.c') or arg.endswith('.cpp') or
 228             arg.endswith('.cc') or arg.endswith('.cxx') or
 229             arg.endswith('.h') or arg.endswith('.hpp') or
 230             arg.endswith('.hxx')):
 231             if not os.path.exists(arg):
 232                 _error('%s: no such a file or directory' % (arg, ))
 233             # Make absolute, because we do comparisons inside scannerparser.c
 234             # against the absolute path that cpp will give us
 235             filenames.append(os.path.abspath(arg))
 236     return filenames
 237
 238 def create_namespace(options):
 239     if options.strip_prefix:
 240         print """g-ir-scanner: warning: Option --strip-prefix has been deprecated;
 241 see --identifier-prefix and --symbol-prefix."""
 242         options.identifier_prefixes.append(options.strip_prefix)
 243
 244     # We do this dance because the empty list has different semantics from
 245     # None; if the user didn't specify the options, we want to use None so
 246     # the Namespace constructor picks the defaults.
 247     if options.identifier_prefixes:
 248         identifier_prefixes = options.identifier_prefixes
 249     else:
 250         identifier_prefixes = None
 251     if options.symbol_prefixes:
 252         for prefix in options.symbol_prefixes:
 253             # See Transformer._split_c_string_for_namespace_matches() for
 254             # why this check is needed
 255             if prefix.lower() != prefix:
 256                 _error("Values for --symbol-prefix must be entirely lowercase")
 257         symbol_prefixes = options.symbol_prefixes
 258     else:
 259         symbol_prefixes = None
 260
 261     return Namespace(options.namespace_name,
 262                      options.namespace_version,
 263                      identifier_prefixes=identifier_prefixes,
 264                      symbol_prefixes=symbol_prefixes)
 265
 266 def create_transformer(namespace, options):
 267     transformer = Transformer(namespace,
 268                               accept_unprefixed=options.accept_unprefixed)
 269     transformer.set_include_paths(options.include_paths)
 270     if options.passthrough_gir:
 271         transformer.disable_cache()
 272         transformer.set_passthrough_mode()
 273
 274     shown_include_warning = False
 275     for include in options.includes:
 276         if os.sep in include:
 277             _error("Invalid include path %r" % (include, ))
 278         try:
 279             include_obj = Include.from_string(include)
 280         except:
 281             _error("Malformed include %r\n" % (include, ))
 282         transformer.register_include(include_obj)
 283     for include_path in options.includes_uninstalled:
 284         transformer.register_include_uninstalled(include_path)
 285
 286     return transformer
 287
 288 def create_binary(transformer, options, args):
 289     # Transform the C AST nodes into higher level
 290     # GLib/GObject nodes
 291     gdump_parser = GDumpParser(transformer)
 292
 293     # Do enough parsing that we have the get_type() functions to reference
 294     # when creating the introspection binary
 295     gdump_parser.init_parse()
 296
 297     if options.program:
 298         args=[options.program]
 299         args.extend(options.program_args)
 300         binary = IntrospectionBinary(args)
 301     else:
 302         binary = compile_introspection_binary(options,
 303                                               gdump_parser.get_get_type_functions(),
 304                                               gdump_parser.get_error_quark_functions())
 305
 306     shlibs = resolve_shlibs(options, binary, options.libraries)
 307     gdump_parser.set_introspection_binary(binary)
 308     gdump_parser.parse()
 309     return shlibs
 310
 311 def create_source_scanner(options, args):
 312     filenames = extract_filenames(args)
 313
 314     # Run the preprocessor, tokenize and construct simple
 315     # objects representing the raw C symbols
 316     ss = SourceScanner()
 317     ss.set_cpp_options(options.cpp_includes,
 318                        options.cpp_defines,
 319                        options.cpp_undefines)
 320     ss.parse_files(filenames)
 321     ss.parse_macros(filenames)
 322     return ss
 323
 324 def write_output(data, options):
 325     if options.output == "-":
 326         output = sys.stdout
 327     elif options.reparse_validate_gir:
 328         main_f, main_f_name = tempfile.mkstemp(suffix='.gir')
 329         main_f = os.fdopen(main_f, 'w')
 330         main_f.write(data)
 331         main_f.close()
 332
 333         temp_f, temp_f_name = tempfile.mkstemp(suffix='.gir')
 334         temp_f = os.fdopen(temp_f, 'w')
 335         passthrough_gir(main_f_name, temp_f)
 336         temp_f.close()
 337         if not utils.files_are_identical(main_f_name, temp_f_name):
 338             _error("Failed to re-parse gir file; scanned=%r passthrough=%r" % (
 339                 main_f_name, temp_f_name))
 340         os.unlink(temp_f_name)
 341         try:
 342             shutil.move(main_f_name, options.output)
 343         except OSError, e:
 344             if e.errno == errno.EPERM:
 345                 os.unlink(main_f_name)
 346                 return 0
 347             raise
 348         return 0
 349     else:
 350         try:
 351             output = open(options.output, "w")
 352         except IOError, e:
 353             _error("opening output for writing: %s" % (e.strerror, ))
 354
 355     try:
 356         output.write(data)
 357     except IOError, e:
 358         _error("while writing output: %s" % (e.strerror, ))
 359
 360 def scanner_main(args):
 361     parser = _get_option_parser()
 362     (options, args) = parser.parse_args(args)
 363
 364     if options.passthrough_gir:
 365         passthrough_gir(options.passthrough_gir, sys.stdout)
 366     if options.test_codegen:
 367         return test_codegen(options.test_codegen)
 368
 369     if len(args) <= 1:
 370         _error('Need at least one filename')
 371
 372     if not options.namespace_name:
 373         _error('Namespace name missing')
 374
 375     if options.format == 'gir':
 376         from giscanner.girwriter import GIRWriter as Writer
 377     else:
 378         _error("Unknown format: %s" % (options.format, ))
 379
 380     if not (options.libraries or options.program):
 381         _error("Must specify --program or --library")
 382
 383     namespace = create_namespace(options)
 384     logger = message.MessageLogger.get(namespace=namespace)
 385     if options.warn_all:
 386         logger.enable_warnings(True)
 387     transformer = create_transformer(namespace, options)
 388
 389     packages = set(options.packages)
 390     packages.update(transformer.get_pkgconfig_packages())
 391     exit_code = process_packages(options, packages)
 392     if exit_code:
 393         return exit_code
 394
 395     ss = create_source_scanner(options, args)
 396
 397     ap = AnnotationParser()
 398     blocks = ap.parse(ss.get_comments())
 399
 400     # Transform the C symbols into AST nodes
 401     transformer.set_annotations(blocks)
 402     transformer.parse(ss.get_symbols())
 403
 404     shlibs = create_binary(transformer, options, args)
 405
 406     main = MainTransformer(transformer, blocks)
 407     main.transform()
 408
 409     utils.break_on_debug_flag('tree')
 410
 411     final = IntrospectablePass(transformer, blocks)
 412     final.validate()
 413
 414     warning_count = logger.get_warning_count()
 415     if options.warn_fatal and warning_count > 0:
 416         message.fatal("warnings configured as fatal")
 417         return 1
 418     elif warning_count > 0 and options.warn_all is False:
 419         print ("g-ir-scanner: %s: warning: %d warnings suppressed (use --warn-all to see them)"
 420                % (transformer.namespace.name, warning_count, ))
 421
 422     # Write out AST
 423     if options.packages_export:
 424         exported_packages = options.packages_export
 425     else:
 426         exported_packages = options.packages
 427
 428     writer = Writer(transformer.namespace, shlibs, transformer.get_includes(),
 429                     exported_packages, options.c_includes)
 430     data = writer.get_xml()
 431
 432     write_output(data, options)
 433
 434     return 0