| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
FreeC.IR.Syntax.Name
Description
This module contains the definition of names of our intermediate language.
Synopsis
- data Name
- identFromName :: Name -> Maybe String
- data QName
- nameFromQName :: QName -> Name
- identFromQName :: QName -> Maybe String
- toQual :: ModName -> QName -> QName
- toUnQual :: QName -> QName
- data Scope
- type ScopedName = (Scope, QName)
- type TypeVarIdent = String
- type ModName = String
- type VarName = QName
- type ConName = QName
- type TypeConName = QName
- data DeclIdent = DeclIdent {}
- class HasDeclIdent node where
- declQName :: HasDeclIdent node => node -> QName
- declName :: HasDeclIdent node => node -> Name
- internalIdentChar :: Char
- isInternalIdent :: String -> Bool
- isInternalName :: Name -> Bool
- isInternalQName :: QName -> Bool
Documentation
An identifier or a symbolic name.
The constructors of this type do not contain source spans because
Names are intended to be comparable. They are used as keys to
identify nodes of the dependency graph for example.
Constructors
| Ident String | An identifier, e.g. |
| Symbol String | A symbolic name, e.g. |
identFromName :: Name -> Maybe String Source #
Extracts an identifier from a name. Returns Nothing if the
given name is a symbol and not an identifier.
A qualifiable Name.
Instances
| Eq QName Source # | |
| Ord QName Source # | |
Defined in FreeC.IR.Syntax.Name | |
| Show QName Source # | |
| Pretty QName Source # | Pretty instance for qualifiable identifiers and symbols. |
Defined in FreeC.IR.Syntax.Name | |
| FromJSON QName | All Haskell names in the interface file are qualified. |
Defined in FreeC.Environment.ModuleInterface.Decoder | |
| ToJSON QName | |
Defined in FreeC.Environment.ModuleInterface.Encoder Methods toEncoding :: QName -> Encoding toJSONList :: [QName] -> Value toEncodingList :: [QName] -> Encoding | |
| Parseable QName Source # | Qualifiable names can be parsed. |
Defined in FreeC.Frontend.IR.Parser | |
nameFromQName :: QName -> Name Source #
Extracts the name of a qualifiable name.
toQual :: ModName -> QName -> QName Source #
Converts a qualifiable name to a name that is qualified with the given module name.
Data type for the different name spaces of the intermediate representation.
Similar to Haskell, type and function names live in separate name spaces.
Additionally, there is a name space for fresh identifiers without a
corresponding IR node. If a fresh identifier is introduced and used
as an IR variable or type variable name, the corresponding entry
lives in the value or type scope respectively. The FreshScope
contains only IR identifiers that were generated such that their
renamed counterpart of the target language can be used as a fresh
identifier by the back end.
Constructors
| TypeScope | |
| ValueScope | |
| FreshScope |
type TypeVarIdent = String Source #
The name of a type variable.
The name of a function or built-in operator used in prefix notation, e.g.
f x y or (+) n m
type TypeConName = QName Source #
The name of a type or type constructor, e.g. Integer or [] a
The name of a top-level declaration including location information.
Constructors
| DeclIdent | |
Fields | |
class HasDeclIdent node where Source #
Type class for AST nodes with a declaration identifier.
Instances
| HasDeclIdent ConDecl Source # | Instance to get the name of a constructor declaration. |
| HasDeclIdent TypeDecl Source # | Instance to get the name of a type synonym or data type declaration. |
| HasDeclIdent Bind Source # | Instance to get the name of a |
| HasDeclIdent VarPat Source # | Instance to get the name of a |
| HasDeclIdent FuncDecl Source # | Instance to get the name of a function declaration. |
declQName :: HasDeclIdent node => node -> QName Source #
Gets the qualified name of the given AST node.
declName :: HasDeclIdent node => node -> Name Source #
Gets the unqualified name of the given AST node.
internalIdentChar :: Char Source #
The character that is used to mark internal identifiers.
This is used to generate fresh identifiers that don't conflict with user- defined identifiers.
isInternalIdent :: String -> Bool Source #
Tests whether the given identifier was generated for internal use only
(i.e., contains internalIdentChar).
isInternalName :: Name -> Bool Source #
Tests whether the given name was generated for internal use only (i.e.,
it is an identifier that matches isInternalIdent).
isInternalQName :: QName -> Bool Source #
Tests whether the given qualifiable name was generated for internal use
only (i.e., the qualified name is internal according to isInternalName).