{-|
Module      : Monomer.Widgets.Singles.ExternalLink
Copyright   : (c) 2018 Francisco Vallarino
License     : BSD-3-Clause (see the LICENSE file)
Maintainer  : fjvallarino@gmail.com
Stability   : experimental
Portability : non-portable

Provides a clickable link that is opened by the host OS. Since it relies on the
OS to open the content, it is possible to open URIs other than urls.

@
externalLink "Open Wikipedia" "https://en.wikipedia.org"
@
-}
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE StrictData #-}

module Monomer.Widgets.Singles.ExternalLink (
  -- * Configuration
  ExternalLinkCfg,
  -- * Constructors
  externalLink,
  externalLink_
) where

import Control.Applicative ((<|>))
import Control.Lens ((&), (^.), (.~))
import Data.Default
import Data.Maybe
import Data.Text (Text)
import System.Process (callCommand)

import qualified Data.Sequence as Seq
import qualified Data.Text as T

import Monomer.Helper (catchAny)
import Monomer.Widgets.Container
import Monomer.Widgets.Singles.Label

import qualified Monomer.Lens as L

{-|
Configuration options for externalLink:

- 'trimSpaces': whether to remove leading/trailing spaces in the caption.
- 'ellipsis': if ellipsis should be used for overflown text.
- 'multiline': if text may be split in multiple lines.
- 'maxLines': maximum number of text lines to show.
- 'resizeFactor': flexibility to have more or less spaced assigned.
- 'resizeFactorW': flexibility to have more or less horizontal spaced assigned.
- 'resizeFactorH': flexibility to have more or less vertical spaced assigned.
- 'onFocus': event to raise when focus is received.
- 'onFocusReq': 'WidgetRequest' to generate when focus is received.
- 'onBlur': event to raise when focus is lost.
- 'onBlurReq': 'WidgetRequest' to generate when focus is lost.
- 'onClick': event to raise when button is clicked.
- 'onClickReq': 'WidgetRequest' to generate when button is clicked.
-}
data ExternalLinkCfg s e = ExternalLinkCfg {
  forall s e. ExternalLinkCfg s e -> LabelCfg s e
_elcLabelCfg :: LabelCfg s e,
  forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnFocusReq :: [Path -> WidgetRequest s e],
  forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnBlurReq :: [Path -> WidgetRequest s e]
}

instance Default (ExternalLinkCfg s e) where
  def :: ExternalLinkCfg s e
def = ExternalLinkCfg {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall a. Default a => a
def,
    _elcOnFocusReq :: [Path -> WidgetRequest s e]
_elcOnFocusReq = [],
    _elcOnBlurReq :: [Path -> WidgetRequest s e]
_elcOnBlurReq = []
  }

instance Semigroup (ExternalLinkCfg s e) where
  <> :: ExternalLinkCfg s e -> ExternalLinkCfg s e -> ExternalLinkCfg s e
(<>) ExternalLinkCfg s e
t1 ExternalLinkCfg s e
t2 = ExternalLinkCfg {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall s e. ExternalLinkCfg s e -> LabelCfg s e
_elcLabelCfg ExternalLinkCfg s e
t1 forall a. Semigroup a => a -> a -> a
<> forall s e. ExternalLinkCfg s e -> LabelCfg s e
_elcLabelCfg ExternalLinkCfg s e
t2,
    _elcOnFocusReq :: [Path -> WidgetRequest s e]
_elcOnFocusReq = forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnFocusReq ExternalLinkCfg s e
t1 forall a. Semigroup a => a -> a -> a
<> forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnFocusReq ExternalLinkCfg s e
t2,
    _elcOnBlurReq :: [Path -> WidgetRequest s e]
_elcOnBlurReq = forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnBlurReq ExternalLinkCfg s e
t1 forall a. Semigroup a => a -> a -> a
<> forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnBlurReq ExternalLinkCfg s e
t2
  }

instance Monoid (ExternalLinkCfg s e) where
  mempty :: ExternalLinkCfg s e
mempty = forall a. Default a => a
def

instance CmbTrimSpaces (ExternalLinkCfg s e) where
  trimSpaces_ :: Bool -> ExternalLinkCfg s e
