Wrap terminalSetEnableSixel in CPP because it doesn't exist in previous vte versions

Author: cdepillabout

Setup.hs

@@ -104,6 +104,7 @@ createVteVersionCPPOpts
 createVteVersionCPPOpts vers =
   catMaybes
     [ if vers >= mkVersion [0,44] then Just "-DVTE_VERSION_GEQ_0_44" else Nothing
+    , if vers >= mkVersion [0,63] then Just "-DVTE_VERSION_GEQ_0_63" else Nothing
     ]
 
 -- | Based on the version of the GTK3 library as reported by @pkg-config@, return

src/Termonad/App.hs

@@ -117,7 +117,6 @@ import GI.Vte
   , terminalSearchSetWrapAround
   , terminalSetBoldIsBright
   , terminalSetCursorBlinkMode
-  , terminalSetEnableSixel
   , terminalSetFont
   , terminalSetScrollbackLines
   , terminalSetWordCharExceptions
@@ -126,7 +125,7 @@ import System.Environment (getExecutablePath)
 import System.FilePath (takeFileName)
 
 import Paths_termonad (getDataFileName)
-import Termonad.Gtk (appNew, objFromBuildUnsafe)
+import Termonad.Gtk (appNew, objFromBuildUnsafe, terminalSetEnableSixelIfExists)
 import Termonad.Keys (handleKeyPress)
 import Termonad.Lenses
   ( lensBoldIsBright
@@ -729,7 +728,7 @@ applyNewPreferencesToTab mvarTMState tab = do
   terminalSetWordCharExceptions term (wordCharExceptions options)
   terminalSetScrollbackLines term (fromIntegral (scrollbackLen options))
   terminalSetBoldIsBright term (boldIsBright options)
-  terminalSetEnableSixel term (enableSixel options)
+  terminalSetEnableSixelIfExists term (enableSixel options)
 
   let vScrollbarPolicy = showScrollbarToPolicy (options ^. lensShowScrollbar)
   scrolledWindowSetPolicy scrolledWin PolicyTypeAutomatic vScrollbarPolicy

src/Termonad/Gtk.hs

@@ -1,3 +1,18 @@
+{-# LANGUAGE CPP #-}
+
+-- | This module contains two things:
+--
+-- 1. Extension functions to libraries like GTK.  These functions wrap up some
+--    generic GTK functionality.  They are not Termonad-specific.
+--
+-- 2. Wrappers around functionality that is only specific to certain versions
+--    of libraries like GTK or VTE.
+--
+--    For instance, 'terminalSetEnableSixelIfExists' is
+--    a wrapper around 'terminalSetEnableSixel'.  Sixel support is only availble in
+--    vte >= 0.63, so if a user tries to compile Termonad with a version of vte
+--    less than 0.63, this function won't do anything.
+
 module Termonad.Gtk where
 
 import Termonad.Prelude
@@ -12,6 +27,12 @@ import GI.Gdk
 import GI.Gio (ApplicationFlags)
 import GI.Gtk (Application, IsWidget, Widget(Widget), applicationNew, builderGetObject, toWidget)
 import qualified GI.Gtk as Gtk
+import GI.Vte
+  ( IsTerminal
+#ifdef VTE_VERSION_GEQ_0_63
+  , terminalSetEnableSixel
+#endif
+  )
 
 
 objFromBuildUnsafe ::
@@ -58,3 +79,17 @@ widgetEq a b = do
     withManagedPtr managedPtrA $ \ptrA ->
       withManagedPtr managedPtrB $ \ptrB ->
         pure (ptrA == ptrB)
+
+-- | Wrapper around 'terminalSetEnableSixel'.  The 'terminalSetEnableSixel' function
+-- is only available starting with vte-0.63. This function has no effect when
+-- compiling against previous versions of vte.
+terminalSetEnableSixelIfExists
+  :: (HasCallStack, MonadIO m, IsTerminal t)
+  => t -- ^ a Terminal
+  -> Bool -- ^ whether to enable SIXEL images
+  -> m ()
+terminalSetEnableSixelIfExists t b = do
+#ifdef VTE_VERSION_GEQ_0_63
+  terminalSetEnableSixel t b
+#endif
+  pure ()

src/Termonad/Term.hs

@@ -90,7 +90,6 @@ import GI.Vte
   , terminalNew
   , terminalSetBoldIsBright
   , terminalSetCursorBlinkMode
-  , terminalSetEnableSixel
   , terminalSetFont
   , terminalSetScrollbackLines
   , terminalSetWordCharExceptions
@@ -99,6 +98,7 @@ import GI.Vte
 import System.Directory (getSymbolicLinkTarget)
 import System.Environment (lookupEnv)
 
+import Termonad.Gtk (terminalSetEnableSixelIfExists)
 import Termonad.Lenses
   ( lensConfirmExit
   , lensOptions
@@ -361,7 +361,7 @@ createAndInitVteTerm tmStateFontDesc curOpts = do
   terminalSetScrollbackLines vteTerm (fromIntegral (scrollbackLen curOpts))
   terminalSetCursorBlinkMode vteTerm (cursorBlinkMode curOpts)
   terminalSetBoldIsBright vteTerm (boldIsBright curOpts)
-  terminalSetEnableSixel vteTerm (enableSixel curOpts)
+  terminalSetEnableSixelIfExists vteTerm (enableSixel curOpts)
   widgetShow vteTerm
   pure vteTerm