CMake projekty w programie Visual C++CMake projects in Visual C++

W tym artykule przyjęto założenie, że czytelnik zna CMake, narzędzia i platform, open source do definiowania kompilacji procesy uruchomione na wielu platformach.This article assumes that you are familiar with CMake, a cross-platform, open-source tool for defining build processes that run on multiple platforms.

Niedawna użytkowników programu Visual Studio może użyć CMake generuje pliki projektu MSBuild, które IDE następnie używane przez funkcję IntelliSense, przeglądanie i kompilacji.Until recently, Visual Studio users could use CMake to generate MSBuild project files, which the IDE then consumed for IntelliSense, browsing, and compilation. W programie Visual Studio 2017 r. Visual C++ Tools dla CMake składnik używa Otwórz Folder funkcję, aby umożliwić IDE korzystają z plików projektu CMake (na przykład CMakeLists.txt) bezpośrednio do celów IntelliSense i przeglądania.Starting in Visual Studio 2017, the Visual C++ Tools for CMake component uses the Open Folder feature to enable the IDE to consume CMake project files (such as CMakeLists.txt) directly for the purposes of IntelliSense and browsing. Jeśli używasz programu Visual Studio generator pliku tymczasowego projektu jest generowana i przekazany do msbuild.exe, ale nigdy nie jest załadowany dla IntelliSense i przeglądania.If you use a Visual Studio generator, a temporary project file is generated and passed to msbuild.exe, but is never loaded for IntelliSense or browsing purposes.

Visual Studio 2017 wersji 15 ustęp 3: Pomoc techniczna jest świadczona dla generatory zarówno Nindżą, jak i programu Visual Studio.Visual Studio 2017 version 15.3: Support is provided for both Ninja and Visual Studio generators.

Visual Studio 2017 wersji 15.4: Dodano obsługę CMake w systemie Linux.Visual Studio 2017 version 15.4: Support is added for CMake on Linux. Aby uzyskać więcej informacji, zobacz Konfigurowanie projektu CMake Linux.For more information, see Configure a Linux CMake Project.

Visual Studio 2017 wersji 15,5 cala: importowanie istniejących pamięci podręcznej CMake dodano obsługę.Visual Studio 2017 version 15.5: Support is added for importing an existing CMake cache. Visual Studio automatycznie wyodrębnia niestandardowe zmienne i tworzy plik CMakeSettings.json wstępnie wypełnione.Visual Studio automatically extracts customized variables and creates a pre-populated CMakeSettings.json file.

InstalacjaInstallation

Narzędzia Visual C++ Tools for CMake jest instalowany domyślnie w ramach tworzenia klasycznych aplikacji w języku C++ obciążenia.Visual C++ Tools for CMake is installed by default as part of the Desktop development with C++ workload.

Składnik CMake obciążenia pracą pulpitu C++

Integracja środowiska IDEIDE Integration

Po wybraniu pliku | Otwórz | Folder aby otworzyć folder zawierający plik CMakeLists.txt, stanie następujących czynności:When you choose File | Open | Folder to open a folder containing a CMakeLists.txt file, the following things happen:

  • Dodaje programu Visual Studio CMake element menu do menu głównego, z poleceniami do wyświetlania i edytowania CMake skryptów.Visual Studio adds a CMake menu item to the main menu, with commands for viewing and editing CMake scripts.
  • Eksplorator rozwiązań Wyświetla struktury folderów i plików.Solution Explorer displays the folder structure and files.
  • Program Visual Studio działa CMake.exe i generuje CMake pamięci podręcznej dla domyślnej konfiguracji, która jest x86 debugowania.Visual Studio runs CMake.exe and generates the CMake cache for the default configuration, which is x86 Debug. W wierszu polecenia CMake jest wyświetlany w okno danych wyjściowych, oraz dodatkowe dane wyjściowe z CMake.The CMake command line is displayed in the Output Window, along with additional output from CMake.
  • W tle Visual Studio rozpoczyna indeksu plików źródłowych, aby włączyć IntelliSense, przeglądanie informacji, refaktoryzacji i tak dalej.In the background, Visual Studio starts to index the source files to enable IntelliSense, browsing information, refactoring, and so on. Podczas pracy programu Visual Studio monitoruje zmiany w edytorze, a także na dysku, aby zachować synchronizację ze źródłami jej indeks.As you work, Visual Studio monitors changes in the editor and also on disk to keep its index in sync with the sources.

