Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clipboard operations: xclip or pbcopy/pbpaste style operations. #656

Merged
merged 1 commit into from May 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 26 additions & 1 deletion amm/repl/src/main/scala/ammonite/repl/ApiImpls.scala
@@ -1,10 +1,13 @@
package ammonite.repl


import ammonite.ops.Internals
import ammonite.runtime._
import ammonite.util.Util._
import ammonite.util._

import java.awt.Toolkit
import java.awt.datatransfer.{DataFlavor, StringSelection}

import scala.collection.mutable

class SessionApiImpl(frames0: => StableRef[List[Frame]]) extends Session{
Expand Down Expand Up @@ -108,4 +111,26 @@ trait ReplApiImpl extends FullReplAPI{

def sess: SessionApiImpl

override def clipboard: Clipboard = ClipboardImpl
}
object ClipboardImpl extends Clipboard {

private lazy val systemClipboard =
Toolkit.getDefaultToolkit.getSystemClipboard

override def read: String =
Option(systemClipboard.getContents(null)) collect {
case data if data.isDataFlavorSupported(DataFlavor.stringFlavor) =>
data.getTransferData(DataFlavor.stringFlavor)
} match {
case Some(str: String) => str
case _ => ""
}

override def write(data: Internals.Writable): Unit = {
val newContents = new StringSelection(
data.writeableData.map(new String(_)).mkString
)
systemClipboard.setContents(newContents, newContents)
}
}
18 changes: 17 additions & 1 deletion amm/repl/src/main/scala/ammonite/repl/ReplAPI.scala
@@ -1,5 +1,6 @@
package ammonite.repl

import ammonite.ops.Internals
import ammonite.util._

import scala.reflect.runtime.universe._
Expand Down Expand Up @@ -160,6 +161,8 @@ trait ReplAPI {
def sess: Session

def load: ReplLoad

def clipboard: Clipboard
}
trait ReplLoad{
/**
Expand Down Expand Up @@ -206,4 +209,17 @@ trait Session{
*/
def delete(name: String): Unit
}

trait Clipboard{
/**
* Reads contents from the system clipboard.
* @return System clipboard contents if they are readable as `String`,
* empty string otherwise.
*/
def read: String
/**
* Sets the contents of the system clipboard.
*
* @param data New contents for the clipboard.
*/
def write(data: Internals.Writable): Unit
}
44 changes: 44 additions & 0 deletions amm/repl/src/test/scala/ammonite/unit/ClipboardTests.scala
@@ -0,0 +1,44 @@
package ammonite.unit

import ammonite.repl.{Clipboard, ClipboardImpl}

import java.awt.Toolkit
import java.awt.datatransfer.DataFlavor

import utest._

import scala.util.Try

object ClipboardTests extends TestSuite{

val clipboard: Clipboard = ClipboardImpl

/**
* This test suite requires an environment with access to a window
* service (either under, Windows, MacOs, X11, ...) CI environment
* doesn't satisfy that condition and that is detected in the following
* check in order to skip [[Clipboard]] test when running on CI.
*/
val canTest = Try(
Toolkit.getDefaultToolkit.getSystemClipboard.isDataFlavorAvailable(
DataFlavor.stringFlavor
)
).getOrElse(false)

override def tests = Tests {
println("ClipboardTests")
'clipboard {
val newClipboardContents = "hello Ammonite"
'copyandpaste - {
if (canTest) {
clipboard.write(newClipboardContents)
assert(clipboard.read == newClipboardContents)
} else {
println(
"The environment doesn't allow testing clipboard - skipping"
)
}
}
}
}
}