command-definition.hpp

Go to the documentation of this file.

/* -*- 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_DEFINITION_HPP
#define NFD_TOOLS_NFDC_COMMAND_DEFINITION_HPP
 
#include "command-arguments.hpp"
 
#include <iosfwd>
#include <set>
#include <stdexcept>
#include <vector>
 
namespace nfd::tools::nfdc {
 
enum class ArgValueType {
  NONE,
 
  ANY,
 
  BOOLEAN,
 
  UNSIGNED,
 
  STRING,
 
  REPORT_FORMAT,
 
  NAME,
 
  FACE_URI,
 
  FACE_ID_OR_URI,
 
  FACE_PERSISTENCY,
 
  ROUTE_ORIGIN,
};
 
std::ostream&
operator<<(std::ostream& os, ArgValueType vt);
 
enum class Required {
  NO = false, 
  YES = true  
};
 
enum class Positional {
  NO = false, 
  YES = true  
};
 
class CommandDefinition
{
public:
  class Error : public std::invalid_argument
  {
  public:
    using std::invalid_argument::invalid_argument;
  };
 
  CommandDefinition(std::string_view noun, std::string_view verb);
 
  ~CommandDefinition();
 
  const std::string&
  getNoun() const
  {
    return m_noun;
  }
 
  const std::string&
  getVerb() const
  {
    return m_verb;
  }
 
public: // help
  const std::string&
  getTitle() const
  {
    return m_title;
  }
 
  CommandDefinition&
  setTitle(std::string_view title)
  {
    m_title = title;
    return *this;
  }
 
public: // arguments
  CommandDefinition&
  addArg(const std::string& name, ArgValueType valueType,
         Required isRequired = Required::NO,
         Positional allowPositional = Positional::NO,
         const std::string& metavar = "");
 
  CommandArguments
  parse(const std::vector<std::string>& tokens, size_t start = 0) const;
 
private:
  static std::any
  parseValue(ArgValueType valueType, const std::string& token);
 
private:
  const std::string m_noun;
  const std::string m_verb;
  std::string m_title;
 
  struct Arg
  {
    std::string name;
    ArgValueType valueType;
    bool isRequired;
    std::string metavar;
  };
  std::map<std::string, Arg> m_args;
  std::set<std::string> m_requiredArgs;
  std::vector<std::string> m_positionalArgs;
};
 
} // namespace nfd::tools::nfdc
 
#endif // NFD_TOOLS_NFDC_COMMAND_DEFINITION_HPP