Curry.Base.Ident

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.

Module identifiers

data ModuleIdent

Module identifier

Constructors

ModuleIdent

Fields

• midSpanInfo :: SpanInfo

  source code SpanInfo

• midQualifiers :: [String]

  hierarchical idenfiers

Instances

Eq ModuleIdent

Defined in Curry.Base.Ident

Methods

(==) :: ModuleIdent -> ModuleIdent -> Bool

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

Ord ModuleIdent

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

Defined in Curry.Base.Ident

Methods

readsPrec :: Int -> ReadS ModuleIdent

readList :: ReadS [ModuleIdent]

readPrec :: ReadPrec ModuleIdent

readListPrec :: ReadPrec [ModuleIdent]

Show ModuleIdent

Defined in Curry.Base.Ident

Methods

showsPrec :: Int -> ModuleIdent -> ShowS

show :: ModuleIdent -> String

showList :: [ModuleIdent] -> ShowS

Pretty ModuleIdent

Defined in Curry.Base.Ident

Methods

pPrint :: ModuleIdent -> Doc

pPrintPrec :: Int -> ModuleIdent -> Doc

pPrintList :: [ModuleIdent] -> Doc

HasPosition ModuleIdent

Defined in Curry.Base.Ident

Methods

getPosition :: ModuleIdent -> Position

setPosition :: Position -> ModuleIdent -> ModuleIdent

HasSpanInfo ModuleIdent

Defined in Curry.Base.Ident

Methods

getSpanInfo :: ModuleIdent -> SpanInfo

setSpanInfo :: SpanInfo -> ModuleIdent -> ModuleIdent

updateEndPos :: ModuleIdent -> ModuleIdent

mkMIdent :: [String] -> ModuleIdent

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

moduleName :: ModuleIdent -> String

Retrieve the hierarchical name of a module

escModuleName :: ModuleIdent -> String

Show the name of an ModuleIdent escaped by ticks

fromModuleName :: String -> ModuleIdent

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

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

Add a source code Position to a ModuleIdent

mIdentLength :: ModuleIdent -> Int

Local identifiers

data Ident

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

Defined in Curry.Base.Ident

Methods

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

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

Ord Ident

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

Defined in Curry.Base.Ident

Methods

readsPrec :: Int -> ReadS Ident

readList :: ReadS [Ident]

readPrec :: ReadPrec Ident

readListPrec :: ReadPrec [Ident]

Show Ident

Defined in Curry.Base.Ident

Methods

showsPrec :: Int -> Ident -> ShowS

show :: Ident -> String

showList :: [Ident] -> ShowS

Pretty Ident

Defined in Curry.Base.Ident

Methods

pPrint :: Ident -> Doc

pPrintPrec :: Int -> Ident -> Doc

pPrintList :: [Ident] -> Doc

HasPosition Ident

Defined in Curry.Base.Ident

Methods

getPosition :: Ident -> Position

setPosition :: Position -> Ident -> Ident

HasSpanInfo Ident

Defined in Curry.Base.Ident

Methods

getSpanInfo :: Ident -> SpanInfo

setSpanInfo :: SpanInfo -> Ident -> Ident

updateEndPos :: Ident -> Ident

mkIdent :: String -> Ident

Construct an Ident from a String

showIdent :: Ident -> String

Show function for an Ident

escName :: Ident -> String

Show the name of an Ident escaped by ticks

identSupply :: [Ident]

Infinite list of different Idents

globalScope :: Integer

Global scope for renaming

hasGlobalScope :: Ident -> Bool

Has the identifier global scope?

isRenamed :: Ident -> Bool

Is the Ident renamed?

renameIdent :: Ident -> Integer -> Ident

Rename an Ident by changing its unique number

unRenameIdent :: Ident -> Ident

Revert the renaming of an Ident by resetting its unique number

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

Change the name of an Ident using a renaming function

addPositionIdent :: Position -> Ident -> Ident

Add a Position to an Ident

isInfixOp :: Ident -> Bool

Check whether an Ident identifies an infix operation

identLength :: Ident -> Int

Qualified identifiers

data QualIdent

Qualified identifier

Constructors

QualIdent

Fields

• qidSpanInfo :: SpanInfo

  Source code SpanInfo

• qidModule :: Maybe ModuleIdent

  optional module identifier

• qidIdent :: Ident

  identifier itself

Instances

Eq QualIdent

Defined in Curry.Base.Ident

Methods

(==) :: QualIdent -> QualIdent -> Bool

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

Ord QualIdent

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

Defined in Curry.Base.Ident

Methods

readsPrec :: Int -> ReadS QualIdent

readList :: ReadS [QualIdent]

readPrec :: ReadPrec QualIdent

readListPrec :: ReadPrec [QualIdent]

Show QualIdent

Defined in Curry.Base.Ident

Methods

showsPrec :: Int -> QualIdent -> ShowS

show :: QualIdent -> String

showList :: [QualIdent] -> ShowS

Pretty QualIdent

Defined in Curry.Base.Ident

Methods

pPrint :: QualIdent -> Doc

