File: system_hotkey_map.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (69 lines) | stat: -rw-r--r-- 2,449 bytes parent folder | download | duplicates (9)
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
// 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 CONTENT_BROWSER_COCOA_SYSTEM_HOTKEY_MAP_H_
#define CONTENT_BROWSER_COCOA_SYSTEM_HOTKEY_MAP_H_

#import <Cocoa/Cocoa.h>

#include <vector>

#include "base/gtest_prod_util.h"
#include "content/common/content_export.h"

namespace content {

struct SystemHotkey;

// Maintains a listing of all macOS system hotkeys (e.g. cmd+`). These hotkeys
// should have higher priority than web content, so NSEvents that correspond to
// a system hotkey should not be passed to the renderer.
class CONTENT_EXPORT SystemHotkeyMap {
 public:
  SystemHotkeyMap();
  SystemHotkeyMap(SystemHotkeyMap&&);

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

  ~SystemHotkeyMap();

  // Parses the property list data commonly stored at
  // ~/Library/Preferences/com.apple.symbolichotkeys.plist
  // Returns false on encountering an irrecoverable error.
  // Can be called multiple times. Only the results from the most recent
  // invocation are stored.
  bool ParseDictionary(NSDictionary* dictionary);

  // Whether the event corresponds to a hotkey that has been reserved by the
  // system.
  bool IsEventReserved(NSEvent* event) const;

 private:
  FRIEND_TEST_ALL_PREFIXES(SystemHotkeyMapTest, Parse);
  FRIEND_TEST_ALL_PREFIXES(SystemHotkeyMapTest, ParseCustomEntries);
  FRIEND_TEST_ALL_PREFIXES(SystemHotkeyMapTest, ParseMouse);
  FRIEND_TEST_ALL_PREFIXES(SystemHotkeyMapTest,
                           ReverseWindowCyclingHotkeyExists);
  FRIEND_TEST_ALL_PREFIXES(SystemHotkeyMapTest,
                           IgnoreUndocumentedShortcutEntries);

  // Whether the hotkey has been reserved by the user.
  bool IsHotkeyReserved(unsigned short key_code, NSUInteger modifiers) const;

  // Creates at least one record of a hotkey that is reserved by the user.
  // Certain system hotkeys automatically reserve multiple key combinations.
  void ReserveHotkey(unsigned short key_code,
                     NSUInteger modifiers,
                     NSString* system_hotkey_identifier);

  // Create a record of a hotkey that is reserved by the user.
  void ReserveHotkey(unsigned short key_code, NSUInteger modifiers);

  std::vector<SystemHotkey> system_hotkeys_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_COCOA_SYSTEM_HOTKEY_MAP_H_