Package limn.backend.lwjgl.transfer

Class X11Clipboard

java.lang.Object

limn.backend.lwjgl.transfer.X11Clipboard

All Implemented Interfaces:

NativeClipboard

public final class X11Clipboard
extends Object
implements NativeClipboard

The X11 clipboard: the CLIPBOARD selection, owned and converted by a hidden window on a connection of our own.

A second connection, and one thread that makes every call on it. GLFW's connection is GLFW's: its event loop reads every event on it, the selection events included, and hands none on. Ours has a thread that waits on the connection and on a pipe that wakes it; the UI thread only queues work and writes a byte. No two threads ever touch one display, so nothing here depends on XInitThreads having been the first Xlib call of the process, which it was not.

What does not fit one request crosses by INCR, both ways. XFixes tells of a new owner, which is when the types are asked for again, so types() never has to ask.

An X error on our display (a requestor that closed mid-transfer) is ignored; one on any other display goes to the handler that was there, as before.

Constructor Summary

Constructors

Constructor	Description
X11Clipboard()

Method Summary

Modifier and Type	Method	Description
void	close()	Lets go of the system's resources.
X11Drag	drags(UiRuntime ui)	The drags of this connection, made the first time a window asks.
boolean	isOwner()
void	offer(List<String> types, Function<String,byte[]> bytes)	Makes this process the clipboard's owner.
Runnable	pinches(long xwindow, Supplier<WindowInput> input, DoubleUnaryOperator toLogical, UiRuntime ui)	Sends the pinches over one of this program's windows to its input, read on this connection.
CompletableFuture<byte[]>	read(String type)	Asks for the bytes of one type.
void	setChangeListener(Runnable listener)
List<String>	types()	The types on the clipboard as the system last reported them, without asking it again.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface limn.backend.lwjgl.transfer.NativeClipboard

madeAhead

Constructor Details

X11Clipboard

public X11Clipboard()

Throws:

RuntimeException - when Xlib or XFixes is absent, or no display opens; the caller then keeps GLFW's text clipboard

Method Details

isOwner

public boolean isOwner()

Specified by:

isOwner in interface NativeClipboard

Returns:

whether what the clipboard holds was put there by the last NativeClipboard.offer(java.util.List<java.lang.String>, java.util.function.Function<java.lang.String, byte[]>) of this process and has not been replaced since

types

public List<String> types()

Description copied from interface: NativeClipboard

The types on the clipboard as the system last reported them, without asking it again.

Specified by:

types in interface NativeClipboard

Returns:

canonical type names, best first; empty when the clipboard is empty or unknown

read

public CompletableFuture<byte[]> read(String type)

Description copied from interface: NativeClipboard

Asks for the bytes of one type.

Specified by:

read in interface NativeClipboard

Parameters:

type - one of NativeClipboard.types()

Returns:

the bytes, completed on whatever thread the implementation reads on; completed exceptionally when the type is not, or no longer, there

drags

public X11Drag drags(UiRuntime ui)

The drags of this connection, made the first time a window asks. Any thread.

Parameters:

ui - the UI runtime

Returns:

what speaks XDND for this program's windows

pinches

public Runnable pinches(long xwindow,
 Supplier<WindowInput> input,
 DoubleUnaryOperator toLogical,
 UiRuntime ui)

Sends the pinches over one of this program's windows to its input, read on this connection. Any thread.

Returns:

what forgets the window

offer

public void offer(List<String> types,
 Function<String,byte[]> bytes)

Description copied from interface: NativeClipboard

Makes this process the clipboard's owner.

Specified by:

offer in interface NativeClipboard

Parameters:

types - what is offered, best first; empty empties the clipboard

bytes - the bytes of one of those types, asked for when a program wants them; it may be called on any thread and may block, and answers null for what it cannot make

setChangeListener

public void setChangeListener(Runnable listener)

Specified by:

setChangeListener in interface NativeClipboard

Parameters:

listener - called, on any thread, after the clipboard's types or its owner change, an NativeClipboard.offer(java.util.List<java.lang.String>, java.util.function.Function<java.lang.String, byte[]>) of this process included; replaces the one before

close

public void close()

Description copied from interface: NativeClipboard

Lets go of the system's resources. The clipboard is not used afterwards.

Specified by:

close in interface NativeClipboard