Compatibilidad de la acción Abrir carpeta con sistemas de compilación de C++ en Visual Studio

Artículo
04/03/2023

La característica "Abrir carpeta" está disponible en Visual Studio 2017 y versiones posteriores.

En Visual Studio 2017 y versiones posteriores, la característica "Abrir carpeta" permite abrir carpetas de archivos de código fuente y comenzar a escribir código compatible con IntelliSense, la exploración, la refactorización, la depuración, etc. de inmediato. A medida que edita, crea, mueve o elimina archivos, Visual Studio hace seguimiento de manera automática de los cambios y actualiza de manera continua su indice de IntelliSense. No se carga ningún archivo .sln o .vcxproj; si es necesario, se pueden especificar tareas personalizadas así como parámetros de inicio y compilación a través de archivos .json simples. Esta característica permite integrar cualquier sistema de compilación de terceros en Visual Studio. Para obtener información general sobre Abrir carpeta, vea Desarrollo de código en Visual Studio sin proyectos o soluciones.

CMake y Qt

CMake está integrado en el IDE de Visual Studio como un componente de la carga de trabajo de escritorio de C++. El flujo de trabajo de CMake no es idéntico al flujo descrito en este artículo. Si usa CMake, vea el artículo sobre proyectos de CMake en Visual Studio. También puede usar CMake para compilar proyectos de Qt, o bien puede usar la extensión de Qt de Visual Studio para Visual Studio 2015 o Visual Studio 2017.

Otros sistemas de compilación

Para usar el IDE de Visual Studio con un sistema de compilación o un conjunto de herramientas del compilador que no se admite directamente en el menú principal, seleccione Archivo | Abrir | Carpeta o presione Ctrl + Mayús + Alt + O. Vaya a la carpeta que contiene los archivos de código fuente. Para compilar el proyecto, configurar IntelliSense y establecer parámetros de depuración, debe agregar tres archivos JSON:

Archivo	Descripción
CppProperties.json	Especifique la información de configuración personalizada para la exploración. Cree este archivo, si es necesario, en la carpeta raíz del proyecto. (No se usa en los proyectos de CMake).
tasks.vs.json	Especifique los comandos de compilación personalizados. Se accede a través del elemento del menú contextual del Explorador de solucionesConfigurar tareas.
launch.vs.json	Especifique argumentos de la línea de comandos para el depurador. Se accede a través del elemento del menú contextual del Explorador de solucionesConfiguración de depuración e inicio.

Para que IntelliSense y el comportamiento de navegación, como Ir a definición, funcionen correctamente, Visual Studio debe saber qué compilador está usando, dónde están los encabezados del sistema y dónde se encuentran los archivos de inclusión adicionales si no están directamente en la carpeta que ha abierto (la carpeta del área de trabajo). Para especificar una configuración, puede elegir Administrar configuraciones en el menú desplegable de la barra de herramientas principal:

Configuration dropdown on the toolbar showing the Manage configurations selection.

Visual Studio ofrece las siguientes configuraciones predeterminadas:

Add Configuration to CppProperties dialog, showing list of Default configurations: x86-Debug, x86-Release, x64-Debug, x64-Release, and so on.

Por ejemplo, si elige x64-Debug, Visual Studio crea un archivo denominado CppProperties.json en la carpeta raíz el proyecto:

{
  "configurations": [
    {
      "inheritEnvironments": [
        "msvc_x64"
      ],
      "name": "x64-Debug",
      "includePath": [
        "${env.INCLUDE}",
        "${workspaceRoot}\\**"
      ],
      "defines": [
        "WIN32",
        "_DEBUG",
        "UNICODE",
        "_UNICODE"
      ],
      "intelliSenseMode": "windows-msvc-x64"
    }
  ]
}

Esta configuración hereda las variables de entorno del Símbolo del sistema para desarrolladores x64 de Visual Studio. Una de esas variables es INCLUDE y puede hacer referencia a ella aquí mediante la macro ${env.INCLUDE}. La propiedad includePath indica a Visual Studio dónde buscar todos los orígenes que necesita para IntelliSense. En este caso, dice "Buscar en todos los directorios especificados por la variable de entorno INCLUDE y también en todos los directorios del árbol de la carpeta de trabajo actual". La propiedad name es el nombre que aparecerá en la lista desplegable y puede ser cualquier cosa que quiera. La propiedad defines proporciona sugerencias a IntelliSense cuando encuentra bloques de compilación condicionales. La propiedad intelliSenseMode proporciona algunas sugerencias adicionales basadas en el tipo de compilador. Hay varias opciones disponibles para MSVC, GCC y Clang.

