generic_property.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2020 by the OpenStructure authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library 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 Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_GENETRIC_PROPERTY_HH
#define OST_GENETRIC_PROPERTY_HH

/*
  usage:

  the impl is derived from GenericPropContainerImpl

  the handle is derived from GenericPropContainer, and then has the
  setter and getter methods for String, Real, int and bool mapping
*/

#include <sstream>
#include <map>
#include <vector>
#include <boost/variant.hpp>

#include <ost/module_config.hh>
#include <ost/invalid_handle.hh>
#include <ost/message.hh>
#include <ost/geom/vec3.hh>

namespace ost {

struct  DLLEXPORT GenericPropError: public Error
{
  GenericPropError(const String& m):
    Error(m)
  {}
};

typedef boost::variant<String, Real, int, bool, geom::Vec3> GenericPropValue;

class  TEMPLATE_EXPORT GenericPropContainerImpl
{
  typedef std::map<String,GenericPropValue> PropertyMap;
  
public:
  GenericPropContainerImpl(): map_(NULL) {}
  ~GenericPropContainerImpl()
  {
    if (map_) {
      delete map_;
    }
  }
  GenericPropContainerImpl(const GenericPropContainerImpl& rhs):
    map_(rhs.map_ ? new PropertyMap(*rhs.map_) : NULL)
  { }
  
  GenericPropContainerImpl& operator=(const GenericPropContainerImpl& r)   
  {
    this->Assign(r);
    return *this;
  }
  
  GenericPropValue& GenericProp(const String& key) 
  {
    if (!map_) {
      map_=new PropertyMap;
    }
    return (*map_)[key];
  }
  
  const GenericPropValue& GenericProp(const String& key) const
  {
    if (!map_) {
      map_=new PropertyMap;
    }    
    return (*map_)[key];
  }
  
  bool HasProp(const String& key) const
  {
    return map_ && map_->find(key) != map_->end();
  }
  
  void ClearProps()
  {
    if (map_) {
      map_->clear();      
    }
  }
  
  void RemoveProp(const String& key)
  {
    if (map_) {
      map_->erase(key);
    }
  }

  void Assign(const GenericPropContainerImpl& impl)
  {
    if (impl.map_) {
      if (!map_) {
        map_=new PropertyMap(*impl.map_);
      } else {
        *map_=*impl.map_;
      }
    } else {
      this->ClearProps();
    }
  }
  
  PropertyMap GetPropMap() const
  {
    if (!map_) {
      map_=new PropertyMap;
    }    
    return *map_;
  }
      
  std::vector<String> GetPropList() const
  {
    std::vector<String> prop_list;
    if (map_) {
      PropertyMap::const_iterator i;
      for (i=map_->begin(); i!=map_->end(); ++i) {
        prop_list.push_back(i->first);
      }
    }
    return prop_list;
  }
  
private:
  mutable PropertyMap* map_;
};  

template <typename H>
class TEMPLATE_EXPORT ConstGenericPropContainer {
protected:
  
  template<typename T>
  T gp_get(const String& key) const {
    if(HasProp(key)) {
      return boost::get<T>(GetImpl()->GenericProp(key));
    } else {
      std::ostringstream m("");
      m << "unknown property " << key;
      throw GenericPropError(m.str());
    }
  }

  template<typename T>
  T gp_get(const String& key, const T& def) const {
    if(HasProp(key)) {
      return boost::get<T>(GetImpl()->GenericProp(key));
    }
    return def;
  }
  GenericPropContainerImpl* GetImpl() 
  {
    return static_cast<H*>(this)->GpImpl();
  }

  const GenericPropContainerImpl* GetImpl() const
  {
    return static_cast<const H*>(this)->GpImpl();
  }  
  
public:
  bool HasProp(const String& key) const {
    CheckHandleValidity(*static_cast<const H*>(this));
    return this->GetImpl()->HasProp(key);
  }
    
