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
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_CHROME_EXTENSION_FUNCTION_H_
#define CHROME_BROWSER_EXTENSIONS_CHROME_EXTENSION_FUNCTION_H_
#include "extensions/browser/extension_function.h"
class Browser;
class Profile;
namespace content {
class WebContents;
}
namespace extensions {
class WindowController;
}
// A chrome specific analog to AsyncExtensionFunction. This has access to a
// chrome Profile.
//
// DEPRECATED: Please consider inherting UIThreadExtensionFunction directly.
// Then if you need access to Chrome details, you can construct a
// ChromeExtensionFunctionDetails object within your function implementation.
class ChromeUIThreadExtensionFunction : public UIThreadExtensionFunction {
public:
ChromeUIThreadExtensionFunction();
Profile* GetProfile() const;
// Returns true if this function (and the profile and extension that it was
// invoked from) can operate on the window wrapped by |window_controller|.
bool CanOperateOnWindow(const extensions::WindowController* window_controller)
const;
// Gets the "current" browser, if any.
//
// Many extension APIs operate relative to the current browser, which is the
// browser the calling code is running inside of. For example, popups, tabs,
// and infobars all have a containing browser, but background pages and
// notification bubbles do not.
//
// If there is no containing window, the current browser defaults to the
// foremost one.
//
// Incognito browsers are not considered unless the calling extension has
// incognito access enabled.
//
// This method can return NULL if there is no matching browser, which can
// happen if only incognito windows are open, or early in startup or shutdown
// shutdown when there are no active windows.
//
// TODO(stevenjb): Replace this with GetExtensionWindowController().
Browser* GetCurrentBrowser();
// Same as above but uses WindowControllerList instead of BrowserList.
extensions::WindowController* GetExtensionWindowController();
// Gets the "current" web contents if any. If there is no associated web
// contents then defaults to the foremost one.
content::WebContents* GetAssociatedWebContents() override;
protected:
~ChromeUIThreadExtensionFunction() override;
};
// A chrome specific analog to AsyncExtensionFunction. This has access to a
// chrome Profile.
//
// DEPRECATED: Please consider inherting UIThreadExtensionFunction or
// AsyncExtensionFunction directly. Then if you need access to Chrome details,
// you can construct a ChromeExtensionFunctionDetails object within your
// function implementation.
class ChromeAsyncExtensionFunction : public ChromeUIThreadExtensionFunction {
public:
ChromeAsyncExtensionFunction();
protected:
~ChromeAsyncExtensionFunction() override;
// Deprecated, see AsyncExtensionFunction::RunAsync.
virtual bool RunAsync() = 0;
// ValidationFailure override to match RunAsync().
static bool ValidationFailure(ChromeAsyncExtensionFunction* function);
private:
ResponseAction Run() override;
};
// A chrome specific analog to SyncExtensionFunction. This has access to a
// chrome Profile.
//
// DEPRECATED: Please consider inherting UIThreadExtensionFunction or
// SyncExtensionFunction directly. Then if you need access to Chrome details,
// you can construct a ChromeExtensionFunctionDetails object within your
// function implementation.
class ChromeSyncExtensionFunction : public ChromeUIThreadExtensionFunction {
public:
ChromeSyncExtensionFunction();
protected:
~ChromeSyncExtensionFunction() override;
// Deprecated, see SyncExtensionFunction::RunSync.
virtual bool RunSync() = 0;
// ValidationFailure override to match RunSync().
static bool ValidationFailure(ChromeSyncExtensionFunction* function);
private:
ResponseAction Run() override;
};
#endif // CHROME_BROWSER_EXTENSIONS_CHROME_EXTENSION_FUNCTION_H_
|