owlps/owlps-positioning/src/userinterface.cc

#include "userinterface.hh"
#include "configuration.hh"

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

using namespace std ;
namespace po = boost::program_options ;



/* *** Default value definitions *** */

#define DEFAULT_CONFIG_FILE_NAME "cfg/owlps-positioning.cfg"
#define DEFAULT_LISTENING_PORT 9902



/* *** Constructors *** */


/**
 * \em argc and \em argv are (normally) the ones passed to the main()
 * function.
 * @param argc Number of arguments passed to the program.
 * @param argv Values of the arguments.
 */
UserInterface::UserInterface(const int argc, char **argv)
{
  assert(argv) ;
  cli_argument_values = argv ;
  cli_argument_count = argc ;

  try
    {
      cli_options = new po::options_description("General options") ;
      file_options = new po::options_description("Parameters") ;
    }
  catch (bad_alloc e)
    {
      throw ;
    }

  fill_options() ;
  parse_options() ;
}


UserInterface::~UserInterface()
{
  delete cli_options ;
  delete file_options ;
}



/* *** Operations *** */


void UserInterface::fill_options()
{
  fill_cli_options() ;
  fill_file_options() ;

  // File options are also accepted on the command line
  cli_options->add(*file_options) ;
}


void UserInterface::fill_cli_options()
{
  cli_options->add_options()
  ("help,h", "Print help")
  ("config-file,f", po::value<string>()
   ->default_value(DEFAULT_CONFIG_FILE_NAME),
   "Alternative configuration file")
  ; // End of options
}


void UserInterface::fill_file_options()
{
  fill_server_options() ;
  fill_data_input_options() ;
  fill_input_options() ;
  fill_log_options() ;
  fill_positioning_options() ;
  fill_output_options() ;
}


void UserInterface::fill_server_options()
{
  po::options_description options("Server options") ;

  options.add_options()
  ("server.port,l", po::value<int>()
   ->default_value(DEFAULT_LISTENING_PORT),
   "Server listening port.")
  ;

  file_options->add(options) ;
}


void UserInterface::fill_data_input_options()
{
  po::options_description options("Data input options") ;

  options.add_options()
  ("data-input.ap-medium", po::value< vector<string> >()
   ->composing(),
   "Medium from which access points are read. You can specify this \
option more than once. Allowed: CSV.")
  ("data-input.ap-csv-file", po::value<string>(),
   "CSV file to use for access points input (when \
data-input.ap-medium = CSV).")
  ("data-input.topology-medium,T", po::value< vector<string> >()
   ->composing(),
   "Medium from which topology (buildings, areas and waypoints) is \
read. You can specify this option more than once. Allowed: CSV.")
  ("data-input.areas-csv-file,A", po::value<string>(),
   "CSV file to use for topology input (when \
data-input.topology-medium = CSV).")
  ("data-input.waypoints-csv-file,W", po::value<string>(),
   "CSV file to use for waypoints input (when \
data-input.topology-medium = CSV).")
  ("data-input.reference-points-medium,R", po::value< vector<string> >()
   ->composing(),
   "Medium from which reference points are read. You can specify this \
option more than once. Allowed: CSV.")
  ("data-input.reference-points-csv-file", po::value<string>(),
   "CSV file to use for reference points input (when \
data-input.reference-points-medium = CSV).")
  ;

  file_options->add(options) ;
}


void UserInterface::fill_input_options()
{
  po::options_description options("Input options") ;

  options.add_options()
  ("input.medium,I", po::value<string>(),
   "Medium from which requests are read. Allowed: CSV.")
  ("input.csv-file,C", po::value<string>(),
   "CSV file to use for input (when input.medium = CSV).")
  ;

  file_options->add(options) ;
}


void UserInterface::fill_log_options()
{
  po::options_description options("Log options") ;

  options.add_options()
  ("log.medium,L", po::value< vector<string> >()->composing(),
   "Medium to which the requests will be logged. You can specify \
this option more than once. Allowed: none, CSV. The `none` value \
completely disables logging.")
  ("log.csv-file", po::value<string>(),
   "CSV file to use for logging (when log.medium = CSV).")
  ;

  file_options->add(options) ;
}


void UserInterface::fill_positioning_options()
{
  po::options_description options("Positioning options") ;

  options.add_options()
  ("positioning.algorithm,a", po::value< vector<string> >()->composing(),
   "Algorithms used to compute positions. You can specify \
this option more than once (but at least once). Allowed: Real, FBCM, \
FRBHMBasic, InterlinkNetworks, RADAR.")
  ;

  file_options->add(options) ;
}


void UserInterface::fill_output_options()
{
  po::options_description options("Output options") ;

  options.add_options()
  ("output.medium,O", po::value< vector<string> >()->composing(),
   "Medium to which the results will be wrote. You can specify \
this option more than once. Allowed: Terminal, CSV. \
If this option is absent, results will be printed on the terminal.")
  ("output.csv-file", po::value<string>(),
   "CSV file to use for output (when output.medium = CSV).")
  ;

  file_options->add(options) ;
}


void UserInterface::parse_options()
{
  parse_command_line() ;
  print_usage_and_exit_if_requested() ;

  parse_file() ;

  po::notify(Configuration::getw_configuration()) ;
}


void UserInterface::parse_command_line() const
{
  po::store(po::parse_command_line(cli_argument_count,
                                   cli_argument_values,
                                   *cli_options),
            Configuration::getw_configuration()) ;
}


void UserInterface::print_usage_and_exit_if_requested() const
{
  if (Configuration::is_configured("help"))
    {
      cout << *cli_options ;
      exit(0) ;
    }
}


void UserInterface::parse_file() const
{
  string config_file_name = Configuration::string_value("config-file") ;
  ifstream config_file(config_file_name.c_str()) ;

  if (! config_file)
    {
      cerr
          << "Warning! Error opening input configuration file « "
          << config_file_name
          << " »! Using command line and default values…"
          << endl ;
      return ;
    }

  po::store(po::parse_config_file(config_file, *file_options),
            Configuration::getw_configuration()) ;
}