Możesz otworzyć foldery zawierające dowolną liczbę CMake projektów.You can open folders containing any number of CMake projects. Visual Studio wykrywa i konfiguruje wszystkie pliki CMakeLists.txt "root" w obszarze roboczym.Visual Studio detects and configures all the "root" CMakeLists.txt files in your workspace. Operacje CMake (Konfigurowanie, tworzenie, debugowanie) również C++ IntelliSense i przeglądania są dostępne dla wszystkich projektów CMake w obszarze roboczym.CMake operations (configure, build, debug) as well as C++ IntelliSense and browsing are available to all CMake projects in your workspace.

Projekt CMake z wielu elementów głównych

Importuj istniejący pamięci podręcznejImport an existing cache

Podczas importowania istniejącego pliku CMakeCache.txt programu Visual Studio automatycznie wyodrębnia niestandardowe zmienne i tworzy plik wstępnie wypełnione CMakeSettings.json na ich podstawie.When you import an existing CMakeCache.txt file, Visual Studio automatically extracts customized variables and creates a pre-populated CMakeSettings.json file based on them. Oryginalny pamięci podręcznej nie jest modyfikowany w jakikolwiek sposób i nadal może być używany, z poziomu wiersza polecenia lub z dowolnego narzędzia lub IDE zostało użyte do wygenerowania.The original cache is not modified in any way and can still be used from the command line or with whatever tool or IDE was used to generate it. Nowy plik CMakeSettings.json jest umieszczana wzdłuż głównego projektu CMakeLists.txt.The new CMakeSettings.json file is placed alongside the project’s root CMakeLists.txt. Visual Studio generuje nowy plik ustawień na podstawie pamięci podręcznej.Visual Studio generates a new cache based the settings file. Nie wszystkie elementy w pamięci podręcznej zostaną zaimportowane.Not everything in the cache is imported. Właściwości, takie jak generator i lokalizację kompilatory są zastępowane wartości domyślne, które działają prawidłowo w IDE.Properties such as the generator and the location of the compilers are replaced with defaults that are known to work well with the IDE.

Aby zaimportować istniejący pamięci podręcznejTo import an existing cache

  1. W menu głównym wybierz pliku | Otwórz | CMake:From the main menu, choose File | Open | CMake:

    Otwórz CMakeOpen CMake

    Spowoduje to wyświetlenie CMake importu z pamięci podręcznej kreatora.This brings up the Import CMake from Cache wizard.

  2. Przejdź do pliku CMakeCache.txt, który chcesz zaimportować, a następnie kliknij przycisk OK.Navigate to the CMakeCache.txt file that you want to import, and then click OK. Importowanie CMake projektu z pamięci podręcznej zostanie wyświetlony Kreator:The Import CMake Project from Cache wizard appears:

    Importuj pamięci podręcznej CMakeImport a CMake cache

    Po zakończeniu działania kreatora można wyświetlić nowy plik CMakeCache.txt w Eksploratora rozwiązań obok głównego pliku CMakeLists.txt w projekcie.When the wizard completes, you can see the new CMakeCache.txt file in Solution Explorer next to the root CMakeLists.txt file in your project.

Kompilowanie projektów CMakeBuilding CMake projects

Aby utworzyć projekt CMake, masz tych opcji:To build a CMake project, you have these choices:

  1. Wybierz obiekt docelowy w debugowania listy rozwijanej i naciśnij klawisz F5, lub kliknij przycisk Uruchom (zielony) trójkąt.Select the target in the Debug dropdown and press F5, or click the Run (green triangle) button. Projekt automatycznie tworzy, podobnie jak rozwiązania Visual Studio.The project automatically builds first, just like a Visual Studio solution.
  2. Kliknij prawym przyciskiem myszy na CMakeLists.txt i wybierz kompilacji z menu kontekstowego.Right click on the CMakeLists.txt and select Build from the context menu. Jeśli masz wiele obiektów docelowych w strukturze folderu, użytkownik może kompilacji wszystkie lub tylko jeden określony element docelowy, lubIf you have multiple targets in your folder structure, you can choose to build all or only one specific target, or
  3. Wybierz z menu głównego kompilacji | Tworzenie rozwiązania (F7 lub Ctrl + Shift + B).From the main menu, select Build | Build Solution (F7 or Ctrl+Shift+B). Upewnij się, że docelowy CMake jest zaznaczona w element startowy listy rozwijanej w ogólne paska narzędzi.Make sure that a CMake target is already selected in the Startup Item dropdown in the General toolbar.

Polecenia menu kompilacji CMakeCMake build menu command

Po wybraniu generator Visual Studio dla aktywnej konfiguracji MSBuild.exe jest wywoływana z -m -v:minimal argumentów.When a Visual Studio generator is selected for the active configuration, MSBuild.exe is invoked with -m -v:minimal arguments. Aby dostosować kompilacji, w pliku CMakeSettings.json można określić argumentów wiersza polecenia do przekazania do kompilacji systemu za pośrednictwem buildCommandArgs właściwości:To customize the build, inside the CMakeSettings.json file, you can specify additional command line arguments to be passed to the build system via the buildCommandArgs property:

