Safe Haskell	None
Language	Haskell2010

BNFC.CF

Contents

Categories
Types (categories in AST)
Expressions (for defined constructors)
Labels
Rule definition
List pragmas
Flags etc.
Utilities

Description

The internal representation of LBNF grammars.

Pragmas have been desugared as far as possible.

Synopsis

data LBNF = LBNF {
- _lbnfSignature :: Signature
- _lbnfFunctions :: Functions
- _lbnfASTRules :: ASTRules
- _lbnfASTRulesAP :: ASTRulesAP
- _lbnfASTBuiltins :: UsedBuiltins
- _lbnfParserRules :: ParserRules
- _lbnfParserBuiltins :: UsedBuiltins
- _lbnfEntryPoints :: EntryPoints
- _lbnfTokenDefs :: TokenDefs
- _lbnfKeywords :: KeywordUses
- _lbnfSymbols :: SymbolUses
- _lbnfSymbolsKeywords :: SymbolsKeywords
- _lbnfLineComments :: LineComments
- _lbnfBlockComments :: BlockComments
- _lbnfLayoutStart :: LayoutKeywords
- _lbnfLayoutStop :: LayoutKeywords
- _lbnfLayoutTop :: Maybe Position
}
type Signature = Map LabelName (WithPosition FunType)
type Functions = Map LabelName (WithPosition Function)
type ASTRules = Map Cat (Map Label (WithPosition ARuleRHS))
type ASTRulesAP = Map Type (Map Label ([Type], (Integer, WithPosition ARHS)))
type ParserRules = Map Cat (Map RHS (WithPosition RuleLabel))
type EntryPoints = Map Cat (List1 Position)
type UsedBuiltins = Map BuiltinCat (List1 Position)
type TokenDefs = Map CatName (WithPosition TokenDef)
type KeywordUses = Map Keyword (List1 Position)
type SymbolUses = Map Symbol (List1 Position)
type SymbolsKeywords = Map String1 Int
type LineComments = Map Position LineComment
type BlockComments = Map Position BlockComment
type LayoutKeywords = Map Keyword Position
initLBNF :: LBNF
data TokenDef = TokenDef {
- positionToken :: PositionToken
- regexToken :: Regex
- isIdent :: Bool
}
newtype Keyword = Keyword {
- theKeyword :: List1 Char
}
newtype Symbol = Symbol {
- theSymbol :: List1 Char
}
newtype LineComment = LineComment String1
data BlockComment = BlockComment String1 String1
type CatName = String1
type Cat = Cat' BaseCat
data Cat' a
- = Cat a
- | ListCat (Cat' a)
- | CoerceCat CatName Integer
data BaseCat
- = BuiltinCat BuiltinCat
- | IdentCat IdentCat
- | TokenCat CatName
- | BaseCat CatName
data BuiltinCat
- = BChar
- | BDouble
- | BInteger
- | BString
data IdentCat = BIdent
data Type
- = BaseType BaseCat
- | ListType Type
data FunType = FunType {
- targetType :: Type
- argTypes :: [Type]
}
data Exp
- = App Label FunType [Exp]
- | Var Parameter
- | LitInteger Integer
- | LitDouble Double
- | LitChar Char
- | LitString String
data Parameter = Parameter {
- paramName :: VarName
- paramType :: Type
}
type VarName = String1
data Function = Function {
- funPars :: [Parameter]
- funBody :: Exp
- funType :: Type
}
type LabelName = String1
data Label
- = LId LabelName
- | LDef LabelName
- | LWild
- | LNil
- | LSg
- | LCons
data Item' a
- = Terminal a
- | NTerminal Cat
type AItem = Item' String1
type Item = Item' Keyword
type RHS' a = [Item' a]
type ARHS = RHS' String1
type RHS = RHS' Keyword
data RuleOrigin
- = FromOrdinary
- | FromRules
- | FromCoercions
- | FromList
data ARuleRHS = ARuleRHS {
- aruleOrigin :: RuleOrigin
- aruleParseable :: Parseable
- aruleRHS :: ARHS
}
data RuleLabel = RuleLabel {
- ruleOrigin :: RuleOrigin
- ruleLabel :: Label
}
data Separator' a
- = Separator a
- | Terminator a
type ASeparator = Separator' String1
type Separator = Separator' Keyword
data Parseable
- = Internal
- | Parseable
data PositionToken
- = PositionToken
- | NoPositionToken
lbnfTokenDefs :: Lens' LBNF TokenDefs
lbnfSymbolsKeywords :: Lens' LBNF SymbolsKeywords
lbnfSymbols :: Lens' LBNF SymbolUses
lbnfSignature :: Lens' LBNF Signature
lbnfParserRules :: Lens' LBNF ParserRules
lbnfParserBuiltins :: Lens' LBNF UsedBuiltins
lbnfLineComments :: Lens' LBNF LineComments
lbnfLayoutTop :: Lens' LBNF (Maybe Position)
lbnfLayoutStop :: Lens' LBNF LayoutKeywords
lbnfLayoutStart :: Lens' LBNF LayoutKeywords
lbnfKeywords :: Lens' LBNF KeywordUses
lbnfFunctions :: Lens' LBNF Functions
lbnfEntryPoints :: Lens' LBNF EntryPoints
lbnfBlockComments :: Lens' LBNF BlockComments
lbnfASTRulesAP :: Lens' LBNF ASTRulesAP
lbnfASTRules :: Lens' LBNF ASTRules
lbnfASTBuiltins :: Lens' LBNF UsedBuiltins
catToType :: Cat -> Type
catToIdentifier :: Cat -> String1
baseCatToIdentifier :: BaseCat -> String1
printCatName :: Cat -> String
printCatNamePrec :: Cat -> String
printCatNamePrec' :: Cat -> String
catToString :: Cat -> String
printBaseCatName :: BaseCat -> String
isCatCoerced :: Cat -> Bool
isCatList :: Cat -> Bool
isCatBuiltin :: Cat -> Bool
getCatPrec :: Cat -> Integer
identCat :: Cat -> String
isBuiltin :: BaseCat -> Bool
isIdentifier :: BaseCat -> Bool
isToken :: BaseCat -> Bool
builtinCats :: [(BuiltinCat, String1)]
printBuiltinCat :: BuiltinCat -> String1
printIdentCat :: IdentCat -> String1
parseBuiltinCat :: String1 -> Maybe (Either IdentCat BuiltinCat)
identBuiltinCats :: [(Either IdentCat BuiltinCat, String1)]
tChar :: Type
tDouble :: Type
tInteger :: Type
tString :: Type
printTypeName :: Type -> String
identType :: Type -> String
isListType :: Type -> Bool
isBuiltinType :: Type -> Bool
isIdentType :: Type -> Bool
isTokenType :: Type -> Bool
labelFromIdentifier :: LabelName -> Label
printLabelName :: Label -> String
printRuleName :: Label -> String
isDef :: Label -> Bool
isCoercion :: Label -> Bool
isList :: Label -> Bool
isALabel :: Label -> Bool
isPLabel :: Label -> Bool
filterLabelsAST :: [String] -> [(Label, ([Type], (Integer, ARHS)))] -> [(Label, ([Type], (Integer, ARHS)))]
filterLabelsPrinter :: [String] -> [(Label, ([Type], (Integer, ARHS)))] -> [(Label, ([Type], (Integer, ARHS)))]
printRhsCats :: [Item' a] -> [String]
printRHS :: [Item' Keyword] -> [String]
getRhsCats :: [Item' a] -> [Cat]
printItemName :: Item' String1 -> String
isNTerminal :: Item' a -> Bool
isItemListCat :: Item' a -> Bool
isItemBuiltin :: Item' a -> Bool
rhsCats :: RHS' a -> [Cat]
rhsType :: RHS' a -> [Type]
isNoPositionToken :: WithPosition TokenDef -> Bool
isPositionToken :: WithPosition TokenDef -> Bool
isPosToken :: TokenDef -> Bool
hasIdentifier :: TokenDefs -> Bool
printExp :: Bool -> String -> Exp -> String
printExp1 :: Exp -> String
printExp2 :: String -> Exp -> String
isApp1 :: Exp -> Bool
isApp2 :: Exp -> Bool
getKeyword :: Separator -> Keyword
parseKeyword :: String -> Maybe Keyword
parseASeparator :: Separator' String -> Maybe ASeparator
trimSeparator :: ASeparator -> Maybe Separator
lookupRHS :: Cat -> RHS -> ParserRules -> Maybe (WithPosition RuleLabel)
layoutsAreUsed :: LBNF -> Bool

Documentation

data LBNF Source #

The internal representation of a LBNF grammar.

The name is an abbreviation of Context-Free (Grammar).

Rules are stored in:

The signature: a map from rule names to their type (Id labels only). The signature is used for type-checking definitions and special rules (lists).
The AST rules: a map from categories to labels to rhss. This representation is useful for generating the abstract syntax and the printer. Keywords are not trimmed here to allow the extra whitespace to be printed (see BNFC/bnfc#70).
The parser rules: a map from categories to rhss to labels. internal rules are not contained in this map. This representation expresses that each parseable BNF rule can have at most one label. It is useful for detecting overlapping rules, e.g. coming from proper rules and list/coercion pragmas. The parser generation should start with these rules. Keywords are trimmed since BNFC-generated parsers are not whitespace-sensitive.

Constructors

LBNF

Fields

_lbnfSignature :: Signature
Type for each AST constructor and defined function.
_lbnfFunctions :: Functions
Checked functions from define pragmas.
_lbnfASTRules :: ASTRules
Per category, its rules ordered by label.
_lbnfASTRulesAP :: ASTRulesAP
AST rules used to generate abstract syntax and printer. Per type (category without precedence), its rules non terminals and a map from category precedence to rhs, ordered by label.
_lbnfASTBuiltins :: UsedBuiltins
Builtin categories Char, Integer, ... (non-overwritten) mentioned in the AST. (Includes builtin categories only mentioned in Internal rules.)
_lbnfParserRules :: ParserRules
Per category, its Parseable rules ordered by RHS.
_lbnfParserBuiltins :: UsedBuiltins
Builtin categories Char, Integer, ... mentioned in the Parseable rules. (and not overwritten).
_lbnfEntryPoints :: EntryPoints
Collection of entry points for parser, each with the position(s) where it was declared entry point.
_lbnfTokenDefs :: TokenDefs
User-defined token categories.
_lbnfKeywords :: KeywordUses
Keywords and their occurrences in rhss. Computed by pass 1.
_lbnfSymbols :: SymbolUses
Symbols and their occurrences in rhss. Computed by pass 1.
_lbnfSymbolsKeywords :: SymbolsKeywords
Symbols and keywords used in lexer and parser specifications
_lbnfLineComments :: LineComments
Line comment pragmas by position, e.g. comment "--".
_lbnfBlockComments :: BlockComments
Block comment pragmas by position, e.g. comment "{-" "-}".
_lbnfLayoutStart :: LayoutKeywords
layout start keywords with the pragma position. Keywords are members of _lbnfKeywords.
_lbnfLayoutStop :: LayoutKeywords
layout stop keywords with the pragma position. Disjoint from _lbnfLayout. Keywords are members of _lbnfKeywords.
_lbnfLayoutTop :: Maybe Position
Position of layout toplevel, if present.

Instances

Instances details

Show LBNF Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> LBNF -> ShowS Source # show :: LBNF -> String Source # showList :: [LBNF] -> ShowS Source #

type Signature = Map LabelName (WithPosition FunType) Source #

type Functions = Map LabelName (WithPosition Function) Source #

type ASTRules = Map Cat (Map Label (WithPosition ARuleRHS)) Source #

type ASTRulesAP = Map Type (Map Label ([Type], (Integer, WithPosition ARHS))) Source #

type ParserRules = Map Cat (Map RHS (WithPosition RuleLabel)) Source #

type EntryPoints = Map Cat (List1 Position) Source #

type UsedBuiltins = Map BuiltinCat (List1 Position) Source #

type TokenDefs = Map CatName (WithPosition TokenDef) Source #

type KeywordUses = Map Keyword (List1 Position) Source #

type SymbolUses = Map Symbol (List1 Position) Source #

type SymbolsKeywords = Map String1 Int Source #

type LineComments = Map Position LineComment Source #

type BlockComments = Map Position BlockComment Source #

type LayoutKeywords = Map Keyword Position Source #

initLBNF :: LBNF Source #

data TokenDef Source #

A token category is defined by a regular expression.

Constructors

TokenDef
Fields positionToken :: PositionToken Is it a `position token`? regexToken :: Regex The defining regular expression. isIdent :: Bool Is it the `Ident` token?

Instances

Instances details

Show TokenDef Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> TokenDef -> ShowS Source # show :: TokenDef -> String Source # showList :: [TokenDef] -> ShowS Source #

newtype Keyword Source #

Keywords are non-empty trimmed strings. Trimming happens since LBNF is a whitespace-insensitive formalism. Should a future version of BNFC become whitespace sensitive, we have to abstain from trimming keywords by default.

Constructors

Keyword
Fields theKeyword :: List1 Char

Instances

Instances details

Eq Keyword Source #
Instance details Defined in BNFC.CF Methods (==) :: Keyword -> Keyword -> Bool Source # (/=) :: Keyword -> Keyword -> Bool Source #
Ord Keyword Source #
Instance details Defined in BNFC.CF Methods compare :: Keyword -> Keyword -> Ordering Source # (<) :: Keyword -> Keyword -> Bool Source # (<=) :: Keyword -> Keyword -> Bool Source # (>) :: Keyword -> Keyword -> Bool Source # (>=) :: Keyword -> Keyword -> Bool Source # max :: Keyword -> Keyword -> Keyword Source # min :: Keyword -> Keyword -> Keyword Source #
Show Keyword Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Keyword -> ShowS Source # show :: Keyword -> String Source # showList :: [Keyword] -> ShowS Source #

newtype Symbol Source #

Constructors

Symbol
Fields theSymbol :: List1 Char

Instances

Instances details

Eq Symbol Source #
Instance details Defined in BNFC.CF Methods (==) :: Symbol -> Symbol -> Bool Source # (/=) :: Symbol -> Symbol -> Bool Source #
Ord Symbol Source #
Instance details Defined in BNFC.CF Methods compare :: Symbol -> Symbol -> Ordering Source # (<) :: Symbol -> Symbol -> Bool Source # (<=) :: Symbol -> Symbol -> Bool Source # (>) :: Symbol -> Symbol -> Bool Source # (>=) :: Symbol -> Symbol -> Bool Source # max :: Symbol -> Symbol -> Symbol Source # min :: Symbol -> Symbol -> Symbol Source #
Show Symbol Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Symbol -> ShowS Source # show :: Symbol -> String Source # showList :: [Symbol] -> ShowS Source #

newtype LineComment Source #

Constructors

LineComment String1

Instances

Instances details

Show LineComment Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> LineComment -> ShowS Source # show :: LineComment -> String Source # showList :: [LineComment] -> ShowS Source #

data BlockComment Source #

Constructors

BlockComment String1 String1

Instances

Instances details

Show BlockComment Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> BlockComment -> ShowS Source # show :: BlockComment -> String Source # showList :: [BlockComment] -> ShowS Source #

Types (categories in AST)

data Type Source #

Types are categories without the precedences (CoerceCat).

Constructors

BaseType BaseCat	Base category.
ListType Type	List category.

Instances

Instances details

Eq Type Source #
Instance details Defined in BNFC.CF Methods (==) :: Type -> Type -> Bool Source # (/=) :: Type -> Type -> Bool Source #
Ord Type Source #
Instance details Defined in BNFC.CF Methods compare :: Type -> Type -> Ordering Source # (<) :: Type -> Type -> Bool Source # (<=) :: Type -> Type -> Bool Source # (>) :: Type -> Type -> Bool Source # (>=) :: Type -> Type -> Bool Source # max :: Type -> Type -> Type Source # min :: Type -> Type -> Type Source #
Show Type Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Type -> ShowS Source # show :: Type -> String Source # showList :: [Type] -> ShowS Source #

data FunType Source #

Function type t(t₁,...,tₙ) or t₁ → ... → tₙ → t.

Constructors

FunType
Fields targetType :: Type Result type. argTypes :: [Type] Types of parameters, left to right.

Instances

Instances details

Eq FunType Source #
Instance details Defined in BNFC.CF Methods (==) :: FunType -> FunType -> Bool Source # (/=) :: FunType -> FunType -> Bool Source #
Show FunType Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> FunType -> ShowS Source # show :: FunType -> String Source # showList :: [FunType] -> ShowS Source #

Expressions (for defined constructors)

data Exp Source #

Bodies of Function. For convenience, these are fully typed.

Constructors

App Label FunType [Exp]	(Possibly defined) label with its type applied to the correct number of expressions.
Var Parameter	Use of function parameter.
LitInteger Integer
LitDouble Double
LitChar Char
LitString String

Instances

Instances details

Show Exp Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Exp -> ShowS Source # show :: Exp -> String Source # showList :: [Exp] -> ShowS Source #

data Parameter Source #

Bound variable.

Constructors

Parameter
Fields paramName :: VarName paramType :: Type

Instances

Instances details

Show Parameter Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Parameter -> ShowS Source # show :: Parameter -> String Source # showList :: [Parameter] -> ShowS Source #

type VarName = String1 Source #

data Function Source #

Definition body of a constructor.

Constructors

Function
Fields funPars :: [Parameter] funBody :: Exp funType :: Type

Instances

Instances details

Show Function Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Function -> ShowS Source # show :: Function -> String Source # showList :: [Function] -> ShowS Source #

Labels

type LabelName = String1 Source #

Label names are nonempty strings.

data Label Source #

LBNF rule label (AST constructor).

Constructors

LId LabelName	ordinary rule label (uppercase)
LDef LabelName	defined label (lowercase) No representation in AST:
LWild	coercion `_` List labels, mapped to the list constructors of the target language.
LNil	empty list `[]`
LSg	singleton list `(:[])` ("robot gorilla")
LCons	list constructor `(:)`

Instances

Instances details

Eq Label Source #
Instance details Defined in BNFC.CF Methods (==) :: Label -> Label -> Bool Source # (/=) :: Label -> Label -> Bool Source #
Ord Label Source #
Instance details Defined in BNFC.CF Methods compare :: Label -> Label -> Ordering Source # (<) :: Label -> Label -> Bool Source # (<=) :: Label -> Label -> Bool Source # (>) :: Label -> Label -> Bool Source # (>=) :: Label -> Label -> Bool Source # max :: Label -> Label -> Label Source # min :: Label -> Label -> Label Source #
Show Label Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Label -> ShowS Source # show :: Label -> String Source # showList :: [Label] -> ShowS Source #

Rule definition

data Item' a Source #

Element of a rule right hand side (rhs).

Constructors

Terminal a	Keyword or symbol (not represented in AST).
NTerminal Cat	Category (represented in AST).

Instances

Instances details

Functor Item' Source #
Instance details Defined in BNFC.CF Methods fmap :: (a -> b) -> Item' a -> Item' b Source # (<$) :: a -> Item' b -> Item' a Source #
Foldable Item' Source #
Instance details Defined in BNFC.CF Methods fold :: Monoid m => Item' m -> m Source # foldMap :: Monoid m => (a -> m) -> Item' a -> m Source # foldMap' :: Monoid m => (a -> m) -> Item' a -> m Source # foldr :: (a -> b -> b) -> b -> Item' a -> b Source # foldr' :: (a -> b -> b) -> b -> Item' a -> b Source # foldl :: (b -> a -> b) -> b -> Item' a -> b Source # foldl' :: (b -> a -> b) -> b -> Item' a -> b Source # foldr1 :: (a -> a -> a) -> Item' a -> a Source # foldl1 :: (a -> a -> a) -> Item' a -> a Source # toList :: Item' a -> [a] Source # null :: Item' a -> Bool Source # length :: Item' a -> Int Source # elem :: Eq a => a -> Item' a -> Bool Source # maximum :: Ord a => Item' a -> a Source # minimum :: Ord a => Item' a -> a Source # sum :: Num a => Item' a -> a Source # product :: Num a => Item' a -> a Source #
Traversable Item' Source #
Instance details Defined in BNFC.CF Methods traverse :: Applicative f => (a -> f b) -> Item' a -> f (Item' b) Source # sequenceA :: Applicative f => Item' (f a) -> f (Item' a) Source # mapM :: Monad m => (a -> m b) -> Item' a -> m (Item' b) Source # sequence :: Monad m => Item' (m a) -> m (Item' a) Source #
Eq a => Eq (Item' a) Source #
Instance details Defined in BNFC.CF Methods (==) :: Item' a -> Item' a -> Bool Source # (/=) :: Item' a -> Item' a -> Bool Source #
Ord a => Ord (Item' a) Source #
Instance details Defined in BNFC.CF Methods compare :: Item' a -> Item' a -> Ordering Source # (<) :: Item' a -> Item' a -> Bool Source # (<=) :: Item' a -> Item' a -> Bool Source # (>) :: Item' a -> Item' a -> Bool Source # (>=) :: Item' a -> Item' a -> Bool Source # max :: Item' a -> Item' a -> Item' a Source # min :: Item' a -> Item' a -> Item' a Source #
Show a => Show (Item' a) Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Item' a -> ShowS Source # show :: Item' a -> String Source # showList :: [Item' a] -> ShowS Source #

type AItem Source #

Arguments

= Item' String1

AST/printer flavor.

type Item Source #

Arguments

= Item' Keyword

Parser flavor.

type RHS' a = [Item' a] Source #

The bare rhs of a rule.

type ARHS = RHS' String1 Source #

type RHS = RHS' Keyword Source #

data RuleOrigin Source #

The origin of a rule.

Constructors

FromOrdinary	Ordinary LBNF rule.
FromRules	Expanded from `rules` pragma.
FromCoercions	Expanded from `coercions` pragma.
FromList	Expanded from list pragma: `separator` or `terminator`.

Instances

Instances details

Eq RuleOrigin Source #
Instance details Defined in BNFC.CF Methods (==) :: RuleOrigin -> RuleOrigin -> Bool Source # (/=) :: RuleOrigin -> RuleOrigin -> Bool Source #
Ord RuleOrigin Source #
Instance details Defined in BNFC.CF Methods compare :: RuleOrigin -> RuleOrigin -> Ordering Source # (<) :: RuleOrigin -> RuleOrigin -> Bool Source # (<=) :: RuleOrigin -> RuleOrigin -> Bool Source # (>) :: RuleOrigin -> RuleOrigin -> Bool Source # (>=) :: RuleOrigin -> RuleOrigin -> Bool Source # max :: RuleOrigin -> RuleOrigin -> RuleOrigin Source # min :: RuleOrigin -> RuleOrigin -> RuleOrigin Source #
Show RuleOrigin Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> RuleOrigin -> ShowS Source # show :: RuleOrigin -> String Source # showList :: [RuleOrigin] -> ShowS Source #

data ARuleRHS Source #

The AST-flavor representation of the rule rhs with meta information.

Constructors

ARuleRHS
Fields aruleOrigin :: RuleOrigin A rule can also originate from pragmas. aruleParseable :: Parseable `internal` or parseable? aruleRHS :: ARHS Right hand side.

Instances

Instances details

Eq ARuleRHS Source #
Instance details Defined in BNFC.CF Methods (==) :: ARuleRHS -> ARuleRHS -> Bool Source # (/=) :: ARuleRHS -> ARuleRHS -> Bool Source #
Show ARuleRHS Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> ARuleRHS -> ShowS Source # show :: ARuleRHS -> String Source # showList :: [ARuleRHS] -> ShowS Source #

data RuleLabel Source #

The parser-flavor representation of the rule label with meta information.

Constructors

RuleLabel
Fields ruleOrigin :: RuleOrigin A rule can also originate from pragmas. ruleLabel :: Label The name of the rule.

Instances

Instances details

Eq RuleLabel Source #
Instance details Defined in BNFC.CF Methods (==) :: RuleLabel -> RuleLabel -> Bool Source # (/=) :: RuleLabel -> RuleLabel -> Bool Source #
Show RuleLabel Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> RuleLabel -> ShowS Source # show :: RuleLabel -> String Source # showList :: [RuleLabel] -> ShowS Source #

List pragmas

data Separator' a Source #

Constructors

Separator a	E.g. `separator _ ","`.
Terminator a	E.g. `terminator _ ";"`. The last case is better represented as `Nothing`. -- \| NoSeparator -- -- ^ E.g. `separator _ ""` or `terminator _ ""`.

Instances

Instances details

Functor Separator' Source #
Instance details Defined in BNFC.CF Methods fmap :: (a -> b) -> Separator' a -> Separator' b Source # (<$) :: a -> Separator' b -> Separator' a Source #
Foldable Separator' Source #
Instance details Defined in BNFC.CF Methods fold :: Monoid m => Separator' m -> m Source # foldMap :: Monoid m => (a -> m) -> Separator' a -> m Source # foldMap' :: Monoid m => (a -> m) -> Separator' a -> m Source # foldr :: (a -> b -> b) -> b -> Separator' a -> b Source # foldr' :: (a -> b -> b) -> b -> Separator' a -> b Source # foldl :: (b -> a -> b) -> b -> Separator' a -> b Source # foldl' :: (b -> a -> b) -> b -> Separator' a -> b Source # foldr1 :: (a -> a -> a) -> Separator' a -> a Source # foldl1 :: (a -> a -> a) -> Separator' a -> a Source # toList :: Separator' a -> [a] Source # null :: Separator' a -> Bool Source # length :: Separator' a -> Int Source # elem :: Eq a => a -> Separator' a -> Bool Source # maximum :: Ord a => Separator' a -> a Source # minimum :: Ord a => Separator' a -> a Source # sum :: Num a => Separator' a -> a Source # product :: Num a => Separator' a -> a Source #
Traversable Separator' Source #
Instance details Defined in BNFC.CF Methods traverse :: Applicative f => (a -> f b) -> Separator' a -> f (Separator' b) Source # sequenceA :: Applicative f => Separator' (f a) -> f (Separator' a) Source # mapM :: Monad m => (a -> m b) -> Separator' a -> m (Separator' b) Source # sequence :: Monad m => Separator' (m a) -> m (Separator' a) Source #
Eq a => Eq (Separator' a) Source #
Instance details Defined in BNFC.CF Methods (==) :: Separator' a -> Separator' a -> Bool Source # (/=) :: Separator' a -> Separator' a -> Bool Source #
Ord a => Ord (Separator' a) Source #
Instance details Defined in BNFC.CF Methods compare :: Separator' a -> Separator' a -> Ordering Source # (<) :: Separator' a -> Separator' a -> Bool Source # (<=) :: Separator' a -> Separator' a -> Bool Source # (>) :: Separator' a -> Separator' a -> Bool Source # (>=) :: Separator' a -> Separator' a -> Bool Source # max :: Separator' a -> Separator' a -> Separator' a Source # min :: Separator' a -> Separator' a -> Separator' a Source #
Show a => Show (Separator' a) Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Separator' a -> ShowS Source # show :: Separator' a -> String Source # showList :: [Separator' a] -> ShowS Source #

type ASeparator = Separator' String1 Source #

type Separator = Separator' Keyword Source #

Flags etc.

data Parseable Source #

Is a rule relevant for the parser or only for the AST/printer?

Constructors

Internal	`internal` rule (only for AST & printer)
Parseable	ordinary rule (also for parser)

Instances

Instances details

Eq Parseable Source #
Instance details Defined in BNFC.CF Methods (==) :: Parseable -> Parseable -> Bool Source # (/=) :: Parseable -> Parseable -> Bool Source #
Ord Parseable Source #
Instance details Defined in BNFC.CF Methods compare :: Parseable -> Parseable -> Ordering Source # (<) :: Parseable -> Parseable -> Bool Source # (<=) :: Parseable -> Parseable -> Bool Source # (>) :: Parseable -> Parseable -> Bool Source # (>=) :: Parseable -> Parseable -> Bool Source # max :: Parseable -> Parseable -> Parseable Source # min :: Parseable -> Parseable -> Parseable Source #
Show Parseable Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Parseable -> ShowS Source # show :: Parseable -> String Source # showList :: [Parseable] -> ShowS Source #

data PositionToken Source #

Does a token category carry position information?

Constructors

PositionToken	from 'position token' pragma
NoPositionToken	from ordinary `token` pragma

Instances

Instances details

Eq PositionToken Source #
Instance details Defined in BNFC.CF Methods (==) :: PositionToken -> PositionToken -> Bool Source # (/=) :: PositionToken -> PositionToken -> Bool Source #
Ord PositionToken Source #
Instance details Defined in BNFC.CF Methods compare :: PositionToken -> PositionToken -> Ordering Source # (<) :: PositionToken -> PositionToken -> Bool Source # (<=) :: PositionToken -> PositionToken -> Bool Source # (>) :: PositionToken -> PositionToken -> Bool Source # (>=) :: PositionToken -> PositionToken -> Bool Source # max :: PositionToken -> PositionToken -> PositionToken Source # min :: PositionToken -> PositionToken -> PositionToken Source #
Show PositionToken Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> PositionToken -> ShowS Source # show :: PositionToken -> String Source # showList :: [PositionToken] -> ShowS Source #

lbnfTokenDefs :: Lens' LBNF TokenDefs Source #

lbnfSymbolsKeywords :: Lens' LBNF SymbolsKeywords Source #

lbnfSymbols :: Lens' LBNF SymbolUses Source #

lbnfSignature :: Lens' LBNF Signature Source #

lbnfParserRules :: Lens' LBNF ParserRules Source #

lbnfParserBuiltins :: Lens' LBNF UsedBuiltins Source #

lbnfLineComments :: Lens' LBNF LineComments Source #

lbnfLayoutTop :: Lens' LBNF (Maybe Position) Source #

lbnfLayoutStop :: Lens' LBNF LayoutKeywords Source #

lbnfLayoutStart :: Lens' LBNF LayoutKeywords Source #

lbnfKeywords :: Lens' LBNF KeywordUses Source #

lbnfFunctions :: Lens' LBNF Functions Source #

lbnfEntryPoints :: Lens' LBNF EntryPoints Source #

lbnfBlockComments :: Lens' LBNF BlockComments Source #

lbnfASTRulesAP :: Lens' LBNF ASTRulesAP Source #

lbnfASTRules :: Lens' LBNF ASTRules Source #

lbnfASTBuiltins :: Lens' LBNF UsedBuiltins Source #

Utilities

Builtin categories

builtinCats :: [(BuiltinCat, String1)] Source #

printBuiltinCat :: BuiltinCat -> String1 Source #

printIdentCat :: IdentCat -> String1 Source #

parseBuiltinCat :: String1 -> Maybe (Either IdentCat BuiltinCat) Source #

identBuiltinCats :: [(Either IdentCat BuiltinCat, String1)] Source #

tChar :: Type Source #

tDouble :: Type Source #

tInteger :: Type Source #

tString :: Type Source #

Types

printTypeName :: Type -> String Source #

identType :: Type -> String Source #

When given a list Type, i.e. '[C]', it removes the square brackets, and adds the prefix List, i.e. ListC. (for Happy and Latex)

isListType :: Type -> Bool Source #

isBuiltinType :: Type -> Bool Source #

isIdentType :: Type -> Bool Source #

isTokenType :: Type -> Bool Source #

Labels

labelFromIdentifier :: LabelName -> Label Source #

printLabelName :: Label -> String Source #

Print Label name.

printRuleName :: Label -> String Source #

isDef :: Label -> Bool Source #

isCoercion :: Label -> Bool Source #

isList :: Label -> Bool Source #

isALabel :: Label -> Bool Source #

isPLabel :: Label -> Bool Source #

filterLabelsAST :: [String] -> [(Label, ([Type], (Integer, ARHS)))] -> [(Label, ([Type], (Integer, ARHS)))] Source #

Filter Labels that will be printed in the AST datatypes.

filterLabelsPrinter :: [String] -> [(Label, ([Type], (Integer, ARHS)))] -> [(Label, ([Type], (Integer, ARHS)))] Source #

Filter Labels that will be printed in the Pretty printer.

RHS

printRhsCats :: [Item' a] -> [String] Source #

Print names of Cat in a rhs.

printRHS :: [Item' Keyword] -> [String] Source #

Print rhs Items, both non terminals and terminals.

getRhsCats :: [Item' a] -> [Cat] Source #

Get Cats in a rhs.

printItemName :: Item' String1 -> String Source #

isNTerminal :: Item' a -> Bool Source #

isItemListCat :: Item' a -> Bool Source #

isItemBuiltin :: Item' a -> Bool Source #

rhsCats :: RHS' a -> [Cat] Source #

Get the non-terminals of a rhs in left-to-right order.

rhsType :: RHS' a -> [Type] Source #

Get the types of a rhs.

Token definitions

isNoPositionToken :: WithPosition TokenDef -> Bool Source #

does a token definition contain a no position token.

isPositionToken :: WithPosition TokenDef -> Bool Source #

does a token definition contain (with position) a position token.

isPosToken :: TokenDef -> Bool Source #

does a token definition contain a position token.

hasIdentifier :: TokenDefs -> Bool Source #

Functions

printExp :: Bool -> String -> Exp -> String Source #

Print Exp (function body in define pragma).

printExp1 :: Exp -> String Source #

printExp2 :: String -> Exp -> String Source #

isApp1 :: Exp -> Bool Source #

isApp2 :: Exp -> Bool Source #

Keywords

getKeyword :: Separator -> Keyword Source #

All-whitespace strings (in particular, empty strings) give Nothing.

parseKeyword :: String -> Maybe Keyword Source #

parseASeparator :: Separator' String -> Maybe ASeparator Source #

trimSeparator :: ASeparator -> Maybe Separator Source #

Parser rules.

lookupRHS :: Cat -> RHS -> ParserRules -> Maybe (WithPosition RuleLabel) Source #

Layouts.

layoutsAreUsed :: LBNF -> Bool Source #

Eq a => Eq (Cat' a) Source #
Instance details Defined in BNFC.CF Methods (==) :: Cat' a -> Cat' a -> Bool Source # (/=) :: Cat' a -> Cat' a -> Bool Source #
Ord a => Ord (Cat' a) Source #
Instance details Defined in BNFC.CF Methods compare :: Cat' a -> Cat' a -> Ordering Source # (<) :: Cat' a -> Cat' a -> Bool Source # (<=) :: Cat' a -> Cat' a -> Bool Source # (>) :: Cat' a -> Cat' a -> Bool Source # (>=) :: Cat' a -> Cat' a -> Bool Source # max :: Cat' a -> Cat' a -> Cat' a Source # min :: Cat' a -> Cat' a -> Cat' a Source #
Show a => Show (Cat' a) Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> Cat' a -> ShowS Source # show :: Cat' a -> String Source # showList :: [Cat' a] -> ShowS Source #
AddCategories (WithPosition ICat) Source #	Directly add to `_stUsedCats`.
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: WithPosition ICat -> ReaderT Parseable M () Source #

Eq BaseCat Source #
Instance details Defined in BNFC.CF Methods (==) :: BaseCat -> BaseCat -> Bool Source # (/=) :: BaseCat -> BaseCat -> Bool Source #
Ord BaseCat Source #
Instance details Defined in BNFC.CF Methods compare :: BaseCat -> BaseCat -> Ordering Source # (<) :: BaseCat -> BaseCat -> Bool Source # (<=) :: BaseCat -> BaseCat -> Bool Source # (>) :: BaseCat -> BaseCat -> Bool Source # (>=) :: BaseCat -> BaseCat -> Bool Source # max :: BaseCat -> BaseCat -> BaseCat Source # min :: BaseCat -> BaseCat -> BaseCat Source #
Show BaseCat Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> BaseCat -> ShowS Source # show :: BaseCat -> String Source # showList :: [BaseCat] -> ShowS Source #

Bounded BuiltinCat Source #
Instance details Defined in BNFC.CF Methods minBound :: BuiltinCat Source # maxBound :: BuiltinCat Source #
Enum BuiltinCat Source #
Instance details Defined in BNFC.CF Methods succ :: BuiltinCat -> BuiltinCat Source # pred :: BuiltinCat -> BuiltinCat Source # toEnum :: Int -> BuiltinCat Source # fromEnum :: BuiltinCat -> Int Source # enumFrom :: BuiltinCat -> [BuiltinCat] Source # enumFromThen :: BuiltinCat -> BuiltinCat -> [BuiltinCat] Source # enumFromTo :: BuiltinCat -> BuiltinCat -> [BuiltinCat] Source # enumFromThenTo :: BuiltinCat -> BuiltinCat -> BuiltinCat -> [BuiltinCat] Source #
Eq BuiltinCat Source #
Instance details Defined in BNFC.CF Methods (==) :: BuiltinCat -> BuiltinCat -> Bool Source # (/=) :: BuiltinCat -> BuiltinCat -> Bool Source #
Ord BuiltinCat Source #
Instance details Defined in BNFC.CF Methods compare :: BuiltinCat -> BuiltinCat -> Ordering Source # (<) :: BuiltinCat -> BuiltinCat -> Bool Source # (<=) :: BuiltinCat -> BuiltinCat -> Bool Source # (>) :: BuiltinCat -> BuiltinCat -> Bool Source # (>=) :: BuiltinCat -> BuiltinCat -> Bool Source # max :: BuiltinCat -> BuiltinCat -> BuiltinCat Source # min :: BuiltinCat -> BuiltinCat -> BuiltinCat Source #
Show BuiltinCat Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> BuiltinCat -> ShowS Source # show :: BuiltinCat -> String Source # showList :: [BuiltinCat] -> ShowS Source #

Eq IdentCat Source #
Instance details Defined in BNFC.CF Methods (==) :: IdentCat -> IdentCat -> Bool Source # (/=) :: IdentCat -> IdentCat -> Bool Source #
Ord IdentCat Source #
Instance details Defined in BNFC.CF Methods compare :: IdentCat -> IdentCat -> Ordering Source # (<) :: IdentCat -> IdentCat -> Bool Source # (<=) :: IdentCat -> IdentCat -> Bool Source # (>) :: IdentCat -> IdentCat -> Bool Source # (>=) :: IdentCat -> IdentCat -> Bool Source # max :: IdentCat -> IdentCat -> IdentCat Source # min :: IdentCat -> IdentCat -> IdentCat Source #
Show IdentCat Source #
Instance details Defined in BNFC.CF Methods showsPrec :: Int -> IdentCat -> ShowS Source # show :: IdentCat -> String Source # showList :: [IdentCat] -> ShowS Source #

Cat a	Base category, e.g. `Ident`, `Exp`.
ListCat (Cat' a)	List non-terminals, e.g., `[Ident]`, `[Exp]`, `[Exp1]`.
CoerceCat CatName Integer	E.g. `Exp1`, `Exp2`.

BuiltinCat BuiltinCat	`Char`, `Double`, `Integer`, `String`.
IdentCat IdentCat	Ident
TokenCat CatName	User-defined `token` category.
BaseCat CatName	Base category defined by CFG, like `Exp`.

BChar	Char
BDouble	Double
BInteger	Integer
BString	String

Documentation

Instances

Instances

Instances

Instances

Instances

Instances

Categories

Instances

Instances

Instances

Instances

Types (categories in AST)

Instances

Instances

Expressions (for defined constructors)

Instances

Instances

Instances

Labels

Instances

Rule definition

Instances

Instances

Instances

Instances

List pragmas

Instances

Flags etc.

Instances

Instances

Utilities

Categories

Builtin categories

Types

Labels

RHS

Token definitions

Functions

Keywords

Parser rules.

Layouts.