RulesRegistry for declarative APIs.

chrome/browser/extensions/api/declarative/initializing_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_INITIALIZING_RULES_REGISTRY_H__
+#define CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_INITIALIZING_RULES_REGISTRY_H__
+#pragma once
+
+#include "chrome/browser/extensions/api/declarative/rules_registry.h"
+
+#include <map>
+#include <set>
+
+#include "base/compiler_specific.h"
+#include "base/memory/scoped_ptr.h"
+
+namespace extensions {
+
+// Wrapper class for RulesRegistry objects that takes care that all optional
+// fields of rules are filled with valid values.
+class InitializingRulesRegistry : public RulesRegistry {
+ public:
+  explicit InitializingRulesRegistry(scoped_ptr<RulesRegistry> delegate);
+  virtual ~InitializingRulesRegistry();
+
+  // Implementation for RulesRegistry:
+  virtual bool AddRules(const std::string& extension_id,
+                        const std::vector<DictionaryValue*>& rules,
+                        std::string* error) OVERRIDE;
+  virtual bool RemoveRules(const std::string& extension_id,
+                           const std::vector<std::string>& rule_identifiers,
+                           std::string* error) OVERRIDE;
+  virtual bool RemoveAllRules(const std::string& extension_id,
+                              std::string* error) OVERRIDE;
+  virtual void GetRules(const std::string& extension_id,
+                        const std::vector<std::string>& rule_identifiers,
+                        std::vector<DictionaryValue*>* out) OVERRIDE;
+  virtual void GetAllRules(const std::string& extension_id,
+                           std::vector<DictionaryValue*>* out) OVERRIDE;
+  virtual void OnExtensionUnloaded(const std::string& extension_id) OVERRIDE;
+
+ private:
+  // Returns whether any existing rule is registered with identifier |rule_id|
+  // for extension |extension_id|.
+  bool IsUniqueId(const std::string& extension_id,
+                  const std::string& rule_id) const;
+
+  // Creates an ID that is unique within the scope of|extension_id|.
+  std::string GenerateUniqueId(std::string extension_id);
+
+  // Verifies that all |rules| have unique IDs or initializes them with
+  // unique IDs if they don't have one. In case of duplicate IDs, this function
+  // fills |error| and returns false.
+  bool CheckAndFillInOptionalRules(
+    const std::string& extension_id,
+    const std::vector<DictionaryValue*>& rules,
+    std::string* error);
+
+  // Initializes the priority fields in case they have not been set.
+  void FillInOptionalPriorities(const std::vector<DictionaryValue*>& rules);
+
+  // Removes all |identifiers| of |extension_id| from |used_rule_identifiers_|.
+  void RemoveUsedRuleIdentifiers(const std::string& extension_id,
+                                 const std::vector<std::string>& identifiers);
+
+  // Same as RemoveUsedRuleIdentifiers but operates on all rules of
+  // |extension_id|.
+  void RemoveAllUsedRuleIdentifiers(const std::string& extension_id);
+
+  scoped_ptr<RulesRegistry> delegate_;
+
+  typedef std::map<std::string, std::set<std::string> > RuleIdentifiersMap;
+  RuleIdentifiersMap used_rule_identifiers_;
+  int last_generated_rule_identifier_id_;
+};
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_INITIALIZING_RULES_REGISTRY_H__