Phát hiện #incin thừa trong C / C ++?

Tôi thường thấy rằng phần tiêu đề của một tập tin ngày càng lớn hơn nhưng nó không bao giờ nhỏ hơn. Trong suốt vòng đời của một lớp tệp nguồn có thể đã di chuyển và được tái cấu trúc và rất có thể có một số ít #includeskhông cần phải ở đó nữa. Để chúng ở đó chỉ kéo dài thời gian biên dịch và thêm các phụ thuộc biên dịch không cần thiết. Cố gắng tìm ra những thứ vẫn cần thiết có thể khá tẻ nhạt.

Có một số loại công cụ có thể phát hiện các chỉ thị #include thừa và đề xuất những công cụ nào tôi có thể gỡ bỏ một cách an toàn không?
Liệu lint làm điều này có thể?

Nó không tự động, nhưng doxygen sẽ tạo sơ đồ phụ thuộc cho #includedcác tệp. Bạn sẽ phải xem qua chúng một cách trực quan, nhưng chúng có thể rất hữu ích để có được một bức tranh về những gì đang sử dụng những gì.

Cppclean của Google (liên kết đến: tải xuống , tài liệu ) có thể tìm thấy một số loại vấn đề về C ++ và giờ đây nó có thể tìm thấy #includes thừa.

Ngoài ra còn có một công cụ dựa trên Clang, bao gồm những gì bạn đang sử dụng , có thể làm điều này. bao gồm những gì bạn đang sử dụng thậm chí có thể đề xuất các khai báo chuyển tiếp (vì vậy bạn không phải #incolee rất nhiều) và tùy ý dọn sạch #inc loại của bạn cho bạn.

Các phiên bản hiện tại của CDT Eclipse cũng có chức năng này được tích hợp sẵn: đi vào menu Nguồn và nhấp vào Sắp xếp bao gồm sẽ sắp xếp thứ tự # bao gồm của bạn, thêm bất kỳ tiêu đề nào mà Eclipse nghĩ rằng bạn đang sử dụng mà không bao gồm trực tiếp chúng và nhận xét bất kỳ tiêu đề nào mà nó không có Tôi nghĩ bạn cần. Tuy nhiên, tính năng này không đáng tin cậy 100%.

Ngoài ra, hãy kiểm tra bao gồm những gì bạn sử dụng , giải quyết vấn đề tương tự.

Vấn đề với việc phát hiện thừa là bao gồm nó không thể chỉ là một trình kiểm tra phụ thuộc loại. Bao gồm không cần thiết là một tệp không cung cấp giá trị gì cho quá trình biên dịch và không làm thay đổi mục khác mà các tệp khác phụ thuộc. Có nhiều cách một tệp tiêu đề có thể thay đổi một trình biên dịch, bằng cách xác định một hằng số, xác định lại và / hoặc xóa một macro được sử dụng, thêm một không gian tên làm thay đổi việc tra cứu tên theo cách nào đó. Để phát hiện các mục như không gian tên bạn cần nhiều hơn một bộ xử lý trước, trên thực tế bạn gần như cần một trình biên dịch đầy đủ.

Lint là một công cụ kiểm tra phong cách và chắc chắn sẽ không có khả năng đầy đủ này.

Tôi nghĩ rằng bạn sẽ tìm thấy cách duy nhất để phát hiện một phần thừa là bao gồm xóa, biên dịch và chạy các bộ.

Tôi nghĩ rằng PCLint sẽ làm điều này, nhưng đã được vài năm kể từ khi tôi nhìn vào nó. Bạn có thể kiểm tra xem nó ra.

Tôi đã xem blog này và tác giả đã nói một chút về việc cấu hình PCLint để tìm thấy bao gồm không sử dụng. Có thể là một giá trị.

Các CScout trình duyệt refactoring có thể phát hiện thừa bao gồm các chỉ thị trong C (tiếc là không C ++) mã. Bạn có thể tìm thấy một mô tả về cách thức hoạt động trong này bài báo.

Bạn có thể viết một tập lệnh nhanh xóa một lệnh #incoide duy nhất, biên dịch các dự án và ghi lại tên trong #include và tệp đã bị xóa trong trường hợp không xảy ra lỗi biên dịch.

Hãy để nó chạy trong đêm và ngày hôm sau bạn sẽ có một danh sách chính xác 100% bao gồm các tệp bạn có thể xóa.

Đôi khi brute-force chỉ hoạt động :-)

chỉnh sửa: và đôi khi nó không :-). Dưới đây là một chút thông tin từ các bình luận:

1. Đôi khi bạn có thể loại bỏ hai tệp tiêu đề riêng biệt, nhưng không phải cả hai cùng nhau. Một giải pháp là loại bỏ các tệp tiêu đề trong quá trình chạy và không đưa chúng trở lại. Điều này sẽ tìm thấy một danh sách các tệp bạn có thể xóa một cách an toàn, mặc dù có thể có một giải pháp với nhiều tệp hơn để loại bỏ thuật toán này sẽ không tìm thấy. (đó là một tìm kiếm tham lam trong không gian bao gồm các tệp để loại bỏ. Nó sẽ chỉ tìm thấy tối đa cục bộ)
2. Có thể có những thay đổi tinh tế trong hành vi nếu bạn có một số macro được định nghĩa lại khác nhau tùy thuộc vào một số #ifdefs. Tôi nghĩ đây là những trường hợp rất hiếm, và Bài kiểm tra đơn vị là một phần của bản dựng nên nắm bắt những thay đổi này.

Xin lỗi để (đăng lại) bài đăng ở đây, mọi người thường không mở rộng bình luận.

Kiểm tra bình luận của tôi để crashmstr, FlexeLint / PC-Lint sẽ làm điều này cho bạn. Thông báo thông tin 766. Mục 11.8.1 trong hướng dẫn của tôi (phiên bản 8.0) thảo luận về điều này.

Ngoài ra, và điều này rất quan trọng, hãy tiếp tục lặp đi lặp lại cho đến khi tin nhắn biến mất . Nói cách khác, sau khi xóa các tiêu đề không được sử dụng, chạy lại lint, nhiều tệp tiêu đề hơn có thể đã trở thành "không cần thiết" khi bạn xóa một số tiêu đề không cần thiết. (Điều đó nghe có vẻ ngớ ngẩn, đọc chậm và phân tích nó, nó có ý nghĩa.)

Tôi chưa bao giờ tìm thấy một công cụ chính thức để thực hiện những gì bạn yêu cầu. Thứ gần nhất tôi đã sử dụng là Bao gồm trình quản lý , biểu đồ cây bao gồm tiêu đề của bạn để bạn có thể phát hiện trực quan những thứ như các tiêu đề chỉ có trong một tệp và các vùi tiêu đề tròn.

Tôi đã thử sử dụng Flexelint (phiên bản unix của PC-Lint) và có kết quả hơi hỗn hợp. Điều này có thể là do tôi đang làm việc trên một cơ sở mã rất lớn và có nhiều nút. Tôi khuyên bạn nên kiểm tra cẩn thận từng tệp được báo cáo là không sử dụng.

Lo lắng chính là dương tính giả. Nhiều bao gồm cùng một tiêu đề được báo cáo là một tiêu đề không cần thiết. Điều này thật tệ vì Flexelint không cho bạn biết dòng tiêu đề được bao gồm trên hoặc nơi nó được bao gồm trước đó.

Một trong những cách mà các công cụ tự động có thể hiểu sai:

Trong A.hpp:

class A { 
  // ...
};

Trong B.hpp:

#include "A.hpp

class B {
    public:
        A foo;
};

Trong 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

Nếu bạn mù quáng theo dõi các tin nhắn từ Flexelint, bạn sẽ làm hỏng # phụ thuộc của bạn. Có nhiều trường hợp bệnh lý hơn, nhưng về cơ bản, bạn sẽ cần phải tự kiểm tra các tiêu đề để có kết quả tốt nhất.

Tôi đánh giá cao bài viết này về Cấu trúc vật lý và C ++ từ blog Trò chơi từ bên trong. Họ đề xuất một cách tiếp cận toàn diện để dọn dẹp mớ hỗn độn #incoide:

Hướng dẫn

Đây là một bộ hướng dẫn được chắt lọc từ cuốn sách của Lakos nhằm giảm thiểu số lượng phụ thuộc vật lý giữa các tệp. Tôi đã sử dụng chúng trong nhiều năm và tôi luôn thực sự hài lòng với kết quả.

1. Mỗi tệp cpp bao gồm tệp tiêu đề của riêng nó đầu tiên. [bắn tỉa]
2. Một tệp tiêu đề phải bao gồm tất cả các tệp tiêu đề cần thiết để phân tích nó. [bắn tỉa]
3. Một tệp tiêu đề nên có số lượng tệp tiêu đề tối thiểu cần thiết để phân tích nó. [bắn tỉa]

Nếu bạn đang sử dụng CDT của Eclipse, bạn có thể thử http://includator.com miễn phí cho những người thử nghiệm beta (tại thời điểm viết bài này) và tự động xóa #includes thừa hoặc thêm những cái còn thiếu. Đối với những người dùng có FlexeLint hoặc PC-Lint và đang sử dụng Elicpse CDT, http://linticator.com có thể là một tùy chọn (cũng miễn phí cho bản thử nghiệm beta). Mặc dù nó sử dụng phân tích của Lint, nhưng nó cung cấp các bản sửa lỗi nhanh để tự động xóa các câu lệnh #include thừa.

