Wie Sie das tool verwenden, gehören-was-Sie-zusammen mit CMake zu erkennen, ungenutzte Header?

Werkzeug include-what-you-use kann verwendet werden, um zu erkennen, unnötige Header. Ich bin mit CMake für meine C++ - software-Projekt. Wie kann ich anweisen, CMake ausgeführt werden, gehören-was-Sie-verwenden Sie automatisch auf die source-Dateien meiner software-Projekt?

Hast du die Frage halt so könnten Sie Sie beantworten?
Ich brauchte zu verwenden sind-was-du-in meinen CMake-Projekt. Als ich herausfand, dass dieser Weg, es zu tun, ich dachte, es war eine gute Idee, um es zu dokumentieren, wie eine stackoverflow-Frage für die anderen. Selbst-Antworten sind aufgefordert, gemäß der Dokumentation
Es gibt sogar eine "Antwort auf Ihre eigene Frage" Kontrollkästchen, wenn Sie eine Frage stellen.

InformationsquelleAutor Erik Sjölund | 2015-06-20

c++cmake header-files

CMake 3.3 Einführung der neuen target-Eigenschaft CXX_INCLUDE_WHAT_YOU_USE, die festgelegt werden können, um den Pfad des Programms include-what-you-use. Zum Beispiel diese CMakeLists.txt

cmake_minimum_required(VERSION 3.3 FATAL_ERROR)
add_executable(hello main.cc)

find_program(iwyu_path NAMES include-what-you-use iwyu)
if(NOT iwyu_path)
  message(FATAL_ERROR "Could not find the program include-what-you-use")
endif()

set_property(TARGET hello PROPERTY CXX_INCLUDE_WHAT_YOU_USE ${iwyu_path})

ist in der Lage, zum erstellen der Datei main.cc

#include <iostream>
#include <vector>

int main() {
  std::cout << "Hello World!" << std::endl;
  return 0;
}

und in der gleichen Zeit, haben include-what-you-use geben eine Warnung, dass
die mitgelieferten header Vektor ist nicht erforderlich.

user@ubuntu:/tmp$ ls ~/hello
CMakeLists.txt  main.cc
user@ubuntu:/tmp$ mkdir /tmp/build
user@ubuntu:/tmp$ cd /tmp/build
user@ubuntu:/tmp/build$ ~/cmake-3.3.0-rc2-Linux-x86_64/bin/cmake ~/hello
-- The C compiler identification is GNU 4.9.2
-- The CXX compiler identification is GNU 4.9.2
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /tmp/build
user@ubuntu:/tmp/build$ make
Scanning dependencies of target hello
[ 50%] Building CXX object CMakeFiles/hello.dir/main.cc.o
Warning: include-what-you-use reported diagnostics:

/home/user/hello/main.cc should add these lines:

/home/user/hello/main.cc should remove these lines:
- #include <vector>  //lines 2-2

The full include-list for /home/user/hello/main.cc:
#include <iostream>  //for operator<<, basic_ostream, cout, endl, ostream
---

[100%] Linking CXX executable hello
[100%] Built target hello
user@ubuntu:/tmp/build$ ./hello 
Hello World!
user@ubuntu:/tmp/build$

Wenn Sie möchten, übergeben von benutzerdefinierten Optionen, um include-what-you-use, wie zum Beispiel --mapping_file können Sie es über

set(iwyu_path_and_options
    ${iwyu_path}
    -Xiwyu
    --mapping_file=${my_mapping})

set_property(TARGET hello
    PROPERTY CXX_INCLUDE_WHAT_YOU_USE ${iwyu_path_and_options})

InformationsquelleAutor Erik Sjölund

23

Wenn Sie nicht haben Zugang zu CMake 3.3, include-what-you-use kommt mit einem python-tool namens iwyu_tool.py, die können tun, was Sie wollen.

Es funktioniert durch die Analyse Geräusch Zusammenstellung-Datenbank, die schnell produziert werden, mit CMake.

