1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_PAGE_CONTEXT_H_
#define COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_PAGE_CONTEXT_H_
#include <compare>
#include <optional>
#include <string>
#include "base/check.h"
#include "base/memory/weak_ptr.h"
#include "base/unguessable_token.h"
namespace content {
class WebContents;
}
namespace performance_manager {
class PageNode;
}
namespace resource_attribution {
class PageContext {
public:
~PageContext();
PageContext(const PageContext& other);
PageContext& operator=(const PageContext& other);
PageContext(PageContext&& other);
PageContext& operator=(PageContext&& other);
// UI thread methods
// Returns the PageContext for `contents`, which must be non-null. Returns
// nullopt if the WebContents is not registered with PerformanceManager.
static std::optional<PageContext> FromWebContents(
content::WebContents* contents);
// Returns the WebContents for this context, or nullptr if it no longer
// exists.
content::WebContents* GetWebContents() const;
// Returns the PageNode for this context, or a null WeakPtr if it no longer
// exists.
base::WeakPtr<performance_manager::PageNode> GetWeakPageNode() const;
// PM sequence methods
// Returns the PageContext for `node`. Equivalent to
// node->GetResourceContext().
static PageContext FromPageNode(const performance_manager::PageNode* node);
// Returns the PageContext for `node`, or nullopt if `node` is null.
static std::optional<PageContext> FromWeakPageNode(
base::WeakPtr<performance_manager::PageNode> node);
// Returns the PageNode for this context, or nullptr if it no longer exists.
performance_manager::PageNode* GetPageNode() const;
// Returns a string representation of the context for debugging. This matches
// the interface of base::TokenType and base::UnguessableToken, for
// convenience.
std::string ToString() const;
// Compare PageContexts by PageNode token.
constexpr friend auto operator<=>(const PageContext& a,
const PageContext& b) {
return a.token_ <=> b.token_;
}
// Test PageContexts for equality by PageNode token.
constexpr friend bool operator==(const PageContext& a, const PageContext& b) {
return a.token_ == b.token_;
}
private:
PageContext(base::UnguessableToken token,
base::WeakPtr<content::WebContents> weak_web_contents,
base::WeakPtr<performance_manager::PageNode> weak_node);
// A unique identifier for the PageNode. A PageNodeImpl::PageToken will be
// assigned to this, but DEPS rules won't let PageNodeImpl be included in a
// public header so UnguessableToken is used directly here. Used to ensure
// that PageContexts for the same PageNode compare equal.
base::UnguessableToken token_;
// A pointer to the WebContents that must be dereferenced on the UI thread.
base::WeakPtr<content::WebContents> weak_web_contents_;
// A pointer to the PageNode that must be dereferenced on the PM sequence.
base::WeakPtr<performance_manager::PageNode> weak_node_;
};
} // namespace resource_attribution
#endif // COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_PAGE_CONTEXT_H_
|