Progetti CMake in Visual Studio

CMake è uno strumento open source multipiattaforma per definire i processi di compilazione eseguiti su più piattaforme. Questo articolo presuppone che si abbia familiarità con CMake. Per altre informazioni su CMake, vedere la documentazione di CMake. L'esercitazione su CMake è un buon punto di partenza per altre informazioni.

Nota

CMake è diventato sempre più integrato con Visual Studio nelle ultime versioni. Per visualizzare la documentazione relativa alla versione preferita di Visual Studio, usare il controllo selettore della versione . Si trova nella parte superiore del sommario in questa pagina.

Il supporto nativo di Visual Studio per CMake consente di modificare, compilare ed eseguire il debug di progetti CMake in Windows, il sottosistema Windows per Linux (WSL) e i sistemi remoti dalla stessa istanza di Visual Studio. I file di progetto CMake (ad esempio CMakeLists.txt) vengono usati direttamente da Visual Studio ai fini di IntelliSense e dell'esplorazione. cmake.exe viene richiamato direttamente dalla configurazione e dalla compilazione di Visual Studio per CMake.

Installazione

Gli strumenti CMake C++ per Windows vengono installati come parte dello sviluppo di applicazioni desktop con C++ e Sviluppo Linux con carichi di lavoro C++ . Entrambi gli strumenti CMake C++ per lo sviluppo di Windows e Linux con C++ sono necessari per lo sviluppo CMake multipiattaforma.

Nel programma di installazione è selezionato l'elenco a discesa Sviluppo di applicazioni desktop con C più più C e C Make tools for Windows.

Per altre informazioni, vedere Installare il carico di lavoro Linux C++ in Visual Studio.

Integrazione con l'IDE

Quando si apre una cartella contenente un CMakeLists.txt file, vengono eseguite le operazioni seguenti.

La finestra di dialogo offre queste opzioni: clonare un repository, aprire un progetto o una soluzione, aprire una cartella locale o creare un nuovo progetto. Aprire una cartella locale è evidenziata nello screenshot.

• Visual Studio aggiunge elementi CMake al menu Progetto , con comandi per la visualizzazione e la modifica degli script CMake.

• Il Esplora soluzioni visualizza la struttura e i file delle cartelle.

• Visual Studio esegue CMake e genera il file della cache CMake (CMakeCache.txt) per la configurazione predefinita. La riga di comando di CMake viene visualizzata nella finestra di output, insieme ad altri output di CMake.

• In background, Visual Studio inizia a indicizzare i file sorgente per abilitare IntelliSense, le informazioni di navigazione, il refactoring e così via. Mentre si lavora, Visual Studio esegue il monitoraggio delle modifiche nell'editor e anche sul disco per mantenere l'indice sincronizzato con le sorgenti.

Nota

A partire da Visual Studio 2022 versione 17.1 Preview 2, se il livello CMakeLists.txt principale esiste in una sottocartella e non nella radice dell'area di lavoro, verrà richiesto se si vuole abilitare o meno l'integrazione di CMake. Per altre informazioni, vedere Attivazione parziale di CMake.

Una volta completata la generazione della cache CMake, è anche possibile visualizzare i progetti organizzati logicamente in base alle destinazioni. Scegliere il pulsante Seleziona visualizzazione sulla barra degli strumenti Esplora soluzioni. Nell'elenco in Esplora soluzioni - Visualizzazioni selezionare Visualizzazione destinazioni CMake e premere INVIO per aprire la visualizzazione destinazioni:

Scegliere il pulsante Mostra tutti i file nella parte superiore di Esplora soluzioni per visualizzare tutti gli output generati da CMake nelle out/build/<config> cartelle.

Usare il CMakeLists.txt file in ogni cartella del progetto esattamente come in qualsiasi progetto CMake. È possibile specificare i file di origine, trovare librerie, impostare le opzioni del compilatore e del linker e specificare altre informazioni correlate al sistema di compilazione. Per altre informazioni sui servizi di linguaggio CMake forniti da Visual Studio, vedere Modifica di file CMakeLists.txt.

