BNFC.CF

The internal representation of LBNF grammars.

Pragmas have been desugared as far as possible.

Documentation

data LBNF

The internal representation of a LBNF grammar.

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

Rules are stored in:

1. 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).
2. 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).
3. 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

Show LBNF

Defined in BNFC.CF

Methods

showsPrec :: Int -> LBNF -> ShowS

show :: LBNF -> String

showList :: [LBNF] -> ShowS

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

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

Show TokenDef

Defined in BNFC.CF

Methods

showsPrec :: Int -> TokenDef -> ShowS

show :: TokenDef -> String

showList :: [TokenDef] -> ShowS

newtype Keyword

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

Eq Keyword

Defined in BNFC.CF

Methods

(==) :: Keyword -> Keyword -> Bool

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

Ord Keyword

Defined in BNFC.CF

Methods

compare :: Keyword -> Keyword -> Ordering

(<) :: Keyword -> Keyword -> Bool

(<=) :: Keyword -> Keyword -> Bool

(>) :: Keyword -> Keyword -> Bool

(>=) :: Keyword -> Keyword -> Bool

max :: Keyword -> Keyword -> Keyword

min :: Keyword -> Keyword -> Keyword

Show Keyword

Defined in BNFC.CF

Methods

showsPrec :: Int -> Keyword -> ShowS

show :: Keyword -> String

showList :: [Keyword] -> ShowS

newtype Symbol

Constructors

Symbol

Fields

• theSymbol :: List1 Char

Instances

Eq Symbol

Defined in BNFC.CF

Methods

(==) :: Symbol -> Symbol -> Bool

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

Ord Symbol

Defined in BNFC.CF

Methods

compare :: Symbol -> Symbol -> Ordering

(<) :: Symbol -> Symbol -> Bool

(<=) :: Symbol -> Symbol -> Bool

(>) :: Symbol -> Symbol -> Bool

(>=) :: Symbol -> Symbol -> Bool

max :: Symbol -> Symbol -> Symbol

min :: Symbol -> Symbol -> Symbol

Show Symbol

Defined in BNFC.CF

Methods

showsPrec :: Int -> Symbol -> ShowS

show :: Symbol -> String

showList :: [Symbol] -> ShowS

newtype LineComment

Constructors

LineComment String1

Instances

Show LineComment

Defined in BNFC.CF

Methods

showsPrec :: Int -> LineComment -> ShowS

show :: LineComment -> String

showList :: [LineComment] -> ShowS

data BlockComment

Constructors

BlockComment String1 String1

Instances

Show BlockComment

Defined in BNFC.CF

Methods

showsPrec :: Int -> BlockComment -> ShowS

show :: BlockComment -> String

showList :: [BlockComment] -> ShowS

Categories

type CatName = String1

type Cat = Cat' BaseCat

data Cat' a

Categories (non-terminals).

Constructors

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.

Instances

