sl@0: #ifndef DYNAMIC_PROPERTY_MAP_RG09302004_HPP
sl@0: #define DYNAMIC_PROPERTY_MAP_RG09302004_HPP
sl@0: 
sl@0: // Copyright 2004-5 The Trustees of Indiana University.
sl@0: 
sl@0: // Use, modification and distribution is subject to the Boost Software
sl@0: // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
sl@0: // http://www.boost.org/LICENSE_1_0.txt)
sl@0: 
sl@0: //  dynamic_property_map.hpp -
sl@0: //    Support for runtime-polymorphic property maps.  This header is factored
sl@0: //  out of Doug Gregor's routines for reading GraphML files for use in reading
sl@0: //  GraphViz graph files.
sl@0: 
sl@0: //  Authors: Doug Gregor
sl@0: //           Ronald Garcia
sl@0: //
sl@0: 
sl@0: 
sl@0: #include <boost/config.hpp>
sl@0: #include <boost/property_map.hpp>
sl@0: #include <boost/lexical_cast.hpp>
sl@0: #include <boost/any.hpp>
sl@0: #include <boost/function/function3.hpp>
sl@0: #include <boost/type_traits/is_convertible.hpp>
sl@0: #include <typeinfo>
sl@0: #include <boost/mpl/bool.hpp>
sl@0: #include <stdexcept>
sl@0: #include <sstream>
sl@0: #include <map>
sl@0: #include <boost/type.hpp>
sl@0: 
sl@0: namespace boost {
sl@0: 
sl@0: namespace detail {
sl@0: 
sl@0:   // read_value -
sl@0:   //   A wrapper around lexical_cast, which does not behave as
sl@0:   //   desired for std::string types.
sl@0:   template<typename Value>
sl@0:   inline Value read_value(const std::string& value)
sl@0:   { return boost::lexical_cast<Value>(value); }
sl@0: 
sl@0:   template<>
sl@0:   inline std::string read_value<std::string>(const std::string& value)
sl@0:   { return value; }
sl@0: 
sl@0: }
sl@0: 
sl@0: 
sl@0: // dynamic_property_map -
sl@0: //  This interface supports polymorphic manipulation of property maps.
sl@0: class dynamic_property_map
sl@0: {
sl@0: public:
sl@0:   virtual ~dynamic_property_map() { }
sl@0: 
sl@0:   virtual boost::any get(const any& key) = 0;
sl@0:   virtual std::string get_string(const any& key) = 0;
sl@0:   virtual void put(const any& key, const any& value) = 0;
sl@0:   virtual const std::type_info& key() const = 0;
sl@0:   virtual const std::type_info& value() const = 0;
sl@0: };
sl@0: 
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////
sl@0: // Property map exceptions
sl@0: //////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: struct dynamic_property_exception : public std::exception {
sl@0:   virtual ~dynamic_property_exception() throw() {}
sl@0:   virtual const char* what() const throw() = 0;
sl@0: };
sl@0: 
sl@0: struct property_not_found : public dynamic_property_exception {
sl@0:   std::string property;
sl@0:   mutable std::string statement;
sl@0:   property_not_found(const std::string& property) : property(property) {}
sl@0:   virtual ~property_not_found() throw() {}
sl@0: 
sl@0:   const char* what() const throw() {
sl@0:     if(statement.empty())
sl@0:       statement =
sl@0:         std::string("Property not found: ") + property + ".";
sl@0: 
sl@0:     return statement.c_str();
sl@0:   }
sl@0: };
sl@0: 
sl@0: struct dynamic_get_failure : public dynamic_property_exception {
sl@0:   std::string property;
sl@0:   mutable std::string statement;
sl@0:   dynamic_get_failure(const std::string& property) : property(property) {}
sl@0:   virtual ~dynamic_get_failure() throw() {}
sl@0: 
sl@0:   const char* what() const throw() {
sl@0:     if(statement.empty())
sl@0:       statement =
sl@0:         std::string(
sl@0:          "dynamic property get cannot retrieve value for  property: ")
sl@0:         + property + ".";
sl@0: 
sl@0:     return statement.c_str();
sl@0:   }
sl@0: };
sl@0: 
sl@0: struct dynamic_const_put_error  : public dynamic_property_exception {
sl@0:   virtual ~dynamic_const_put_error() throw() {}
sl@0: 
sl@0:   const char* what() const throw() {
sl@0:     return "Attempt to put a value into a const property map: ";
sl@0:   }
sl@0: };
sl@0: 
sl@0: 
sl@0: namespace detail {
sl@0: 
sl@0: //
sl@0: // dynamic_property_map_adaptor -
sl@0: //   property-map adaptor to support runtime polymorphism.
sl@0: template<typename PropertyMap>
sl@0: class dynamic_property_map_adaptor : public dynamic_property_map
sl@0: {
sl@0:   typedef typename property_traits<PropertyMap>::key_type key_type;
sl@0:   typedef typename property_traits<PropertyMap>::value_type value_type;
sl@0:   typedef typename property_traits<PropertyMap>::category category;
sl@0: 
sl@0:   // do_put - overloaded dispatches from the put() member function.
sl@0:   //   Attempts to "put" to a property map that does not model
sl@0:   //   WritablePropertyMap result in a runtime exception.
sl@0: 
sl@0:   //   in_value must either hold an object of value_type or a string that
sl@0:   //   can be converted to value_type via iostreams.
sl@0:   void do_put(const any& in_key, const any& in_value, mpl::bool_<true>)
sl@0:   {
sl@0: #if !(defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95))
sl@0:     using boost::put;
sl@0: #endif
sl@0: 
sl@0:     key_type key = any_cast<key_type>(in_key);
sl@0:     if (in_value.type() == typeid(value_type)) {
sl@0: #if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95)
sl@0:       boost::put(property_map, key, any_cast<value_type>(in_value));
sl@0: #else
sl@0:       put(property_map, key, any_cast<value_type>(in_value));
sl@0: #endif
sl@0:     } else {
sl@0:       //  if in_value is an empty string, put a default constructed value_type.
sl@0:       std::string v = any_cast<std::string>(in_value);
sl@0:       if (v.empty()) {
sl@0: #if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95)
sl@0:         boost::put(property_map, key, value_type());
sl@0: #else
sl@0:         put(property_map, key, value_type());
sl@0: #endif
sl@0:       } else {
sl@0: #if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95)
sl@0:         boost::put(property_map, key, detail::read_value<value_type>(v));
sl@0: #else
sl@0:         put(property_map, key, detail::read_value<value_type>(v));
sl@0: #endif
sl@0:       }
sl@0:     }
sl@0:   }
sl@0: 
sl@0:   void do_put(const any&, const any&, mpl::bool_<false>)
sl@0:   {
sl@0:     throw dynamic_const_put_error();
sl@0:   }
sl@0: 
sl@0: public:
sl@0:   explicit dynamic_property_map_adaptor(const PropertyMap& property_map)
sl@0:     : property_map(property_map) { }
sl@0: 
sl@0:   virtual boost::any get(const any& key)
sl@0:   {
sl@0: #if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95)
sl@0:     return boost::get(property_map, any_cast<key_type>(key));
sl@0: #else
sl@0:     using boost::get;
sl@0: 
sl@0:     return get(property_map, any_cast<key_type>(key));
sl@0: #endif
sl@0:   }
sl@0: 
sl@0:   virtual std::string get_string(const any& key)
sl@0:   {
sl@0: #if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ == 95)
sl@0:     std::ostringstream out;
sl@0:     out << boost::get(property_map, any_cast<key_type>(key));
sl@0:     return out.str();
sl@0: #else
sl@0:     using boost::get;
sl@0: 
sl@0:     std::ostringstream out;
sl@0:     out << get(property_map, any_cast<key_type>(key));
sl@0:     return out.str();
sl@0: #endif
sl@0:   }
sl@0: 
sl@0:   virtual void put(const any& in_key, const any& in_value)
sl@0:   {
sl@0:     do_put(in_key, in_value,
sl@0:            mpl::bool_<(is_convertible<category*,
sl@0:                                       writable_property_map_tag*>::value)>());
sl@0:   }
sl@0: 
sl@0:   virtual const std::type_info& key()   const { return typeid(key_type); }
sl@0:   virtual const std::type_info& value() const { return typeid(value_type); }
sl@0: 
sl@0:   PropertyMap&       base()       { return property_map; }
sl@0:   const PropertyMap& base() const { return property_map; }
sl@0: 
sl@0: private:
sl@0:   PropertyMap property_map;
sl@0: };
sl@0: 
sl@0: } // namespace detail
sl@0: 
sl@0: //
sl@0: // dynamic_properties -
sl@0: //   container for dynamic property maps
sl@0: //
sl@0: struct dynamic_properties
sl@0: {
sl@0:   typedef std::multimap<std::string, dynamic_property_map*>
sl@0:     property_maps_type;
sl@0:   typedef boost::function3<std::auto_ptr<dynamic_property_map>,
sl@0:                            const std::string&,
sl@0:                            const boost::any&,
sl@0:                            const boost::any&> generate_fn_type;
sl@0: public:
sl@0: 
sl@0:   typedef property_maps_type::iterator iterator;
sl@0:   typedef property_maps_type::const_iterator const_iterator;
sl@0: 
sl@0:   dynamic_properties() : generate_fn() { }
sl@0:   dynamic_properties(const generate_fn_type& g) : generate_fn(g) {}
sl@0: 
sl@0:   ~dynamic_properties()
sl@0:   {
sl@0:     for (property_maps_type::iterator i = property_maps.begin();
sl@0:          i != property_maps.end(); ++i) {
sl@0:       delete i->second;
sl@0:     }
sl@0:   }
sl@0: 
sl@0:   template<typename PropertyMap>
sl@0:   dynamic_properties&
sl@0:   property(const std::string& name, PropertyMap property_map)
sl@0:   {
sl@0:     // Tbd: exception safety
sl@0:     std::auto_ptr<dynamic_property_map> pm(
sl@0:       new detail::dynamic_property_map_adaptor<PropertyMap>(property_map));
sl@0:     property_maps_type::iterator i =
sl@0:       property_maps.insert(property_maps_type::value_type(name, 0));
sl@0:     i->second = pm.release();
sl@0: 
sl@0:     return *this;
sl@0:   }
sl@0: 
sl@0:   iterator       begin()       { return property_maps.begin(); }
sl@0:   const_iterator begin() const { return property_maps.begin(); }
sl@0:   iterator       end()         { return property_maps.end(); }
sl@0:   const_iterator end() const   { return property_maps.end(); }
sl@0: 
sl@0:   iterator lower_bound(const std::string& name)
sl@0:   { return property_maps.lower_bound(name); }
sl@0: 
sl@0:   const_iterator lower_bound(const std::string& name) const
sl@0:   { return property_maps.lower_bound(name); }
sl@0: 
sl@0:   void
sl@0:   insert(const std::string& name, std::auto_ptr<dynamic_property_map> pm)
sl@0:   {
sl@0:     property_maps.insert(property_maps_type::value_type(name, pm.release()));
sl@0:   }
sl@0: 
sl@0:   template<typename Key, typename Value>
sl@0:   std::auto_ptr<dynamic_property_map>
sl@0:   generate(const std::string& name, const Key& key, const Value& value)
sl@0:   {
sl@0:     if(!generate_fn) {
sl@0:       throw property_not_found(name);
sl@0:     } else {
sl@0:       return generate_fn(name,key,value);
sl@0:     }
sl@0:   }
sl@0: 
sl@0: private:
sl@0:   property_maps_type property_maps;
sl@0:   generate_fn_type generate_fn;
sl@0: };
sl@0: 
sl@0: template<typename Key, typename Value>
sl@0: bool
sl@0: put(const std::string& name, dynamic_properties& dp, const Key& key,
sl@0:     const Value& value)
sl@0: {
sl@0:   for (dynamic_properties::iterator i = dp.lower_bound(name);
sl@0:        i != dp.end() && i->first == name; ++i) {
sl@0:     if (i->second->key() == typeid(key)) {
sl@0:       i->second->put(key, value);
sl@0:       return true;
sl@0:     }
sl@0:   }
sl@0: 
sl@0:   std::auto_ptr<dynamic_property_map> new_map = dp.generate(name, key, value);
sl@0:   if (new_map.get()) {
sl@0:     new_map->put(key, value);
sl@0:     dp.insert(name, new_map);
sl@0:     return true;
sl@0:   } else {
sl@0:     return false;
sl@0:   }
sl@0: }
sl@0: 
sl@0: #ifndef BOOST_NO_EXPLICIT_FUNCTION_TEMPLATE_ARGUMENTS 
sl@0: template<typename Value, typename Key>
sl@0: Value
sl@0: get(const std::string& name, const dynamic_properties& dp, const Key& key)
sl@0: {
sl@0:   for (dynamic_properties::const_iterator i = dp.lower_bound(name);
sl@0:        i != dp.end() && i->first == name; ++i) {
sl@0:     if (i->second->key() == typeid(key))
sl@0:       return any_cast<Value>(i->second->get(key));
sl@0:   }
sl@0: 
sl@0:   throw dynamic_get_failure(name);
sl@0: }
sl@0: #endif
sl@0: 
sl@0: template<typename Value, typename Key>
sl@0: Value
sl@0: get(const std::string& name, const dynamic_properties& dp, const Key& key, type<Value>)
sl@0: {
sl@0:   for (dynamic_properties::const_iterator i = dp.lower_bound(name);
sl@0:        i != dp.end() && i->first == name; ++i) {
sl@0:     if (i->second->key() == typeid(key))
sl@0:       return any_cast<Value>(i->second->get(key));
sl@0:   }
sl@0: 
sl@0:   throw dynamic_get_failure(name);
sl@0: }
sl@0: 
sl@0: template<typename Key>
sl@0: std::string
sl@0: get(const std::string& name, const dynamic_properties& dp, const Key& key)
sl@0: {
sl@0:   for (dynamic_properties::const_iterator i = dp.lower_bound(name);
sl@0:        i != dp.end() && i->first == name; ++i) {
sl@0:     if (i->second->key() == typeid(key))
sl@0:       return i->second->get_string(key);
sl@0:   }
sl@0: 
sl@0:   throw dynamic_get_failure(name);
sl@0: }
sl@0: 
sl@0: 
sl@0: }
sl@0: 
sl@0: #endif // DYNAMIC_PROPERTY_MAP_RG09302004_HPP