Nota:

Si parece que Visual Studio está omitiendo opciones de configuración en CppProperties.json, intente agregar una excepción al archivo .gitignore como esta: !/CppProperties.json.

Configuración predeterminada para MinGW-w64

Si agrega la configuración minGW-W64, el código JSON tendrá este aspecto:

{
  "configurations": [
    {
      "inheritEnvironments": [
        "mingw_64"
      ],
      "name": "Mingw64",
      "includePath": [
        "${env.INCLUDE}",
        "${workspaceRoot}\\**"
      ],
      "intelliSenseMode": "linux-gcc-x64",
      "environments": [
        {
          "MINGW64_ROOT": "C:\\msys64\\mingw64",
          "BIN_ROOT": "${env.MINGW64_ROOT}\\bin",
          "FLAVOR": "x86_64-w64-mingw32",
          "TOOLSET_VERSION": "9.1.0",
          "PATH": "${env.BIN_ROOT};${env.MINGW64_ROOT}\\..\\usr\\local\\bin;${env.MINGW64_ROOT}\\..\\usr\\bin;${env.MINGW64_ROOT}\\..\\bin;${env.PATH}",
          "INCLUDE": "${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION};${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION}\\tr1;${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION}\\${env.FLAVOR}",
          "environment": "mingw_64"
        }
      ]
    }
  ]
}

Fíjese en el bloque environments. Define propiedades que se comportan como variables de entorno y que están disponibles no solo en el archivo CppProperties.json, sino también en los otros archivos de configuración task.vs.json y launch.vs.json. La configuración de Mingw64 hereda el entorno de mingw_w64 y usa su propiedad INCLUDE para especificar el valor de includePath. Puede agregar otras rutas de acceso a esta propiedad de matriz según sea necesario.

La propiedad intelliSenseMode se establece en un valor adecuado para GCC. Para obtener más información sobre estas propiedades, vea la referencia de esquema CppProperties.

Cuando todo funcione correctamente, verá IntelliSense desde los encabezados de GCC al pasar el mouse sobre un tipo:

Screenshot of a GCC IntelliSense pop-up showing the header documentation.

Habilitación de los diagnósticos de IntelliSense

Si no ve la característica de IntelliSense que espera, vaya a Herramientas>Opciones>Editor de texto>C/C++>Avanzadas y establezca Habilitar registro en true para solucionar el problema. Para empezar, pruebe a establecer Nivel de registro en 5 y Filtro de registro en 8.

Options dialog, showing the Diagnostic logging settings.

La salida se canaliza a la ventana de salida y es visible al elegir *Mostrar salida desde: Registro de Visual C++. La salida contiene, entre otras cosas, la lista de rutas de acceso de inclusión reales que IntelliSense está intentando usar. Si las rutas de acceso no coinciden con las de CppProperties.json, pruebe a cerrar la carpeta y eliminar la subcarpeta .vs que contiene los datos de navegación almacenados en caché.

Definición de tareas de compilación con tasks.vs.json

Puede automatizar los scripts de compilación o cualquier otra operación externa en los archivos que tiene en el área de trabajo actual al ejecutarlos directamente en el IDE. Para configurar una tarea nueva, haga clic con el botón derecho en un archivo o una carpeta y seleccione Configurar tareas.

Solution Explorer shortcut menu showing the Configure Tasks command.

Esto crea (o abre) el archivo tasks.vs.json en la carpeta .vs que Visual Studio crea en la carpeta raíz del proyecto. En este archivo puede definir cualquier tarea arbitraria y luego invocarla desde el menú contextual del Explorador de soluciones. Para continuar el ejemplo de GCC, el fragmento de código siguiente muestra un archivo tasks.vs.json completo con una única tarea que invoca a g++.exe para compilar un proyecto. Imagine que el proyecto contiene un solo archivo llamado hello.cpp.

{
  "version": "0.2.1",
  "tasks": [
    {
      "taskLabel": "build hello",
      "appliesTo": "/",
      "type": "default",
      "command": "g++",
      "args": [
        "-g",
        "-o",
        "hello",
        "hello.cpp"
      ]
    }
  ]
}

