Copyright	(c) 1999 - 2004 Wolfgang Lux 2011 - 2013 Björn Peemöller 2016 Finn Teegen
License	BSD-3-clause
Maintainer	bjp@informatik.uni-kiel.de
Stability	experimental
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Curry.Base.Ident

Contents

Module identifiers
Local identifiers
Qualified identifiers
Predefined simple identifiers
Predefined qualified identifiers
Extended functionality
- Functional patterns
- Records

Description

This module provides the implementation of identifiers and some utility functions for identifiers.

Identifiers comprise the name of the denoted entity and an id, which can be used for renaming identifiers, e.g., in order to resolve name conflicts between identifiers from different scopes. An identifier with an id 0 is considered as not being renamed and, hence, its id will not be shown.

Qualified identifiers may optionally be prefixed by a module name.

Synopsis

data ModuleIdent = ModuleIdent {
- midSpanInfo :: SpanInfo
- midQualifiers :: [String]
}
mkMIdent :: [String] -> ModuleIdent
moduleName :: ModuleIdent -> String
escModuleName :: ModuleIdent -> String
fromModuleName :: String -> ModuleIdent
isValidModuleName :: String -> Bool
addPositionModuleIdent :: Position -> ModuleIdent -> ModuleIdent
mIdentLength :: ModuleIdent -> Int
data Ident = Ident {
- idSpanInfo :: SpanInfo
- idName :: String
- idUnique :: Integer
}
mkIdent :: String -> Ident
showIdent :: Ident -> String
escName :: Ident -> String
identSupply :: [Ident]
globalScope :: Integer
hasGlobalScope :: Ident -> Bool
isRenamed :: Ident -> Bool
renameIdent :: Ident -> Integer -> Ident
unRenameIdent :: Ident -> Ident
updIdentName :: (String -> String) -> Ident -> Ident
addPositionIdent :: Position -> Ident -> Ident
isInfixOp :: Ident -> Bool
identLength :: Ident -> Int
data QualIdent = QualIdent {
- qidSpanInfo :: SpanInfo
- qidModule :: Maybe ModuleIdent
- qidIdent :: Ident
}
qualName :: QualIdent -> String
escQualName :: QualIdent -> String
isQInfixOp :: QualIdent -> Bool
qualify :: Ident -> QualIdent
qualifyWith :: ModuleIdent -> Ident -> QualIdent
qualQualify :: ModuleIdent -> QualIdent -> QualIdent
qualifyLike :: QualIdent -> Ident -> QualIdent
isQualified :: QualIdent -> Bool
unqualify :: QualIdent -> Ident
qualUnqualify :: ModuleIdent -> QualIdent -> QualIdent
localIdent :: ModuleIdent -> QualIdent -> Maybe Ident
isLocalIdent :: ModuleIdent -> QualIdent -> Bool
updQualIdent :: (ModuleIdent -> ModuleIdent) -> (Ident -> Ident) -> QualIdent -> QualIdent
qIdentLength :: QualIdent -> Int
emptyMIdent :: ModuleIdent
mainMIdent :: ModuleIdent
preludeMIdent :: ModuleIdent
arrowId :: Ident
unitId :: Ident
boolId :: Ident
charId :: Ident
intId :: Ident
floatId :: Ident
listId :: Ident
ioId :: Ident
successId :: Ident
eqId :: Ident
ordId :: Ident
enumId :: Ident
boundedId :: Ident
readId :: Ident
showId :: Ident
numId :: Ident
fractionalId :: Ident
monadId :: Ident
trueId :: Ident
falseId :: Ident
nilId :: Ident
consId :: Ident
tupleId :: Int -> Ident
isTupleId :: Ident -> Bool
tupleArity :: Ident -> Int
mainId :: Ident
minusId :: Ident
fminusId :: Ident
applyId :: Ident
errorId :: Ident
failedId :: Ident
idId :: Ident
succId :: Ident
predId :: Ident
toEnumId :: Ident
fromEnumId :: Ident
enumFromId :: Ident
enumFromThenId :: Ident
enumFromToId :: Ident
enumFromThenToId :: Ident
maxBoundId :: Ident
minBoundId :: Ident
lexId :: Ident
readsPrecId :: Ident
readParenId :: Ident
showsPrecId :: Ident
showParenId :: Ident
showStringId :: Ident
andOpId :: Ident
eqOpId :: Ident
leqOpId :: Ident
ltOpId :: Ident
orOpId :: Ident
appendOpId :: Ident
dotOpId :: Ident
anonId :: Ident
isAnonId :: Ident -> Bool
qArrowId :: QualIdent
qUnitId :: QualIdent
qBoolId :: QualIdent
qCharId :: QualIdent
qIntId :: QualIdent
qFloatId :: QualIdent
qListId :: QualIdent
qIOId :: QualIdent
qSuccessId :: QualIdent
isPrimTypeId :: QualIdent -> Bool
qEqId :: QualIdent
qOrdId :: QualIdent
qEnumId :: QualIdent
qBoundedId :: QualIdent
qReadId :: QualIdent
qShowId :: QualIdent
qNumId :: QualIdent
qFractionalId :: QualIdent
qMonadId :: QualIdent
qTrueId :: QualIdent
qFalseId :: QualIdent
qNilId :: QualIdent
qConsId :: QualIdent
qTupleId :: Int -> QualIdent
isQTupleId :: QualIdent -> Bool
qTupleArity :: QualIdent -> Int
qApplyId :: QualIdent
qErrorId :: QualIdent
qFailedId :: QualIdent
qIdId :: QualIdent
qFromEnumId :: QualIdent
qEnumFromId :: QualIdent
qEnumFromThenId :: QualIdent
qEnumFromToId :: QualIdent
qEnumFromThenToId :: QualIdent
qMaxBoundId :: QualIdent
qMinBoundId :: QualIdent
qLexId :: QualIdent
qReadsPrecId :: QualIdent
qReadParenId :: QualIdent
qShowsPrecId :: QualIdent
qShowParenId :: QualIdent
qShowStringId :: QualIdent
qAndOpId :: QualIdent
qEqOpId :: QualIdent
qLeqOpId :: QualIdent
qLtOpId :: QualIdent
qOrOpId :: QualIdent
qAppendOpId :: QualIdent
qDotOpId :: QualIdent
fpSelectorId :: Int -> Ident
isFpSelectorId :: Ident -> Bool
isQualFpSelectorId :: QualIdent -> Bool
recSelectorId :: QualIdent -> Ident -> Ident
qualRecSelectorId :: ModuleIdent -> QualIdent -> Ident -> QualIdent
recUpdateId :: QualIdent -> Ident -> Ident
qualRecUpdateId :: ModuleIdent -> QualIdent -> Ident -> QualIdent
recordExt :: String
recordExtId :: Ident -> Ident
isRecordExtId :: Ident -> Bool
fromRecordExtId :: Ident -> Ident
labelExt :: String
labelExtId :: Ident -> Ident
isLabelExtId :: Ident -> Bool
fromLabelExtId :: Ident -> Ident
renameLabel :: Ident -> Ident
mkLabelIdent :: String -> Ident