trimSpaces_ Bool
trim = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbTrimSpaces t => Bool -> t
trimSpaces_ Bool
trim
  }

instance CmbEllipsis (ExternalLinkCfg s e) where
  ellipsis_ :: Bool -> ExternalLinkCfg s e
ellipsis_ Bool
ellipsis = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbEllipsis t => Bool -> t
ellipsis_ Bool
ellipsis
  }

instance CmbMultiline (ExternalLinkCfg s e) where
  multiline_ :: Bool -> ExternalLinkCfg s e
multiline_ Bool
multi = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbMultiline t => Bool -> t
multiline_ Bool
multi
  }

instance CmbMaxLines (ExternalLinkCfg s e) where
  maxLines :: Int -> ExternalLinkCfg s e
maxLines Int
count = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbMaxLines t => Int -> t
maxLines Int
count
  }

instance CmbResizeFactor (ExternalLinkCfg s e) where
  resizeFactor :: Double -> ExternalLinkCfg s e
resizeFactor Double
s = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbResizeFactor t => Double -> t
resizeFactor Double
s
  }

instance CmbResizeFactorDim (ExternalLinkCfg s e) where
  resizeFactorW :: Double -> ExternalLinkCfg s e
resizeFactorW Double
w = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbResizeFactorDim t => Double -> t
resizeFactorW Double
w
  }
  resizeFactorH :: Double -> ExternalLinkCfg s e
resizeFactorH Double
h = forall a. Default a => a
def {
    _elcLabelCfg :: LabelCfg s e
_elcLabelCfg = forall t. CmbResizeFactorDim t => Double -> t
resizeFactorH Double
h
  }

instance WidgetEvent e => CmbOnFocus (ExternalLinkCfg s e) e Path where
  onFocus :: (Path -> e) -> ExternalLinkCfg s e
onFocus Path -> e
fn = forall a. Default a => a
def {
    _elcOnFocusReq :: [Path -> WidgetRequest s e]
_elcOnFocusReq = [forall s e. WidgetEvent e => e -> WidgetRequest s e
RaiseEvent forall b c a. (b -> c) -> (a -> b) -> a -> c
. Path -> e
fn]
  }

instance CmbOnFocusReq (ExternalLinkCfg s e) s e Path where
  onFocusReq :: (Path -> WidgetRequest s e) -> ExternalLinkCfg s e
onFocusReq Path -> WidgetRequest s e
req = forall a. Default a => a
def {
    _elcOnFocusReq :: [Path -> WidgetRequest s e]
_elcOnFocusReq = [Path -> WidgetRequest s e
req]
  }

instance WidgetEvent e => CmbOnBlur (ExternalLinkCfg s e) e Path where
  onBlur :: (Path -> e) -> ExternalLinkCfg s e
onBlur Path -> e
fn = forall a. Default a => a
def {
    _elcOnBlurReq :: [Path -> WidgetRequest s e]
_elcOnBlurReq = [forall s e. WidgetEvent e => e -> WidgetRequest s e
RaiseEvent forall b c a. (b -> c) -> (a -> b) -> a -> c
. Path -> e
fn]
  }

instance CmbOnBlurReq (ExternalLinkCfg s e) s e Path where
  onBlurReq :: (Path -> WidgetRequest s e) -> ExternalLinkCfg s e
onBlurReq Path -> WidgetRequest s e
req = forall a. Default a => a
def {
    _elcOnBlurReq :: [Path -> WidgetRequest s e]
_elcOnBlurReq = [Path -> WidgetRequest s e
req]
  }

-- | Creates an external link with the given caption and url.
externalLink :: WidgetEvent e => Text -> Text -> WidgetNode s e
externalLink :: forall e s. WidgetEvent e => Text -> Text -> WidgetNode s e
externalLink Text
caption Text
url = forall e s.
WidgetEvent e =>
Text -> Text -> [ExternalLinkCfg s e] -> WidgetNode s e
externalLink_ Text
caption Text
url forall a. Default a => a
def

-- | Creates an external link with the given caption and url. Accepts config.
externalLink_
  :: WidgetEvent e => Text -> Text -> [ExternalLinkCfg s e] -> WidgetNode s e
externalLink_ :: forall e s.
WidgetEvent e =>
Text -> Text -> [ExternalLinkCfg s e] -> WidgetNode s e
externalLink_ Text
caption Text
url [ExternalLinkCfg s e]
configs = WidgetNode s e
externalLinkNode where
  config :: ExternalLinkCfg s e
config = forall a. Monoid a => [a] -> a
mconcat [ExternalLinkCfg s e]
configs
  widget :: Widget s e
widget = forall e s.
WidgetEvent e =>
Text -> Text -> ExternalLinkCfg s e -> Widget s e
makeExternalLink Text
caption Text
url ExternalLinkCfg s e
config
  externalLinkNode :: WidgetNode s e
externalLinkNode = forall s e. WidgetType -> Widget s e -> WidgetNode s e
defaultWidgetNode WidgetType
"externalLink" Widget s e
widget
    forall a b. a -> (a -> b) -> b
& forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasFocusable s a => Lens' s a
L.focusable forall s t a b. ASetter s t a b -> b -> s -> t
.~ Bool
True

makeExternalLink
  :: WidgetEvent e => Text -> Text -> ExternalLinkCfg s e -> Widget s e
makeExternalLink :: forall e s.
WidgetEvent e =>
Text -> Text -> ExternalLinkCfg s e -> Widget s e
makeExternalLink !Text
caption !Text
url !ExternalLinkCfg s e
config = Widget s e
widget where
  widget :: Widget s e
widget = forall a s e. WidgetModel a => a -> Container s e a -> Widget s e
createContainer () forall a. Default a => a
def {
    containerAddStyleReq :: Bool
containerAddStyleReq = Bool
False,
    containerDrawDecorations :: Bool
containerDrawDecorations = Bool
False,
    containerUseScissor :: Bool
containerUseScissor = Bool
True,
    containerGetBaseStyle :: ContainerGetBaseStyle s e
containerGetBaseStyle = forall {s} {e} {p}. WidgetEnv s e -> p -> Maybe Style
getBaseStyle,
    containerInit :: ContainerInitHandler s e
containerInit = forall {p}. p -> WidgetNode s e -> WidgetResult s e
init,
    containerMerge :: ContainerMergeHandler s e ()
containerMerge = forall {p} {p} {p}.
p -> WidgetNode s e -> p -> p -> WidgetResult s e
merge,
    containerHandleEvent :: ContainerEventHandler s e
containerHandleEvent = forall {p}.
WidgetEnv s e
-> WidgetNode s e -> p -> SystemEvent -> Maybe (WidgetResult s e)
handleEvent,
    containerResize :: ContainerResizeHandler s e
containerResize = forall {p} {s} {e} {p} {p}.
p -> WidgetNode s e -> p -> p -> (WidgetResult s e, Seq p)
resize
  }

  getBaseStyle :: WidgetEnv s e -> p -> Maybe Style
getBaseStyle WidgetEnv s e
wenv p
node = forall a. a -> Maybe a
Just Style
style where
    style :: Style
style = forall s e. WidgetEnv s e -> Lens' ThemeState StyleState -> Style
collectTheme WidgetEnv s e
wenv forall s a. HasExternalLinkStyle s a => Lens' s a
L.externalLinkStyle

  createChildNode :: p -> p -> p
createChildNode p
wenv p
node = p
newNode where
    nodeStyle :: Style
nodeStyle = p
node forall s a. s -> Getting a s a -> a
^. forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasStyle s a => Lens' s a
L.style
    labelCfg :: LabelCfg s e
labelCfg = forall s e. ExternalLinkCfg s e -> LabelCfg s e
_elcLabelCfg ExternalLinkCfg s e
config
    labelCurrStyle :: LabelCfg s e
labelCurrStyle = forall s e.
(WidgetEnv s e -> WidgetNode s e -> StyleState) -> LabelCfg s e
labelCurrentStyle forall s e. WidgetEnv s e -> WidgetNode s e -> StyleState
childOfFocusedStyle
    !labelNode :: WidgetNode s e
