File: navigation_entry_restore_context_impl.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (86 lines) | stat: -rw-r--r-- 3,566 bytes parent folder | download | duplicates (5)
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_ENTRY_RESTORE_CONTEXT_IMPL_H_
#define CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_ENTRY_RESTORE_CONTEXT_IMPL_H_

#include <map>
#include <string>

#include "base/memory/raw_ptr.h"
#include "content/common/content_export.h"
#include "content/public/browser/navigation_entry_restore_context.h"
#include "url/gurl.h"

namespace content {

class FrameNavigationEntry;

// NavigationEntryRestoreContextImpl is passed to
// NavigationEntry::SetPageState() when restoring a vector of NavigationEntries.
// It tracks the item sequence number (ISNs) associated with each
// FrameNavigationEntry (FNE), and maintains a mapping of ISNs to FNEs to
// ensure FNEs are de-duplicated if they appear in multiple NavigationEntries.
class CONTENT_EXPORT NavigationEntryRestoreContextImpl
    : public NavigationEntryRestoreContext {
 public:
  NavigationEntryRestoreContextImpl();
  ~NavigationEntryRestoreContextImpl() override;
  NavigationEntryRestoreContextImpl(const NavigationEntryRestoreContextImpl&) =
      delete;
  NavigationEntryRestoreContextImpl& operator=(
      const NavigationEntryRestoreContextImpl&) = delete;

  void AddFrameNavigationEntry(FrameNavigationEntry* entry);
  // If there is an existing FrameNavigationEntry with the given
  // |item_sequence_number| targeting |unique_name|, this returns it so that it
  // can be shared. Entries with the same ISN and unique name may differ by URL
  // if they were persisted from an earlier version, so this indexes by URL as
  // well.
  FrameNavigationEntry* GetFrameNavigationEntry(int64_t item_sequence_number,
                                                const std::string& unique_name,
                                                const GURL& url);

 private:
  // RestoreContext entries are indexed by item sequence number, unique name of
  // the frame, and URL. The unique name is a precaution in case the item
  // sequence number somehow appears in multiple frames. The URL is needed to
  // handle cases from older versions where a replaceState operation might have
  // caused multiple FrameNavigationEntries with the same ISN and unique name to
  // have different URLs.
  //
  // We also ensure that entries with an item sequence number of 0 (the default
  // value) cannot be stored or retrieved, since they may not represent the same
  // document. This may happen for entries restored without all available state,
  // and we can skip FrameNavigationEntry sharing for them because they are not
  // considered same-document anyway.
  class Key {
   public:
    Key(int64_t isn, const std::string& name, const GURL& entry_url)
        : item_sequence_number_(isn), unique_name_(name), url_(entry_url) {}

    // Avoid copying of the Key as it contains strings.
    Key(const Key&) = delete;
    Key& operator=(const Key&) = delete;
    Key(Key&& other) = default;
    Key& operator=(Key&& other) = default;

    struct Compare {
      bool operator()(const Key& x, const Key& y) const;
    };

   private:
    // These values are non-const so that the Key is movable. They should
    // otherwise never change.
    int64_t item_sequence_number_;
    std::string unique_name_;
    GURL url_;
  };
  std::map<Key, raw_ptr<FrameNavigationEntry, CtnExperimental>, Key::Compare>
      entries_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_ENTRY_RESTORE_CONTEXT_IMPL_H_