Module identifiers

data ModuleIdent Source #

Module identifier

Constructors

ModuleIdent
Fields midSpanInfo :: SpanInfo source code `SpanInfo` midQualifiers :: [String] hierarchical idenfiers

Instances

Eq ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods (==) :: ModuleIdent -> ModuleIdent -> Bool # (/=) :: ModuleIdent -> ModuleIdent -> Bool #
Ord ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods compare :: ModuleIdent -> ModuleIdent -> Ordering # (<) :: ModuleIdent -> ModuleIdent -> Bool # (<=) :: ModuleIdent -> ModuleIdent -> Bool # (>) :: ModuleIdent -> ModuleIdent -> Bool # (>=) :: ModuleIdent -> ModuleIdent -> Bool # max :: ModuleIdent -> ModuleIdent -> ModuleIdent # min :: ModuleIdent -> ModuleIdent -> ModuleIdent #
Read ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods readsPrec :: Int -> ReadS ModuleIdent # readList :: ReadS [ModuleIdent] # readPrec :: ReadPrec ModuleIdent # readListPrec :: ReadPrec [ModuleIdent] #
Show ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods showsPrec :: Int -> ModuleIdent -> ShowS # show :: ModuleIdent -> String # showList :: [ModuleIdent] -> ShowS #
Pretty ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods pPrint :: ModuleIdent -> Doc Source # pPrintPrec :: Int -> ModuleIdent -> Doc Source # pPrintList :: [ModuleIdent] -> Doc Source #
HasPosition ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods getPosition :: ModuleIdent -> Position Source # setPosition :: Position -> ModuleIdent -> ModuleIdent Source #
HasSpanInfo ModuleIdent Source #
Instance details Defined in Curry.Base.Ident Methods getSpanInfo :: ModuleIdent -> SpanInfo Source # setSpanInfo :: SpanInfo -> ModuleIdent -> ModuleIdent Source # updateEndPos :: ModuleIdent -> ModuleIdent Source #

