Safe Haskell	None
Language	Haskell2010

Language.PureScript.Names

Description

Data types for names

Synopsis

data Name
- = IdentName Ident
- | ValOpName (OpName 'ValueOpName)
- | TyName (ProperName 'TypeName)
- | TyOpName (OpName 'TypeOpName)
- | DctorName (ProperName 'ConstructorName)
- | TyClassName (ProperName 'ClassName)
- | ModName ModuleName
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
- = Ident Text
- | GenIdent (Maybe Text) Integer
- | UnusedIdent
runIdent :: Ident -> Text
showIdent :: Ident -> Text
freshIdent :: MonadSupply m => Text -> m Ident
freshIdent' :: MonadSupply m => m Ident
newtype OpName (a :: OpNameType) = OpName {
- runOpName :: Text
}
showOp :: OpName a -> Text
data OpNameType
- = ValueOpName
- | TypeOpName
- | AnyOpName
eraseOpName :: OpName a -> OpName 'AnyOpName
coerceOpName :: OpName a -> OpName b
newtype ProperName (a :: ProperNameType) = ProperName {
- runProperName :: Text
}
data ProperNameType
- = TypeName
- | ConstructorName
- | ClassName
- | Namespace
coerceProperName :: ProperName a -> ProperName b
newtype ModuleName = ModuleName Text
runModuleName :: ModuleName -> Text
moduleNameFromString :: Text -> ModuleName
isBuiltinModuleName :: ModuleName -> Bool
data Qualified a = Qualified (Maybe ModuleName) a
showQualified :: (a -> Text) -> Qualified a -> Text
getQual :: Qualified a -> Maybe ModuleName
qualify :: ModuleName -> Qualified a -> (ModuleName, a)
mkQualified :: a -> ModuleName -> Qualified a
disqualify :: Qualified a -> a
disqualifyFor :: Maybe ModuleName -> Qualified a -> Maybe a
isQualified :: Qualified a -> Bool
isUnqualified :: Qualified a -> Bool
isQualifiedWith :: ModuleName -> Qualified a -> Bool

Documentation

data Name Source #

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

Instances

Instances details

Eq Name Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in Language.PureScript.Names 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 Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Generic Name Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep Name :: Type -> Type # Methods from :: Name -> Rep Name x # to :: Rep Name x -> Name #
NFData Name Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: Name -> () #
Serialise Name Source #
Instance details Defined in Language.PureScript.Names Methods encode :: Name -> Encoding # decode :: Decoder s Name # encodeList :: [Name] -> Encoding # decodeList :: Decoder s [Name] #
type Rep Name Source #
Instance details Defined in Language.PureScript.Names type Rep Name = D1 ('MetaData "Name" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) ((C1 ('MetaCons "IdentName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ident)) :+: (C1 ('MetaCons "ValOpName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OpName 'ValueOpName))) :+: C1 ('MetaCons "TyName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'TypeName))))) :+: ((C1 ('MetaCons "TyOpName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OpName 'TypeOpName))) :+: C1 ('MetaCons "DctorName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'ConstructorName)))) :+: (C1 ('MetaCons "TyClassName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'ClassName))) :+: C1 ('MetaCons "ModName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)))))

getIdentName :: Name -> Maybe Ident Source #

getValOpName :: Name -> Maybe (OpName 'ValueOpName) Source #

getTypeName :: Name -> Maybe (ProperName 'TypeName) Source #

getTypeOpName :: Name -> Maybe (OpName 'TypeOpName) Source #

getDctorName :: Name -> Maybe (ProperName 'ConstructorName) Source #

getClassName :: Name -> Maybe (ProperName 'ClassName) Source #

getModName :: Name -> Maybe ModuleName Source #

data Ident Source #

Names for value identifiers

Constructors

Ident Text	An alphanumeric identifier
GenIdent (Maybe Text) Integer	A generated name for an identifier
UnusedIdent	A generated name used only for type-checking

Instances

Instances details

Eq Ident Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: Ident -> Ident -> Bool # (/=) :: Ident -> Ident -> Bool #
Ord Ident Source #
Instance details Defined in Language.PureScript.Names 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 Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> Ident -> ShowS # show :: Ident -> String # showList :: [Ident] -> ShowS #
Generic Ident Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep Ident :: Type -> Type # Methods from :: Ident -> Rep Ident x # to :: Rep Ident x -> Ident #
ToJSON Ident Source #
Instance details Defined in Language.PureScript.Names Methods toJSON :: Ident -> Value # toEncoding :: Ident -> Encoding # toJSONList :: [Ident] -> Value # toEncodingList :: [Ident] -> Encoding #
FromJSON Ident Source #
Instance details Defined in Language.PureScript.Names Methods parseJSON :: Value -> Parser Ident # parseJSONList :: Value -> Parser [Ident] #
NFData Ident Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: Ident -> () #
Serialise Ident Source #
Instance details Defined in Language.PureScript.Names Methods encode :: Ident -> Encoding # decode :: Decoder s Ident # encodeList :: [Ident] -> Encoding # decodeList :: Decoder s [Ident] #
type Rep Ident Source #
Instance details Defined in Language.PureScript.Names type Rep Ident = D1 ('MetaData "Ident" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) (C1 ('MetaCons "Ident" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "GenIdent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: C1 ('MetaCons "UnusedIdent" 'PrefixI 'False) (U1 :: Type -> Type)))

runIdent :: Ident -> Text Source #

showIdent :: Ident -> Text Source #

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

freshIdent' :: MonadSupply m => m Ident Source #

newtype OpName (a :: OpNameType) Source #

Operator alias names.

Constructors

OpName
Fields runOpName :: Text

Instances

Instances details

Eq (OpName a) Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: OpName a -> OpName a -> Bool # (/=) :: OpName a -> OpName a -> Bool #
Ord (OpName a) Source #
Instance details Defined in Language.PureScript.Names 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) Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> OpName a -> ShowS # show :: OpName a -> String # showList :: [OpName a] -> ShowS #
Generic (OpName a) Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep (OpName a) :: Type -> Type # Methods from :: OpName a -> Rep (OpName a) x # to :: Rep (OpName a) x -> OpName a #
ToJSON (OpName a) Source #
Instance details Defined in Language.PureScript.Names Methods toJSON :: OpName a -> Value # toEncoding :: OpName a -> Encoding # toJSONList :: [OpName a] -> Value # toEncodingList :: [OpName a] -> Encoding #
FromJSON (OpName a) Source #
Instance details Defined in Language.PureScript.Names Methods parseJSON :: Value -> Parser (OpName a) # parseJSONList :: Value -> Parser [OpName a] #
NFData (OpName a) Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: OpName a -> () #
Serialise (OpName a) Source #
Instance details Defined in Language.PureScript.Names Methods encode :: OpName a -> Encoding # decode :: Decoder s (OpName a) # encodeList :: [OpName a] -> Encoding # decodeList :: Decoder s [OpName a] #
type Rep (OpName a) Source #
Instance details Defined in Language.PureScript.Names type Rep (OpName a) = D1 ('MetaData "OpName" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'True) (C1 ('MetaCons "OpName" 'PrefixI 'True) (S1 ('MetaSel ('Just "runOpName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

showOp :: OpName a -> Text Source #

data OpNameType Source #

The closed set of operator alias types.

Constructors

ValueOpName
TypeOpName
AnyOpName

eraseOpName :: OpName a -> OpName 'AnyOpName Source #

coerceOpName :: OpName a -> OpName b Source #

newtype ProperName (a :: ProperNameType) Source #

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

Constructors

ProperName
Fields runProperName :: Text

Instances

Instances details

Eq (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: ProperName a -> ProperName a -> Bool # (/=) :: ProperName a -> ProperName a -> Bool #
Ord (ProperName a) Source #
Instance details Defined in Language.PureScript.Names 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) Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> ProperName a -> ShowS # show :: ProperName a -> String # showList :: [ProperName a] -> ShowS #
Generic (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep (ProperName a) :: Type -> Type # Methods from :: ProperName a -> Rep (ProperName a) x # to :: Rep (ProperName a) x -> ProperName a #
ToJSON (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Methods toJSON :: ProperName a -> Value # toEncoding :: ProperName a -> Encoding # toJSONList :: [ProperName a] -> Value # toEncodingList :: [ProperName a] -> Encoding #
FromJSON (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Methods parseJSON :: Value -> Parser (ProperName a) # parseJSONList :: Value -> Parser [ProperName a] #
NFData (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: ProperName a -> () #
Serialise (ProperName a) Source #
Instance details Defined in Language.PureScript.Names Methods encode :: ProperName a -> Encoding # decode :: Decoder s (ProperName a) # encodeList :: [ProperName a] -> Encoding # decodeList :: Decoder s [ProperName a] #
type Rep (ProperName a) Source #
Instance details Defined in Language.PureScript.Names type Rep (ProperName a) = D1 ('MetaData "ProperName" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'True) (C1 ('MetaCons "ProperName" 'PrefixI 'True) (S1 ('MetaSel ('Just "runProperName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ProperNameType Source #

The closed set of proper name types.

Constructors

TypeName
ConstructorName
ClassName
Namespace

coerceProperName :: ProperName a -> ProperName b Source #

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 Source #

Module names

Constructors

ModuleName Text

Instances

Instances details

Eq ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Ord ModuleName Source #
Instance details Defined in Language.PureScript.Names 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 Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #
Generic ModuleName Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep ModuleName :: Type -> Type # Methods from :: ModuleName -> Rep ModuleName x # to :: Rep ModuleName x -> ModuleName #
ToJSON ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods toJSON :: ModuleName -> Value # toEncoding :: ModuleName -> Encoding # toJSONList :: [ModuleName] -> Value # toEncodingList :: [ModuleName] -> Encoding #
ToJSONKey ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods toJSONKey :: ToJSONKeyFunction ModuleName # toJSONKeyList :: ToJSONKeyFunction [ModuleName] #
FromJSON ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods parseJSON :: Value -> Parser ModuleName # parseJSONList :: Value -> Parser [ModuleName] #
FromJSONKey ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods fromJSONKey :: FromJSONKeyFunction ModuleName # fromJSONKeyList :: FromJSONKeyFunction [ModuleName] #
NFData ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: ModuleName -> () #
Serialise ModuleName Source #
Instance details Defined in Language.PureScript.Names Methods encode :: ModuleName -> Encoding # decode :: Decoder s ModuleName # encodeList :: [ModuleName] -> Encoding # decodeList :: Decoder s [ModuleName] #
type Rep ModuleName Source #
Instance details Defined in Language.PureScript.Names type Rep ModuleName = D1 ('MetaData "ModuleName" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'True) (C1 ('MetaCons "ModuleName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

runModuleName :: ModuleName -> Text Source #

moduleNameFromString :: Text -> ModuleName Source #

isBuiltinModuleName :: ModuleName -> Bool Source #

data Qualified a Source #

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

Constructors

Qualified (Maybe ModuleName) a

Instances

Instances details

Functor Qualified Source #
Instance details Defined in Language.PureScript.Names Methods fmap :: (a -> b) -> Qualified a -> Qualified b # (<$) :: a -> Qualified b -> Qualified a #
Foldable Qualified Source #
Instance details Defined in Language.PureScript.Names Methods fold :: Monoid m => Qualified m -> m # foldMap :: Monoid m => (a -> m) -> Qualified a -> m # foldMap' :: Monoid m => (a -> m) -> Qualified a -> m # foldr :: (a -> b -> b) -> b -> Qualified a -> b # foldr' :: (a -> b -> b) -> b -> Qualified a -> b # foldl :: (b -> a -> b) -> b -> Qualified a -> b # foldl' :: (b -> a -> b) -> b -> Qualified a -> b # foldr1 :: (a -> a -> a) -> Qualified a -> a # foldl1 :: (a -> a -> a) -> Qualified a -> a # toList :: Qualified a -> [a] # null :: Qualified a -> Bool # length :: Qualified a -> Int # elem :: Eq a => a -> Qualified a -> Bool # maximum :: Ord a => Qualified a -> a # minimum :: Ord a => Qualified a -> a # sum :: Num a => Qualified a -> a # product :: Num a => Qualified a -> a #
Traversable Qualified Source #
Instance details Defined in Language.PureScript.Names Methods traverse :: Applicative f => (a -> f b) -> Qualified a -> f (Qualified b) # sequenceA :: Applicative f => Qualified (f a) -> f (Qualified a) # mapM :: Monad m => (a -> m b) -> Qualified a -> m (Qualified b) # sequence :: Monad m => Qualified (m a) -> m (Qualified a) #
Eq a => Eq (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Methods (==) :: Qualified a -> Qualified a -> Bool # (/=) :: Qualified a -> Qualified a -> Bool #
Ord a => Ord (Qualified a) Source #
Instance details Defined in Language.PureScript.Names 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) Source #
Instance details Defined in Language.PureScript.Names Methods showsPrec :: Int -> Qualified a -> ShowS # show :: Qualified a -> String # showList :: [Qualified a] -> ShowS #
Generic (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Associated Types type Rep (Qualified a) :: Type -> Type # Methods from :: Qualified a -> Rep (Qualified a) x # to :: Rep (Qualified a) x -> Qualified a #
ToJSON a => ToJSON (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Methods toJSON :: Qualified a -> Value # toEncoding :: Qualified a -> Encoding # toJSONList :: [Qualified a] -> Value # toEncodingList :: [Qualified a] -> Encoding #
FromJSON a => FromJSON (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Methods parseJSON :: Value -> Parser (Qualified a) # parseJSONList :: Value -> Parser [Qualified a] #
NFData a => NFData (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Methods rnf :: Qualified a -> () #
Serialise a => Serialise (Qualified a) Source #
Instance details Defined in Language.PureScript.Names Methods encode :: Qualified a -> Encoding # decode :: Decoder s (Qualified a) # encodeList :: [Qualified a] -> Encoding # decodeList :: Decoder s [Qualified a] #
type Rep (Qualified a) Source #
Instance details Defined in Language.PureScript.Names type Rep (Qualified a) = D1 ('MetaData "Qualified" "Language.PureScript.Names" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) (C1 ('MetaCons "Qualified" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ModuleName)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

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

getQual :: Qualified a -> Maybe ModuleName Source #

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

Provide a default module name, if a name is unqualified

mkQualified :: a -> ModuleName -> Qualified a Source #

Makes a qualified value from a name and module name.

disqualify :: Qualified a -> a Source #

Remove the module name from a qualified name

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

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

isQualified :: Qualified a -> Bool Source #

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

isUnqualified :: Qualified a -> Bool Source #

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

isQualifiedWith :: ModuleName -> Qualified a -> Bool Source #

Checks whether a qualified value is qualified with a particular module