Visual Studio usa un file di configurazione CMake per l'unità di generazione e compilazione della cache CMake. Per altre informazioni, vedere Configurazione di progetti CMake e Compilazione di progetti CMake.

Per passare argomenti a un eseguibile in fase di debug, è possibile usare un altro file denominato launch.vs.json. Per altre informazioni sul debug di progetti CMake multipiattaforma in Visual Studio, vedere Debug di progetti CMake.

La maggior parte delle funzionalità del linguaggio Visual Studio e C++ è supportata dai progetti CMake in Visual Studio. Alcuni esempi:

• Modificare e continuare per i progetti CMake
• Integrazione di Incredibuild per progetti CMake
• Supporto di AddressSanitizer per i progetti CMake
• Supporto Clang/LLVM

Nota

Per altri tipi di progetti Open Folder, viene usato un file CppProperties.json JSON aggiuntivo. Questo file non è rilevante per i progetti CMake.

Configurazione di progetti CMake

Il passaggio di configurazione di CMake genera il sistema di compilazione del progetto. Equivale a richiamare cmake.exe dalla riga di comando. Per altre informazioni sul passaggio di configurazione di CMake, vedere la documentazione di CMake.

Visual Studio usa un file di configurazione CMake per generare e compilare CMake. CMakePresets.json è supportato da Visual Studio 2019 versione 16.10 o successiva ed è il file di configurazione CMake consigliato. CMakePresets.json è supportato direttamente da CMake e può essere usato per guidare la generazione e la compilazione di CMake da Visual Studio, da VS Code, in una pipeline di integrazione continua e dalla riga di comando in Windows, Linux e Mac. Per altre informazioni su CMakePresets.json, vedere Configurare e compilare con i set di impostazioni di CMake. CMakeSettings.json è disponibile per i clienti che usano una versione precedente di Visual Studio. Per altre informazioni su CMakeSettings.json, vedere Personalizzare le impostazioni di compilazione di CMake.

Quando si apportano modifiche significative al file di configurazione di CMake o a un CMakeLists.txt file, Visual Studio eseguirà automaticamente il passaggio di configurazione di CMake. È possibile richiamare manualmente il passaggio di configurazione: selezionare Configurazione progetto > cache dalla barra degli strumenti. È anche possibile modificare le preferenze di configurazione in Strumenti>Opzioni>CMake>Generale.

Vengono visualizzate le impostazioni di configurazione di CMake. Mostra L'opzione Rendi le notifiche della cache in C è selezionata. In 'When cache is out of date:', l'opzione 'Never run configure step automatically' (Non eseguire mai il passaggio di configurazione automaticamente) è selezionata.

Se il passaggio di configurazione termina senza errori, le informazioni disponibili sono le unità IntelliSense C++ e i servizi di linguaggio. Viene usato anche nelle operazioni di compilazione e debug.

È anche possibile aprire una cache CMake esistente in Visual Studio. Per altre informazioni, vedere Aprire una cache esistente.

Personalizzare il feedback e le notifiche sulla configurazione

Per impostazione predefinita, la maggior parte dei messaggi di configurazione viene eliminata a meno che non si verifichi un errore. Per visualizzare tutti i messaggi, selezionare Strumenti>Opzioni>CMake>Abilita output di diagnostica CMake dettagliato.

È anche possibile disabilitare tutte le notifiche della cache CMake (barre oro) deselezionando Mostra notifica della cache CMake.

Risoluzione degli errori di cache CMake

Se sono necessarie altre informazioni sullo stato della cache CMake per diagnosticare un problema, aprire il menu principale progetto o il CMakeLists.txt menu di scelta rapida in Esplora soluzioni per eseguire uno di questi comandi:

• Visualizza CMakeCache.txt apre il CMakeCache.txt file dalla directory di compilazione nell'editor. Eventuali modifiche apportate in CMakeCache.txt vengono cancellate se si pulisce la cache. Per apportare modifiche che vengono mantenute dopo la pulizia della cache, vedere Personalizzare le impostazioni di CMake o Configurare e compilare con i set di impostazioni di CMake.

