Language.PS.SmartCST

reservedNames :: Set String

quoteIfReserved :: String -> String

appendUnderscoreIfReserved :: String -> String

mkRowLabels :: forall type_. Array (String /\ type_) -> Array { label :: Label, type_ :: type_ }

mkRowLabel :: forall type_. (String /\ type_) -> { label :: Label, type_ :: type_ }

mkModuleName :: NonEmptyArray String -> ModuleName

emptyRow :: forall labelType type_. { rowLabels :: Array labelType, rowTail :: Maybe type_ }

data RecordLabeled a

Constructors

• RecordPun Ident
• RecordField Label a

Instances

• Functor RecordLabeled
• Foldable RecordLabeled
• Traversable RecordLabeled
• Generic (RecordLabeled a) _
• (Eq a) => Eq (RecordLabeled a)
• (Ord a) => Ord (RecordLabeled a)
• (Show a) => Show (RecordLabeled a)

data ProperNameType_TypeConstructor :: ProperNameType

data ProperNameType_Namespace :: ProperNameType

data ProperNameType_ConstructorName :: ProperNameType

data ProperNameType_ClassName :: ProperNameType

data ProperNameType

newtype ProperName (proxy :: ProperNameType)

Constructors

• ProperName String

Instances

• Newtype (ProperName proxy) _
• Generic (ProperName proxy) _
• Eq (ProperName proxy)
• Ord (ProperName proxy)
• Show (ProperName proxy)

data OpNameType_ValueOpName :: OpNameType

data OpNameType_TypeOpName :: OpNameType

data OpNameType

newtype OpName (proxy :: OpNameType)

Constructors

• OpName String

Instances

• Newtype (OpName proxy) _
• Generic (OpName proxy) _
• Eq (OpName proxy)
• Ord (OpName proxy)
• Show (OpName proxy)

newtype ModuleName

Constructors

• ModuleName (NonEmptyArray (ProperName ProperNameType_Namespace))

Instances

• Newtype ModuleName _
• Generic ModuleName _
• Eq ModuleName
• Ord ModuleName
• Show ModuleName

newtype Label

Constructors

• Label String

Instances

• Newtype Label _
• Generic Label _
• Eq Label
• Ord Label
• Show Label

newtype Ident

Constructors

• Ident String

Instances

• Newtype Ident _
• Generic Ident _
• Eq Ident
• Ord Ident
• Show Ident

data Fixity

Constructors

• Infix
• Infixl
• Infixr

Instances

• Generic Fixity _
• Eq Fixity
• Ord Fixity
• Show Fixity

data DeclDeriveType

Constructors

• DeclDeriveType_Newtype
• DeclDeriveType_Ordinary

Instances

• Generic DeclDeriveType _
• Eq DeclDeriveType
• Ord DeclDeriveType
• Show DeclDeriveType

data Comments

Constructors

• OneLineComments (Array String)

  Rendered as

  -- | line1
  -- | line2
  

• BlockComments (Array String)

  Rendered as

  {-
    line1
    line2
  -}
  

Instances

• Generic Comments _
• Eq Comments
• Ord Comments
• Show Comments

data ClassFundep

Constructors

• FundepDetermines (NonEmptyArray Ident) (NonEmptyArray Ident)

Instances

• Generic ClassFundep _

  FundepDetermined (NonEmptyArray Ident) -- parser is not allowing it (i.e. class Foo a | a)?

• Eq ClassFundep
• Ord ClassFundep
• Show ClassFundep

newtype Module

Constructors

• Module { declarations :: Array Declaration, exports :: Array Export, moduleName :: ModuleName }

printModule :: Module -> Doc Void

moduleToCstModule :: Module -> Module

typeRow :: Array (String /\ PSType) -> PSType

typeRecord :: Array (String /\ PSType) -> PSType

stringType :: PSType

numberType :: PSType

maybeType :: PSType -> PSType

booleanType :: PSType

arrayType :: PSType -> PSType

type Where = { expr :: Expr, whereBindings :: Array LetBinding }

type ValueBindingFields = { binders :: Array Binder, guarded :: Guarded, name :: Ident }

data TypeVarBinding

Constructors

• TypeVarKinded Ident PSType
• TypeVarName Ident

Instances

• Generic TypeVarBinding _
• Eq TypeVarBinding
• Ord TypeVarBinding
• Show TypeVarBinding

data RecordUpdate

Constructors

• RecordUpdateLeaf Label Expr
• RecordUpdateBranch Label (NonEmptyArray RecordUpdate)

Instances

• Generic RecordUpdate _
• Eq RecordUpdate
• Ord RecordUpdate
• Show RecordUpdate

type RecordAccessor = { recExpr :: Expr, recPath :: NonEmptyArray Label }

type PatternGuard = { binder :: Maybe Binder, expr :: Expr }

