snmsts/trivial-clipboard

trivial-clipboard

trivial-clipboard let access system clipboard.

Installation

(ql:quickload :trivial-clipboard)

Dependencies

• CFFI (only on Windows)

Usage

get text from clipboard.

(trivial-clipboard:text)

put text to clipboard.

(trivial-clipboard:text "put text!")

Author

SANO Masatoshi ([email protected])

Project

• https://github.com/snmsts/trivial-clipboard

License

Licensed under the MIT License.

trivial-clipboard's Issues

The test tries to put a string containing null characters, which at least on Windows cannot work

The test extra-set when i is zero passes a string containing null characters, but at least on windows a null character terminate the string, so it doesn't work.

https://docs.microsoft.com/en-us/windows/win32/dataxchg/standard-clipboard-formats

Support wayland

We could use wl-copy to support Wayland.
See atlas-engineer/nyxt#924.

support windows.

Don't Rely on XClip

xclip is not necessarily installed on every Linux system that uses X. It would probably be a better idea to do whatever it does in Lisp natively using clx.

Resolve commands at runtime instead of compile time

We have

(defvar *clipboard-in-command*
  #+(or darwin macosx)
  "pbcopy"
  #+(and :unix (:not :darwin))
  (or (executable-find "wl-copy")
      (executable-find "xclip")
      (executable-find "xsel")
      ""))

so when packaging a Lisp binary the commands are derived at compile time, which means the target machine needs to have the command at the same path. It's not practical for packagers, see atlas-engineer/nyxt#984 (comment).

Instead, I suggest making one defvar for each executable (wl-copy, xclip, etc.) and then a function which derives the command to use at run time.

Something like this (untested):

(defvar *in-commands* (append
                       #+(or darwin macosx) (list "pbcopy")
                       #+(and :unix (:not :darwin))
                       (list "wl-copy" "xclip" "xsel")))

(defun clipboard-in ()
  (some #'executable-find *in-commands*))

(defvar clipboard-in-args ()
  (progn
    '()
    #+ (and :unix (:not :darwin))
    (or (and (string= (pathname-name (clipboard-in-command)) "wl-copy")
             '())
        (and (string= (pathname-name (clipboard-in-command)) "xclip")
             '("-in" "-selection" "clipboard"))
        (and (string= (pathname-name (clipboard-in-command)) "xsel")
             '("--input" "--clipboard")))))

(defun text (&optional data)
  "If DATA is STRING, it is set to the clipboard. An ERROR is
signalled if the copy failed.

If DATA is NIL, TEXT returns the STRING from the clipboard. If the
copy failed, it returns NIL instead."
  (etypecase data
    (string
     #+os-windows
     (set-text-on-win32 data)
     #+(not os-windows)
     (with-input-from-string (input data)
       (uiop:run-program (cons (clipboard-in) (clipboard-in-args))
                         :input input))
     data)
    (null
     ;; ...
     )))

It would be a good opportunity to structure the code so that args are semantically bound to the command. But this probably belongs to a second commit.

Thoughts?

Wrong copy/paste command chosen on some systems

Hi,

I found a case where the command finding mechanism is not general enough. I use Fedora, where you can have both Wayland and X, and you choose which one to use when logging in. This lead to a case where I can use X, but wl-copy still exists. Therefore, when evaluating (trivial-clipboard:text "some text") using X, I get an error because:

• trivial-clipboard:find-copy-command finds wl-copy first
• wl-copy fails afterwards (which makes sense since Wayland is not started)

So relying on whether or not the command exists does not seem to handle all case. Maybe selecting a command should be done based on if it returns an error code or not ? In this case, wl-copy should be tried and, because it returns an error code, xclip should be selected instead. Let me know your thoughts on the issue. Happy to submit a PR if you're interested.

Find the right clipboard commands

#17 was a major improvement on the goal of setting the right clipboard command. I found out that it may be the case that a user is using X11 but XDG_SESSION_TYPE is set to tty instead of x11. I suggest to fallback on xclip or xsel if they're found regardless of the value of XDG_SESSION_TYPE. In other words, check XDG_SESSION_TYPE for Wayland exclusively.

@aartaka you run StumpWM, correct? What's the output of env | grep XDG_SESSION_TYPE?

Using an undefined variable

Hi!

After recompiling this package i have found a warning printed by SBCL:

warning: undefined variable: TRIVIAL-CLIPBOARD::DATA

coming from this form:

https://github.com/snmsts/trivial-clipboard/blob/master/src/text.lisp#L98

I have not checked the code but i think data supposed to be changed to value

Hope this helps! :)

Bye!
C.