Environment.h

Go to the documentation of this file.

 
#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_ENVIRONMENT_H_
#define ELEMENTSKERNEL_ELEMENTSKERNEL_ENVIRONMENT_H_
 
#include <functional>  // for reference_wrapper
#include <iostream>    // for ostream
#include <map>         // for map
#include <string>      // for string
#include <vector>      // for vector
 
#include "ElementsKernel/Export.h"  // for ELEMENTS_API
 
namespace Elements {
 
class ELEMENTS_API Environment {
public:
  class Variable;
 
public:
  explicit Environment(bool keep_same = true);
  virtual ~Environment();
 
  Variable       operator[](const std::string&);
  const Variable operator[](const std::string& index) const;
  Environment&   restore();
  Environment&   set(const std::string&, const std::string&);
  Environment&   unSet(const std::string&);
  Environment&   append(const std::string&, const std::string&);
  Environment&   prepend(const std::string&, const std::string&);
  std::string    get(const std::string& index, const std::string& default_value = "") const;
  static bool    hasKey(const std::string&);
  void           commit();
 
  enum ShellType { sh, csh };
 
  std::string generateScript(ShellType) const;
 
private:
  static void checkOutOfRange(const std::string&);
 
  std::map<std::string, std::string> m_old_values;
 
  bool m_keep_same;
 
  std::vector<std::string> m_added_variables;
};
 
class Environment::Variable {
 
public:
  Variable() = delete;
  Variable(Environment& env, const std::string& index);
  Variable(const Variable& other);
  Variable(Variable&& other);
  Variable&          operator=(const Variable& other);
  Variable&          operator=(Variable&& other);
  Variable&          operator=(const std::string&);
  Variable&          set(const std::string&);
  Variable&          unSet();
  Variable&          append(const std::string&);
  Variable&          operator+=(const std::string&);
  Variable&          prepend(const std::string&);
  Variable           operator+(const std::string&);
  const std::string& index() const;
  Environment&       env() const;
  std::string        value() const;
       operator std::string() const;
  bool empty() const;
  bool exists() const;
 
private:
  void checkCompatibility(const Variable&);
 
  std::reference_wrapper<Environment> m_env;
 
  std::string m_index;
};
 
ELEMENTS_API std::ostream& operator<<(std::ostream&, const Environment::Variable&);
 
ELEMENTS_API Environment::Variable operator+(const std::string&, const Environment::Variable&);
 
}  // namespace Elements
 
#endif  // ELEMENTSKERNEL_ELEMENTSKERNEL_ENVIRONMENT_H_