options cannot be stored in variables

Open
#68 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
cli

Research direction

Start with the supplied main entry point and reproduce the command-line example using Boost 1.68 on MSVC 2017. Compare the bound variables such as depends with the corresponding variables_map values and check the tutorial's storage-variable guidance. Done means the behavior is explained and either corrected or clearly documented, with the example producing consistent values.

Written by the indexing model from the issue text.

Description

It seems like storing options in variables doesn't work.

Sample code (based on tutorial):

#include <boost/program_options.hpp>
using namespace boost::program_options;

#include <iostream>
using namespace std;

/* Auxiliary functions for checking input for validity. */

/* Function used to check that 'opt1' and 'opt2' are not specified
at the same time. */
void conflicting_options(const variables_map& vm,
  const char* opt1, const char* opt2)
{
  if (vm.count(opt1) && !vm[opt1].defaulted()
    && vm.count(opt2) && !vm[opt2].defaulted())
    throw logic_error(string("Conflicting options '")
      + opt1 + "' and '" + opt2 + "'.");
}

/* Function used to check that of 'for_what' is specified, then
'required_option' is specified too. */
void option_dependency(const variables_map& vm,
  const char* for_what, const char* required_option)
{
  if (vm.count(for_what) && !vm[for_what].defaulted())
    if (vm.count(required_option) == 0 || vm[required_option].defaulted())
      throw logic_error(string("Option '") + for_what
        + "' requires option '" + required_option + "'.");
}

int main(int argc, char* argv[])
{
  try {
    string ofile;
    string macrofile, libmakfile;
    bool t_given = false;
    bool b_given = false;
    string mainpackage;
    string depends = "deps_file";
    string sources = "src_file";
    string root = ".";

    options_description desc("Allowed options");
    desc.add_options()
      // First parameter describes option name/short name
      // The second is parameter to option
      // The third is description
      ("help,h", "print usage message")
      ("output,o", value(&ofile), "pathname for output")
      ("macrofile,m", value(&macrofile), "full pathname of macro.h")
      ("two,t", bool_switch(&t_given), "preprocess both header and body")
      ("body,b", bool_switch(&b_given), "preprocess body in the header context")
      ("libmakfile,l", value(&libmakfile),
        "write include makefile for library")
        ("mainpackage,p", value(&mainpackage),
          "output dependency information")
          ("depends,d", value(&depends),
            "write dependencies to <pathname>")
            ("sources,s", value(&sources), "write source package list to <pathname>")
      ("root,r", value(&root), "treat <dirname> as project root directory")
      ;

    variables_map vm;
    store(parse_command_line(argc, argv, desc), vm);

    if (vm.count("help")) {
      cout << desc << "\n";
      return 0;
    }

    conflicting_options(vm, "output", "two");
    conflicting_options(vm, "output", "body");
    conflicting_options(vm, "output", "mainpackage");
    conflicting_options(vm, "two", "mainpackage");
    conflicting_options(vm, "body", "mainpackage");

    conflicting_options(vm, "two", "body");
    conflicting_options(vm, "libmakfile", "mainpackage");
    conflicting_options(vm, "libmakfile", "mainpackage");

    option_dependency(vm, "depends", "mainpackage");
    option_dependency(vm, "sources", "mainpackage");
    option_dependency(vm, "root", "mainpackage");

    cout << "two = " << vm["two"].as<bool>() << "\n";
    cout << "depends = " << depends << "\n";
    cout << "depends = " << vm["depends"].as<string>() << "\n";
  }
  catch (exception& e) {
    cerr << e.what() << "\n";
  }
}

And here is an example console printout:

$ ./Gmame.exe -p e -d fg
two = 0
depends = deps_file
depends = fg

It seems like the provided storage variable is just being ignored? If this is incorrect somehow then the tutorial needs to be updated as well.

Building using boost 1.68 on Windows using MSVC 2017.

Dominant language
C++
Stars
136
Forks
117
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/program_options

All issues in boostorg/program_options

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.