{-|
Module      : AST
Description : Abstract syntax
Copyright   : (c) Harley Eades, 2026
Maintainer  : harley.eades@gmail.com

The abstract syntax for CFV files.
-}
module Configuration.Cfv.AST  
    (VarName
    ,VarValue
    ,Binding
    ,Var(..)
    ,VarAttr(..)
    ,varAttr
    ,revealVar) where
import Data.Text (Text)

-- | Security level for variables.
data VarAttr
  = Public  -- ^ The default; has no syntax.
  | Secret  -- ^ Declared with a @secret@ prefix.
  deriving (VarAttr -> VarAttr -> Bool
(VarAttr -> VarAttr -> Bool)
-> (VarAttr -> VarAttr -> Bool) -> Eq VarAttr
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VarAttr -> VarAttr -> Bool
== :: VarAttr -> VarAttr -> Bool
$c/= :: VarAttr -> VarAttr -> Bool
/= :: VarAttr -> VarAttr -> Bool
Eq, Eq VarAttr
Eq VarAttr =>
(VarAttr -> VarAttr -> Ordering)
-> (VarAttr -> VarAttr -> Bool)
-> (VarAttr -> VarAttr -> Bool)
-> (VarAttr -> VarAttr -> Bool)
-> (VarAttr -> VarAttr -> Bool)
-> (VarAttr -> VarAttr -> VarAttr)
-> (VarAttr -> VarAttr -> VarAttr)
-> Ord VarAttr
VarAttr -> VarAttr -> Bool
VarAttr -> VarAttr -> Ordering
VarAttr -> VarAttr -> VarAttr
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: VarAttr -> VarAttr -> Ordering
compare :: VarAttr -> VarAttr -> Ordering
$c< :: VarAttr -> VarAttr -> Bool
< :: VarAttr -> VarAttr -> Bool
$c<= :: VarAttr -> VarAttr -> Bool
<= :: VarAttr -> VarAttr -> Bool
$c> :: VarAttr -> VarAttr -> Bool
> :: VarAttr -> VarAttr -> Bool
$c>= :: VarAttr -> VarAttr -> Bool
>= :: VarAttr -> VarAttr -> Bool
$cmax :: VarAttr -> VarAttr -> VarAttr
max :: VarAttr -> VarAttr -> VarAttr
$cmin :: VarAttr -> VarAttr -> VarAttr
min :: VarAttr -> VarAttr -> VarAttr
Ord, Int -> VarAttr -> ShowS
[VarAttr] -> ShowS
VarAttr -> String
(Int -> VarAttr -> ShowS)
-> (VarAttr -> String) -> ([VarAttr] -> ShowS) -> Show VarAttr
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VarAttr -> ShowS
showsPrec :: Int -> VarAttr -> ShowS
$cshow :: VarAttr -> String
show :: VarAttr -> String
$cshowList :: [VarAttr] -> ShowS
showList :: [VarAttr] -> ShowS
Show)

-- | A variables value.
type VarValue = Text

-- | A variable's final value (after any command has been run) together with its
-- attribute.
--
-- The 'Show' instance never prints a secret value, so a list of bindings can
-- be logged safely:
--
-- > [("name",Public "x"),("key",Secret ())]
--
data Var 
  = Var VarAttr VarValue  
  deriving (Var -> Var -> Bool
(Var -> Var -> Bool) -> (Var -> Var -> Bool) -> Eq Var
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Var -> Var -> Bool
== :: Var -> Var -> Bool
$c/= :: Var -> Var -> Bool
/= :: Var -> Var -> Bool
Eq)

instance Show Var where
  showsPrec :: Int -> Var -> ShowS
  showsPrec :: Int -> Var -> ShowS
showsPrec Int
d (Var VarAttr
Public VarValue
v) =
    Bool -> ShowS -> ShowS
showParen (Int
d Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
> Int
10) (String -> ShowS
showString String
"Public " ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> VarValue -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
11 VarValue
v)
  showsPrec Int
_ (Var VarAttr
Secret VarValue
_) = String -> ShowS
showString String
"Secret ()"

-- | The variable's attribute.
varAttr :: Var -> VarAttr
varAttr :: Var -> VarAttr
varAttr (Var VarAttr
a VarValue
_) = VarAttr
a

-- | The variable's value, secret or not.
revealVar :: Var -> Text
revealVar :: Var -> VarValue
revealVar (Var VarAttr
_ VarValue
v) = VarValue
v

-- | A variables name.
type VarName = Text

-- | A variable binding: a name, attribute, and a value.
type Binding = (VarName, Var)