minidump: Change the ownership model

minidump/minidump_module_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,
@@ skipping 10 matching lines @@
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
 #include "minidump/minidump_extensions.h"
 #include "minidump/minidump_stream_writer.h"
 #include "minidump/minidump_writable.h"
+#include "util/stdlib/pointer_container.h"
 
 namespace crashpad {
 
 namespace internal {
 class MinidumpUTF16StringWriter;
 }  // namespace internal
 
 //! \brief The base class for writers of CodeView records referenced by
 //!     MINIDUMP_MODULE::CvRecord in minidump files.
 class MinidumpModuleCodeViewRecordWriter : public internal::MinidumpWritable {
  public:
-  virtual ~MinidumpModuleCodeViewRecordWriter();
+  ~MinidumpModuleCodeViewRecordWriter() override;
 
  protected:
   MinidumpModuleCodeViewRecordWriter() : MinidumpWritable() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MinidumpModuleCodeViewRecordWriter);
 };
 
 namespace internal {
 
@@ skipping 74 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(MinidumpModuleCodeViewRecordPDB70Writer);
 };
 
 //! \brief The writer for an IMAGE_DEBUG_MISC object in a minidump file.
 //!
 //! Most users will want MinidumpModuleCodeViewRecordPDB70Writer instead.
 class MinidumpModuleMiscDebugRecordWriter final
     : public internal::MinidumpWritable {
  public:
   MinidumpModuleMiscDebugRecordWriter();
-  ~MinidumpModuleMiscDebugRecordWriter() {}
+  ~MinidumpModuleMiscDebugRecordWriter() override;
 
   //! \brief Sets IMAGE_DEBUG_MISC::DataType.
   void SetDataType(uint32_t data_type) {
     image_debug_misc_.DataType = data_type;
   }
 
   //! \brief Sets IMAGE_DEBUG_MISC::Data, IMAGE_DEBUG_MISC::Length, and
   //!     IMAGE_DEBUG_MISC::Unicode.
   //!
   //! If \a utf16 is `true`, \a data will be treated as UTF-8 data and will be
@@ skipping 18 matching lines @@
 
 //! \brief The writer for a MINIDUMP_MODULE object in a minidump file.
 //!
 //! Because MINIDUMP_MODULE objects only appear as elements of
 //! MINIDUMP_MODULE_LIST objects, this class does not write any data on its own.
 //! It makes its MINIDUMP_MODULE data available to its MinidumpModuleListWriter
 //! parent, which writes it as part of a MINIDUMP_MODULE_LIST.
 class MinidumpModuleWriter final : public internal::MinidumpWritable {
  public:
   MinidumpModuleWriter();
-  ~MinidumpModuleWriter();
+  ~MinidumpModuleWriter() override;
 
   //! \brief Returns a MINIDUMP_MODULE referencing this object’s data.
   //!
   //! This method is expected to be called by a MinidumpModuleListWriter in
   //! order to obtain a MINIDUMP_MODULE to include in its list.
   //!
   //! \note Valid in #kStateWritable.
   const MINIDUMP_MODULE* MinidumpModule() const;
 
   //! \brief Arranges for MINIDUMP_MODULE::ModuleNameRva to point to a
   //!     MINIDUMP_STRING containing \a name.
   //!
   //! A name is required in all MINIDUMP_MODULE objects.
   //!
   //! \note Valid in #kStateMutable.
   void SetName(const std::string& name);
 
   //! \brief Arranges for MINIDUMP_MODULE::CvRecord to point to a CodeView
   //!     record to be written by \a codeview_record.
   //!
-  //! \a codeview_record will become a child of this object in the overall tree
-  //! of internal::MinidumpWritable objects.
+  //! This object takes ownership of \a codeview_record and becomes its parent
+  //! in the overall tree of internal::MinidumpWritable objects.
   //!
   //! \note Valid in #kStateMutable.
-  void SetCodeViewRecord(MinidumpModuleCodeViewRecordWriter* codeview_record);
+  void SetCodeViewRecord(
+      scoped_ptr<MinidumpModuleCodeViewRecordWriter> codeview_record);
 
   //! \brief Arranges for MINIDUMP_MODULE::MiscRecord to point to an
   //!     IMAGE_DEBUG_MISC object to be written by \a misc_debug_record.
   //!
-  //! \a misc_debug_record will become a child of this object in the overall
-  //! tree of internal::MinidumpWritable objects.
+  //! This object takes ownership of \a misc_debug_record and becomes its parent
+  //! in the overall tree of internal::MinidumpWritable objects.
   //!
   //! \note Valid in #kStateMutable.
   void SetMiscDebugRecord(
-      MinidumpModuleMiscDebugRecordWriter* misc_debug_record);
+      scoped_ptr<MinidumpModuleMiscDebugRecordWriter> misc_debug_record);
 
   //! \brief Sets IMAGE_DEBUG_MISC::BaseOfImage.
   void SetImageBaseAddress(uint64_t image_base_address) {
     module_.BaseOfImage = image_base_address;
   }
 
   //! \brief Sets IMAGE_DEBUG_MISC::SizeOfImage.
   void SetImageSize(uint32_t image_size) { module_.SizeOfImage = image_size; }
 
   //! \brief Sets IMAGE_DEBUG_MISC::CheckSum.
@@ skipping 50 matching lines @@
  protected:
   // MinidumpWritable:
   bool Freeze() override;
   size_t SizeOfObject() override;
   std::vector<MinidumpWritable*> Children() override;
   bool WriteObject(FileWriterInterface* file_writer) override;
 
  private:
   MINIDUMP_MODULE module_;
   scoped_ptr<internal::MinidumpUTF16StringWriter> name_;
-  MinidumpModuleCodeViewRecordWriter* codeview_record_;  // weak
-  MinidumpModuleMiscDebugRecordWriter* misc_debug_record_;  // weak
+  scoped_ptr<MinidumpModuleCodeViewRecordWriter> codeview_record_;
+  scoped_ptr<MinidumpModuleMiscDebugRecordWriter> misc_debug_record_;
 
   DISALLOW_COPY_AND_ASSIGN(MinidumpModuleWriter);
 };
 
 //! \brief The writer for a MINIDUMP_MODULE_LIST stream in a minidump file,
 //!     containing a list of MINIDUMP_MODULE objects.
 class MinidumpModuleListWriter final : public internal::MinidumpStreamWriter {
  public:
   MinidumpModuleListWriter();
-  ~MinidumpModuleListWriter();
+  ~MinidumpModuleListWriter() override;
 
   //! \brief Adds a MinidumpModuleWriter to the MINIDUMP_MODULE_LIST.
   //!
-  //! \a module will become a child of this object in the overall tree of
-  //! internal::MinidumpWritable objects.
+  //! This object takes ownership of \a module and becomes its parent in the
+  //! overall tree of internal::MinidumpWritable objects.
   //!
   //! \note Valid in #kStateMutable.
-  void AddModule(MinidumpModuleWriter* module);
+  void AddModule(scoped_ptr<MinidumpModuleWriter> module);
 
  protected:
   // MinidumpWritable:
   bool Freeze() override;
   size_t SizeOfObject() override;
   std::vector<MinidumpWritable*> Children() override;
   bool WriteObject(FileWriterInterface* file_writer) override;
 
   // MinidumpStreamWriter:
   MinidumpStreamType StreamType() const override;
 
  private:
   MINIDUMP_MODULE_LIST module_list_base_;
-  std::vector<MinidumpModuleWriter*> modules_;  // weak
+  PointerVector<MinidumpModuleWriter> modules_;
 
   DISALLOW_COPY_AND_ASSIGN(MinidumpModuleListWriter);
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_MINIDUMP_MINIDUMP_MODULE_WRITER_H_