Eq a => Eq (Cat' a)

Defined in BNFC.CF

Methods

(==) :: Cat' a -> Cat' a -> Bool

(/=) :: Cat' a -> Cat' a -> Bool

Ord a => Ord (Cat' a)

Defined in BNFC.CF

Methods

compare :: Cat' a -> Cat' a -> Ordering

(<) :: Cat' a -> Cat' a -> Bool

(<=) :: Cat' a -> Cat' a -> Bool

(>) :: Cat' a -> Cat' a -> Bool

(>=) :: Cat' a -> Cat' a -> Bool

max :: Cat' a -> Cat' a -> Cat' a

min :: Cat' a -> Cat' a -> Cat' a

Show a => Show (Cat' a)

Defined in BNFC.CF

Methods

showsPrec :: Int -> Cat' a -> ShowS

show :: Cat' a -> String

showList :: [Cat' a] -> ShowS

AddCategories (WithPosition ICat)

Directly add to _stUsedCats.

Defined in BNFC.Check.Pass1

Methods

addCategories :: WithPosition ICat -> ReaderT Parseable M ()

data BaseCat

Constructors

BuiltinCat BuiltinCat

Char, Double, Integer, String.

IdentCat IdentCat

Ident

TokenCat CatName

User-defined token category.

BaseCat CatName

Base category defined by CFG, like Exp.

Instances

Eq BaseCat

Defined in BNFC.CF

Methods

(==) :: BaseCat -> BaseCat -> Bool

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

Ord BaseCat

Defined in BNFC.CF

Methods

compare :: BaseCat -> BaseCat -> Ordering

(<) :: BaseCat -> BaseCat -> Bool

(<=) :: BaseCat -> BaseCat -> Bool

(>) :: BaseCat -> BaseCat -> Bool

(>=) :: BaseCat -> BaseCat -> Bool

max :: BaseCat -> BaseCat -> BaseCat

min :: BaseCat -> BaseCat -> BaseCat

Show BaseCat

Defined in BNFC.CF

Methods

showsPrec :: Int -> BaseCat -> ShowS

show :: BaseCat -> String

showList :: [BaseCat] -> ShowS

data BuiltinCat

Built-in token categories with special token representation.

Constructors

BChar

Char

BDouble

Double

BInteger

Integer

BString

String

Instances

Bounded BuiltinCat

Defined in BNFC.CF

Methods

minBound :: BuiltinCat

maxBound :: BuiltinCat

Enum BuiltinCat

Defined in BNFC.CF

Methods

succ :: BuiltinCat -> BuiltinCat

pred :: BuiltinCat -> BuiltinCat

toEnum :: Int -> BuiltinCat

fromEnum :: BuiltinCat -> Int

enumFrom :: BuiltinCat -> [BuiltinCat]

enumFromThen :: BuiltinCat -> BuiltinCat -> [BuiltinCat]

enumFromTo :: BuiltinCat -> BuiltinCat -> [BuiltinCat]

enumFromThenTo :: BuiltinCat -> BuiltinCat -> BuiltinCat -> [BuiltinCat]

Eq BuiltinCat

Defined in BNFC.CF

Methods

(==) :: BuiltinCat -> BuiltinCat -> Bool

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

Ord BuiltinCat

Defined in BNFC.CF

Methods

compare :: BuiltinCat -> BuiltinCat -> Ordering

(<) :: BuiltinCat -> BuiltinCat -> Bool

(<=) :: BuiltinCat -> BuiltinCat -> Bool

(>) :: BuiltinCat -> BuiltinCat -> Bool

(>=) :: BuiltinCat -> BuiltinCat -> Bool

max :: BuiltinCat -> BuiltinCat -> BuiltinCat

min :: BuiltinCat -> BuiltinCat -> BuiltinCat

Show BuiltinCat

Defined in BNFC.CF

Methods

showsPrec :: Int -> BuiltinCat -> ShowS

show :: BuiltinCat -> String

showList :: [BuiltinCat] -> ShowS

data IdentCat

Built-in token Ident, treated as a string.

Constructors

BIdent

Ident

Instances

Eq IdentCat

Defined in BNFC.CF

Methods

(==) :: IdentCat -> IdentCat -> Bool

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

Ord IdentCat

Defined in BNFC.CF

Methods

compare :: IdentCat -> IdentCat -> Ordering

(<) :: IdentCat -> IdentCat -> Bool

(<=) :: IdentCat -> IdentCat -> Bool

(>) :: IdentCat -> IdentCat -> Bool

(>=) :: IdentCat -> IdentCat -> Bool

max :: IdentCat -> IdentCat -> IdentCat

min :: IdentCat -> IdentCat -> IdentCat

Show IdentCat

Defined in BNFC.CF

Methods

showsPrec :: Int -> IdentCat -> ShowS

show :: IdentCat -> String

showList :: [IdentCat] -> ShowS

Types (categories in AST)

data Type

Types are categories without the precedences (CoerceCat).

Constructors

BaseType BaseCat

Base category.

ListType Type

List category.

Instances

Eq Type

Defined in BNFC.CF

Methods

(==) :: Type -> Type -> Bool

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

Ord Type

Defined in BNFC.CF

Methods

compare :: Type -> Type -> Ordering

(<) :: Type -> Type -> Bool

(<=) :: Type -> Type -> Bool

(>) :: Type -> Type -> Bool

(>=) :: Type -> Type -> Bool

max :: Type -> Type -> Type

min :: Type -> Type -> Type

Show Type

Defined in BNFC.CF

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

data FunType

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

Eq FunType

Defined in BNFC.CF

Methods

(==) :: FunType -> FunType -> Bool

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

Show FunType

Defined in BNFC.CF

Methods

showsPrec :: Int -> FunType -> ShowS

show :: FunType -> String

showList :: [FunType] -> ShowS

Expressions (for defined constructors)

data Exp

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

Show Exp

Defined in BNFC.CF

Methods

showsPrec :: Int -> Exp -> ShowS

show :: Exp -> String

showList :: [Exp] -> ShowS

data Parameter

Bound variable.

Constructors

Parameter

Fields

• paramName :: VarName
• paramType :: Type

Instances

Show Parameter

Defined in BNFC.CF

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

type VarName = String1

data Function

Definition body of a constructor.

Constructors

Function

Fields

• funPars :: [Parameter]
• funBody :: Exp
• funType :: Type

Instances

Show Function

Defined in BNFC.CF

Methods

showsPrec :: Int -> Function -> ShowS

show :: Function -> String

showList :: [Function] -> ShowS

Labels

type LabelName = String1

Label names are nonempty strings.

data Label

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

Eq Label

Defined in BNFC.CF

Methods

(==) :: Label -> Label -> Bool

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

Ord Label

Defined in BNFC.CF

Methods

compare :: Label -> Label -> Ordering

(<) :: Label -> Label -> Bool

(<=) :: Label -> Label -> Bool

(>) :: Label -> Label -> Bool

(>=) :: Label -> Label -> Bool

max :: Label -> Label -> Label

min :: Label -> Label -> Label

Show Label

Defined in BNFC.CF

Methods

showsPrec :: Int -> Label -> ShowS

show :: Label -> String

showList :: [Label] -> ShowS

Rule definition

data Item' a

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

Functor Item'

Defined in BNFC.CF

Methods

fmap :: (a -> b) -> Item' a -> Item' b

(<$) :: a -> Item' b -> Item' a

Foldable Item'

Defined in BNFC.CF

Methods

fold :: Monoid m => Item' m -> m

foldMap :: Monoid m => (a -> m) -> Item' a -> m

foldMap' :: Monoid m => (a -> m) -> Item' a -> m

foldr :: (a -> b -> b) -> b -> Item' a -> b

foldr' :: (a -> b -> b) -> b -> Item' a -> b

foldl :: (b -> a -> b) -> b -> Item' a -> b

foldl' :: (b -> a -> b) -> b -> Item' a -> b

foldr1 :: (a -> a -> a) -> Item' a -> a

foldl1 :: (a -> a -> a) -> Item' a -> a

toList :: Item' a -> [a]

null :: Item' a -> Bool

length :: Item' a -> Int

elem :: Eq a => a -> Item' a -> Bool

maximum :: Ord a => Item' a -> a

minimum :: Ord a => Item' a -> a

sum :: Num a => Item' a -> a

product :: Num a => Item' a -> a

Traversable Item'

Defined in BNFC.CF

Methods

traverse :: Applicative f => (a -> f b) -> Item' a -> f (Item' b)

sequenceA :: Applicative f => Item' (f a) -> f (Item' a)

mapM :: Monad m => (a -> m b) -> Item' a -> m (Item' b)

sequence :: Monad m => Item' (m a) -> m (Item' a)