"buildCommandArgs": "-m:8 -v:minimal -p:PreferredToolArchitecture=x64"

Jak można oczekiwać w przedstawiono wyniki kompilacji okno danych wyjściowych i listy błędów.As you would expect, build results are shown in the Output Window and Error List.

Błędy kompilacji CMakeCMake build errors

W folderze z wieloma docelowymi kompilacji, można wybrać kompilacji elementu na CMake menu lub CMakeLists.txt menu kontekstowym, aby określić, która docelowa CMake do kompilacji.In a folder with multiple build targets, you can choose the Build item on the CMake menu or the CMakeLists.txt context menu to specify which CMake target to build. Naciśnięcie przycisku Ctrl + Shift + B w CMake projektu kompilacje bieżący aktywny dokument.Pressing Ctrl+Shift+B in a CMake project builds the current active document.

Debugowanie projektuDebug the project

Aby debugować projektu CMake, wybrać żądaną konfiguracją i naciśnij klawisz F5, lub naciśnij klawisz Uruchom przycisku w pasku narzędzi.To debug a CMake project, choose the desired configuration and press F5, or press the Run button in the toolbar. Jeśli Uruchom przycisk mówi "Wybierz element startowy", wybierz strzałkę listy rozwijanej i wybierz element docelowy, który chcesz uruchomić.If the Run button says "Select Startup Item", select the dropdown arrow and choose the target that you want to run. (W projekcie CMake "bieżący dokument" opcja jest prawidłowa tylko dla plików .cpp.)(In a CMake project, the "Current document" option is only valid for .cpp files.)

Przycisk Uruchom CMakeCMake run button

Uruchom lub F5 polecenia najpierw skompilować projekt, jeśli zostały zmienione od czasu poprzedniej kompilacji.The Run or F5 commands first build the project if changes have been made since the previous build.

Skonfiguruj CMake sesji debugowaniaConfigure CMake debugging sessions

Wszystkie elementy docelowe wykonywalnego CMake są wyświetlane w element startowy listy rozwijanej w ogólne paska narzędzi.All executable CMake targets are shown in the Startup Item dropdown in the General toolbar. Aby rozpocząć sesję debugowania, wystarczy wybrać jedną i uruchomić debugera.To start a debugging session, just select one and launch the debugger.

CMake uruchamiania elementu z listy rozwijanejCMake startup item dropdown

Można również uruchomić sesję debugowania, w menu CMake.You can also start a debug session from the CMake menus.

Aby dostosować ustawienia debugera dla dowolnego pliku wykonywalnego CMake docelowego w projekcie, kliknij prawym przyciskiem myszy w określonym pliku CMakeLists.txt, a następnie wybierz debugowania i ustawienia uruchamiania.To customize the debugger settings for any executable CMake target in your project, right-click on the specific CMakeLists.txt file and select Debug and Launch Settings. Po wybraniu elementu docelowego CMake w podmenu jest tworzony plik o nazwie launch.vs.json.When you select a CMake target in the sub-menu, a file called launch.vs.json is created. Ten plik jest wstępnie wypełnione informacjami o docelowym CMake, wybrana przez Ciebie i pozwala określić dodatkowe parametry, takie jak program argumentów lub typ debugera.This file is pre-populated with information about the CMake target you have selected and allows you to specify additional parameters such as program arguments or debugger type. Aby odwołać dowolny klawisz, w pliku CMakeSettings.json, należy poprzedzić go z "cmake."To reference any key in a CMakeSettings.json file, preface it with "cmake." in launch.vs.json.in launch.vs.json. W poniższym przykładzie przedstawiono plik prosty launch.vs.json ściągający wartości klucza "remoteCopySources" w pliku CMakeSettings.json dla aktualnie wybranej konfiguracji:The following example shows a simple launch.vs.json file that pulls in the value of the "remoteCopySources" key in the CMakeSettings.json file for the currently selected configuration:

{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
   {
      "type": "default",
      "project": "CMakeLists.txt",
      "projectTarget": "CMakeHelloWorld.exe (Debug\\CMakeHelloWorld.exe)",
      "name": "CMakeHelloWorld.exe (Debug\\CMakeHelloWorld.exe)",
      "args": ["${cmake.remoteCopySources}"]
    }
  ]
}

