CMakePresets.json en CMakeUserPresets.json Kaarten van Microsoft-leveranciers

CMake ondersteunt twee bestanden en CMakePresets.jsonCMakeUserPresets.json, waarmee gebruikers algemene configuratie-, build- en testopties kunnen opgeven en deze met anderen kunnen delen.

CMakePresets.json en CMakeUserPresets.json kunnen worden gebruikt om CMake te gebruiken in Visual Studio, in Visual Studio Code, in een Continuous Integration (CI)-pijplijn en vanaf de commandoregel.

CMakePresets.json is bedoeld om projectbrede builds op te slaan en CMakeUserPresets.json is bedoeld voor ontwikkelaars om hun eigen lokale builds op te slaan. Het schema voor beide bestanden is identiek.

CMakePresets.json en CMakeUserPresets.json ondersteunen leverancierskaarten om leverancierspecifieke informatie op te slaan. Microsoft onderhoudt twee leverancierskaarten met opties die specifiek zijn voor Visual Studio en Visual Studio Code. Hier documenteert u twee microsoft-leverancierskaarten en leveranciersmacro's. Zie de officiële CMake-documentatie voor meer informatie over de rest van het schema. Het bevat informatie over het configureren van voorinstellingen, build voorinstellingen en testvoorinstellingen.

Zie CMakePresets.json voor meer informatie over het gebruik in Visual Studio

Zie CMakePresets.json voor meer informatie over het gebruik in Visual Studio Code

Kaart van de leverancier van Visual Studio-instellingen

Eén leverancierkaart met de URI microsoft.com/VisualStudioSettings/CMake/<version> van de leverancier is toegestaan per vooraf ingestelde configuratie en bevat opties die specifiek zijn voor CMake-integratie in Visual Studio en Visual Studio Code. Alle opties in de leverancierskaart zijn van toepassing op Visual Studio. Opties die van toepassing zijn op Visual Studio en Visual Studio Code, zijn expliciet gemarkeerd.

Alle instellingen in de Visual Studio-instellingenverkoperkaart zijn optioneel en worden overgenomen van voorgeconfigureerde instellingen zoals gespecificeerd door de inherits sleutel. Alleen opties die zijn gewijzigd, worden naar het bestand geschreven. De leverancierskaart van Visual Studio-instellingen wordt ondersteund door zowel CMakePresets.json als CMakeUserPresets.json.

De opties in de instellingen van de Visual Studio-leverancier zijn niet van invloed op de opbouw van de CMake- of CTest-commandoregel. Het is dus hetzelfde CMakePresets.json bestand dat kan worden gebruikt om CMake te besturen met Visual Studio, Visual Studio Code en vanaf de opdrachtregel. De uitzonderingen zijn de cacheRoot en cmakeGenerateCommand opties. Deze opties zijn specifiek voor het scenario Bestaande cache openen in Visual Studio en kunnen niet worden gereproduceerd vanaf de opdrachtregel.

Kaart van leveranciers voor Externe instellingen van Visual Studio

Eén leverancierkaart met de URI microsoft.com/VisualStudioRemoteSettings/CMake/<version> van de leverancier is toegestaan per vooraf ingestelde configuratie en bevat opties die specifiek zijn voor externe ontwikkeling in Visual Studio. Externe ontwikkeling betekent dat u CMake aanroept op een externe SSH-verbinding of WSL. Geen van de opties in de leverancierkaart van Visual Studio Remote Settings is van toepassing op Visual Studio Code.

Alle instellingen in de leveranciertoewijzing van externe instellingen van Visual Studio zijn optioneel en overgenomen van de Configureer Presets gespecificeerd door het inherits trefwoord. Alleen opties die zijn gewijzigd, worden naar het bestand geschreven. De leverancierskaart voor Externe instellingen van Visual Studio wordt ondersteund door zowel CMakePresets.json als CMakeUserPresets.json.

De opties in de instellingen van de Visual Studio-leverancier zijn niet van invloed op de opbouw van de CMake- of CTest-commandoregel. Het is dus hetzelfde CMakePresets.json bestand dat kan worden gebruikt om CMake te besturen met Visual Studio, Visual Studio Code en vanaf de opdrachtregel.

Veel van de opties in de leverancierskaart van Visual Studio Remote Settings worden genegeerd bij het richten op WSL1. Dit komt doordat de WSL1-toolset alle opdrachten lokaal uitvoert en afhankelijk is van Windows-stations die zijn gekoppeld onder de /mnt map om toegang te krijgen tot lokale bronbestanden van WSL1. Er is geen bronbestandskopie vereist. Opties die worden genegeerd wanneer WSL1 als doel wordt gebruikt, zijn expliciet gemarkeerd.

Externe vooraf gemaakte en post-buildgebeurtenissen

Opties voor een remotePrebuildEvent en remotePostbuildEvent zijn afgeschaft met de ingebruikname van CMakePresets.json.

Codeer pre-build-, pre-link- en post-buildgebeurtenissen in uw CMakeLists.txt door gebruik te maken van add_custom_command. Het zorgt voor hetzelfde gedrag bij het bouwen met Visual Studio en met de opdrachtprompt.

Als u gedrag nodig hebt dat specifiek is voor Visual Studio, kunt u een aangepaste externe taak toevoegen in tasks.vs.json. Als u wilt beginnen, klikt u met de rechtermuisknop op de root CMakeLists.txt in de Solution Explorer vanuit de mapweergave en selecteert u Taken configureren. Vervolgens kunt u een nieuwe externe taak toevoegen aan uw tasks.vs.json bestand.

Met de volgende externe taak maakt u een map met de naam Test op het externe Linux-systeem:

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

Klik met de rechtermuisknop op een CMakeLists.txt willekeurige optie en selecteer de mkdir-optie om deze taak uit te voeren.

De waarde van remoteMachineName moet overeenkomen met de hostnaam van een verbinding in Verbindingsbeheer.

Macro's van Microsoft-leveranciers

De twee Microsoft-leverancierskaarten Visual Studio Settings en Visual Studio Remote Settingsondersteunen alle macro's die zijn gedefinieerd door CMake. Onze leverancierskaarten ondersteunen alle macro's die zijn gedefinieerd door CMake. Zie macro-uitbreidingen met cmake-voorinstellingen voor meer informatie. Alle macro's en omgevingsvariabelen worden uitgevouwen voordat ze worden doorgegeven aan CMake.

Visual Studio ondersteunt leveranciersmacro's met het voorvoegsel ms. Microsoft-leveranciersmacro's kunnen alleen worden gebruikt in Microsoft-leveranciersoverzichten. CMake kan geen voorinstellingen gebruiken die leveranciersmacro's bevatten buiten een leverancierskaart.

Omgevingsvariabelen

Verouderde macro's

Een paar macro's die worden ondersteund door CMakeSettings.json , zijn afgeschaft met de ingebruikname van CMakePresets.json.

Gebruik de macro's die door CMake worden ondersteund om bestandspaden samen te stellen. Wanneer u de macro's gebruikt, zorgt dit ervoor dat hetzelfde CMakePresets.json bestand werkt in Visual Studio en vanaf de opdrachtregel.

Geaccepteerde shellsyntaxis

Gebruik de $env{HOME}-syntaxis om te verwijzen naar $HOME bij het maken van Linux-paden in de Microsoft-leveranciertoewijzingen.