tools/nfdc/command-arguments.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD 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 GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP
#define NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP

#include <ndn-cxx/encoding/nfd-constants.hpp>

#include <any>
#include <map>
#include <optional>
#include <string>
#include <string_view>

#include <boost/logic/tribool.hpp>

namespace nfd::tools::nfdc {

using ndn::nfd::FacePersistency;
using ndn::nfd::RouteOrigin;

/** \brief Contains named command arguments.
 */
class CommandArguments : public std::map<std::string, std::any, std::less<>>
{
public:
  /** \return the argument value, or nullopt if the argument is omitted on command line
   */
  template<typename T>
  std::optional<T>
  getOptional(std::string_view key) const
  {
    auto i = find(key);
    return i == end() ? std::nullopt : std::make_optional(std::any_cast<T>(i->second));
  }

  /** \return the argument value, or a default value if the argument is omitted on command line
   */
  template<typename T>
  T
  get(std::string_view key, const T& defaultValue = T()) const
  {
    return getOptional<T>(key).value_or(defaultValue);
  }

  /** \brief Get an optional boolean argument as tribool.
   *  \return the argument value, or boost::logic::indeterminate if the argument is omitted on command line
   */
  boost::logic::tribool
  getTribool(std::string_view key) const
  {
    auto value = getOptional<bool>(key);
    return value ? boost::logic::tribool(*value) : boost::logic::indeterminate;
  }
};

} // namespace nfd::tools::nfdc

#endif // NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP