target_parser.h

Go to the documentation of this file.

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/*
 * Antonin Bas (antonin@barefootnetworks.com)
 *
 */
 
 
#ifndef BM_BM_SIM_TARGET_PARSER_H_
#define BM_BM_SIM_TARGET_PARSER_H_
 
#include <string>
#include <vector>
#include <memory>
#include <iosfwd>
 
namespace bm {
 
class TargetParserIface {
 public:
  virtual ~TargetParserIface() { }
 
  virtual int parse(const std::vector<std::string> &more_options,
                    std::ostream *errstream) = 0;
 
  virtual void help_msg(std::ostream *outstream) const = 0;
};
 
class TargetParserBasicStore;
 
class TargetParserBasic : public TargetParserIface {
 public:
  enum class ReturnCode {
    SUCCESS = 0,
    DUPLICATE_OPTION,
    INVALID_OPTION_NAME,
    OPTION_NOT_PROVIDED,
    INVALID_OPTION_TYPE
  };
 
  TargetParserBasic();
  ~TargetParserBasic();
 
  int parse(const std::vector<std::string> &more_options,
            std::ostream *errstream) override;
 
  void help_msg(std::ostream *outstream) const override;
 
  ReturnCode add_string_option(const std::string &name,
                               const std::string &help_str);
  ReturnCode add_int_option(const std::string &name,
                            const std::string &help_str);
  ReturnCode add_uint_option(const std::string &name,
                             const std::string &help_str);
  ReturnCode add_flag_option(const std::string &name,
                             const std::string &help_str);
 
  ReturnCode get_string_option(const std::string &name, std::string *v) const;
  ReturnCode get_int_option(const std::string &name, int *v) const;
  ReturnCode get_uint_option(const std::string &name, unsigned int *v) const;
  ReturnCode get_flag_option(const std::string &name, bool *v) const;
 
 private:
  std::unique_ptr<TargetParserBasicStore> var_store;
};
 
class TargetParserBasicWithDynModules : public TargetParserBasic {
 public:
  TargetParserBasicWithDynModules();
  ~TargetParserBasicWithDynModules();
 
  int parse(const std::vector<std::string> &more_options,
            std::ostream *errstream) override;
 
 private:
  static constexpr char load_modules_option[] = "load-modules";
 
  int load_modules(std::ostream *errstream);
};
 
}  // namespace bm
 
#endif  // BM_BM_SIM_TARGET_PARSER_H_