File: history_tool.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (80 lines) | stat: -rw-r--r-- 2,812 bytes parent folder | download | duplicates (3)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_ACTOR_TOOLS_HISTORY_TOOL_H_
#define CHROME_BROWSER_ACTOR_TOOLS_HISTORY_TOOL_H_

#include <memory>
#include <optional>
#include <vector>

#include "base/memory/weak_ptr.h"
#include "chrome/browser/actor/tools/history_tool_request.h"
#include "chrome/browser/actor/tools/tool.h"
#include "chrome/browser/actor/tools/tool_request.h"
#include "chrome/common/actor.mojom-forward.h"
#include "components/tabs/public/tab_interface.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/web_contents_observer.h"
#include "third_party/abseil-cpp/absl/container/flat_hash_set.h"

namespace content {
class NavigationHandle;
class WebContents;
}  // namespace content

namespace actor {

// Performs a history navigation in a WebContents.
class HistoryTool : public Tool, content::WebContentsObserver {
 public:
  HistoryTool(TaskId task_id,
              AggregatedJournal& journal,
              content::WebContents& web_contents,
              HistoryToolRequest::Direction direction);
  ~HistoryTool() override;

  // actor::Tool
  void Validate(ValidateCallback callback) override;
  void Invoke(InvokeCallback callback) override;
  std::string DebugString() const override;
  std::string JournalEvent() const override;
  std::unique_ptr<ObservationDelayController> GetObservationDelayer()
      const override;

  // content::WebContentsObserver
  void DidStartNavigation(
      content::NavigationHandle* navigation_handle) override;
  void DidFinishNavigation(
      content::NavigationHandle* navigation_handle) override;

 private:
  void FinishToolInvocationIfNeeded(mojom::ActionResultPtr result);

  void PurgePendingNavigations();

  bool IsInvokeInProgress() const;

  // Whether the navigation is backwards or forwards in session history.
  HistoryToolRequest::Direction direction_;

  // This class tracks all navigation handles created as a result of the history
  // traversal in `pending_navigations_`. However, these navigations may or may
  // not start. When they are started (or canceled), they are removed from this
  // vector. Started navigations that are added to `in_flight_navigation_ids_`.
  // Note: these are vector/set since a history traversal can navigate multiple
  // frames.
  content::NavigationController::WeakNavigationHandleVector
      pending_navigations_;
  absl::flat_hash_set<uint64_t> in_flight_navigation_ids_;

  // Holds the callback to the Invoke method. Null before invoke is called.
  InvokeCallback invoke_callback_;

  base::WeakPtrFactory<HistoryTool> weak_ptr_factory_{this};
};

}  // namespace actor

#endif  // CHROME_BROWSER_ACTOR_TOOLS_HISTORY_TOOL_H_