CMakePresets.json e CMakeUserPresets.json mappe fornitore Microsoft

CMake supporta due file, CMakePresets.json e CMakeUserPresets.json, che consentono agli utenti di specificare opzioni comuni di configurazione, compilazione e test e condividerle con altri utenti.

CMakePresets.json e CMakeUserPresets.json possono essere usati per eseguire l'unità CMake in Visual Studio, in Visual Studio Code, in una pipeline di integrazione continua (CI) e dalla riga di comando.

CMakePresets.json è progettato per salvare compilazioni a livello di progetto ed CMakeUserPresets.json è destinato agli sviluppatori per salvare le proprie build locali. Lo schema per entrambi i file è identico.

CMakePresets.json e CMakeUserPresets.json il fornitore del supporto esegue il mapping per archiviare informazioni specifiche del fornitore. Microsoft gestisce due mappe fornitore con opzioni specifiche di Visual Studio e Visual Studio Code. Qui vengono documentato due mappe dei fornitori Microsoft e macro fornitore. Per altre informazioni sul resto dello schema, vedere la documentazione ufficiale di CMake. Include informazioni su Configura set di impostazioni, set di impostazioni di compilazione e set di impostazioni di test.

Per altre informazioni su come usare CMakePresets.json in Visual Studio, vedere Configurare e compilare con i set di impostazioni di CMake in Visual Studio

Per altre informazioni su come usare CMakePresets.json in Visual Studio Code, vedere Configurare e compilare con i set di impostazioni di CMake in VS Code

Mappa fornitore delle impostazioni di Visual Studio

Una mappa fornitore con l'URI microsoft.com/VisualStudioSettings/CMake/<version> del fornitore è consentita per configurare il set di impostazioni e contiene opzioni specifiche per l'integrazione di CMake in Visual Studio e Visual Studio Code. Tutte le opzioni nella mappa fornitore si applicano a Visual Studio. Le opzioni applicabili sia a Visual Studio che a Visual Studio Code sono state contrassegnate in modo esplicito.

Tutte le impostazioni nella mappa fornitore delle impostazioni di Visual Studio sono facoltative e ereditate da Configura set di impostazioni specificati dalla inherits chiave. Solo le opzioni modificate vengono scritte nel file. La mappa fornitore delle impostazioni di Visual Studio è supportata sia da che CMakeUserPresets.jsonda CMakePresets.json .

Le opzioni nella mappa fornitore delle impostazioni di Visual Studio non influiscono sulla costruzione della riga di comando CMake o CTest. È quindi possibile usare lo stesso CMakePresets.json file per eseguire l'unità CMake con Visual Studio, Visual Studio Code e dalla riga di comando. Le eccezioni sono le cacheRoot opzioni e cmakeGenerateCommand . Queste opzioni sono specifiche dello scenario Apri cache esistente in Visual Studio e non possono essere riprodotte dalla riga di comando.

Mappa fornitore impostazioni remote di Visual Studio

Una mappa fornitore con l'URI microsoft.com/VisualStudioRemoteSettings/CMake/<version> del fornitore è consentita per impostazione predefinita e contiene opzioni specifiche per lo sviluppo remoto in Visual Studio. Lo sviluppo remoto significa richiamare CMake in una connessione SSH remota o WSL. Nessuna delle opzioni nella mappa fornitore impostazioni remote di Visual Studio si applica a Visual Studio Code.

Tutte le impostazioni nella mappa fornitore impostazioni remote di Visual Studio sono facoltative e ereditate da Configura set di impostazioni specificati dalla inherits chiave. Solo le opzioni modificate vengono scritte nel file. La mappa fornitore delle impostazioni remote di Visual Studio è supportata sia da che CMakeUserPresets.jsonda CMakePresets.json .

Le opzioni nella mappa fornitore delle impostazioni di Visual Studio non influiscono sulla costruzione della riga di comando CMake o CTest. È quindi possibile usare lo stesso CMakePresets.json file per eseguire l'unità CMake con Visual Studio, Visual Studio Code e dalla riga di comando.

Molte delle opzioni nella mappa fornitore impostazioni remote di Visual Studio vengono ignorate quando la destinazione è WSL1. Poiché il set di strumenti WSL1 esegue tutti i comandi in locale e si basa sulle unità windows montate nella /mnt cartella per accedere ai file di origine locali da WSL1. Non è necessaria alcuna copia del file di origine. Le opzioni ignorate quando la destinazione WSL1 è stata contrassegnata in modo esplicito.

Eventi di pre-compilazione e post-compilazione remoti

Le opzioni per un remotePrebuildEvent oggetto e remotePostbuildEvent sono state deprecate con l'adozione di CMakePresets.json.

Codificare gli eventi di pre-compilazione, pre-collegamento e post-compilazione nell'oggetto CMakeLists.txt usando add_custom_command. Garantisce lo stesso comportamento durante la compilazione con Visual Studio e dalla riga di comando.

Se è necessario un comportamento specifico di Visual Studio, è possibile aggiungere un'attività remota personalizzata in tasks.vs.json. Per iniziare, fare clic con il pulsante destro del mouse sulla radice CMakeLists.txt nella Esplora soluzioni da Visualizzazione cartelle e scegliere Configura attività. È quindi possibile aggiungere una nuova attività remota al tasks.vs.json file.

L'attività remota seguente crea una directory denominata test nel sistema Linux remoto:

{
      "taskLabel": "mkdir",
      "appliesTo": "CMakeLists.txt",
      "type": "remote",
      "command": "mkdir test",
      "remoteMachineName": "localhost"
  }

Fare clic con il pulsante destro del mouse su uno qualsiasi CMakeLists.txt e selezionare l'opzione mkdir per eseguire questa attività.

Il valore di remoteMachineName deve corrispondere al nome host di una connessione nella Gestione connessioni.

Macro del fornitore Microsoft

Le due mappe dei fornitori Microsoft e Visual Studio Settings Visual Studio Remote Settings, supportano tutte le macro definite da CMake. Le mappe fornitore supportano tutte le macro definite da CMake. Per altre informazioni, vedere Espansione macro cmake-presets. Tutte le macro e le variabili di ambiente vengono espanse prima di essere passate a CMake.

Visual Studio supporta macro fornitore con il prefisso ms. Le macro dei fornitori Microsoft possono essere usate solo nelle mappe dei fornitori Microsoft. CMake non può usare set di impostazioni con macro fornitore all'esterno di una mappa fornitore.

Variabili di ambiente

Macro deprecate

Alcune macro supportate da CMakeSettings.json sono state deprecate con l'adozione di CMakePresets.json.

Usare le macro supportate da CMake per costruire i percorsi dei file. Quando si usano le macro, garantisce che lo stesso CMakePresets.json file funzioni all'interno di Visual Studio e dalla riga di comando.

Sintassi della shell accettata

Usare la $env{HOME} sintassi per fare riferimento $HOME quando si creano percorsi Linux nelle mappe dei fornitori Microsoft.