{-# OPTIONS_GHC -Wno-redundant-constraints #-}
-- | Various helpers for building Sentences from other bits.
-- Really ought to be moved out to (likely) docLang, but is here for now.
module Language.Drasil.Development.Sentence (
  -- * All Lowercase
  phrase, plural, phrasePoss, pluralPoss,
  -- * Capitalize First Word
  atStart, atStart',
  -- * Capitalize All Words
  titleize, titleize',
  -- * from NPStruct to Sentence
  toSent,
  -- * Short Form (lowercase)
  short, introduceAbb) where

import Control.Lens ((^.))

import Language.Drasil.Classes (NamedIdea(term), Idea)
import Language.Drasil.Sentence ((+:+), sParen, sentenceTerm,
  sentencePlural, sentenceShort)
import qualified Language.Drasil.Sentence as S
import qualified Language.Drasil.NounPhrase as NP
import Language.Drasil.NounPhrase.Core (NPStruct(..))
import Drasil.Database.UID (HasUID(..))

-- | Translate from NPStruct to Sentence
toSent :: NPStruct -> S.Sentence
toSent :: NPStruct -> Sentence
toSent (S String
s) = String -> Sentence
S.S String
s
toSent (NPStruct
s1 :-: NPStruct
s2) = NPStruct -> Sentence
toSent NPStruct
s1 Sentence -> Sentence -> Sentence
S.:+: NPStruct -> Sentence
toSent NPStruct
s2 -- no space between noun phases
toSent (NPStruct
s1 :+: NPStruct
s2) = NPStruct -> Sentence
toSent NPStruct
s1 Sentence -> Sentence -> Sentence
S.+:+ NPStruct -> Sentence
toSent NPStruct
s2 -- insert space between noun phrases
toSent (P Symbol
p) = Symbol -> Sentence
S.P Symbol
p

-- | Get short form (if it exists), else get term of an 'Idea'.
-- Uses the UID of the 'Idea' in a 'Ch' Sentence constructor to get the short
-- form using getA. getA may return Nothing, in which case lookupS uses the
-- term, where lookupS is the main helper for looking up the short form of a
-- 'Ch' Sentence.
short :: Idea c => c -> S.Sentence
short :: forall c. Idea c => c -> Sentence
short c
c = UID -> Sentence
sentenceShort (c
c c -> Getting UID c UID -> UID
forall s a. s -> Getting a s a -> a
^. Getting UID c UID
forall c. HasUID c => Getter c UID
Getter c UID
uid)

-- | Helper for common pattern of introducing the title-case version of a
-- noun phrase (from an Idea)
-- followed by its abbreviation in parentheses.
introduceAbb :: Idea n => n -> S.Sentence
introduceAbb :: forall c. Idea c => c -> Sentence
introduceAbb n
n = NPStruct -> Sentence
toSent (NP -> NPStruct
forall n. NounPhrase n => n -> NPStruct
NP.titleizeNP (n
n n -> Getting NP n NP -> NP
forall s a. s -> Getting a s a -> a
^. Getting NP n NP
forall c. NamedIdea c => Lens' c NP
Lens' n NP
term)) Sentence -> Sentence -> Sentence
+:+ Sentence -> Sentence
sParen (n -> Sentence
forall c. Idea c => c -> Sentence
short n
n)

-- | Helper function for getting the sentence case of a noun phrase from a
-- 'NamedIdea'.
atStart, atStart' :: NamedIdea n => n -> S.Sentence
-- | Singular sentence case.
atStart :: forall n. NamedIdea n => n -> Sentence
atStart  n
n = NPStruct -> Sentence
toSent (NPStruct -> Sentence) -> NPStruct -> Sentence
forall a b. (a -> b) -> a -> b
$ NP -> NPStruct
forall n. NounPhrase n => n -> NPStruct
NP.atStartNP (n
n n -> Getting NP n NP -> NP
forall s a. s -> Getting a s a -> a
^. Getting NP n NP
forall c. NamedIdea c => Lens' c NP
Lens' n NP
term)
-- | Plural sentence case.
atStart' :: forall n. NamedIdea n => n -> Sentence
atStart' n
n = NPStruct -> Sentence
toSent (NPStruct -> Sentence) -> NPStruct -> Sentence
forall a b. (a -> b) -> a -> b
$ NP -> NPStruct
forall n. NounPhrase n => n -> NPStruct
NP.atStartNP' (n
n n -> Getting NP n NP -> NP
forall s a. s -> Getting a s a -> a
^. Getting NP n NP
forall c. NamedIdea c => Lens' c NP
Lens' n NP
term)

-- | Helper function for getting the title case of a noun phrase from a
-- 'NamedIdea'.
titleize, titleize' :: NamedIdea n => n -> S.Sentence
-- | Singular title case.
titleize :: forall n. NamedIdea n => n -> Sentence
titleize  n
n = NPStruct -> Sentence
toSent (NPStruct -> Sentence) -> NPStruct -> Sentence
forall a b. (a -> b) -> a -> b
$ NP -> NPStruct
forall n. NounPhrase n => n -> NPStruct
NP.titleizeNP (n
n n -> Getting NP n NP -> NP
forall s a. s -> Getting a s a -> a
^. Getting NP n NP
forall c. NamedIdea c => Lens' c NP
Lens' n NP
term)
-- | Plural title case.
titleize' :: forall n. NamedIdea n => n -> Sentence
titleize' n
n = NPStruct -> Sentence
toSent (NPStruct -> Sentence) -> NPStruct -> Sentence
forall a b. (a -> b) -> a -> b
$ NP -> NPStruct
forall n. NounPhrase n => n -> NPStruct
NP.titleizeNP' (n
n n -> Getting NP n NP -> NP
forall s a. s -> Getting a s a -> a
^. Getting NP n NP
forall c. NamedIdea c => Lens' c NP
Lens' n NP
term)

-- | Helper for getting the phrase from a 'NamedIdea' using it's UID.
phrase :: NamedIdea n => n -> S.Sentence
phrase :: forall n. NamedIdea n => n -> Sentence
phrase n
n = UID -> Sentence
sentenceTerm (n
n n -> Getting UID n UID -> UID
forall s a. s -> Getting a s a -> a
^. Getting UID n UID
forall c. HasUID c => Getter c UID
Getter n UID
uid)

-- | Helper for getting the plural of a phrase from a 'NamedIdea'.
plural :: NamedIdea n => n -> S.Sentence
plural :: forall n. NamedIdea n => n -> Sentence
plural n
n = UID -> Sentence
sentencePlural (n
n n -> Getting UID n UID -> UID
forall s a. s -> Getting a s a -> a
^. Getting UID n UID
forall c. HasUID c => Getter c UID
Getter n UID
uid)
--plural n = NP.plural (n ^. term)

-- | Helper for getting the possesive cases from the term of a 'NamedIdea'.
phrasePoss, pluralPoss :: NamedIdea n => n -> S.Sentence
-- | Singular possesive function
phrasePoss :: forall n. NamedIdea n => n -> Sentence
phrasePoss n
a = n -> Sentence
forall n. NamedIdea n => n -> Sentence
phrase n
a Sentence -> Sentence -> Sentence
S.:+: String -> Sentence
S.S String
"'s"
-- | Plural possesive function
pluralPoss :: forall n. NamedIdea n => n -> Sentence
pluralPoss n
a = n -> Sentence
forall n. NamedIdea n => n -> Sentence
plural n
a Sentence -> Sentence -> Sentence
S.:+: String -> Sentence
S.S String
"'"