Add option to disable native clipboard

This is related to aseprite#1100, as the Linux port is not well tested and may
fail, it's good to have an option to disable the native clipboard code
just in case.

Author: dacap

data/pref.xml

@@ -152,6 +152,7 @@
       <option id="mini_font" type="std::string" migrate="Options.UserMiniFont" />
     </section>
     <section id="experimental" text="Experimental">
+      <option id="use_native_clipboard" type="bool" default="true" />
       <option id="use_native_file_dialog" type="bool" default="false" />
       <option id="flash_layer" type="bool" default="false" migrate="Options.FlashLayer" />
       <option id="nonactive_layers_opacity" type="int" default="255" />

data/strings/en.ini

@@ -1008,6 +1008,7 @@ disable_extension = &Disable
 uninstall_extension = &Uninstall
 open_extension_folder = Open &Folder
 user_interface = User Interface
+native_clipboard = Use native clipboard
 native_file_dialog = Use native file dialog
 flash_selected_layer = Flash layer when it is selected
 non_active_layer_opacity = Opacity for non-active layers:

data/widgets/options.xml

@@ -352,6 +352,7 @@
         <!-- Experimental -->
         <vbox id="section_experimental">
           <separator text="@.user_interface" horizontal="true" />
+          <check id="native_clipboard" text="@.native_clipboard" />
           <check id="native_file_dialog" text="@.native_file_dialog" />
           <check id="flash_layer" text="@.flash_selected_layer" />
 	  <hbox>

src/app/app.cpp