labelNode = forall s e. Text -> [LabelCfg s e] -> WidgetNode s e
label_ Text
caption [forall t. CmbIgnoreTheme t => t
ignoreTheme, LabelCfg s e
labelCfg, forall {s} {e}. LabelCfg s e
labelCurrStyle]
      forall a b. a -> (a -> b) -> b
& forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasStyle s a => Lens' s a
L.style forall s t a b. ASetter s t a b -> b -> s -> t
.~ Style
nodeStyle
    !newNode :: p
newNode = p
node
      forall a b. a -> (a -> b) -> b
& forall s a. HasChildren s a => Lens' s a
L.children forall s t a b. ASetter s t a b -> b -> s -> t
.~ forall a. a -> Seq a
Seq.singleton WidgetNode s e
labelNode

  init :: p -> WidgetNode s e -> WidgetResult s e
init p
wenv WidgetNode s e
node = WidgetResult s e
result where
    result :: WidgetResult s e
result = forall s e. WidgetNode s e -> WidgetResult s e
resultNode (forall {p} {a} {p}.
(HasInfo p a, HasStyle a Style,
 HasChildren p (Seq (WidgetNode s e))) =>
p -> p -> p
createChildNode p
wenv WidgetNode s e
node)

  merge :: p -> WidgetNode s e -> p -> p -> WidgetResult s e
merge p
wenv WidgetNode s e
node p
oldNode p
oldState = WidgetResult s e
result where
    result :: WidgetResult s e
result = forall s e. WidgetNode s e -> WidgetResult s e
resultNode (forall {p} {a} {p}.
(HasInfo p a, HasStyle a Style,
 HasChildren p (Seq (WidgetNode s e))) =>
p -> p -> p
createChildNode p
wenv WidgetNode s e
node)

  handleEvent :: WidgetEnv s e
-> WidgetNode s e -> p -> SystemEvent -> Maybe (WidgetResult s e)
handleEvent WidgetEnv s e
wenv WidgetNode s e
node p
target SystemEvent
evt = case SystemEvent
evt of
    Focus Path
prev -> forall s e.
WidgetNode s e
-> Path -> [Path -> WidgetRequest s e] -> Maybe (WidgetResult s e)
handleFocusChange WidgetNode s e
node Path
prev (forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnFocusReq ExternalLinkCfg s e
config)

    Blur Path
next -> forall s e.
WidgetNode s e
-> Path -> [Path -> WidgetRequest s e] -> Maybe (WidgetResult s e)
handleFocusChange WidgetNode s e
node Path
next (forall s e. ExternalLinkCfg s e -> [Path -> WidgetRequest s e]
_elcOnBlurReq ExternalLinkCfg s e
config)

    KeyAction KeyMod
mode KeyCode
code KeyStatus
status
      | KeyCode -> Bool
isSelectKey KeyCode
code Bool -> Bool -> Bool
&& KeyStatus
status forall a. Eq a => a -> a -> Bool
== KeyStatus
KeyPressed -> forall a. a -> Maybe a
Just WidgetResult s e
result
      where
        isSelectKey :: KeyCode -> Bool
isSelectKey KeyCode
code = KeyCode -> Bool
isKeyReturn KeyCode
code Bool -> Bool -> Bool
|| KeyCode -> Bool
isKeySpace KeyCode
code

    Click Point
p Button
_ Int
_
      | forall s e. WidgetNode s e -> Point -> Bool
isPointInNodeVp WidgetNode s e
node Point
p -> forall a. a -> Maybe a
Just WidgetResult s e
result

    ButtonAction Point
p Button
btn ButtonState
BtnPressed Int
1 -- Set focus on click
      | Button -> Bool
mainBtn Button
btn Bool -> Bool -> Bool
&& Point -> Bool
pointInVp Point
p Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
focused -> forall a. a -> Maybe a
Just WidgetResult s e
resultFocus

    ButtonAction Point
p Button
btn ButtonState
BtnReleased Int
clicks
      | Button -> Bool
mainBtn Button
btn Bool -> Bool -> Bool
&& Bool
focused Bool -> Bool -> Bool
&& Point -> Bool
pointInVp Point
p Bool -> Bool -> Bool
&& Int
clicks forall a. Ord a => a -> a -> Bool
> Int
1 -> forall a. a -> Maybe a
Just WidgetResult s e
result
    SystemEvent