• Elimina cache e riconfigura elimina la directory di compilazione e riconfigura da una cache pulita.

• Configura cache forza l'esecuzione del passaggio di generazione anche se Visual Studio considera aggiornato l'ambiente.

Compilazione di progetti CMake

Il passaggio di compilazione CMake compila un albero binario del progetto già generato. Equivale a richiamare cmake --build dalla riga di comando. Per altre informazioni sul passaggio di compilazione di CMake, vedere la documentazione di CMake.

Per compilare un progetto di CMake, sono disponibili le opzioni seguenti:

1. Nella barra degli strumenti trovare l'elenco a discesa Elemento di avvio. Selezionare la destinazione preferita e premere F5 oppure scegliere il pulsante Esegui sulla barra degli strumenti. Il progetto viene compilato automaticamente prima di tutto, come una soluzione Visual Studio.

2. Fare clic con il pulsante destro del mouse sulla destinazione CMake con CMake Targets View (Visualizza destinazioni CMake) attiva nella Esplora soluzioni e scegliere Build (Compila) dal menu di scelta rapida.

3. Scegliere Compila > tutto dal menu principale. Assicurarsi che una destinazione CMake sia già selezionata nell'elenco a discesa Elemento di avvio sulla barra degli strumenti.

Come prevedibile, i risultati della compilazione sono visualizzati nella Finestra di output e nell'Elenco errori.

Gli avvisi di compilazione di CMake relativi alle conversioni che possono causare una perdita di dati, ad esempio la conversione da un tipo float a un numero intero, sono visibili. :::image-end:::

Modificare le impostazioni di compilazione

Visual Studio usa un file di configurazione CMake per l'unità delle compilazioni CMake. I file di configurazione di CMake incapsulano opzioni di compilazione come opzioni dello strumento di compilazione nativo e variabili di ambiente. Se CMakePresets.json è il file di configurazione attivo, vedere Configurare e compilare con i set di impostazioni di CMake. Se CMakeSettings.json è il file di configurazione attivo, vedere Personalizzare le impostazioni di compilazione di CMake. CMakePresets.json è disponibile in Visual Studio 2019 versione 16.10 o successiva ed è il file di configurazione CMake consigliato.

Debug dei progetti CMake

Tutte le destinazioni CMake eseguibili vengono visualizzate nell'elenco a discesa Elemento di avvio sulla barra degli strumenti. Per avviare il debug, selezionare uno e premere il pulsante Debug > Avvia debug sulla barra degli strumenti. In un progetto CMake l'opzione "Documento corrente" è valida solo per i file .cpp.

L'elenco a discesa include queste opzioni: Mostra/Nascondi destinazioni di debug, documento corrente, esempi (evidenziati), box2d_tests e samples-noGUI.

I comandi Debug o F5 compilano prima il progetto se sono state apportate modifiche dopo la compilazione precedente. Le modifiche apportate al file di configurazione di CMake (CMakePresets.json o ) o CMakeSettings.jsona causa CMakeLists.txt della rigenerazione della cache CMake.

È possibile personalizzare una sessione di debug di CMake impostando le proprietà nel file launch.vs.json. Per personalizzare le impostazioni di debug per una destinazione specifica, selezionare la destinazione nell'elenco a discesa Elemento di avvio e premere Debug > debug e avvia Impostazioni per <la destinazione> attiva. Per altre informazioni sulle sessioni di debug di CMake, vedere Configurare le sessioni di debug di CMake.

Just My Code per i progetti CMake

Quando si compila per Windows usando il compilatore MSVC, i progetti CMake supportano il debug Just My Code. Per modificare l'impostazione Just My Code, passare a Strumenti>Opzioni>debug>Generale.

Modificare e continuare per i progetti CMake

Quando si compila per Windows con il compilatore MSVC, i progetti CMake supportano Modifica e Continuazione. Aggiungere il codice seguente al CMakeLists.txt file per abilitare Modifica e Continuazione.

if(MSVC)
  target_compile_options(<target> PUBLIC "/ZI")
  target_link_options(<target> PUBLIC "/INCREMENTAL")
endif()