  String GetPropAsString(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    if(!HasProp(key)) return "";
    std::ostringstream rep("");
    rep << this->GetImpl()->GenericProp(key);
    return rep.str();
  }  

  String GetStringProp(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));
    return this->gp_get<String>(key);
  }

  Real GetFloatProp(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    if(HasProp(key)) {
      GenericPropValue value=this->GetImpl()->GenericProp(key);
      switch (value.which()) {
        case 1:
          return boost::get<Real>(value);
        case 2:
          return static_cast<Real>(boost::get<int>(value));
        case 3:
          return static_cast<Real>(boost::get<bool>(value));
      }
      std::ostringstream m("");
      m << "property '" << key << "' is not numeric";
      throw GenericPropError(m.str());
    }
    std::ostringstream m("");
    m << "unknown property " << key;
    throw GenericPropError(m.str());
  }
  int GetIntProp(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    if (HasProp(key)){
      GenericPropValue value=this->GetImpl()->GenericProp(key);
      switch (value.which()) {
        case 2:
          return boost::get<int>(value);
        case 3:
          return boost::get<bool>(value);
      }
      std::ostringstream m("");
      m << "property '" << key << "' is not integral";
      throw GenericPropError(m.str());
    }
    std::ostringstream m("");
    m << "unknown property " << key;
    throw GenericPropError(m.str());
  }

  bool GetBoolProp(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    return this->gp_get<bool>(key);
  }

  geom::Vec3 GetVec3Prop(const String& key) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    return this->gp_get<geom::Vec3>(key);
  }

  String GetStringProp(const String& key, const String& def) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    return this->gp_get<String>(key,def);
  }

  Real GetFloatProp(const String& key, Real def) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    if(this->HasProp(key)) {
      GenericPropValue value=GetImpl()->GenericProp(key);
      switch (value.which()) {
        case 1:
          return boost::get<Real>(value);
        case 2:
          return static_cast<Real>(boost::get<int>(value));
        case 3:
          return static_cast<Real>(boost::get<bool>(value));
      }
      std::ostringstream m("");
      m << "property '" << key << "' is not numeric";
      throw GenericPropError(m.str());
    }
    return def;
  }

  int GetIntProp(const String& key, int def) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    if(this->HasProp(key)) {
      GenericPropValue value=GetImpl()->GenericProp(key);
      switch (value.which()) {
        case 2:
          return boost::get<int>(value);
        case 3:
          return static_cast<int>(boost::get<bool>(value));
      }
      std::ostringstream m("");
      m << "property '" << key << "' is not integral";
      throw GenericPropError(m.str());
    }
    return def;
  }

  bool GetBoolProp(const String& key, bool def) const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    return this->gp_get<bool>(key, def);
  }

  std::map<String,GenericPropValue> GetPropMap() const
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    return this->GetImpl()->GetPropMap();
  }  

  std::vector<String> GetPropList() const
  {
    CheckHandleValidity(*static_cast<const H*>(this));
    return this->GetImpl()->GetPropList();
  }
};

template <typename H>
class  TEMPLATE_EXPORT GenericPropContainer : 
   public ConstGenericPropContainer<H>
{
public:
  void ClearProps()
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->ClearProps();
  }
  
  void SetStringProp(const String& key, const String& value)
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->GenericProp(key)=value;
  }

  void SetFloatProp(const String& key, Real value)
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->GenericProp(key)=value;
  }

  void SetIntProp(const String& key, int value)
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->GenericProp(key)=value;
  }

  void SetBoolProp(const String& key, bool value)
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->GenericProp(key)=value;
  }
  
  void SetVec3Prop(const String& key, geom::Vec3 value)
  {
    CheckHandleValidity(*static_cast<const H*>(this));    
    this->GetImpl()->GenericProp(key)=value;
  } 

  void RemoveProp(const String& key)
  {
    CheckHandleValidity(*static_cast<const H*>(this));
    this->GetImpl()->RemoveProp(key);
  }
};


} // ns

#endif