Partage via

Tutoriel : Installer une dépendance à partir d’un fichier manifeste

  • Article

vcpkg a deux modes d’opération : le mode classique et le mode manifeste. Cet article explique comment installer des packages à l’aide du mode manifeste, qui est le flux de travail recommandé pour la plupart des utilisateurs.

En mode manifeste, vous déclarez les dépendances directes de votre projet dans un fichier manifeste nommé vcpkg.json.

Les fichiers manifestes ont leur propre vcpkg_installed répertoire où ils installent des dépendances, contrairement au mode classique, où tous les packages sont installés dans un répertoire commun %VCPKG_ROOT%/installed . Par conséquent, chaque projet peut avoir son propre manifeste et son propre ensemble de dépendances qui ne sont pas en conflit avec les dépendances d’autres projets.

Le mode manifeste est également nécessaire pour utiliser des fonctionnalités avancées telles que le contrôle de version et les registres personnalisés.

Dans ce didacticiel, vous apprendrez à :

Prérequis

  • vcpkg
  • Un terminal
  • Éditeur de code
  • Compilateur C++
  • (Facultatif) CMake ou MSBuild

1 - Créer un projet avec un manifeste

Dans un nouveau dossier, créez un fichier source nommé main.cxx avec le contenu suivant :

#include <cxxopts.hpp>
#include <fmt/format.h>
#include <range/v3/view.hpp>

namespace view = ranges::views;

int fib(int x)
{
  int a = 0, b = 1;

  for (int it : view::repeat(0) | view::take(x))
  {
    (void)it;
    int tmp = a;
    a += b;
    b = tmp;
  }

  return a;
}

int main(int argc, char **argv)
{
  cxxopts::Options options("fibo", "Print the fibonacci sequence up to a value 'n'");
  options.add_options()("n,value", "The value to print to", cxxopts::value<int>()->default_value("10"));

  auto result = options.parse(argc, argv);
  auto n = result["value"].as<int>();

  for (int x : view::iota(1) | view::take(n))
  {
    fmt::print("fib({}) = {}\n", x, fib(x));
  }
}

Le code fait référence aux bibliothèques open source : cxxopts, fmtet range-v3; qui sont toutes disponibles dans le registre public vcpkg à l’adresse https://github.com/Microsoft/vcpkg.

Pour déclarer ces dépendances, créez un fichier nommé vcpkg.json dans le même répertoire que votre projet :

vcpkg.json:

{
  "dependencies": [
    "cxxopts",
    "fmt",
    "range-v3"
  ]
}

Vous devez uniquement spécifier vos dépendances directes dans la "dependencies" liste. Lorsqu’il s’exécute, vcpkg résout et installe toutes les dépendances transitives requises.

2 - Intégrer vcpkg à votre système de build

Dans cette étape, nous vous montrons comment intégrer vcpkg à CMake ou MSBuild afin que vos dépendances de projet soient automatiquement installées ou restaurées chaque fois que vous générez le projet.

Si vous utilisez un autre système de génération, passez à l’étape suivante : Installez les dépendances.

En savoir plus sur l’utilisation de vcpkg à partir de MSBuild

Pour utiliser vcpkg dans vos projets MSBuild, exécutez la commande suivante :

vcpkg integrate install

Vous devez uniquement exécuter la vcpkg integrate install commande la première fois que vous souhaitez activer l’intégration MSBuild. Cela permet l’intégration de MSBuild pour tous vos projets existants et futurs. Permet vcpkg integrate remove de supprimer l’intégration à l’échelle du système MSBuild.

Cette méthode d’intégration ajoute automatiquement des packages installés par vcpkg aux propriétés de projet suivantes : Include Directories, Link Directorieset Link Libraries. En outre, cela crée une action post-build qui garantit que toutes les DLL requises sont copiées dans le dossier de sortie de build. Cela fonctionne pour toutes les solutions et projets à l’aide de Visual Studio 2015 ou version ultérieure.

3 - Installer les dépendances

Si vous utilisez CMake ou MSBuild et que vous avez suivi l’étape précédente, vous pouvez passer à l’étape suivante : Générer le projet.

Si vous utilisez un autre système de génération ou que vous souhaitez installer les dépendances manuellement, vous devez tout exécuter vcpkg install dans le répertoire contenant votre fichier manifeste.

PS D:\projects\manifest-example> vcpkg install
Detecting compiler hash for triplet x64-windows...
The following packages will be built and installed:
    cxxopts:x64-windows -> 3.1.1
    fmt:x64-windows -> 10.0.0
    range-v3:x64-windows -> 0.12.0#1
  * vcpkg-cmake:x64-windows -> 2023-05-04
  * vcpkg-cmake-config:x64-windows -> 2022-02-06#1
Additional packages (*) will be modified to complete this operation.
Installing 1/5 vcpkg-cmake-config:x64-windows...
Installing 2/5 vcpkg-cmake:x64-windows...
Installing 3/5 cxxopts:x64-windows...
Installing 4/5 fmt:x64-windows...
Installing 5/5 range-v3:x64-windows...
Total install time: 48 s
cxxopts provides CMake targets:

    # this is heuristically generated, and may not be correct
    find_package(cxxopts CONFIG REQUIRED)
    target_link_libraries(main PRIVATE cxxopts::cxxopts)

