Tutorial: Instalación y uso de paquetes con vcpkg

Artículo
05/01/2024

En este tutorial se muestra cómo crear un programa de "Hola mundo" de C++ que usa la fmt biblioteca con CMake y vcpkg. Instalará dependencias, configurará, compilará y ejecutará una aplicación sencilla.

Requisitos previos

Un terminal
Un compilador de C++
CMake
Git

Nota:

Para los usuarios de Windows, MSVC de Visual Studio (Compilador de Microsoft Visual C++) es el compilador necesario para el desarrollo de C++.

1 - Configurar vcpkg

Clonación del repositorio

El primer paso es clonar el repositorio vcpkg desde GitHub. El repositorio contiene scripts para adquirir el ejecutable vcpkg y un registro de bibliotecas de código abierto mantenidas mantenidas por la comunidad de vcpkg. Para hacerlo, ejecute lo siguiente:
```
git clone https://github.com/microsoft/vcpkg.git
```
El registro mantenido de vcpkg es un conjunto de más de 2000 bibliotecas de código abierto. Las canalizaciones de integración continua de vcpkg han validado estas bibliotecas para trabajar conjuntamente. Aunque el repositorio vcpkg no contiene el código fuente de estas bibliotecas, contiene recetas y metadatos para compilarlos e instalarlos en el sistema.
Ejecución del script de arranque

Ahora que ha clonado el repositorio vcpkg, vaya al vcpkg directorio y ejecute el script de arranque:
```
cd vcpkg && bootstrap-vcpkg.bat
```
```
cd vcpkg; .\bootstrap-vcpkg.bat
```
```
cd vcpkg && ./bootstrap-vcpkg.sh
```
El script de arranque realiza comprobaciones de requisitos previos y descarga el ejecutable vcpkg.

Eso es todo. vcpkg está configurado y listo para usarse.

2 - Configurar el proyecto

Configure la variable de entorno VCPKG_ROOT.
```
export VCPKG_ROOT=/path/to/vcpkg
export PATH=$VCPKG_ROOT:$PATH
```
Nota:

Establecer variables de entorno con el export comando solo afecta a la sesión de shell actual. Para que este cambio sea permanente entre sesiones, agregue el export comando al script de perfil del shell (por ejemplo, ~/.bashrc o ~/.zshrc).
```
set VCPKG_ROOT="C:\path\to\vcpkg"
set PATH=%VCPKG_ROOT%;%PATH%
```
Nota:

Establecer variables de entorno de esta manera solo afecta a la sesión de terminal actual. Para realizar estos cambios permanentes en todas las sesiones, establézcalos en el panel Variables de entorno del sistema de Windows.
```
$env:VCPKG_ROOT = "C:\path\to\vcpkg"
$env:PATH = "$env:VCPKG_ROOT;$env:PATH"
```
Nota:

Establecer variables de entorno de esta manera solo afecta a la sesión de terminal actual. Para realizar estos cambios permanentes en todas las sesiones, establézcalos en el panel Variables de entorno del sistema de Windows.
La configuración VCPKG_ROOT indica a vcpkg dónde se encuentra la instancia de vcpkg. Agregarlo a PATH garantiza que puede ejecutar comandos vcpkg directamente desde el shell.
Cree el directorio del proyecto.
```
mkdir helloworld && cd helloworld
```

3- Agregar dependencias y archivos de proyecto

Cree el archivo de manifiesto y agregue la fmt dependencia.

En primer lugar, cree un archivo de manifiesto (vcpkg.json) en el directorio del proyecto ejecutando el vcpkg new comando desde el helloworld directorio :
```
vcpkg new --application
```
A continuación, agregue la fmt dependencia:
```
vcpkg add port fmt
```
vcpkg.json ahora debería presentar un aspecto similar a este:
```
{
    "dependencies": [
        "fmt"
    ]
}
```
Este es el archivo de manifiesto. vcpkg lee el archivo de manifiesto para obtener información sobre qué dependencias instalar e integrar con CMake para proporcionar las dependencias necesarias para el proyecto.