Eq a => Eq (Item' a)

Defined in BNFC.CF

Methods

(==) :: Item' a -> Item' a -> Bool

(/=) :: Item' a -> Item' a -> Bool

Ord a => Ord (Item' a)

Defined in BNFC.CF

Methods

compare :: Item' a -> Item' a -> Ordering

(<) :: Item' a -> Item' a -> Bool

(<=) :: Item' a -> Item' a -> Bool

(>) :: Item' a -> Item' a -> Bool

(>=) :: Item' a -> Item' a -> Bool

max :: Item' a -> Item' a -> Item' a

min :: Item' a -> Item' a -> Item' a

Show a => Show (Item' a)

Defined in BNFC.CF

Methods

showsPrec :: Int -> Item' a -> ShowS

show :: Item' a -> String

showList :: [Item' a] -> ShowS

type AItem

Arguments

 = Item' String1

AST/printer flavor.

type Item

Arguments

 = Item' Keyword

Parser flavor.

type RHS' a = [Item' a]

The bare rhs of a rule.

type ARHS = RHS' String1

type RHS = RHS' Keyword

data RuleOrigin

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

Eq RuleOrigin

Defined in BNFC.CF

Methods

(==) :: RuleOrigin -> RuleOrigin -> Bool

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

Ord RuleOrigin

Defined in BNFC.CF

Methods

compare :: RuleOrigin -> RuleOrigin -> Ordering

(<) :: RuleOrigin -> RuleOrigin -> Bool

(<=) :: RuleOrigin -> RuleOrigin -> Bool

(>) :: RuleOrigin -> RuleOrigin -> Bool

(>=) :: RuleOrigin -> RuleOrigin -> Bool

max :: RuleOrigin -> RuleOrigin -> RuleOrigin

min :: RuleOrigin -> RuleOrigin -> RuleOrigin

Show RuleOrigin

Defined in BNFC.CF

Methods

showsPrec :: Int -> RuleOrigin -> ShowS

show :: RuleOrigin -> String

showList :: [RuleOrigin] -> ShowS

data ARuleRHS

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

Eq ARuleRHS

Defined in BNFC.CF

Methods

(==) :: ARuleRHS -> ARuleRHS -> Bool

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

Show ARuleRHS

Defined in BNFC.CF

Methods

showsPrec :: Int -> ARuleRHS -> ShowS

show :: ARuleRHS -> String

showList :: [ARuleRHS] -> ShowS

data RuleLabel

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

Eq RuleLabel

Defined in BNFC.CF

Methods

(==) :: RuleLabel -> RuleLabel -> Bool

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

Show RuleLabel

Defined in BNFC.CF

Methods

showsPrec :: Int -> RuleLabel -> ShowS

show :: RuleLabel -> String

showList :: [RuleLabel] -> ShowS

List pragmas

data Separator' a

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

Functor Separator'

Defined in BNFC.CF

Methods

fmap :: (a -> b) -> Separator' a -> Separator' b

(<$) :: a -> Separator' b -> Separator' a

Foldable Separator'

Defined in BNFC.CF

Methods

fold :: Monoid m => Separator' m -> m

foldMap :: Monoid m => (a -> m) -> Separator' a -> m

foldMap' :: Monoid m => (a -> m) -> Separator' a -> m

foldr :: (a -> b -> b) -> b -> Separator' a -> b

foldr' :: (a -> b -> b) -> b -> Separator' a -> b

foldl :: (b -> a -> b) -> b -> Separator' a -> b

foldl' :: (b -> a -> b) -> b -> Separator' a -> b

foldr1 :: (a -> a -> a) -> Separator' a -> a

foldl1 :: (a -> a -> a) -> Separator' a -> a

toList :: Separator' a -> [a]

null :: Separator' a -> Bool

length :: Separator' a -> Int

elem :: Eq a => a -> Separator' a -> Bool

maximum :: Ord a => Separator' a -> a

minimum :: Ord a => Separator' a -> a

sum :: Num a => Separator' a -> a

product :: Num a => Separator' a -> a

Traversable Separator'

Defined in BNFC.CF

Methods

traverse :: Applicative f => (a -> f b) -> Separator' a -> f (Separator' b)

sequenceA :: Applicative f => Separator' (f a) -> f (Separator' a)

mapM :: Monad m => (a -> m b) -> Separator' a -> m (Separator' b)

