{- ORMOLU_DISABLE -}
{- HLINT ignore -}
-- THIS IS A GENERATED FILE, DO NOT EDIT

{-# OPTIONS_GHC -Wno-unused-imports #-}
{-# OPTIONS_GHC -Wno-unused-matches #-}
{-# OPTIONS_GHC -Wno-deprecations #-}
module Language.LSP.Protocol.Internal.Types.ParameterInformation where

import Control.DeepSeq
import Data.Hashable
import GHC.Generics
import Language.LSP.Protocol.Utils.Misc
import Prettyprinter
import qualified Data.Aeson as Aeson
import qualified Data.Row.Aeson as Aeson
import qualified Data.Row.Hashable as Hashable
import qualified Data.Text
import qualified Language.LSP.Protocol.Internal.Types.MarkupContent
import qualified Language.LSP.Protocol.Types.Common

{-|
Represents a parameter of a callable-signature. A parameter can
have a label and a doc-comment.
-}
data ParameterInformation = ParameterInformation 
  { {-|
  The label of this parameter information.

  Either a string or an inclusive start and exclusive end offsets within its containing
  signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
  string representation as `Position` and `Range` does.

  To avoid ambiguities a server should use the [start, end] offset value instead of using
  a substring. Whether a client support this is controlled via `labelOffsetSupport` client
  capability.

  *Note*: a label of type string should be a substring of its containing signature label.
  Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
  -}
  _label :: (Data.Text.Text Language.LSP.Protocol.Types.Common.|? ( Language.LSP.Protocol.Types.Common.UInt
  , Language.LSP.Protocol.Types.Common.UInt ))
  , {-|
  The human-readable doc-comment of this parameter. Will be shown
  in the UI but can be omitted.
  -}
  _documentation :: (Maybe (Data.Text.Text Language.LSP.Protocol.Types.Common.|? Language.LSP.Protocol.Internal.Types.MarkupContent.MarkupContent))
  }
  deriving stock (Show, Eq, Ord, Generic)
  deriving anyclass (NFData, Hashable)
  deriving Pretty via (ViaJSON ParameterInformation)

instance Aeson.ToJSON ParameterInformation where
  toJSON (ParameterInformation arg0 arg1) = Aeson.object $ concat $  [["label" Aeson..= arg0]
    ,"documentation" Language.LSP.Protocol.Types.Common..=? arg1]

instance Aeson.FromJSON ParameterInformation where
  parseJSON = Aeson.withObject "ParameterInformation" $ \arg -> ParameterInformation <$> arg Aeson..: "label" <*> arg Language.LSP.Protocol.Types.Common..:!? "documentation"
