Clipboard-2.3.2.2: System/Clipboard.hs

{-# LANGUAGE CPP #-}

-- | System Clipboard Interface. It should work on both Windows and Unix (X11).
module System.Clipboard
    ( -- * Clipboard interface
      setClipboardString
    , getClipboardString
    , modifyClipboardString
    ) where

#if defined(mingw32_HOST_OS) || defined(__MINGW32__)
import qualified System.Clipboard.Windows as OS
#else
import qualified System.Clipboard.X11 as OS
#endif

-- | Write a string to the clipboard.
setClipboardString :: String -> IO ()
setClipboardString = OS.setClipboardString

-- | Get the content of the clipboard as a 'String'.
--   It returns 'Nothing' if the clipboard doesn't contain /textual/ data.
getClipboardString :: IO (Maybe String)
getClipboardString = OS.getClipboardString

-- | Modify the clipboard content.
--   If the clipboard has /textual/ data, this function modifies its content
--   and returns 'True'. Otherwise, it does nothing and returns 'False'.
modifyClipboardString :: (String -> String) -> IO Bool
modifyClipboardString f = do
 s <- getClipboardString
 case s of
   Nothing -> return False
   Just sc -> setClipboardString (f sc) >> return True