Connettersi a un progetto CMake in esecuzione in Linux

Visual Studio consente di eseguire il debug di un processo in esecuzione in un sistema Linux remoto o WSL ed eseguirne il debug con il debugger GDB. Per iniziare, selezionare Debug>Collega a processo..., impostare il tipo di Connessione ion su SSH e selezionare la destinazione di Connessione ion dall'elenco delle connessioni nel Gestione connessioni. Selezionare un processo dall'elenco dei processi disponibili e premere Collega. GDB deve essere installato nel computer Linux. Per altre informazioni sulle connessioni SSH, vedere il Gestione connessioni

Nella finestra di dialogo sono disponibili le opzioni seguenti: Connessione tipo (impostato su SSH), la destinazione di connessione (impostata su demo@ 172. 20. 60. 6) e un elenco dei processi disponibili a cui è possibile collegarsi."

Attivazione parziale di CMake

In Visual Studio 2022 versione 17.1 e successive, la funzionalità di CMake non verrà abilitata automaticamente se la cartella radice non contiene un CMakeLists.txt file. Verrà invece visualizzata una finestra di dialogo per indicare se si vuole abilitare la funzionalità di CMake per il progetto. Se si rifiuta, la generazione della cache CMake non viene avviata e le configurazioni CMake (da CMakeSettings.json o CMakePresets.json) non verranno visualizzate nell'elenco a discesa della configurazione. Se si accetta, verrà visualizzato un file di configurazione a livello di area di lavoro ( CMakeWorkspaceSettings.json archiviato nella .vs directory) per specificare le cartelle per cui si vuole abilitare CMake. Queste cartelle contengono i file radice CMakeLists.txt .

Le proprietà accettate sono:

Proprietà	Descrizione
enableCMake	Abilitare l'integrazione di Visual Studio per questa area di lavoro.
sourceDirectory	Stringa o matrice di stringhe che specificano la directory o le directory con CMakeLists.txt. Le macro ( ad esempio ${workspaceRoot}) sono consentite. I percorsi relativi si basano sulla radice dell'area di lavoro. Le directory esterne all'area di lavoro corrente verranno ignorate.

È possibile accedere CMakeWorkspaceSettings.json tramite il comando di menu Project>CMake Workspace Impostazioni in qualsiasi momento, anche se la funzionalità di CMake è attualmente disabilitata.

Aprire una cache esistente

Quando si apre un file di cache CMake esistente (CMakeCache.txt), Visual Studio non tenta di gestire la cache e la struttura ad albero di compilazione. Gli strumenti personalizzati o preferiti hanno il controllo completo sul modo in cui CMake configura il progetto.

È possibile aggiungere una cache CMake esistente a un progetto aperto. Viene eseguita allo stesso modo in cui si aggiunge una nuova configurazione. Per altre informazioni, vedere il post di blog sull'apertura di una cache esistente in Visual Studio.

Nota

L'esperienza di cache esistente predefinita si basa su cmake-server, che è stato rimosso da CMake nella versione 3.20. Per continuare a usare la funzionalità cache esistente in Visual Studio 2019 versione 16.10 e successive, eseguire una delle operazioni seguenti:

• Installare manualmente CMake versione 3.19 o precedente. Impostare quindi la cmakeExecutable proprietà nella configurazione della cache esistente per usare tale versione di CMake.
• Nella configurazione della cache esistente impostare la cacheGenerationCommand proprietà per consentire a Visual Studio di richiedere i file API basati su file CMake necessari. Per altre informazioni su tale proprietà, vedere Riferimenti per CMake Impostazioni.json.
• Usare un file di query per richiedere i file api basati su file CMake durante la generazione della cache prima dell'apertura in Visual Studio. Per istruzioni sui file di query, vedere la sezione successiva Risoluzione dei problemi della cache CMake avanzata.

Risoluzione avanzata della risoluzione dei problemi relativi alla cache CMake

Visual Studio usa l'API basata su file CMake (nelle versioni 3.14 e successive) per popolare l'editor con informazioni specifiche per la struttura del progetto. Per altre informazioni, vedere il post di blog del team C++ sulle aree di lavoro multi-radice e sull'API basata su file.

