2022-03-19 19:48:45 +01:00
|
|
|
# MIT License
|
|
|
|
|
#
|
|
|
|
|
# Copyright The SCons Foundation
|
|
|
|
|
#
|
|
|
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
|
|
|
# a copy of this software and associated documentation files (the
|
|
|
|
|
# "Software"), to deal in the Software without restriction, including
|
|
|
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
|
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
|
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
|
|
|
# the following conditions:
|
|
|
|
|
#
|
|
|
|
|
# The above copyright notice and this permission notice shall be included
|
|
|
|
|
# in all copies or substantial portions of the Software.
|
|
|
|
|
#
|
|
|
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
|
|
|
|
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
|
|
|
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
|
|
|
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
|
|
|
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
|
|
|
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
|
|
|
|
|
"""Tool-specific initialization for Qt.
|
|
|
|
|
|
|
|
|
|
There normally shouldn't be any need to import this module directly.
|
|
|
|
|
It will usually be imported through the generic SCons.Tool.Tool()
|
|
|
|
|
selection method.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
import os.path
|
|
|
|
|
import re
|
|
|
|
|
|
|
|
|
|
import SCons.Action
|
|
|
|
|
import SCons.Builder
|
|
|
|
|
import SCons.Defaults
|
|
|
|
|
import SCons.Scanner
|
|
|
|
|
import SCons.Tool
|
|
|
|
|
import SCons.Util
|
|
|
|
|
import SCons.Tool.cxx
|
|
|
|
|
import SCons.Warnings
|
|
|
|
|
cplusplus = SCons.Tool.cxx
|
|
|
|
|
|
|
|
|
|
class ToolQtWarning(SCons.Warnings.SConsWarning):
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
class GeneratedMocFileNotIncluded(ToolQtWarning):
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
class QtdirNotFound(ToolQtWarning):
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
SCons.Warnings.enableWarningClass(ToolQtWarning)
|
|
|
|
|
|
|
|
|
|
header_extensions = [".h", ".hxx", ".hpp", ".hh"]
|
|
|
|
|
if SCons.Util.case_sensitive_suffixes('.h', '.H'):
|
|
|
|
|
header_extensions.append('.H')
|
|
|
|
|
|
|
|
|
|
cxx_suffixes = cplusplus.CXXSuffixes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def find_platform_specific_qt_paths():
|
|
|
|
|
"""
|
|
|
|
|
find non-standard QT paths
|
|
|
|
|
|
|
|
|
|
If the platform does not put QT tools in standard search paths,
|
|
|
|
|
the path is expected to be set using QTDIR. SCons violates
|
|
|
|
|
the normal rule of not pulling from the user's environment
|
|
|
|
|
in this case. However, some test cases try to validate what
|
|
|
|
|
happens when QTDIR is unset, so we need to try to make a guess.
|
|
|
|
|
|
|
|
|
|
:return: a guess at a path
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
# qt_bin_dirs = []
|
|
|
|
|
qt_bin_dir = None
|
|
|
|
|
if os.path.isfile('/etc/redhat-release'):
|
|
|
|
|
with open('/etc/redhat-release','r') as rr:
|
|
|
|
|
lines = rr.readlines()
|
|
|
|
|
distro = lines[0].split()[0]
|
|
|
|
|
if distro == 'CentOS':
|
|
|
|
|
# Centos installs QT under /usr/{lib,lib64}/qt{4,5,-3.3}/bin
|
|
|
|
|
# so we need to handle this differently
|
|
|
|
|
# qt_bin_dirs = glob.glob('/usr/lib64/qt*/bin')
|
|
|
|
|
# TODO: all current Fedoras do the same, need to look deeper here.
|
|
|
|
|
qt_bin_dir = '/usr/lib64/qt-3.3/bin'
|
|
|
|
|
|
|
|
|
|
return qt_bin_dir
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
QT_BIN_DIR = find_platform_specific_qt_paths()
|
|
|
|
|
|
|
|
|
|
def checkMocIncluded(target, source, env):
|
|
|
|
|
moc = target[0]
|
|
|
|
|
cpp = source[0]
|
|
|
|
|
# looks like cpp.includes is cleared before the build stage :-(
|
|
|
|
|
# not really sure about the path transformations (moc.cwd? cpp.cwd?) :-/
|
|
|
|
|
path = SCons.Defaults.CScan.path(env, moc.cwd)
|
|
|
|
|
includes = SCons.Defaults.CScan(cpp, env, path)
|
|
|
|
|
if moc not in includes:
|
|
|
|
|
SCons.Warnings.warn(
|
|
|
|
|
GeneratedMocFileNotIncluded,
|
|
|
|
|
"Generated moc file '%s' is not included by '%s'" %
|
|
|
|
|
(str(moc), str(cpp)))
|
|
|
|
|
|
|
|
|
|
def find_file(filename, paths, node_factory):
|
|
|
|
|
for dir in paths:
|
|
|
|
|
node = node_factory(filename, dir)
|
|
|
|
|
if node.rexists():
|
|
|
|
|
return node
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
class _Automoc:
|
|
|
|
|
"""
|
|
|
|
|
Callable class, which works as an emitter for Programs, SharedLibraries and
|
|
|
|
|
StaticLibraries.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(self, objBuilderName):
|
|
|
|
|
self.objBuilderName = objBuilderName
|
|
|
|
|
|
|
|
|
|
def __call__(self, target, source, env):
|
|
|
|
|
"""
|
|
|
|
|
Smart autoscan function. Gets the list of objects for the Program
|
|
|
|
|
or Lib. Adds objects and builders for the special qt files.
|
|
|
|
|
"""
|
|
|
|
|
try:
|
|
|
|
|
if int(env.subst('$QT_AUTOSCAN')) == 0:
|
|
|
|
|
return target, source
|
|
|
|
|
except ValueError:
|
|
|
|
|
pass
|
|
|
|
|
try:
|
|
|
|
|
debug = int(env.subst('$QT_DEBUG'))
|
|
|
|
|
except ValueError:
|
|
|
|
|
debug = 0
|
|
|
|
|
|
|
|
|
|
# some shortcuts used in the scanner
|
|
|
|
|
splitext = SCons.Util.splitext
|
|
|
|
|
objBuilder = getattr(env, self.objBuilderName)
|
|
|
|
|
|
|
|
|
|
# some regular expressions:
|
|
|
|
|
# Q_OBJECT detection
|
|
|
|
|
q_object_search = re.compile(r'[^A-Za-z0-9]Q_OBJECT[^A-Za-z0-9]')
|
|
|
|
|
# cxx and c comment 'eater'
|
|
|
|
|
#comment = re.compile(r'(//.*)|(/\*(([^*])|(\*[^/]))*\*/)')
|
|
|
|
|
# CW: something must be wrong with the regexp. See also bug #998222
|
|
|
|
|
# CURRENTLY THERE IS NO TEST CASE FOR THAT
|
|
|
|
|
|
|
|
|
|
# The following is kind of hacky to get builders working properly (FIXME)
|
|
|
|
|
objBuilderEnv = objBuilder.env
|
|
|
|
|
objBuilder.env = env
|
|
|
|
|
mocBuilderEnv = env.Moc.env
|
|
|
|
|
env.Moc.env = env
|
|
|
|
|
|
|
|
|
|
# make a deep copy for the result; MocH objects will be appended
|
|
|
|
|
out_sources = source[:]
|
|
|
|
|
|
|
|
|
|
for obj in source:
|
|
|
|
|
if not obj.has_builder():
|
|
|
|
|
# binary obj file provided
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: '%s' seems to be a binary. Discarded." % str(obj))
|
|
|
|
|
continue
|
|
|
|
|
cpp = obj.sources[0]
|
|
|
|
|
if not splitext(str(cpp))[1] in cxx_suffixes:
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: '%s' is no cxx file. Discarded." % str(cpp))
|
|
|
|
|
# c or fortran source
|
|
|
|
|
continue
|
|
|
|
|
#cpp_contents = comment.sub('', cpp.get_text_contents())
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: Getting contents of %s" % cpp)
|
|
|
|
|
cpp_contents = cpp.get_text_contents()
|
|
|
|
|
h=None
|
|
|
|
|
for h_ext in header_extensions:
|
|
|
|
|
# try to find the header file in the corresponding source
|
|
|
|
|
# directory
|
|
|
|
|
hname = splitext(cpp.name)[0] + h_ext
|
|
|
|
|
h = find_file(hname, (cpp.get_dir(),), env.File)
|
|
|
|
|
if h:
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: Scanning '%s' (header of '%s')" % (str(h), str(cpp)))
|
|
|
|
|
#h_contents = comment.sub('', h.get_text_contents())
|
|
|
|
|
h_contents = h.get_text_contents()
|
|
|
|
|
break
|
|
|
|
|
if not h and debug:
|
|
|
|
|
print("scons: qt: no header for '%s'." % (str(cpp)))
|
|
|
|
|
if h and q_object_search.search(h_contents):
|
|
|
|
|
# h file with the Q_OBJECT macro found -> add moc_cpp
|
|
|
|
|
moc_cpp = env.Moc(h)
|
|
|
|
|
moc_o = objBuilder(moc_cpp)
|
|
|
|
|
out_sources.append(moc_o)
|
|
|
|
|
#moc_cpp.target_scanner = SCons.Defaults.CScan
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: found Q_OBJECT macro in '%s', moc'ing to '%s'" % (str(h), str(moc_cpp)))
|
|
|
|
|
if cpp and q_object_search.search(cpp_contents):
|
|
|
|
|
# cpp file with Q_OBJECT macro found -> add moc
|
|
|
|
|
# (to be included in cpp)
|
|
|
|
|
moc = env.Moc(cpp)
|
|
|
|
|
env.Ignore(moc, moc)
|
|
|
|
|
if debug:
|
|
|
|
|
print("scons: qt: found Q_OBJECT macro in '%s', moc'ing to '%s'" % (str(cpp), str(moc)))
|
|
|
|
|
#moc.source_scanner = SCons.Defaults.CScan
|
|
|
|
|
# restore the original env attributes (FIXME)
|
|
|
|
|
objBuilder.env = objBuilderEnv
|
|
|
|
|
env.Moc.env = mocBuilderEnv
|
|
|
|
|
|
|
|
|
|
return (target, out_sources)
|
|
|
|
|
|
|
|
|
|
AutomocShared = _Automoc('SharedObject')
|
|
|
|
|
AutomocStatic = _Automoc('StaticObject')
|
|
|
|
|
|
|
|
|
|
def _detect(env):
|
|
|
|
|
"""Not really safe, but fast method to detect the QT library"""
|
|
|
|
|
|
|
|
|
|
QTDIR = env.get('QTDIR',None)
|
|
|
|
|
if not QTDIR:
|
|
|
|
|
QTDIR = os.environ.get('QTDIR',None)
|
|
|
|
|
if not QTDIR:
|
|
|
|
|
moc = env.WhereIs('moc') or env.WhereIs('moc',QT_BIN_DIR)
|
|
|
|
|
if moc:
|
|
|
|
|
QTDIR = os.path.dirname(os.path.dirname(moc))
|
|
|
|
|
SCons.Warnings.warn(
|
|
|
|
|
QtdirNotFound,
|
|
|
|
|
"Could not detect qt, using moc executable as a hint (QTDIR=%s)" % QTDIR)
|
|
|
|
|
else:
|
|
|
|
|
QTDIR = None
|
|
|
|
|
SCons.Warnings.warn(
|
|
|
|
|
QtdirNotFound,
|
|
|
|
|
"Could not detect qt, using empty QTDIR")
|
|
|
|
|
return QTDIR
|
|
|
|
|
|
|
|
|
|
def uicEmitter(target, source, env):
|
|
|
|
|
adjustixes = SCons.Util.adjustixes
|
|
|
|
|
bs = SCons.Util.splitext(str(source[0].name))[0]
|
|
|
|
|
bs = os.path.join(str(target[0].get_dir()),bs)
|
|
|
|
|
# first target (header) is automatically added by builder
|
|
|
|
|
if len(target) < 2:
|
|
|
|
|
# second target is implementation
|
|
|
|
|
target.append(adjustixes(bs,
|
|
|
|
|
env.subst('$QT_UICIMPLPREFIX'),
|
|
|
|
|
env.subst('$QT_UICIMPLSUFFIX')))
|
|
|
|
|
if len(target) < 3:
|
|
|
|
|
# third target is moc file
|
|
|
|
|
target.append(adjustixes(bs,
|
|
|
|
|
env.subst('$QT_MOCHPREFIX'),
|
|
|
|
|
env.subst('$QT_MOCHSUFFIX')))
|
|
|
|
|
return target, source
|
|
|
|
|
|
|
|
|
|
def uicScannerFunc(node, env, path):
|
|
|
|
|
lookout = []
|
|
|
|
|
lookout.extend(env['CPPPATH'])
|
|
|
|
|
lookout.append(str(node.rfile().dir))
|
|
|
|
|
includes = re.findall("<include.*?>(.*?)</include>", node.get_text_contents())
|
|
|
|
|
result = []
|
|
|
|
|
for incFile in includes:
|
|
|
|
|
dep = env.FindFile(incFile,lookout)
|
|
|
|
|
if dep:
|
|
|
|
|
result.append(dep)
|
|
|
|
|
return result
|
|
|
|
|
|
|
|
|
|
uicScanner = SCons.Scanner.ScannerBase(uicScannerFunc,
|
|
|
|
|
name = "UicScanner",
|
|
|
|
|
node_class = SCons.Node.FS.File,
|
|
|
|
|
node_factory = SCons.Node.FS.File,
|
|
|
|
|
recursive = 0)
|
|
|
|
|
|
|
|
|
|
def generate(env):
|
|
|
|
|
"""Add Builders and construction variables for qt to an Environment."""
|
|
|
|
|
CLVar = SCons.Util.CLVar
|
|
|
|
|
Action = SCons.Action.Action
|
|
|
|
|
Builder = SCons.Builder.Builder
|
|
|
|
|
|
|
|
|
|
SCons.Warnings.warn(
|
|
|
|
|
SCons.Warnings.ToolQtDeprecatedWarning, "Tool module for Qt version 3 is deprecated"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
env.SetDefault(QTDIR = _detect(env),
|
|
|
|
|
QT_BINPATH = os.path.join('$QTDIR', 'bin'),
|
|
|
|
|
QT_CPPPATH = os.path.join('$QTDIR', 'include'),
|
|
|
|
|
QT_LIBPATH = os.path.join('$QTDIR', 'lib'),
|
|
|
|
|
QT_MOC = os.path.join('$QT_BINPATH','moc'),
|
|
|
|
|
QT_UIC = os.path.join('$QT_BINPATH','uic'),
|
|
|
|
|
QT_LIB = 'qt', # may be set to qt-mt
|
|
|
|
|
|
|
|
|
|
QT_AUTOSCAN = 1, # scan for moc'able sources
|
|
|
|
|
|
|
|
|
|
# Some QT specific flags. I don't expect someone wants to
|
|
|
|
|
# manipulate those ...
|
|
|
|
|
QT_UICIMPLFLAGS = CLVar(''),
|
|
|
|
|
QT_UICDECLFLAGS = CLVar(''),
|
|
|
|
|
QT_MOCFROMHFLAGS = CLVar(''),
|
|
|
|
|
QT_MOCFROMCXXFLAGS = CLVar('-i'),
|
|
|
|
|
|
|
|
|
|
# suffixes/prefixes for the headers / sources to generate
|
|
|
|
|
QT_UICDECLPREFIX = '',
|
|
|
|
|
QT_UICDECLSUFFIX = '.h',
|
|
|
|
|
QT_UICIMPLPREFIX = 'uic_',
|
|
|
|
|
QT_UICIMPLSUFFIX = '$CXXFILESUFFIX',
|
|
|
|
|
QT_MOCHPREFIX = 'moc_',
|
|
|
|
|
QT_MOCHSUFFIX = '$CXXFILESUFFIX',
|
|
|
|
|
QT_MOCCXXPREFIX = '',
|
|
|
|
|
QT_MOCCXXSUFFIX = '.moc',
|
|
|
|
|
QT_UISUFFIX = '.ui',
|
|
|
|
|
|
|
|
|
|
# Commands for the qt support ...
|
|
|
|
|
# command to generate header, implementation and moc-file
|
|
|
|
|
# from a .ui file
|
|
|
|
|
QT_UICCOM = [
|
|
|
|
|
CLVar('$QT_UIC $QT_UICDECLFLAGS -o ${TARGETS[0]} $SOURCE'),
|
|
|
|
|
CLVar('$QT_UIC $QT_UICIMPLFLAGS -impl ${TARGETS[0].file} '
|
|
|
|
|
'-o ${TARGETS[1]} $SOURCE'),
|
|
|
|
|
CLVar('$QT_MOC $QT_MOCFROMHFLAGS -o ${TARGETS[2]} ${TARGETS[0]}')],
|
|
|
|
|
# command to generate meta object information for a class
|
2022-12-22 19:51:25 +01:00
|
|
|
# declared in a header
|
2022-03-19 19:48:45 +01:00
|
|
|
QT_MOCFROMHCOM = (
|
|
|
|
|
'$QT_MOC $QT_MOCFROMHFLAGS -o ${TARGETS[0]} $SOURCE'),
|
|
|
|
|
# command to generate meta object information for a class
|
2022-12-22 19:51:25 +01:00
|
|
|
# declared in a cpp file
|
2022-03-19 19:48:45 +01:00
|
|
|
QT_MOCFROMCXXCOM = [
|
|
|
|
|
CLVar('$QT_MOC $QT_MOCFROMCXXFLAGS -o ${TARGETS[0]} $SOURCE'),
|
|
|
|
|
Action(checkMocIncluded,None)])
|
|
|
|
|
|
|
|
|
|
# ... and the corresponding builders
|
|
|
|
|
uicBld = Builder(action=SCons.Action.Action('$QT_UICCOM', '$QT_UICCOMSTR'),
|
|
|
|
|
emitter=uicEmitter,
|
|
|
|
|
src_suffix='$QT_UISUFFIX',
|
|
|
|
|
suffix='$QT_UICDECLSUFFIX',
|
|
|
|
|
prefix='$QT_UICDECLPREFIX',
|
|
|
|
|
source_scanner=uicScanner)
|
|
|
|
|
mocBld = Builder(action={}, prefix={}, suffix={})
|
|
|
|
|
for h in header_extensions:
|
|
|
|
|
act = SCons.Action.Action('$QT_MOCFROMHCOM', '$QT_MOCFROMHCOMSTR')
|
|
|
|
|
mocBld.add_action(h, act)
|
|
|
|
|
mocBld.prefix[h] = '$QT_MOCHPREFIX'
|
|
|
|
|
mocBld.suffix[h] = '$QT_MOCHSUFFIX'
|
|
|
|
|
for cxx in cxx_suffixes:
|
|
|
|
|
act = SCons.Action.Action('$QT_MOCFROMCXXCOM', '$QT_MOCFROMCXXCOMSTR')
|
|
|
|
|
mocBld.add_action(cxx, act)
|
|
|
|
|
mocBld.prefix[cxx] = '$QT_MOCCXXPREFIX'
|
|
|
|
|
mocBld.suffix[cxx] = '$QT_MOCCXXSUFFIX'
|
|
|
|
|
|
|
|
|
|
# register the builders
|
|
|
|
|
env['BUILDERS']['Uic'] = uicBld
|
|
|
|
|
env['BUILDERS']['Moc'] = mocBld
|
|
|
|
|
static_obj, shared_obj = SCons.Tool.createObjBuilders(env)
|
|
|
|
|
static_obj.add_src_builder('Uic')
|
|
|
|
|
shared_obj.add_src_builder('Uic')
|
|
|
|
|
|
|
|
|
|
# We use the emitters of Program / StaticLibrary / SharedLibrary
|
|
|
|
|
# to scan for moc'able files
|
|
|
|
|
# We can't refer to the builders directly, we have to fetch them
|
|
|
|
|
# as Environment attributes because that sets them up to be called
|
|
|
|
|
# correctly later by our emitter.
|
|
|
|
|
env.AppendUnique(PROGEMITTER =[AutomocStatic],
|
|
|
|
|
SHLIBEMITTER=[AutomocShared],
|
|
|
|
|
LDMODULEEMITTER=[AutomocShared],
|
|
|
|
|
LIBEMITTER =[AutomocStatic],
|
|
|
|
|
# Of course, we need to link against the qt libraries
|
|
|
|
|
CPPPATH=["$QT_CPPPATH"],
|
|
|
|
|
LIBPATH=["$QT_LIBPATH"],
|
|
|
|
|
LIBS=['$QT_LIB'])
|
|
|
|
|
|
|
|
|
|
def exists(env):
|
|
|
|
|
return _detect(env)
|
|
|
|
|
|
|
|
|
|
# Local Variables:
|
|
|
|
|
# tab-width:4
|
|
|
|
|
# indent-tabs-mode:nil
|
|
|
|
|
# End:
|
|
|
|
|
# vim: set expandtab tabstop=4 shiftwidth=4:
|
