C / C ++ 'daki gereksiz # tespitler?

Sık sık bir dosyanın üstbilgiler bölümünün her zaman büyüyüp büyüdüğünü ancak hiçbir zaman küçülmediğini görüyorum. Bir kaynak dosya ömrü boyunca sınıflar taşınmış ve yeniden düzenlenmiş olabilir ve #includesorada ve artık olması gerekmeyen oldukça az sayıda olması mümkündür . Onları orada bırakmak sadece derleme süresini uzatır ve gereksiz derleme bağımlılıkları ekler. Hangisinin hala gerekli olduğunu anlamaya çalışmak oldukça sıkıcı olabilir.

Gereksiz #include yönergelerini algılayabilen ve hangilerini güvenle kaldırabileceğimi önerebilen bir tür araç var mı?
Tüysüz bunu yapabilir mi?

Otomatik değil, ancak doxygen#included dosyalar için bağımlılık diyagramları üretecektir . Onları görsel olarak gözden geçirmeniz gerekecek, ancak neyi kullandığını gösteren bir resim elde etmek için çok yararlı olabilirler.

Google'ın cppclean (bağlantılar: indirmek , dokümantasyon ) C ++ sorunların birkaç kategori bulabilirsiniz ve artık gereksiz #includes bulabilirsiniz.

Bir Clang tabanlı aracı da yok, dahil-ne-sen kullanımlık yapabilmesidir. ne kullandığınızı içermek, ileri bildirimler bile önerebilir (bu nedenle #incit eklemeniz gerekmez) ve isteğe bağlı olarak #includes'inizi sizin için temizleyebilirsiniz.

Eclipse CDT'nin şu anki sürümleri de bu işlevselliğe sahiptir: Kaynak menüsünün altına girip İçerir Düzenle'yi tıklamak # içerdiklerinizi alfabetik hale getirecek, Eclipse'nin doğrudan dahil etmeden kullandığınızı düşündüğü başlıkları ekleyecek ve içermediği başlıkları yorumlayacaktır. ihtiyacın olduğunu düşünmüyorum. Ancak bu özellik% 100 güvenilir değildir.

Ayrıca , benzer bir sorunu çözen ne kullandığınızı da ekleyin .

Gereksiz içeriklerin algılanmasındaki sorun, sadece bir tür bağımlılık denetleyicisi olamamasıdır. Gereksiz bir ekleme, derlemeye hiçbir değer sağlamayan ve diğer dosyaların bağımlı olduğu başka bir öğeyi değiştirmeyen bir dosyadır . Başlık dosyasının bir derlemeyi değiştirmesinin birçok yolu vardır, örneğin bir sabit tanımlayarak, kullanılmış bir makroyu yeniden tanımlayarak ve / veya silerek, adın aramasını bir şekilde aşağıya doğru değiştiren bir ad alanı ekleyerek. Ad alanı gibi öğeleri algılamak için bir ön işlemciden çok daha fazlasına ihtiyacınız var, aslında neredeyse tam bir derleyiciye ihtiyacınız var.

Lint daha çok bir stil denetleyicisidir ve kesinlikle bu tam kapasiteye sahip olmayacaktır.

Bence gereksiz bir eklentiyi tespit etmenin tek yolunu suitleri kaldırmak, derlemek ve çalıştırmaktır.

PCLint'in bunu yapacağını düşündüm , ama bakmamın üzerinden birkaç yıl geçti. Kontrol edebilirsin.

Bu bloga baktım ve yazar, PCLint'i kullanılmayan içerikleri bulmak için yapılandırma hakkında biraz konuştu. Bir göz atmaya değer olabilir.

CScout yeniden düzenleme tarayıcı gereksiz C (ne yazık ki değil C ++) kodu yönergeleri içermesi algılayabilir. Bu dergi makalesinde nasıl çalıştığına dair bir açıklama bulabilirsiniz .

Tek bir #include yönergesini silen, projeleri derleyen ve #include içindeki adı günlüğe kaydeden ve derleme hatalarının oluşmaması durumunda kaldırıldığı dosyayı hızlı bir komut dosyası yazabilirsiniz.

Gece boyunca çalışmasına izin verin ve ertesi gün kaldırabileceğiniz% 100 doğru dosya listesine sahip olacaksınız.

Bazen kaba kuvvet sadece çalışır :-)

edit: ve bazen değil :-). İşte yorumlardan biraz bilgi:

1. Bazen iki başlık dosyasını ayrı olarak kaldırabilirsiniz, ancak ikisini birlikte kaldıramazsınız. Çözüm, çalışma sırasında başlık dosyalarını kaldırmak ve geri getirmektir. Bu, güvenli bir şekilde kaldırabileceğiniz dosyaların bir listesini bulur, ancak bu algoritmanın bulamayacağı daha fazla dosya içeren bir çözüm olabilir. (kaldırılacak dosyaları dahil etme alanı üzerinde açgözlü bir arama.
2. Bazı #ifdef'lere bağlı olarak farklı şekilde yeniden tanımlanmış bazı makrolarınız varsa, davranışta küçük değişiklikler olabilir. Bence bunlar çok nadir vakalardır ve yapının bir parçası olan Birim Testleri bu değişiklikleri yakalamalıdır.

Buraya gönderi yaptığım için üzgünüm, insanlar genellikle yorumları genişletmiyor.

Crashmstr hakkındaki yorumumu kontrol edin, FlexeLint / PC-Lint bunu sizin için yapacak. Bilgilendirici mesaj 766. Kılavuzumun 11.8.1 bölümü (sürüm 8.0) bunu tartışıyor.

Ayrıca, bu önemlidir, mesaj kaybolana kadar yinelemeye devam edin . Başka bir deyişle, kullanılmayan üstbilgileri kaldırdıktan sonra tiftiği yeniden çalıştırın, bazı gereksiz üstbilgileri kaldırdığınızda daha fazla üstbilgi dosyası "gereksiz" olabilir. (Aptalca gelebilir, yavaşça okuyabilir ve ayrıştırabilir, mantıklı olabilir.)

Sorduğunuz şeyi başaran tam teşekküllü bir araç bulamadım. Kullandığım en yakın şey , başlık içerme ağacınızı grafik haline getiren IncludeManager , böylece yalnızca tek bir dosyada yer alan üstbilgiler ve dairesel başlık eklemelerini görsel olarak tespit edebilirsiniz.

Flexelint'i (PC-Lint'in unix sürümü) kullanmayı denedim ve biraz karışık sonuçlar aldım. Bu muhtemelen çok büyük ve düğümlü bir kod tabanı üzerinde çalışıyorum çünkü. Kullanılmadığı bildirilen her dosyayı dikkatlice incelemenizi öneririz.

Ana endişe yanlış pozitiftir. Aynı üstbilginin birden fazla eklenmesi gereksiz bir üstbilgi olarak bildirilir. Flexelint, başlığın hangi satıra dahil edildiğini veya daha önce nereye dahil edildiğini size söylemediğinden bu durum kötüdür.

Otomatik araçların bunu yanlış yapmasının yollarından biri:

A.hpp'de:

class A { 
  // ...
};

B.hpp'de:

#include "A.hpp

class B {
    public:
        A foo;
};

C.cpp'de:

#include "C.hpp"  

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

Flexelint'in mesajlarını körü körüne takip ederseniz #include bağımlılıklarınızı boğacaksınız. Daha fazla patolojik vaka var, ancak temel olarak en iyi sonuçlar için başlıkları kendiniz kontrol etmeniz gerekecek.

İçeriden Blog Oyunları'ndan Fiziksel Yapı ve C ++ ile ilgili bu makaleyi tavsiye ederim . #İnclude karmaşasını temizlemek için kapsamlı bir yaklaşım öneriyorlar:

Kuralları

İşte Lakos'un kitabından, dosyalar arasındaki fiziksel bağımlılıkların sayısını en aza indiren, damıtılmış bir kılavuz seti. Onları yıllardır kullanıyorum ve sonuçlardan hep çok memnun kaldım.

1. Her cpp dosyası önce kendi başlık dosyasını içerir. [Kesik]
2. Başlık dosyası, ayrıştırmak için gerekli tüm başlık dosyalarını içermelidir. [Kesik]
3. Bir üstbilgi dosyası, ayrıştırmak için gereken en az sayıda üstbilgi dosyasına sahip olmalıdır. [Kesik]

Eclipse CDT kullanıyorsanız deneyebileceğiniz http://includator.com (bu yazının yazıldığı anda) beta test için ücretsizdir ve otomatik gereksiz #includes kaldırır veya eksik olanları ekler hangi. FlexeLint veya PC-Lint'e sahip olan ve Elicpse CDT kullanan kullanıcılar için http://linticator.com bir seçenek olabilir (beta testi için de ücretsiz). Lint'in analizini kullanırken, gereksiz #include ifadelerini otomatik olarak kaldırmak için hızlı düzeltmeler sağlar.

