Add basic MacOS support

* Add choose as rofi alternative
* Support pbcopy/pbpaste backend for clipboarder
* Add cliclick support as typer
* Update documentation

Implements: #223

Author: Lqp1

README.md

@@ -66,9 +66,9 @@ You can configure `rofimoji` either with cli arguments or with a config file cal
 | `--use-icons`                                                                                                                                          |              |                                                                                                                | `false`                                              | Show characters as icons in `rofi`. Not used for other selectors.                                                                                                                                                                                                                                                   |
 | `--prompt`                                                                                                                                             | `-r`         | any string                                                                                                     | `😀 `                                                | Define the prompt text for `rofimoji`.                                                                                                                                                                                                                                                                              |
 | `--selector-args`                                                                                                                                      |              |                                                                                                                |                                                      | Define arguments that `rofimoji` will pass through to the selector.<br/>Please note that you need to specify it as `--selector-args="<selector-args>"` or `--selector-args " <selector-args>"` because of a [bug in argparse](https://bugs.python.org/issue9334)                                                    |
-| `--selector`                                                                                                                                           |              | `rofi`, `wofi`, `fuzzel`, `dmenu`, `tofi`, `bemenu`, `wmenu`                                                   | (automatically chosen)                               | Show the selection dialog with this application.                                                                                                                                                                                                                                                                    |
-| `--clipboarder`                                                                                                                                        |              | `xsel`, `xclip`, `wl-copy`                                                                                     | (automatically chosen)                               | Access the clipboard with this application.                                                                                                                                                                                                                                                                         |
-| `--typer`                                                                                                                                              |              | `xdotool`, `wtype`, `ydotool`                                                                                  | (automatically chosen)                               | Type the characters using this application.                                                                                                                                                                                                                                                                         |
+| `--selector`                                                                                                                                           |              | `rofi`, `wofi`, `fuzzel`, `dmenu`, `tofi`, `bemenu`, `wmenu`, `choose`                                         | (automatically chosen)                               | Show the selection dialog with this application.                                                                                                                                                                                                                                                                    |
+| `--clipboarder`                                                                                                                                        |              | `xsel`, `xclip`, `wl-copy`, `pbcopy`                                                                           | (automatically chosen)                               | Access the clipboard with this application.                                                                                                                                                                                                                                                                         |
+| `--typer`                                                                                                                                              |              | `xdotool`, `wtype`, `ydotool`, `cliclick`                                                                      | (automatically chosen)                               | Type the characters using this application.                                                                                                                                                                                                                                                                         |
 | `--keybinding-copy`, `--keybinding-type`, `--keybinding-clipboard`, `--keybinding-type-numerical`, `--keybinding-unicode`, `--keybinding-copy-unicode` |              |                                                                                                                | `Alt+c`, `Alt+t`, `Alt+p`, `Alt+n`, `Alt+u`, `Alt+i` | Choose different keybindings than the default values.                                                                                                                                                                                                                                                               |
 
 ## Example config file
@@ -109,6 +109,8 @@ Finally, with `--action copy` (or `-a copy`) you can also tell `rofimoji` to onl
 `rofimoji` supports both X11 and Wayland by using the correct tools for each environment (see [Supported Selectors](#supported-selectors)). It tries to automatically choose the right one for the currently running session.
 If you want to manually overwrite this, have a look at the `--selector`, `--clipboarder` and `--typer` options [above](#options).
 
+`rofimoji` also supports MacOS in a best-effort fashion (see below)
+
 ## Most recently used characters
 By default, `rofimoji` will show the last ten recently used characters separately; you can insert them with `alt+1`, `alt+2` and so on. It will use the default [insertion method](#insertion-method).
 If you don't want this, you can set `--max-recent` to `0`.
@@ -163,6 +165,15 @@ What else do you need:
 - Optionally, a tool to programmatically type characters into applications. Either `xdotool` for X11 or `wtype`/`ydotool` for Wayland
 - Optionally, a tool to copy the characters to the clipboard. `xsel` and `xclip` work on X11; `wl-copy` on Wayland
 
+### MacOS support
+
+A light support of MacOS was brought to `rofimoji` through:
+- `pbcopy` / `pbpaste` to manage the clipboard
+- `choose` as selector alternative to `rofi`
+- `cliclick` as typer alternative to `xdotool`
+
+Support is for now limited and `type`, `type-numerical` and `unicode` are not supported yet.
+
 ### Supported Selectors
 Please note that several advanced features are only supported by `rofi` (both on X and Wayland):
 - custom keyboard shortcuts
@@ -184,3 +195,6 @@ All other selectors can be used for the basic functionality.
 - [tofi](https://github.com/philj56/tofi)
 - [bemenu](https://github.com/Cloudef/bemenu)
 - [wmenu](https://git.sr.ht/~adnano/wmenu)
+
+#### MacOS
+- [choose](https://github.com/chipsenkbeil/choose)

src/picker/abstractionhelper.py

@@ -1,10 +1,15 @@
 import os
+import platform
 import shutil
 
 
 def is_installed(executable: str) -> bool:
     return shutil.which(executable) is not None
 
 
+def is_macos() -> bool:
+    return platform.system() == "Darwin"
+
+
 def is_wayland() -> bool:
     return "WAYLAND_DISPLAY" in os.environ

src/picker/argument_parsing.py

@@ -112,7 +112,7 @@ def __parse_arguments(only_known: bool) -> argparse.Namespace:
         dest="selector",
         action="store",
         type=str,
-        choices=["rofi", "wofi", "fuzzel", "dmenu", "tofi", "bemenu", "wmenu"],
+        choices=["rofi", "wofi", "fuzzel", "dmenu", "tofi", "bemenu", "wmenu", "choose"],
         default=None,
         help="Choose the application to select the characters with",
     )
@@ -121,7 +121,7 @@ def __parse_arguments(only_known: bool) -> argparse.Namespace:
         dest="clipboarder",
         action="store",
         type=str,
-        choices=["xsel", "xclip", "wl-copy"],
+        choices=["xsel", "xclip", "wl-copy", "pbcopy"],
         default=None,
         help="Choose the application to access the clipboard with",
     )
@@ -130,7 +130,7 @@ def __parse_arguments(only_known: bool) -> argparse.Namespace:
         dest="typer",
         action="store",
         type=str,
-        choices=["xdotool", "wtype", "ydotool"],
+        choices=["xdotool", "wtype", "ydotool", "cliclick"],
         default=None,
         help="Choose the application to type with",
     )

src/picker/clipboarder/clipboarder.py

@@ -11,8 +11,9 @@ def best_option(name: Optional[str] = None) -> "Clipboarder":
         from .wl import WlClipboarder
         from .xclip import XClipClipboarder
         from .xsel import XSelClipboarder
+        from .pbcopy import PBCopyClipboarder
 
-        available_clipboarders = [XSelClipboarder, XClipClipboarder, WlClipboarder, NoopClipboarder]
+        available_clipboarders = [XSelClipboarder, XClipClipboarder, WlClipboarder, PBCopyClipboarder, NoopClipboarder]
 
         if name is not None:
             return next(clipboarder for clipboarder in available_clipboarders if clipboarder.name() == name)()

src/picker/clipboarder/pbcopy.py

@@ -0,0 +1,28 @@
+from subprocess import run
+
+from ..abstractionhelper import is_installed, is_macos
+from ..typer.typer import Typer
+from .clipboarder import Clipboarder
+
+
+class PBCopyClipboarder(Clipboarder):
+    @staticmethod
+    def supported() -> bool:
+        return is_installed("pbcopy")
+
+    @staticmethod
+    def name() -> str:
+        return "pbcopy"
+
+    def copy_characters_to_clipboard(self, characters: str) -> None:
+        run(["pbcopy"], input=characters, encoding="utf-8")
+
+    def copy_paste_characters(self, characters: str, active_window: str, typer: Typer) -> None:
+        old_clipboard_content = run(args=["pbpaste"], capture_output=True, encoding="utf-8")
+
+        run(args=["pbcopy"], input=characters, encoding="utf-8")
+
+        typer.insert_from_clipboard(active_window)
+
+        if old_clipboard_content.returncode == 0:
+            run(args=["pbcopy"], input=old_clipboard_content.stdout, encoding="utf-8")

src/picker/selector/choose.py

@@ -0,0 +1,58 @@
+from subprocess import run
+from typing import Dict, List, Tuple, Union
+
+from ..abstractionhelper import is_installed, is_macos
+from ..models import CANCEL, DEFAULT, Action, CharacterEntry, Shortcut
+from .selector import Selector
+
+
+class Choose(Selector):
+    @staticmethod
+    def supported() -> bool:
+        return is_macos() and is_installed("choose")
+
+    @staticmethod
+    def name() -> str:
+        return "choose"
+
+    def show_character_selection(
+        self,
+        characters: List[CharacterEntry],
+        recent_characters: List[str],
+        prompt: str,
+        show_description: bool,
+        use_icons: bool,
+        keybindings: Dict[Action, str],
+        additional_args: List[str],
+    ) -> Tuple[Union[Action, DEFAULT, CANCEL], Union[List[str], Shortcut]]:
+        parameters = ["choose", "-p", prompt, *additional_args]
+
+        choose = run(
+            parameters, input="\n".join(self.basic_format_characters(characters)), capture_output=True, encoding="utf-8"
+        )
+        return DEFAULT(), [self.extract_char_from_basic_output(line) for line in choose.stdout.splitlines()]
+
+    def show_skin_tone_selection(
+        self, tones_emojis: List[str], prompt: str, additional_args: List[str]
+    ) -> Tuple[int, str]:
+        choose = run(
+            ["choose", "-p", prompt, *additional_args],
+            input="\n".join(tones_emojis),
+            capture_output=True,
+            encoding="utf-8",
+        )
+
+        return choose.returncode, choose.stdout
+
+    def show_action_menu(self, additional_args: List[str]) -> List[Action]:
+        choose = run(
+            [
+                "choose",
+                *additional_args,
+            ],
+            input="\n".join([it.value for it in Action if it != Action.MENU]),
+            capture_output=True,
+            encoding="utf-8",
+        )
+
+        return [Action(choose.stdout.strip())]

src/picker/selector/selector.py

@@ -15,8 +15,9 @@ def best_option(name: Optional[str] = None) -> "Selector":
         from .tofi import Tofi
         from .wmenu import WMenu
         from .wofi import Wofi
+        from .choose import Choose
 
-        available_selectors = [Rofi, Wofi, Fuzzel, Bemenu, Tofi, DMenu, WMenu]
+        available_selectors = [Rofi, Wofi, Fuzzel, Bemenu, Tofi, DMenu, WMenu, Choose]
 
         if name is not None:
             try:

src/picker/typer/cliclick.py

@@ -0,0 +1,36 @@
+from subprocess import run
+from typing import List
+
+from ..abstractionhelper import is_installed, is_wayland, is_macos
+from .typer import Typer
+
+
+class CliclickTyper(Typer):
+    @staticmethod
+    def supported() -> bool:
+        return is_installed("cliclick")
+
+    @staticmethod
+    def name() -> str:
+        return "cliclick"
+
+    def get_active_window(self) -> str:
+        return ""
+
+    def type_characters(self, characters: str, active_window: str) -> None:
+        pass
+
+
+    def insert_from_clipboard(self, active_window: str) -> None:
+        run(
+            [
+                "cliclick",
+                "-w 100",
+                "kd:cmd",
+                "t:v",
+                "ku:cmd"
+            ]
+        )
+
+    def type_numerical(self, codepoints: List[int], active_window: str) -> None:
+        pass

src/picker/typer/typer.py

@@ -9,8 +9,9 @@ def best_option(name: Optional[str] = None) -> "Typer":
         from .wtype import WTypeTyper
         from .xdotool import XDoToolTyper
         from .ydotool import YdotoolTyper as YDoToolTyper
+        from .cliclick import CliclickTyper
 
-        available_typers = [XDoToolTyper, WTypeTyper, YDoToolTyper, NoopTyper]
+        available_typers = [XDoToolTyper, WTypeTyper, YDoToolTyper, CliclickTyper, NoopTyper]
 
         if name is not None:
             return next(typer for typer in available_typers if typer.name() == name)()