chrome/common/extensions/api/commands/commands_handler.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_COMMON_EXTENSIONS_API_COMMANDS_COMMANDS_HANDLER_H_
   6 #define CHROME_COMMON_EXTENSIONS_API_COMMANDS_COMMANDS_HANDLER_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "chrome/common/extensions/command.h"
  12 #include "extensions/common/extension.h"
  13 #include "extensions/common/manifest.h"
  14 #include "extensions/common/manifest_handler.h"
  15
  16 namespace extensions {
  17
  18 struct CommandsInfo : public Extension::ManifestData {
  19   CommandsInfo();
  20   virtual ~CommandsInfo();
  21
  22   // Optional list of commands (keyboard shortcuts).
  23   // These commands are the commands which the extension wants to use, which are
  24   // not necessarily the ones it can use, as it might be inactive (see also
  25   // Get*Command[s] in CommandService).
  26   scoped_ptr<Command> browser_action_command;
  27   scoped_ptr<Command> page_action_command;
  28   scoped_ptr<Command> script_badge_command;
  29   CommandMap named_commands;
  30
  31   static const Command* GetBrowserActionCommand(const Extension* extension);
  32   static const Command* GetPageActionCommand(const Extension* extension);
  33   static const Command* GetScriptBadgeCommand(const Extension* extension);
  34   static const CommandMap* GetNamedCommands(const Extension* extension);
  35 };
  36
  37 // Parses the "commands" manifest key.
  38 class CommandsHandler : public ManifestHandler {
  39  public:
  40   CommandsHandler();
  41   virtual ~CommandsHandler();
  42
  43   virtual bool Parse(Extension* extension, base::string16* error) OVERRIDE;
  44   virtual bool AlwaysParseForType(Manifest::Type type) const OVERRIDE;
  45
  46  private:
  47   // If the extension defines a browser action, but no command for it, then
  48   // we synthesize a generic one, so the user can configure a shortcut for it.
  49   // No keyboard shortcut will be assigned to it, until the user selects one.
  50   void MaybeSetBrowserActionDefault(const Extension* extension,
  51                                     CommandsInfo* info);
  52
  53   virtual const std::vector<std::string> Keys() const OVERRIDE;
  54
  55   DISALLOW_COPY_AND_ASSIGN(CommandsHandler);
  56 };
  57
  58 }  // namespace extensions
  59
  60 #endif  // CHROME_COMMON_EXTENSIONS_API_COMMANDS_COMMANDS_HANDLER_H_