Initial support for Sioyek viewer (#1634)

Author: deathaxe

LaTeXTools.sublime-settings

@@ -246,7 +246,9 @@
 
 	"osx": 	{
 		// Path used when invoking tex & friends; MUST include $PATH
-		"texpath" : "/Library/TeX/texbin:/usr/texbin:/usr/local/bin:/opt/local/bin:$PATH"
+		"texpath": "/Library/TeX/texbin:/usr/texbin:/usr/local/bin:/opt/local/bin:$PATH",
+		// Command to invoke Sioyek. If blank, "sioyek.exe" is used (it has to be on your PATH)
+		"sioyek": ""
 	},
 
 	"windows": {
@@ -256,6 +258,8 @@
 		"texpath" : "",
 		// TeX distro: "miktex" or "texlive"
 		"distro" : "miktex",
+		// Command to invoke Sioyek. If blank, "sioyek.exe" is used (it has to be on your PATH)
+		"sioyek": "",
 		// Command to invoke Sumatra. If blank, "SumatraPDF.exe" is used (it has to be on your PATH)
 		"sumatra": "",
 		// Command to invoke Sublime Text. Used if the keep_focus toggle is true.
@@ -275,6 +279,8 @@
 		// Both Python2 and Python3 are supported, but must have the DBus bindings
 		// installed.
 		"python": "",
+		// Command to invoke Sioyek. If blank, "sioyek.exe" is used (it has to be on your PATH)
+		"sioyek": "",
 		// How long to wait after evince or okular has launched before sending a sync message
 		// in seconds, floating point; choose 2.0 or 3.0 on a slower machine, 0.5 on a fast one
 		// Note: only tweak this if sync after launching the PDF viewer does not seem to work,
@@ -523,6 +529,8 @@
 	//
 	// "preview"		uses Preview.app to open the pdf
 	//
+	// "sioyek"			uses Sioyek to open the pdf
+	//
 	// "skim"			uses Skim to open the pdf; this is the
 	//					default on OSX
 	//

plugins/viewer/__init__.py

@@ -2,6 +2,7 @@
 from .evince_viewer import EvinceViewer
 from .okular_viewer import OkularViewer
 from .preview_viewer import PreviewViewer
+from .sioyek_viewer import SioyekViewer
 from .skim_viewer import SkimViewer
 from .sumatra_viewer import SumatraViewer
 from .zathura_viewer import ZathuraViewer

plugins/viewer/sioyek_viewer.py

@@ -0,0 +1,59 @@
+import sublime
+
+from ...latextools.utils.external_command import external_command
+from ...latextools.utils.settings import get_setting
+
+from .base_viewer import BaseViewer
+
+__all__ = ["SioyekViewer"]
+
+
+class SioyekViewer(BaseViewer):
+
+    def _run_sioyek(self, *args, **kwargs):
+        platform = sublime.platform()
+        sioyek_binary = (
+            # prefer `viewer_settings`
+            get_setting("viewer_settings", {}).get("sioyek")
+            # fallback to platform specific settings
+            or get_setting(platform, {}).get("sioyek")
+            # static binary expected to be found on $PATH
+            or "sioyek.exe"
+            if platform == "windows"
+            else "sioyek"
+        )
+
+        command = [sioyek_binary]
+
+        keep_focus = kwargs.pop("keep_focus", True)
+        if keep_focus:
+            command.append("--nofocus")
+
+        command += args
+        external_command(command, use_texpath=False, show_window=True)
+
+    def forward_sync(self, pdf_file, tex_file, line, col, **kwargs):
+        sublime_text = get_setting(sublime.platform(), {}).get("sublime_executable") or "subl"
+        self._run_sioyek(
+            "--execute-command",
+            "turn_on_synctex",
+            "--forward-search-file",
+            tex_file,
+            "--forward-search-line",
+            f"{line}",
+            "--forward-search-column",
+            f"{col}",
+            "--inverse-search",
+            f"{sublime_text} %1:%2",
+            pdf_file,
+            **kwargs
+        )
+
+    def view_file(self, pdf_file, **kwargs):
+        self._run_sioyek("--new-window", pdf_file, **kwargs)
+
+    def supports_keep_focus(self):
+        return True
+
+    def supports_platform(self, platform):
+        return True