options.h

Go to the documentation of this file.

/*
  Copyright (c) Mircea Neacsu (2014-2025) Licensed under MIT License.
  This file is part of MLIB project. See LICENSE file for full license terms.
*/

#pragma once
 
#include <string>
#include <vector>
 
#if __has_include("defs.h")
#include "defs.h"
#endif
 
namespace mlib {
 
class OptParser
{
public:
  explicit OptParser ();

  OptParser (std::vector<const char*>& list);

  OptParser (std::initializer_list<const char*> list);

  OptParser (const char** list);

  void set_options (std::vector<const char*>& list);

  void add_option (const char* descr);

  int parse (int argc, const char* const* argv, int* stop = nullptr);

  int parse (const std::vector<std::string>& args, int* stop = nullptr);

  bool next (std::string& opt, std::string& optarg, char sep = '|');

  bool next (std::string& opt, std::vector<std::string>& optarg);

  int getopt (const std::string& option, std::string& optarg, char sep = '|') const;

  int getopt (const std::string& option, std::vector<std::string>& optarg) const;

  int getopt (char option, std::string& optarg, char sep = '|') const;

  int getopt (char option, std::vector<std::string>& optarg) const;

  bool hasopt (const std::string& option) const;

  bool hasopt (char option) const;
  
  const std::string synopsis () const;

  const std::string description (size_t indent_size = 2) const;

  const std::string& appname () const;
 
private:
  struct opt
  {
    char oshort;                  // short form
    std::string olong;            // long form
    char flag;                    // argument type
    std::string arg_descr;        // argument description
    std::vector<std::string> arg; // actual argument(s)
    int count;                    // number of occurrences
  };
 
  std::vector<opt>::const_iterator find_option (const std::string& opt) const;
  std::vector<opt>::const_iterator find_option (char opt) const;
  void format_arg (std::string& str, const opt& option, char sep) const;
 
  std::vector<opt> optlist;
  std::vector<opt> cmd;
  std::vector<opt>::iterator nextop;
  std::string app;
};

inline const std::string& OptParser::appname () const
{
  return app;
}

inline bool OptParser::hasopt (const std::string& option) const
{
  return find_option (option) != cmd.end ();
}

inline bool OptParser::hasopt (char option) const
{
  return find_option (option) != cmd.end ();
}

 
inline int OptParser::getopt (const std::string& option, std::vector<std::string>& optarg) const
{
  optarg.clear ();
  auto p = find_option (option);
  if (p == cmd.end ())
    return 0;
 
  optarg = p->arg;
  return p->count;
}

inline int OptParser::getopt (char option, std::vector<std::string>& optarg) const
{
  optarg.clear ();
  auto p = find_option (option);
  if (p == cmd.end ())
    return 0;
 
  optarg = p->arg;
  return p->count;
}
 
} // namespace mlib