Bu makalede , # okslude'un Doxygen çözümlemesini kullanarak kaldırma tekniğini açıklamaktadır. Bu sadece bir perl betiği, bu yüzden kullanımı oldukça kolay.

Belki biraz geç, ama bir keresinde tam olarak ne istediğini yapan bir WebKit perl betiği buldum. İnandığım bazı uyarlamalara ihtiyaç duyacak (perl'de iyi değilim), ancak hile yapmalı:

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

(bu eski bir dal çünkü bagajda artık dosya yok)

Görsel stüdyoya entegre edilebilen Dosya Bağımlılıkları İzleyicisi'ni içeren ücretsiz bir araç var . Kırmızı ile gereksiz #includes gösterir.

İki tür gereksiz #include dosyası vardır:

1. Modül (.c, .cpp) tarafından gerçekten gerekli olmayan bir başlık dosyası
2. Bir başlık dosyası modül tarafından gereklidir, ancak birden fazla, doğrudan veya dolaylı olarak dahil edilir.

Deneyimlerimde, bunu tespit etmek için iyi çalışan 2 yol var:

• gcc -H veya cl.exe / showincludes (2. sorunu çözün)

  Gerçek dünyada, eğer Makefile'in tümü CFLAGS seçeneklerini geçersiz kılmazsa, CFLAGS = -H yapmadan önce dışa aktarabilirsiniz. Ya da kullandığım gibi, her $ (CC) ve $ (CXX) çağrısına zorla -H seçenekleri eklemek için bir cc / g ++ sarmalayıcısı oluşturabilirsiniz. ve sarmalayıcı dizinini $ PATH değişkenine ekleyin, ardından make'iniz size wrapper komutunu kullanır. Tabii ki ambalajınız gerçek gcc derleyicisini çağırmalıdır. Makefile'niz doğrudan gcc kullanıyorsa bu hilelerin değişmesi gerekir. $ (CC) veya $ (CXX) yerine veya zımni kurallara göre.

  Komut satırıyla ayarlayarak tek bir dosyayı da derleyebilirsiniz. Ancak tüm proje için başlıkları temizlemek istiyorsanız. Tüm çıktıları şu yollarla yakalayabilirsiniz:

  temizle

  marka 2> & 1 | tee sonuç.txt

• PC-Lint / FlexeLint (sorunu hem 1 hem de 2'de çözün)

  + e766 seçeneklerini eklediğinizden emin olun, bu uyarı aşağıdakilerle ilgilidir: kullanılmayan başlık dosyaları.

  pclint / flint -vf ...

  Bu pclint çıktı başlık dosyaları dahil neden olacak, iç içe başlık dosyaları uygun girintili olacaktır.

Bu tartışmayı sonlandırmak için: c ++ önişlemcisi tamamlanıyor. İçermenin gereksiz olup olmadığı anlamsal bir özelliktir. Bu nedenle, Rice'ın teoreminden, bir içerme işleminin gereksiz olup olmadığı kararsızdır. Bir içerme gereksizdir (her zaman doğru) bir program olamaz.

İşte gereksiz başlık tanımlamak için basit bir kaba kuvvet yolu . Mükemmel değil ama "açık" gereksiz içerir ortadan kaldırır. Bunlardan kurtulmak kodu temizlemede uzun bir yol kat ediyor.

Komut GitHub'dan doğrudan ulaşılabilir.

Gimpel Yazılımları PC Lint'i , bir ekleme dosyasının bir derleme birimine birden çok kez dahil edildiğini bildirebilir , ancak aradığınız şekilde gerekli olmayan dosyaları içeremez.

Düzenleme: Olabilir. Mattinin cevabını görün

JetBrains'den C / C ++ IDE olan CLion , kutudan çıktığı gibi gereksiz içeriklerin bulunduğunu algılar. Bunlar düzenleyicide grileşir, ancak geçerli dosyadaki veya tüm projedeki eklemeleri optimize etme işlevleri de vardır .

Bu işlevsellik için ödeme yaptığınızı gördüm; CLion, ilk yüklendiğinde projenizi taramak ve analiz etmek için biraz zaman alır.