pPrintPrec :: Int -> QualIdent -> Doc

pPrintList :: [QualIdent] -> Doc

HasPosition QualIdent

Defined in Curry.Base.Ident

Methods

getPosition :: QualIdent -> Position

setPosition :: Position -> QualIdent -> QualIdent

HasSpanInfo QualIdent

Defined in Curry.Base.Ident

Methods

getSpanInfo :: QualIdent -> SpanInfo

setSpanInfo :: SpanInfo -> QualIdent -> QualIdent

updateEndPos :: QualIdent -> QualIdent

qualName :: QualIdent -> String

show function for qualified identifiers)=

escQualName :: QualIdent -> String

Show the name of an QualIdent escaped by ticks

isQInfixOp :: QualIdent -> Bool

Check whether an QualIdent identifies an infix operation

qualify :: Ident -> QualIdent

Convert an Ident to a QualIdent

qualifyWith :: ModuleIdent -> Ident -> QualIdent

Convert an Ident to a QualIdent with a given ModuleIdent

qualQualify :: ModuleIdent -> QualIdent -> QualIdent

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

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

isQualified :: QualIdent -> Bool

Check whether a QualIdent contains a ModuleIdent

unqualify :: QualIdent -> Ident

Remove the qualification of an QualIdent

qualUnqualify :: ModuleIdent -> QualIdent -> QualIdent

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

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

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

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

Update a QualIdent by applying functions to its components

qIdentLength :: QualIdent -> Int

Predefined simple identifiers

Identifiers for modules

emptyMIdent :: ModuleIdent

ModuleIdent for the empty module

mainMIdent :: ModuleIdent

ModuleIdent for the main module

preludeMIdent :: ModuleIdent

ModuleIdent for the Prelude

Identifiers for types

arrowId :: Ident

Ident for the type '(->)'

unitId :: Ident

Ident for the type/value unit ('()')

boolId :: Ident

Ident for the type Bool

charId :: Ident

Ident for the type Char

intId :: Ident

Ident for the type Int

floatId :: Ident

Ident for the type Float

listId :: Ident

Ident for the type '[]'

ioId :: Ident

Ident for the type IO

successId :: Ident

Ident for the type Success

Identifiers for type classes

eqId :: Ident

Ident for the Eq class

ordId :: Ident

Ident for the Ord class

enumId :: Ident

Ident for the Enum class

boundedId :: Ident

Ident for the Bounded class

readId :: Ident

Ident for the Read class

showId :: Ident

Ident for the Show class

numId :: Ident

Ident for the Num class

fractionalId :: Ident

Ident for the Fractional class

monadId :: Ident

Ident for the Monad class

Identifiers for constructors

trueId :: Ident

Ident for the value True

falseId :: Ident

Ident for the value False

nilId :: Ident

Ident for the value '[]'

consId :: Ident

Ident for the function :

tupleId :: Int -> Ident

Construct an Ident for an n-ary tuple where n > 1

isTupleId :: Ident -> Bool

Check whether an Ident is an identifier for an tuple type

tupleArity :: Ident -> Int

Compute the arity of a tuple identifier

Identifiers for values

mainId :: Ident

Ident for the main function

minusId :: Ident

Ident for the minus function

fminusId :: Ident

Ident for the minus function for Floats

applyId :: Ident

Ident for the apply function

errorId :: Ident

Ident for the error function

failedId :: Ident

Ident for the failed function

idId :: Ident

Ident for the id function

succId :: Ident

Ident for the succ function

predId :: Ident

Ident for the pred function

toEnumId :: Ident

Ident for the toEnum function

fromEnumId :: Ident

Ident for the fromEnum function

enumFromId :: Ident

Ident for the enumFrom function

enumFromThenId :: Ident

Ident for the enumFromThen function

enumFromToId :: Ident

Ident for the enumFromTo function

enumFromThenToId :: Ident

Ident for the enumFromThenTo function

maxBoundId :: Ident

Ident for the maxBound function

minBoundId :: Ident

Ident for the minBound function

lexId :: Ident

Ident for the lex function

readsPrecId :: Ident

Ident for the readsPrec function

readParenId :: Ident

Ident for the readParen function

showsPrecId :: Ident

Ident for the showsPrec function

showParenId :: Ident

Ident for the showParen function

showStringId :: Ident

Ident for the showString function

andOpId :: Ident

Ident for the && operator

eqOpId :: Ident

Ident for the == operator

leqOpId :: Ident

Ident for the <= operator

ltOpId :: Ident

Ident for the < operator

orOpId :: Ident

Ident for the || operator

appendOpId :: Ident

Ident for the ++ operator

dotOpId :: Ident

Ident for the . operator

anonId :: Ident

Ident for anonymous variable

isAnonId :: Ident -> Bool

Check whether an Ident represents an anonymous identifier (anonId)

Predefined qualified identifiers

Identifiers for types

qArrowId :: QualIdent

QualIdent for the type '(->)'

qUnitId :: QualIdent

QualIdent for the type/value unit ('()')