Bezpośrednio po zapisaniu pliku launch.vs.json wpis jest tworzony w element startowy listy rozwijanej z nową nazwą.As soon as you save the launch.vs.json file, an entry is created in the Startup Item dropdown with the new name. Edytując plik launch.vs.json, można tworzyć, jak dla dowolnej liczby CMake celów, takich jak wiele konfiguracje debugowania.By editing the launch.vs.json file, you can create as many debug configurations as you like for any number of CMake targets.

Visual Studio 2017 wersji 15.4: Launch.vs.json obsługuje zmienne, które są zadeklarowane w CMakeSettings.json (patrz poniżej) i które są stosowane do obecnie wybranej konfiguracji.Visual Studio 2017 version 15.4: Launch.vs.json supports variables that are declared in CMakeSettings.json (see below) and that are applicable to the currently-selected configuration. Ma klucz o nazwie "currentDir", który określa bieżącego katalogu uruchamiania aplikacji:It also has a key named "currentDir", which sets the current directory of the launching app:

{
"type": "default",
"project": "CMakeLists.txt",
"projectTarget": "CMakeHelloWorld1.exe (C:\\Users\\satyan\\CMakeBuilds\\Test\\Debug\\CMakeHelloWorld1.exe)",
"name": "CMakeHelloWorld1.exe (C:\\Users\\satyan\\CMakeBuilds\\Test\\Debug\\CMakeHelloWorld1.exe)",
"currentDir": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}"
}

Po uruchomieniu aplikacji, wartość currentDir jest podobny doWhen you run the app, the value of currentDir is something similar to

C:\Users\satyan\7f14809a-2626-873e-952e-cdf038211175\

Edytowanie plików CMakeLists.txtEditing CMakeLists.txt files

Aby edytować plik CMakeLists.txt, kliknij prawym przyciskiem myszy plik w Eksploratora rozwiązań i wybierz polecenie Otwórz.To edit a CMakeLists.txt file, right click on the file in Solution Explorer and choose Open. Jeśli wprowadzisz zmiany w pliku pasek stanu żółty pojawia się i informuje o IntelliSense zostanie zaktualizowana i daje możliwość anulowania operacji aktualizacji.If you make changes to the file, a yellow status bar appears and informs you that IntelliSense will update, and gives you an opportunity to cancel the update operation. Aby uzyskać informacje o CMakeLists.txt, zobacz dokumentacji CMake.For information about CMakeLists.txt, see the CMake documentation.

Edytowanie pliku CMakeLists.txtCMakeLists.txt file editing

Bezpośrednio po zapisaniu pliku krok konfiguracji jest uruchamiana ponownie i automatycznie wyświetla informacje w dane wyjściowe okna.As soon as you save the file, the configuration step automatically runs again and displays information in the Output window. Błędy i ostrzeżenia są wyświetlane w listy błędów lub dane wyjściowe okna.Errors and warnings are shown in the Error List or Output window. Kliknij dwukrotnie w przypadku wystąpienia błędu w listy błędów można przejść do ataku wiersza w CMakeLists.txt.Double-click on an error in the Error List to navigate to the offending line in CMakeLists.txt.

Błędy w pliku CMakeLists.txtCMakeLists.txt file errors

CMake ustawienia i konfiguracje niestandardoweCMake settings and custom configurations

Domyślnie program Visual Studio oferuje sześć domyślne konfiguracje CMake ("x86-Debug", "x86 wersja", "x64-Debug", "x64-wersja", "Linux-Debug" i "Linux wersja").By default, Visual Studio provides six default CMake configurations ("x86-Debug", "x86-Release", "x64-Debug", "x64-Release", "Linux-Debug" and "Linux-Release"). Te konfiguracje zdefiniuj, jak CMake.exe jest wywoływane w celu utworzenia pamięci podręcznej CMake dla danego projektu.These configurations define how CMake.exe is invoked to create the CMake cache for a given project. Aby zmodyfikować te konfiguracje lub Utwórz nową konfigurację niestandardowe, wybierz CMake | Zmień ustawienia CMake, a następnie wybierz plik CMakeLists.txt, które ustawienia dotyczą.To modify these configurations, or create a new custom configuration, choose CMake | Change CMake Settings, and then choose the CMakeLists.txt file that the settings apply to. Zmień ustawienia CMake polecenia jest również dostępny w menu kontekstowym pliku w Eksploratora rozwiązań.The Change CMake Settings command is also available on the file's context menu in Solution Explorer. To polecenie tworzy plik CMakeSettings.json w folderze projektu.This command creates a CMakeSettings.json file in the project folder. Ten plik służy do ponownego utworzenia pliku pamięci podręcznej CMake, na przykład po wyczyść operacji.This file is used to re-create the CMake cache file, for example after a Clean operation.

Polecenia menu głównego CMake ustawienia zmian

