<filename>scripts/gen-mumble_app-qt-def.py
#!/usr/bin/env python
#
# Copyright (C) 2013 <NAME> <<EMAIL>>
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# - Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
# - Neither the name of the Mumble Developers nor the names of its
#   contributors may be used to endorse or promote products derived from this
#   software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# gen-mumble_app-qt-def.py creates a module definition file (.def)
# for the Qt symbols that mumble_app.dll needs to export to support
# the manual.dll plugin.
#
# The .def file is generated by running dumpbin.exe on a set of static
# Qt libraries, filtering the output to only include the symbols that
# we're interested in.
#
# The filtering process is simply a substring match on the list of
# MSVC mangled names. It might make sense to tune the filter in the
# future, since the current iteration is likely to produce unneeded
# exports.

import subprocess
import sys
import re
import os

# qtSymbols list the Qt symbols that we're interested in exporting.
qtSymbols = [
	# QtCore
	'QObject',
	'QCoreApplication',
	'QString',
	'QBasicAtomicInt',
	'QByteArray',
	'QListData',
	'QArrayData',

	# QtGui/QtWidgets
	'QGroupBox',
	'QGridLayout',
	'QGraphicsScene',
	'QWidget',
	'QDialog',
	'QDialogButton',
	'QLabel',
	'QLineEdit',
	'QAbstractSlider',
	'QBrush',
	'QGraphicsView',
	'QPushButton',
	'QDial',
	'QSpinBox',
	'QValidator',
	'QSpacerItem',
	'QLayoutItem',
	'QAbstractScrollArea',
	'QVBoxLayout',
	'QLayout',
	'QAbstractSpinBox',
	'QFrame',
	'QBoxLayout',
	'QDoubleSpinBox',
	'QObject',
	'QMetaObject',
	'QAbstractButton',
	'QPen',
	'QHBoxLayout',
	'QGraphicsItem',
	'QColor',
	'QGraphicsView',
	'QSizePolicy',
	'QMouseEvent',
	'QRectF',
	'QPointF',
	'QWindow',
	'QGuiApplication',
]

def processExports(f, libs, symbols):
	'''
		processExports writes a module definition file (.def) to the file object
		`f' for all symbols found in the static libraries given in `libs' that
		match any of the strings found in `symbols'.
	'''
	p = subprocess.Popen(['dumpbin.exe', '/linkermember'] + libs, stdout=subprocess.PIPE)
	stdout, stderr = p.communicate()
	if p.returncode != 0:
		raise Exception('dumpbin.exe failed: %s', stderr)

	symbol_re = re.compile('^.*\ (.*(%s)+?.*)$' % '|'.join(symbols))
	f.write('EXPORTS\n\n')

	for line in stdout.split('\r\n'):
		m = symbol_re.match(line)
		if m is not None:
			mangled, matchedsym = m.groups()
			# Qt5: avoid LNK1237
			if 'innerFunction' in mangled:
				continue
			f.write(mangled + '\r\n')

def main():
	if len(sys.argv) < 4:
		print 'Usage: gen-mumble_app-qt-def.py <release|debug> <qt-lib-path> <outfn>'
		sys.exit(1)

	kind = sys.argv[1]
	qtLibDir = sys.argv[2]
	outFn = sys.argv[3]

	# Find the absolute path of the Qt libs we're interested in.
	#
	# If we're in debug mode, look for libraries with a 'd' suffix,
	# such as 'QtGuid', rather than 'QtGui'.
	#
	# Non-existant libs are skipped. This is to allow the script to
	# work on both Qt 4 and 5.
	suffix = ''
	if kind == 'debug':
		suffix = 'd'
	libs = ['QtCore', 'QtGui', 'Qt5Core', 'Qt5Gui', 'Qt5Widgets']
	libs = ['%s%s.lib' % (lib, suffix) for lib in libs]
	abslibs = [os.path.join(qtLibDir, lib) for lib in libs]
	abslibs = [lib for lib in abslibs if os.path.exists(lib)]

	with open(outFn, 'w') as f:
		processExports(f, abslibs, qtSymbols)

if __name__ == '__main__':
	main()
