CMake PUBLIC, PRIVATE und INTERFACE: Abhängigkeitsumfang reparieren, ohne globale Flags zu setzen

Worum es geht

target_link_libraries von CMake drückt mit seinen Geltungsbereichen unterschiedliche Beziehungen aus. PUBLIC verlinkt eine Abhängigkeit und macht sie über das Link-Interface sichtbar; PRIVATE verlinkt sie, ohne sie zu einem gewöhnlichen öffentlichen Interface-Eintrag zu machen; INTERFACE macht die Abhängigkeit sichtbar, ohne das aktuelle Target selbst zu verlinken. Der Vertrag des Targets sollte die Wahl leiten, nicht die Frage, ob ein lokaler Build zufällig durchläuft. CMake target_link_libraries

Warum es wichtig ist

Ein Agent könnte verzeichnisweite Flags hinzufügen, bis ein Compilerfehler verschwindet. Das erschwert es, festzustellen, welches Target die Abhängigkeit tatsächlich benötigt. Bei einer Bibliothek, die einen Drittanbietertyp in einem öffentlichen Header offenlegt, verdienen die Anforderungen der konsumierenden Seite eine explizite Prüfung. Eine nur innerhalb des Implementierungscodes verwendete Abhängigkeit wirft eine andere Frage auf.

So wird es angewendet

• Die öffentlichen Header lesen und jeden benötigten Drittanbietertyp, jedes Makro und jeden Include auflisten. Nur für die Implementierung benötigte Abhängigkeiten getrennt auflisten.
• Das importierte Target der Abhängigkeit und die Link-Deklaration des aktuellen Targets prüfen. Den vom Projekt bereitgestellten Target-Vertrag dem manuellen Kopieren von Include-Pfaden und Compiler-Optionen vorziehen.
• Einen minimalen Konsumenten bauen, der einen öffentlichen Header einbindet und nur die zu prüfende Bibliothek verlinkt. Diese Testvorrichtung ausserhalb von Verzeichnissen platzieren, die versehentlich globale Einstellungen liefern könnten.
• Für eine nur zur Implementierung gehörende Abhängigkeit sowohl statische als auch dynamische Builds vorschlagen, sofern das Projekt sie unterstützt. Den entstehenden Link-Befehl prüfen, statt ihn allein aus dem Geltungsbereichswort abzuleiten.
• Den temporären globalen Workaround entfernen und anschliessend die gewöhnliche Anwendung sowie den minimalen Konsumenten prüfen. Die Begründung der Abhängigkeit neben der Target-Deklaration festhalten.

Stolpersteine

PRIVATE rechtfertigt nicht das Versprechen, dass Konsumierende einer statischen Bibliothek nie eine Abhängigkeit in ihrem endgültigen Link-Befehl sehen werden. Statisches Linken bringt zusätzliche transitive Anforderungen mit sich. Umgekehrt weitet es den Konsumentenvertrag unnötig aus, alles auf PUBLIC zu setzen. Dieser Artikel schlägt ein Prüfverfahren vor; er beansprucht nicht, ein bestimmtes Paket oder eine exportierte Konfiguration getestet zu haben.