El archivo predeterminado vcpkg-configuration.json presenta restricciones de línea base , especificando las versiones mínimas de las dependencias que debe usar el proyecto. Aunque la modificación de este archivo está fuera del ámbito de este tutorial, desempeña un papel fundamental en la definición de restricciones de versión para las dependencias del proyecto. Por lo tanto, aunque no sea estrictamente necesario para este tutorial, se recomienda agregar vcpkg-configuration.json al control de código fuente para garantizar la coherencia de versiones en distintos entornos de desarrollo.
Cree los archivos del proyecto.

Cree el CMakeLists.txt archivo con el siguiente contenido:
```
cmake_minimum_required(VERSION 3.10)

project(HelloWorld)

find_package(fmt CONFIG REQUIRED)

add_executable(HelloWorld main.cpp)

target_link_libraries(HelloWorld PRIVATE fmt::fmt)
```
Ahora, vamos a desglosar lo que hace cada línea del CMakeLists.txt archivo:
- cmake_minimum_required(VERSION 3.10): especifica que la versión mínima de CMake necesaria para compilar el proyecto es 3.10. Si la versión de CMake instalada en el sistema es inferior a esta, se generará un error.
- project(HelloWorld): establece el nombre del proyecto en "HelloWorld".
- find_package(fmt CONFIG REQUIRED): busca la fmt biblioteca mediante su archivo de configuración de CMake. La REQUIRED palabra clave garantiza que se genere un error si no se encuentra el paquete.
- add_executable(HelloWorld main.cpp): agrega un destino ejecutable denominado "HelloWorld", compilado a partir del archivo main.cppde origen .
- target_link_libraries(HelloWorld PRIVATE fmt::fmt): especifica que el HelloWorld ejecutable debe vincularse con la fmt biblioteca. La PRIVATE palabra clave indica que fmt solo es necesario para compilar HelloWorld y no debe propagarse a otros proyectos dependientes.
Cree el main.cpp archivo con el siguiente contenido:
```
#include <fmt/core.h>

int main()
{
    fmt::print("Hello World!\n");
    return 0;
}
```
En este main.cpp archivo, el <fmt/core.h> encabezado se incluye para usar la fmt biblioteca. A main() continuación, la función llama fmt::print() a para generar el mensaje "Hola mundo!" en la consola.

4- Compilación y ejecución del proyecto

Ejecución de la configuración de CMake

Para permitir que el sistema de proyectos de CMake reconozca las bibliotecas de C++ proporcionadas por vcpkg, deberá proporcionar el vcpkg.cmake archivo de cadena de herramientas. Para automatizar esto, cree un CMakePresets.json archivo en el directorio "helloworld" con el siguiente contenido:
```
{
  "version": 2,
  "configurePresets": [
    {
      "name": "default",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}
```
Este CMakePresets.json archivo contiene un único valor preestablecido "predeterminado" para CMake y establece la CMAKE_TOOLCHAIN_FILE variable . CMAKE_TOOLCHAIN_FILE permite que el sistema de proyectos de CMake reconozca las bibliotecas de C++ proporcionadas por vcpkg. CMakePresets.json Agregar automatiza el proceso de especificar la cadena de herramientas al ejecutar CMake.

Configure la compilación mediante CMake:
```
cmake --preset=default
```
Compilación del proyecto

Ejecute:
```
cmake --build build
```
Ejecución de la aplicación

Por último, ejecute el archivo ejecutable para ver la aplicación en acción:
```
./build/HelloWorld

Hello World!
```
```
.\build\HelloWorld.exe

Hello World!
```

Pasos siguientes

Para más información sobre , consulte nuestra documentación de vcpkg.jsonreferencia:

Compartir a través de