-- | Gathers and organizes all the information for the [Drasil website](https://jacquescarette.github.io/Drasil/).
module Drasil.Website.Body where

import Language.Drasil.Printers (PrintingInformation(..), defaultConfiguration)
import Database.Drasil
import SysInfo.Drasil
import Language.Drasil
import Drasil.DocLang (findAllRefs)

import Drasil.Website.Introduction (introSec)
import Drasil.Website.CaseStudy (caseStudySec)
import Drasil.Website.Example (exampleSec, exampleRefs, allExampleSI)
import Drasil.Website.Documentation (docsSec, docRefs)
import Drasil.Website.Analysis (analysisSec, analysisRefs)

-- * Functions to Generate the Website Through Drasil

-- | Printing info to get document to generate. Takes in the 'FolderLocation'.
printSetting :: FolderLocation -> PrintingInformation
printSetting :: FolderLocation -> PrintingInformation
printSetting fl :: FolderLocation
fl = ChunkDB -> Stage -> PrintingConfiguration -> PrintingInformation
PI (FolderLocation -> ChunkDB
symbMap FolderLocation
fl) Stage
Equational PrintingConfiguration
defaultConfiguration

-- | Instead of being an 'SRSDecl', this takes the folder locations and generates the document from there.
mkWebsite :: FolderLocation -> Document
mkWebsite :: FolderLocation -> Document
mkWebsite fl :: FolderLocation
fl =
    --Document  -- Title  --  author  (hack for now to show up in proper spot) -- no table of contents -- [Section]
    Title -> Title -> ShowTableOfContents -> [Section] -> Document
Document (String -> Title
S String
websiteTitle) (Reference -> Title -> Title
forall r.
(HasUID r, HasRefAddress r, HasShortName r) =>
r -> Title -> Title
namedRef Reference
gitHubRef (String -> Title
S "Link to GitHub Repository")) ShowTableOfContents
NoToC ([Section] -> Document) -> [Section] -> Document
forall a b. (a -> b) -> a -> b
$ FolderLocation -> [Section]
sections FolderLocation
fl

-- | Folder locations based on environment variables (using 'getEnv' in "Drasil.Website.Main").
data FolderLocation = Folder {
    -- | Deploy location. Currently unused, but may be needed in the future.
    FolderLocation -> String
depL :: FilePath
    -- | Haddock documentation root file path. After using @make deploy@, this should be @deploy/docs@.
  , FolderLocation -> String
docsRt :: FilePath
    -- | Example root file path. After using @make deploy@, this should be @deploy/examples@.
  , FolderLocation -> String
exRt :: FilePath
    -- | Package dependency graph root file path. After using @make deploy@, this should be @deploy/graphs@.
  , FolderLocation -> String
graphRt :: FilePath
    -- | Analysis root file path. After using @make deploy@, this should be @deploy/analysis@.
  , FolderLocation -> String
analysisRt :: FilePath
    -- | Type graphs root file path. After using @make deploy@, this should be @deploy\/analysis\/TypeDependencyGraphs@.
  , FolderLocation -> String
typeGraphFolder :: FilePath
    -- | Class-instance graphs root file path. After using @make deploy@, this should be @deploy\/analysis\/DataTable\/packagegraphs@.
  , FolderLocation -> String
classInstFolder :: FilePath
    -- | Repository root, used for linking to generated code in GitHub.
  , FolderLocation -> String
repoRt :: FilePath
    -- | Deploy build number. Currently unused.
  , FolderLocation -> String
buildNum :: FilePath
    -- | Deploy build path. Currently unused.
  , FolderLocation -> String
buildPth :: FilePath
    -- | List of Drasil packages taken from the @Makefile@.
  , FolderLocation -> [String]
packages :: [String]
    }

-- TODO: Should the website be using a ``SystemInformation''? This is primarily for the SmithEtAl template.
--       It seems like the website is primarily that functions on a chunkdb.

-- | System information.
si :: FolderLocation -> SystemInformation
si :: FolderLocation -> SystemInformation
si fl :: FolderLocation
fl = SI :: forall a b c e f h i j d.
(CommonIdea a, Idea a, Idea b, HasName c, Quantity e, Eq e,
 MayHaveUnit e, Quantity f, MayHaveUnit f, Concept f, Eq f,
 Quantity h, MayHaveUnit h, Quantity i, MayHaveUnit i, HasUID j,
 Constrained j) =>
a
-> b
-> [c]
-> d
-> [e]
-> [f]
-> [InstanceModel]
-> [DataDefinition]
-> [String]
-> [h]
-> [i]
-> [Block SimpleQDef]
-> [j]
-> [ConstQDef]
-> ChunkDB
-> ChunkDB
-> ReferenceDB
-> SystemInformation
SI {
    _sys :: CI
_sys         = CI
webName,
    _kind :: CI
_kind        = CI
web,
    _authors :: [Person]
_authors     = [] :: [Person],
    _quants :: [QuantityDict]
_quants      = [] :: [QuantityDict],
    _purpose :: [Any]
_purpose     = [],
    _concepts :: [UnitalChunk]
_concepts    = [] :: [UnitalChunk],
    _instModels :: [InstanceModel]
_instModels  = [],
    _datadefs :: [DataDefinition]
_datadefs    = [],
    _configFiles :: [String]
_configFiles = [],
    _inputs :: [QuantityDict]
_inputs      = [] :: [QuantityDict],
    _outputs :: [QuantityDict]
_outputs     = [] :: [QuantityDict],
    _defSequence :: [Block SimpleQDef]
_defSequence = [] :: [Block SimpleQDef],
    _constraints :: [ConstrainedChunk]
_constraints = [] :: [ConstrainedChunk],
    _constants :: [ConstQDef]
_constants   = [] :: [ConstQDef],
    _sysinfodb :: ChunkDB
_sysinfodb   = FolderLocation -> ChunkDB
symbMap FolderLocation
fl,
    _usedinfodb :: ChunkDB
_usedinfodb  = ChunkDB
usedDB,
    refdb :: ReferenceDB
refdb        = BibRef -> [ConceptInstance] -> ReferenceDB
rdb [] []
}

-- | Puts all the sections in order. Basically the website version of the SRS declaration.
sections :: FolderLocation -> [Section]
sections :: FolderLocation -> [Section]
sections fl :: FolderLocation
fl = [Section
headerSec, Reference
-> Reference -> Reference -> Reference -> Reference -> Section
introSec (Section -> Reference
forall r.
(HasUID r, HasRefAddress r, HasShortName r) =>
r -> Reference
ref Section
caseStudySec) (Section -> Reference
forall r.
(HasUID r, HasRefAddress r, HasShortName r) =>
r -> Reference
ref (Section -> Reference) -> Section -> Reference
forall a b. (a -> b) -> a -> b
$ String -> Section
docsSec (String -> Section) -> String -> Section
forall a b. (a -> b) -> a -> b
$ FolderLocation -> String
docsRt FolderLocation
fl) (Section -> Reference
forall r.
(HasUID r, HasRefAddress r, HasShortName r) =>
r -> Reference
ref (Section -> Reference) -> Section -> Reference
forall a b. (a -> b) -> a -> b
$ String -> String -> String -> String -> [String] -> Section
analysisSec (FolderLocation -> String
analysisRt FolderLocation
fl) (FolderLocation -> String
typeGraphFolder FolderLocation
fl) (FolderLocation -> String
classInstFolder FolderLocation
fl) (FolderLocation -> String
graphRt FolderLocation
fl) ([String] -> Section) -> [String] -> Section
forall a b. (a -> b) -> a -> b
$ FolderLocation -> [String]
packages FolderLocation
fl) Reference
gitHubRef Reference
wikiRef, 
  String -> String -> Section
exampleSec (FolderLocation -> String
repoRt FolderLocation
fl) (FolderLocation -> String
exRt FolderLocation
fl), Section
caseStudySec, String -> Section
docsSec (FolderLocation -> String
docsRt FolderLocation
fl), String -> String -> String -> String -> [String] -> Section
analysisSec (FolderLocation -> String
analysisRt FolderLocation
fl) (FolderLocation -> String
typeGraphFolder FolderLocation
fl) (FolderLocation -> String
classInstFolder FolderLocation
fl) (FolderLocation -> String
graphRt FolderLocation
fl) ([String] -> Section) -> [String] -> Section
forall a b. (a -> b) -> a -> b
$ FolderLocation -> [String]
packages FolderLocation
fl,
  FolderLocation -> Section
footer FolderLocation
fl]

-- | Needed for references and terms to work.
symbMap :: FolderLocation -> ChunkDB
symbMap :: FolderLocation -> ChunkDB
symbMap fl :: FolderLocation
fl = [QuantityDict]
-> [IdeaDict]
-> [ConceptChunk]
-> [UnitDefn]
-> [DataDefinition]
-> [InstanceModel]
-> [GenDefn]
-> [TheoryModel]
-> [ConceptInstance]
-> [Section]
-> [LabelledContent]
-> [Reference]
-> ChunkDB
forall q t c u.
(Quantity q, MayHaveUnit q, Idea t, Concept c, IsUnit u) =>
[q]
-> [t]
-> [c]
-> [u]
-> [DataDefinition]
-> [InstanceModel]
-> [GenDefn]
-> [TheoryModel]
-> [ConceptInstance]
-> [Section]
-> [LabelledContent]
-> [Reference]
-> ChunkDB
cdb ([] :: [QuantityDict]) ((CI -> IdeaDict) -> [CI] -> [IdeaDict]
forall a b. (a -> b) -> [a] -> [b]
map CI -> IdeaDict
forall c. Idea c => c -> IdeaDict
nw [CI
webName, CI
web] [IdeaDict] -> [IdeaDict] -> [IdeaDict]
forall a. [a] -> [a] -> [a]
++ (SystemInformation -> IdeaDict)
-> [SystemInformation] -> [IdeaDict]
forall a b. (a -> b) -> [a] -> [b]
map SystemInformation -> IdeaDict
getSysName [SystemInformation]
allExampleSI)
  ([] :: [ConceptChunk]) ([] :: [UnitDefn]) [] [] [] [] [] [] [] ([Reference] -> ChunkDB) -> [Reference] -> ChunkDB
forall a b. (a -> b) -> a -> b
$ FolderLocation -> [Reference]
allRefs FolderLocation
fl

-- | Helper to get the system name as an 'IdeaDict' from 'SystemInformation'.
getSysName :: SystemInformation -> IdeaDict
getSysName :: SystemInformation -> IdeaDict
getSysName SI{_sys :: ()
_sys = a
nm} = a -> IdeaDict
forall c. Idea c => c -> IdeaDict
nw a
nm 

-- | Empty database needed for 'si' to work.
usedDB :: ChunkDB
usedDB :: ChunkDB
usedDB = [QuantityDict]
-> [IdeaDict]
-> [ConceptChunk]
-> [UnitDefn]
-> [DataDefinition]
-> [InstanceModel]
-> [GenDefn]
-> [TheoryModel]
-> [ConceptInstance]
-> [Section]
-> [LabelledContent]
-> [Reference]
-> ChunkDB
forall q t c u.
(Quantity q, MayHaveUnit q, Idea t, Concept c, IsUnit u) =>
[q]
-> [t]
-> [c]
-> [u]
-> [DataDefinition]
-> [InstanceModel]
-> [GenDefn]
-> [TheoryModel]
-> [ConceptInstance]
-> [Section]
-> [LabelledContent]
-> [Reference]
-> ChunkDB
cdb ([] :: [QuantityDict]) ([] :: [IdeaDict])
           ([] :: [ConceptChunk]) ([] :: [UnitDefn]) [] [] [] [] [] [] [] ([] :: [Reference])

-- | Holds all references and links used in the website.
allRefs :: FolderLocation -> [Reference]
allRefs :: FolderLocation -> [Reference]
allRefs fl :: FolderLocation
fl = [Reference
gitHubRef, Reference
wikiRef]
  [Reference] -> [Reference] -> [Reference]
forall a. [a] -> [a] -> [a]
++ String -> String -> [Reference]
exampleRefs (FolderLocation -> String
repoRt FolderLocation
fl) (FolderLocation -> String
exRt FolderLocation
fl) 
  [Reference] -> [Reference] -> [Reference]
forall a. [a] -> [a] -> [a]
++ String -> [Reference]
docRefs (FolderLocation -> String
docsRt FolderLocation
fl) 
  [Reference] -> [Reference] -> [Reference]
forall a. [a] -> [a] -> [a]
++ String -> String -> String -> String -> [String] -> [Reference]
analysisRefs (FolderLocation -> String
analysisRt FolderLocation
fl) (FolderLocation -> String
typeGraphFolder FolderLocation
fl) (FolderLocation -> String
classInstFolder FolderLocation
fl) (FolderLocation -> String
graphRt FolderLocation
fl) (FolderLocation -> [String]
packages FolderLocation
fl)
  [Reference] -> [Reference] -> [Reference]
forall a. [a] -> [a] -> [a]
++ (Section -> [Reference]) -> [Section] -> [Reference]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap Section -> [Reference]
findAllRefs (FolderLocation -> [Section]
sections FolderLocation
fl)

-- | Used for system name and kind inside of 'si'.
webName, web :: CI
webName :: CI
webName = String -> NP -> String -> [UID] -> CI
commonIdea "websiteName" (String -> NP
cn String
websiteTitle) "Drasil" []
web :: CI
web = String -> NP -> String -> [UID] -> CI
commonIdea "website" (String -> NP
cn "website") "web" []

-- * Header Section

-- | Header section creator.
headerSec :: Section
headerSec :: Section
headerSec = 
  Title -> [Contents] -> [Section] -> Reference -> Section
section Title
EmptyS -- No title
  [LabelledContent -> Contents
LlC LabelledContent
imageContent] -- Contents
  [] (Reference -> Section) -> Reference -> Section
forall a b. (a -> b) -> a -> b
$ String -> Title -> Reference
makeSecRef "Header" (Title -> Reference) -> Title -> Reference
forall a b. (a -> b) -> a -> b
$ String -> Title
S "Header" -- Section reference

-- | For the drasil tree image on the website.
imageContent :: LabelledContent
imageContent :: LabelledContent
imageContent = Reference -> RawContent -> LabelledContent
llcc (String -> Reference
makeFigRef "Drasil") (RawContent -> LabelledContent) -> RawContent -> LabelledContent
forall a b. (a -> b) -> a -> b
$ Title -> String -> MaxWidthPercent -> RawContent
figWithWidth Title
EmptyS String
imagePath 50

-- | Used for the repository link.
gitHubRef :: Reference
gitHubRef :: Reference
gitHubRef = String -> String -> ShortName -> Reference
makeURI "gitHubRepo" String
gitHubInfoURL (Title -> ShortName
shortname' (Title -> ShortName) -> Title -> ShortName
forall a b. (a -> b) -> a -> b
$ String -> Title
S "gitHubRepo")
wikiRef :: Reference
wikiRef :: Reference
wikiRef = String -> String -> ShortName -> Reference
makeURI "gitHubWiki" (String
gitHubInfoURL String -> String -> String
forall a. [a] -> [a] -> [a]
++ "/wiki") (Title -> ShortName
shortname' (Title -> ShortName) -> Title -> ShortName
forall a b. (a -> b) -> a -> b
$ String -> Title
S "gitHubWiki")

-- | Hardcoded info for the title, URL, and image path.
websiteTitle :: String
gitHubInfoURL, imagePath :: FilePath
websiteTitle :: String
websiteTitle = "Drasil - Generate All the Things!"
gitHubInfoURL :: String
gitHubInfoURL = "https://github.com/JacquesCarette/Drasil"
imagePath :: String
imagePath = "./images/Icon.png"

-- * Footer Section

-- | Create the footer section.
footer :: FolderLocation -> Section
footer :: FolderLocation -> Section
footer _ = Title -> [Contents] -> [Section] -> Reference -> Section
section Title
EmptyS [Title -> Contents
mkParagraph Title
copyrightInfo] [] (Reference -> Section) -> Reference -> Section
forall a b. (a -> b) -> a -> b
$ String -> Title -> Reference
makeSecRef "Footer" (Title -> Reference) -> Title -> Reference
forall a b. (a -> b) -> a -> b
$ String -> Title
S "Footer"

-- | 'footer' contents.
copyrightInfo :: Sentence
copyrightInfo :: Title
copyrightInfo = String -> Title
S "Copyright (c) Jacques Carette, 2021. All rights reserved. This website is a software artifact generated by Drasil."

-- uncomment to add in build number and path information
--buildInfo :: String -> String -> Sentence
--buildInfo bnum bPath = S $ "Build number: " ++ bnum ++ ". Generated from " ++ bPath ++ "."