mkMIdent :: [String] -> ModuleIdent Source #

Construct a ModuleIdent from a list of Strings forming the the hierarchical module name.

moduleName :: ModuleIdent -> String Source #

Retrieve the hierarchical name of a module

escModuleName :: ModuleIdent -> String Source #

Show the name of an ModuleIdent escaped by ticks

fromModuleName :: String -> ModuleIdent Source #

Resemble the hierarchical module name from a String by splitting the String at inner dots.

Note: This function does not check the String to be a valid module identifier, use isValidModuleName for this purpose.

isValidModuleName :: String -> Bool Source #

Check whether a String is a valid module name.

Valid module names must satisfy the following conditions:

The name must not be empty
The name must consist of one or more single identifiers, seperated by dots
Each single identifier must be non-empty, start with a letter and consist of letter, digits, single quotes or underscores only

addPositionModuleIdent :: Position -> ModuleIdent -> ModuleIdent Source #

Add a source code Position to a ModuleIdent

mIdentLength :: ModuleIdent -> Int Source #

Local identifiers

data Ident Source #

Simple identifier

Constructors

Ident
Fields idSpanInfo :: SpanInfo Source code `SpanInfo` idName :: String Name of the identifier idUnique :: Integer Unique number of the identifier

Instances

Eq Ident Source #
Instance details Defined in Curry.Base.Ident Methods (==) :: Ident -> Ident -> Bool # (/=) :: Ident -> Ident -> Bool #
Ord Ident Source #
Instance details Defined in Curry.Base.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 #
Read Ident Source #
Instance details Defined in Curry.Base.Ident Methods readsPrec :: Int -> ReadS Ident # readList :: ReadS [Ident] # readPrec :: ReadPrec Ident # readListPrec :: ReadPrec [Ident] #
Show Ident Source #
Instance details Defined in Curry.Base.Ident Methods showsPrec :: Int -> Ident -> ShowS # show :: Ident -> String # showList :: [Ident] -> ShowS #
Pretty Ident Source #
Instance details Defined in Curry.Base.Ident Methods pPrint :: Ident -> Doc Source # pPrintPrec :: Int -> Ident -> Doc Source # pPrintList :: [Ident] -> Doc Source #
HasPosition Ident Source #
Instance details Defined in Curry.Base.Ident Methods getPosition :: Ident -> Position Source # setPosition :: Position -> Ident -> Ident Source #
HasSpanInfo Ident Source #
Instance details Defined in Curry.Base.Ident Methods getSpanInfo :: Ident -> SpanInfo Source # setSpanInfo :: SpanInfo -> Ident -> Ident Source # updateEndPos :: Ident -> Ident Source #

mkIdent :: String -> Ident Source #

Construct an Ident from a String

showIdent :: Ident -> String Source #

Show function for an Ident

escName :: Ident -> String Source #

Show the name of an Ident escaped by ticks

identSupply :: [Ident] Source #

Infinite list of different Idents

globalScope :: Integer Source #

Global scope for renaming

hasGlobalScope :: Ident -> Bool Source #

Has the identifier global scope?

isRenamed :: Ident -> Bool Source #

Is the Ident renamed?

renameIdent :: Ident -> Integer -> Ident Source #

Rename an Ident by changing its unique number