JSON IntelliSense pomaga edytować plik CMakeSettings.json:JSON IntelliSense helps you edit the CMakeSettings.json file:

IntelliSense CMake JSONCMake JSON IntelliSense

W poniższym przykładzie przedstawiono Przykładowa konfiguracja, która służy jako punkt początkowy do tworzenia własnych w CMakeSettings.json:The following example shows a sample configuration, which you can use as the starting point to create your own in CMakeSettings.json:

    {
      "name": "x86-Debug",
      "generator": "Ninja",
      "configurationType": "Debug",
      "inheritEnvironments": [ "msvc_x86" ],
      "buildRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build\\${name}",
      "installRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\install\\${name}",
      "cmakeCommandArgs": "",
      "buildCommandArgs": "-v",
      "ctestCommandArgs": ""
    },
  1. Nazwa: Nazwa wyświetlana na liście rozwijanej konfiguracji C++.name: the name that appears in the C++ configuration dropdown. Wartość tej właściwości mogą służyć jako makra, ${name}, aby określić wartości innych właściwości.This property value can also be used as a macro, ${name}, to specify other property values. Na przykład zobacz buildRoot definicji w CMakeSettings.json.For an example, see the buildRoot definition in CMakeSettings.json.
  2. Generator: mapuje - G przełącznika i określa generatora ma być używany.generator: maps to the -G switch and specifies the generator to be used. Ta właściwość umożliwia również jako makra, ${generator}, aby określić wartości innych właściwości.This property can also be used as a macro, ${generator}, to help specify other property values. Program Visual Studio obsługuje obecnie następujących generatory CMake:Visual Studio currently supports the following CMake generators:
- <span data-ttu-id="a701b-205">"Nindżą"</span><span class="sxs-lookup"><span data-stu-id="a701b-205">"Ninja"</span></span>
- <span data-ttu-id="a701b-206">"Visual Studio 14 2015"</span><span class="sxs-lookup"><span data-stu-id="a701b-206">"Visual Studio 14 2015"</span></span>
- <span data-ttu-id="a701b-207">"Programu visual Studio 14 2015 RAMIĘ"</span><span class="sxs-lookup"><span data-stu-id="a701b-207">"Visual Studio 14 2015 ARM"</span></span>
- <span data-ttu-id="a701b-208">"Visual Studio 14 2015 Win64"</span><span class="sxs-lookup"><span data-stu-id="a701b-208">"Visual Studio 14 2015 Win64"</span></span>
- <span data-ttu-id="a701b-209">"Visual Studio 15 2017"</span><span class="sxs-lookup"><span data-stu-id="a701b-209">"Visual Studio 15 2017"</span></span>
- <span data-ttu-id="a701b-210">"RAMIĘ programie visual Studio 15 2017"</span><span class="sxs-lookup"><span data-stu-id="a701b-210">"Visual Studio 15 2017 ARM"</span></span>
- <span data-ttu-id="a701b-211">"Visual Studio 15 2017 Win64"</span><span class="sxs-lookup"><span data-stu-id="a701b-211">"Visual Studio 15 2017 Win64"</span></span>

Ponieważ Nindżą został zaprojektowany do szybkiego kompilacje prędkości zamiast elastyczność i funkcji, jest ustawiona domyślnie.Because Ninja is designed for fast builds speeds instead of flexibility and function, it is set as the default. Jednak niektóre projekty CMake może być nie można prawidłowo utworzyć przy użyciu Nindżą.However, some CMake projects may be unable to correctly build using Ninja. W takim przypadku można nakazać CMake do generowania zamiast tego projektu programu Visual Studio.If this occurs, you can instruct CMake to generate a Visual Studio project instead.

Aby określić generator Visual Studio, otwórz CMakeSettings.json z poziomu menu głównego, wybierając CMake | Zmień ustawienia CMake.To specify a Visual Studio generator, open the CMakeSettings.json from the main menu by choosing CMake | Change CMake Settings. Usuń "Nindżą" i wpisz "V".Delete “Ninja” and type “V”. Aktywuje IntelliSense, dzięki czemu można wybrać generator, który ma.This activates IntelliSense, which enables you to choose the generator you want.

  1. buildRoot: mapuje -DCMAKE_BINARY_DIR przełącznika i określa, gdzie zostanie utworzone w pamięci podręcznej CMake.buildRoot: maps to -DCMAKE_BINARY_DIR switch and specifies where the CMake cache will be created. Jeśli folder nie istnieje, jest tworzony.If the folder does not exist, it is created.
  2. zmienne: CMake zmiennych, które będą zostały przekazane jako pary nazwa wartość zawiera -Dnazwa=wartość do CMake.variables: contains a name-value pair of CMake variables that will get passed as -Dname=value to CMake. Instrukcje kompilacji projektu CMake określić dodanie wszelkie zmienne bezpośrednio do pliku pamięci podręcznej CMake, zaleca się dodanie je tutaj zamiast tego.If your CMake project build instructions specify the addition of any variables directly to the CMake cache file, it is recommended that you add them here instead.
  3. cmakeCommandArgs: określa żadnych dodatkowych przełączników, które mają zostać przekazane do CMake.exe.cmakeCommandArgs: specifies any additional switches you want to pass to CMake.exe.
  4. configurationType: Określa typ konfiguracji kompilacji dla wybranego generatora.configurationType: defines the build configuration type for the selected generator. Obecnie obsługiwane wartości to "Debug", "MinSizeRel", "Wersja" i "RelWithDebInfo".Currently supported values are "Debug", "MinSizeRel", "Release", and "RelWithDebInfo".

