| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Agda.Syntax.Notation
Contents
Description
As a concrete name, a notation is a non-empty list of alternating IdParts and holes.
In contrast to concrete names, holes can be binders.
Example:
syntax fmap (λ x → e) xs = for x ∈ xs return e
The declared notation for fmap is for_∈_return_ where the first hole is a binder.
Synopsis
- data HoleName
- = LambdaHole { }
- | ExprHole { }
- isLambdaHole :: HoleName -> Bool
- stringParts :: Notation -> [String]
- holeTarget :: NotationPart -> Maybe Int
- isAHole :: NotationPart -> Bool
- isBinder :: NotationPart -> Bool
- data NotationKind
- notationKind :: Notation -> NotationKind
- mkNotation :: [NamedArg HoleName] -> [RString] -> Either String Notation
- data NewNotation = NewNotation {}
- namesToNotation :: QName -> Name -> NewNotation
- useDefaultFixity :: NewNotation -> NewNotation
- notationNames :: NewNotation -> [QName]
- syntaxOf :: Name -> Notation
- mergeNotations :: List1 NewNotation -> List1 NewNotation
- isLambdaNotation :: NewNotation -> Bool
- _notaFixity :: Lens' NewNotation Fixity
- data NotationSection = NotationSection {}
- noSection :: NewNotation -> NotationSection
Documentation
Data type constructed in the Happy parser; converted to
NotationPart before it leaves the Happy code.
Constructors
| LambdaHole |
|
Fields | |
| ExprHole | Simple named hole with hiding. |
isLambdaHole :: HoleName -> Bool Source #
Is the hole a binder?
stringParts :: Notation -> [String] Source #
Get a flat list of identifier parts of a notation.
holeTarget :: NotationPart -> Maybe Int Source #
Target argument position of a part (Nothing if it is not a hole).
isAHole :: NotationPart -> Bool Source #
Is the part a hole?
isBinder :: NotationPart -> Bool Source #
Is the part a binder?
data NotationKind Source #
Classification of notations.
Constructors
| InfixNotation | Ex: |
| PrefixNotation | Ex: |
| PostfixNotation | Ex: |
| NonfixNotation | Ex: |
| NoNotation |
Instances
notationKind :: Notation -> NotationKind Source #
Classify a notation by presence of leading and/or trailing normal holes.
mkNotation :: [NamedArg HoleName] -> [RString] -> Either String Notation Source #
From notation with names to notation with indices.
An example (with some parts of the code omitted):
The lists
["for", "x", "∈", "xs", "return", "e"]
and
[
are mapped to the following notation:
LambdaHole ("x" :| []) "e", ExprHole "xs"]
[ IdPart "for" , VarPart (BoundVariablePosition 0 0)
, IdPart "∈" , HolePart 1
, IdPart "return" , HolePart 0
]
data NewNotation Source #
All the notation information related to a name.
Constructors
| NewNotation | |
Fields
| |
Instances
namesToNotation :: QName -> Name -> NewNotation Source #
If an operator has no specific notation, then it is computed from its name.
useDefaultFixity :: NewNotation -> NewNotation Source #
Replace noFixity by defaultFixity.
notationNames :: NewNotation -> [QName] Source #
Return the IdParts of a notation, the first part qualified,
the other parts unqualified.
This allows for qualified use of operators, e.g.,
M.for x ∈ xs return e, or x ℕ.+ y.
mergeNotations :: List1 NewNotation -> List1 NewNotation Source #
Merges NewNotations that have the same precedence level and
notation, with two exceptions:
- Operators and notations coming from syntax declarations are kept separate.
- If all instances of a given
NewNotationhave the same precedence level or are "unrelated", then they are merged. They get the given precedence level, if any, and otherwise they become unrelated (but related to each other).
If NewNotations that are merged have distinct associativities,
then they get NonAssoc as their associativity.
Precondition: No Name may occur in more than one list element.
Every NewNotation must have the same notaName.
Postcondition: No Name occurs in more than one list element.
isLambdaNotation :: NewNotation -> Bool Source #
Check if a notation contains any lambdas (in which case it cannot be used in a pattern).
_notaFixity :: Lens' NewNotation Fixity Source #
Lens for Fixity in NewNotation.
Sections
data NotationSection Source #
Sections, as well as non-sectioned operators.
Constructors
| NotationSection | |
Fields
| |
Instances
noSection :: NewNotation -> NotationSection Source #
Converts a notation to a (non-)section.