Add a QT tool. (Christoph Wiedemann)

1 files changed, 102 insertions, 1 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 49fe6fd..29b2bb2 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -895,6 +895,7 @@ msvs
 nasm
 pdflatex
 pdftex
+qt
 rmic
 sgiar
 sgicc
@@ -1351,7 +1352,8 @@ env.CFile(target = 'bar', source = 'bar.y')
 .EE
 
 .IP CXXFile
-Builds a C++ source file given a lex (.ll) or yacc (.yy) input file.
+Builds a C++ source file given a lex (.ll), yacc (.yy)
+or uic (.ui) input file.
 The suffix specified by the $CXXFILESUFFIX construction variable
 (.cc by default)
 is automatically added to the target
@@ -3068,6 +3070,105 @@ The prefix used for PostScript file names.
 .IP PSSUFFIX
 The prefix used for PostScript file names.
 
+.IP QTDIR
+The qt tool tries to take this from os.environ.
+It also initializes all QT_*
+construction variables listed below.
+(Note that all paths are constructed
+with python's os.path.join() method, but listed here with the '/' seperator
+for easier reading.)
+In addition, the construction environment
+variables CPPPATH, LIBPATH, LIBS, PROGEMITTER, SHLIBEMITTER and LIBEMITTER
+are modified. Because the build-performance is affected when using this tool,
+you have to explicitly specify it at Environment creation:
+.ES
+Environment(tools=['default','qt']).
+.EE
+.IP
+You may want to use
+.B Configure
+to verify that the qt support really works.
+The qt tool supports the following operations:
+
+.B Automatic moc file generation from header files.
+You do not have to specify moc files explicitly, the tool does it for you.
+However, there are a few preconditions to do so: Your header file must have
+the same filebase as your implementation file and must stay in the same
+directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh.
+
+.B Automatic moc file generation from cxx files.
+As stated in the qt documentation,
+include the moc file at the end of the cxx file.
+Note that you have to include the file, which is generated by the
+QT_MOCNAMEGENERATOR function. If you are using BuildDir, you may need to
+specify duplicate=1.
+
+.B Automatic handling of .ui files.
+The implementation files generated from .ui files are handled much the same
+as yacc or lex files. Because there are also generated headers, you may
+need to specify duplicate=1 in calls to BuildDir.
+
+.IP QT_LIB
+Default value is 'qt'. You may want to set this to 'qt-mt'
+
+.IP QT_MOC
+Default value is '$QTDIR/bin/moc'.
+
+.IP QT_UIC
+Default value is '$QTDIR/bin/uic'.
+
+.IP QT_UICIMPLFLAGS
+Default value is ''. These flags are passed to uic, when creating a cxx
+file from a .ui file.
+
+.IP QT_UICDECLFLAGS
+Default value is ''. These flags are passed to uic, when creating a a h
+file from a .ui file.
+
+.IP QT_MOCFROMHFLAGS
+Default value is ''. These flags are passed to moc, when moccing a header
+file.
+
+.IP QT_MOCFROMCPPFLAGS
+Default value is '-i'. These flags are passed to moc, when moccing a
+cpp file.
+
+.IP QT_HSUFFIX
+Default value is '.h'. Suffix of headers generated with uic.
+
+.IP QT_UISUFFIX
+Default value is '.ui'. Suffix of designer files.
+
+.IP QT_UIHSUFFIX
+Default value is '.ui.h'.
+
+.IP QT_MOCNAMEGENERATOR
+Three-argument function, which generates names of moc output files.
+This is the most flexible way to support the huge number of conventions
+for this type of files. The arguments are the
+.I filebase
+, which is the file to be moc'd without path and extension, the
+.I src_suffix
+, which is the extension of the file to be moc'd and the environment
+.I env
+The default value maps 'myfile.myext' to 'moc_myfile.$CXXFILESUFFIX':
+
+.ES
+lambda filebase, src_suffix, env: 'moc_' + filebase + env['CXXFILESUFFIX']
+.EE
+
+.IP QT_UICIMPLCOM
+Command to generate cxx files from .ui files.
+
+.IP QT_UICDECLCOM
+Command to generate header files from .ui files.
+
+.IP QT_MOCFROMHCOM
+Command to generate a moc file from a header.
+
+.IP QT_MOCFROMCXXCOM
+Command to generate a moc file from a cpp file.
+
 .IP RANLIB
 The archive indexer.