File: pdf_extension_test_util.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 (107 lines) | stat: -rw-r--r-- 4,078 bytes parent folder | download | duplicates (6)
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
100
101
102
103
104
105
106
107
// Copyright 2015 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_PDF_PDF_EXTENSION_TEST_UTIL_H_
#define CHROME_BROWSER_PDF_PDF_EXTENSION_TEST_UTIL_H_

#include <stddef.h>

#include <vector>

#include "testing/gtest/include/gtest/gtest.h"

class Browser;

namespace content {
class RenderFrameHost;
class ToRenderFrameHost;
class WebContents;
}  // namespace content

namespace extensions {
class MimeHandlerViewGuest;
}  // namespace extensions

namespace gfx {
class Point;
}  // namespace gfx

namespace pdf_extension_test_util {

// Options for customizing behavior in `EnsurePDFHasLoadedWithOptions()`.
struct EnsurePDFHasLoadedOptions {
  // // Whether to wait for hit test data or not after the PDF successfully
  // loads.
  bool wait_for_hit_test_data = true;
  // The tag name of the PDF embedder element.
  std::string pdf_element = "embed";
  // True if the PDF embedder frame should be allowed to have multiple
  // subframes, false otherwise. This can occur if extensions append subframes
  // to the PDF embedder.
  bool allow_multiple_frames = false;
};

// Gets the PDF extension host that is the first child of `embedder_host`.
// If multiple frames aren't allowed and there is more than one child frame,
// returns nullptr.
content::RenderFrameHost* GetPdfExtensionHostFromEmbedder(
    content::RenderFrameHost* embedder_host,
    bool allow_multiple_frames);

// Gets the PDF extension host for a given `WebContents`. There should only be
// one extension host in `contents`, otherwise returns nullptr.
content::RenderFrameHost* GetOnlyPdfExtensionHost(
    content::WebContents* contents);

// Gets all the PDF extension hosts for a given `WebContents`.
std::vector<content::RenderFrameHost*> GetPdfExtensionHosts(
    content::WebContents* contents);

// Gets the PDF plugin frame for a given `WebContents`. There should only be
// one plugin frame in `contents`, otherwise returns nullptr.
content::RenderFrameHost* GetOnlyPdfPluginFrame(content::WebContents* contents);

// Gets all the PDF plugin frames for a given `WebContents`.
std::vector<content::RenderFrameHost*> GetPdfPluginFrames(
    content::WebContents* contents);

// Counts the total number of unique PDF plugin processes.
size_t CountPdfPluginProcesses(const Browser* browser);

// Ensures, inside the given `frame`, that a PDF has either finished
// loading or prompted a password. The result indicates success if the PDF loads
// successfully, otherwise it indicates failure. If it doesn't finish loading,
// the test will hang. The test will fail if the PDF embedder host has multiple
// subframes.
//
// In order to ensure an OOPIF PDF has loaded, `frame` must be an embedder host,
// and the extension host must have already been created.
//
// Waits for hit test data if the PDF successfully loads so that tests that
// attempt to send mouse/pointer events have the necessary hit test data.
[[nodiscard]] testing::AssertionResult EnsurePDFHasLoaded(
    const content::ToRenderFrameHost& frame);
// Same as `EnsurePDFHasLoaded()`, but uses `EnsurePDFHasLoadedOptions` to
// customize behavior.
[[nodiscard]] testing::AssertionResult EnsurePDFHasLoadedWithOptions(
    const content::ToRenderFrameHost& frame,
    const EnsurePDFHasLoadedOptions& options);

gfx::Point ConvertPageCoordToScreenCoord(
    content::ToRenderFrameHost guest_main_frame,
    const gfx::Point& point);

// Synchronously sets the input focus on the plugin frame by clicking on the
// top-left corner of a PDF document.
void SetInputFocusOnPlugin(content::RenderFrameHost* extension_host,
                           content::WebContents* embedder_web_contents);

// Returns the `MimeHandlerViewGuest` embedded in `embedder_contents`. If more
// than one `MimeHandlerViewGuest` is found, the test fails.
extensions::MimeHandlerViewGuest* GetOnlyMimeHandlerView(
    content::WebContents* embedder_contents);

}  // namespace pdf_extension_test_util

#endif  // CHROME_BROWSER_PDF_PDF_EXTENSION_TEST_UTIL_H_