C / C ++에서 불필요한 #include를 감지합니까?

종종 파일의 헤더 섹션이 항상 커지고 커지지 만 결코 작아지지는 않습니다. 소스 파일의 수명 동안 클래스는 이동하고 리팩토링되었을 #includes수 있으며, 더 이상 필요하지 않은 클래스가있을 가능성이 매우 높습니다 . 그것들을 그대로두면 컴파일 시간이 길어지고 불필요한 컴파일 종속성이 추가됩니다. 여전히 필요한 것이 무엇인지 파악하는 것은 매우 지루할 수 있습니다.

불필요한 #include 지시문을 감지하고 안전하게 제거 할 수있는 명령을 제안 할 수있는 도구가 있습니까?
보풀이이 작업을 수행합니까?

자동은 아니지만 doxygen 은 #included파일에 대한 종속성 다이어그램을 생성 합니다. 시각적으로 살펴 봐야하지만 무엇을 사용하고 있는지에 대한 그림을 얻는 데 매우 유용 할 수 있습니다.

Google의 cppclean (links : download , documentation )은 여러 범주의 C ++ 문제를 찾을 수 있으며 이제 불필요한 #include를 찾을 수 있습니다.

Clang 기반 도구 인 include-what-you-use 도 있습니다. include-what-you-use는 포워드 선언을 제안하고 (따라서 #include하지 않아도 됨) 선택적으로 #include를 정리합니다.

현재 버전의 Eclipse CDT 에는이 기능이 내장되어 있습니다. 소스 메뉴에서 포함 구성을 클릭하면 #include를 알파벳순으로 표시하고 Eclipse가 직접 포함하지 않고 사용한다고 생각하는 헤더를 추가하고 포함하지 않은 헤더는 주석 처리합니다 당신이 필요하다고 생각하지 않습니다. 그러나이 기능은 100 % 신뢰할 수 없습니다.

또한 include-what-you-use 를 확인하여 비슷한 문제를 해결하십시오.

불필요한 포함을 감지하는 데있어 문제점은 유형 종속성 검사기가 될 수 없다는 것입니다. 포함 불필요한이 편집에 가치의 아무것도 제공하지 않는 파일 및 다른 파일이 의존하는 다른 항목을 변경하지 않습니다. 헤더 파일이 컴파일을 변경하는 방법에는 여러 가지가 있습니다. 예를 들어, 상수를 정의하고, 사용 된 매크로를 재정의 및 / 또는 삭제하고, 네임 스페이스를 추가하여 이름의 조회를 줄 아래로 변경하는 등의 방법이 있습니다. 네임 스페이스와 같은 항목을 탐지하려면 전 처리기보다 훨씬 더 많은 것이 필요하므로 실제로는 완전한 컴파일러가 거의 필요합니다.

Lint는 더 많은 스타일 검사기이며이 기능을 완전히 갖추고 있지는 않습니다.

불필요한 포함을 감지하는 유일한 방법은 제품군을 제거, 컴파일 및 실행하는 것입니다.

나는 PCLint 가 이것을 할 것이라고 생각 했지만, 그것을 본 지 몇 년이 지났다 . 당신은 그것을 확인할 수 있습니다.

나는 쳐다 보면서 이 블로그 와 저자가 사용되지 않는 포함 찾을 PCLint 구성에 대한 조금 이야기했다. 살펴볼 가치가 있습니다.

CScout의 리팩토링 브라우저 불필요한은 C (불행히도 C ++) 코드의 지시를 포함 감지 할 수 있습니다. 이 저널 기사 에서 작동 방식에 대한 설명을 찾을 수 있습니다 .

단일 #include 지시문을 지우고 프로젝트를 컴파일하고 컴파일 오류가 발생하지 않은 경우 제거 된 파일과 #include에 이름을 기록하는 빠른 스크립트를 작성할 수 있습니다.

밤 중에 실행되도록하고 다음 날에는 제거 할 수있는 포함 파일의 100 % 올바른 목록이 표시됩니다.

때로는 무차별 강제 작동 :-)

편집 : 때로는 그렇지 않습니다 :-). 주석의 정보는 다음과 같습니다.

