{-# LANGUAGE GeneralizedNewtypeDeriving #-}

{- |
Copyright : Flipstone Technology Partners 2023
License   : MIT
Stability : Stable

@since 1.0.0.0
-}
module Orville.PostgreSQL.Expr.Internal.Name.FunctionName
  ( FunctionName
  , functionName
  )
where

import Orville.PostgreSQL.Expr.Internal.Name.Identifier (Identifier, IdentifierExpression, identifier)
import qualified Orville.PostgreSQL.Raw.RawSql as RawSql

{- |
Type to represent a SQL function name. 'FunctionName' values constructed
via the 'functionName' function will be properly escaped as part of the
generated SQL. E.G.

> "some_function_name"

'FunctionName' provides a 'RawSql.SqlExpression' instance. See
'RawSql.unsafeSqlExpression' for how to construct a value with your own custom
SQL.

@since 1.0.0.0
-}
newtype FunctionName
  = FunctionName Identifier
  deriving
    ( -- | @since 1.0.0.0
      RawSql -> FunctionName
FunctionName -> RawSql
(FunctionName -> RawSql)
-> (RawSql -> FunctionName) -> SqlExpression FunctionName
forall a. (a -> RawSql) -> (RawSql -> a) -> SqlExpression a
$ctoRawSql :: FunctionName -> RawSql
toRawSql :: FunctionName -> RawSql
$cunsafeFromRawSql :: RawSql -> FunctionName
unsafeFromRawSql :: RawSql -> FunctionName
RawSql.SqlExpression
    , -- | @since 1.0.0.0
      Identifier -> FunctionName
FunctionName -> Identifier
(FunctionName -> Identifier)
-> (Identifier -> FunctionName)
-> IdentifierExpression FunctionName
forall name.
(name -> Identifier)
-> (Identifier -> name) -> IdentifierExpression name
$ctoIdentifier :: FunctionName -> Identifier
toIdentifier :: FunctionName -> Identifier
$cfromIdentifier :: Identifier -> FunctionName
fromIdentifier :: Identifier -> FunctionName
IdentifierExpression
    )

{- |
Construct a 'FunctionName' from a 'String' with proper escaping as part of the generated SQL.

@since 1.0.0.0
-}
functionName :: String -> FunctionName
functionName :: String -> FunctionName
functionName =
  Identifier -> FunctionName
FunctionName (Identifier -> FunctionName)
-> (String -> Identifier) -> String -> FunctionName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Identifier
identifier