MinidumpLocationDescriptorListWriter

minidump/minidump_location_descriptor_list_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_LOCATION_DESCRIPTOR_LIST_WRITER_H_
+#define CRASHPAD_MINIDUMP_LOCATION_DESCRIPTOR_LIST_WRITER_H_
+
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_ptr.h"
+#include "minidump/minidump_extensions.h"
+#include "minidump/minidump_writable.h"
+#include "util/stdlib/pointer_container.h"
+
+namespace crashpad {
+
+//! \brief The writer for a MinidumpLocationDescriptorList object in a minidump
+//!     file, containing a list of MINIDUMP_LOCATION_DESCRIPTOR objects.
+class MinidumpLocationDescriptorListWriter : public internal::MinidumpWritable {
+ protected:
+  MinidumpLocationDescriptorListWriter();
+  ~MinidumpLocationDescriptorListWriter() override;
+
+  //! \brief Adds a MINIDUMP_LOCATION_DESCRIPTOR referencing an
+  //!     internal::MinidumpWritable to the MinidumpLocationDescriptorList.
+  //!
+  //! This object takes ownership of \a child and becomes its parent in the
+  //! overall tree of internal::MinidumpWritable objects.
+  //!
+  //! To provide type-correctness, subclasses are expected to provide a public
+  //! method that accepts a `scoped_ptr`-wrapped argument of the proper
+  //! internal::MinidumpWritable subclass, and call this method with that
+  //! argument.
+  //!
+  //! \note Valid in #kStateMutable.
+  void AddChild(scoped_ptr<MinidumpWritable> child);
+
+  //! \brief Returns `true` if no child objects have been added by AddChild(),
+  //!     and `false` if child objects are present.
+  bool IsEmpty() const { return children_.empty(); }
+
+  //! \brief Returns an object’s MINIDUMP_LOCATION_DESCRIPTOR objects
+  //!     referencing its children.
+  //!
+  //! \note The returned vector will be empty until the object advances to
+  //!     #kStateFrozen or beyond.
+  const std::vector<MINIDUMP_LOCATION_DESCRIPTOR>& child_location_descriptors()
+      const {
+    return child_location_descriptors_;
+  }
+
+  // MinidumpWritable:
+  bool Freeze() override;
+  size_t SizeOfObject() override;
+  std::vector<MinidumpWritable*> Children() override;
+  bool WriteObject(FileWriterInterface* file_writer) override;
+
+ private:
+  MinidumpLocationDescriptorList location_descriptor_list_base_;
+  PointerVector<MinidumpWritable> children_;
+  std::vector<MINIDUMP_LOCATION_DESCRIPTOR> child_location_descriptors_;
+
+  DISALLOW_COPY_AND_ASSIGN(MinidumpLocationDescriptorListWriter);
+};
+
+}  // namespace crashpad
+
+#endif  // CRASHPAD_MINIDUMP_LOCATION_DESCRIPTOR_LIST_WRITER_H_