{-# LANGUAGE TemplateHaskell #-}
-- | Defines types and functions to gather all the information needed for printing.
module Language.Drasil.Printing.PrintingInformation (
    Notation(..), HasPrintingOptions(..)
  , PrintingConfiguration, notation
  , PrintingInformation, ckdb, stg, configuration
  , piSys
  , defaultConfiguration, plainConfiguration
) where

import Control.Lens (makeLenses, Lens')

import Database.Drasil (ChunkDB)

import Language.Drasil (Stage(..))

-- | Notation can be scientific or for engineering.
data Notation = Scientific
              | Engineering

-- | Able to be printed.
class HasPrintingOptions c where
    -- | Holds the printing notation.
    getSetting :: Lens' c Notation

-- | Holds the printing configuration.
newtype PrintingConfiguration = PC { PrintingConfiguration -> Notation
_notation :: Notation }
makeLenses ''PrintingConfiguration

-- | Finds the notation used for the 'PrintingConfiguration'.
instance HasPrintingOptions  PrintingConfiguration where getSetting :: Lens' PrintingConfiguration Notation
getSetting = (Notation -> f Notation)
-> PrintingConfiguration -> f PrintingConfiguration
Iso' PrintingConfiguration Notation
notation

-- | Printing information contains a database, a stage, and a printing configuration.
data PrintingInformation = PI
                         { PrintingInformation -> ChunkDB
_ckdb :: ChunkDB
                         , PrintingInformation -> Stage
_stg :: Stage
                         , PrintingInformation -> PrintingConfiguration
_configuration :: PrintingConfiguration
                         }
makeLenses ''PrintingInformation

-- | Finds the notation used for the 'PrintingConfiguration' within the 'PrintingInformation'.
instance HasPrintingOptions  PrintingInformation where getSetting :: Lens' PrintingInformation Notation
getSetting  = (PrintingConfiguration -> f PrintingConfiguration)
-> PrintingInformation -> f PrintingInformation
Lens' PrintingInformation PrintingConfiguration
configuration ((PrintingConfiguration -> f PrintingConfiguration)
 -> PrintingInformation -> f PrintingInformation)
-> ((Notation -> f Notation)
    -> PrintingConfiguration -> f PrintingConfiguration)
-> (Notation -> f Notation)
-> PrintingInformation
-> f PrintingInformation
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Notation -> f Notation)
-> PrintingConfiguration -> f PrintingConfiguration
forall c. HasPrintingOptions c => Lens' c Notation
Lens' PrintingConfiguration Notation
getSetting

-- | Builds a document's printing information based on the system information.
piSys :: ChunkDB -> Stage -> PrintingConfiguration -> PrintingInformation
piSys :: ChunkDB -> Stage -> PrintingConfiguration -> PrintingInformation
piSys = ChunkDB -> Stage -> PrintingConfiguration -> PrintingInformation
PI

-- | Default configuration is for engineering.
defaultConfiguration :: PrintingConfiguration
defaultConfiguration :: PrintingConfiguration
defaultConfiguration = Notation -> PrintingConfiguration
PC Notation
Engineering

-- | Simple printing configuration is scientific.
plainConfiguration :: PrintingConfiguration
plainConfiguration :: PrintingConfiguration
plainConfiguration = Notation -> PrintingConfiguration
PC Notation
Scientific