Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1013)

Unified Diff: chrome/browser/extensions/api/declarative/rules_registry.h

Issue 9315010: RulesRegistry for declarative APIs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: chrome/browser/extensions/api/declarative/rules_registry.h
diff --git a/chrome/browser/extensions/api/declarative/rules_registry.h b/chrome/browser/extensions/api/declarative/rules_registry.h
new file mode 100644
index 0000000000000000000000000000000000000000..9c50727cf555f3b4063de0755a1bc51331b39546
--- /dev/null
+++ b/chrome/browser/extensions/api/declarative/rules_registry.h
@@ -0,0 +1,72 @@
+// 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>
+
+#include "base/callback_forward.h"
+#include "base/values.h"
+
+namespace extensions {
+
+// Interface for rule registries.
+class RulesRegistry {
+ public:
+ typedef base::Callback<void(const std::string&)> SetErrorCallback;
+
+ 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.
+ // |set_error_callback| can be called to relay an error message.
+ //
+ // Returns true if the function is successful.
+ //
+ // IMPORTANT: This function is atomic. Either all rules that are deemed
+ // relevant are added or none.
+ virtual bool AddRules(const std::string& extension_id,
+ const std::vector<DictionaryValue*>& rules,
+ SetErrorCallback set_error_callback) = 0;
+
+ // Unregisters all rules listed in |rule_identifiers| and owned by
+ // |extension_id| from this RulesRegistry. If |rule_identifiers| is empty, all
+ // rules of this extension will be unregistered.
+ // Some or all IDs in |rule_identifiers| may not affect this RulesRegistry.
+ // |set_error_callback| can be called to relay an error message.
+ //
+ // Returns true if the function is successful.
+ //
+ // IMPORTANT: This function is atomic. Either all rules that are deemed
+ // relevant are removed or none.
+ virtual bool RemoveRules(const std::string& extension_id,
+ const std::vector<std::string>& rule_identifiers,
+ SetErrorCallback set_error_callback) = 0;
+
+ // Returns all rules listed in |rule_identifiers| and owned by |extension_id|
+ // registered in this RuleRegistry. If |rule_identifiers| is empty, all rules
+ // of |extension_id| are returned.
+ // The returned rules are stored in |out|. Ownership is passed to the caller.
+ virtual void GetRules(const std::string& extension_id,
+ const std::vector<std::string>& rule_identifiers,
+ std::vector<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__

Powered by Google App Engine
This is Rietveld 408576698