Depurando programas com argumentos em C++

Programas executados pelo terminal podem receber argumentos. Esses são textos e números descritos logo após digitar o nome do programa.

Até agora, utilizamos argumentos para listar os arquivos *.cpp quando chamamos o Clang.

Vamos criar um programa simples que captura o nome de um usuário como argumento e o exibe numa mensagem de boas-vindas.

Projeto

Crie uma pasta chamada hello_user dentro de dev/c_cpp_projects e navegue para dentro dela.

1
mkdir -p ~/dev/c_cpp_projects/hello_user
2
cd ~/dev/c_cpp_projects/hello_user

Crie a pasta .vscode e, dentro dela, os arquivos tasks.json e launch.json.

1
mkdir -p .vscode
2
touch .vscode/tasks.json .vscode/launch.json

Abra o VSCode na pasta atual.

1
code .

Então, crie o arquivo .gitignore na raiz do projeto, e o preencha com o snippet gitignore-c-cpp.

Finalmente, crie um arquivo chamado main.cpp na raiz do projeto .e o preencha com o código a seguir.

1
#include <iostream>
2

3
using namespace std;
4

5
int main() {
6
  cout << "Hello, world!"<< endl;
7

8
  return 0;
9
}

A estrutura de pastas deve ficar da seguinte forma.

Directorydev
- Directoryc_cpp_projects
  - Directoryhello_user
    Directory.vscode
    launch.json
    tasks.json
    .gitignore
    main.cpp

Compilação

Utilize o snippet tasks-json para inicializar o arquivo tasks.json com o seguinte código:

1
{
2
  "version": "2.0.0",
3
  "tasks": []
4
}

Utilize o snippet cpp-build-task para preencher o vetor tasks. O conteúdo do arquivo será o seguinte:

1
{
2
  "version": "2.0.0",
3
  "tasks": [
4
    {
5
      "args": [
6
        "-fcolor-diagnostics",
7
        "-fansi-escape-codes",
8
        "-g",
9
        "${workspaceFolder}/*.cpp",
10
        "-I",
11
        "${workspaceFolder}",
12
        "-o",
13
        "${workspaceFolder}/build/${workspaceFolderBasename}"
14
      ],
15
      "command": "clang++",
16
      "detail": "Tarefa de compilação de um projeto em C++. Compila todos os arquivos C++ na raiz do projeto em um único executável.",
17
      "group": {
18
        "kind": "build"
19
      },
20
      "label": "Clang: build C++ project (Local)",
21
      "options": {
22
        "cwd": "${workspaceFolder}"
23
      },
24
      "problemMatcher": ["$gcc"],
25
      "type": "cppbuild"
26
    }
27
  ]
28
}

Execução

Então, utilize o snippet launch-json para inicializar o arquivo launch.json com o seguinte código:

1
{
2
  "configurations": [],
3
  "version": "0.2.0"
4
}

Por fim, utilize o snippet cpp-launch para preencher o vetor configurations. O conteúdo do arquivo será o seguinte:

1
{
2
  "configurations": [
3
    {
4
      "args": [],
5
      "cwd": "${workspaceFolder}",
6
      "name": "LLDB: build and launch C++ project (Local)",
7
      "preLaunchTask": "Clang: build C++ project (Local)",
8
      "program": "${workspaceFolder}/build/${workspaceFolderBasename}",
9
      "request": "launch",
10
      "terminal": "console",
11
      "type": "lldb"
12
    }
13
  ],
14
  "version": "0.2.0"
15
}

Argumentos

Para obtermos os argumentos passados para o programa, precisamos fazer uma pequena alteração na função main. Vamos incluir nela os parâmetros int argc e char *argv[].

5
int main(int argc, char *argv[]) {
6
  cout << "Hello, world!"<< endl;
7

8
  return 0;
9
}

O parâmetro int argc representa a quantidade de argumentos que o usuário informou para o programa.
Já o parâmetro char *argv[] se trata de um vetor de strings que guarda cada argumento informado.

Programa

O primeiro argumento da lista é sempre o caminho (ou path) do arquivo executável chamado. Podemos conferir isso com uma modificação no nosso programa. Vamos receber o argumento de índice 0 em uma variável. Então, imprimiremos seu valor.

Edite o arquivo main.cpp da seguinte forma:

5
int main(int argc, char *argv[]) {
6
  auto program = argv[0];
7
  cout << "This is the program " << program << "." << endl;
8

9
  return 0;
10
}

Para executar nosso programa, acesse o menu de depuração clicando no ícone de bug ou pelo atalho Control + Shift + D Control + Shift + D . Então clique no botão de play verde ou, se preferir, use o atalho de teclado F5 F5 .