El archivo JSON se coloca en la subcarpeta .vs. Para ver esa carpeta, haga clic en el botón Mostrar todos los archivos en la parte superior del Explorador de soluciones. Puede ejecutar esta tarea haciendo clic con el botón derecho en el nodo raíz en el Explorador de soluciones y eligiendo compilar hello. Cuando se complete la tarea, debería ver un nuevo archivo hello.exe en el Explorador de soluciones.

Puede definir muchos tipos de tareas. En el ejemplo siguiente se muestra un archivo tasks.vs.json que define una sola tarea. taskLabel define el nombre que aparece en el menú contextual. appliesTo define los archivos en los que se puede ejecutar el comando. La propiedad command hace referencia a la variable de entorno COMSPEC, que identifica la ruta de acceso de la consola (cmd.exe en Windows). También se puede hacer referencia a variables de entorno que se declaran en CppProperties.json o CMakeSettings.json. La propiedad args especifica la línea de comandos que se va a invocar. La macro ${file} recupera el archivo seleccionado en el Explorador de soluciones. En el ejemplo siguiente se muestra el nombre de archivo del archivo .cpp seleccionado actualmente.

{
  "version": "0.2.1",
  "tasks": [
    {
      "taskLabel": "Echo filename",
      "appliesTo": "*.cpp",
      "type": "command",
      "command": "${env.COMSPEC}",
      "args": ["echo ${file}"]
    }
  ]
}

Después de guardar tasks.vs.json, puede hacer clic con el botón derecho en cualquier archivo .cpp de la carpeta, seleccionar Mostrar nombre de archivo en el menú contextual y ver el nombre de archivo mostrado en la ventana de salida.

Para obtener más información, vea la referencia del esquema Tasks.vs.json.

Configurar parámetros de depuración con launch.vs.json

Para personalizar los argumentos de la línea de comandos y las instrucciones de depuración del programa, haga clic con el botón derecho en el archivo ejecutable en el Explorador de soluciones y seleccione Configuración de depuración e inicio. Se abrirá un archivo launch.vs.json existente o, si no existe ninguno, se creará un nuevo archivo con un conjunto de valores de inicio mínimos. En primer lugar, tiene la opción de elegir el tipo de sesión de depuración que quiere configurar. Para depurar un proyecto MinGW-w64, elegimos Inicio de C/C++ para MinGW/Cygwin (gdb). Esto crea una configuración de inicio para usar gdb.exe con algunas suposiciones razonadas sobre los valores predeterminados. Uno de estos valores predeterminados es MINGW_PREFIX. Puede sustituir la ruta de acceso literal (como se muestra a continuación) o definir una propiedad MINGW_PREFIX en CppProperties.json:

{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
    {
      "type": "cppdbg",
      "name": "hello.exe",
      "project": "hello.exe",
      "cwd": "${workspaceRoot}",
      "program": "${debugInfo.target}",
      "MIMode": "gdb",
      "miDebuggerPath": "c:\\msys64\\usr\\bin\\gdb.exe",
      "externalConsole": true
    }
  ]
}

Para iniciar la depuración, elija el ejecutable en la lista desplegable de depuración y, después, haga clic en la flecha verde:

Toolbar debug target dropdown, showing the green arrow to start the debugger.

Debería ver el cuadro de diálogo Initializing Debugger (Inicializando el depurador) y, luego, una ventana de consola externa que ejecuta el programa.

Para obtener más información, consulte el artículo Referencia del esquema launch.vs.json.

Inicio de otros ejecutables

Puede definir la configuración de inicio de cualquier archivo ejecutable del equipo. En el ejemplo siguiente se inicia 7za y se especifican argumentos adicionales al agregarlos a la matriz JSON args:

{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
    {
      "type": "default",
      "project": "CPP\\7zip\\Bundles\\Alone\\O\\7za.exe",
      "name": "7za.exe list content of helloworld.zip",
      "args": [ "l", "d:\\sources\\helloworld.zip" ]
    }
  ]
}

Al guardar este archivo, el nombre de la configuración nueva aparece en la lista desplegable Destino de depuración y puede seleccionarlo para iniciar el depurador. Puede crear tantas configuraciones de depuración como quiera, para cualquier número de archivos ejecutables. Si ahora presiona F5, se iniciará el depurador y se alcanzará cualquier punto de interrupción que se haya establecido. Todas las ventanas del depurador conocidas y su funcionalidad estarán ahora disponibles.

Compartir a través de