The package fmt provides CMake targets:

    find_package(fmt CONFIG REQUIRED)
    target_link_libraries(main PRIVATE fmt::fmt)

    # Or use the header-only version
    find_package(fmt CONFIG REQUIRED)
    target_link_libraries(main PRIVATE fmt::fmt-header-only)

range-v3 provides CMake targets:

    # this is heuristically generated, and may not be correct
    find_package(range-v3 CONFIG REQUIRED)
    target_link_libraries(main PRIVATE range-v3::meta range-v3::concepts range-v3::range-v3)

Une fois la commande terminée, tous les packages générés sont présents dans un vcpkg_installed répertoire. L’emplacement spécifique de ce répertoire dépend de votre système de build ; généralement, dans le dossier de sortie par défaut du système de génération, ou en regard de votre vcpkg.json fichier.

4 - Générer le projet

Par défaut, le mode manifeste est désactivé dans les projets MSBuild.

Pour activer les manifestes dans votre projet, définissez la VcpkgEnableManifest propriété dans votre .vcxproj fichier :

<PropertyGroup Label="Vcpkg">
  <VcpkgEnableManifest>true</VcpkgEnableManifest>
</PropertyGroup>

Vous pouvez également activer le mode manifeste dans votre appel MSBuild en passant msbuild /p:VcpkgEnableManifest=true en tant que paramètre.

PS D:\projects\manifest-example> msbuild /p:VcpkgEnableManifest=true
MSBuild version 17.7.0-preview-23319-02+6829506b8 for .NET Framework
Build started 8/11/2023 11:29:50 AM.

Project "D:\projects\manifest-example\manifest-example.sln" on node 1 (default targets).
ValidateSolutionConfiguration:
  Building solution configuration "Debug|x64".
Project "D:\projects\manifest-example\manifest-example.sln" (1) is building "D:\projects\manifest-example\manifest-example.vcxproj" (2) on node 1 (default targets).
PrepareForBuild:
  (omitted)
InitializeBuildStatus:
  (omitted)
ComputeStdModulesCompileInputs:
  (omitted)
SetModuleDependencies:
  Creating directory "x64\Debug\manifest.ceffc6eb_MD.tlog\".
VcpkgTripletSelection:
  Using triplet "x64-windows" from "D:\projects\manifest-example\vcpkg_installed\x64-windows\x64-windows\"
  Using normalized configuration "Debug"
VcpkgInstallManifestDependencies:
  Installing vcpkg dependencies to D:\projects\manifest-example\vcpkg_installed\x64-windows\
  Creating directory "D:\projects\manifest-example\vcpkg_installed\x64-windows\".
  "D:\vcpkg\vcpkg.exe" install  --x-wait-for-lock --triplet "x64-windows" --vcpkg-root "D:\vcpkg\" "--x-manifest-root=D:\projects\manifest-example\" "--x-install-root=D:\projects\manifest-example\vcpkg_installed\x64-windows\"
  "D:\vcpkg\vcpkg.exe" install  --x-wait-for-lock --triplet "x64-windows" --vcpkg-root "D:\vcpkg\" "--x-manifest-root=D:\projects\manifest-example\" "--x-install-root=D:\projects\manifest-example\vcpkg_installed\x64-windows\"
  Detecting compiler hash for triplet x64-windows...
  The following packages will be built and installed:
      cxxopts:x64-windows -> 3.1.1
      fmt:x64-windows -> 10.0.0
      range-v3:x64-windows -> 0.12.0#1
    * vcpkg-cmake:x64-windows -> 2023-05-04
    * vcpkg-cmake-config:x64-windows -> 2022-02-06#1
  (omitted)
ClCompile:
  (omitted)
Link:
  (omitted)
AppLocalFromInstalled:
  pwsh.exe -ExecutionPolicy Bypass -noprofile -File "D:\vcpkg\scripts\buildsystems\msbuild\applocal.ps1" "D:\projects\manif
  est-mode-msbuild\x64\Debug\manifest-example.exe" "D:\projects\manifest-example\vcpkg_installed\x64-windows\x64-windows\debug\bin"
  "x64\Debug\manifest.ceffc6eb.tlog\manifest-example.write.1u.tlog" "x64\Debug\vcpkg.applocal.log"
  D:\projects\manifest-example\x64\Debug\fmtd.dll
FinalizeBuildStatus:
  (omitted)
Done Building Project "D:\projects\manifest-example\manifest-example.vcxproj" (default targets).

Done Building Project "D:\projects\manifest-example\manifest-example.sln" (default targets).

Build succeeded.

Étapes suivantes

Dans ce guide, vous avez installé des dépendances pour un projet simple à l’aide d’un fichier manifeste.

Voici quelques tâches supplémentaires à essayer ensuite :

  • Installer des packages pour des plateformes personnalisées, des compilateurs ou des architectures de build à l’aide de triplets
  • Verrouiller vos versions pour les builds reproductibles à l’aide du contrôle de version
  • Réutiliser des fichiers binaires sur des exécutions d’intégration locale ou continue à l’aide de la mise en cache binaire
  • Gérer vos bibliothèques privées à l’aide de registres personnalisés