Language.PureScript.Names

data Name

Constructors

• IdentName Ident
• ValOpName (OpName ValueOpName)
• TyName (ProperName TypeName)
• TyOpName (OpName TypeOpName)
• DctorName (ProperName ConstructorName)
• TyClassName (ProperName ClassName)
• ModName ModuleName

Instances

• Eq Name
• Ord Name
• Generic Name _
• Show Name

data InternalIdentData

This type is meant to be extended with any new uses for idents that come along. Adding constructors to this type is cheaper than adding them to Ident because functions that match on Ident can ignore all InternalIdents with a single pattern, and thus don't have to change if a new InternalIdentData constructor is created.

Constructors

• RuntimeLazyFactory
• Lazy String

Instances

• Eq InternalIdentData
• Ord InternalIdentData
• Generic InternalIdentData _
• Show InternalIdentData

fromInternalIdentData :: InternalIdentData -> Json

toInternalIdentData :: Json -> Either DecodeError InternalIdentData

data Ident

Names for value identifiers

Constructors

• Ident String

  An alphanumeric identifier

• GenIdent (Maybe String) Int

  A generated name for an identifier

• UnusedIdent

  A generated name used only for type-checking

• InternalIdent InternalIdentData

  A generated name used only for internal transformations

Instances

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

fromIdent :: Ident -> Json

toIdent :: Json -> Either DecodeError Ident

newtype OpName :: OpNameType -> Typenewtype OpName a

Operator alias names.

Constructors

• OpName String

Instances

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

fromOpName :: forall a. OpName a -> Json

toOpName :: forall a. Json -> Either DecodeError (OpName a)

data OpNameType

data ValueOpName :: OpNameTypedata ValueOpName

data TypeOpName :: OpNameTypedata TypeOpName

data AnyOpName :: OpNameTypedata AnyOpName

newtype ProperName :: ProperNameType -> Typenewtype ProperName a

Proper names, i.e. capitalized names for e.g. module names, type/data constructors.

Constructors

• ProperName String

Instances

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

fromProperName :: forall a. ProperName a -> Json

toProperName :: forall a. Json -> Either DecodeError (ProperName a)

data ProperNameType

data TypeName :: ProperNameTypedata TypeName

data ConstructorName :: ProperNameTypedata ConstructorName

data ClassName :: ProperNameTypedata ClassName

data Namespace :: ProperNameTypedata Namespace

newtype ModuleName

Constructors

• ModuleName String

Instances

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

fromModuleName :: ModuleName -> Json

toModuleName :: Json -> Either DecodeError ModuleName

data QualifiedBy

Constructors

• BySourcePos SourcePos
• ByModuleName ModuleName

Instances

• Eq QualifiedBy
• Ord QualifiedBy
• Generic QualifiedBy _
• Show QualifiedBy

byNullSourcePos :: QualifiedBy

fromQualifiedBy :: QualifiedBy -> Json

Note: this instance isn't defined in the PureScript compiler. as it appears within the instance of Qualified a.

toQualifiedBy :: Json -> Either DecodeError QualifiedBy

Note: this instance isn't defined in the PureScript compiler. as it appears within the instance of Qualified a.

data Qualified a

Constructors

• Qualified QualifiedBy a

Instances

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

fromQualified :: forall a. (a -> Json) -> Qualified a -> Json

toQualified :: forall a. (Json -> Either DecodeError a) -> Json -> Either DecodeError (Qualified a)