VariablePresentationHintJSON.hs

{-# LANGUAGE TemplateHaskell #-}

module Phoityne.VSCode.TH.VariablePresentationHintJSON where

import Data.Aeson.TH

import Phoityne.VSCode.Utility

-- |
-- Optional properties of a variable that can be used to determine how to render the variable in the UI.
--
data VariablePresentationHint =
VariablePresentationHint {
{-
The kind of variable. Before introducing additional values, try to use the listed values.
Values:
'property': Indicates that the object is a property.
'method': Indicates that the object is a method.
'class': Indicates that the object is a class.
'data': Indicates that the object is data.
'event': Indicates that the object is an event.
'baseClass': Indicates that the object is a base class.
'innerClass': Indicates that the object is an inner class.
'interface': Indicates that the object is an interface.
'mostDerivedClass': Indicates that the object is the most derived class.
'virtual': Indicates that the object is virtual, that means it is a synthetic object introduced by the adapter for rendering purposes, e.g. an index range for large arrays.
etc.
-}
kindVariablePresentationHint :: String
{-
Set of attributes represented as an array of strings. Before introducing additional values, try to use the listed values.
Values:
'static': Indicates that the object is static.
'constant': Indicates that the object is a constant.
'readOnly': Indicates that the object is read only.
'rawString': Indicates that the object is a raw string.
'hasObjectId': Indicates that the object can have an Object ID created for it.
'canHaveObjectId': Indicates that the object has an Object ID associated with it.
'hasSideEffects': Indicates that the evaluation had side effects.
etc.
-}
, attributesVariablePresentationHint :: [String]
{-
Visibility of variable. Before introducing additional values, try to use the listed values.
Values: 'public', 'private', 'protected', 'internal', 'final', etc.
-}
, visibilityVariablePresentationHint :: String
} deriving (Show, Read, Eq)

$(deriveJSON defaultOptions { fieldLabelModifier = rdrop (length "VariablePresentationHint") } ''VariablePresentationHint)

-- |
--
defaultVariablePresentationHint :: VariablePresentationHint
defaultVariablePresentationHint = VariablePresentationHint "data" [] "public"