{-# LANGUAGE NoImplicitPrelude          #-}
{-# LANGUAGE ConstraintKinds            #-}
{-# LANGUAGE DataKinds                  #-}
{-# LANGUAGE DeriveDataTypeable         #-}
{-# LANGUAGE DeriveGeneric              #-}
{-# LANGUAGE DuplicateRecordFields      #-}
{-# LANGUAGE FlexibleContexts           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE ScopedTypeVariables        #-}

-- | A module providing a type representing the name of an \'unqualified\'

-- component and related helper functions.

module Stack.Types.ComponentUtils
  ( StackUnqualCompName (..)
  , fromCabalName
  , toCabalName
  ) where

import           Distribution.PackageDescription
                   ( UnqualComponentName, mkUnqualComponentName
                   , unUnqualComponentName
                   )
import           RIO.Text (pack, unpack)
import           Stack.Prelude

-- | Type representing the name of an \'unqualified\' component (that is, the

-- component can be any sort - a (unnamed) main library or sub-library,

-- an executable, etc. ).

--

-- The corresponding The Cabal-syntax type is

-- 'Distribution.Types.UnqualComponentName.UnqualComponentName'.


-- Ideally, we would use the Cabal-syntax type and not 'Text', to avoid

-- unnecessary work, but there is no 'Hashable' instance for

-- 'Distribution.Types.UnqualComponentName.UnqualComponentName' yet.

newtype StackUnqualCompName = StackUnqualCompName
  { StackUnqualCompName -> Text
unqualCompToText :: Text
  }
  deriving (Typeable StackUnqualCompName
Typeable StackUnqualCompName =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g)
 -> StackUnqualCompName
 -> c StackUnqualCompName)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c StackUnqualCompName)
-> (StackUnqualCompName -> Constr)
-> (StackUnqualCompName -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c StackUnqualCompName))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c StackUnqualCompName))
-> ((forall b. Data b => b -> b)
    -> StackUnqualCompName -> StackUnqualCompName)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r)
-> (forall u.
    (forall d. Data d => d -> u) -> StackUnqualCompName -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> StackUnqualCompName -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d)
    -> StackUnqualCompName -> m StackUnqualCompName)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> StackUnqualCompName -> m StackUnqualCompName)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> StackUnqualCompName -> m StackUnqualCompName)
-> Data StackUnqualCompName
StackUnqualCompName -> Constr
StackUnqualCompName -> DataType
(forall b. Data b => b -> b)
-> StackUnqualCompName -> StackUnqualCompName
forall a.
Typeable a =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u.
Int -> (forall d. Data d => d -> u) -> StackUnqualCompName -> u
forall u.
(forall d. Data d => d -> u) -> StackUnqualCompName -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c StackUnqualCompName
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g)
-> StackUnqualCompName
-> c StackUnqualCompName
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c StackUnqualCompName)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c StackUnqualCompName)
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g)
-> StackUnqualCompName
-> c StackUnqualCompName
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g)
-> StackUnqualCompName
-> c StackUnqualCompName
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c StackUnqualCompName
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c StackUnqualCompName
$ctoConstr :: StackUnqualCompName -> Constr
toConstr :: StackUnqualCompName -> Constr
$cdataTypeOf :: StackUnqualCompName -> DataType
dataTypeOf :: StackUnqualCompName -> DataType
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c StackUnqualCompName)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c StackUnqualCompName)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c StackUnqualCompName)
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c StackUnqualCompName)
$cgmapT :: (forall b. Data b => b -> b)
-> StackUnqualCompName -> StackUnqualCompName
gmapT :: (forall b. Data b => b -> b)
-> StackUnqualCompName -> StackUnqualCompName
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
gmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
gmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> StackUnqualCompName -> r
$cgmapQ :: forall u.
(forall d. Data d => d -> u) -> StackUnqualCompName -> [u]
gmapQ :: forall u.
(forall d. Data d => d -> u) -> StackUnqualCompName -> [u]
$cgmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> StackUnqualCompName -> u
gmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> StackUnqualCompName -> u
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> StackUnqualCompName -> m StackUnqualCompName
Data, StackUnqualCompName -> StackUnqualCompName -> Bool
(StackUnqualCompName -> StackUnqualCompName -> Bool)
-> (StackUnqualCompName -> StackUnqualCompName -> Bool)
-> Eq StackUnqualCompName
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: StackUnqualCompName -> StackUnqualCompName -> Bool
== :: StackUnqualCompName -> StackUnqualCompName -> Bool
$c/= :: StackUnqualCompName -> StackUnqualCompName -> Bool
/= :: StackUnqualCompName -> StackUnqualCompName -> Bool
Eq, (forall x. StackUnqualCompName -> Rep StackUnqualCompName x)
-> (forall x. Rep StackUnqualCompName x -> StackUnqualCompName)
-> Generic StackUnqualCompName
forall x. Rep StackUnqualCompName x -> StackUnqualCompName
forall x. StackUnqualCompName -> Rep StackUnqualCompName x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. StackUnqualCompName -> Rep StackUnqualCompName x
from :: forall x. StackUnqualCompName -> Rep StackUnqualCompName x
$cto :: forall x. Rep StackUnqualCompName x -> StackUnqualCompName
to :: forall x. Rep StackUnqualCompName x -> StackUnqualCompName
Generic, Eq StackUnqualCompName
Eq StackUnqualCompName =>
(Int -> StackUnqualCompName -> Int)
-> (StackUnqualCompName -> Int) -> Hashable StackUnqualCompName
Int -> StackUnqualCompName -> Int
StackUnqualCompName -> Int
forall a. Eq a => (Int -> a -> Int) -> (a -> Int) -> Hashable a
$chashWithSalt :: Int -> StackUnqualCompName -> Int
hashWithSalt :: Int -> StackUnqualCompName -> Int
$chash :: StackUnqualCompName -> Int
hash :: StackUnqualCompName -> Int
Hashable, String -> StackUnqualCompName
(String -> StackUnqualCompName) -> IsString StackUnqualCompName
forall a. (String -> a) -> IsString a
$cfromString :: String -> StackUnqualCompName
fromString :: String -> StackUnqualCompName
IsString, StackUnqualCompName -> ()
(StackUnqualCompName -> ()) -> NFData StackUnqualCompName
forall a. (a -> ()) -> NFData a
$crnf :: StackUnqualCompName -> ()
rnf :: StackUnqualCompName -> ()
NFData, Eq StackUnqualCompName
Eq StackUnqualCompName =>
(StackUnqualCompName -> StackUnqualCompName -> Ordering)
-> (StackUnqualCompName -> StackUnqualCompName -> Bool)
-> (StackUnqualCompName -> StackUnqualCompName -> Bool)
-> (StackUnqualCompName -> StackUnqualCompName -> Bool)
-> (StackUnqualCompName -> StackUnqualCompName -> Bool)
-> (StackUnqualCompName
    -> StackUnqualCompName -> StackUnqualCompName)