Läuft das tool manuell

Vorausgesetzt, Sie haben bereits eine CMake dir für Ihr Projekt, müssen Sie zunächst sagen, CMake zu produzieren, die Zusammenstellung-Datenbank:
```
$ cd build
$ cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .
```
Dieser erzeugt eine Datei, compile_commands.json mit compiler-Aufrufe für jedes Objekt eine Datei in Ihrem Projekt. Sie nicht brauchen, um das Projekt neu erstellen.

Nun können Sie include-what-you-use auf Ihr Projekt durch ausführen des python-Werkzeug, auf das build-Verzeichnis:
```
$ python /path/to/iwyu_tool.py -p .
```
Hinzufügen einer benutzerdefinierten Ziel-zu Ihrem cmake-Projekt

Folgende Ausschnitt kann verwendet werden, um einen iwyu Ziel ein cmake-Projekt.
```
# Generate clang compilation database
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

find_package(PythonInterp)
find_program(iwyu_tool_path NAMES iwyu_tool.py)
if (iwyu_tool_path AND PYTHONINTERP_FOUND)
  add_custom_target(iwyu
    ALL      # Remove ALL if you don't iwyu to be run by default.
    COMMAND "${PYTHON_EXECUTABLE}" "${iwyu_tool_path}" -p "${CMAKE_BINARY_DIR}"
    COMMENT "Running include-what-you-use tool"
    VERBATIM
  )
endif()
```
Hinweise

Den include-what-you-use binäre werden muss, die in Ihrem Pfad für jede der oben genannten arbeiten ordnungsgemäß.
- Danke, gut, eine Lösung für CMake 3.2 zu.
- ich kann Sie nicht finden iwyu_tool.py in der aktuellen Quelle. was wäre die Entsprechung für, die?
- Redest du include-what-you-use-0.7.src.tar.gz heruntergeladen von http://include-what-you-use.org/downloads/? iwyu_tool.py offenbar noch immer gibt, obwohl es tief geschachtelt ist in der directory-Struktur. Alternativ laden Sie einfach das Skript aus der github-Seite.
- ah, du hast Recht. Ich war mit clang 3.4-Zweig und es nicht haben, dass iwyu_tool.py. Die Datei besteht nur aus clang 3.6 nach oben. Vielen Dank für die Hilfe!
- Beachten Sie, dass das tool nicht die Vorteile der Parallelität, wie Sie in der Regel erhalten Sie mit make-j.
- Es heißt iwyu_tool und nicht iwyu-tool. Möchten Sie vielleicht korrigieren Sie Ihre Antwort oder andere, die vielleicht in einer ähnlichen situation wie ich Tat, als suchte ich für das letztere und konnte nicht finden, dass das Werkzeug überall.
- Danke @josch, ich habe aktualisiert die Namen.
- Darüber hinaus find_program() nimmt die NAMES, HINTS, und PATHS Argumente, die ich gefunden habe, hilfreich für die, die sich anmutig zur Verarbeitung von unix - -y-und Windows-Umgebungen.
InformationsquelleAutor Alastair Harrison
6

Können Sie auch ermöglichen es weltweit außerhalb der cmake-Skript, indem die cmake-variable:
```
cmake -DCMAKE_CXX_INCLUDE_WHAT_YOU_USE="iwyu" <builddir> 
```
Wird es dann nennen Sie es auf jeden CXX Ziel.

InformationsquelleAutor user7159222

Erweiterte ich den source code von Alastair Harrison, um zu erstellen Sie eine wiederverwendbare Lösung. Ich habe, kam mit die folgenden arbeiten sollten mit alle CMake Versionen:

Datei iwyu.cmake:

