Improve the Hyprland support

Author: xyproto

backend.go

@@ -7,6 +7,7 @@ package wallutils
 // Some backends may require cgo (sway + x11)
 var WMs = []WM{
 	&Hyprpaper{},
+	//&Hyprctl{},
 	&Sway{},
 	&Deepin{},
 	&Xfce4{},

backend_nocgo.go

@@ -7,6 +7,7 @@ package wallutils
 // Only backends that do not require cgo should be included here.
 var WMs = []WM{
 	&Hyprpaper{},
+	//&Hyprctl{},
 	//&Sway{},
 	&Deepin{},
 	&Xfce4{},

hyprctl.go

@@ -0,0 +1,70 @@
+package wallutils
+
+import (
+	"fmt"
+
+	"github.com/xyproto/env/v2"
+)
+
+// Hyprctl compatible windowmanager
+type Hyprctl struct {
+	mode    string
+	verbose bool
+}
+
+// Name returns the name of this window manager or desktop environment
+func (h *Hyprctl) Name() string {
+	return "Hyprctl"
+}
+
+// ExecutablesExists checks if executables associated with this backend exists in the PATH
+func (h *Hyprctl) ExecutablesExists() bool {
+	return which("hyprctl") != "" && which("hyprpaper") != ""
+}
+
+// Running examines environment variables to try to figure out if this backend is currently running.
+func (h *Hyprctl) Running() bool {
+	return env.Contains("XDG_SESSION_DESKTOP", "Hyprland") || env.Contains("DESKTOP_SESSION", "hyprland")
+}
+
+// SetMode will set the current way to display the wallpaper (stretched, tiled etc)
+func (h *Hyprctl) SetMode(mode string) {
+	h.mode = mode
+}
+
+// SetVerbose can be used for setting the verbose field to true or false.
+// This will cause this backend to output information about what is is doing on stdout.
+func (h *Hyprctl) SetVerbose(verbose bool) {
+	h.verbose = verbose
+}
+
+// SetWallpaper sets the desktop wallpaper, given an image filename.
+// The image must exist and be readable.
+func (h *Hyprctl) SetWallpaper(imageFilename string) error {
+	if !exists(imageFilename) {
+		return fmt.Errorf("no such file: %s", imageFilename)
+	}
+
+	// Set the wallpaper mode
+	mode := defaultMode
+	if h.mode != "" {
+		mode = h.mode
+	}
+
+	switch mode {
+	case "stretched", "center", "fill", "fit", "scale", "scaled", "stretch", "tile", "zoom", "zoomed":
+		mode = ""
+	default:
+		// Invalid and unrecognized desktop wallpaper mode
+		return fmt.Errorf("invalid desktop wallpaper mode for swaybg: %s", mode)
+	}
+
+	// preload the wallpaper image using hyprctl
+	err := run("hyprctl", []string{"hyprpaper", "preload", imageFilename}, h.verbose)
+	if err != nil {
+		return err
+	}
+
+	// reload the wallpaper image using hyprctl
+	return run("hyprctl", []string{"hyprpaper", "reload", ",\"" + imageFilename + "\""}, h.verbose)
+}

hyprpaper.go

@@ -17,19 +17,19 @@ type Hyprpaper struct {
 }
 
 // Name returns the name of this window manager or desktop environment
-func (sb *Hyprpaper) Name() string {
+func (hp *Hyprpaper) Name() string {
 	return "Hyprpaper"
 }
 
 // ExecutablesExists checks if executables associated with this backend exists in the PATH
-func (sb *Hyprpaper) ExecutablesExists() bool {
+func (hp *Hyprpaper) ExecutablesExists() bool {
 	return which("hyprpaper") != "" // && which("hyprctl") != ""
 }
 
 // Running examines environment variables to try to figure out if this backend is currently running.
-// Also sets sb.sock to an empty string or to a UNIX socket file.
-func (sb *Hyprpaper) Running() bool {
-	sb.sock = ""
+// Also sets hp.sock to an empty string or to a UNIX socket file.
+func (hp *Hyprpaper) Running() bool {
+	hp.sock = ""
 
 	inst := env.Str("HYPRLAND_INSTANCE_SIGNATURE")
 	if inst == "" {
@@ -42,38 +42,38 @@ func (sb *Hyprpaper) Running() bool {
 	}
 
 	if sock := path.Join("/run/user/" + currentUser.Uid + "/hypr/" + inst + "/.hyprpaper.sock"); exists(sock) {
-		sb.sock = sock
+		hp.sock = sock
 		return true
 	}
 
 	if sock := path.Join("/tmp/hypr", inst, ".hyprpaper.sock"); exists(sock) {
-		sb.sock = sock
+		hp.sock = sock
 		return true
 	}
 
-	return false // env.Contains("XDG_SESSION_DESKTOP", "Hyprland") || env.Contains("DESKTOP_SESSION", "hyprland")
+	return false
 }
 
 // SetMode will set the current way to display the wallpaper (stretched, tiled etc)
-func (sb *Hyprpaper) SetMode(mode string) {
-	sb.mode = mode
+func (hp *Hyprpaper) SetMode(mode string) {
+	hp.mode = mode
 }
 
 // SetVerbose can be used for setting the verbose field to true or false.
 // This will cause this backend to output information about what is is doing on stdout.
-func (sb *Hyprpaper) SetVerbose(verbose bool) {
-	sb.verbose = verbose
+func (hp *Hyprpaper) SetVerbose(verbose bool) {
+	hp.verbose = verbose
 }
 
 // SetWallpaper sets the desktop wallpaper, given an image filename.
 // The image must exist and be readable.
-func (sb *Hyprpaper) SetWallpaper(imageFilename string) error {
+func (hp *Hyprpaper) SetWallpaper(imageFilename string) error {
 	if !exists(imageFilename) {
 		return fmt.Errorf("no such file: %s", imageFilename)
 	}
 
 	// Connect to the Hyprpaper socket
-	sock, err := net.DialUnix("unix", nil, &net.UnixAddr{Name: sb.sock, Net: "unix"})
+	sock, err := net.DialUnix("unix", nil, &net.UnixAddr{Name: hp.sock, Net: "unix"})
 
 	if err != nil {
 		return err
@@ -88,8 +88,8 @@ func (sb *Hyprpaper) SetWallpaper(imageFilename string) error {
 
 	// Set the wallpaper mode
 	mode := defaultMode
-	if sb.mode != "" {
-		mode = sb.mode
+	if hp.mode != "" {
+		mode = hp.mode
 	}
 
 	switch mode {