Zmienne środowiskoweEnvironment variables

CMakeSettings.json obsługuje również odbierającą zmienne środowiskowe w dowolnej właściwości wymienionych powyżej.CMakeSettings.json also supports consuming environment variables in any of the properties mentioned above. Składnia jest ${env.FOO} aby rozwinąć zmiennej środowiskowej % FOO %.The syntax to use is ${env.FOO} to expand the environment variable %FOO%. Masz również dostęp do wbudowanych makr wewnątrz tego pliku:You also have access to built-in macros inside this file:

  • ${workspaceRoot} — zapewnia pełną ścieżkę folderu roboczego${workspaceRoot} – provides the full path of the workspace folder
  • ${workspaceHash} — Skrót lokalizacji obszaru roboczego. przydatne w przypadku tworzenia Unikatowy identyfikator dla bieżącego obszaru roboczego (na przykład do użycia w ścieżkach folderów)${workspaceHash} – hash of workspace location; useful for creating a unique identifier for the current workspace (for example, to use in folder paths)
  • ${projectFile} — Pełna ścieżka pliku CMakeLists.txt głównego${projectFile} – the full path of the root CMakeLists.txt file
  • ${projectDir} — Pełna ścieżka do folderu głównego pliku CMakeLists.txt${projectDir} – the full path of the folder of the root CMakeLists.txt file
  • ${thisFile} — Pełna ścieżka pliku CMakeSettings.json${thisFile} – the full path of the CMakeSettings.json file
  • ${name} — Nazwa konfiguracji${name} – the name of the configuration
  • ${generator} — Nazwa generatora CMake używany w tej konfiguracji${generator} – the name of the CMake generator used in this configuration

Argumenty wiersza polecenia nindżąNinja command line arguments

Jeśli obiekty docelowe nieokreślony, tworzy element docelowy "default" (zobacz Podręcznik).If targets are unspecified, builds the 'default' target (see manual).