sequence :: Monad m => Separator' (m a) -> m (Separator' a)

Eq a => Eq (Separator' a)

Defined in BNFC.CF

Methods

(==) :: Separator' a -> Separator' a -> Bool

(/=) :: Separator' a -> Separator' a -> Bool

Ord a => Ord (Separator' a)

Defined in BNFC.CF

Methods

compare :: Separator' a -> Separator' a -> Ordering

(<) :: Separator' a -> Separator' a -> Bool

(<=) :: Separator' a -> Separator' a -> Bool

(>) :: Separator' a -> Separator' a -> Bool

(>=) :: Separator' a -> Separator' a -> Bool

max :: Separator' a -> Separator' a -> Separator' a

min :: Separator' a -> Separator' a -> Separator' a

Show a => Show (Separator' a)

Defined in BNFC.CF

Methods

showsPrec :: Int -> Separator' a -> ShowS

show :: Separator' a -> String

showList :: [Separator' a] -> ShowS

type ASeparator = Separator' String1

type Separator = Separator' Keyword

Flags etc.

data Parseable

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

Eq Parseable

Defined in BNFC.CF

Methods

(==) :: Parseable -> Parseable -> Bool

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

Ord Parseable

Defined in BNFC.CF

Methods

compare :: Parseable -> Parseable -> Ordering

(<) :: Parseable -> Parseable -> Bool

(<=) :: Parseable -> Parseable -> Bool

(>) :: Parseable -> Parseable -> Bool

(>=) :: Parseable -> Parseable -> Bool

max :: Parseable -> Parseable -> Parseable

min :: Parseable -> Parseable -> Parseable

Show Parseable

Defined in BNFC.CF

Methods

showsPrec :: Int -> Parseable -> ShowS

show :: Parseable -> String

showList :: [Parseable] -> ShowS

data PositionToken

Does a token category carry position information?

Constructors

PositionToken

from 'position token' pragma

NoPositionToken

from ordinary token pragma

Instances

Eq PositionToken

Defined in BNFC.CF

Methods

(==) :: PositionToken -> PositionToken -> Bool

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

Ord PositionToken

Defined in BNFC.CF

Methods

compare :: PositionToken -> PositionToken -> Ordering

(<) :: PositionToken -> PositionToken -> Bool

(<=) :: PositionToken -> PositionToken -> Bool

(>) :: PositionToken -> PositionToken -> Bool

(>=) :: PositionToken -> PositionToken -> Bool

max :: PositionToken -> PositionToken -> PositionToken

min :: PositionToken -> PositionToken -> PositionToken

Show PositionToken

Defined in BNFC.CF

Methods

showsPrec :: Int -> PositionToken -> ShowS

show :: PositionToken -> String

showList :: [PositionToken] -> ShowS

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

Utilities

Categories

catToType :: Cat -> Type

Convert Cat to Type, converting CoerceCat to BaseCat.

catToIdentifier :: Cat -> String1

baseCatToIdentifier :: BaseCat -> String1

printCatName :: Cat -> String

Print CatName from Cat in AST generator.

printCatNamePrec :: Cat -> String

printCatNamePrec' :: Cat -> String

catToString :: Cat -> String

printBaseCatName :: BaseCat -> String

isCatCoerced :: Cat -> Bool

is Cat coerced?

isCatList :: Cat -> Bool

is Cat list category?

isCatBuiltin :: Cat -> Bool

is Cat between used builtins.

getCatPrec :: Cat -> Integer

get Cat coercion number, returns 0 if Cat is not coerced.

identCat :: Cat -> String

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

isBuiltin :: BaseCat -> Bool

isIdentifier :: BaseCat -> Bool

isToken :: BaseCat -> Bool

Builtin categories

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

Types

printTypeName :: Type -> String

identType :: Type -> String

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

isBuiltinType :: Type -> Bool

isIdentType :: Type -> Bool

isTokenType :: Type -> Bool

Labels

labelFromIdentifier :: LabelName -> Label

printLabelName :: Label -> String

Print Label name.

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)))]

