summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/parent/ext-omnibox.js
blob: 7348af64396de4d710bdfec461584780fd588744 (plain)
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

ChromeUtils.defineModuleGetter(
  this,
  "ExtensionSearchHandler",
  "resource://gre/modules/ExtensionSearchHandler.jsm"
);

this.omnibox = class extends ExtensionAPI {
  onManifestEntry(entryName) {
    let { extension } = this;
    let { manifest } = extension;

    let keyword = manifest.omnibox.keyword;
    try {
      // This will throw if the keyword is already registered.
      ExtensionSearchHandler.registerKeyword(keyword, extension);
      this.keyword = keyword;
    } catch (e) {
      extension.manifestError(e.message);
    }
  }

  onShutdown() {
    ExtensionSearchHandler.unregisterKeyword(this.keyword);
  }

  getAPI(context) {
    let { extension } = context;
    return {
      omnibox: {
        setDefaultSuggestion: suggestion => {
          try {
            // This will throw if the keyword failed to register.
            ExtensionSearchHandler.setDefaultSuggestion(
              this.keyword,
              suggestion
            );
          } catch (e) {
            return Promise.reject(e.message);
          }
        },

        onInputStarted: new EventManager({
          context,
          name: "omnibox.onInputStarted",
          register: fire => {
            let listener = eventName => {
              fire.sync();
            };
            extension.on(ExtensionSearchHandler.MSG_INPUT_STARTED, listener);
            return () => {
              extension.off(ExtensionSearchHandler.MSG_INPUT_STARTED, listener);
            };
          },
        }).api(),

        onInputCancelled: new EventManager({
          context,
          name: "omnibox.onInputCancelled",
          register: fire => {
            let listener = eventName => {
              fire.sync();
            };
            extension.on(ExtensionSearchHandler.MSG_INPUT_CANCELLED, listener);
            return () => {
              extension.off(
                ExtensionSearchHandler.MSG_INPUT_CANCELLED,
                listener
              );
            };
          },
        }).api(),

        onInputEntered: new EventManager({
          context,
          name: "omnibox.onInputEntered",
          register: fire => {
            let listener = (eventName, text, disposition) => {
              fire.sync(text, disposition);
            };
            extension.on(ExtensionSearchHandler.MSG_INPUT_ENTERED, listener);
            return () => {
              extension.off(ExtensionSearchHandler.MSG_INPUT_ENTERED, listener);
            };
          },
        }).api(),

        // Internal APIs.
        addSuggestions: (id, suggestions) => {
          try {
            ExtensionSearchHandler.addSuggestions(
              this.keyword,
              id,
              suggestions
            );
          } catch (e) {
            // Silently fail because the extension developer can not know for sure if the user
            // has already invalidated the callback when asynchronously providing suggestions.
          }
        },

        onInputChanged: new EventManager({
          context,
          name: "omnibox.onInputChanged",
          register: fire => {
            let listener = (eventName, text, id) => {
              fire.sync(text, id);
            };
            extension.on(ExtensionSearchHandler.MSG_INPUT_CHANGED, listener);
            return () => {
              extension.off(ExtensionSearchHandler.MSG_INPUT_CHANGED, listener);
            };
          },
        }).api(),
      },
    };
  }
};