_ -> forall a. Maybe a
Nothing
    where
      widgetId :: WidgetId
widgetId = WidgetNode s e
node forall s a. s -> Getting a s a -> a
^. forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasWidgetId s a => Lens' s a
L.widgetId
      path :: Path
path = WidgetNode s e
node forall s a. s -> Getting a s a -> a
^. forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasPath s a => Lens' s a
L.path
      mainBtn :: Button -> Bool
mainBtn Button
btn = Button
btn forall a. Eq a => a -> a -> Bool
== WidgetEnv s e
wenv forall s a. s -> Getting a s a -> a
^. forall s a. HasMainButton s a => Lens' s a
L.mainButton

      focused :: Bool
focused = forall s e. WidgetEnv s e -> WidgetNode s e -> Bool
isNodeFocused WidgetEnv s e
wenv WidgetNode s e
node
      pointInVp :: Point -> Bool
pointInVp Point
p = forall s e. WidgetNode s e -> Point -> Bool
isPointInNodeVp WidgetNode s e
node Point
p
      openLinkTask :: IO ()
openLinkTask = forall s e. WidgetEnv s e -> String -> IO ()
openLink WidgetEnv s e
wenv (Text -> String
T.unpack Text
url)

      requests :: [WidgetRequest s e]
requests = [forall s e i.
Typeable i =>
WidgetId -> Path -> IO i -> WidgetRequest s e
RunTask WidgetId
widgetId Path
path IO ()
openLinkTask]
      result :: WidgetResult s e
result = forall s e.
WidgetNode s e -> [WidgetRequest s e] -> WidgetResult s e
resultReqs WidgetNode s e
node forall {s} {e}. [WidgetRequest s e]
requests
      resultFocus :: WidgetResult s e
resultFocus = forall s e.
WidgetNode s e -> [WidgetRequest s e] -> WidgetResult s e
resultReqs WidgetNode s e
node [forall s e. WidgetId -> WidgetRequest s e
SetFocus (WidgetNode s e
node forall s a. s -> Getting a s a -> a
^. forall s a. HasInfo s a => Lens' s a
L.info forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall s a. HasWidgetId s a => Lens' s a
L.widgetId)]

  resize :: p -> WidgetNode s e -> p -> p -> (WidgetResult s e, Seq p)
resize p
wenv WidgetNode s e
node p
viewport p
children = (WidgetResult s e, Seq p)
resized where
    assignedAreas :: Seq p
assignedAreas = forall a. [a] -> Seq a
Seq.fromList [p
viewport]
    resized :: (WidgetResult s e, Seq p)
resized = (forall s e. WidgetNode s e -> WidgetResult s e
resultNode WidgetNode s e
node, Seq p
assignedAreas)

openLink :: WidgetEnv s e -> String -> IO ()
openLink :: forall s e. WidgetEnv s e -> String -> IO ()
openLink WidgetEnv s e
wenv String
url = IO () -> IO ()
catchIgnore (String -> IO ()
callCommand String
openCommand) where
  os :: Text
os = WidgetEnv s e
wenv forall s a. s -> Getting a s a -> a
^. forall s a. HasOs s a => Lens' s a
L.os
  command :: String
command
    | Text
os forall a. Eq a => a -> a -> Bool
== Text
"Windows" = String
"start"
    | Text
os forall a. Eq a => a -> a -> Bool
== Text
"Mac OS X" = String
"open"
    | Text
os forall a. Eq a => a -> a -> Bool
== Text
"Linux" = String
"xdg-open"
    | Bool
otherwise = String
"ls"
  openCommand :: String
openCommand = String
command forall a. [a] -> [a] -> [a]
++ String
" \"" forall a. [a] -> [a] -> [a]
++ String
url forall a. [a] -> [a] -> [a]
++ String
"\""

catchIgnore :: IO () -> IO ()
catchIgnore :: IO () -> IO ()
catchIgnore IO ()
task = forall a. IO a -> (SomeException -> IO a) -> IO a
catchAny IO ()
task (forall a b. a -> b -> a
const forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. Monad m => a -> m a
return ())