qBoolId :: QualIdent

QualIdent for the type Bool

qCharId :: QualIdent

QualIdent for the type Char

qIntId :: QualIdent

QualIdent for the type Int

qFloatId :: QualIdent

QualIdent for the type Float

qListId :: QualIdent

QualIdent for the type '[]'

qIOId :: QualIdent

QualIdent for the type IO

qSuccessId :: QualIdent

QualIdent for the type Success

isPrimTypeId :: QualIdent -> Bool

Check whether an QualIdent is an primary type constructor

Identifiers for type classes

qEqId :: QualIdent

QualIdent for the Eq class

qOrdId :: QualIdent

QualIdent for the Ord class

qEnumId :: QualIdent

QualIdent for the Enum class

qBoundedId :: QualIdent

QualIdent for the Bounded class

qReadId :: QualIdent

QualIdent for the Read class

qShowId :: QualIdent

QualIdent for the Show class

qNumId :: QualIdent

QualIdent for the Num class

qFractionalId :: QualIdent

QualIdent for the Fractional class

qMonadId :: QualIdent

QualIdent for the Monad class

Identifiers for constructors

qTrueId :: QualIdent

QualIdent for the constructor True

qFalseId :: QualIdent

QualIdent for the constructor False

qNilId :: QualIdent

QualIdent for the constructor '[]'

qConsId :: QualIdent

QualIdent for the constructor :

qTupleId :: Int -> QualIdent

QualIdent for the type of n-ary tuples

isQTupleId :: QualIdent -> Bool

Check whether an QualIdent is an identifier for an tuple type

qTupleArity :: QualIdent -> Int

Compute the arity of an qualified tuple identifier

Identifiers for values

qApplyId :: QualIdent

QualIdent for the apply function

qErrorId :: QualIdent

QualIdent for the error function

qFailedId :: QualIdent

QualIdent for the failed function

qIdId :: QualIdent

QualIdent for the id function

qFromEnumId :: QualIdent

QualIdent for the fromEnum function

qEnumFromId :: QualIdent

QualIdent for the enumFrom function

qEnumFromThenId :: QualIdent

QualIdent for the enumFromThen function

qEnumFromToId :: QualIdent

QualIdent for the enumFromTo function

qEnumFromThenToId :: QualIdent

QualIdent for the enumFromThenTo function

qMaxBoundId :: QualIdent

QualIdent for the maxBound function

qMinBoundId :: QualIdent

QualIdent for the minBound function

qLexId :: QualIdent

QualIdent for the lex function

qReadsPrecId :: QualIdent

QualIdent for the readsPrec function

qReadParenId :: QualIdent

QualIdent for the readParen function

qShowsPrecId :: QualIdent

QualIdent for the showsPrec function

qShowParenId :: QualIdent

QualIdent for the showParen function

qShowStringId :: QualIdent

QualIdent for the showString function

qAndOpId :: QualIdent

QualIdent for the && operator

qEqOpId :: QualIdent

QualIdent for the == operator

qLeqOpId :: QualIdent

QualIdent for the <= operator

qLtOpId :: QualIdent

QualIdent for the < operator

qOrOpId :: QualIdent

QualIdent for the || operator

qAppendOpId :: QualIdent

QualIdent for the ++ operator

qDotOpId :: QualIdent

QualIdent for the . operator

Extended functionality

Functional patterns

fpSelectorId :: Int -> Ident

Construct an Ident for a functional pattern

isFpSelectorId :: Ident -> Bool

Check whether an Ident is an identifier for a functional pattern

isQualFpSelectorId :: QualIdent -> Bool

Check whether an QualIdent is an identifier for a function pattern

Records

recSelectorId

Arguments

:: QualIdent

identifier of the record

-> Ident

identifier of the label

-> Ident

Construct an Ident for a record selection pattern

qualRecSelectorId

Arguments

:: ModuleIdent

default module

-> QualIdent

record identifier

-> Ident

label identifier

-> QualIdent

Construct a QualIdent for a record selection pattern

recUpdateId

Arguments

:: QualIdent

record identifier

-> Ident

label identifier

-> Ident

Construct an Ident for a record update pattern

qualRecUpdateId

Arguments

:: ModuleIdent

default module

-> QualIdent

record identifier

-> Ident

label identifier

-> QualIdent

Construct a QualIdent for a record update pattern

recordExt :: String

Annotation for record identifiers

recordExtId :: Ident -> Ident

Construct an Ident for a record

isRecordExtId :: Ident -> Bool

Check whether an Ident is an identifier for a record

fromRecordExtId :: Ident -> Ident

Retrieve the Ident from a record identifier

labelExt :: String

Annotation for record label identifiers

labelExtId :: Ident -> Ident

Construct an Ident for a record label

isLabelExtId :: Ident -> Bool

Check whether an Ident is an identifier for a record label

fromLabelExtId :: Ident -> Ident

Retrieve the Ident from a record label identifier

renameLabel :: Ident -> Ident

Rename an Ident for a record label

mkLabelIdent :: String -> Ident

Construct an Ident for a record label