mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-10 14:46:07 +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>
75 lines
2.5 KiB
C++
75 lines
2.5 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_MEMORY_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
#define CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_MEMORY_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
|
|
#include <vector>
|
|
|
|
#include "snapshot/memory_snapshot.h"
|
|
#include "util/misc/address_types.h"
|
|
#include "util/misc/initialization_state_dcheck.h"
|
|
|
|
namespace crashpad {
|
|
namespace internal {
|
|
|
|
//! \brief A MemorySnapshot of a memory region.
|
|
class MemorySnapshotIOSIntermediateDump final : public MemorySnapshot {
|
|
public:
|
|
MemorySnapshotIOSIntermediateDump() = default;
|
|
|
|
MemorySnapshotIOSIntermediateDump(const MemorySnapshotIOSIntermediateDump&) =
|
|
delete;
|
|
MemorySnapshotIOSIntermediateDump& operator=(
|
|
const MemorySnapshotIOSIntermediateDump&) = delete;
|
|
|
|
~MemorySnapshotIOSIntermediateDump() = default;
|
|
|
|
//! \brief Initializes the object.
|
|
//!
|
|
//! \param[in] address The base address of the memory region to snapshot.
|
|
//! \param[in] data The destination address where the snapshot will be stored.
|
|
//! \param[in] size The size of the memory region to snapshot.
|
|
void Initialize(vm_address_t address, vm_address_t data, vm_size_t size);
|
|
|
|
// MemorySnapshot:
|
|
uint64_t Address() const override;
|
|
size_t Size() const override;
|
|
bool Read(Delegate* delegate) const override;
|
|
const MemorySnapshot* MergeWithOtherSnapshot(
|
|
const MemorySnapshot* other) const override;
|
|
|
|
private:
|
|
template <class T>
|
|
friend const MemorySnapshot* MergeWithOtherSnapshotImpl(
|
|
const T* self,
|
|
const MemorySnapshot* other);
|
|
|
|
vm_address_t address_;
|
|
vm_address_t data_;
|
|
|
|
// Because the iOS snapshot memory region is owned by the intermediate dump,
|
|
// it's necessary to copy the merged data into a vector owned by the memory
|
|
// snapshot itself.
|
|
std::vector<uint8_t> merged_data_;
|
|
|
|
vm_size_t size_;
|
|
InitializationStateDcheck initialized_;
|
|
};
|
|
|
|
} // namespace internal
|
|
} // namespace crashpad
|
|
|
|
#endif // CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_MEMORY_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|