CMake target_include_directories significato dell'ambito

Qual è il significato della parola chiave PUBLIC, PRIVATEe INTERFACErelativi a CMake di target_include_directories?

Queste parole chiave vengono utilizzate per sapere quando è necessario l'elenco delle directory di inclusione che stai passando alla destinazione. Entro quando , significa che sono necessarie quelle directory di inclusione:

• Per compilare quell'obiettivo stesso.
• Per compilare altri target che dipendono da quel target (come l'utilizzo delle sue intestazioni pubbliche).
• In entrambe le situazioni di cui sopra.

Quando CMake sta compilando un target, utilizza gli obiettivi INCLUDE_DIRECTORIES, COMPILE_DEFINITIONSe COMPILE_OPTIONSle proprietà. Quando si utilizza la PRIVATEparola chiave in target_include_directories()e simili, si dice a CMake di popolare quelle proprietà di destinazione.

Quando CMake rileva una dipendenza tra una destinazione A e un'altra destinazione B (come quando si utilizza il target_link_libraries(A B)comando), propaga in modo transitorio i B requisiti di utilizzo alla Adestinazione. Tali requisiti di utilizzo di destinazione sono le directory di inclusione, le definizioni di compilazione, ecc. Che qualsiasi obiettivo da cui dipende Bdeve soddisfare. Sono specificati dalla INTERFACE_*versione delle proprietà sopra elencate (come INTERFACE_INCLUDE_DIRECTORIES) e vengono popolati utilizzando la INTERFACEparola chiave quando si chiamano i target_*()comandi.

La PUBLICparola chiave significa approssimativamente PRIVATE + INTERFACE.

Supponiamo quindi di creare una libreria Ache utilizzi alcune intestazioni Boost. Faresti:

• target_include_directories(A PRIVATE ${Boost_INCLUDE_DIRS})se usi solo quelle intestazioni Boost all'interno dei tuoi file sorgente ( .cpp) o file di intestazione privati ​​( .h).
• target_include_directories(A INTERFACE ${Boost_INCLUDE_DIRS})se non usi queste intestazioni Boost all'interno dei tuoi file sorgente (quindi, non è necessario che vengano compilate A). Non riesco a pensare a un esempio del mondo reale per questo.
• target_include_directories(A PUBLIC ${Boost_INCLUDE_DIRS})se usi queste intestazioni Boost nei tuoi file di intestazione pubblici, che sono inclusi ENTRAMBI in alcuni Afile sorgente di e potrebbero anche essere inclusi in qualsiasi altro client della tua Alibreria.

La documentazione di CMake 3.0 contiene maggiori dettagli su questa specifica di build e sulle proprietà dei requisiti di utilizzo .

Le parole chiave INTERFACE, PUBLIC e PRIVATE sono necessarie per specificare l'ambito dei seguenti argomenti. Gli elementi PRIVATE e PUBLIC popoleranno la proprietà INCLUDE_DIRECTORIES di <target>. Gli elementi PUBLIC e INTERFACE popoleranno la proprietà INTERFACE_INCLUDE_DIRECTORIES di <target>. I seguenti argomenti specificano le directory include.

Dalla documentazione: http://www.cmake.org/cmake/help/v3.0/command/target_include_directories.html

Per riformulare la documentazione con parole mie:

• si desidera aggiungere una directory all'elenco di directory di inclusione per una destinazione
• con PRIVATE la directory viene aggiunta alle directory include del target
• con INTERFACE il target non viene modificato, ma INTERFACE_INCLUDE_DIRECTORIES viene esteso dalla directory. La variabile è un elenco di directory di inclusione pubbliche per una libreria.
• con PUBLIC vengono eseguite sia le azioni da PRIVATO che da INTERFACCIA.