unRenameIdent :: Ident -> Ident Source #

Revert the renaming of an Ident by resetting its unique number

updIdentName :: (String -> String) -> Ident -> Ident Source #

Change the name of an Ident using a renaming function

addPositionIdent :: Position -> Ident -> Ident Source #

Add a Position to an Ident

isInfixOp :: Ident -> Bool Source #

Check whether an Ident identifies an infix operation

identLength :: Ident -> Int Source #

Qualified identifiers

data QualIdent Source #

Qualified identifier

Constructors

QualIdent
Fields qidSpanInfo :: SpanInfo Source code `SpanInfo` qidModule :: Maybe ModuleIdent optional module identifier qidIdent :: Ident identifier itself

Instances

Eq QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods (==) :: QualIdent -> QualIdent -> Bool # (/=) :: QualIdent -> QualIdent -> Bool #
Ord QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods compare :: QualIdent -> QualIdent -> Ordering # (<) :: QualIdent -> QualIdent -> Bool # (<=) :: QualIdent -> QualIdent -> Bool # (>) :: QualIdent -> QualIdent -> Bool # (>=) :: QualIdent -> QualIdent -> Bool # max :: QualIdent -> QualIdent -> QualIdent # min :: QualIdent -> QualIdent -> QualIdent #
Read QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods readsPrec :: Int -> ReadS QualIdent # readList :: ReadS [QualIdent] # readPrec :: ReadPrec QualIdent # readListPrec :: ReadPrec [QualIdent] #
Show QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods showsPrec :: Int -> QualIdent -> ShowS # show :: QualIdent -> String # showList :: [QualIdent] -> ShowS #
Pretty QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods pPrint :: QualIdent -> Doc Source # pPrintPrec :: Int -> QualIdent -> Doc Source # pPrintList :: [QualIdent] -> Doc Source #
HasPosition QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods getPosition :: QualIdent -> Position Source # setPosition :: Position -> QualIdent -> QualIdent Source #
HasSpanInfo QualIdent Source #
Instance details Defined in Curry.Base.Ident Methods getSpanInfo :: QualIdent -> SpanInfo Source # setSpanInfo :: SpanInfo -> QualIdent -> QualIdent Source # updateEndPos :: QualIdent -> QualIdent Source #

qualName :: QualIdent -> String Source #

show function for qualified identifiers)=

escQualName :: QualIdent -> String Source #

Show the name of an QualIdent escaped by ticks

isQInfixOp :: QualIdent -> Bool Source #

Check whether an QualIdent identifies an infix operation

qualify :: Ident -> QualIdent Source #

Convert an Ident to a QualIdent

qualifyWith :: ModuleIdent -> Ident -> QualIdent Source #

Convert an Ident to a QualIdent with a given ModuleIdent

qualQualify :: ModuleIdent -> QualIdent -> QualIdent Source #

Convert an QualIdent to a new QualIdent with a given ModuleIdent. If the original QualIdent already contains an ModuleIdent it remains unchanged.

qualifyLike :: QualIdent -> Ident -> QualIdent Source #

Qualify an Ident with the ModuleIdent of the given QualIdent, if present.

isQualified :: QualIdent -> Bool Source #

Check whether a QualIdent contains a ModuleIdent

unqualify :: QualIdent -> Ident Source #

Remove the qualification of an QualIdent

qualUnqualify :: ModuleIdent -> QualIdent -> QualIdent Source #

Remove the qualification with a specific ModuleIdent. If the original QualIdent has no ModuleIdent or a different one, it remains unchanged.

localIdent :: ModuleIdent -> QualIdent -> Maybe Ident Source #

Extract the Ident of an QualIdent if it is local to the ModuleIdent, i.e. if the Ident is either unqualified or qualified with the given ModuleIdent.

isLocalIdent :: ModuleIdent -> QualIdent -> Bool Source #

Check whether the given QualIdent is local to the given ModuleIdent.

updQualIdent :: (ModuleIdent -> ModuleIdent) -> (Ident -> Ident) -> QualIdent -> QualIdent Source #

Update a QualIdent by applying functions to its components

qIdentLength :: QualIdent -> Int Source #