Filter Labels that will be printed in the AST datatypes.

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

Filter Labels that will be printed in the Pretty printer.

RHS

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

Print names of Cat in a rhs.

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

Print rhs Items, both non terminals and terminals.

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

Get Cats in a rhs.

printItemName :: Item' String1 -> String

isNTerminal :: Item' a -> Bool

isItemListCat :: Item' a -> Bool

isItemBuiltin :: Item' a -> Bool

rhsCats :: RHS' a -> [Cat]

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

rhsType :: RHS' a -> [Type]

Get the types of a rhs.

Token definitions

isNoPositionToken :: WithPosition TokenDef -> Bool

does a token definition contain a no position token.

isPositionToken :: WithPosition TokenDef -> Bool

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

isPosToken :: TokenDef -> Bool

does a token definition contain a position token.

hasIdentifier :: TokenDefs -> Bool

Functions

printExp :: Bool -> String -> Exp -> String

Print Exp (function body in define pragma).

printExp1 :: Exp -> String

printExp2 :: String -> Exp -> String

isApp1 :: Exp -> Bool

isApp2 :: Exp -> Bool

Keywords

getKeyword :: Separator -> Keyword

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

parseKeyword :: String -> Maybe Keyword

parseASeparator :: Separator' String -> Maybe ASeparator

trimSeparator :: ASeparator -> Maybe Separator

Parser rules.

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

Layouts.

layoutsAreUsed :: LBNF -> Bool