mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-17 16:43:53 +00:00
e428b3ad13
doc/support/crashpad.doxy is updated with:
```
% doxygen -u doc/support/crashpad.doxy
[…]
% doxygen -v
1.13.2
```
Additional updates to doc/support/crashpad.doxy are made:
- The settings for `DISABLE_INDEX` and `GENERATE_TREEVIEW` are updated,
as Doxygen’s defaults have changed. This switches from the
top-of-page index to the side-of-page tree view.
- The TODO and Deprecated sections have become more prominent under the
side-of-page tree view than they were with the top-of-page index, and
they’re not very useful in Crashpad documentation, so they’re
disabled by setting `GENERATE_TODOLIST` and `GENERATE_DEPRECATEDLIST`
appropriately. The similar (but unused in Crashpad)
`GENERATE_TESTLIST` and `GENERATE_BUGLIST` are also disabled.
- `USE_DOT` is now set, to use `dot` from GraphViz to generate SVG
diagrams. These look better than the PNGs that Doxygen generated
without `dot`. `DOT_COMMON_ATTR` and `DOT_EDGE_ATTR` are set to make
the fonts used in GraphViz-generated SVGs match those used in
Doxygen-generated HTML/CSS.
- `EXCLUDE` has been updated to drop directories that no longer exist
(compat/non_cxx11_lib) and add ones that now do (compat/android,
compat/ios, and compat/linux).
- Some values that were otherwise unused in doc/support/crashpad.doxy
are set back to their default values. The differences from the
default configuration are shown with `doxygen -x
doc/support/crashpad.doxy`, and a configuration template with default
values can be generated for inspection with `doxygen -g
/tmp/template.doxy`. The tags affected are:
- `MATHJAX_RELPATH`, unused since `USE_MATHJAX` is `NO`.
- `LATEX_CMD_NAME` and `LATEX_BIB_STYLE`, unused since `USE_LATEX`
is `NO`).
- `EXCLUDE_PATTERNS`, unused since `EXCLUDE_PATH` is empty.
doc/support/doxygen_crashpad.css is updated to change the non-monospaced
font from Open Sans to Noto Sans. It is also updated to use the CSS
properties Doxygen defines for the purpose, rather than monkeying around
with custom selectors. The properties can be discovered by running
`doxygen -w html header.html footer.html customdoxygen.css
doc/support/crashpad.doxy` and reviewing customdoxygen.css.
doc/support/generate.sh is updated to further execute
doc/support/generate_doxygen.py by invoking directly and relying on its
`#!/usr/bin/env python3` line rather than invoking via `python`, which
is no longer available on many systems. doc/support/generate_doxygen.py
has already been Python 3-compatible since f88a116c0e2e
(https://chromium-review.googlesource.com/c/3542572, 2022-03-23).
Finally, there are a number of changes to fix Doxygen warnings produced
by the new Doxygen version or because of new code that has not yet been
run through Doxygen during a test run.
Change-Id: I436688b16530cb0a07dbf89d32601fff689ac2f2
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/6180234
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Reviewed-by: Joshua Peraza <jperaza@chromium.org>
Commit-Queue: Mark Mentovai <mark@chromium.org>
98 lines
3.4 KiB
C++
98 lines
3.4 KiB
C++
// Copyright 2020 The Crashpad Authors
|
|
//
|
|
// 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_IOS_INTERMEDIATE_DUMP_MODULE_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
#define CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_MODULE_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
|
|
#include <mach-o/dyld_images.h>
|
|
#include <stdint.h>
|
|
#include <sys/types.h>
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "snapshot/crashpad_info_client_options.h"
|
|
#include "snapshot/module_snapshot.h"
|
|
#include "util/ios/ios_intermediate_dump_map.h"
|
|
#include "util/misc/initialization_state_dcheck.h"
|
|
|
|
namespace crashpad {
|
|
namespace internal {
|
|
|
|
//! \brief A ModuleSnapshot of a code module (binary image) loaded into a
|
|
//! running (or crashed) process on an iOS system.
|
|
class ModuleSnapshotIOSIntermediateDump final : public ModuleSnapshot {
|
|
public:
|
|
ModuleSnapshotIOSIntermediateDump();
|
|
|
|
ModuleSnapshotIOSIntermediateDump(const ModuleSnapshotIOSIntermediateDump&) =
|
|
delete;
|
|
ModuleSnapshotIOSIntermediateDump& operator=(
|
|
const ModuleSnapshotIOSIntermediateDump&) = delete;
|
|
|
|
~ModuleSnapshotIOSIntermediateDump() override;
|
|
|
|
//! \brief Initialize the snapshot
|
|
//!
|
|
//! \param[in] image_data The intermediate dump map used to initialize this
|
|
//! object.
|
|
//!
|
|
//! \return `true` if the snapshot could be created.
|
|
bool Initialize(const IOSIntermediateDumpMap* image_data);
|
|
|
|
// ModuleSnapshot:
|
|
std::string Name() const override;
|
|
uint64_t Address() const override;
|
|
uint64_t Size() const override;
|
|
time_t Timestamp() const override;
|
|
void FileVersion(uint16_t* version_0,
|
|
uint16_t* version_1,
|
|
uint16_t* version_2,
|
|
uint16_t* version_3) const override;
|
|
void SourceVersion(uint16_t* version_0,
|
|
uint16_t* version_1,
|
|
uint16_t* version_2,
|
|
uint16_t* version_3) const override;
|
|
ModuleType GetModuleType() const override;
|
|
void UUIDAndAge(UUID* uuid, uint32_t* age) const override;
|
|
std::string DebugFileName() const override;
|
|
std::vector<uint8_t> BuildID() const override;
|
|
std::vector<std::string> AnnotationsVector() const override;
|
|
std::map<std::string, std::string> AnnotationsSimpleMap() const override;
|
|
std::vector<AnnotationSnapshot> AnnotationObjects() const override;
|
|
std::set<CheckedRange<uint64_t>> ExtraMemoryRanges() const override;
|
|
std::vector<const UserMinidumpStream*> CustomMinidumpStreams() const override;
|
|
|
|
private:
|
|
std::string name_;
|
|
uint64_t address_;
|
|
uint64_t size_;
|
|
time_t timestamp_;
|
|
uint32_t dylib_version_;
|
|
uint64_t source_version_;
|
|
uint32_t filetype_;
|
|
UUID uuid_;
|
|
std::vector<std::string> annotations_vector_;
|
|
std::map<std::string, std::string> annotations_simple_map_;
|
|
std::vector<AnnotationSnapshot> annotation_objects_;
|
|
|
|
InitializationStateDcheck initialized_;
|
|
};
|
|
|
|
} // namespace internal
|
|
} // namespace crashpad
|
|
|
|
#endif // CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_MODULE_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|