Language.PureScript.Names

Data types for names

Documentation

data Name

A sum of the possible name types, useful for error and lint messages.

Constructors

IdentName Ident

ValOpName (OpName ValueOpName)

TyName (ProperName TypeName)

TyOpName (OpName TypeOpName)

DctorName (ProperName ConstructorName)

TyClassName (ProperName ClassName)

ModName ModuleName

KiName (ProperName KindName)

Instances

Eq Name

Methods

(==) :: Name -> Name -> Bool

(/=) :: Name -> Name -> Bool

Ord Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Generic Name

Associated Types

type Rep Name :: * -> *

Methods

from :: Name -> Rep Name x

to :: Rep Name x -> Name

NFData Name

Methods

rnf :: Name -> ()

type Rep Name

type Rep Name = D1 (MetaData "Name" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "IdentName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Ident))) (C1 (MetaCons "ValOpName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (OpName ValueOpName))))) ((:+:) (C1 (MetaCons "TyName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProperName TypeName)))) (C1 (MetaCons "TyOpName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (OpName TypeOpName)))))) ((:+:) ((:+:) (C1 (MetaCons "DctorName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProperName ConstructorName)))) (C1 (MetaCons "TyClassName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProperName ClassName))))) ((:+:) (C1 (MetaCons "ModName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName))) (C1 (MetaCons "KiName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProperName KindName)))))))

getIdentName :: Name -> Maybe Ident

getValOpName :: Name -> Maybe (OpName ValueOpName)

getTypeName :: Name -> Maybe (ProperName TypeName)

getTypeOpName :: Name -> Maybe (OpName TypeOpName)

getDctorName :: Name -> Maybe (ProperName ConstructorName)

getClassName :: Name -> Maybe (ProperName ClassName)

getModName :: Name -> Maybe ModuleName

data Ident

Names for value identifiers

Constructors

Ident Text

An alphanumeric identifier

GenIdent (Maybe Text) Integer

A generated name for an identifier

Instances

Eq Ident

Methods

(==) :: Ident -> Ident -> Bool

(/=) :: Ident -> Ident -> Bool

Ord Ident

Methods

compare :: Ident -> Ident -> Ordering

(<) :: Ident -> Ident -> Bool

(<=) :: Ident -> Ident -> Bool

(>) :: Ident -> Ident -> Bool

(>=) :: Ident -> Ident -> Bool

max :: Ident -> Ident -> Ident

min :: Ident -> Ident -> Ident

Show Ident

Methods

showsPrec :: Int -> Ident -> ShowS

show :: Ident -> String

showList :: [Ident] -> ShowS

Generic Ident

Associated Types

type Rep Ident :: * -> *

Methods

from :: Ident -> Rep Ident x

to :: Rep Ident x -> Ident

ToJSON Ident

Methods

toJSON :: Ident -> Value

toEncoding :: Ident -> Encoding

toJSONList :: [Ident] -> Value

toEncodingList :: [Ident] -> Encoding

FromJSON Ident

Methods

parseJSON :: Value -> Parser Ident

parseJSONList :: Value -> Parser [Ident]

NFData Ident

Methods

rnf :: Ident -> ()

type Rep Ident