@@ -228,6 +228,10 @@ void App::initialize(const AppOptions& options)
   if (isGui()) {
     LOG("APP: GUI mode\n");
 
+    // Set the ClipboardDelegate impl to copy/paste text in the native
+    // clipboard from the ui::Entry control.
+    m_uiSystem->setClipboardDelegate(&m_modules->m_clipboardManager);
+
     // Setup the GUI cursor and redraw screen
     ui::set_use_native_cursors(preferences().cursor.useNativeCursor());
     ui::set_mouse_cursor_scale(preferences().cursor.cursorScale());

src/app/commands/cmd_options.cpp

@@ -250,6 +250,9 @@ class OptionsWindow : public app::gen::Options {
 
     onNativeCursorChange();
 
+    if (m_pref.experimental.useNativeClipboard())
+      nativeClipboard()->setSelected(true);
+
     if (m_pref.experimental.useNativeFileDialog())
       nativeFileDialog()->setSelected(true);
 
@@ -486,6 +489,7 @@ class OptionsWindow : public app::gen::Options {
     m_pref.undo.allowNonlinearHistory(undoAllowNonlinearHistory()->isSelected());
 
     // Experimental features
+    m_pref.experimental.useNativeClipboard(nativeClipboard()->isSelected());
     m_pref.experimental.useNativeFileDialog(nativeFileDialog()->isSelected());
     m_pref.experimental.flashLayer(flashLayer()->isSelected());
     m_pref.experimental.nonactiveLayersOpacity(nonactiveLayersOpacity()->getValue());

src/app/util/clipboard.cpp

@@ -21,6 +21,7 @@
 #include "app/modules/editors.h"
 #include "app/modules/gfx.h"
 #include "app/modules/gui.h"
+#include "app/pref/preferences.h"
 #include "app/transaction.h"
 #include "app/ui/color_bar.h"
 #include "app/ui/editor/editor.h"
@@ -31,6 +32,7 @@
 #include "app/util/clipboard_native.h"
 #include "app/util/new_image_from_mask.h"
 #include "base/shared_ptr.h"
+#include "clip/clip.h"
 #include "doc/doc.h"
 #include "render/ordered_dither.h"
 #include "render/quantization.h"
@@ -99,6 +101,16 @@ static ClipboardRange clipboard_range;
 
 static ClipboardManager* g_instance = nullptr;
 
+static bool use_native_clipboard()
+{
+  return Preferences::instance().experimental.useNativeClipboard();
+}
+
+ClipboardManager* ClipboardManager::instance()
+{
+  return g_instance;
+}
+
 ClipboardManager::ClipboardManager()
 {
   ASSERT(!g_instance);
@@ -123,9 +135,25 @@ ClipboardManager::~ClipboardManager()
   g_instance = nullptr;
 }
 
-ClipboardManager* ClipboardManager::instance()
+void ClipboardManager::setClipboardText(const std::string& text)
 {
-  return g_instance;
+  if (use_native_clipboard()) {
+    clip::set_text(text);
+  }
+  else {
+    m_text = text;
+  }
+}
+
+bool ClipboardManager::getClipboardText(std::string& text)
+{
+  if (use_native_clipboard()) {
+    return clip::get_text(text);
+  }
+  else {
+    text = m_text;
+    return true;
+  }
 }
 
 static void set_clipboard_image(Image* image,
@@ -148,7 +176,8 @@ static void set_clipboard_image(Image* image,
         image->setMaskColor(-1);
     }
 
-    set_native_clipboard_bitmap(image, mask, palette);
+    if (use_native_clipboard())
+      set_native_clipboard_bitmap(image, mask, palette);
 
     if (image && !image_source_is_transparent)
       image->setMaskColor(oldMask);
@@ -181,7 +210,8 @@ static bool copy_from_document(const Site& site, bool merged = false)
 ClipboardFormat get_current_format()
 {
   // Check if the native clipboard has an image
-  if (has_native_clipboard_bitmap())
+  if (use_native_clipboard() &&
+      has_native_clipboard_bitmap())
     return ClipboardImage;
   else if (clipboard_image)
     return ClipboardImage;
@@ -302,8 +332,8 @@ void paste()
   switch (get_current_format()) {
 
     case clipboard::ClipboardImage: {
-      // Get the image from the clipboard.
-      {
+      // Get the image from the native clipboard.
+      if (use_native_clipboard()) {
         Image* native_image = nullptr;
         Mask* native_mask = nullptr;
         Palette* native_palette = nullptr;
@@ -567,15 +597,16 @@ void paste()
 bool get_image_size(gfx::Size& size)
 {
 #if defined(_WIN32) || defined(__APPLE__)
-  if (get_native_clipboard_bitmap_size(&size))
+  if (use_native_clipboard() &&
+      get_native_clipboard_bitmap_size(&size))
     return true;
-#else
+#endif
+
   if (clipboard_image) {
     size.w = clipboard_image->width();
     size.h = clipboard_image->height();
     return true;
   }
-#endif
 
   return false;
 }

src/app/util/clipboard.h

@@ -1,5 +1,5 @@
 // Aseprite
-// Copyright (C) 2001-2016  David Capello
+// Copyright (C) 2001-2018  David Capello
 //
 // This program is distributed under the terms of
 // the End-User License Agreement for Aseprite.
@@ -11,6 +11,7 @@
 #include "gfx/point.h"
 #include "gfx/size.h"
 #include "ui/base.h"
+#include "ui/clipboard_delegate.h"
 
 namespace doc {
   class Image;
@@ -37,12 +38,17 @@ namespace app {
 
     // TODO Horrible API: refactor it (maybe a merge with she::clipboard).
 
-    class ClipboardManager {
+    class ClipboardManager : public ui::ClipboardDelegate {
     public:
+      static ClipboardManager* instance();
+
       ClipboardManager();
       ~ClipboardManager();
 
-      static ClipboardManager* instance();
+      void setClipboardText(const std::string& text) override;
+      bool getClipboardText(std::string& text) override;
+    private:
+      std::string m_text; // Text used when the native clipboard is disabled
     };
 
     ClipboardFormat get_current_format();

src/ui/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Aseprite UI Library
-# Copyright (C) 2001-2017  David Capello
+# Copyright (C) 2001-2018  David Capello
 
 if(WIN32)
   add_definitions(-D_CRT_SECURE_NO_WARNINGS)
@@ -57,7 +57,6 @@ add_library(ui-lib
 
 target_link_libraries(ui-lib
   she
-  clip
   gfx-lib
   laf-base
   obs

src/ui/clipboard_delegate.h

@@ -0,0 +1,24 @@
+// Aseprite UI Library
+// Copyright (C) 2018  David Capello
+//
+// This file is released under the terms of the MIT license.
+// Read LICENSE.txt for more information.
+
+#ifndef UI_CLIPBOARD_DELEGATE_H_INCLUDED
+#define UI_CLIPBOARD_DELEGATE_H_INCLUDED
+#pragma once
+
+#include <string>
+
+namespace ui {
+
+  class ClipboardDelegate {
+  public:
+    virtual ~ClipboardDelegate() { }
+    virtual void setClipboardText(const std::string& text) = 0;
+    virtual bool getClipboardText(std::string& text) = 0;
+  };
+
+} // namespace ui
+
+#endif

src/ui/entry.cpp

@@ -1,5 +1,5 @@
 // Aseprite UI Library
-// Copyright (C) 2001-2017  David Capello
+// Copyright (C) 2001-2018  David Capello
 //
 // This file is released under the terms of the MIT license.
 // Read LICENSE.txt for more information.
@@ -12,7 +12,6 @@
 
 #include "base/bind.h"
 #include "base/string.h"
-#include "clip/clip.h"
 #include "she/draw_text.h"
 #include "she/font.h"
 #include "she/system.h"
@@ -636,7 +635,7 @@ void Entry::executeCmd(EntryCmd cmd, int unicodeChar, bool shift_pressed)
       if (selbeg >= 0) {
         // *cut* text!
         if (cmd == EntryCmd::Cut)
-          clip::set_text(selectedText());
+          set_clipboard_text(selectedText());
 
         // remove text
         text.erase(m_boxes[selbeg].from,
@@ -656,7 +655,7 @@ void Entry::executeCmd(EntryCmd cmd, int unicodeChar, bool shift_pressed)
 
     case EntryCmd::Paste: {
       std::string clipboard;
-      if (clip::get_text(clipboard)) {
+      if (get_clipboard_text(clipboard)) {
         // delete the entire selection
         if (selbeg >= 0) {
           text.erase(m_boxes[selbeg].from,
@@ -688,7 +687,7 @@ void Entry::executeCmd(EntryCmd cmd, int unicodeChar, bool shift_pressed)
 
     case EntryCmd::Copy:
       if (selbeg >= 0)
-        clip::set_text(selectedText());
+        set_clipboard_text(selectedText());
       break;
 
     case EntryCmd::DeleteBackward:

src/ui/system.cpp

@@ -1,5 +1,5 @@
 // Aseprite UI Library
-// Copyright (C) 2001-2017  David Capello
+// Copyright (C) 2001-2018  David Capello
 //
 // This file is released under the terms of the MIT license.
 // Read LICENSE.txt for more information.
@@ -15,6 +15,7 @@
 #include "she/display.h"
 #include "she/surface.h"
 #include "she/system.h"
+#include "ui/clipboard_delegate.h"
 #include "ui/cursor.h"
 #include "ui/intern.h"
 #include "ui/intern.h"
@@ -171,8 +172,20 @@ static void update_mouse_cursor()
   }
 }
 
+// static
+static UISystem* g_instance = nullptr;
+
+UISystem* UISystem::instance()
+{
+  return g_instance;
+}
+
 UISystem::UISystem()
+  : m_clipboardDelegate(nullptr)
 {
+  ASSERT(!g_instance);
+  g_instance = this;
+
   main_gui_thread = base::this_thread::native_handle();
   mouse_cursor_type = kOutsideDisplay;
   support_native_custom_cursor =
@@ -196,6 +209,9 @@ UISystem::~UISystem()
   _internal_set_mouse_display(nullptr);
   if (!update_custom_native_cursor(nullptr))
     update_mouse_overlay(nullptr);
+
+  ASSERT(g_instance == this);
+  g_instance = nullptr;
 }
 
 void _internal_set_mouse_display(she::Display* display)
@@ -223,6 +239,24 @@ int display_h()
     return 1;
 }
 
+void set_clipboard_text(const std::string& text)
+{
+  ASSERT(g_instance);
+  ClipboardDelegate* delegate = g_instance->clipboardDelegate();
+  if (delegate)
+    delegate->setClipboardText(text);
+}
+
+bool get_clipboard_text(std::string& text)
+{
+  ASSERT(g_instance);
+  ClipboardDelegate* delegate = g_instance->clipboardDelegate();
+  if (delegate)
+    return delegate->getClipboardText(text);
+  else
+    return false;
+}
+
 void update_cursor_overlay()
 {
   if (mouse_cursor_overlay != NULL && mouse_scares == 0) {

src/ui/system.h

@@ -1,5 +1,5 @@
 // Aseprite UI Library
-// Copyright (C) 2001-2017  David Capello
+// Copyright (C) 2001-2018  David Capello
 //
 // This file is released under the terms of the MIT license.
 // Read LICENSE.txt for more information.
@@ -13,22 +13,39 @@
 #include "ui/cursor_type.h"
 #include "ui/mouse_buttons.h"
 
+#include <string>
+
 namespace she { class Display; }
 
 namespace ui {
 
+  class ClipboardDelegate;
   class Cursor;
   class Widget;
 
   class UISystem {
   public:
+    static UISystem* instance();
+
     UISystem();
     ~UISystem();
+
+    void setClipboardDelegate(ClipboardDelegate* delegate) {
+      m_clipboardDelegate = delegate;
+    }
+    ClipboardDelegate* clipboardDelegate() {
+      return m_clipboardDelegate;
+    }
+  private:
+    ClipboardDelegate* m_clipboardDelegate;
   };
 
   int display_w();
   int display_h();
 
+  void set_clipboard_text(const std::string& text);
+  bool get_clipboard_text(std::string& text);
+
   // Mouse related
 
   // Updates the position of the mouse cursor overlay depending on the