Add ErrorUtils::FormatErrorMessage() syntax to ExtensionFunction::Error().

extensions/browser/extension_function.h

 // Copyright 2013 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 EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_
 #define EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_
 
 #include <list>
 #include <string>
 
@@ skipping 127 matching lines @@
   typedef scoped_ptr<ResponseActionObject> ResponseAction;
 
   // Runs the function and returns the action to take when the caller is ready
   // to respond.
   //
   // Typical return values might be:
   //   * RespondNow(NoArguments())
   //   * RespondNow(OneArgument(42))
   //   * RespondNow(ArgumentList(my_result.ToValue()))
   //   * RespondNow(Error("Warp core breach"))
+  //   * RespondNow(Error("Warp core breach on *", GetURL()))
   //   * RespondLater(), then later,
   //     * Respond(NoArguments())
   //     * ... etc.
   //
   //
   // Callers must call Execute() on the return ResponseAction at some point,
   // exactly once.
   //
   // SyncExtensionFunction and AsyncExtensionFunction implement this in terms
   // of SyncExtensionFunction::RunSync and AsyncExtensionFunction::RunAsync,
@@ skipping 99 matching lines @@
   // the argument to this by hand. Note that use of this function may imply you
   // should be using the generated Result struct and ArgumentList.
   ResponseValue TwoArguments(base::Value* arg1, base::Value* arg2);
   // Success, a list of arguments |results| to pass to caller. TAKES OWNERSHIP
   // --
   // a scoped_ptr<> for convenience, since callers usually get this from the
   // result of a ToValue() call on the generated Result struct.
   ResponseValue ArgumentList(scoped_ptr<base::ListValue> results);
   // Error. chrome.runtime.lastError.message will be set to |error|.
   ResponseValue Error(const std::string& error);
+  // Error with formatting. Args are processed using
+  // ErrorUtils::FormatErrorMessage, that is, each occurence of * is replaced
+  // by the corresponding |s*|:
+  // Error("Error in *: *", "foo", "bar") <--> // Error("Error in foo: bar").
+  ResponseValue Error(const std::string& format, const std::string& s1);
+  ResponseValue Error(const std::string& format,
+                      const std::string& s1,
+                      const std::string& s2);
+  ResponseValue Error(const std::string& format,
+                      const std::string& s1,
+                      const std::string& s2,
+                      const std::string& s3);
   // Bad message. A ResponseValue equivalent to EXTENSION_FUNCTION_VALIDATE().
   ResponseValue BadMessage();
 
   // ResponseActions.
   //
   // Respond to the extension immediately with |result|.
   ResponseAction RespondNow(ResponseValue result);
   // Don't respond now, but promise to call Respond() later.
   ResponseAction RespondLater();
 
@@ skipping 290 matching lines @@
   virtual bool RunSync() = 0;
 
   // ValidationFailure override to match RunSync().
   static bool ValidationFailure(SyncIOThreadExtensionFunction* function);
 
  private:
   virtual ResponseAction Run() OVERRIDE;
 };
 
 #endif  // EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_