src/chrome/browser/extensions/extension_error_reporter.h

   1 // Copyright (c) 2011 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_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_
   6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/strings/string16.h"
  12
  13 namespace base {
  14 class MessageLoop;
  15 }
  16
  17 // Exposes an easy way for the various components of the extension system to
  18 // report errors. This is a singleton that lives on the UI thread, with the
  19 // exception of ReportError() which may be called from any thread.
  20 // TODO(aa): Hook this up to about:extensions, when we have about:extensions.
  21 // TODO(aa): Consider exposing directly, or via a helper, to the renderer
  22 // process and plumbing the errors out to the browser.
  23 // TODO(aa): Add ReportError(extension_id, message, be_noisy), so that we can
  24 // report errors that are specific to a particular extension.
  25 class ExtensionErrorReporter {
  26  public:
  27   // Initializes the error reporter. Must be called before any other methods
  28   // and on the UI thread.
  29   static void Init(bool enable_noisy_errors);
  30
  31   // Get the singleton instance.
  32   static ExtensionErrorReporter* GetInstance();
  33
  34   // Report an error. Errors always go to VLOG(1). Optionally, they can also
  35   // cause a noisy alert box. This method can be called from any thread.
  36   void ReportError(const string16& message, bool be_noisy);
  37
  38   // Get the errors that have been reported so far.
  39   const std::vector<string16>* GetErrors();
  40
  41   // Clear the list of errors reported so far.
  42   void ClearErrors();
  43
  44  private:
  45   static ExtensionErrorReporter* instance_;
  46
  47   explicit ExtensionErrorReporter(bool enable_noisy_errors);
  48   ~ExtensionErrorReporter();
  49
  50   base::MessageLoop* ui_loop_;
  51   std::vector<string16> errors_;
  52   bool enable_noisy_errors_;
  53 };
  54
  55 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_