RulesRegistry for declarative APIs.

chrome/browser/extensions/api/declarative/rules_registry.h

+// Copyright (c) 2012 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_API_DECLARATIVE_RULES_REGISTRY_H__
+#define CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_RULES_REGISTRY_H__
+#pragma once
+
+#include <string>
+#include <vector>
+
+namespace base {
+class DictionaryValue;
+}
+
+namespace extensions {
+
+// Interface for rule registries.
+class RulesRegistry {
+ public:
+  virtual ~RulesRegistry() {}
+
+  // Registers |rules|, owned by |extension_id| to this RulesRegistry.
+  // If a concrete RuleRegistry does not support some of the rules,
+  // it may ignore them.
+  //
+  // |rules| is a list of Rule instances following the definition of the
+  // declarative extension APIs. It is guaranteed that each rule in |rules| has
+  // a unique name within the scope of |extension_id| that has not been
+  // registered before, unless it has been removed again.
+  // The ownership of rules remains with the caller.
+  //
+  // Returns an empty string if the function is successful or an error
+  // message otherwise.
+  //
+  // IMPORTANT: This function is atomic. Either all rules that are deemed
+  // relevant are added or none.
+  virtual std::string AddRules(
+      const std::string& extension_id,
+      const std::vector<base::DictionaryValue*>& rules) = 0;
+
+  // Unregisters all rules listed in |rule_identifiers| and owned by
+  // |extension_id| from this RulesRegistry.
+  // Some or all IDs in |rule_identifiers| may not affect this RulesRegistry.
+  //
+  // Returns an empty string if the function is successful or an error
+  // message otherwise.
+  //
+  // IMPORTANT: This function is atomic. Either all rules that are deemed
+  // relevant are removed or none.
+  virtual std::string RemoveRules(
+      const std::string& extension_id,
+      const std::vector<std::string>& rule_identifiers) = 0;
+
+  // Same as RemoveAllRules but acts on all rules owned by |extension_id|.
+  virtual std::string RemoveAllRules(const std::string& extension_id) = 0;
+
+  // Returns all rules listed in |rule_identifiers| and owned by |extension_id|
+  // registered in this RuleRegistry.
+  //
+  // The returned rules are stored in |out|. Ownership is passed to the caller.
+  //
+  // Returns an empty string if the function is successful or an error
+  // message otherwise.
+  virtual std::string GetRules(const std::string& extension_id,
+                               const std::vector<std::string>& rule_identifiers,
+                               std::vector<base::DictionaryValue*>* out) = 0;
+
+  // Same as GetRules but returns all rules owned by |extension_id|.
+  virtual std::string GetAllRules(const std::string& extension_id,
+                                  std::vector<base::DictionaryValue*>* out) = 0;
+
+  // Called to notify the RulesRegistry that an extension has been unloaded
+  // and all rules of this extension need to be removed.
+  virtual void OnExtensionUnloaded(const std::string& extension_id) = 0;
+};
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_RULES_REGISTRY_H__