option_group.hpp

Go to the documentation of this file.

/* Option++ -- read command-line program options
 * Copyright (C) 2017-2020 Greg Kikola.
 *
 * This file is part of Option++.
 *
 * Option++ is free software: you can redistribute it and/or modify
 * it under the terms of the Boost Software License version 1.0.
 *
 * Option++ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Boost Software License for more details.
 *
 * You should have received a copy of the Boost Software License
 * along with Option++.  If not, see
 * <https://www.boost.org/LICENSE_1_0.txt>.
 */
/* Written by Greg Kikola <[email protected]>. */
 
#ifndef OPTIONPP_OPTION_GROUP_HPP
#define OPTIONPP_OPTION_GROUP_HPP
 
#include <string>
#include <utility>
#include <vector>
#include <optionpp/option.hpp>
 
namespace optionpp {
 
  class option_group {
  public:
 
    using value_type = option;
    using container_type = std::vector<option>;
    using size_type = container_type::size_type;
    using iterator = container_type::iterator;
    using const_iterator = container_type::const_iterator;
    using reverse_iterator = container_type::reverse_iterator;
    using const_reverse_iterator = container_type::const_reverse_iterator;
 
    option_group() noexcept {}
    option_group(const std::string& name) : m_name{name} {}
    template <typename InputIt>
    option_group(const std::string& name,
                 InputIt first, InputIt last)
      : m_name{name}, m_options{first, last} {}
 
    const std::string& name() const noexcept { return m_name; }
 
    option& add_option(const option& opt = option{}) {
      m_options.push_back(opt);
      return m_options.back();
    }
    option& add_option(const std::string& long_name,
                       char short_name = '\0',
                       const std::string& description = "",
                       const std::string& arg_name = "",
                       bool arg_required = false);
 
    size_type size() const noexcept { return m_options.size(); }
    bool empty() const noexcept { return m_options.empty(); }
 
    iterator begin() noexcept { return m_options.begin(); }
    const_iterator begin() const noexcept { return cbegin(); }
    iterator end() noexcept { return m_options.end(); }
    const_iterator end() const noexcept { return cend(); }
 
    const_iterator cbegin() const noexcept { return m_options.cbegin(); }
    const_iterator cend() const noexcept { return m_options.cend(); }
 
    reverse_iterator rbegin() noexcept { return m_options.rbegin(); }
    const_reverse_iterator rbegin() const noexcept { return crbegin(); }
    reverse_iterator rend() noexcept { return m_options.rend(); }
    const_reverse_iterator rend() const noexcept { return crend(); }
 
    const_reverse_iterator crbegin() const noexcept { return m_options.crbegin(); }
    const_reverse_iterator crend() const noexcept { return m_options.crend(); }
 
    iterator find(const std::string& long_name);
 
    const_iterator find(const std::string& long_name) const;
 
    iterator find(char short_name);
 
    const_iterator find(char short_name) const;
 
    void sort();
 
    option& operator[](const std::string long_name);
    option& operator[](char short_name);
 
  private:
    std::string m_name; //< Group name.
    container_type m_options; //< Collection of program options.
  };
 
} // End namespace
 
#endif