A execução será exibida na aba Debug console. Você pode acessá-la com o atalho Control + Shift + Y Control + Shift + Y .

Aba "Debug console" do Visual Studio Code, em que o programa "hello_user" é executado. Ele exibe no console o seguinte texto: "This is the program /home/gabriel/dev/c_cpp_projects/hello_user/build/hello_user.". — Execução do programa exibindo o caminho do arquivo executado.

Opcionais

Agora, vamos receber o segundo argumento, em que o usuário informará seu nome.

Em todos os programas, devemos tratar os argumentos de índice 1 em diante como opcionais. De fato, o usuário não é obrigado a fornecê-los. Assim, é nossa responsabilidade tratar esse caso.

A primeira forma de tratar a entrada de dados é verificar a quantidade de argumentos fornecidos.

Caso ela seja igual a 1, então apenas o próprio programa foi chamado.
De 2 em diante, sabemos que o usuário informou pelo menos um argumento.

Vamos fazer essa verificação. Caso o nome do usuário não tenha sido fornecido, imprimiremos que ele é um usuário desconhecido.

Edite o arquivo main.cpp da seguinte forma:

5
int main(int argc, char *argv[]) {
6
  auto program = argv[0];
7
  cout << "This is the program " << program << "." << endl;
8

9
  cout << "Hello, ";
10

11
  if (argc < 2) {
12
    cout << "unknown user";
13
  }
14

15
  cout << "!" << endl;
16

17
  return 0;
18
}

Compile o programa pelo VSCode. Você pode utilizar o atalho Control + Shift + B Control + Shift + B e executar a tarefa Clang: build C++ project (Local).

Vamos executar o programa via linha de comando. Lembre-se de que, quando o programa é compilado automaticamente pelo VSCode, seu arquivo executável fica dentro da pasta build.

1
./build/hello_user
2
# This is the program ./build/hello_user.
3
# Hello, unknown user!

Nesse caso, como chamamos o programa manualmente pelo caminho ./build/hello_user, este foi impresso no terminal. Na linha abaixo, o programa imprimiu que somos um usuário desconhecido.

Agora, vamos tratar um argumento recebido. Caso o número de argumentos fornecido seja pelo menos 2, receberemos aquele de índice 1 em uma variável. Nesse caso, poderemos imprimi-lo como o nome do usuário.

Edite o arquivo main.cpp da seguinte forma:

1
#include <iostream>
2

3
using namespace std;
4

5
int main(int argc, char *argv[]) {
6
  auto program = argv[0];
7
  cout << "This is the program " << program << "." << endl;
8

9
  cout << "Hello, ";
10

11
  if (argc < 2) {
12
    cout << "unknown user";
13
  } else {
14
    auto name = argv[1];
15
    cout << name;
16
  }
17
  cout << "!" << endl;
18

19
  return 0;
20
}

Compile o projeto pelo VSCode como fizemos anteriormente.

Agora, ao executarmos o programa manualmente, vamos passar um nome. Ele deve ser escrito logo após o caminho do executável, e separado por um espaço. Também não devemos usar aspas ou qualquer outro delimitador.

1
./build/hello_user Gabriel
2
# This is the program ./build/hello_user.
3
# Hello, Gabriel!

Parece ótimo!

Mas e se quisermos executar o programa pelo VSCode? Ele não sabe qual é o nome do usuário a informar.

Se tentarmos executá-lo, veremos a seguinte saída no “Debug console”:

1
# This is the program /home/gabriel/dev/c_cpp_projects/hello_user/build/hello_user.
2
# Hello, unknown user!

Podemos resolver isso editando o arquivo .vscode/launch.json. O vetor args guarda a lista de argumentos a serem informados para o programa. Vamos adicionar dentro dele a string “Alice”.

1
{
2
  "configurations": [
3
    {
4
      "args": ["Alice"],
5
      "cwd": "${workspaceFolder}",
6
      "name": "LLDB: build and launch C++ project (Local)",
7
      "preLaunchTask": "Clang: build C++ project (Local)",
8
      "program": "${workspaceFolder}/build/${workspaceFolderBasename}",
9
      "request": "launch",
10
      "terminal": "console",
11
      "type": "lldb"
12
    }
13
  ],
14
  "version": "0.2.0"
15
}

Agora, se compilarmos e executarmos pelo VScode, o resultado no “Debug console” mostrará o nome “Alice”, como a seguir:

1
# This is the program /home/gabriel/dev/c_cpp_projects/hello_user/build/hello_user.
2
# Hello, Alice!

Não se esqueça de inicializar o repositório e fazer commit das modificações.