File: options_page_info.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 (91 lines) | stat: -rw-r--r-- 3,053 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
81
82
83
84
85
86
87
88
89
90
91
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_COMMON_MANIFEST_HANDLERS_OPTIONS_PAGE_INFO_H_
#define EXTENSIONS_COMMON_MANIFEST_HANDLERS_OPTIONS_PAGE_INFO_H_

#include <string>
#include <vector>

#include "base/values.h"
#include "extensions/common/extension.h"
#include "extensions/common/manifest_handler.h"
#include "url/gurl.h"

namespace base {
class Value;
}

namespace extensions {

// A class to provide options page configuration settings from the manifest.
class OptionsPageInfo : public Extension::ManifestData {
 public:
  OptionsPageInfo(const GURL& options_page,
                  bool chrome_styles,
                  bool open_in_tab);

  OptionsPageInfo(const OptionsPageInfo&) = delete;
  OptionsPageInfo& operator=(const OptionsPageInfo&) = delete;

  ~OptionsPageInfo() override;

  // Returns the URL to the given extension's options page. This method supports
  // both the "options_ui.page" field and the legacy "options_page" field. If
  // both are present, it will return the value of "options_ui.page".
  static const GURL& GetOptionsPage(const Extension* extension);

  // Returns true if the given extension has an options page. An extension has
  // an options page if one or both of "options_ui.page" and "options_page"
  // specify a valid options page.
  static bool HasOptionsPage(const Extension* extension);

  // Returns whether the Chrome user agent stylesheet should be applied to the
  // given extension's options page.
  static bool ShouldUseChromeStyle(const Extension* extension);

  // Returns whether the given extension's options page should be opened in a
  // new tab instead of an embedded popup.
  static bool ShouldOpenInTab(const Extension* extension);

  static std::unique_ptr<OptionsPageInfo> Create(
      Extension* extension,
      const base::Value::Dict* options_ui_dict,
      const std::string& options_page_string,
      std::vector<InstallWarning>* install_warnings,
      std::u16string* error);

 private:
  // The URL to the options page of this extension. We only store one options
  // URL, either options_page or options_ui.page. options_ui.page is preferred
  // if both are present.
  GURL options_page_;

  bool chrome_styles_;

  bool open_in_tab_;
};

// Parses the "options_ui" manifest key and the legacy "options_page" key.
class OptionsPageHandler : public ManifestHandler {
 public:
  OptionsPageHandler();

  OptionsPageHandler(const OptionsPageHandler&) = delete;
  OptionsPageHandler& operator=(const OptionsPageHandler&) = delete;

  ~OptionsPageHandler() override;

  bool Parse(Extension* extension, std::u16string* error) override;
  bool Validate(const Extension& extension,
                std::string* error,
                std::vector<InstallWarning>* warnings) const override;

 private:
  base::span<const char* const> Keys() const override;
};

}  // namespace extensions

#endif  // EXTENSIONS_COMMON_MANIFEST_HANDLERS_OPTIONS_PAGE_INFO_H_