1. 때로는 두 개의 헤더 파일을 개별적으로 제거 할 수 있지만 둘 다 제거 할 수는 없습니다. 해결책은 실행 중에 헤더 파일을 제거하고 다시 가져 오지 않는 것입니다. 이 알고리즘으로 찾을 수없는 파일이 더 많은 솔루션이있을 수 있지만 안전하게 제거 할 수있는 파일 목록을 찾을 수 있습니다. (제거 할 포함 파일 공간에 대한 욕심 많은 검색입니다. 로컬 최대 값 만 찾습니다)
2. 일부 #ifdef에 따라 일부 매크로가 다르게 재정의되면 동작에 미묘한 변화가있을 수 있습니다. 나는 이것이 매우 드문 경우라고 생각하며 빌드의 일부인 단위 테스트는 이러한 변화를 포착해야합니다.

여기에 (다시) 게시하여 죄송합니다. 사람들은 종종 댓글을 확장하지 않습니다.

crashmstr에 대한 내 의견을 확인하십시오. FlexeLint / PC-Lint 가이 작업을 수행합니다. 정보 메시지 766. 내 설명서 (버전 8.0)의 11.8.1 절에서 이에 대해 설명합니다.

또한 이것은 중요하며 메시지가 사라질 때까지 반복하십시오 . 즉, 사용하지 않는 헤더를 제거한 후 보푸라기를 다시 실행하면 불필요한 헤더를 제거하면 더 많은 헤더 파일이 "필요하지 않은"것일 수 있습니다. (이것은 어리석은 소리, 천천히 읽고 해석하는 것이 합리적입니다.)

나는 당신이 요구하는 것을 성취하는 본격적인 도구를 찾지 못했습니다. 내가 사용한 가장 가까운 것은 IncludeManager입니다 . 헤더 포함 트리를 그래프로 표시하여 하나의 파일에 포함 된 헤더와 원형 헤더 포함을 시각적으로 볼 수 있습니다.

Flexelint (Unix 버전의 PC-Lint)를 사용해 보았지만 결과가 약간 다릅니다. 이것은 매우 크고 코드가 많은 코드 기반으로 작업하고 있기 때문일 수 있습니다. 사용하지 않은 것으로보고 된 각 파일을주의 깊게 검사하는 것이 좋습니다.

가장 큰 걱정은 오 탐지입니다. 동일한 헤더의 여러 포함이 불필요한 헤더로보고됩니다. Flexelint가 헤더가 포함 된 행 또는 이전에 포함 된 행을 알려주지 않기 때문에 이것은 나쁩니다.

자동화 된 도구가이를 잘못 해결할 수있는 방법 중 하나 :

A.hpp에서 :

class A { 
  // ...
};

B.hpp에서 :

#include "A.hpp

class B {
    public:
        A foo;
};

C.cpp에서 :

#include "C.hpp"  

#include "B.hpp"  // <-- Unneeded, but lint reports it as needed
#include "A.hpp"  // <-- Needed, but lint reports it as unneeded

Flexelint의 메시지를 맹목적으로 따르는 경우 #include 종속성이 막힙니다. 더 많은 병리학 적 사례가 있지만 기본적으로 최상의 결과를 얻으려면 헤더를 직접 검사해야합니다.

게임 내 블로그에서 실제 구조 및 C ++ 에 대한이 기사를 적극 권장합니다 . #include 혼란을 정리하기위한 포괄적 인 접근 방식을 권장합니다.

지침

다음은 파일 간의 물리적 종속성 수를 최소화하는 Lakos의 책에서 나온 일련의 지침입니다. 나는 수년 동안 그것들을 사용해 왔으며 항상 결과에 정말 만족했습니다.

1. 모든 cpp 파일은 먼저 자체 헤더 파일을 포함합니다. [한조각]
2. 헤더 파일에는 구문 분석에 필요한 모든 헤더 파일이 포함되어야합니다. [한조각]
3. 헤더 파일에는 구문 분석에 필요한 최소한의 헤더 파일 수가 있어야합니다. [한조각]

Eclipse CDT를 사용하는 경우 http://includator.com 을 사용하여 베타 테스터에게 무료로 제공 할 수 있으며 (이 글을 쓰는 시점에) 무료 #include를 포함하거나 누락 된 것을 자동으로 제거합니다. FlexeLint 또는 PC-Lint를 사용하고 Elicpse CDT를 사용하는 사용자의 경우 http://linticator.com 이 옵션 일 수 있습니다 (베타 테스트는 무료). Lint의 분석을 사용하지만 불필요한 #include 문을 자동으로 제거하기위한 빠른 수정 사항을 제공합니다.