-> (StackUnqualCompName
    -> StackUnqualCompName -> StackUnqualCompName)
-> Ord StackUnqualCompName
StackUnqualCompName -> StackUnqualCompName -> Bool
StackUnqualCompName -> StackUnqualCompName -> Ordering
StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: StackUnqualCompName -> StackUnqualCompName -> Ordering
compare :: StackUnqualCompName -> StackUnqualCompName -> Ordering
$c< :: StackUnqualCompName -> StackUnqualCompName -> Bool
< :: StackUnqualCompName -> StackUnqualCompName -> Bool
$c<= :: StackUnqualCompName -> StackUnqualCompName -> Bool
<= :: StackUnqualCompName -> StackUnqualCompName -> Bool
$c> :: StackUnqualCompName -> StackUnqualCompName -> Bool
> :: StackUnqualCompName -> StackUnqualCompName -> Bool
$c>= :: StackUnqualCompName -> StackUnqualCompName -> Bool
>= :: StackUnqualCompName -> StackUnqualCompName -> Bool
$cmax :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName
max :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName
$cmin :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName
min :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName
Ord, ReadPrec [StackUnqualCompName]
ReadPrec StackUnqualCompName
Int -> ReadS StackUnqualCompName
ReadS [StackUnqualCompName]
(Int -> ReadS StackUnqualCompName)
-> ReadS [StackUnqualCompName]
-> ReadPrec StackUnqualCompName
-> ReadPrec [StackUnqualCompName]
-> Read StackUnqualCompName
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
$creadsPrec :: Int -> ReadS StackUnqualCompName
readsPrec :: Int -> ReadS StackUnqualCompName
$creadList :: ReadS [StackUnqualCompName]
readList :: ReadS [StackUnqualCompName]
$creadPrec :: ReadPrec StackUnqualCompName
readPrec :: ReadPrec StackUnqualCompName
$creadListPrec :: ReadPrec [StackUnqualCompName]
readListPrec :: ReadPrec [StackUnqualCompName]
Read, Int -> StackUnqualCompName -> ShowS
[StackUnqualCompName] -> ShowS
StackUnqualCompName -> String
(Int -> StackUnqualCompName -> ShowS)
-> (StackUnqualCompName -> String)
-> ([StackUnqualCompName] -> ShowS)
-> Show StackUnqualCompName
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> StackUnqualCompName -> ShowS
showsPrec :: Int -> StackUnqualCompName -> ShowS
$cshow :: StackUnqualCompName -> String
show :: StackUnqualCompName -> String
$cshowList :: [StackUnqualCompName] -> ShowS
showList :: [StackUnqualCompName] -> ShowS
Show, Typeable)

fromCabalName :: UnqualComponentName -> StackUnqualCompName
fromCabalName :: UnqualComponentName -> StackUnqualCompName
fromCabalName UnqualComponentName
unqualName =
  Text -> StackUnqualCompName
StackUnqualCompName (Text -> StackUnqualCompName) -> Text -> StackUnqualCompName
forall a b. (a -> b) -> a -> b
$ String -> Text
pack (String -> Text)
-> (UnqualComponentName -> String) -> UnqualComponentName -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. UnqualComponentName -> String
unUnqualComponentName (UnqualComponentName -> Text) -> UnqualComponentName -> Text
forall a b. (a -> b) -> a -> b
$ UnqualComponentName
unqualName

toCabalName :: StackUnqualCompName -> UnqualComponentName
toCabalName :: StackUnqualCompName -> UnqualComponentName
toCabalName (StackUnqualCompName Text
unqualName) =
  String -> UnqualComponentName
mkUnqualComponentName (Text -> String
unpack Text
unqualName)