type Rep Ident = D1 (MetaData "Ident" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" False) ((:+:) (C1 (MetaCons "Ident" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) (C1 (MetaCons "GenIdent" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))))

runIdent :: Ident -> Text

showIdent :: Ident -> Text

freshIdent :: MonadSupply m => Text -> m Ident

freshIdent' :: MonadSupply m => m Ident

newtype OpName a

Operator alias names.

Constructors

OpName

Fields

• runOpName :: Text

Instances

Eq (OpName a)

Methods

(==) :: OpName a -> OpName a -> Bool

(/=) :: OpName a -> OpName a -> Bool

Ord (OpName a)

Methods

compare :: OpName a -> OpName a -> Ordering

(<) :: OpName a -> OpName a -> Bool

(<=) :: OpName a -> OpName a -> Bool

(>) :: OpName a -> OpName a -> Bool

(>=) :: OpName a -> OpName a -> Bool

max :: OpName a -> OpName a -> OpName a

min :: OpName a -> OpName a -> OpName a

Show (OpName a)

Methods

showsPrec :: Int -> OpName a -> ShowS

show :: OpName a -> String

showList :: [OpName a] -> ShowS

Generic (OpName a)

Associated Types

type Rep (OpName a) :: * -> *

Methods

from :: OpName a -> Rep (OpName a) x

to :: Rep (OpName a) x -> OpName a

ToJSON (OpName a)

Methods

toJSON :: OpName a -> Value

toEncoding :: OpName a -> Encoding

toJSONList :: [OpName a] -> Value

toEncodingList :: [OpName a] -> Encoding

FromJSON (OpName a)

Methods

parseJSON :: Value -> Parser (OpName a)

parseJSONList :: Value -> Parser [OpName a]

NFData (OpName a)

Methods

rnf :: OpName a -> ()

type Rep (OpName a)

type Rep (OpName a) = D1 (MetaData "OpName" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" True) (C1 (MetaCons "OpName" PrefixI True) (S1 (MetaSel (Just Symbol "runOpName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

showOp :: OpName a -> Text

data OpNameType

The closed set of operator alias types.

Constructors

ValueOpName

TypeOpName

newtype ProperName a

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

Constructors

ProperName

Fields

• runProperName :: Text

Instances

Eq (ProperName a)

Methods

(==) :: ProperName a -> ProperName a -> Bool

(/=) :: ProperName a -> ProperName a -> Bool

Ord (ProperName a)

Methods

compare :: ProperName a -> ProperName a -> Ordering

(<) :: ProperName a -> ProperName a -> Bool

(<=) :: ProperName a -> ProperName a -> Bool

(>) :: ProperName a -> ProperName a -> Bool

(>=) :: ProperName a -> ProperName a -> Bool

max :: ProperName a -> ProperName a -> ProperName a

min :: ProperName a -> ProperName a -> ProperName a

Show (ProperName a)

Methods

showsPrec :: Int -> ProperName a -> ShowS

show :: ProperName a -> String

showList :: [ProperName a] -> ShowS

Generic (ProperName a)

Associated Types

type Rep (ProperName a) :: * -> *

Methods

from :: ProperName a -> Rep (ProperName a) x

to :: Rep (ProperName a) x -> ProperName a

ToJSON (ProperName a)

Methods

toJSON :: ProperName a -> Value

toEncoding :: ProperName a -> Encoding

toJSONList :: [ProperName a] -> Value

toEncodingList :: [ProperName a] -> Encoding

FromJSON (ProperName a)

Methods

parseJSON :: Value -> Parser (ProperName a)

parseJSONList :: Value -> Parser [ProperName a]

NFData (ProperName a)

Methods

rnf :: ProperName a -> ()

type Rep (ProperName a)

type Rep (ProperName a) = D1 (MetaData "ProperName" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" True) (C1 (MetaCons "ProperName" PrefixI True) (S1 (MetaSel (Just Symbol "runProperName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data ProperNameType

The closed set of proper name types.

Constructors

TypeName

ConstructorName

ClassName

KindName

Namespace

coerceProperName :: ProperName a -> ProperName b

Coerces a ProperName from one ProperNameType to another. This should be used with care, and is primarily used to convert ClassNames into TypeNames after classes have been desugared.

newtype ModuleName

Module names

Constructors

ModuleName [ProperName Namespace]

Instances

Eq ModuleName

Methods

(==) :: ModuleName -> ModuleName -> Bool

(/=) :: ModuleName -> ModuleName -> Bool

Ord ModuleName

Methods

compare :: ModuleName -> ModuleName -> Ordering

(<) :: ModuleName -> ModuleName -> Bool

(<=) :: ModuleName -> ModuleName -> Bool

(>) :: ModuleName -> ModuleName -> Bool

(>=) :: ModuleName -> ModuleName -> Bool

max :: ModuleName -> ModuleName -> ModuleName

min :: ModuleName -> ModuleName -> ModuleName

Show ModuleName

Methods

showsPrec :: Int -> ModuleName -> ShowS

show :: ModuleName -> String

showList :: [ModuleName] -> ShowS

Generic ModuleName

Associated Types

type Rep ModuleName :: * -> *

Methods

from :: ModuleName -> Rep ModuleName x

to :: Rep ModuleName x -> ModuleName

ToJSON ModuleName

Methods

toJSON :: ModuleName -> Value

toEncoding :: ModuleName -> Encoding

toJSONList :: [ModuleName] -> Value

toEncodingList :: [ModuleName] -> Encoding

FromJSON ModuleName

Methods

parseJSON :: Value -> Parser ModuleName

parseJSONList :: Value -> Parser [ModuleName]

NFData ModuleName

Methods

rnf :: ModuleName -> ()

type Rep ModuleName

type Rep ModuleName = D1 (MetaData "ModuleName" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" True) (C1 (MetaCons "ModuleName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ProperName Namespace])))

