Switch from copypasta to rust-clipboard

This switches our own `copypasta` crate with the more standardized
`clipboard` library, which allows us to get rid of the `xclip`
dependency on X11.

Additionally, this lays the foundation for native Wayland clipboard
support once the clipboard crate is updated (or a fork is created).

Fixes #5.
This commit is contained in:
Christian Duerr 2019-04-28 20:21:39 +00:00 committed by GitHub
parent 37b66a7cd2
commit 9e89aaa477
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 302 additions and 924 deletions

View File

@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Packaging
- The xclip dependency has been removed
### Added
- Added ToggleFullscreen action
@ -38,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Added ScrollLineUp and ScrollLineDown actions for scrolling line by line
- Native clipboard support on X11 and Wayland
### Changed

136
Cargo.lock generated
View File

@ -41,7 +41,7 @@ dependencies = [
"base64 0.10.1 (registry+https://github.com/rust-lang/crates.io-index)",
"bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)",
"copypasta 0.0.1",
"clipboard 0.5.0 (git+https://github.com/chrisduerr/rust-clipboard)",
"crossbeam-channel 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
"dirs 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)",
"dunce 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
@ -66,7 +66,7 @@ dependencies = [
"serde_derive 1.0.90 (registry+https://github.com/rust-lang/crates.io-index)",
"serde_json 1.0.39 (registry+https://github.com/rust-lang/crates.io-index)",
"serde_yaml 0.8.8 (registry+https://github.com/rust-lang/crates.io-index)",
"signal-hook 0.1.8 (registry+https://github.com/rust-lang/crates.io-index)",
"signal-hook 0.1.9 (registry+https://github.com/rust-lang/crates.io-index)",
"static_assertions 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)",
"terminfo 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
"unicode-width 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)",
@ -316,12 +316,14 @@ dependencies = [
[[package]]
name = "clipboard"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
source = "git+https://github.com/chrisduerr/rust-clipboard#c0c27997a091e217eb2b6e38d4cb6232a3fe593a"
dependencies = [
"clipboard-win 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"objc 0.2.6 (registry+https://github.com/rust-lang/crates.io-index)",
"objc-foundation 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"objc_id 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"smithay-clipboard 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-client 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"x11-clipboard 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)",
]
@ -401,16 +403,6 @@ dependencies = [
"url 1.7.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "copypasta"
version = "0.0.1"
dependencies = [
"clipboard 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
"objc 0.2.6 (registry+https://github.com/rust-lang/crates.io-index)",
"objc-foundation 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"objc_id 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "core-foundation"
version = "0.6.4"
@ -1405,6 +1397,18 @@ dependencies = [
"winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "nix"
version = "0.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"cc 1.0.35 (registry+https://github.com/rust-lang/crates.io-index)",
"cfg-if 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"libc 0.2.53 (registry+https://github.com/rust-lang/crates.io-index)",
"void 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "nix"
version = "0.13.0"
@ -2117,13 +2121,22 @@ dependencies = [
[[package]]
name = "signal-hook"
version = "0.1.8"
version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"libc 0.2.53 (registry+https://github.com/rust-lang/crates.io-index)",
"mio 0.6.16 (registry+https://github.com/rust-lang/crates.io-index)",
"mio-uds 0.6.7 (registry+https://github.com/rust-lang/crates.io-index)",
"signal-hook-registry 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "signal-hook-registry"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"arc-swap 0.3.11 (registry+https://github.com/rust-lang/crates.io-index)",
"libc 0.2.53 (registry+https://github.com/rust-lang/crates.io-index)",
"mio 0.6.16 (registry+https://github.com/rust-lang/crates.io-index)",
"mio-uds 0.6.7 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
@ -2157,6 +2170,30 @@ dependencies = [
"wayland-protocols 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "smithay-client-toolkit"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"andrew 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
"bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"dlib 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)",
"lazy_static 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
"memmap 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
"nix 0.13.0 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-client 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-commons 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-protocols 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "smithay-clipboard"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"smithay-client-toolkit 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "socket2"
version = "0.3.8"
@ -2592,6 +2629,20 @@ dependencies = [
"wayland-sys 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-client"
version = "0.22.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"downcast-rs 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"libc 0.2.53 (registry+https://github.com/rust-lang/crates.io-index)",
"nix 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-commons 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-scanner 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-sys 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-commons"
version = "0.21.12"
@ -2601,6 +2652,15 @@ dependencies = [
"wayland-sys 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-commons"
version = "0.22.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"nix 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-sys 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-protocols"
version = "0.21.12"
@ -2613,6 +2673,18 @@ dependencies = [
"wayland-sys 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-protocols"
version = "0.22.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-client 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-commons 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-scanner 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
"wayland-sys 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-scanner"
version = "0.21.12"
@ -2623,6 +2695,16 @@ dependencies = [
"xml-rs 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-scanner"
version = "0.22.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"proc-macro2 0.4.28 (registry+https://github.com/rust-lang/crates.io-index)",
"quote 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)",
"xml-rs 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-sys"
version = "0.21.12"
@ -2632,6 +2714,15 @@ dependencies = [
"lazy_static 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "wayland-sys"
version = "0.22.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"dlib 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)",
"lazy_static 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "which"
version = "1.0.5"
@ -2845,7 +2936,7 @@ dependencies = [
"checksum cgl 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "55e7ec0b74fe5897894cbc207092c577e87c52f8a59e8ca8d97ef37551f60a49"
"checksum clang-sys 0.22.0 (registry+https://github.com/rust-lang/crates.io-index)" = "939a1a34310b120d26eba35c29475933128b0ec58e24b43327f8dbe6036fc538"
"checksum clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5067f5bb2d80ef5d68b4c87db81601f0b75bca627bc2ef76b141d7b846a3c6d9"
"checksum clipboard 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "25a904646c0340239dcf7c51677b33928bf24fdf424b79a57909c0109075b2e7"
"checksum clipboard 0.5.0 (git+https://github.com/chrisduerr/rust-clipboard)" = "<none>"
"checksum clipboard-win 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "289da2fc09ab964a4948a63287c94fcb4698fa823c46da84c3792928c9d36110"
"checksum cloudabi 0.0.3 (registry+https://github.com/rust-lang/crates.io-index)" = "ddfc5b9aa5d4507acaf872de71051dfd0e309860e88966e1051e462a077aac4f"
"checksum cmake 0.1.38 (registry+https://github.com/rust-lang/crates.io-index)" = "96210eec534fc3fbfc0452a63769424eaa80205fda6cea98e5b61cb3d97bcec8"
@ -2962,6 +3053,7 @@ dependencies = [
"checksum named_pipe 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "8ed10a5ac4f5f7e5d75552b12c1d5d542debca81e573279dd1e4c19fde6efa6d"
"checksum native-tls 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "4b2df1a4c22fd44a62147fd8f13dd0f95c9d8ca7b2610299b2a2f9cf8964274e"
"checksum net2 0.2.33 (registry+https://github.com/rust-lang/crates.io-index)" = "42550d9fb7b6684a6d404d9fa7250c2eb2646df731d1c06afc06dcee9e1bcf88"
"checksum nix 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)" = "921f61dc817b379d0834e45d5ec45beaacfae97082090a49c2cf30dcbc30206f"
"checksum nix 0.13.0 (registry+https://github.com/rust-lang/crates.io-index)" = "46f0f3210768d796e8fa79ec70ee6af172dacbe7147f5e69be5240a47778302b"
"checksum nodrop 0.1.13 (registry+https://github.com/rust-lang/crates.io-index)" = "2f9667ddcc6cc8a43afc9b7917599d7216aa09c463919ea32c59ed6cac8bc945"
"checksum nom 3.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "05aec50c70fd288702bcd93284a8444607f3292dbdf2a30de5ea5dcdbe72287b"
@ -3041,11 +3133,14 @@ dependencies = [
"checksum servo-fontconfig 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "a088f8d775a5c5314aae09bd77340bc9c67d72b9a45258be34c83548b4814cd9"
"checksum servo-fontconfig-sys 4.0.7 (registry+https://github.com/rust-lang/crates.io-index)" = "b46d201addcfbd25c1798ad1281d98c40743824e0b0f1e611bd3d5d0d31a7b8d"
"checksum shared_library 0.1.9 (registry+https://github.com/rust-lang/crates.io-index)" = "5a9e7e0f2bfae24d8a5b5a66c5b257a83c7412304311512a0c054cd5e619da11"
"checksum signal-hook 0.1.8 (registry+https://github.com/rust-lang/crates.io-index)" = "97a47ae722318beceb0294e6f3d601205a1e6abaa4437d9d33e3a212233e3021"
"checksum signal-hook 0.1.9 (registry+https://github.com/rust-lang/crates.io-index)" = "72ab58f1fda436857e6337dcb6a5aaa34f16c5ddc87b3a8b6ef7a212f90b9c5a"
"checksum signal-hook-registry 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)" = "591fe2ee5a2412968f63a008a190d99918c2cda3f616411026f0975715e1cf62"
"checksum siphasher 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "0b8de496cf83d4ed58b6be86c3a275b8602f6ffe98d3024a869e124147a9a3ac"
"checksum slab 0.4.2 (registry+https://github.com/rust-lang/crates.io-index)" = "c111b5bd5695e56cffe5129854aa230b39c93a305372fdbb2668ca2394eea9f8"
"checksum smallvec 0.6.9 (registry+https://github.com/rust-lang/crates.io-index)" = "c4488ae950c49d403731982257768f48fada354a5203fe81f9bb6f43ca9002be"
"checksum smithay-client-toolkit 0.4.5 (registry+https://github.com/rust-lang/crates.io-index)" = "aa4899558362a65589b53313935099835acf999740915e134dff20cca7c6a28b"
"checksum smithay-client-toolkit 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "7c172926680325cc0cbb6b08193a66fd88e1ef4a6e92651fd459ca4f5d94c8bc"
"checksum smithay-clipboard 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "7944fcb3ecb86f0e39537c1c7501931d3a0f00d3ef1dfc0d4b8996884ac77197"
"checksum socket2 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "c4d11a52082057d87cb5caa31ad812f4504b97ab44732cd8359df2e9ff9f48e7"
"checksum spsc-buffer 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "be6c3f39c37a4283ee4b43d1311c828f2e1fb0541e76ea0cb1a2abd9ef2f5b3b"
"checksum stable_deref_trait 1.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "dba1a27d3efae4351c8051072d619e3ade2820635c3958d826bfea39d59b54c8"
@ -3096,10 +3191,15 @@ dependencies = [
"checksum walkdir 2.2.7 (registry+https://github.com/rust-lang/crates.io-index)" = "9d9d7ed3431229a144296213105a390676cc49c9b6a72bd19f3176c98e129fa1"
"checksum want 0.0.6 (registry+https://github.com/rust-lang/crates.io-index)" = "797464475f30ddb8830cc529aaaae648d581f99e2036a928877dfde027ddf6b3"
"checksum wayland-client 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)" = "e77d1e6887f07ea2e5d79a3d7d03a875e62d3746334a909b5035d779d849a523"
"checksum wayland-client 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)" = "a2656a57440ba1db12d4e5f0dce5423eed97bbf91bd321f456f41cde6da6c01e"
"checksum wayland-commons 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)" = "dff69a5399ca212efa4966f3ee2a3773f19960d0fa329b9aca046a8508a0e09f"
"checksum wayland-commons 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)" = "27b4965c07ee4b63b845e6aef4aa9066668a9ed00ce345afddcc991508ec8025"
"checksum wayland-protocols 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)" = "c9ccddf6a4407d982898e0f0a1172217843f3d40fe4272f828060b56a2d40d81"
"checksum wayland-protocols 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)" = "56bfad6aef97b909703605ea1321079a00914aa2eb98912641c54bfa9e3b0570"
"checksum wayland-scanner 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)" = "63bc5efa7dcdb8f04d2e5d1571c0d0577fc47076d133d68e056bdb299f1b60e2"
"checksum wayland-scanner 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)" = "ada374074230633e2b27c045c6706be02408e1abf76e0e810e0f65cccae43c6e"
"checksum wayland-sys 0.21.12 (registry+https://github.com/rust-lang/crates.io-index)" = "e76af81a601b84d400744f85f083381daa77ac01f6c8711e57e662dc3a35d69d"
"checksum wayland-sys 0.22.2 (registry+https://github.com/rust-lang/crates.io-index)" = "c0e5e9cbfba8b38c34d7615cfe1e69c5242f0e7c2dab00fd705f6caff32b3c0f"
"checksum which 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)" = "e84a603e7e0b1ce1aa1ee2b109c7be00155ce52df5081590d1ffb93f4f515cb2"
"checksum widestring 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "effc0e4ff8085673ea7b9b2e3c73f6bd4d118810c9009ed8f1e16bd96c331db6"
"checksum winapi 0.2.8 (registry+https://github.com/rust-lang/crates.io-index)" = "167dc9d6949a9b857f3451275e911c3f44255842c1f7a76f33c55103a909087a"

View File

@ -3,7 +3,6 @@ members = [
"alacritty",
"alacritty_terminal",
"font",
"copypasta",
"winpty"
]

View File

@ -71,7 +71,7 @@ libraries to build Alacritty. Here's an apt command that should install all of
them. If something is still found to be missing, please open an issue.
```sh
apt-get install cmake pkg-config libfreetype6-dev libfontconfig1-dev xclip
apt-get install cmake pkg-config libfreetype6-dev libfontconfig1-dev
```
#### Arch Linux
@ -81,7 +81,7 @@ On Arch Linux, you need a few extra libraries to build Alacritty. Here's a
to be missing, please open an issue.
```sh
pacman -S cmake freetype2 fontconfig pkg-config make xclip
pacman -S cmake freetype2 fontconfig pkg-config make
```
#### Fedora
@ -91,7 +91,7 @@ command that should install all of them. If something is still found to be
missing, please open an issue.
```sh
dnf install cmake freetype-devel fontconfig-devel xclip
dnf install cmake freetype-devel fontconfig-devel
```
#### CentOS/RHEL 7
@ -101,7 +101,7 @@ command that should install all of them. If something is still found to be
missing, please open an issue.
```sh
yum install cmake freetype-devel fontconfig-devel xclip
yum install cmake freetype-devel fontconfig-devel
yum group install "Development Tools"
```
@ -112,15 +112,12 @@ a `zypper` command that should install all of them. If something is
still found to be missing, please open an issue.
```sh
zypper install cmake freetype-devel fontconfig-devel xclip
zypper install cmake freetype-devel fontconfig-devel
```
#### Slackware
Compiles out of the box for 14.2
For copy & paste support (middle mouse button) you need to install xclip
https://slackbuilds.org/repository/14.2/misc/xclip/?search=xclip
#### Void Linux
@ -128,7 +125,7 @@ On [Void Linux](https://voidlinux.eu), install following packages before
compiling Alacritty:
```sh
xbps-install cmake freetype-devel freetype expat-devel fontconfig-devel fontconfig xclip
xbps-install cmake freetype-devel freetype expat-devel fontconfig-devel fontconfig
```
#### FreeBSD
@ -138,7 +135,7 @@ command that should install all of them. If something is still found to be
missing, please open an issue.
```sh
pkg install cmake freetype2 fontconfig xclip pkgconf
pkg install cmake freetype2 fontconfig pkgconf
```
#### OpenBSD

View File

@ -41,6 +41,7 @@ use std::env;
#[cfg(not(windows))]
use std::os::unix::io::AsRawFd;
use alacritty_terminal::clipboard::Clipboard;
use alacritty_terminal::config::{self, Config, Monitor};
use alacritty_terminal::display::Display;
use alacritty_terminal::event_loop::{self, EventLoop, Msg};
@ -138,12 +139,18 @@ fn run(
info!("PTY Dimensions: {:?} x {:?}", display.size().lines(), display.size().cols());
// Create new native clipboard
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
let clipboard = Clipboard::new(display.get_wayland_display());
#[cfg(any(target_os = "macos", target_os = "windows"))]
let clipboard = Clipboard::new();
// Create the terminal
//
// This object contains all of the state about what's being displayed. It's
// wrapped in a clonable mutex since both the I/O loop and display need to
// access it.
let terminal = Term::new(&config, display.size().to_owned(), message_buffer);
let terminal = Term::new(&config, display.size().to_owned(), message_buffer, clipboard);
let terminal = Arc::new(FairMutex::new(terminal));
// Find the window ID for setting $WINDOWID

View File

@ -23,7 +23,6 @@ serde_yaml = "0.8"
vte = "0.3"
mio = "0.6"
mio-extras = "2"
copypasta = { path = "../copypasta" }
xdg = "2"
log = "0.4"
clap = "2"
@ -35,6 +34,7 @@ static_assertions = "0.3.0"
terminfo = "0.6.1"
url = "1.7.1"
crossbeam-channel = "0.3.8"
clipboard = { git = "https://github.com/chrisduerr/rust-clipboard" }
[target.'cfg(unix)'.dependencies]
nix = "0.13"

View File

@ -0,0 +1,90 @@
// Copyright 2016 Joe Wilm, The Alacritty Project Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
use std::ffi::c_void;
use clipboard::nop_clipboard::NopClipboardContext;
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
use clipboard::wayland_clipboard::WaylandClipboardContext;
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
use clipboard::x11_clipboard::{Primary as X11SecondaryClipboard, X11ClipboardContext};
use clipboard::{ClipboardContext, ClipboardProvider};
pub struct Clipboard {
primary: Box<ClipboardProvider>,
secondary: Option<Box<ClipboardProvider>>,
}
impl Clipboard {
#[cfg(any(target_os = "macos", target_os = "windows"))]
pub fn new() -> Self {
Self::default()
}
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
pub fn new(display: Option<*mut c_void>) -> Self {
if let Some(display) = display {
return Self {
primary: unsafe { Box::new(WaylandClipboardContext::new_from_external(display)) },
secondary: None,
};
}
Self {
primary: Box::new(ClipboardContext::new().unwrap()),
secondary: Some(Box::new(X11ClipboardContext::<X11SecondaryClipboard>::new().unwrap())),
}
}
// Use for tests and ref-tests
pub fn new_nop() -> Self {
Self { primary: Box::new(NopClipboardContext::new().unwrap()), secondary: None }
}
}
impl Default for Clipboard {
fn default() -> Self {
Self { primary: Box::new(ClipboardContext::new().unwrap()), secondary: None }
}
}
#[derive(Debug)]
pub enum ClipboardType {
Primary,
Secondary,
}
impl Clipboard {
pub fn store(&mut self, ty: ClipboardType, text: impl Into<String>) {
let clipboard = match (ty, &mut self.secondary) {
(ClipboardType::Secondary, Some(provider)) => provider,
(ClipboardType::Secondary, None) => return,
_ => &mut self.primary,
};
clipboard.set_contents(text.into()).unwrap_or_else(|err| {
warn!("Error storing selection to clipboard. {}", err);
});
}
pub fn load(&mut self, ty: ClipboardType) -> Result<String, Box<std::error::Error>> {
let clipboard = match (ty, &mut self.secondary) {
(ClipboardType::Secondary, Some(provider)) => provider,
_ => &mut self.primary,
};
clipboard.get_contents()
}
}

View File

@ -15,6 +15,7 @@
//! The display subsystem including window management, font rasterization, and
//! GPU drawing.
use std::f64;
use std::ffi::c_void;
use std::sync::mpsc;
use glutin::dpi::{PhysicalPosition, PhysicalSize};
@ -557,4 +558,9 @@ impl Display {
self.window().set_ime_spot(PhysicalPosition::from((nspot_x, nspot_y)).to_logical(dpr));
}
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
pub fn get_wayland_display(&self) -> Option<*mut c_void> {
self.window.get_wayland_display()
}
}

View File

@ -8,13 +8,13 @@ use std::io::Write;
use std::sync::mpsc;
use std::time::Instant;
use copypasta::{Buffer as ClipboardBuffer, Clipboard, Load, Store};
use glutin::dpi::PhysicalSize;
use glutin::{self, ElementState, Event, ModifiersState, MouseButton};
use parking_lot::MutexGuard;
use serde_json as json;
use crate::cli::Options;
use crate::clipboard::ClipboardType;
use crate::config::{self, Config};
use crate::display::OnResize;
use crate::grid::Scroll;
@ -26,7 +26,6 @@ use crate::term::cell::Cell;
use crate::term::{SizeInfo, Term};
#[cfg(unix)]
use crate::tty;
use crate::util::fmt::Red;
use crate::util::{limit, start_daemon};
use crate::window::Window;
@ -70,14 +69,10 @@ impl<'a, N: Notify + 'a> input::ActionContext for ActionContext<'a, N> {
}
}
fn copy_selection(&self, buffer: ClipboardBuffer) {
fn copy_selection(&mut self, ty: ClipboardType) {
if let Some(selected) = self.terminal.selection_to_string() {
if !selected.is_empty() {
Clipboard::new()
.and_then(|mut clipboard| clipboard.store(selected, buffer))
.unwrap_or_else(|err| {
warn!("Error storing selection to clipboard. {}", Red(err));
});
self.terminal.clipboard().store(ty, selected);
}
}
}

View File

@ -23,7 +23,6 @@ use std::mem;
use std::ops::RangeInclusive;
use std::time::Instant;
use copypasta::{Buffer as ClipboardBuffer, Clipboard, Load};
use glutin::{
ElementState, KeyboardInput, ModifiersState, MouseButton, MouseCursor, MouseScrollDelta,
TouchPhase,
@ -31,6 +30,7 @@ use glutin::{
use unicode_width::UnicodeWidthStr;
use crate::ansi::{ClearMode, Handler};
use crate::clipboard::ClipboardType;
use crate::config::{self, Key};
use crate::event::{ClickState, Mouse};
use crate::grid::Scroll;
@ -63,7 +63,7 @@ pub struct Processor<'a, A: 'a> {
pub trait ActionContext {
fn write_to_pty<B: Into<Cow<'static, [u8]>>>(&mut self, _: B);
fn size_info(&self) -> SizeInfo;
fn copy_selection(&self, _: ClipboardBuffer);
fn copy_selection(&mut self, _: ClipboardType);
fn clear_selection(&mut self);
fn update_selection(&mut self, point: Point, side: Side);
fn simple_selection(&mut self, point: Point, side: Side);
@ -279,11 +279,12 @@ impl Action {
ctx.write_to_pty(s.clone().into_bytes())
},
Action::Copy => {
ctx.copy_selection(ClipboardBuffer::Primary);
ctx.copy_selection(ClipboardType::Primary);
},
Action::Paste => {
Clipboard::new()
.and_then(|clipboard| clipboard.load_primary())
ctx.terminal_mut()
.clipboard()
.load(ClipboardType::Primary)
.map(|contents| self.paste(ctx, &contents))
.unwrap_or_else(|err| {
error!("Error loading data from clipboard: {}", Red(err));
@ -292,8 +293,9 @@ impl Action {
Action::PasteSelection => {
// Only paste if mouse events are not captured by an application
if !mouse_mode {
Clipboard::new()
.and_then(|clipboard| clipboard.load_selection())
ctx.terminal_mut()
.clipboard()
.load(ClipboardType::Secondary)
.map(|contents| self.paste(ctx, &contents))
.unwrap_or_else(|err| {
error!("Error loading data from clipboard: {}", Red(err));
@ -952,9 +954,9 @@ impl<'a, A: ActionContext + 'a> Processor<'a, A> {
/// Copy text selection.
fn copy_selection(&mut self) {
if self.save_to_clipboard {
self.ctx.copy_selection(ClipboardBuffer::Primary);
self.ctx.copy_selection(ClipboardType::Primary);
}
self.ctx.copy_selection(ClipboardBuffer::Selection);
self.ctx.copy_selection(ClipboardType::Secondary);
}
}
@ -965,6 +967,7 @@ mod tests {
use glutin::{ElementState, Event, ModifiersState, MouseButton, VirtualKeyCode, WindowEvent};
use crate::clipboard::{Clipboard, ClipboardType};
use crate::config::{self, ClickHandler, Config};
use crate::event::{ClickState, Mouse, WindowChanges};
use crate::grid::Scroll;
@ -974,7 +977,6 @@ mod tests {
use crate::term::{SizeInfo, Term, TermMode};
use super::{Action, Binding, Processor};
use copypasta::Buffer as ClipboardBuffer;
const KEY: VirtualKeyCode = VirtualKeyCode::Key0;
@ -1004,7 +1006,7 @@ mod tests {
fn simple_selection(&mut self, _point: Point, _side: Side) {}
fn copy_selection(&self, _buffer: ClipboardBuffer) {}
fn copy_selection(&mut self, _: ClipboardType) {}
fn clear_selection(&mut self) {}
@ -1095,7 +1097,7 @@ mod tests {
dpr: 1.0,
};
let mut terminal = Term::new(&config, size, MessageBuffer::new());
let mut terminal = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
let mut mouse = Mouse::default();
mouse.click_state = $initial_state;

View File

@ -30,6 +30,7 @@ extern crate objc;
pub mod macros;
pub mod ansi;
pub mod cli;
pub mod clipboard;
pub mod config;
mod cursor;
pub mod display;

View File

@ -18,7 +18,6 @@ use std::ops::{Index, IndexMut, Range, RangeInclusive};
use std::time::{Duration, Instant};
use std::{io, mem, ptr};
use copypasta::{Clipboard, Load, Store};
use font::{self, RasterizedGlyph, Size};
use glutin::MouseCursor;
use unicode_width::UnicodeWidthChar;
@ -26,6 +25,7 @@ use unicode_width::UnicodeWidthChar;
use crate::ansi::{
self, Attr, CharsetIndex, Color, CursorStyle, Handler, NamedColor, StandardCharset,
};
use crate::clipboard::{Clipboard, ClipboardType};
use crate::config::{Config, VisualBellAnimation};
use crate::cursor;
use crate::grid::{
@ -756,6 +756,9 @@ pub struct Term {
/// Hint that Alacritty should be closed
should_exit: bool,
/// Clipboard access coupled to the active window
clipboard: Clipboard,
}
/// Terminal size info
@ -843,7 +846,12 @@ impl Term {
self.next_mouse_cursor.take()
}
pub fn new(config: &Config, size: SizeInfo, message_buffer: MessageBuffer) -> Term {
pub fn new(
config: &Config,
size: SizeInfo,
message_buffer: MessageBuffer,
clipboard: Clipboard,
) -> Term {
let num_cols = size.cols();
let num_lines = size.lines();
@ -889,6 +897,7 @@ impl Term {
auto_scroll: config.scrolling().auto_scroll,
message_buffer,
should_exit: false,
clipboard,
}
}
@ -1317,6 +1326,10 @@ impl Term {
self.grid.url_highlight = None;
self.dirty = true;
}
pub fn clipboard(&mut self) -> &mut Clipboard {
&mut self.clipboard
}
}
impl ansi::TermInfo for Term {
@ -1835,11 +1848,7 @@ impl ansi::Handler for Term {
/// Set the clipboard
#[inline]
fn set_clipboard(&mut self, string: &str) {
Clipboard::new().and_then(|mut clipboard| clipboard.store_primary(string)).unwrap_or_else(
|err| {
warn!("Error storing selection to clipboard: {}", err);
},
);
self.clipboard.store(ClipboardType::Primary, string);
}
#[inline]
@ -2120,20 +2129,20 @@ impl IndexMut<Column> for TabStops {
#[cfg(test)]
mod tests {
use std::mem;
use font::Size;
use serde_json;
use super::{Cell, SizeInfo, Term};
use crate::term::cell;
use crate::ansi::{self, CharsetIndex, Handler, StandardCharset};
use crate::clipboard::Clipboard;
use crate::config::Config;
use crate::grid::{Grid, Scroll};
use crate::index::{Column, Line, Point, Side};
use crate::input::FONT_SIZE_STEP;
use crate::message_bar::MessageBuffer;
use crate::selection::Selection;
use font::Size;
use std::mem;
use crate::term::{cell, Cell, SizeInfo, Term};
#[test]
fn semantic_selection_works() {
@ -2146,7 +2155,8 @@ mod tests {
padding_y: 0.0,
dpr: 1.0,
};
let mut term = Term::new(&Default::default(), size, MessageBuffer::new());
let mut term =
Term::new(&Default::default(), size, MessageBuffer::new(), Clipboard::new_nop());
let mut grid: Grid<Cell> = Grid::new(Line(3), Column(5), 0, Cell::default());
for i in 0..5 {
for j in 0..2 {
@ -2190,7 +2200,8 @@ mod tests {
padding_y: 0.0,
dpr: 1.0,
};
let mut term = Term::new(&Default::default(), size, MessageBuffer::new());
let mut term =
Term::new(&Default::default(), size, MessageBuffer::new(), Clipboard::new_nop());
let mut grid: Grid<Cell> = Grid::new(Line(1), Column(5), 0, Cell::default());
for i in 0..5 {
grid[Line(0)][Column(i)].c = 'a';
@ -2215,7 +2226,8 @@ mod tests {
padding_y: 0.0,
dpr: 1.0,
};
let mut term = Term::new(&Default::default(), size, MessageBuffer::new());
let mut term =
Term::new(&Default::default(), size, MessageBuffer::new(), Clipboard::new_nop());
let mut grid: Grid<Cell> = Grid::new(Line(3), Column(3), 0, Cell::default());
for l in 0..3 {
if l != 1 {
@ -2259,7 +2271,8 @@ mod tests {
padding_y: 0.0,
dpr: 1.0,
};
let mut term = Term::new(&Default::default(), size, MessageBuffer::new());
let mut term =
Term::new(&Default::default(), size, MessageBuffer::new(), Clipboard::new_nop());
let cursor = Point::new(Line(0), Column(0));
term.configure_charset(CharsetIndex::G0, StandardCharset::SpecialCharacterAndLineDrawing);
term.input('a');
@ -2278,7 +2291,7 @@ mod tests {
dpr: 1.0,
};
let config: Config = Default::default();
let mut term: Term = Term::new(&config, size, MessageBuffer::new());
let mut term: Term = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
term.change_font_size(font_size);
let expected_font_size: Size = config.font().size() + Size::new(font_size);
@ -2307,7 +2320,7 @@ mod tests {
dpr: 1.0,
};
let config: Config = Default::default();
let mut term: Term = Term::new(&config, size, MessageBuffer::new());
let mut term: Term = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
term.change_font_size(-100.0);
@ -2327,7 +2340,7 @@ mod tests {
dpr: 1.0,
};
let config: Config = Default::default();
let mut term: Term = Term::new(&config, size, MessageBuffer::new());
let mut term: Term = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
term.change_font_size(10.0);
term.reset_font_size();
@ -2348,7 +2361,7 @@ mod tests {
dpr: 1.0,
};
let config: Config = Default::default();
let mut term: Term = Term::new(&config, size, MessageBuffer::new());
let mut term: Term = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
// Add one line of scrollback
term.grid.scroll_up(&(Line(0)..Line(1)), Line(1), &Cell::default());
@ -2373,6 +2386,7 @@ mod benches {
use std::mem;
use std::path::Path;
use crate::clipboard::Clipboard;
use crate::config::Config;
use crate::grid::Grid;
use crate::message_bar::MessageBuffer;
@ -2416,7 +2430,7 @@ mod benches {
let config = Config::default();
let mut terminal = Term::new(&config, size, MessageBuffer::new());
let mut terminal = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
mem::swap(&mut terminal.grid, &mut grid);
let metrics = font::Metrics {

View File

@ -148,6 +148,7 @@ mod tests {
use unicode_width::UnicodeWidthChar;
use crate::clipboard::Clipboard;
use crate::grid::Grid;
use crate::index::{Column, Line, Point};
use crate::message_bar::MessageBuffer;
@ -166,7 +167,8 @@ mod tests {
};
let width = input.chars().map(|c| if c.width() == Some(2) { 2 } else { 1 }).sum();
let mut term = Term::new(&Default::default(), size, MessageBuffer::new());
let mut term =
Term::new(&Default::default(), size, MessageBuffer::new(), Clipboard::new_nop());
let mut grid: Grid<Cell> = Grid::new(Line(1), Column(width), 0, Cell::default());
let mut i = 0;

View File

@ -12,12 +12,15 @@
// See the License for the specific language governing permissions and
// limitations under the License.
use std::convert::From;
use std::ffi::c_void;
use std::fmt::Display;
use crate::gl;
use glutin::dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize};
#[cfg(target_os = "macos")]
use glutin::os::macos::WindowExt;
#[cfg(not(any(target_os = "macos", windows)))]
use glutin::os::unix::EventsLoopExt;
use glutin::os::unix::{EventsLoopExt, WindowExt};
#[cfg(not(target_os = "macos"))]
use glutin::Icon;
use glutin::{
@ -362,13 +365,11 @@ impl Window {
target_os = "openbsd"
))]
pub fn set_urgent(&self, is_urgent: bool) {
use glutin::os::unix::WindowExt;
self.window().set_urgent(is_urgent);
}
#[cfg(target_os = "macos")]
pub fn set_urgent(&self, is_urgent: bool) {
use glutin::os::macos::WindowExt;
self.window().request_user_attention(is_urgent);
}
@ -381,8 +382,6 @@ impl Window {
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
pub fn get_window_id(&self) -> Option<usize> {
use glutin::os::unix::WindowExt;
match self.window().get_xlib_window() {
Some(xlib_window) => Some(xlib_window as usize),
None => None,
@ -416,6 +415,11 @@ impl Window {
self.window().set_simple_fullscreen(fullscreen);
}
#[cfg(not(any(target_os = "macos", target_os = "windows")))]
pub fn get_wayland_display(&self) -> Option<*mut c_void> {
self.window().get_wayland_display()
}
fn window(&self) -> &glutin::Window {
self.windowed_context.window()
}
@ -441,7 +445,6 @@ impl OsExtensions for Window {}
))]
impl OsExtensions for Window {
fn run_os_extensions(&self) {
use glutin::os::unix::WindowExt;
use libc::getpid;
use std::ffi::CStr;
use std::ptr;

View File

@ -7,6 +7,7 @@ use std::io::{self, Read};
use std::path::Path;
use alacritty_terminal::ansi;
use alacritty_terminal::clipboard::Clipboard;
use alacritty_terminal::config::Config;
use alacritty_terminal::index::Column;
use alacritty_terminal::message_bar::MessageBuffer;
@ -92,7 +93,7 @@ fn ref_test(dir: &Path) {
let mut config: Config = Default::default();
config.set_history(ref_config.history_size);
let mut terminal = Term::new(&config, size, MessageBuffer::new());
let mut terminal = Term::new(&config, size, MessageBuffer::new(), Clipboard::new_nop());
let mut parser = ansi::Processor::new();
for byte in recording {

View File

@ -1,17 +0,0 @@
[package]
name = "copypasta"
version = "0.0.1"
authors = ["Joe Wilm <joe@jwilm.com>"]
license = "Apache-2.0"
description = "Forthcoming clipboard library"
keywords = ["clipboard", "copy", "paste"]
[dependencies]
[target.'cfg(target_os = "macos")'.dependencies]
objc = "0.2"
objc_id = "0.1"
objc-foundation = "0.1"
[target.'cfg(windows)'.dependencies]
clipboard = "0.5.0"

View File

@ -1,201 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2016 Joe Wilm, The Alacritty Project Contributors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -1,88 +0,0 @@
//! A cross-platform clipboard library
#![deny(clippy::all, clippy::if_not_else, clippy::enum_glob_use, clippy::wrong_pub_self_convention)]
// This has to be here due to macro_use
#[cfg(target_os = "macos")]
#[macro_use]
extern crate objc;
#[cfg(windows)]
extern crate clipboard;
/// An enumeration describing available clipboard buffers
pub enum Buffer {
Primary,
Selection,
}
/// Types that can get the system clipboard contents
pub trait Load: Sized {
/// Errors encountered when working with a clipboard. Each implementation is
/// allowed to define its own error type, but it must conform to std error.
type Err: ::std::error::Error + Send + Sync + 'static;
/// Create a clipboard
fn new() -> Result<Self, Self::Err>;
/// Get the primary clipboard contents.
fn load_primary(&self) -> Result<String, Self::Err>;
/// Get the clipboard selection contents.
///
/// On most platforms, this doesn't mean anything. A default implementation
/// is provided which uses the primary clipboard.
#[inline]
fn load_selection(&self) -> Result<String, Self::Err> {
self.load_primary()
}
fn load(&self, buffer: Buffer) -> Result<String, Self::Err> {
match buffer {
Buffer::Selection => self.load_selection(),
Buffer::Primary => self.load_primary(),
}
}
}
/// Types that can set the system clipboard contents
///
/// Note that some platforms require the clipboard context to stay active in
/// order to load the contents from other applications.
pub trait Store: Load {
/// Sets the primary clipboard contents
fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>;
/// Sets the secondary clipboard contents
fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>;
/// Store into the specified `buffer`.
fn store<S>(&mut self, contents: S, buffer: Buffer) -> Result<(), Self::Err>
where
S: Into<String>,
{
match buffer {
Buffer::Selection => self.store_selection(contents),
Buffer::Primary => self.store_primary(contents),
}
}
}
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
mod x11;
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
pub use x11::{Clipboard, Error};
#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "macos")]
pub use macos::{Clipboard, Error};
#[cfg(windows)]
mod windows;
#[cfg(windows)]
pub use crate::windows::{Clipboard, Error};

View File

@ -1,329 +0,0 @@
//! Clipboard access on macOS
//!
//! Implemented according to
//! https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PasteboardGuide106/Articles/pbReading.html#//apple_ref/doc/uid/TP40008123-SW1
mod ns {
extern crate objc_foundation;
extern crate objc_id;
#[link(name = "AppKit", kind = "framework")]
extern "C" {}
use std::mem;
use self::objc_foundation::{INSArray, INSObject, INSString};
use self::objc_foundation::{NSArray, NSDictionary, NSObject, NSString};
use self::objc_id::{Id, Owned};
use objc::runtime::{Class, Object};
/// Rust API for NSPasteboard
pub struct Pasteboard(Id<Object>);
/// Errors occurring when creating a Pasteboard
#[derive(Debug)]
pub enum NewPasteboardError {
GetPasteboardClass,
LoadGeneralPasteboard,
}
/// Errors occurring when reading a string from the pasteboard
#[derive(Debug)]
pub enum ReadStringError {
GetStringClass,
ReadObjectsForClasses,
}
/// Errors from writing strings to the pasteboard
#[derive(Debug)]
pub struct WriteStringError;
/// A trait for reading contents from the pasteboard
///
/// This is intended to reflect the underlying objective C API
/// `readObjectsForClasses:options:`.
pub trait PasteboardReadObject<T> {
type Err;
fn read_object(&self) -> Result<T, Self::Err>;
}
/// A trait for writing contents to the pasteboard
pub trait PasteboardWriteObject<T> {
type Err;
fn write_object(&mut self, T) -> Result<(), Self::Err>;
}
impl PasteboardReadObject<String> for Pasteboard {
type Err = ReadStringError;
fn read_object(&self) -> Result<String, ReadStringError> {
// Get string class; need this for passing to readObjectsForClasses
let ns_string_class = match Class::get("NSString") {
Some(class) => class,
None => return Err(ReadStringError::GetStringClass),
};
let ns_string: Id<Object> = unsafe {
let ptr: *mut Object = msg_send![ns_string_class, class];
if ptr.is_null() {
return Err(ReadStringError::GetStringClass);
} else {
Id::from_ptr(ptr)
}
};
let classes: Id<NSArray<NSObject, Owned>> = unsafe {
// I think this transmute is valid. It's going from an
// Id<Object> to an Id<NSObject>. From transmute's perspective,
// the only thing that matters is that they both have the same
// size (they do for now since the generic is phantom data). In
// both cases, the underlying pointer is an id (from `[NSString
// class]`), so again, this should be valid. There's just
// nothing implemented in objc_id or objc_foundation to do this
// "safely". By the way, the only reason this is necessary is
// because INSObject isn't implemented for Id<Object>.
//
// And if that argument isn't convincing, my final reasoning is
// that "it seems to work".
NSArray::from_vec(vec![mem::transmute(ns_string)])
};
// No options
//
// Apparently this doesn't compile without a type hint, so it maps
// objects to objects!
let options: Id<NSDictionary<NSObject, NSObject>> = NSDictionary::new();
// call [pasteboard readObjectsForClasses:options:]
let copied_items = unsafe {
let copied_items: *mut NSArray<NSString> = msg_send![
self.0,
readObjectsForClasses:&*classes
options:&*options
];
if copied_items.is_null() {
return Err(ReadStringError::ReadObjectsForClasses);
} else {
Id::from_ptr(copied_items) as Id<NSArray<NSString>>
}
};
// Ok, this is great. We have an NSArray<NSString>, and these have
// decent bindings. Use the first item returned (if an item was
// returned) or just return an empty string
//
// XXX Should this return an error if no items were returned?
let contents = copied_items
.first_object()
.map(|ns_string| ns_string.as_str().to_owned())
.unwrap_or_else(String::new);
Ok(contents)
}
}
impl PasteboardWriteObject<String> for Pasteboard {
type Err = WriteStringError;
fn write_object(&mut self, object: String) -> Result<(), Self::Err> {
let objects = NSArray::from_vec(vec![NSString::from_str(&object)]);
self.clear_contents();
// The writeObjects method returns true in case of success, and
// false otherwise.
let ok: bool = unsafe { msg_send![self.0, writeObjects: objects] };
if ok {
Ok(())
} else {
Err(WriteStringError)
}
}
}
impl ::std::error::Error for WriteStringError {
fn description(&self) -> &str {
"Failed writing string to the NSPasteboard (writeContents returned false)"
}
}
impl ::std::fmt::Display for WriteStringError {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
f.write_str(::std::error::Error::description(self))
}
}
impl ::std::error::Error for ReadStringError {
fn description(&self) -> &str {
match *self {
ReadStringError::GetStringClass => "NSString class not found",
ReadStringError::ReadObjectsForClasses => "readObjectsForClasses:options: failed",
}
}
}
impl ::std::fmt::Display for ReadStringError {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
f.write_str(::std::error::Error::description(self))
}
}
impl ::std::error::Error for NewPasteboardError {
fn description(&self) -> &str {
match *self {
NewPasteboardError::GetPasteboardClass => "NSPasteboard class not found",
NewPasteboardError::LoadGeneralPasteboard => {
"[NSPasteboard generalPasteboard] failed"
},
}
}
}
impl ::std::fmt::Display for NewPasteboardError {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
f.write_str(::std::error::Error::description(self))
}
}
impl Pasteboard {
pub fn new() -> Result<Pasteboard, NewPasteboardError> {
// NSPasteboard *pasteboard = [NSPasteboard generalPasteboard];
let ns_pasteboard_class = match Class::get("NSPasteboard") {
Some(class) => class,
None => return Err(NewPasteboardError::GetPasteboardClass),
};
let ptr = unsafe {
let ptr: *mut Object = msg_send![ns_pasteboard_class, generalPasteboard];
if ptr.is_null() {
return Err(NewPasteboardError::LoadGeneralPasteboard);
} else {
ptr
}
};
let id = unsafe { Id::from_ptr(ptr) };
Ok(Pasteboard(id))
}
/// Clears the existing contents of the pasteboard, preparing it for new
/// contents.
///
/// This is the first step in providing data on the pasteboard. The
/// return value is the change count of the pasteboard
pub fn clear_contents(&mut self) -> usize {
unsafe { msg_send![self.0, clearContents] }
}
}
}
#[derive(Debug)]
pub enum Error {
CreatePasteboard(ns::NewPasteboardError),
ReadString(ns::ReadStringError),
WriteString(ns::WriteStringError),
}
impl ::std::error::Error for Error {
fn cause(&self) -> Option<&::std::error::Error> {
match *self {
Error::CreatePasteboard(ref err) => Some(err),
Error::ReadString(ref err) => Some(err),
Error::WriteString(ref err) => Some(err),
}
}
fn description(&self) -> &str {
match *self {
Error::CreatePasteboard(ref _err) => "Failed to create pasteboard",
Error::ReadString(ref _err) => "Failed to read string from pasteboard",
Error::WriteString(ref _err) => "Failed to write string to pasteboard",
}
}
}
impl ::std::fmt::Display for Error {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match *self {
Error::CreatePasteboard(ref err) => write!(f, "Failed to create pasteboard: {}", err),
Error::ReadString(ref err) => {
write!(f, "Failed to read string from pasteboard: {}", err)
},
Error::WriteString(ref err) => {
write!(f, "Failed to write string to pasteboard: {}", err)
},
}
}
}
impl From<ns::NewPasteboardError> for Error {
fn from(val: ns::NewPasteboardError) -> Error {
Error::CreatePasteboard(val)
}
}
impl From<ns::ReadStringError> for Error {
fn from(val: ns::ReadStringError) -> Error {
Error::ReadString(val)
}
}
impl From<ns::WriteStringError> for Error {
fn from(val: ns::WriteStringError) -> Error {
Error::WriteString(val)
}
}
pub struct Clipboard(ns::Pasteboard);
impl super::Load for Clipboard {
type Err = Error;
fn new() -> Result<Self, Error> {
Ok(Clipboard(ns::Pasteboard::new()?))
}
fn load_primary(&self) -> Result<String, Self::Err> {
use self::ns::PasteboardReadObject;
self.0.read_object().map_err(::std::convert::From::from)
}
}
impl super::Store for Clipboard {
fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
use self::ns::PasteboardWriteObject;
self.0.write_object(contents.into()).map_err(::std::convert::From::from)
}
fn store_selection<S>(&mut self, _contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
// No such thing on macOS
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::Clipboard;
use {Load, Store};
#[test]
fn create_clipboard_save_load_contents() {
let mut clipboard = Clipboard::new().unwrap();
clipboard.store_primary("arst").unwrap();
let loaded = clipboard.load_primary().unwrap();
assert_eq!("arst", loaded);
}
}

View File

@ -1,64 +0,0 @@
use clipboard::ClipboardContext;
use clipboard::ClipboardProvider;
use super::{Load, Store};
pub struct Clipboard(ClipboardContext);
#[derive(Debug)]
pub enum Error {
Clipboard(Box<::std::error::Error>),
}
impl ::std::error::Error for Error {
fn description(&self) -> &str {
match *self {
Error::Clipboard(..) => "Error opening clipboard",
}
}
}
impl ::std::fmt::Display for Error {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match *self {
Error::Clipboard(ref err) => err.fmt(f),
}
}
}
unsafe impl Send for Error {}
unsafe impl Sync for Error {}
impl Load for Clipboard {
type Err = Error;
fn new() -> Result<Self, Error> {
ClipboardContext::new().map(Clipboard).map_err(Error::Clipboard)
}
fn load_primary(&self) -> Result<String, Self::Err> {
let mut ctx: ClipboardContext = ClipboardProvider::new().unwrap();
ctx.get_contents().map_err(Error::Clipboard)
}
}
impl Store for Clipboard {
/// Sets the primary clipboard contents
#[inline]
fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
self.0.set_contents(contents.into()).map_err(Error::Clipboard)
}
/// Sets the secondary clipboard contents
#[inline]
fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
// No such thing on Windows
Ok(())
}
}

View File

@ -1,144 +0,0 @@
//! X11 Clipboard implementation
//!
//! Note that the x11 implementation is really crap right now - we just depend
//! on xclip being on the user's path. If x11 pasting doesn't work, it's
//! probably because xclip is unavailable. There's currently no non-GPL x11
//! clipboard library for Rust. Until then, we have this hack.
//!
//! FIXME: Implement actual X11 clipboard API using the ICCCM reference
//! https://tronche.com/gui/x/icccm/
use std::ffi::OsStr;
use std::io;
use std::process::{Command, Output};
use std::string::FromUtf8Error;
use super::{Load, Store};
/// The x11 clipboard
pub struct Clipboard;
#[derive(Debug)]
pub enum Error {
Io(io::Error),
Xclip(String),
Utf8(FromUtf8Error),
}
impl ::std::error::Error for Error {
fn cause(&self) -> Option<&::std::error::Error> {
match *self {
Error::Io(ref err) => Some(err),
Error::Utf8(ref err) => Some(err),
_ => None,
}
}
fn description(&self) -> &str {
match *self {
Error::Io(..) => "Error calling xclip",
Error::Xclip(..) => "Error reported by xclip",
Error::Utf8(..) => "Clipboard contents not utf8",
}
}
}
impl ::std::fmt::Display for Error {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match *self {
Error::Io(ref err) => match err.kind() {
io::ErrorKind::NotFound => {
write!(f, "Please install `xclip` to enable clipboard support")
},
_ => write!(f, "Error calling xclip: {}", err),
},
Error::Xclip(ref s) => write!(f, "Error from xclip: {}", s),
Error::Utf8(ref err) => write!(f, "Error parsing xclip output: {}", err),
}
}
}
impl From<io::Error> for Error {
fn from(val: io::Error) -> Error {
Error::Io(val)
}
}
impl From<FromUtf8Error> for Error {
fn from(val: FromUtf8Error) -> Error {
Error::Utf8(val)
}
}
impl Load for Clipboard {
type Err = Error;
fn new() -> Result<Self, Error> {
Ok(Clipboard)
}
fn load_primary(&self) -> Result<String, Self::Err> {
let output = Command::new("xclip").args(&["-o", "-selection", "clipboard"]).output()?;
Clipboard::process_xclip_output(output)
}
fn load_selection(&self) -> Result<String, Self::Err> {
let output = Command::new("xclip").args(&["-o"]).output()?;
Clipboard::process_xclip_output(output)
}
}
impl Store for Clipboard {
/// Sets the primary clipboard contents
#[inline]
fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
self.store(contents, &["-i", "-selection", "clipboard"])
}
/// Sets the secondary clipboard contents
#[inline]
fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
where
S: Into<String>,
{
self.store(contents, &["-i"])
}
}
impl Clipboard {
fn process_xclip_output(output: Output) -> Result<String, Error> {
if output.status.success() {
String::from_utf8(output.stdout).map_err(::std::convert::From::from)
} else {
String::from_utf8(output.stderr).map_err(::std::convert::From::from)
}
}
fn store<C, S>(&mut self, contents: C, args: &[S]) -> Result<(), Error>
where
C: Into<String>,
S: AsRef<OsStr>,
{
use std::io::Write;
use std::process::Stdio;
let contents = contents.into();
let mut child = Command::new("xclip").args(args).stdin(Stdio::piped()).spawn()?;
if let Some(stdin) = child.stdin.as_mut() {
stdin.write_all(contents.as_bytes())?;
}
// Return error if didn't exit cleanly
let exit_status = child.wait()?;
if exit_status.success() {
Ok(())
} else {
Err(Error::Xclip("xclip returned non-zero exit code".into()))
}
}
}

View File

@ -19,7 +19,6 @@ parts:
alacritty:
plugin: rust
source: .
stage-packages: [xclip]
build-packages: [libfreetype6-dev, libfontconfig1-dev, cmake]
desktop:
plugin: dump