Componentize spellcheck [4]: spellcheck/browser and android java-side.

chrome/browser/spellchecker/spelling_service_client.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_SPELLCHECKER_SPELLING_SERVICE_CLIENT_H_
-#define CHROME_BROWSER_SPELLCHECKER_SPELLING_SERVICE_CLIENT_H_
-
-#include <map>
-#include <memory>
-#include <string>
-#include <vector>
-
-#include "base/callback.h"
-#include "base/compiler_specific.h"
-#include "base/strings/string16.h"
-#include "net/url_request/url_fetcher_delegate.h"
-
-class GURL;
-class TextCheckClientDelegate;
-struct SpellCheckResult;
-
-namespace content {
-class BrowserContext;
-}
-
-namespace net {
-class URLFetcher;
-}  // namespace net
-
-// A class that encapsulates a JSON-RPC call to the Spelling service to check
-// text there. This class creates a JSON-RPC request, sends the request to the
-// service with URLFetcher, parses a response from the service, and calls a
-// provided callback method. When a user deletes this object before it finishes
-// a JSON-RPC call, this class cancels the JSON-RPC call without calling the
-// callback method. A simple usage is creating a SpellingServiceClient and
-// calling its RequestTextCheck method as listed in the following snippet.
-//
-//   class MyClient {
-//    public:
-//     MyClient();
-//     virtual ~MyClient();
-//
-//     void OnTextCheckComplete(
-//         int tag,
-//         bool success,
-//         const std::vector<SpellCheckResult>& results) {
-//       ...
-//     }
-//
-//     void MyTextCheck(BrowserContext* context, const base::string16& text) {
-//        client_.reset(new SpellingServiceClient);
-//        client_->RequestTextCheck(context, 0, text,
-//            base::Bind(&MyClient::OnTextCheckComplete,
-//                       base::Unretained(this));
-//     }
-//    private:
-//     std::unique_ptr<SpellingServiceClient> client_;
-//   };
-//
-class SpellingServiceClient : public net::URLFetcherDelegate {
- public:
-  // Service types provided by the Spelling service. The Spelling service
-  // consists of a couple of backends:
-  // * SUGGEST: Retrieving suggestions for a word (used by Google Search), and;
-  // * SPELLCHECK: Spellchecking text (used by Google Docs).
-  // This type is used for choosing a backend when sending a JSON-RPC request to
-  // the service.
-  enum ServiceType {
-    SUGGEST = 1,
-    SPELLCHECK = 2,
-  };
-  typedef base::Callback<void(
-      bool /* success */,
-      const base::string16& /* text */,
-      const std::vector<SpellCheckResult>& /* results */)>
-          TextCheckCompleteCallback;
-
-  SpellingServiceClient();
-  ~SpellingServiceClient() override;
-
-  // Sends a text-check request to the Spelling service. When we send a request
-  // to the Spelling service successfully, this function returns true. (This
-  // does not mean the service finishes checking text successfully.) We will
-  // call |callback| when we receive a text-check response from the service.
-  bool RequestTextCheck(content::BrowserContext* context,
-                        ServiceType type,
-                        const base::string16& text,
-                        const TextCheckCompleteCallback& callback);
-
-  // Returns whether the specified service is available for the given context.
-  static bool IsAvailable(content::BrowserContext* context, ServiceType type);
-
- protected:
-  // Parses a JSON-RPC response from the Spelling service.
-  bool ParseResponse(const std::string& data,
-                     std::vector<SpellCheckResult>* results);
-
- private:
-  struct TextCheckCallbackData {
-    TextCheckCallbackData(TextCheckCompleteCallback callback,
-                          base::string16 text);
-    ~TextCheckCallbackData();
-
-    // The callback function to be called when we receive a response from the
-    // Spelling service and parse it.
-    TextCheckCompleteCallback callback;
-
-    // The text checked by the Spelling service.
-    base::string16 text;
-  };
-
-  // net::URLFetcherDelegate implementation.
-  void OnURLFetchComplete(const net::URLFetcher* source) override;
-
-  // Creates a URLFetcher object used for sending a JSON-RPC request. This
-  // function is overridden by unit tests to prevent them from actually sending
-  // requests to the Spelling service.
-  virtual std::unique_ptr<net::URLFetcher> CreateURLFetcher(const GURL& url);
-
-  // The URLFetcher object used for sending a JSON-RPC request.
-  std::map<const net::URLFetcher*, TextCheckCallbackData*> spellcheck_fetchers_;
-};
-
-#endif  // CHROME_BROWSER_SPELLCHECKER_SPELLING_SERVICE_CLIENT_H_