data PSType

Constructors

• TypeVar Ident
• TypeConstructor (SmartQualifiedName (ProperName ProperNameType_TypeConstructor))
• TypeWildcard
• TypeHole Ident
• TypeString String
• TypeRow PSRow
• TypeRecord PSRow
• TypeApp PSType PSType
• TypeForall (NonEmptyArray TypeVarBinding) PSType
• TypeArr PSType PSType
• TypeKinded PSType PSType
• TypeOp PSType (SmartQualifiedName (OpName OpNameType_TypeOpName)) PSType
• TypeConstrained PSConstraint PSType

Instances

• Generic PSType _

  TypeOpName (SmartQualifiedName (OpName OpNameType_TypeOpName)) TypeArrName TypeParens PSType -- generated automatically

• Eq PSType
• Ord PSType
• Show PSType

type PSRow = { rowLabels :: Array { label :: Label, type_ :: PSType }, rowTail :: Maybe PSType }

newtype PSConstraint

Constructors

• PSConstraint { args :: Array PSType, className :: SmartQualifiedName (ProperName ProperNameType_ClassName) }

Instances

• Generic PSConstraint _

  ConstraintParens PSConstraint

• Eq PSConstraint
• Ord PSConstraint
• Show PSConstraint

type LetIn = { bindings :: NonEmptyArray LetBinding, body :: Expr }

data LetBinding

Constructors

• LetBindingSignature { ident :: Ident, type_ :: PSType }
• LetBindingName ValueBindingFields
• LetBindingPattern { binder :: Binder, where_ :: Where }

Instances

• Generic LetBinding _
• Eq LetBinding
• Ord LetBinding
• Show LetBinding

type Lambda = { binders :: NonEmptyArray Binder, body :: Expr }

type InstanceHead = { instClass :: SmartQualifiedName (ProperName ProperNameType_ClassName), instConstraints :: Array PSConstraint, instName :: Ident, instTypes :: NonEmptyArray PSType }

data InstanceBinding

Constructors

• InstanceBindingSignature { ident :: Ident, type_ :: PSType }
• InstanceBindingName ValueBindingFields

Instances

• Generic InstanceBinding _
• Eq InstanceBinding
• Ord InstanceBinding
• Show InstanceBinding

type Instance = { body :: Array InstanceBinding, head :: InstanceHead }

type IfThenElse = { cond :: Expr, false_ :: Expr, true_ :: Expr }

type GuardedExpr = { patterns :: NonEmptyArray PatternGuard, where_ :: Where }

data Guarded

Constructors

• Unconditional (Where)
• Guarded (NonEmptyArray GuardedExpr)

Instances

• Generic Guarded _
• Eq Guarded
• Ord Guarded
• Show Guarded

data Foreign

Constructors

• ForeignValue { ident :: Ident, type_ :: PSType }
• ForeignData { kind_ :: PSType, name :: ProperName ProperNameType_TypeConstructor }
• ForeignKind { name :: ProperName ProperNameType_TypeConstructor }

Instances

• Generic Foreign _
• Eq Foreign
• Ord Foreign
• Show Foreign

data FixityOp

Constructors

• FixityValue (Either (SmartQualifiedName Ident) (SmartQualifiedNameConstructor)) (OpName OpNameType_ValueOpName)
• FixityType (SmartQualifiedName (ProperName ProperNameType_TypeConstructor)) (OpName OpNameType_TypeOpName)

Instances

• Generic FixityOp _
• Eq FixityOp
• Ord FixityOp
• Show FixityOp

type FixityFields = { keyword :: Fixity, operator :: FixityOp, precedence :: Int }

data Expr

Constructors

• ExprHole Ident
• ExprSection
• ExprIdent (SmartQualifiedName Ident)
• ExprVar Ident
• ExprConstructor (SmartQualifiedNameConstructor)
• ExprBoolean Boolean
• ExprChar Char
• ExprString String
• ExprNumber (Either Int Number)
• ExprArray (Array Expr)
• ExprRecord (Array (RecordLabeled Expr))
• ExprTyped Expr PSType
• ExprInfix Expr Expr Expr
• ExprOp Expr (SmartQualifiedName (OpName OpNameType_ValueOpName)) Expr
• ExprOpName (SmartQualifiedName (OpName OpNameType_ValueOpName))
• ExprNegate Expr
• ExprRecordAccessor RecordAccessor
• ExprRecordUpdate Expr (NonEmptyArray RecordUpdate)
• ExprApp Expr Expr
• ExprLambda Lambda
• ExprIf IfThenElse
• ExprCase CaseOf
• ExprLet LetIn
• ExprDo (NonEmptyArray DoStatement)
• ExprAdo AdoBlock

Instances

• Generic Expr _

  ExprParens Expr -- no need