Prima di generare la cache CMake, gli strumenti personalizzati o preferiti potrebbero dover creare un file di query denominato .cmake/api/v1/query/client-MicrosoftVS/query.json nella cartella di output di compilazione (la cartella che contiene CMakeCache.txt). Il file di query deve contenere questo contenuto:

{"requests":[{"kind":"cache","version":2},{"kind":"cmakeFiles","version":1},{"kind":"codemodel","version":2}]}

Quando gli strumenti personalizzati o preferiti generano la cache, CMake inserisce i file in .cmake/api/v1/response tale Visual Studio per popolare l'editor con informazioni specifiche della struttura del progetto.

Modifica dei CMakeLists.txt file

Per modificare un CMakeLists.txt file, fare clic con il pulsante destro del mouse sul file in Esplora soluzioni e scegliere Apri. Se si apportano modifiche al file, viene visualizzata una barra di stato gialla che informa che IntelliSense verrà aggiornato. Consente di annullare l'operazione di aggiornamento. Per informazioni su CMakeLists.txt, vedere la documentazione di CMake.

Contiene il progetto di righe (hello-cmake), add_subdirectory (test), add_executable (hello hello.cpp) e l'installazione (TARGETS hello DESTINATION hello/bin). Un messaggio nella parte superiore della finestra indica che c più informazioni IntelliSense verranno aggiornate al termine della generazione della cache da parte di C Make.

Non appena si salva il file, viene eseguito nuovamente e automaticamente il passaggio di configurazione che visualizza le informazioni nella finestra Output. Gli errori e gli avvisi vengono visualizzati nella finestra Elenco errori o Output. Fare doppio clic su un errore nell'elenco errori per passare alla riga che causa l'errore in CMakeLists.txt.

Viene evidenziato un messaggio di errore C Nella riga 3 di CMakeLists.txt. I dettagli sono che C Make non è riuscito a trovare un file di configurazione del pacchetto fornito da sqlite3. C Make looked for it in CMAKE_MODULE_PATH but couldn't find it.C Make looked for it in CMAKE_MODULE_PATH but't find it. Il suggerimento consiste nell'aggiungere il prefisso di installazione 'sqlite3' a CMAKE_PREFIX_PATH o impostare sqlite3_DIR su una directory contenente sqlite3Config.cmake e/o sqlitet3-config.cmake.

Servizi di linguaggio per CMake

I servizi di linguaggio per CMake sono disponibili in Visual Studio 2019 versione 16.5 o successiva. Supporta funzionalità di spostamento del codice come Vai a definizione, Visualizza definizione e Trova tutti i riferimenti per variabili, funzioni e destinazioni CMake nei file di script CMake. Per altre informazioni, vedere Spostamento del codice per gli script CMake.

Vengono visualizzati i risultati della posizione in cui vengono trovati i SUPERTUX_SOURCES_CXX. Ad esempio, in list(SORT SSUPERTUX_SOURCES_CXX), file(GLOB SUPERTUX_SOURCES_CXX) e così via.

Manipolazione del progetto CMake

La modifica del progetto CMake è disponibile in Visual Studio 2019 versione 16.5 o successiva. La manipolazione del progetto consente di aggiungere, rimuovere e rinominare file e destinazioni di origine nel progetto CMake senza modificare manualmente gli script CMake. Quando si aggiungono o rimuovono file dalla Esplora soluzioni, Visual Studio modifica automaticamente il progetto CMake. Potrebbe esserci più di una posizione in cui è opportuno aggiungere o rimuovere un riferimento a uno script CMake. In tal caso, Visual Studio chiede dove si vuole apportare la modifica e visualizza un'anteprima delle modifiche proposte. Per istruzioni dettagliate, vedere Aggiungere, rimuovere e rinominare file e destinazioni nei progetti CMake.

