boost
Öka programalternativ

Grundläggande användning

Boost-programalternativ är ett enkelt och säkert sätt att analysera och hantera kommandoradsargument.

#include <boost/program_options.hpp>
#include <string>
#include <iostream>

int main(int argc, char** argv) {
  namespace po = boost::program_options;

  po::variables_map vm;
  po::options_description desc("Allowed Options");

  // declare arguments
  desc.add_options()
    ("name", po::value<std::string>()->required(), "Type your name to be greeted!");

  // parse arguments and save them in the variable map (vm)
  po::store(po::parse_command_line(argc, argv, desc), vm);

  std::cout << "Hello " << vm["name"].as<std::string>() << std::endl;

  return 0;
}

Kompilera och kör med:

 $ g++ main.cpp -lboost_program_options && ./a.out --name Batman
Hello Batman

Du kan mata ut en boost::program_options::options_description att skriva ut det förväntade argumentformatet:

std::cout << desc << std::endl;

skulle producera:

Allowed Options:
  --name arg                Type your name to be greeted!

Felhantering

boost::program_options::notify kan användas för att rapportera eventuella fel i de som passerar parametrarna

#include <boost/program_options.hpp>
#include <string>
#include <iostream>

int main(int argc, char** argv) {
  namespace po = boost::program_options;

  po::variables_map vm;
  po::options_description desc("Allowed Options");

  // declare options
  desc.add_options()
    ("name", po::value<std::string>()->required(), "Type your name to be greeted!");

  // parse arguments
  po::store(po::parse_command_line(argc, argv, desc), vm);

  // check arguments
  try {
    po::notify(vm);
  } catch (std::exception& e) {
    std::cout << "Error: " << e.what() << std::endl;
    std::cout << desc << std::endl;
    return 1;
  }

  // program logic
  std::cout << "Hello " << vm["name"].as<std::string>() << std::endl;

  return 0;
}

Att skicka olagliga argument ger användbara felmeddelanden

 $ ./a.out
Error: the option '--name' is required but missing
Allowed Options:
  --name arg            Type your name to be greeted!

Ursprungliga värden

Ett standardvärderat kommandoradsargument kan enkelt anges:

// declare options
desc.add_options()
  ("name", po::value<std::string>()->required(), "Type your name to be greeted!")
  ("rank", po::value<std::string>()->default_value("Dark Knight"), "Your rank");

Dess värde läggs också till variabeln karta:

  std::cout << "Hello " << vm["name"].as<std::string>() << " " << vm["rank"].as<std::string>() << std::endl;

Standardvärdet visas i beskrivningen ...

$ ./a.out
Error: the option '--name' is required but missing
Allowed Options:
  --name arg                Type your name to be greeted!
  --rank arg (=Dark Knight) Your rank

... och används om det inte anges ...

$ ./a.out --name Batman
Hello Batman Dark Knight

... men kan skrivas över på kommandoraden:

 $ ./a.out --name Batman --rank FlyingSquirrel
Hello Batman FlyingSquirrel

Växlar

En switch är ett kommandoradsargument som inte tar något värde. Det kan specificeras med:

desc.add_options()
  ("hidden", po::bool_switch()->default_value(false), "Hide your name");

Och används med:

if (vm["hidden"].as<bool>())
   std::cout << "Hello *****" << std::endl;

från kommandoraden:

 $ ./a.out --name Batman --hidden
Hello *****

och i beskrivningen visas den som:

Allowed Options:
  --name arg                Type your name to be greeted!
  --rank arg (=Dark Knight) Your rank
  --hidden                  Hide your name