Implement clipboard for aura and re-enable clipboard_unittests.

ui/base/clipboard/clipboard_aurax11.cc

+// 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.
+
+#include "ui/base/clipboard/clipboard.h"
+
+#include "base/logging.h"
+#include "base/utf_string_conversions.h"
+#include "third_party/skia/include/core/SkBitmap.h"
+#include "ui/gfx/linux_util.h"
+#include "ui/gfx/size.h"
+
+namespace ui {
+
+namespace {
+const char kMimeTypeBitmap[] = "image/bmp";
+const char kMimeTypeWebkitSmartPaste[] = "chromium/x-webkit-paste";
+
+// ClipboardData contains data copied to the Clipboard for a variety of formats.
+// It mostly just provides APIs to cleanly access and manipulate this data.
+class ClipboardData {
+ public:
+  ClipboardData() : bitmap_data_(NULL),
+                    custom_data_data_(NULL),
+                    custom_data_len_(0),
+                    web_smart_paste_(false) { }

[oshima, 2011/10/21 21:32:43]

nit: just {}

[varunjain, 2011/10/24 05:51:53]

Done.

+
+  virtual ~ClipboardData() {
+    // Cleanup bitmap_data_
+    CleanupBitmapData();
+
+    // Cleanup custom format data
+    CleanupDataData();
+  }
+
+  const std::string& text() const { return utf8_text_; }
+

[oshima, 2011/10/21 21:32:43]

I prefer to remove new line to group them together. That's easier to read and
common in chrome (i think).

[varunjain, 2011/10/24 05:51:53]

Done.

+  void set_text(const std::string& text) {
+    utf8_text_ = text;
+  }
+
+  const std::string& markup_data() const { return markup_data_; }
+
+  void set_markup_data(const std::string& markup_data) {
+    markup_data_ = markup_data;
+  }
+
+  const std::string& url() const { return url_; }
+
+  void set_url(const std::string& url) {
+    url_ = url;
+  }
+
+  const std::string& bookmark_title() const { return bookmark_title_; }
+
+  void set_bookmark_title(const std::string& bookmark_title) {
+    bookmark_title_ = bookmark_title;
+  }
+
+  const std::string& bookmark_url() const { return bookmark_url_; }
+
+  void set_bookmark_url(const std::string& bookmark_url) {
+    bookmark_url_ = bookmark_url;
+  }
+
+  uint8_t* bitmap_data() const { return bitmap_data_; }
+
+  void set_bitmap_data(uint8_t* bitmap_data) {
+    CleanupBitmapData();
+    bitmap_data_ = bitmap_data;
+  }
+
+  const gfx::Size bitmap_size() const { return bitmap_size_; }
+
+  void set_bitmap_size(const gfx::Size bitmap_size) {
+    bitmap_size_ = bitmap_size;
+  }
+
+  const std::string& custom_data_format() const { return custom_data_format_; }
+  char* custom_data_data() const { return custom_data_data_; }
+  size_t custom_data_len() const { return custom_data_len_; }
+
+  void SetData(const std::string& data_format,
+               const char* data_data,
+               size_t data_len) {
+    CleanupDataData();
+    custom_data_len_ = data_len;
+    if (custom_data_len_ == 0)
+      return;
+    custom_data_data_ = new char[custom_data_len_];
+    memcpy(custom_data_data_, data_data, custom_data_len_);
+    custom_data_format_ = data_format;
+  }
+
+  bool web_smart_paste() const { return web_smart_paste_; }
+
+  void set_web_smart_paste(bool web_smart_paste) {
+    web_smart_paste_ = web_smart_paste;
+  }
+
+ private:
+  void CleanupBitmapData() {
+    if (bitmap_data_)
+      free(bitmap_data_); // bitmap_data_ is allocated using malloc.
+    bitmap_data_ = NULL;
+  }
+
+  void CleanupDataData() {
+    if (custom_data_data_)
+      delete[] custom_data_data_;
+    custom_data_data_ = NULL;
+  }
+
+  // Plain text
+  std::string utf8_text_;
+
+  // HTML
+  std::string markup_data_;
+  std::string url_;
+
+  // Bookmarks
+  std::string bookmark_title_;

[oshima, 2011/10/21 21:32:43]

utf8_

or just use text_ for text() and document somewhere.

[varunjain, 2011/10/24 05:51:53]

I am not sure I understand. are you suggesting to reuse the utf8_text_ field? ht
clipboard should be able to hold both text and bookmarks independently.

[oshima, 2011/10/24 23:31:26]

If you use utf8_ for text, then use it for other utf8 strings. Alternatively,
you can document which one is utf8 and which one is not.

[varunjain, 2011/10/25 21:04:40]

Done.

+  std::string bookmark_url_;
+
+  // Bitmap images
+  uint8_t* bitmap_data_;

[oshima, 2011/10/21 21:32:43]

you can use scoped_generic_obj and remove CleanupBitmapData.

[varunjain, 2011/10/24 05:51:53]

actually I can just do scoped_ptr_malloc

+  gfx::Size bitmap_size_;
+
+  // Data with custom format
+  std::string custom_data_format_;
+  char* custom_data_data_;

[oshima, 2011/10/21 21:32:43]

scoped_ptr

[varunjain, 2011/10/24 05:51:53]

Done. but with scoped_array

[oshima, 2011/10/24 23:31:26]

yes, scoped_array

+  size_t custom_data_len_;
+
+  // WebKit smart paste data
+  bool web_smart_paste_;
+
+  DISALLOW_COPY_AND_ASSIGN(ClipboardData);
+};
+
+ClipboardData* clipboard_data = NULL;
+
+ClipboardData* GetClipboardData() {
+  if (!clipboard_data)
+    clipboard_data = new ClipboardData();
+  return clipboard_data;
+}
+
+void DeleteClipboardData() {
+  if (clipboard_data)
+    delete clipboard_data;
+  clipboard_data = NULL;
+}
+
+}  // namespace
+
+// TODO(varunjain): Complete implementation:
+// 1. Handle different types of BUFFERs.
+// 2. Do we need to care about concurrency here? Can there be multiple instances
+//    of ui::Clipboard? Ask oshima.
+// 3. Implement File types.
+// 4. Handle conversion between types.
+
+Clipboard::Clipboard() {
+  // Make sure clipboard is created.
+  GetClipboardData();
+}
+
+Clipboard::~Clipboard() {
+}
+
+void Clipboard::WriteObjects(const ObjectMap& objects) {
+  // We need to overwrite previous data. Probably best to just delete
+  // everything and start fresh.
+  DeleteClipboardData();
+  for (ObjectMap::const_iterator iter = objects.begin();
+       iter != objects.end(); ++iter) {
+    DispatchObject(static_cast<ObjectType>(iter->first), iter->second);
+  }
+}
+
+
+void Clipboard::WriteObjects(const ObjectMap& objects,
+                             base::ProcessHandle process) {
+  NOTIMPLEMENTED();
+}
+
+void Clipboard::DidWriteURL(const std::string& utf8_text) {
+  // This function seems GTK specific. We probably dont care.
+}

[oshima, 2011/10/21 21:32:43]

can we exclude this for AURA?

[varunjain, 2011/10/24 05:51:53]

Done.

+
+bool Clipboard::IsFormatAvailable(const FormatType& format,
+                                  Buffer buffer) const {
+  ClipboardData* data = GetClipboardData();
+  if (GetPlainTextFormatType() == format)
+    return !data->text().empty();
+  else if (GetHtmlFormatType() == format)
+    return !data->markup_data().empty() || !data->url().empty();
+  else if (GetBitmapFormatType() == format)
+    return data->bitmap_data();
+  else if (GetWebKitSmartPasteFormatType() == format)
+    return data->web_smart_paste();
+  else if (data->custom_data_format() == format)
+    return true;
+  return false;
+}
+
+bool Clipboard::IsFormatAvailableByString(const std::string& format,
+                                          Buffer buffer) const {
+  return IsFormatAvailable(format, buffer);
+}
+
+void Clipboard::ReadAvailableTypes(Buffer buffer, std::vector<string16>* types,
+    bool* contains_filenames) const {
+  if (!types || !contains_filenames) {
+    NOTREACHED();
+    return;
+  }
+
+  types->clear();
+  if (IsFormatAvailable(GetPlainTextFormatType(), buffer))
+    types->push_back(UTF8ToUTF16(GetPlainTextFormatType()));
+  if (IsFormatAvailable(GetHtmlFormatType(), buffer))
+    types->push_back(UTF8ToUTF16(GetHtmlFormatType()));
+  if (IsFormatAvailable(GetBitmapFormatType(), buffer))
+    types->push_back(UTF8ToUTF16(GetBitmapFormatType()));
+  if (IsFormatAvailable(GetWebKitSmartPasteFormatType(), buffer))
+    types->push_back(UTF8ToUTF16(GetWebKitSmartPasteFormatType()));
+  *contains_filenames = false;
+}
+
+void Clipboard::ReadText(Buffer buffer, string16* result) const {
+  *result = UTF8ToUTF16(GetClipboardData()->text());
+}
+
+void Clipboard::ReadAsciiText(Buffer buffer, std::string* result) const {
+  *result = GetClipboardData()->text();
+}
+
+void Clipboard::ReadHTML(Buffer buffer, string16* markup, std::string* src_url,
+                         uint32* fragment_start, uint32* fragment_end) const {
+  markup->clear();
+  if (src_url)
+    src_url->clear();
+  *fragment_start = 0;
+  *fragment_end = 0;
+
+  *markup = UTF8ToUTF16(GetClipboardData()->markup_data());
+  *src_url = GetClipboardData()->url();
+
+  *fragment_start = 0;
+  DCHECK(markup->length() <= kuint32max);
+  *fragment_end = static_cast<uint32>(markup->length());
+
+}
+
+SkBitmap Clipboard::ReadImage(Buffer buffer) const {
+  const gfx::Size size = GetClipboardData()->bitmap_size();
+  uint8_t* bitmap = GetClipboardData()->bitmap_data();
+  SkBitmap image;
+  image.setConfig(SkBitmap::kARGB_8888_Config, size.width(), size.height(), 0);
+  image.allocPixels();
+  image.eraseARGB(0, 0, 0, 0);
+  int byte_counter = 0;
+  for (int i = 0; i < size.height(); ++i) {
+    for (int j = 0; j < size.width(); ++j) {
+      uint32* pixel = image.getAddr32(j, i);
+      // We store the pixels in RGBA format. Create one ARGB pixel from four
+      // RGBA values.

[oshima, 2011/10/24 23:31:26]

BGRA

[varunjain, 2011/10/25 21:04:40]

Removed conversion.

+      *pixel = (bitmap[byte_counter] << 16) +    /* R */
+               (bitmap[byte_counter + 1] << 8) + /* G */
+               (bitmap[byte_counter + 2] << 0) + /* B */
+               (bitmap[byte_counter + 3] << 24); /* A */
+      byte_counter += 4;

[oshima, 2011/10/21 21:32:43]

can we use gfx::ConvertBetweenBGRAandRGBA?

[varunjain, 2011/10/24 05:51:53]

I believe that function is not publicly visible. Besides its probably faster
this way since we want an int at the end and that function converts between
char*s

[oshima, 2011/10/24 23:31:26]

Actually, why we're converting back and forth? Can you add comment on why we're
doing this?

I'm not so convinced about performance either. This way requires to load between
memory and register, while their way doesn't, and 3 copies can be done in
parallel.
I'm not disagreeing with you, but it has to be measured to claim it's faster.

[varunjain, 2011/10/25 21:04:40]

Removed conversion.

+    }
+  }
+  return image;
+}
+
+void Clipboard::ReadBookmark(string16* title, std::string* url) const {
+  *title = UTF8ToUTF16(GetClipboardData()->bookmark_title());
+  *url = GetClipboardData()->bookmark_url();
+}
+
+void Clipboard::ReadFile(FilePath* file) const {
+  NOTIMPLEMENTED();
+}
+
+void Clipboard::ReadFiles(std::vector<FilePath>* files) const {
+  NOTIMPLEMENTED();
+}
+
+void Clipboard::ReadData(const std::string& format, std::string* result) {
+  result->clear();
+  ClipboardData* data = GetClipboardData();
+  if (data->custom_data_format() == format)
+    *result = std::string(data->custom_data_data(), data->custom_data_len());
+}
+
+uint64 Clipboard::GetSequenceNumber() {
+  NOTIMPLEMENTED();
+  return 0;
+}
+
+void Clipboard::WriteText(const char* text_data, size_t text_len) {
+  GetClipboardData()->set_text(std::string(text_data, text_len));
+}
+
+void Clipboard::WriteHTML(const char* markup_data,
+                          size_t markup_len,
+                          const char* url_data,
+                          size_t url_len) {
+  GetClipboardData()->set_markup_data(std::string(markup_data, markup_len));
+  GetClipboardData()->set_url(std::string(url_data, url_len));
+}
+
+void Clipboard::WriteBookmark(const char* title_data,
+                              size_t title_len,
+                              const char* url_data,
+                              size_t url_len) {
+  GetClipboardData()->set_bookmark_title(std::string(title_data, title_len));
+  GetClipboardData()->set_bookmark_url(std::string(url_data, url_len));
+}
+
+void Clipboard::WriteWebSmartPaste() {
+  GetClipboardData()->set_web_smart_paste(true);
+}
+
+void Clipboard::WriteBitmap(const char* pixel_data, const char* size_data) {
+  const gfx::Size* size = reinterpret_cast<const gfx::Size*>(size_data);
+
+  // Create an RGBA bitmap and store it in ClipboardData
+  GetClipboardData()->set_bitmap_data(
+      gfx::BGRAToRGBA(reinterpret_cast<const uint8_t*>(pixel_data),
+                      size->width(), size->height(), 0));
+  GetClipboardData()->set_bitmap_size(*size);
+}
+
+void Clipboard::WriteData(const char* format_name, size_t format_len,
+                          const char* data_data, size_t data_len) {
+  GetClipboardData()->SetData(std::string(format_name, format_len),
+      data_data, data_len);
+}
+
+// static
+Clipboard::FormatType Clipboard::GetPlainTextFormatType() {
+  return std::string(kMimeTypeText);
+}
+
+// static
+Clipboard::FormatType Clipboard::GetPlainTextWFormatType() {
+  return GetPlainTextFormatType();
+}
+
+// static
+Clipboard::FormatType Clipboard::GetHtmlFormatType() {
+  return std::string(kMimeTypeHTML);
+}
+
+// static
+Clipboard::FormatType Clipboard::GetBitmapFormatType() {
+  return std::string(kMimeTypeBitmap);
+}
+
+// static
+Clipboard::FormatType Clipboard::GetWebKitSmartPasteFormatType() {
+  return std::string(kMimeTypeWebkitSmartPaste);
+}
+
+}  // namespace ui