• Eq Expr
• Ord Expr
• Show Expr

data DoStatement

Constructors

• DoLet (NonEmptyArray LetBinding)
• DoDiscard Expr
• DoBind { binder :: Binder, expr :: Expr }

Instances

• Generic DoStatement _
• Eq DoStatement
• Ord DoStatement
• Show DoStatement

data Declaration

Constructors

• DeclData { comments :: Maybe Comments, constructors :: Array DataCtor, head :: DataHead }
• DeclType { comments :: Maybe Comments, head :: DataHead, type_ :: PSType }
• DeclNewtype { comments :: Maybe Comments, head :: DataHead, name :: ProperName ProperNameType_ConstructorName, type_ :: PSType }
• DeclClass { comments :: Maybe Comments, head :: ClassHead, methods :: Array { ident :: Ident, type_ :: PSType } }
• DeclInstanceChain { comments :: Maybe Comments, instances :: NonEmptyArray (Instance) }
• DeclDerive { comments :: Maybe Comments, deriveType :: DeclDeriveType, head :: InstanceHead }
• DeclSignature { comments :: Maybe Comments, ident :: Ident, type_ :: PSType }
• DeclValue { comments :: Maybe Comments, valueBindingFields :: ValueBindingFields }
• DeclFixity { comments :: Maybe Comments, fixityFields :: FixityFields }
• DeclForeign { comments :: Maybe Comments, foreign_ :: Foreign }

Instances

• Generic Declaration _
• Eq Declaration
• Ord Declaration
• Show Declaration

newtype DataHead

Constructors

• DataHead { dataHdName :: ProperName ProperNameType_TypeConstructor, dataHdVars :: Array TypeVarBinding }

Instances

• Newtype DataHead _
• Generic DataHead _
• Eq DataHead
• Ord DataHead
• Show DataHead

newtype DataCtor

Constructors

• DataCtor { dataCtorFields :: Array PSType, dataCtorName :: ProperName ProperNameType_ConstructorName }

Instances

• Newtype DataCtor _
• Generic DataCtor _
• Eq DataCtor
• Ord DataCtor
• Show DataCtor

type ClassHead = { fundeps :: Array ClassFundep, name :: ProperName ProperNameType_ClassName, super :: Array PSConstraint, vars :: Array TypeVarBinding }

type CaseOf = { branches :: NonEmptyArray { binders :: NonEmptyArray Binder, body :: Guarded }, head :: NonEmptyArray Expr }

data Binder

Constructors

• BinderWildcard
• BinderVar Ident
• BinderNamed { binder :: Binder, ident :: Ident }
• BinderConstructor { args :: Array Binder, name :: SmartQualifiedNameConstructor }
• BinderBoolean Boolean
• BinderChar Char
• BinderString String
• BinderNumber (Either Int Number)
• BinderArray (Array Binder)
• BinderRecord (Array (RecordLabeled Binder))
• BinderTyped Binder PSType
• BinderOp Binder (SmartQualifiedName (OpName OpNameType_ValueOpName)) Binder

Instances

• Generic Binder _

  BinderParens Binder -- no need

• Eq Binder
• Ord Binder
• Show Binder

type AdoBlock = { result :: Expr, statements :: Array DoStatement }

Operator alias for Language.PS.SmartCST.Types.Declaration.TypeArr (right-associative / precedence 5)

Operator alias for Language.PS.SmartCST.Types.Declaration.ExprLambda (left-associative / precedence 5)

data SmartQualifiedName a

Constructors

• SmartQualifiedName__Ignore a
• SmartQualifiedName__Full ModuleName a
• SmartQualifiedName__Simple ModuleName a
• SmartQualifiedName__Custom ModuleName ModuleName a

Instances

• Generic (SmartQualifiedName a) _
• Functor SmartQualifiedName
• (Eq a) => Eq (SmartQualifiedName a)
• (Ord a) => Ord (SmartQualifiedName a)
• (Show a) => Show (SmartQualifiedName a)

data SmartQualifiedNameConstructor

Constructors

• SmartQualifiedNameConstructor__Ignore (ProperName ProperNameType_ConstructorName)
• SmartQualifiedNameConstructor__Full ModuleName (ProperName ProperNameType_ConstructorName) (ProperName ProperNameType_TypeConstructor)
• SmartQualifiedNameConstructor__Simple ModuleName (ProperName ProperNameType_ConstructorName) (ProperName ProperNameType_TypeConstructor)
• SmartQualifiedNameConstructor__Custom ModuleName ModuleName (ProperName ProperNameType_ConstructorName) (ProperName ProperNameType_TypeConstructor)

Instances

• Generic SmartQualifiedNameConstructor _
• Eq SmartQualifiedNameConstructor
• Ord SmartQualifiedNameConstructor
• Show SmartQualifiedNameConstructor