-- | Contains the high-level functionality to create 'PackageFiles' and then produce the
-- actual generated package files.
module Language.Drasil.Code.PackageFiles (
    consolidatePackageFiles,
    createPackageFiles,
) where

import Text.PrettyPrint.HughesPJ ( Doc, Doc, render )

import Drasil.GOOL (FileData(..), ModData(modDoc))
import Utils.Drasil (createDirIfMissing)

import Language.Drasil.Code.FileData (FileAndContents(fileDoc))
import qualified Language.Drasil.Code.FileData as D (
  filePath)
import System.FilePath.Posix (takeDirectory)
import System.IO (hPutStrLn, hClose, openFile, IOMode(WriteMode))

-- | Represents the generated files of a package as a unified
--   list of pairs of file names and rendered contents.
newtype PackageFiles = PackageFiles [(FilePath, Doc)]

-- | Converts 'FileData' ('FilePath's with module data) and 'FileAndContents'
-- ('FilePath's with auxiliary document information) into 'PackageFiles'
-- (a unified format for all file types)
consolidatePackageFiles :: [FileData] -> [FileAndContents] -> PackageFiles
consolidatePackageFiles :: [FileData] -> [FileAndContents] -> PackageFiles
consolidatePackageFiles [FileData]
files [FileAndContents]
aux = [(FilePath, Doc)] -> PackageFiles
PackageFiles ([(FilePath, Doc)] -> PackageFiles)
-> [(FilePath, Doc)] -> PackageFiles
forall a b. (a -> b) -> a -> b
$ [FilePath] -> [Doc] -> [(FilePath, Doc)]
forall a b. [a] -> [b] -> [(a, b)]
zip ((FileData -> FilePath) -> [FileData] -> [FilePath]
forall a b. (a -> b) -> [a] -> [b]
map FileData -> FilePath
filePath [FileData]
files [FilePath] -> [FilePath] -> [FilePath]
forall a. [a] -> [a] -> [a]
++ (FileAndContents -> FilePath) -> [FileAndContents] -> [FilePath]
forall a b. (a -> b) -> [a] -> [b]
map FileAndContents -> FilePath
D.filePath [FileAndContents]
aux)
  ((FileData -> Doc) -> [FileData] -> [Doc]
forall a b. (a -> b) -> [a] -> [b]
map (ModData -> Doc
modDoc (ModData -> Doc) -> (FileData -> ModData) -> FileData -> Doc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. FileData -> ModData
fileMod) [FileData]
files [Doc] -> [Doc] -> [Doc]
forall a. [a] -> [a] -> [a]
++ (FileAndContents -> Doc) -> [FileAndContents] -> [Doc]
forall a b. (a -> b) -> [a] -> [b]
map FileAndContents -> Doc
fileDoc [FileAndContents]
aux)

-- | Outputs the requested 'Package Files' into system files.
createPackageFiles :: PackageFiles -> IO ()
createPackageFiles :: PackageFiles -> IO ()
createPackageFiles (PackageFiles [(FilePath, Doc)]
cs) = ((FilePath, Doc) -> IO ()) -> [(FilePath, Doc)] -> IO ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (FilePath, Doc) -> IO ()
createPackageFile [(FilePath, Doc)]
cs

-- | Helper that uses pairs of 'PackageFiles' to create a file written with the given
-- document at the given 'FilePath'.
createPackageFile :: (FilePath, Doc) -> IO ()
createPackageFile :: (FilePath, Doc) -> IO ()
createPackageFile (FilePath
path, Doc
contents) = do
  Bool -> FilePath -> IO ()
createDirIfMissing Bool
True (FilePath -> FilePath
takeDirectory FilePath
path)
  Handle
h <- FilePath -> IOMode -> IO Handle
openFile FilePath
path IOMode
WriteMode
  Handle -> FilePath -> IO ()
hPutStrLn Handle
h (Doc -> FilePath
render Doc
contents)
  Handle -> IO ()
hClose Handle
h