C:\Program Files (x86)\Microsoft Visual Studio\Preview\Enterprise>ninja -?
ninja: invalid option -- `-?'
usage: ninja [options] [targets...]
OpcjaOption OpisDescription
--wersji--version Drukowanie nindżą wersja ("1.7.1")print ninja version ("1.7.1")
-C DIR-C DIR Zmień katalog przed wykonaniem jakichkolwiek innych czynnościchange to DIR before doing anything else
-f pliku-f FILE Określ plik wejściowy kompilacji (default=build.ninja)specify input build file (default=build.ninja)
-j N-j N równoległe wykonywanie zadań N (domyślne = 14 pochodzące z procesorów dostępnych)run N jobs in parallel (default=14, derived from CPUs available)
-k N-k N Zachowaj przechodzi do momentu N zadanie zakończy się niepowodzeniem (domyślne = 1)keep going until N jobs fail (default=1)
-l N-l N Nie uruchamiaj nowe zadania, jeśli średnia obciążenia jest większa niż Ndo not start new jobs if the load average is greater than N
-n Uruchom wysuszyć (nie działają polecenia, ale działa jak one zakończyło się powodzeniem)dry run (don't run commands but act like they succeeded)
-v-v Pokaż wszystkie wiersze poleceń podczas kompilowaniashow all command lines while building
-d tryb-d MODE Włącz debugowanie (tryby listy do użycia -d)enable debugging (use -d list to list modes)
t — narzędzie-t TOOL Uruchom subtool (Użyj -t listy do narzędzi niższego poziomu).run a subtool (use -t list to list subtools). kończy opcje toplevel; dodatkowe flagi są przekazywane do narzędziaterminates toplevel options; further flags are passed to the tool
-w flagi-w FLAG Dostosuj ostrzeżenia (Użyj -w listy do ostrzeżenia)adjust warnings (use -w list to list warnings)

Dziedziczony środowisk (Visual Studio 2017 wersji 15,5 cala)Inherited environments (Visual Studio 2017 version 15.5)

CMakeSettings.json obsługuje teraz dziedziczone środowiska.CMakeSettings.json now supports inherited environments. Ta funkcja umożliwia (1) dziedziczyć domyślnego środowiska i (2) Utwórz zmienne środowiskowe niestandardowych, które są przekazywane do CMake.exe, gdy jest uruchamiany.This feature enables you to (1) inherit default environments and (2) create custom environment variables that are passed to CMake.exe when it runs.

  "inheritEnvironments": [ "msvc_x64_x64" ]

W powyższym przykładzie jest taka sama jak działa wiersz polecenia dla programu VS 2017 deweloperów z -arch = amd64-host_arch = amd64 argumentów.The example above is the same as running the Developer Command Prompt for VS 2017 with the -arch=amd64 -host_arch=amd64 arguments.

W poniższej tabeli przedstawiono domyślne wartości i ich odpowiedniki wiersza polecenia:The following table shows the default values and their command line equivalents:

Nazwa kontekstuContext Name OpisDescription
vsdevvsdev Domyślne środowisko Visual StudioThe default Visual Studio environment
msvc_x86msvc_x86 Kompiluj x86 przy użyciu x86 narzędziaCompile for x86 using x86 tools
msvc_armmsvc_arm Kompiluj ARM przy użyciu x86 narzędziaCompile for ARM using x86 tools
msvc_arm64msvc_arm64 Kompilacji dla ARM64 przy użyciu x86 narzędziaCompile for ARM64 using x86 tools
msvc_x86_x64msvc_x86_x64 Kompiluj dla AMD64, przy użyciu x86 narzędziaCompile for AMD64 using x86 tools
msvc_x64_x64msvc_x64_x64 Kompiluj dla AMD64, za pomocą narzędzia 64-bitowyCompile for AMD64 using 64-bit tools
msvc_arm_x64msvc_arm_x64 Kompiluj ARM przy użyciu narzędzia 64-bitowyCompile for ARM using 64-bit tools
msvc_arm64_x64msvc_arm64_x64 Kompilacji dla ARM64 przy użyciu narzędzia 64-bitowyCompile for ARM64 using 64-bit tools

Zmienne środowiskowe niestandardowychCustom environment variables

W CMakeSettings.json, można zdefiniować zmienne niestandardowe środowiska globalnie lub na konfigurację w środowisk właściwości.In CMakeSettings.json, you can define custom environment variables globally or per-configuration in the environments property. W poniższym przykładzie zdefiniowano jednej zmiennej globalnej, BuildDir, dziedziczoną w konfiguracjach x86 debugowania i x64 debugowania.The following example defines one global variable, BuildDir, which is inherited in both the x86-Debug and x64-Debug configurations. Każdej konfiguracji użyto zmiennej do określenia wartości buildRoot właściwości dla tej konfiguracji.Each configuration uses the variable to specify the value for the buildRoot property for that configuration. Należy też zauważyć, jak każdej konfiguracji używa inheritEnvironments właściwości w celu określenia zmiennej, która ma zastosowanie tylko do tej konfiguracji.Note also how each configuration uses the inheritEnvironments property to specify a variable that applies only to that configuration.

{
  // The "environments" property is an array of key value pairs of the form
  // { "EnvVar1": "Value1", "EnvVar2": "Value2" }
  "environments": [
    {
      "BuildDir": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build",
    }
  ],

  "configurations": [
    {
      "name": "x86-Debug",
      "generator": "Ninja",
      "configurationType": "Debug",
      // Inherit the defaults for using the MSVC x86 compiler.
      "inheritEnvironments": [ "msvc_x86" ],
      "buildRoot": "${env.BuildDir}\\${name}"    },
    {
      "name": "x64-Debug",
      "generator": "Ninja",
      "configurationType": "Debug",
      // Inherit the defaults for using the MSVC x64 compiler.
      "inheritEnvironments": [ "msvc_x64" ],
      "buildRoot": "${env.BuildDir}\\${name}"
    }
  ]
}

W następnym przykładzie z konfiguracji debugowania x86 definiuje wartość dla BuildDir właściwości i ta wartość zastępuje wartość ustawioną przez globalnej BuildDir właściwości, aby BuildRoot daje w wyniku D:\custom-builddir\x86-Debug.In the next example, the x86-Debug configuration defines its own value for the BuildDir property, and this value overrides the value set by the global BuildDir property so that BuildRoot evaluates to D:\custom-builddir\x86-Debug.

{
  "environments": [
    {
      "BuildDir": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}",
    }
  ],

  "configurations": [
    {
      "name": "x86-Debug",

      // The syntax for this property is the same as the global one above.
      "environments": [
        {
          // Replace the global property entirely.
          "BuildDir": "D:\\custom-builddir",
        }
      ],

      "generator": "Ninja",
      "configurationType": "Debug",
      "inheritEnvironments": [ "msvc_x86" ],
      // Evaluates to "D:\custom-builddir\x86-Debug"
      "buildRoot": "${env.BuildDir}\\${name}"
    },
    {
      "name": "x64-Debug",

      "generator": "Ninja",
      "configurationType": "Debug",
      "inheritEnvironments": [ "msvc_x64" ], 
      // Since this configuration doesn’t modify BuildDir, it inherits
      // from the one defined globally.
      "buildRoot": "${env.BuildDir}\\${name}"
    }
  ]
}

CMake skonfigurować krokuCMake configure step

W przypadku istotnych zmian do CMakeSettings.json lub CMakeLists.txt pliki, Visual Studio automatycznie ponownie uruchamia CMake skonfigurować kroku.When significant changes are made to the CMakeSettings.json or to CMakeLists.txt files, Visual Studio automatically re-runs the CMake configure step. Jeśli krok Konfiguruj zakończy działanie bez błędów, zbieranych informacji jest dostępnych w usługach języka i IntelliSense dla C++ i również w kompilacji i debugowania operacji.If the configure step finishes without errors, the information that is collected is available in C++ IntelliSense and language services and also in build and debug operations.

Korzystając z wielu projektów CMake taką samą nazwę konfiguracji CMake (na przykład x86-Debug), wszystkie z nich są konfigurowane i wbudowane (folder główny własnych kompilacji) po wybraniu tej konfiguracji.When multiple CMake projects use the same CMake configuration name (for example, x86-Debug), all of them are configured and built (in their own build root folder) when that configuration is selected. Można debugować elementy docelowe ze wszystkich projektów CMake uczestniczących w tej konfiguracji CMake.You can debug the targets from all of the CMake projects that participate in that CMake configuration.

Tworzenie CMake tylko element menuCMake Build Only menu item

Aby ograniczyć kompilacji i debugowania sesji do podzbioru projekty w obszarze roboczym, Utwórz nową konfigurację o unikatowej nazwie w pliku CMakeSettings.json i dotyczą tylko tych projektów.To limit builds and debug sessions to a subset of the projects in the workspace, create a new configuration with a unique name in the CMakeSettings.json file and apply it to those projects only. Po wybraniu tej konfiguracji polecenia IntelliSense i kompilacji i debugowania są włączone tylko dla określonych projektów.When that configuration is selected, the IntelliSense and build and debug commands are enabled only for those specified projects.

Rozwiązywanie problemów z błędami pamięci podręcznej CMakeTroubleshooting CMake cache errors

Aby uzyskać więcej informacji o stanie CMake pamięci podręcznej, aby zdiagnozować problem, otwórz CMake menu głównego lub CMakeLists.txt menu kontekstowego w Eksploratora rozwiązańna jeden z tych poleceń:If you need more information about the state of the CMake cache to diagnose a problem, open the CMake main menu or the CMakeLists.txt context menu in Solution Explorer to run one of these commands:

  • Wyświetlanie pamięci podręcznej otwiera plik CMakeCache.txt z folderu głównego kompilacji w edytorze.View Cache opens the CMakeCache.txt file from the build root folder in the editor. (Wszystkie zmiany wprowadzone w tym miejscu CMakeCache.txt są czyszczone Jeśli czyszczenia pamięci podręcznej.(Any edits you make here to CMakeCache.txt are wiped out if you clean the cache. Aby wprowadzić zmiany, które są zachowywane po czyszczeniu pamięci podręcznej, zobacz CMake ustawienia i konfiguracje niestandardowe we wcześniejszej części tego artykułu.)To make changes that persist after the cache is cleaned, see CMake settings and custom configurations earlier in this article.)
  • Otwórz Folder pamięci podręcznej zostanie otwarte okno Eksploratora do folderu głównego kompilacji.Open Cache Folder opens an Explorer window to the build root folder.
  • Czyszczenie pamięci podręcznej usuwa folder główny kompilacji, aby dalej CMake skonfigurowanie uruchamia krok z czystą pamięci podręcznej.Clean Cache deletes the build root folder so that the next CMake configure step starts from a clean cache.
  • Generowanie pamięci podręcznej wymusza krok Generuj do uruchomienia, nawet jeśli program Visual Studio uwzględnia aktualnego środowiska.Generate Cache forces the generate step to run even if Visual Studio considers the environment up-to-date.