runModuleName :: ModuleName -> Text

moduleNameFromString :: Text -> ModuleName

data Qualified a

A qualified name, i.e. a name with an optional module name

Constructors

Qualified (Maybe ModuleName) a

Instances

Functor Qualified

Methods

fmap :: (a -> b) -> Qualified a -> Qualified b

(<$) :: a -> Qualified b -> Qualified a

Eq a => Eq (Qualified a)

Methods

(==) :: Qualified a -> Qualified a -> Bool

(/=) :: Qualified a -> Qualified a -> Bool

Ord a => Ord (Qualified a)

Methods

compare :: Qualified a -> Qualified a -> Ordering

(<) :: Qualified a -> Qualified a -> Bool

(<=) :: Qualified a -> Qualified a -> Bool

(>) :: Qualified a -> Qualified a -> Bool

(>=) :: Qualified a -> Qualified a -> Bool

max :: Qualified a -> Qualified a -> Qualified a

min :: Qualified a -> Qualified a -> Qualified a

Show a => Show (Qualified a)

Methods

showsPrec :: Int -> Qualified a -> ShowS

show :: Qualified a -> String

showList :: [Qualified a] -> ShowS

Generic (Qualified a)

Associated Types

type Rep (Qualified a) :: * -> *

Methods

from :: Qualified a -> Rep (Qualified a) x

to :: Rep (Qualified a) x -> Qualified a

ToJSON a0 => ToJSON (Qualified a0)

Methods

toJSON :: Qualified a0 -> Value

toEncoding :: Qualified a0 -> Encoding

toJSONList :: [Qualified a0] -> Value

toEncodingList :: [Qualified a0] -> Encoding

FromJSON a0 => FromJSON (Qualified a0)

Methods

parseJSON :: Value -> Parser (Qualified a0)

parseJSONList :: Value -> Parser [Qualified a0]

NFData a => NFData (Qualified a)

Methods

rnf :: Qualified a -> ()

type Rep (Qualified a)

type Rep (Qualified a) = D1 (MetaData "Qualified" "Language.PureScript.Names" "purescript-0.11.6-chPJf69BpsDF9pnv32AcV" False) (C1 (MetaCons "Qualified" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ModuleName))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

showQualified :: (a -> Text) -> Qualified a -> Text

getQual :: Qualified a -> Maybe ModuleName

qualify :: ModuleName -> Qualified a -> (ModuleName, a)

Provide a default module name, if a name is unqualified

mkQualified :: a -> ModuleName -> Qualified a

Makes a qualified value from a name and module name.

disqualify :: Qualified a -> a

Remove the module name from a qualified name

disqualifyFor :: Maybe ModuleName -> Qualified a -> Maybe a

Remove the qualification from a value when it is qualified with a particular module name.

isQualified :: Qualified a -> Bool

Checks whether a qualified value is actually qualified with a module reference

isUnqualified :: Qualified a -> Bool

Checks whether a qualified value is not actually qualified with a module reference

isQualifiedWith :: ModuleName -> Qualified a -> Bool

Checks whether a qualified value is qualified with a particular module