blob: 6dc060a22ecf24ea30925333951fb98f10f9b5b6 [file] [log] [blame]
Junxiao Shi64567bb2016-09-04 16:00:27 +00001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Eric Newberry84d3adc2017-08-09 23:31:40 -04002/*
Davide Pesaventob7bfcb92022-05-22 23:55:23 -04003 * Copyright (c) 2014-2022, Regents of the University of California,
Junxiao Shi64567bb2016-09-04 16:00:27 +00004 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
26#ifndef NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP
27#define NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP
28
29#include "core/common.hpp"
Eric Newberry84d3adc2017-08-09 23:31:40 -040030
Junxiao Shi215fd0b2017-01-28 19:01:04 +000031#include <ndn-cxx/encoding/nfd-constants.hpp>
Eric Newberry84d3adc2017-08-09 23:31:40 -040032
Davide Pesaventob7bfcb92022-05-22 23:55:23 -040033#include <any>
Eric Newberry84d3adc2017-08-09 23:31:40 -040034#include <boost/logic/tribool.hpp>
Junxiao Shi64567bb2016-09-04 16:00:27 +000035
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040036namespace nfd::tools::nfdc {
Junxiao Shi64567bb2016-09-04 16:00:27 +000037
Junxiao Shi215fd0b2017-01-28 19:01:04 +000038using ndn::nfd::FacePersistency;
Junxiao Shi8eda6822017-04-12 02:53:14 +000039using ndn::nfd::RouteOrigin;
Junxiao Shi215fd0b2017-01-28 19:01:04 +000040
Junxiao Shi64567bb2016-09-04 16:00:27 +000041/** \brief contains named command arguments
42 */
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040043class CommandArguments : public std::map<std::string, std::any, std::less<>>
Junxiao Shi64567bb2016-09-04 16:00:27 +000044{
45public:
Junxiao Shi36e54292017-02-17 18:43:16 +000046 /** \return the argument value, or nullopt if the argument is omitted on command line
47 */
48 template<typename T>
Davide Pesaventob7bfcb92022-05-22 23:55:23 -040049 std::optional<T>
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040050 getOptional(std::string_view key) const
Junxiao Shi36e54292017-02-17 18:43:16 +000051 {
52 auto i = find(key);
Davide Pesaventob7bfcb92022-05-22 23:55:23 -040053 return i == end() ? std::nullopt : std::make_optional(std::any_cast<T>(i->second));
Davide Pesavento8b663a92018-11-21 22:57:20 -050054 }
55
56 /** \return the argument value, or a default value if the argument is omitted on command line
57 */
58 template<typename T>
59 T
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040060 get(std::string_view key, const T& defaultValue = T()) const
Davide Pesavento8b663a92018-11-21 22:57:20 -050061 {
62 return getOptional<T>(key).value_or(defaultValue);
Junxiao Shi36e54292017-02-17 18:43:16 +000063 }
Eric Newberry84d3adc2017-08-09 23:31:40 -040064
65 /** \brief get an optional boolean argument as tribool
66 * \return the argument value, or boost::logic::indeterminate if the argument is omitted on command line
67 */
68 boost::logic::tribool
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040069 getTribool(std::string_view key) const
Eric Newberry84d3adc2017-08-09 23:31:40 -040070 {
71 auto value = getOptional<bool>(key);
Davide Pesavento8b663a92018-11-21 22:57:20 -050072 return value ? boost::logic::tribool(*value) : boost::logic::indeterminate;
Eric Newberry84d3adc2017-08-09 23:31:40 -040073 }
Junxiao Shi64567bb2016-09-04 16:00:27 +000074};
75
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040076} // namespace nfd::tools::nfdc
Junxiao Shi64567bb2016-09-04 16:00:27 +000077
78#endif // NFD_TOOLS_NFDC_COMMAND_ARGUMENTS_HPP