Quando si utilizza boost :: program_options, come si imposta il nome dell'argomento?

Question

Quando si utilizza boost::program_options, come si imposta il nome di un argomento per boost::program_options::value<>()?

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

int main() 
{ 
    boost::program_options::options_description desc; 

    desc.add_options() 
    ("width", boost::program_options::value<int>(), 
    "Give width"); 

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

    return 0; 
} 

Il codice di cui sopra dà:

--width arg   Give width 

Quello che voglio è quello di sostituire il nome arg con qualcosa di più descrittivo come NUM:

--width NUM   Give width 

Answer 1

Nelle versioni recenti di Boost (testato solo per > = 1.61) questo è completamente supportato.Sotto una leggera modifica del primo esempio nel tutorial, dove "LEVEL" viene stampato al posto di "arg":

po::options_description desc("Allowed options"); 
desc.add_options() 
    ("help", "produce help message") 
    ("compression", po::value<int>()->value_name("LEVEL"), "set compression level") 
; 

Live Example

Answer 2

può sostituire arg con qualcosa di diverso tramite la variabile globale boost::program_options::arg:

boost::program_options::arg = "NUM"; 

Tuttavia, poiché è una variabile globale, non aiuta molto a risolvere il problema quando più opzioni potrebbero richiedere argomenti diversi.

Answer 3

La classe program_options::value_semantic non parametrizza il nome dell'argomento, quindi penso che sarà necessario definire la propria classe. Qualcosa di simile a questo:

struct my_arg_type 
    : public boost::program_options::typed_value<int> 
{ 
    my_arg_type(std::string const& name) 
     : boost::program_options::typed_value<int>(&my_value) 
     , my_name(name) 
     , my_value(0) 
    { 
    } 
    std::string name() const { return my_name; } 
    std::string my_name; 
    int my_value; 
}; 

boost::program_options::options_description desc; 

my_arg_type arg("foo"); 
desc.add_options() 
    ("width", &arg, "give width"); 

Questo dovrebbe dare qualcosa di simile:

--witdh foo give width 

Answer 4

L'approccio data dal Codebender è l'unico che si può usare. Questo è in realtà intenzionale - l'uso di "NUM" per nome dell'argomento sembra essere una micro-ottimizzazione che non vale la pena fare. Una buona descrizione dell'opzione dovrebbe anche dire che tipo di argomento è previsto.

Answer 5

Nella versione corrente di boost (1.53) non è più necessario creare la propria classe come proposto da Tim Sylvester. È possibile utilizzare: boost :: program_options :: typed_value. Su quale value_name può essere configurato.

#include <iostream> 
#include <boost/program_options.hpp> 
using boost::program_options::typed_value; 
using boost::program_options::options_description; 

int main(int argc, char **argv) { 
    options_description desc("Usage"); 

    int someValue; 
    auto someOption = new typed_value<decltype(someValue)>(&someValue); 
    someOption->value_name("NUM"); 
    desc.add_options() 
     ("some-option,s", someOption, "The option\n"); 

    std::cout << desc << std::endl; 
    return 0; 
} 

visualizzerà un nome dell'argomento configurato:

Usage: 
-s [ --some-option ] NUM The option 

Answer 6

daminetreg's answer opere, ma può essere un po 'prolissa quando viene utilizzato per un sacco di voci di opzione. Ho appena messo insieme un sovraccarico per il modello value<T>(T* v) di costruire le mie value_sematic s con un ulteriore value_name: usando

template<class T> 
typed_value<T>* 
value(T* v, const char * value_typename) 
{ 
    typed_value<T>* r = new typed_value<T>(v); 
    r->value_name(value_typename); 

    return r;   
} 

è possibile creare e aggiungere un nuovo program_option come questo:

int width; 
desc.add_options() 
    ("width", boost::program_options::value<int>(&width, "NUM"), 
    "Give width"); 

(Nota: questo non affronta tutti gli altri modelli di costruzione, in particolare non il costruttore predefinito value() che l'OP desidera utilizzare)