minidump: Change the ownership model

minidump/minidump_simple_string_dictionary_writer.h

 // Copyright 2014 The Crashpad Authors. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
 #ifndef CRASHPAD_MINIDUMP_MINIDUMP_SIMPLE_STRING_DICTIONARY_WRITER_H_
 #define CRASHPAD_MINIDUMP_MINIDUMP_SIMPLE_STRING_DICTIONARY_WRITER_H_
 
 #include <sys/types.h>
 
 #include <string>
 #include <map>
 #include <vector>
 
 #include "base/basictypes.h"
+#include "base/memory/scoped_ptr.h"
 #include "minidump/minidump_extensions.h"
 #include "minidump/minidump_string_writer.h"
 #include "minidump/minidump_writable.h"
 
 namespace crashpad {
 
 //! \brief The writer for a MinidumpSimpleStringDictionaryEntry object in a
 //!     minidump file.
 //!
 //! Because MinidumpSimpleStringDictionaryEntry objects only appear as elements
 //! of MinidumpSimpleStringDictionary objects, this class does not write any
 //! data on its own. It makes its MinidumpSimpleStringDictionaryEntry data
 //! available to its MinidumpSimpleStringDictionaryWriter parent, which writes
 //! it as part of a MinidumpSimpleStringDictionary.
 class MinidumpSimpleStringDictionaryEntryWriter final
     : public internal::MinidumpWritable {
  public:
   MinidumpSimpleStringDictionaryEntryWriter();
-  ~MinidumpSimpleStringDictionaryEntryWriter();
+  ~MinidumpSimpleStringDictionaryEntryWriter() override;
 
   //! \brief Returns a MinidumpSimpleStringDictionaryEntry referencing this
   //!     object’s data.
   //!
   //! This method is expected to be called by a
   //! MinidumpSimpleStringDictionaryWriter in order to obtain a
   //! MinidumpSimpleStringDictionaryEntry to include in its list.
   //!
   //! \note Valid in #kStateWritable.
   const MinidumpSimpleStringDictionaryEntry*
@@ skipping 27 matching lines @@
 
 //! \brief The writer for a MinidumpSimpleStringDictionary object in a minidump
 //!     file, containing a list of MinidumpSimpleStringDictionaryEntry objects.
 //!
 //! Because this class writes a representatin of a dictionary, the order of
 //! entries is insignificant. Entries may be written in any order.
 class MinidumpSimpleStringDictionaryWriter final
     : public internal::MinidumpWritable {
  public:
   MinidumpSimpleStringDictionaryWriter();
-  ~MinidumpSimpleStringDictionaryWriter();
+  ~MinidumpSimpleStringDictionaryWriter() override;
 
   //! \brief Adds a MinidumpSimpleStringDictionaryEntryWriter to the
   //!     MinidumpSimpleStringDictionary.
   //!
-  //! \a entry will become a child of this object in the overall tree of
-  //! internal::MinidumpWritable objects.
+  //! This object takes ownership of \a entry and becomes its parent in the
+  //! overall tree of internal::MinidumpWritable objects.
   //!
   //! If the key contained in \a entry duplicates the key of an entry already
   //! present in the MinidumpSimpleStringDictionary, the new \a entry will
   //! replace the previous one.
   //!
   //! \note Valid in #kStateMutable.
-  void AddEntry(MinidumpSimpleStringDictionaryEntryWriter* entry);
+  void AddEntry(scoped_ptr<MinidumpSimpleStringDictionaryEntryWriter> entry);
 
  protected:
   // MinidumpWritable:
 
   bool Freeze() override;
   size_t SizeOfObject() override;
   std::vector<MinidumpWritable*> Children() override;
   bool WriteObject(FileWriterInterface* file_writer) override;
 
  private:
   MinidumpSimpleStringDictionary simple_string_dictionary_base_;
-  std::map<std::string, MinidumpSimpleStringDictionaryEntryWriter*>
-      entries_;  // weak
+
+  // This object owns the MinidumpSimpleStringDictionaryEntryWriter objects.
+  std::map<std::string, MinidumpSimpleStringDictionaryEntryWriter*> entries_;
 
   DISALLOW_COPY_AND_ASSIGN(MinidumpSimpleStringDictionaryWriter);
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_MINIDUMP_MINIDUMP_SIMPLE_STRING_DICTIONARY_WRITER_H_