Add base support for Include-What-You-Use

Author: u-235

3rdparty/basic/basic.pro

@@ -3,6 +3,8 @@ TEMPLATE = lib
 TARGET = basic
 CONFIG += staticlib
 
+USE -= check_iwyu
+
 include(../../common.pri)
 
 HEADERS += basic_interpreter.h

3rdparty/kdiff3/kdiff3.pro

@@ -4,6 +4,8 @@ TEMPLATE = lib
 TARGET = kdiff3
 CONFIG += staticlib
 
+USE -= check_iwyu
+
 include(../../common.pri)
 
 QT *= widgets

3rdparty/qtsingleapplication/qtsingleapplication.pro

@@ -4,6 +4,8 @@ TEMPLATE = lib
 TARGET = qtsingleapplication
 CONFIG += staticlib
 
+USE -= check_iwyu
+
 include(../../common.pri)
 
 QT *= widgets network

common.pri

@@ -47,7 +47,7 @@ contains(MODULES, qtsingleapplication) {
     LIBS += -L$$shadowed($${PROJECT_ROOT_PATH}/3rdparty/qtsingleapplication)
     LIBS += -lqtsingleapplication
 }
- 
+
 contains(MODULES, addons) {
     MODULES *= basic
     INCLUDEPATH += $${PROJECT_ROOT_PATH}/addons/include
@@ -82,6 +82,29 @@ contains(MODULES, basic) {
 }
 
 
+#------------------#
+# iwyu support     #
+#------------------#
+
+contains(USE, check_iwyu) {
+    linux*:IWYU_FLAGS += -fPIE
+
+    IWYU_FLAGS += $(DEFINES) -w $(INCPATH)
+
+    for(include, IWYU_INCLUDES) {
+        IWYU_FLAGS += -I$$include
+    }
+
+    IWYU_EXTRA_FLAGS += -Xiwyu --max_line_length=120 -Xiwyu --mapping_file=$${PROJECT_ROOT_PATH}/tools/iwyu.imp
+
+    iwyu.output  = ${QMAKE_FILE_BASE}.cpp.log
+    iwyu.commands = $${PROJECT_ROOT_PATH}/tools/iwyu_comp.sh $${IWYU_EXTRA_FLAGS} $${IWYU_FLAGS} ${QMAKE_FILE_NAME}
+    iwyu.input = SOURCES
+    iwyu.CONFIG += no_link target_predeps
+    QMAKE_EXTRA_COMPILERS += iwyu
+}
+
+
 #
 # function findFiles(dir, basename)
 # Returns a list of files with this basename.

tools/README.md

@@ -14,3 +14,30 @@ Usage (from source root):
 or
 
     astyle  --project=tools/astyle.cfg -I -r 'module/*.cpp' 'module/*.h'
+
+
+Include-What-You-Use
+--------------------
+
+https://include-what-you-use.org
+    
+To use IWYU, run qmake with the optional USE flag:
+
+    qmake  -r USE+=check_iwyu path/to/gcodeworkshop_top.pro
+
+The following additional parameters are possible:
+
+* `IWYU_INCLUDES` specifies additional paths to search for header files,
+  this comes in handy in Debian:
+
+      IWYU_INCLUDES=/usr/lib/llvm-13/include/c++/v1
+
+* `IWYU_EXTRA_FLAGS` additional options specifically IWYU:
+
+      IWYU_EXTRA_FLAGS='-Xiwyu --update_comments'
+
+
+Additional links:
+
+* https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUMappings.md
+* https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md

tools/iwyu.imp

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+include-what-you-use $* 2>&1 | tee $(basename -- "${!#}").log
+exit 0