Many changes to DictionaryValues:...

base/values.h

-// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+// Copyright (c) 2009 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file specifies a recursive data storage class called Value
 // intended for storing setting and other persistable data.
 // It includes the ability to specify (recursive) lists and dictionaries, so
 // it's fairly expressive.  However, the API is optimized for the common case,
 // namely storing a hierarchical tree of simple values.  Given a
 // DictionaryValue root, you can easily do things like:
 //
@@ skipping 188 matching lines @@
   ~DictionaryValue();
 
   // Subclassed methods
   Value* DeepCopy() const;
   virtual bool Equals(const Value* other) const;
 
   // Returns true if the current dictionary has a value for the given key.
   bool HasKey(const std::wstring& key) const;
 
   // Returns the number of Values in this dictionary.
-  size_t GetSize() const { return dictionary_.size(); }
+  size_t size() const { return dictionary_.size(); }
+
+  // Returns whether the dictionary is empty.
+  bool empty() const { return dictionary_.empty(); }
 
   // Clears any current contents of this dictionary.
   void Clear();
 
   // Sets the Value associated with the given path starting from this object.
   // A path has the form "<key>" or "<key>.<key>.[...]", where "." indexes
   // into the next DictionaryValue down.  Obviously, "." can't be used
   // within a key, but there are no other restrictions on keys.
   // If the key at any step of the way doesn't exist, or exists but isn't
   // a DictionaryValue, a new DictionaryValue will be created and attached
   // to the path in that location.
   // Note that the dictionary takes ownership of the value referenced by
-  // |in_value|.
-  bool Set(const std::wstring& path, Value* in_value);
+  // |in_value|, and therefore |in_value| must be non-NULL.
+  void Set(const std::wstring& path, Value* in_value);
 
   // Convenience forms of Set().  These methods will replace any existing
   // value at that path, even if it has a different type.
-  bool SetBoolean(const std::wstring& path, bool in_value);
-  bool SetInteger(const std::wstring& path, int in_value);
-  bool SetReal(const std::wstring& path, double in_value);
-  bool SetString(const std::wstring& path, const std::string& in_value);
-  bool SetString(const std::wstring& path, const std::wstring& in_value);
+  void SetBoolean(const std::wstring& path, bool in_value);
+  void SetInteger(const std::wstring& path, int in_value);
+  void SetReal(const std::wstring& path, double in_value);
+  void SetString(const std::wstring& path, const std::string& in_value);
+  void SetString(const std::wstring& path, const std::wstring& in_value);
+
+  // Like Set(), but without special treatment of '.'.  This allows e.g. URLs to
+  // be used as paths.
+  void SetWithoutPathExpansion(const std::wstring& key, Value* in_value);
 
   // Gets the Value associated with the given path starting from this object.
   // A path has the form "<key>" or "<key>.<key>.[...]", where "." indexes
   // into the next DictionaryValue down.  If the path can be resolved
   // successfully, the value for the last key in the path will be returned
   // through the "value" parameter, and the function will return true.
   // Otherwise, it will return false and "value" will be untouched.
   // Note that the dictionary always owns the value that's returned.
   bool Get(const std::wstring& path, Value** out_value) const;
 
   // These are convenience forms of Get().  The value will be retrieved
   // and the return value will be true if the path is valid and the value at
   // the end of the path can be returned in the form specified.
   bool GetBoolean(const std::wstring& path, bool* out_value) const;
   bool GetInteger(const std::wstring& path, int* out_value) const;
   bool GetReal(const std::wstring& path, double* out_value) const;
   bool GetString(const std::wstring& path, std::string* out_value) const;
   bool GetString(const std::wstring& path, std::wstring* out_value) const;
   bool GetBinary(const std::wstring& path, BinaryValue** out_value) const;
   bool GetDictionary(const std::wstring& path,
                      DictionaryValue** out_value) const;
   bool GetList(const std::wstring& path, ListValue** out_value) const;
 
+  // Like Get(), but without special treatment of '.'.  This allows e.g. URLs to
+  // be used as paths.
+  bool GetWithoutPathExpansion(const std::wstring& key,
+                               Value** out_value) const;
+  bool GetIntegerWithoutPathExpansion(const std::wstring& path,
+                                      int* out_value) const;
+  bool GetStringWithoutPathExpansion(const std::wstring& path,
+                                     std::string* out_value) const;
+  bool GetStringWithoutPathExpansion(const std::wstring& path,
+                                     std::wstring* out_value) const;
+  bool GetDictionaryWithoutPathExpansion(const std::wstring& path,
+                                         DictionaryValue** out_value) const;
+  bool GetListWithoutPathExpansion(const std::wstring& path,
+                                   ListValue** out_value) const;
+
   // Removes the Value with the specified path from this dictionary (or one
   // of its child dictionaries, if the path is more than just a local key).
   // If |out_value| is non-NULL, the removed Value AND ITS OWNERSHIP will be
   // passed out via out_value.  If |out_value| is NULL, the removed value will
   // be deleted.  This method returns true if |path| is a valid path; otherwise
   // it will return false and the DictionaryValue object will be unchanged.
   bool Remove(const std::wstring& path, Value** out_value);
 
+  // Like Remove(), but without special treatment of '.'.  This allows e.g. URLs
+  // to be used as paths.
+  bool RemoveWithoutPathExpansion(const std::wstring& key, Value** out_value);
+
   // This class provides an iterator for the keys in the dictionary.
   // It can't be used to modify the dictionary.
+  //
+  // YOU SHOULD ALWAYS USE THE XXXWithoutPathExpansion() APIs WITH THESE, NOT
+  // THE NORMAL XXX() APIs.  This makes sure things will work correctly if any
+  // keys have '.'s in them.
   class key_iterator
     : private std::iterator<std::input_iterator_tag, const std::wstring> {
    public:
     explicit key_iterator(ValueMap::const_iterator itr) { itr_ = itr; }
     key_iterator operator++() { ++itr_; return *this; }
     const std::wstring& operator*() { return itr_->first; }
     bool operator!=(const key_iterator& other) { return itr_ != other.itr_; }
     bool operator==(const key_iterator& other) { return itr_ == other.itr_; }
 
    private:
     ValueMap::const_iterator itr_;
   };
 
   key_iterator begin_keys() const { return key_iterator(dictionary_.begin()); }
   key_iterator end_keys() const { return key_iterator(dictionary_.end()); }
 
  private:
-  // Associates the value |in_value| with the |key|.  This method should be
-  // used instead of "dictionary_[key] = foo" so that any previous value can
-  // be properly deleted.
-  void SetInCurrentNode(const std::wstring& key, Value* in_value);
-
   ValueMap dictionary_;
 
   DISALLOW_COPY_AND_ASSIGN(DictionaryValue);
 };
 
 // This type of Value represents a list of other Value values.
 class ListValue : public Value {
  public:
   ListValue() : Value(TYPE_LIST) {}
   ~ListValue();
@@ skipping 74 matching lines @@
   virtual bool Serialize(const Value& root) = 0;
 
   // This method deserializes the subclass-specific format into a Value object.
   // If the return value is non-NULL, the caller takes ownership of returned
   // Value. If the return value is NULL, and if error_message is non-NULL,
   // error_message should be filled with a message describing the error.
   virtual Value* Deserialize(std::string* error_message) = 0;
 };
 
 #endif  // BASE_VALUES_H_