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

Unified Diff: chrome/browser/extensions/extension_settings_api.h

Issue 7189029: Implement an initial extension settings API. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk
Patch Set: Change where extension settings are saved, update TODO, api test Created 9 years, 6 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/extension_settings_api.h
diff --git a/chrome/browser/extensions/extension_settings_api.h b/chrome/browser/extensions/extension_settings_api.h
new file mode 100644
index 0000000000000000000000000000000000000000..690ab49133b9a09b05893070c761e3f43087a7b9
--- /dev/null
+++ b/chrome/browser/extensions/extension_settings_api.h
@@ -0,0 +1,92 @@
+// Copyright (c) 2011 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_EXTENSION_SETTINGS_API_H_
+#define CHROME_BROWSER_EXTENSIONS_EXTENSION_SETTINGS_API_H_
+#pragma once
+
+#include "chrome/browser/extensions/extension_function.h"
+#include "chrome/browser/extensions/extension_settings.h"
+#include "chrome/browser/extensions/extension_settings_storage.h"
+
+// Superclass of all settings functions.
+class SettingsFunction : public AsyncExtensionFunction {
+ public:
+ virtual ~SettingsFunction() {}
+
+ // Extension settings function implementations should do their work here, and
+ // either run a StorageResultCallback or fill the function result / call
+ // SendResponse themselves.
+ // The exception is that implementations can return false to immediately
+ // call SendResponse(false) -- this is so that the extensions macros work.
Mihai Parparita -not on Chrome 2011/06/21 23:40:11 Not sure what "macros" refers to here.
not at google - send to devlin 2011/06/22 09:40:38 Oh like EXTENSION_FUNCTION_VALIDATE.
+ virtual bool RunWithStorage(ExtensionSettingsStorage* storage) = 0;
+
+ bool RunImpl();
+
+ protected:
+ // GetStorage() callback to run the given ExtensionFunction's RunWithStorage.
+ // Declared here to access to the protected members of ExtensionFunction.
+ class GetStorageCallback : public ExtensionSettings::Callback {
+ public:
+ explicit GetStorageCallback(SettingsFunction* settings_function);
+ ~GetStorageCallback();
+ void Run(ExtensionSettingsStorage* storage);
+
+ private:
+ scoped_refptr<SettingsFunction> settings_function_;
+ };
+
+ // Callback from all storage methods (Get/Set/Remove/Clear) which sets the
+ // appropriate fields of the extension function (result/error) and sends a
+ // response.
+ // Declared here to access to the protected members of ExtensionFunction.
+ class StorageResultCallback : public ExtensionSettingsStorage::Callback {
+ public:
+ explicit StorageResultCallback(SettingsFunction* settings_function);
+ ~StorageResultCallback();
+ void OnSuccess(DictionaryValue* settings);
+ void OnFailure(const std::string& message);
+
+ private:
+ scoped_refptr<SettingsFunction> settings_function_;
+ };
+};
+
+class GetSettingsFunction : public SettingsFunction {
+ public:
+ DECLARE_EXTENSION_FUNCTION_NAME("experimental.settings.get");
+
+ protected:
+ bool RunWithStorage(ExtensionSettingsStorage* storage);
+ std::string Thing();
Mihai Parparita -not on Chrome 2011/06/21 23:40:11 I don't think you need any of the Thing() methods.
not at google - send to devlin 2011/06/22 09:40:38 Oops. Debugging cleanup fail.
+};
+
+class SetSettingsFunction : public SettingsFunction {
+ public:
+ DECLARE_EXTENSION_FUNCTION_NAME("experimental.settings.set");
+
+ protected:
+ bool RunWithStorage(ExtensionSettingsStorage* storage);
+ std::string Thing();
+};
+
+class RemoveSettingsFunction : public SettingsFunction {
+ public:
+ DECLARE_EXTENSION_FUNCTION_NAME("experimental.settings.remove");
+
+ protected:
+ bool RunWithStorage(ExtensionSettingsStorage* storage);
+ std::string Thing();
+};
+
+class ClearSettingsFunction : public SettingsFunction {
+ public:
+ DECLARE_EXTENSION_FUNCTION_NAME("experimental.settings.clear");
+
+ protected:
+ bool RunWithStorage(ExtensionSettingsStorage* storage);
+ std::string Thing();
+};
+
+#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_SETTINGS_API_H_

Powered by Google App Engine
This is Rietveld 408576698