giscanner/utils.py

   1 # -*- Mode: Python -*-
   2 # GObject-Introspection - a framework for introspecting GObject libraries
   3 # Copyright (C) 2008  Johan Dahlin
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2 of the License, or (at your option) any later version.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the
  17 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18 # Boston, MA 02111-1307, USA.
  19 #
  20
  21 import re
  22 import os
  23 import subprocess
  24
  25 _debugflags = None
  26 def have_debug_flag(flag):
  27     """Check for whether a specific debugging feature is enabled.
  28 Well-known flags:
  29  * start: Drop into debugger just after processing arguments
  30  * exception: Drop into debugger on fatalexception
  31  * warning: Drop into debugger on warning
  32  * posttrans: Drop into debugger just before introspectable pass
  33 """
  34     global _debugflags
  35     if _debugflags is None:
  36         _debugflags = os.environ.get('GI_SCANNER_DEBUG', '').split(',')
  37         if '' in _debugflags:
  38             _debugflags.remove('')
  39     return flag in _debugflags
  40
  41 def break_on_debug_flag(flag):
  42     if have_debug_flag(flag):
  43         import pdb
  44         pdb.set_trace()
  45
  46 # Copied from h2defs.py
  47 _upperstr_pat1 = re.compile(r'([^A-Z])([A-Z])')
  48 _upperstr_pat2 = re.compile(r'([A-Z][A-Z])([A-Z][0-9a-z])')
  49 _upperstr_pat3 = re.compile(r'^([A-Z])([A-Z])')
  50
  51
  52 def to_underscores(name):
  53     """Converts a typename to the equivalent underscores name.
  54     This is used to form the type conversion macros and enum/flag
  55     name variables"""
  56     name = _upperstr_pat1.sub(r'\1_\2', name)
  57     name = _upperstr_pat2.sub(r'\1_\2', name)
  58     name = _upperstr_pat3.sub(r'\1_\2', name, count=1)
  59     return name
  60
  61
  62 def to_underscores_noprefix(name):
  63     """Like to_underscores, but designed for "unprefixed" names.
  64     to_underscores("DBusFoo") => dbus_foo, not d_bus_foo."""
  65     name = _upperstr_pat1.sub(r'\1_\2', name)
  66     name = _upperstr_pat2.sub(r'\1_\2', name)
  67     return name
  68
  69 _libtool_pat = re.compile("dlname='([A-z0-9\.\-\+]+)'\n")
  70
  71 def _extract_dlname_field(la_file):
  72     f = open(la_file)
  73     data = f.read()
  74     f.close()
  75     m = _libtool_pat.search(data)
  76     if m:
  77         return m.groups()[0]
  78     else:
  79         return None
  80
  81 # Returns the name that we would pass to dlopen() the library
  82 # corresponding to this .la file
  83 def extract_libtool_shlib(la_file):
  84     dlname = _extract_dlname_field(la_file)
  85     if dlname is None:
  86         return None
  87
  88     # From the comments in extract_libtool(), older libtools had
  89     # a path rather than the raw dlname
  90     return os.path.basename(dlname)
  91
  92 def extract_libtool(la_file):
  93     dlname = _extract_dlname_field(la_file)
  94     if dlname is None:
  95         raise ValueError("%s has no dlname. Not a shared library?" % la_file)
  96     libname = os.path.join(os.path.dirname(la_file),
  97                            '.libs', dlname)
  98     # FIXME: This hackish, but I'm not sure how to do this
  99     #        in a way which is compatible with both libtool 2.2
 100     #        and pre-2.2. Johan 2008-10-21
 101     libname = libname.replace('.libs/.libs', '.libs')
 102     return libname
 103
 104 # Returns arguments for invoking libtool, if applicable, otherwise None
 105 def get_libtool_command(options):
 106     libtool_infection = not options.nolibtool
 107     if not libtool_infection:
 108         return None
 109
 110     libtool_path = options.libtool_path
 111     if libtool_path:
 112         # Automake by default sets:
 113         # LIBTOOL = $(SHELL) $(top_builddir)/libtool
 114         # To be strictly correct we would have to parse shell.  For now
 115         # we simply split().
 116         return libtool_path.split(' ')
 117
 118     try:
 119         subprocess.check_call(['libtool', '--version'],
 120                               stdout=open(os.devnull))
 121     except (subprocess.CalledProcessError, OSError), e:
 122         # If libtool's not installed, assume we don't need it
 123         return None
 124
 125     return ['libtool']
 126
 127
 128 def files_are_identical(path1, path2):
 129     f1 = open(path1)
 130     f2 = open(path2)
 131     buf1 = f1.read(8192)
 132     buf2 = f2.read(8192)
 133     while buf1 == buf2 and buf1 != '':
 134         buf1 = f1.read(8192)
 135         buf2 = f2.read(8192)
 136     f1.close()
 137     f2.close()
 138     return buf1 == buf2