crashpad/snapshot/win/pe_image_annotations_reader.h
Peter Boström 1aa478d161 Remove DISALLOW_* macros in crashpad
This change was partially scripted and partially done manually with vim
regex + manually placing the deleted constructors.

The script change looked for destructors in the public: section of a
class, if that existed the deleted constructors would go before the
destructor.

For manual placement I looked for any constructor in the public: section
of the corresponding class. If there wasn't one, then it would ideally
have gone as the first entry except below enums, classes and typedefs.
This may not have been perfect, but is hopefully good enough. Fingers
crossed.

#include "base/macros.h" is removed from files that don't use
ignore_result, which is the only other thing defined in base/macros.h.

Bug: chromium:1010217
Change-Id: I099526255a40b1ac1264904b4ece2f3f503c9418
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/3171034
Reviewed-by: Mark Mentovai <mark@chromium.org>
Commit-Queue: Peter Boström <pbos@chromium.org>
2021-09-21 15:09:44 +00:00

84 lines
3.2 KiB
C++

// Copyright 2015 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_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_
#define CRASHPAD_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_
#include <map>
#include <string>
#include <vector>
#include "snapshot/annotation_snapshot.h"
namespace crashpad {
class PEImageReader;
class ProcessReaderWin;
//! \brief A reader of annotations stored in a PE image mapped into another
//! process.
//!
//! These annotations are stored for the benefit of crash reporters, and provide
//! information thought to be potentially useful for crash analysis.
//!
//! Currently, this class can decode information stored only in the CrashpadInfo
//! structure. This format is used by Crashpad clients. The "simple annotations"
//! are recovered from any module with a compatible data section, and are
//! included in the annotations returned by SimpleMap().
class PEImageAnnotationsReader {
public:
//! \brief Constructs the object.
//!
//! \param[in] process_reader The reader for the remote process.
//! \param[in] pe_image_reader The PEImageReader for the PE image file
//! contained within the remote process.
//! \param[in] name The module's name, a string to be used in logged messages.
//! This string is for diagnostic purposes only, and may be empty.
PEImageAnnotationsReader(ProcessReaderWin* process_reader,
const PEImageReader* pe_image_reader,
const std::wstring& name);
PEImageAnnotationsReader(const PEImageAnnotationsReader&) = delete;
PEImageAnnotationsReader& operator=(const PEImageAnnotationsReader&) = delete;
~PEImageAnnotationsReader() {}
//! \brief Returns the module's annotations that are organized as key-value
//! pairs, where all keys and values are strings.
std::map<std::string, std::string> SimpleMap() const;
//! \brief Returns the module's annotations that are organized as a list of
//! typed annotation objects.
std::vector<AnnotationSnapshot> AnnotationsList() const;
private:
// Reads CrashpadInfo::simple_annotations_ on behalf of SimpleMap().
template <class Traits>
void ReadCrashpadSimpleAnnotations(
std::map<std::string, std::string>* simple_map_annotations) const;
// Reads CrashpadInfo::annotations_list_ on behalf of AnnotationsList().
template <class Traits>
void ReadCrashpadAnnotationsList(
std::vector<AnnotationSnapshot>* vector_annotations) const;
std::wstring name_;
ProcessReaderWin* process_reader_; // weak
const PEImageReader* pe_image_reader_; // weak
};
} // namespace crashpad
#endif // CRASHPAD_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_