mukesh agrawal | 4d0401c | 2012-01-06 16:05:31 -0800 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef SHILL_PROPERTY_STORE_ |
| 6 | #define SHILL_PROPERTY_STORE_ |
| 7 | |
| 8 | #include <map> |
| 9 | #include <string> |
| 10 | #include <vector> |
| 11 | |
| 12 | #include <base/basictypes.h> |
| 13 | |
| 14 | #include "shill/accessor_interface.h" |
Chris Masone | a8a2c25 | 2011-06-27 22:16:30 -0700 | [diff] [blame] | 15 | #include "shill/property_iterator.h" |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 16 | |
| 17 | namespace shill { |
| 18 | |
| 19 | class Error; |
| 20 | |
| 21 | class PropertyStore { |
| 22 | public: |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 23 | PropertyStore(); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 24 | virtual ~PropertyStore(); |
| 25 | |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 26 | virtual bool Contains(const std::string& property) const; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 27 | |
| 28 | // Methods to allow the setting, by name, of properties stored in this object. |
| 29 | // The property names are declared in chromeos/dbus/service_constants.h, |
| 30 | // so that they may be shared with libcros. |
| 31 | // Upon success, these methods return true and leave |error| untouched. |
| 32 | // Upon failure, they return false and set |error| appropriately, if it |
| 33 | // is non-NULL. |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 34 | virtual bool SetBoolProperty(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 35 | bool value, |
| 36 | Error *error); |
| 37 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 38 | virtual bool SetInt16Property(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 39 | int16 value, |
| 40 | Error *error); |
| 41 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 42 | virtual bool SetInt32Property(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 43 | int32 value, |
| 44 | Error *error); |
| 45 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 46 | virtual bool SetStringProperty(const std::string &name, |
| 47 | const std::string &value, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 48 | Error *error); |
| 49 | |
| 50 | virtual bool SetStringmapProperty( |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 51 | const std::string &name, |
| 52 | const std::map<std::string, std::string> &values, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 53 | Error *error); |
| 54 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 55 | virtual bool SetStringsProperty(const std::string &name, |
| 56 | const std::vector<std::string> &values, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 57 | Error *error); |
| 58 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 59 | virtual bool SetUint8Property(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 60 | uint8 value, |
| 61 | Error *error); |
| 62 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 63 | virtual bool SetUint16Property(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 64 | uint16 value, |
| 65 | Error *error); |
| 66 | |
mukesh agrawal | 66b0aca | 2012-01-30 15:28:28 -0800 | [diff] [blame^] | 67 | virtual bool SetUint32Property(const std::string &name, |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 68 | uint32 value, |
| 69 | Error *error); |
| 70 | |
mukesh agrawal | 4d260da | 2012-01-30 11:53:52 -0800 | [diff] [blame] | 71 | // Clearing a property resets it to its "factory" value. This value |
| 72 | // is generally the value that it (the property) had when it was |
| 73 | // registered with PropertyStore. |
| 74 | // |
| 75 | // The exception to this rule is write-only derived properties. For |
| 76 | // such properties, the property owner explicitly provides a |
| 77 | // "factory" value at registration time. This is necessary because |
| 78 | // PropertyStore can't read the current value at registration time. |
| 79 | // |
| 80 | // |name| is the key used to access the property. If the property |
| 81 | // cannot be cleared, |error| is set, and the method returns false. |
| 82 | // Otherwrise, |error| is unchanged, and the method returns true. |
| 83 | virtual bool ClearProperty(const std::string &name, Error *error); |
| 84 | |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 85 | // We do not provide methods for reading individual properties, |
| 86 | // because we don't need them to implement the flimflam API. (The flimflam |
| 87 | // API only allows fetching all properties at once -- not individual |
| 88 | // properties.) |
| 89 | |
| 90 | // Accessors for iterators over property maps. Useful for dumping all |
| 91 | // properties. |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 92 | ReadablePropertyConstIterator<bool> GetBoolPropertiesIter() const; |
| 93 | ReadablePropertyConstIterator<int16> GetInt16PropertiesIter() const; |
| 94 | ReadablePropertyConstIterator<int32> GetInt32PropertiesIter() const; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 95 | ReadablePropertyConstIterator<KeyValueStore> GetKeyValueStorePropertiesIter( |
| 96 | ) const; |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 97 | ReadablePropertyConstIterator<std::string> GetStringPropertiesIter() const; |
| 98 | ReadablePropertyConstIterator<Stringmap> GetStringmapPropertiesIter() const; |
| 99 | ReadablePropertyConstIterator<Stringmaps> GetStringmapsPropertiesIter() const; |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 100 | ReadablePropertyConstIterator<Strings> GetStringsPropertiesIter() const; |
| 101 | ReadablePropertyConstIterator<uint8> GetUint8PropertiesIter() const; |
| 102 | ReadablePropertyConstIterator<uint16> GetUint16PropertiesIter() const; |
| 103 | ReadablePropertyConstIterator<uint32> GetUint32PropertiesIter() const; |
Chris Masone | a8a2c25 | 2011-06-27 22:16:30 -0700 | [diff] [blame] | 104 | |
mukesh agrawal | 4d260da | 2012-01-30 11:53:52 -0800 | [diff] [blame] | 105 | // Methods for registering a property. |
| 106 | // |
| 107 | // It is permitted to re-register a property (in which case the old |
| 108 | // binding is forgotten). However, the newly bound object must be of |
| 109 | // the same type. |
| 110 | // |
| 111 | // Note that types do not encode read-write permission. Hence, it |
| 112 | // is possible to change permissions by rebinding a property to the |
| 113 | // same object. |
| 114 | // |
| 115 | // (Corollary of the rebinding-to-same-type restriction: a |
| 116 | // PropertyStore cannot hold two properties of the same name, but |
| 117 | // differing types.) |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 118 | void RegisterBool(const std::string &name, bool *prop); |
| 119 | void RegisterConstBool(const std::string &name, const bool *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 120 | void RegisterWriteOnlyBool(const std::string &name, bool *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 121 | void RegisterInt16(const std::string &name, int16 *prop); |
| 122 | void RegisterConstInt16(const std::string &name, const int16 *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 123 | void RegisterWriteOnlyInt16(const std::string &name, int16 *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 124 | void RegisterInt32(const std::string &name, int32 *prop); |
| 125 | void RegisterConstInt32(const std::string &name, const int32 *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 126 | void RegisterWriteOnlyInt32(const std::string &name, int32 *prop); |
mukesh agrawal | 4d260da | 2012-01-30 11:53:52 -0800 | [diff] [blame] | 127 | void RegisterUint32(const std::string &name, uint32 *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 128 | void RegisterString(const std::string &name, std::string *prop); |
| 129 | void RegisterConstString(const std::string &name, const std::string *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 130 | void RegisterWriteOnlyString(const std::string &name, std::string *prop); |
Chris Masone | 43b48a1 | 2011-07-01 13:37:07 -0700 | [diff] [blame] | 131 | void RegisterStringmap(const std::string &name, Stringmap *prop); |
| 132 | void RegisterConstStringmap(const std::string &name, const Stringmap *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 133 | void RegisterWriteOnlyStringmap(const std::string &name, Stringmap *prop); |
Darin Petkov | c086531 | 2011-09-16 15:31:20 -0700 | [diff] [blame] | 134 | void RegisterStringmaps(const std::string &name, Stringmaps *prop); |
| 135 | void RegisterConstStringmaps(const std::string &name, const Stringmaps *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 136 | void RegisterWriteOnlyStringmaps(const std::string &name, Stringmaps *prop); |
Chris Masone | 43b48a1 | 2011-07-01 13:37:07 -0700 | [diff] [blame] | 137 | void RegisterStrings(const std::string &name, Strings *prop); |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 138 | void RegisterConstStrings(const std::string &name, const Strings *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 139 | void RegisterWriteOnlyStrings(const std::string &name, Strings *prop); |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 140 | void RegisterUint8(const std::string &name, uint8 *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 141 | void RegisterConstUint8(const std::string &name, const uint8 *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 142 | void RegisterWriteOnlyUint8(const std::string &name, uint8 *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 143 | void RegisterUint16(const std::string &name, uint16 *prop); |
| 144 | void RegisterConstUint16(const std::string &name, const uint16 *prop); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 145 | void RegisterWriteOnlyUint16(const std::string &name, uint16 *prop); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 146 | |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 147 | void RegisterDerivedBool(const std::string &name, |
| 148 | const BoolAccessor &accessor); |
mukesh agrawal | 4d0401c | 2012-01-06 16:05:31 -0800 | [diff] [blame] | 149 | void RegisterDerivedInt32(const std::string &name, |
| 150 | const Int32Accessor &accessor); |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 151 | void RegisterDerivedKeyValueStore(const std::string &name, |
| 152 | const KeyValueStoreAccessor &accessor); |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 153 | void RegisterDerivedString(const std::string &name, |
| 154 | const StringAccessor &accessor); |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 155 | void RegisterDerivedStringmaps(const std::string &name, |
| 156 | const StringmapsAccessor &accessor); |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 157 | void RegisterDerivedStrings(const std::string &name, |
| 158 | const StringsAccessor &accessor); |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 159 | void RegisterDerivedUint16(const std::string &name, |
| 160 | const Uint16Accessor &accessor); |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 161 | |
| 162 | private: |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 163 | template <class V> |
| 164 | bool SetProperty( |
| 165 | const std::string &name, |
| 166 | const V &value, |
| 167 | Error *error, |
| 168 | std::map< std::string, std::tr1::shared_ptr< AccessorInterface<V> > > &, |
| 169 | const std::string &value_type_english); |
| 170 | |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 171 | // These are std::maps instead of something cooler because the common |
| 172 | // operation is iterating through them and returning all properties. |
| 173 | std::map<std::string, BoolAccessor> bool_properties_; |
| 174 | std::map<std::string, Int16Accessor> int16_properties_; |
| 175 | std::map<std::string, Int32Accessor> int32_properties_; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 176 | std::map<std::string, KeyValueStoreAccessor> key_value_store_properties_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 177 | std::map<std::string, StringAccessor> string_properties_; |
| 178 | std::map<std::string, StringmapAccessor> stringmap_properties_; |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 179 | std::map<std::string, StringmapsAccessor> stringmaps_properties_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 180 | std::map<std::string, StringsAccessor> strings_properties_; |
| 181 | std::map<std::string, Uint8Accessor> uint8_properties_; |
| 182 | std::map<std::string, Uint16Accessor> uint16_properties_; |
| 183 | std::map<std::string, Uint32Accessor> uint32_properties_; |
| 184 | |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 185 | DISALLOW_COPY_AND_ASSIGN(PropertyStore); |
| 186 | }; |
| 187 | |
| 188 | } // namespace shill |
| 189 | |
| 190 | #endif // SHILL_PROPERTY_STORE_ |