Types.hs

{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE TemplateHaskell   #-}

{-|
Module      : Headroom.FileSupport.Types
Description : Data types for "Headroom.FileSupport"
Copyright   : (c) 2019-2020 Vaclav Svejcar
License     : BSD-3-Clause
Maintainer  : vaclav.svejcar@gmail.com
Stability   : experimental
Portability : POSIX

This module contains data types for "Headroom.FileSupport" module.
-}

module Headroom.FileSupport.Types
  ( -- * Data Types
    FileInfo(..)
    -- * Lenses
  , fiFileTypeL
  , fiHeaderConfigL
  , fiHeaderPosL
  , fiVariablesL
  )
where

import           Headroom.Configuration.Types   ( CtHeaderConfig )
import           Headroom.Data.Lens             ( suffixLenses )
import           Headroom.FileType.Types        ( FileType )
import           Headroom.Variables.Types       ( Variables )
import           RIO


-- | Info extracted about the concrete source code file.
data FileInfo = FileInfo
  { fiFileType     :: !FileType
  -- ^ type of the file
  , fiHeaderConfig :: !CtHeaderConfig
  -- ^ configuration for license header
  , fiHeaderPos    :: !(Maybe (Int, Int))
  -- ^ position of existing license header
  , fiVariables    :: !Variables
  -- ^ additional extracted variables
  }
  deriving (Eq, Show)

suffixLenses ''FileInfo