Copycat

Basic clipboard access in your Java applications!

---

Usage

Repository

Groovy (.gradle)

maven {
    name = "Deftu Releases"
    url = "https://maven.deftu.dev/releases"
}

Kotlin (.gradle.kts)

maven(url = "https://maven.deftu.dev/releases") {
    name = "Deftu Releases"
}

Dependency

Groovy (.gradle)

implementation "dev.deftu:copycat:<VERSION>"
[
    "windows-x64",
    "windows-x86",
    "linux-x64",
    "linux-x86",
    "linux-arm",
    "linux-arm64",
    "osx-x64",
    "osx-arm64"
].forEach { target ->
    runtimeOnly "dev.deftu:copycat-natives-$target:<VERSION>"
}

Kotlin (.gradle.kts)

implementation("dev.deftu:copycat:<VERSION>")
listOf(
    "windows-x64",
    "windows-x86",
    "linux-x64",
    "linux-x86",
    "linux-arm",
    "linux-arm64",
    "os-x-x64",
    "os-x-arm64"
).forEach { target ->
    runtimeOnly("dev.deftu:copycat-natives-$target:<VERSION>")
}

Operating system & architecture support

• Windows x64
• Windows x86
• Linux x64
• Linux x86
• Linux ARM (Android)
• Linux ARM64 (Android)
• macOS x64 (Intel)
• macOS ARM64 (Apple Silicon)

macOS is not supported at this time due to the inability to build the native library.

Interacting with the clipboard

A user-facing API is provided via dev.deftu.clipboard.Clipboard, pointing to the native methods provided by the native library by default.

import dev.deftu.clipboard.Clipboard;

public class Main {
    public static void main(String[] args) {
        Clipboard clipboard = Clipboard.getInstance();
        clipboard.setString("Hello, world!");
        System.out.println(clipboard.getString());
    }
}

Native loading

By default, when a Clipboard instance is created, it will make an attempt to load the default native library provided by Copycat. If you'd rather load the natives later, or provide your own, you can do so by marking the native as loaded using Clipboard#markNativeLoaded().

import dev.deftu.clipboard.Clipboard;

public class Main {
    public static void main(String[] args) {
        Clipboard.markNativeLoaded();
        Clipboard clipboard = Clipboard.getInstance();
        clipboard.setString("Hello, world!"); // Throws an UnsatisfiedLinkError! There are no natives loaded.
        System.out.println(clipboard.getString());
    }
}

Custom natives

If you'd like to provide your own natives, you can do so by using the Clipboard#loadAndMarkNative(String) method. Alternatively, you can separately use the Clipboard#loadNative(String) method to load the native without marking it as loaded and then use Clipboard#markNativeLoaded() to mark it as loaded.

import dev.deftu.clipboard.Clipboard;

public class Main {
    public static void main(String[] args) {
        Clipboard.loadAndMarkNative("path/to/native");
        Clipboard clipboard = Clipboard.getInstance();
        clipboard.setString("Hello, world!");
        System.out.println(clipboard.getString());
    }
}

OR

import dev.deftu.clipboard.Clipboard;

public class Main {
    public static void main(String[] args) {
        Clipboard.loadNative("path/to/native");
        Clipboard.markNativeLoaded();
        Clipboard clipboard = Clipboard.getInstance();
        clipboard.setString("Hello, world!");
        System.out.println(clipboard.getString());
    }
}

Working with images

Copycat provides a way to interact with images on the clipboard. This is done through the dev.deftu.clipboard.ClipboardImage class.

import dev.deftu.clipboard.Clipboard;
import dev.deftu.clipboard.ClipboardImage;

public class Main {
    public static void main(String[] args) {
        Clipboard clipboard = Clipboard.getInstance();
        ClipboardImage image = clipboard.getImage();
        System.out.println(image.getWidth() + "x" + image.getHeight());
    }
}

To keep the library agnostic of image libraries, the image is represented simply as a byte array, width and height.

AWT BufferedImage support

If you're using AWT's BufferedImage, Copycat provides an extension library to convert between BufferedImage and ClipboardImage.

Groovy (.gradle)

implementation "dev.deftu:copycat-image-awt:<VERSION>"

Kotlin (.gradle.kts)

implementation("dev.deftu:copycat-image-awt:<VERSION>")

import dev.deftu.clipboard.Clipboard;
import dev.deftu.clipboard.ClipboardImage;
import dev.deftu.clipboard.BufferedClipboardImage;

import java.awt.image.BufferedImage;
import javax.imageio.ImageIO;

public class Main {
    public static void main(String[] args) {
        Clipboard clipboard = Clipboard.getInstance();
        ClipboardImage image = clipboard.getImage();
        
        BufferedImage bufferedImage = BufferedClipboardImage.toBufferedImage(image);
        ClipboardImage clipboardImage = BufferedClipboardImage.toClipboardImage(bufferedImage);
        
        System.out.println(bufferedImage.getWidth() + "x" + bufferedImage.getHeight());
        
        try {
            ImageIO.write(bufferedImage, "png", new File("image.png"));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

---

This project is licensed under LGPL-3.0
© 2024 Deftu