#.rst:
# include-what-you-use (iwyu)
# ----------------------------
#
# Allows to run the static code analyzer `include-what-you-use (iwyu)
# <http://include-what-you-use.org>`_ as a custom target with the build system
# `CMake <http://cmake.org>`_.
#
# .. topic:: Dependencies
#
#  This module requires the following *CMake* modules:
#
#  * ``FindPythonInterp``
#
# .. topic:: Contributors
#
#  * Florian Wolters <[email protected]>

#===============================================================================
# Copyright 2015 Florian Wolters
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#===============================================================================

# ------------------------------------------------------------------------------
# Include guard for this file.
# ------------------------------------------------------------------------------

if(iwyu_included)
  return()
endif()

set(iwyu_included TRUE)

option(BUILD_IWYU
       "Run the include-what-you-use static analyzer on the source code of the project."
       OFF)

function(iwyu_enable)
  set(iwyu_EXECUTABLE_NAME include-what-you-use)
  find_program(iwyu_EXECUTABLE ${iwyu_EXECUTABLE_NAME})

  if(iwyu_EXECUTABLE)
    # This is not exactly the same behavior as with CMake v3.3, since here all
    # compiled targets are analyzed.
    set(iwyu_tool_EXECUTABLE_NAME iwyu_tool.py)

    find_package(PythonInterp)
    find_program(iwyu_tool_EXECUTABLE ${iwyu_tool_EXECUTABLE_NAME})

    if(PYTHONINTERP_FOUND AND iwyu_tool_EXECUTABLE)
      set(CMAKE_EXPORT_COMPILE_COMMANDS ON PARENT_SCOPE)

      add_custom_target(iwyu
                        ALL
                        COMMAND "${PYTHON_EXECUTABLE}" "${iwyu_tool_EXECUTABLE}" -p "${CMAKE_BINARY_DIR}"
                        COMMENT "Running the ${iwyu_tool_EXECUTABLE_NAME} compilation database driver"
                        VERBATIM)
    else()
      message(STATUS
              "Unable to find the Python interpreter and/or the ${iwyu_tool_EXECUTABLE_NAME} script")
    endif()
  else()
    message(STATUS "Unable to find the ${iwyu_EXECUTABLE_NAME} executable")
  endif()
endfunction()

Datei CMakeLists.txt:

cmake_minimum_required(VERSION 3.0)

include(iwyu.cmake)

project(hello_world)
add_executable(${PROJECT_NAME} main.cc)

if(BUILD_IWYU)
  iwyu_enable()
endif()

Aufrufen CMake wie folgt ausgeführt gehören-was-Sie-verwenden, wenn die all Ziel ist aufgerufen:

cmake -DBUILD_IWYU=ON <path-to-source>
cmake --build . --target all

Sollte die Ausgabe wie folgt:

-- Configuring done
-- Generating done
-- Build files have been written to: /home/wolters/workspace/include-what-you-use_example/build
[ 66%] Built target hello_world
[100%] Running the iwyu_tool.py compilation database driver

/home/wolters/workspace/include-what-you-use_example/develop/main.cc should add these lines:

/home/wolters/workspace/include-what-you-use_example/develop/main.cc should remove these lines:
- #include <vector>  //lines 1-1

The full include-list for /home/wolters/workspace/include-what-you-use_example/develop/main.cc:
#include <iostream>  //for operator<<, basic_ostream, cout, endl, ostream
---
[100%] Built target iwyu

Bearbeiten 2015-08-19: Der Ansatz mit der CMake Eigenschaft <LANG>_INCLUDE_WHAT_YOU_USE hat nicht funktioniert für mich mit CMake version 3.3.1. Deshalb habe ich aktualisiert, die Lösung.

Bearbeiten 2015-09-30: Die Ausgabe falsch war, da mein gehören-was-Sie-verwenden installation defekt war. Die include-what-you-use und iwyu_tool.py Dateien werden im gleichen Verzeichnis wie clang, clang++ usw.

InformationsquelleAutor Florian Wolters

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.

Läuft das tool manuell

Hinzufügen einer benutzerdefinierten Ziel-zu Ihrem cmake-Projekt

Hinweise