OptionFlags.hpp

// Copyright (c) 2018 Graphcore Ltd. All rights reserved.
#ifndef poplar_OptionFlags_hpp
#define poplar_OptionFlags_hpp
 
#include <functional>
#include <initializer_list>
#include <iosfwd>
#include <iterator>
#include <memory>
#include <poplar/StringRef.hpp>
#include <string>
#include <utility>
 
namespace poplar {
namespace core {
class OptionFlags;
class OptionFlagsIterator;
} // namespace core
class ProfileValue;
 
class OptionFlags {
public:
  using OptionFlag = std::pair<const std::string, std::string>;
  using initializer_list = std::initializer_list<OptionFlag>;
 
  class iterator : public std::iterator<std::forward_iterator_tag, OptionFlag> {
    std::unique_ptr<core::OptionFlagsIterator> impl;
 
    iterator(std::unique_ptr<core::OptionFlagsIterator> p) noexcept;
 
    friend class OptionFlags;
 
  public:
    iterator(const iterator &other);
    iterator &operator=(const iterator &other);
    iterator(iterator &&other) noexcept;
    iterator &operator=(iterator &&other) noexcept;
    ~iterator();
    const OptionFlag &operator*() const;
    const OptionFlag *operator->() const;
    bool operator==(const iterator &other) const;
    bool operator!=(const iterator &other) const { return !(*this == other); }
    iterator &operator++();
    iterator operator++(int) {
      iterator it(*this);
      ++(*this);
      return it;
    }
  };
 
public:
  OptionFlags();
  ~OptionFlags();
  OptionFlags(const OptionFlags &other);
  OptionFlags(OptionFlags &&other) noexcept;
  OptionFlags &operator=(const OptionFlags &other);
  OptionFlags &operator=(OptionFlags &&other) noexcept;
 
  bool operator==(const OptionFlags &other) const;
 
  OptionFlags(initializer_list &&list) : OptionFlags() { set(std::move(list)); }
 
  void set(initializer_list &&list);
 
  void set(StringRef option, StringRef value);
 
  StringRef at(StringRef option) const;
 
  void clear();
 
  iterator begin() const;
  iterator end() const;
 
  // Implementation
private:
  std::unique_ptr<core::OptionFlags> impl;
};
 
ProfileValue getAsProfileValue(const OptionFlags &flags);
 
void readJSON(StringRef string, OptionFlags &flags);
 
void readJSON(std::istream &stream, OptionFlags &flags);
 
void readJSONFromEnv(StringRef envVarName, OptionFlags &flags);
 
std::ostream &operator<<(std::ostream &ostream, const OptionFlags &flags);
 
} // end namespace poplar
 
#endif // poplar_OptionFlags_hpp