Merge pull request #131 from federico-terzi/dev

Version 0.4.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "espanso"
-version = "0.3.5"
+version = "0.4.0"
 authors = ["Federico Terzi <federicoterzi96@gmail.com>"]
 license = "GPL-3.0"
 description = "Cross-platform Text Expander written in Rust"

README.md

@@ -41,6 +41,13 @@ ___
 
 Visit the [official documentation](https://espanso.org/docs/).
 
+## Support
+
+If you need some help to setup espanso, want to ask a question or simply get involved
+in the community, [Join the official Subreddit](https://www.reddit.com/r/espanso/)! :)
+
+
+
 ## Donations
 
 espanso is a free, open source software developed in my (little) spare time.
@@ -57,6 +64,7 @@ Many people helped the project along the way, thanks to all of you. In particula
 * [Luca Antognetti](https://github.com/luca-ant) - Linux and Windows Tester
 * [Matteo Pellegrino](https://www.matteopellegrino.me/) - MacOS Tester
 * [Timo Runge](http://timorunge.com/) - MacOS contributor
+* [NickSeagull](http://nickseagull.github.io/) - Contributor
 
 ## Remarks
 

native/liblinuxbridge/bridge.cpp

@@ -299,6 +299,10 @@ void trigger_terminal_paste() {
     xdo_send_keysequence_window(xdo_context, CURRENTWINDOW, "Control_L+Shift+v", 8000);
 }
 
+void trigger_shift_ins_paste() {
+    xdo_send_keysequence_window(xdo_context, CURRENTWINDOW, "Shift+Insert", 8000);
+}
+
 // SYSTEM MODULE
 
 // Function taken from the wmlib tool source code
@@ -470,3 +474,5 @@ int32_t is_current_window_terminal() {
 
     return 0;
 }
+
+

native/liblinuxbridge/bridge.h

@@ -82,6 +82,11 @@ extern "C" void trigger_paste();
  */
 extern "C" void trigger_terminal_paste();
 
+/*
+ * Trigger shift ins pasting( Pressing SHIFT+INS )
+ */
+extern "C" void trigger_shift_ins_paste();
+
 
 // SYSTEM MODULE
 

native/libmacbridge/bridge.h

@@ -148,5 +148,11 @@ int32_t get_clipboard(char * buffer, int32_t size);
  */
 int32_t set_clipboard(char * text);
 
+/*
+ * Set the clipboard image to the given file
+ */
+int32_t set_clipboard_image(char * path);
+
+
 };
 #endif //ESPANSO_BRIDGE_H

native/libmacbridge/bridge.mm

@@ -230,6 +230,24 @@ int32_t set_clipboard(char * text) {
     [pasteboard setString:nsText forType:NSPasteboardTypeString];
 }
 
+int32_t set_clipboard_image(char *path) {
+    NSString *pathString = [NSString stringWithUTF8String:path];
+    NSImage *image = [[NSImage alloc] initWithContentsOfFile:pathString];
+    int result = 0;
+
+    if (image != nil) {
+        NSPasteboard *pasteboard = [NSPasteboard generalPasteboard];
+        [pasteboard clearContents];
+        NSArray *copiedObjects = [NSArray arrayWithObject:image];
+        [pasteboard writeObjects:copiedObjects];
+        result = 1;
+    }
+    [image release];
+
+    return result;
+}
+
+
 // CONTEXT MENU
 
 int32_t show_context_menu(MenuItem * items, int32_t count) {
@@ -273,4 +291,4 @@ int32_t prompt_accessibility() {
 void open_settings_panel() {
     NSString *urlString = @"x-apple.systempreferences:com.apple.preference.security?Privacy_Accessibility";
     [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:urlString]];
-}
+}

native/libwinbridge/bridge.cpp

@@ -31,6 +31,9 @@
 #include <strsafe.h>
 #include <shellapi.h>
 
+#pragma comment( lib, "gdiplus.lib" )
+#include <gdiplus.h>
+
 // How many milliseconds must pass between keystrokes to refresh the keyboard layout
 const long refreshKeyboardLayoutInterval = 2000;
 
@@ -656,3 +659,43 @@ int32_t get_clipboard(wchar_t *buffer, int32_t size) {
 
     CloseClipboard();
 }
+
+int32_t set_clipboard_image(wchar_t *path) {
+    bool result = false;
+
+    Gdiplus::GdiplusStartupInput gdiplusStartupInput;
+    ULONG_PTR gdiplusToken;
+    Gdiplus::GdiplusStartup(&gdiplusToken, &gdiplusStartupInput, NULL);
+
+    Gdiplus::Bitmap *gdibmp = Gdiplus::Bitmap::FromFile(path);
+    if (gdibmp)
+    {
+        HBITMAP hbitmap;
+        gdibmp->GetHBITMAP(0, &hbitmap);
+        if (OpenClipboard(NULL))
+        {
+            EmptyClipboard();
+            DIBSECTION ds;
+            if (GetObject(hbitmap, sizeof(DIBSECTION), &ds))
+            {
+                HDC hdc = GetDC(HWND_DESKTOP);
+                //create compatible bitmap (get DDB from DIB)
+                HBITMAP hbitmap_ddb = CreateDIBitmap(hdc, &ds.dsBmih, CBM_INIT,
+                                                     ds.dsBm.bmBits, (BITMAPINFO*)&ds.dsBmih, DIB_RGB_COLORS);
+                ReleaseDC(HWND_DESKTOP, hdc);
+                SetClipboardData(CF_BITMAP, hbitmap_ddb);
+                DeleteObject(hbitmap_ddb);
+                result = true;
+            }
+            CloseClipboard();
+        }
+
+        //cleanup:
+        DeleteObject(hbitmap);
+        delete gdibmp;
+    }
+
+    Gdiplus::GdiplusShutdown(gdiplusToken);
+
+    return result;
+}

native/libwinbridge/bridge.h

@@ -146,4 +146,9 @@ extern "C" int32_t get_clipboard(wchar_t * buffer, int32_t size);
  */
 extern "C" int32_t set_clipboard(wchar_t * text);
 
+/*
+ * Set the clipboard image to the given path
+ */
+extern "C" int32_t set_clipboard_image(wchar_t * path);
+
 #endif //ESPANSO_BRIDGE_H

src/bridge/linux.rs

@@ -42,4 +42,5 @@ extern {
     pub fn left_arrow(count: i32);
     pub fn trigger_paste();
     pub fn trigger_terminal_paste();
+    pub fn trigger_shift_ins_paste();
 }

src/bridge/macos.rs

@@ -43,6 +43,7 @@ extern {
     // Clipboard
     pub fn get_clipboard(buffer: *mut c_char, size: i32) -> i32;
     pub fn set_clipboard(text: *const c_char) -> i32;
+    pub fn set_clipboard_image(path: *const c_char) -> i32;
 
     // UI
     pub fn register_icon_click_callback(cb: extern fn(_self: *mut c_void));

src/bridge/windows.rs

@@ -47,6 +47,7 @@ extern {
     // CLIPBOARD
     pub fn get_clipboard(buffer: *mut u16, size: i32) -> i32;
     pub fn set_clipboard(payload: *const u16) -> i32;
+    pub fn set_clipboard_image(path: *const u16) -> i32;
 
     // KEYBOARD
     pub fn register_keypress_callback(cb: extern fn(_self: *mut c_void, *const u16,

src/clipboard/linux.rs

@@ -19,7 +19,8 @@
 
 use std::process::{Command, Stdio};
 use std::io::{Write};
-use log::error;
+use log::{error, warn};
+use std::path::Path;
 
 pub struct LinuxClipboardManager {}
 
@@ -63,6 +64,29 @@ impl super::ClipboardManager for LinuxClipboardManager {
             }
         }
     }
+
+    fn set_clipboard_image(&self, image_path: &Path) {
+        let extension = image_path.extension();
+        let mime = match extension {
+            Some(ext) => {
+                let ext = ext.to_string_lossy().to_lowercase();
+                match ext.as_ref() {
+                    "png" => {"image/png"},
+                    "jpg" | "jpeg" => {"image/jpeg"},
+                    "gif" => {"image/gif"},
+                    "svg" => {"image/svg"},
+                    _ => {"image/png"},
+                }
+            },
+            None => {"image/png"},
+        };
+
+        let image_path = image_path.to_string_lossy().into_owned();
+
+        let res = Command::new("xclip")
+            .args(&["-selection", "clipboard", "-t", mime, "-i", &image_path])
+            .spawn();
+    }
 }
 
 impl LinuxClipboardManager {

src/clipboard/macos.rs

@@ -18,8 +18,10 @@
  */
 
 use std::os::raw::c_char;
-use crate::bridge::macos::{get_clipboard, set_clipboard};
+use crate::bridge::macos::*;
 use std::ffi::{CStr, CString};
+use std::path::Path;
+use log::{error, warn};
 
 pub struct MacClipboardManager {
 
@@ -52,6 +54,19 @@ impl super::ClipboardManager for MacClipboardManager {
             }
         }
     }
+
+    fn set_clipboard_image(&self, image_path: &Path) {
+        let path_string = image_path.to_string_lossy().into_owned();
+        let res = CString::new(path_string);
+        if let Ok(path) = res {
+            unsafe {
+                let result = set_clipboard_image(path.as_ptr());
+                if result != 1 {
+                    warn!("Couldn't set clipboard for image: {:?}", image_path)
+                }
+            }
+        }
+    }
 }
 
 impl MacClipboardManager {

src/clipboard/mod.rs

@@ -17,6 +17,8 @@
  * along with espanso.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+use std::path::Path;
+
 #[cfg(target_os = "windows")]
 mod windows;
 
@@ -29,6 +31,7 @@ mod macos;
 pub trait ClipboardManager {
     fn get_clipboard(&self) -> Option<String>;
     fn set_clipboard(&self, payload: &str);
+    fn set_clipboard_image(&self, image_path: &Path);
 }
 
 // LINUX IMPLEMENTATION

src/clipboard/windows.rs

@@ -18,7 +18,8 @@
  */
 
 use widestring::U16CString;
-use crate::bridge::windows::{set_clipboard, get_clipboard};
+use crate::bridge::windows::{set_clipboard, get_clipboard, set_clipboard_image};
+use std::path::Path;
 
 pub struct WindowsClipboardManager {
 
@@ -53,4 +54,12 @@ impl super::ClipboardManager for WindowsClipboardManager {
             set_clipboard(payload_c.as_ptr());
         }
     }
+
+    fn set_clipboard_image(&self, image_path: &Path) {
+        let path_string = image_path.to_string_lossy().into_owned();
+        unsafe {
+            let payload_c = U16CString::from_str(path_string).unwrap();
+            set_clipboard_image(payload_c.as_ptr());
+        }
+    }
 }

src/config/mod.rs

@@ -26,6 +26,7 @@ use std::fs::{File, create_dir_all};
 use std::io::Read;
 use serde::{Serialize, Deserialize};
 use crate::event::KeyModifier;
+use crate::keyboard::PasteShortcut;
 use std::collections::{HashSet, HashMap};
 use log::{error};
 use std::fmt;
@@ -97,6 +98,9 @@ pub struct Configs {
     #[serde(default = "default_toggle_interval")]
     pub toggle_interval: u32,
 
+    #[serde(default)]
+    pub paste_shortcut: PasteShortcut,
+
     #[serde(default = "default_backspace_limit")]
     pub backspace_limit: i32,
 
@@ -426,6 +430,7 @@ mod tests {
     use std::io::Write;
     use tempfile::{NamedTempFile, TempDir};
     use std::any::Any;
+    use crate::matcher::{TextContent, MatchContentType};
 
     const TEST_WORKING_CONFIG_FILE : &str = include_str!("../res/test/working_config.yml");
     const TEST_CONFIG_FILE_WITH_BAD_YAML : &str = include_str!("../res/test/config_with_bad_yaml.yml");
@@ -727,7 +732,13 @@ mod tests {
         assert_eq!(config_set.default.matches.len(), 2);
         assert_eq!(config_set.specific[0].matches.len(), 2);
 
-        assert!(config_set.specific[0].matches.iter().find(|x| x.trigger == ":lol" && x.replace == "newstring").is_some());
+        assert!(config_set.specific[0].matches.iter().find(|x| {
+            if let MatchContentType::Text(content) = &x.content {
+                x.trigger == ":lol" && content.replace == "newstring"
+            }else{
+                false
+            }
+        }).is_some());
         assert!(config_set.specific[0].matches.iter().find(|x| x.trigger == ":yess").is_some());
     }
 
@@ -755,7 +766,13 @@ mod tests {
         assert_eq!(config_set.default.matches.len(), 2);
         assert_eq!(config_set.specific[0].matches.len(), 1);
 
-        assert!(config_set.specific[0].matches.iter().find(|x| x.trigger == "hello" && x.replace == "newstring").is_some());
+        assert!(config_set.specific[0].matches.iter().find(|x| {
+            if let MatchContentType::Text(content) = &x.content {
+                x.trigger == "hello" && content.replace == "newstring"
+            }else{
+                false
+            }
+        }).is_some());
     }
 
     #[test]
@@ -897,7 +914,13 @@ mod tests {
         let config_set = ConfigSet::load(data_dir.path(), package_dir.path()).unwrap();
         assert_eq!(config_set.specific.len(), 0);
         assert_eq!(config_set.default.matches.len(), 1);
-        assert!(config_set.default.matches.iter().any(|m| m.trigger == "hasta" && m.replace == "world"));
+        assert!(config_set.default.matches.iter().any(|m| {
+            if let MatchContentType::Text(content) = &m.content {
+                m.trigger == "hasta" && content.replace == "world"
+            }else{
+                false
+            }
+        }));
     }
 
     #[test]