Bài viết này giải thích một kỹ thuật loại bỏ #incoide bằng cách sử dụng phân tích cú pháp Doxygen. Đó chỉ là một tập lệnh perl, vì vậy nó khá dễ sử dụng.

Có thể hơi muộn, nhưng tôi đã từng tìm thấy một kịch bản perl WebKit đã làm đúng những gì bạn muốn. Tôi sẽ cần một số điều chỉnh mà tôi tin (tôi không rành về perl), nhưng nó nên thực hiện thủ thuật:

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

(đây là một nhánh cũ vì thân cây không có tệp nữa)

Có một công cụ miễn phí Bao gồm Trình xem phụ thuộc tệp có thể được tích hợp trong phòng thu trực quan. Nó hiển thị #incoles thừa trong màu đỏ.

Có hai loại tệp #incoide thừa:

1. Một tệp tiêu đề thực sự không cần thiết cho mô-đun (.c, .cpp)
2. Một tệp tiêu đề là cần thiết bởi mô-đun nhưng được bao gồm nhiều lần, trực tiếp hoặc gián tiếp.

Có 2 cách theo kinh nghiệm của tôi hoạt động tốt để phát hiện ra nó:

• gcc -H hoặc cl.exe / showincludes (giải quyết vấn đề 2)

  Trong thế giới thực, bạn có thể xuất CFLAGS = -H trước khi thực hiện, nếu tất cả các Makefile không ghi đè các tùy chọn CFLAGS. Hoặc như tôi đã sử dụng, bạn có thể tạo một trình bao bọc cc / g ++ để thêm các tùy chọn -H buộc vào mỗi lệnh gọi $ (CC) và $ (CXX). và thêm thư mục của trình bao bọc vào biến $ PATH, thay vào đó, make của bạn sẽ sử dụng lệnh trình bao bọc thay thế. Tất nhiên trình bao bọc của bạn sẽ gọi trình biên dịch gcc thực sự. Thủ thuật này cần thay đổi nếu Makefile của bạn sử dụng gcc trực tiếp. thay vì $ (CC) hoặc $ (CXX) hoặc theo quy tắc ngụ ý.

  Bạn cũng có thể biên dịch một tệp bằng cách điều chỉnh với dòng lệnh. Nhưng nếu bạn muốn làm sạch tiêu đề cho toàn bộ dự án. Bạn có thể nắm bắt tất cả đầu ra bằng cách:

  Làm sạch

  thực hiện 2> & 1 | kết quả tee

• PC-Lint / FlexeLint (giải quyết vấn đề cả 1 và 2)

  đảm bảo thêm các tùy chọn + e766, cảnh báo này là về: các tệp tiêu đề không được sử dụng.

  pclint / đá lửa -vf ...

  Điều này sẽ gây ra các tệp tiêu đề bao gồm đầu ra pclint, các tệp tiêu đề lồng nhau sẽ được thụt lề một cách thích hợp.

Để kết thúc cuộc thảo luận này: bộ tiền xử lý c ++ đã hoàn tất. Nó là một tài sản ngữ nghĩa, cho dù bao gồm là không cần thiết. Do đó, theo định lý của Rice rằng không thể xác định được liệu bao gồm có thừa hay không. Không thể có một chương trình, mà (luôn luôn chính xác) phát hiện xem một bao gồm có thừa hay không.

Dưới đây là một cách đơn giản để xác định tiêu đề thừa bao gồm . Nó không hoàn hảo nhưng loại bỏ "rõ ràng" không cần thiết bao gồm. Loại bỏ những thứ này đi một chặng đường dài trong việc làm sạch mã.

Các tập lệnh có thể được truy cập trực tiếp trên GitHub.

PC Lint của Gimpel Software có thể báo cáo khi một tệp bao gồm đã được đưa vào nhiều lần trong một đơn vị biên dịch , nhưng nó không thể tìm thấy các tệp không cần thiết theo cách bạn đang tìm kiếm.

Chỉnh sửa: Nó có thể. Xem câu trả lời của nó

CLion , IDE C / C ++ của JetBrains, phát hiện dự phòng bao gồm cả ngoài hộp. Đây là các màu xám trong trình chỉnh sửa, nhưng cũng có các chức năng để tối ưu hóa bao gồm trong tệp hiện tại hoặc toàn bộ dự án .

Tôi đã thấy rằng bạn trả tiền cho chức năng này mặc dù; CLion mất một thời gian để quét và phân tích dự án của bạn khi được tải lần đầu tiên.