Una visualizzazione albero mostra CMakeLists.txt, in cui sono due elementi: add_executable e impostati. Il set è selezionato. La finestra di anteprima mostra dove verranno apportate le modifiche. Il set di righe (PROJECT_SRC "CmakeProject4.cpp" "CMakeProject4.h" mostra "Demo.cpp" evidenziato prima della parentesi di chiusura. Il pulsante applica accetta la modifica oppure è possibile premere annulla.

IntelliSense per i progetti CMake

Per impostazione predefinita, Visual Studio usa la modalità IntelliSense corrispondente all'architettura del compilatore e di destinazione specificata dalla configurazione CMake attiva.

Se CMakePresets.json è il file di configurazione CMake attivo, è possibile specificare le opzioni di IntelliSense usando intelliSenseMode e intelliSenseOptions nella mappa fornitore di Visual Studio Impostazioni. Per altre informazioni, vedere informazioni di riferimento sulla mappa dei fornitori di Visual Studio Impostazioni.

Se CMakeSettings.json è il file di configurazione CMake attivo, è possibile specificare le opzioni di IntelliSense usando intelliSenseMode in CMakeSettings.json. Per altre informazioni, vedere le CMakeSettings.jsoninformazioni di riferimento.

Configurare IntelliSense con i file toolchain CMake

In Visual Studio 2019 versione 16.9 e successive Visual Studio configura automaticamente IntelliSense nei progetti CMake in base alle variabili CMake quando si usa un file toolchain CMake. Per altre informazioni, vedere Configurare IntelliSense con i file toolchain CMake.

Integrazione di Vcpkg

I progetti CMake aperti in Visual Studio si integrano con vcpkg, una gestione dipendenze C/C++ multipiattaforma. Prima di usare vcpkg con Visual Studio, è necessario eseguire vcpkg integrate install. Per istruzioni e altre informazioni su vcpkg, vedere:

• Installare e usare pacchetti con CMake in Visual Studio
• vcpkg nei progetti CMake

Se CMakeSettings.json è il file di configurazione attivo, Visual Studio passa automaticamente il file toolchain vcpkg (vcpkg.cmake) a CMake. Questo comportamento viene disabilitato automaticamente quando si specifica qualsiasi altra toolchain nella configurazione di CMake Impostazioni.

Se CMakePresets.json è il file di configurazione attivo, è necessario impostare il percorso su vcpkg.cmake in CMakePresets.json. È consigliabile usare la VCPKG_ROOT variabile di ambiente anziché un percorso assoluto per mantenere condivisibile il file. Per altre informazioni, vedere Abilitare l'integrazione di vcpkg con I set di impostazioni di CMake. CMakePresets.json è disponibile in Visual Studio 2019 versione 16.10 o successiva ed è il file di configurazione CMake consigliato.

Eseguire CMake dalla riga di comando

Se CMakePresets.json è il file di configurazione CMake attivo, è possibile riprodurre facilmente le compilazioni locali all'esterno di Visual Studio. Per altre informazioni, vedere Eseguire CMake dalla riga di comando o da una pipeline CI. CMakePresets.json è supportato in Visual Studio 2019 versione 16.10 o successiva ed è il file di configurazione CMake consigliato.

Se CMakeSettings.json è il file di configurazione CMake attivo, sarà necessario passare manualmente gli argomenti codificati nel CMakeSettings.json file a CMake. Se CMake è stato installato dal programma di installazione di Visual Studio, è possibile eseguirlo dalla riga di comando seguendo questa procedura:

1. Eseguire il file appropriato vsdevcmd.bat (x86/x64). Per altre informazioni, vedere Compilazione nella riga di comando .

2. Passare alla cartella di output.

3. Eseguire CMake per compilare o configurare l'app.

Vedi anche

Esercitazione: Creare progetti multipiattaforma C++ in Visual Studio
Configurare un progetto CMake per Linux
Connettersi al computer Linux remoto
Personalizzare le impostazioni di compilazione di CMake
CMakeSettings.json riferimento allo schema
Configurare le sessioni di debug di CMake
Distribuire, eseguire e sottoporre a debug il progetto Linux
Informazioni di riferimento sulle configurazioni predefinite CMake
vcpkg nei progetti CMake
Installare e usare pacchetti con CMake in Visual Studio