이 기사에서는 Doxygen의 구문 분석을 사용하여 #include 제거 기술에 대해 설명합니다. 펄 스크립트 일 뿐이므로 사용하기가 매우 쉽습니다.

어쩌면 조금 늦었지만 한 번은 WebKit perl 스크립트를 찾았습니다. 내가 믿는 약간의 적응이 필요하지만 (나는 펄에 정통하지 않다), 트릭을 수행해야한다.

http://trac.webkit.org/browser/branches/old/safari-3-2-branch/WebKitTools/Scripts/find-extra-includes

(이것은 트렁크에 더 이상 파일이 없기 때문에 오래된 지점입니다)

Visual Studio에 통합 할 수 있는 무료 도구 Include File Dependencies Watcher 가 있습니다. 불필요한 #include를 빨간색으로 표시합니다.

불필요한 #include 파일에는 두 가지 유형이 있습니다.

1. 실제로 모듈 (.c, .cpp)에 필요하지 않은 헤더 파일
2. 헤더 파일은 모듈에 필요하지만 두 번 이상, 직접 또는 간접적으로 포함됩니다.

내 경험에는 그것을 감지하는 데 잘 작동하는 두 가지 방법이 있습니다.

• gcc -H 또는 cl.exe / showincludes (문제 2 해결)

  실제로는 모든 Makefile이 CFLAGS 옵션을 무시하지 않는 경우 만들기 전에 CFLAGS = -H를 내보낼 수 있습니다. 또는 내가 사용한 것처럼 cc / g ++ 래퍼를 만들어 $ (CC) 및 $ (CXX)를 호출 할 때마다 -H 옵션을 강제로 추가 할 수 있습니다. 래퍼의 디렉토리를 $ PATH 변수 앞에 추가하면 make가 대신 래퍼 명령을 대신 사용합니다. 물론 래퍼는 실제 gcc 컴파일러를 호출해야합니다. Makefile이 gcc를 직접 사용하는 경우이 트릭을 변경해야합니다. $ (CC) 또는 $ (CXX) 대신 또는 묵시적 규칙.

  명령 행을 조정하여 단일 파일을 컴파일 할 수도 있습니다. 그러나 전체 프로젝트의 헤더를 정리하려면 다음을 통해 모든 출력을 캡처 할 수 있습니다.

  깨끗하게하다

  2> & 1 | 티 result.txt

• PC-Lint / FlexeLint (1과 2의 문제 해결)

  + e766 옵션을 추가하십시오.이 경고는 사용되지 않은 헤더 파일입니다.

  pclint / 플린트 -vf ...

  이로 인해 pclint 출력에 헤더 파일이 포함되고 중첩 된 헤더 파일이 적절히 들여 쓰기됩니다.

이 논의를 끝내기 위해 : c ++ 전처리 기가 완전히 작동합니다. 포함이 불필요한 지 여부는 의미 적 특성입니다. 따라서 쌀의 정리에 따르면 포함이 불필요한 지 여부를 결정할 수 없습니다. 포함이 불필요한 지 여부를 항상 감지하는 프로그램은있을 수 없습니다.

여기에 불필요한 헤더 포함을 식별 하는 간단한 무차별 강제 방법이 있습니다 . 완벽하지는 않지만 "분명한"불필요한 포함을 제거합니다. 이것을 제거하는 것은 코드 정리에 먼 길을 간다.

스크립트는 GitHub의에 직접 액세스 할 수 있습니다.

Gimpel Software의 PC Lint 는 포함 파일이 컴파일 장치에 두 번 이상 포함 된 경우보고 할 수 있지만 원하는 방식으로 필요하지 않은 포함 파일을 찾을 수 없습니다.

편집 : 가능합니다. 참조 itsmatt의 답변을

JetBrains의 C / C ++ IDE 인 CLion 은 기본 제공 중복을 감지합니다. 이들은 편집기에서 회색으로 표시되지만 현재 파일 또는 전체 프로젝트에서 포함 을 최적화하는 기능도 있습니다 .

이 기능에 대한 비용을 지불 한 것으로 나타났습니다. CLion은 처음로드 할 때 프로젝트를 스캔하고 분석하는 데 시간이 걸립니다.