BNFC.Check.Pass1

First pass of processing a LBNF file.

• Find all the categories defined in a LBNF grammar.
• Complain about duplicate categories, e.g. defined both by rules and list or token pragmas.
• Drops errorneous definitions, returning a list of errors. It is possible to continue into pass 2 with the remaining definitions, should the user desire so (switch --force).
• Produces a map whose keys are the grammar categories parsed into ICat intermediate format and whose values are their first defining occurrences plus kind information.

This pass does not transform the list of parsed definitions into an intermediate format, e.g. for saving the translations of category names to ICat. This could be done, but the translation is cheap and deterministic, so it can be repeated in pass 2.

Documentation

data Pass1

The state and result of pass1.

Constructors

Pass1

Fields

• _stDefinedCats :: DefinedICats

  The categories defined by the grammar.

• _stUsedCats :: Map ICat (List1 (WithPosition Parseable))

  The categories referenced (used) in the grammar. Occurrences in internal rules will be labeled Internal.

• _stKeywords :: Map Keyword (List1 Position)

  The keywords used in the grammar.

Instances

Show Pass1

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> Pass1 -> ShowS

show :: Pass1 -> String

showList :: [Pass1] -> ShowS

type DefinedICats = Map ICat PCatKind

data CatKind

The kind of a category definition.

Constructors

KRules (List1 RuleKind)

given by rules and/or rules pragma

KList

given by separator or terminator pragma

KToken PositionToken

given by token pragma

Instances

Show CatKind

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> CatKind -> ShowS

show :: CatKind -> String

showList :: [CatKind] -> ShowS

type PCatKind = WithPosition CatKind

data RuleKind

The kind of a rule definition.

Constructors

ROrdinary Parseable

ordinary or internal rule

RRules

rules pragma

RCoercion

coercion pragma

Instances

Show RuleKind

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> RuleKind -> ShowS

show :: RuleKind -> String

showList :: [RuleKind] -> ShowS

stUsedCats :: Lens' Pass1 (Map ICat (List1 (WithPosition Parseable)))

stKeywords :: Lens' Pass1 (Map Keyword (List1 Position))

stDefinedCats :: Lens' Pass1 DefinedICats

checkLBNF :: Grammar -> Check (Grammar, Pass1)

Entry point for pass 1.

Pass 1 checker

type M = StateT Pass1 Check

The monad for pass 1, manipulates Pass1.

checkGrammar :: Grammar -> M Grammar

Check a whole grammar, swallowing errorneous definitions.

checkDef :: Def -> M (Maybe Def)

Check a definition. Swallow it if it produces a recoverable error.

Collecting categories

useCats :: AddCategories a => a -> M ()

useCatsInternal :: AddCategories a => a -> M ()

class AddCategories a where

Collect categories used in something.

Methods

addCategories :: a -> ReaderT Parseable M ()

Instances

AddCategories RHS

Defined in BNFC.Check.Pass1

Methods

addCategories :: RHS -> ReaderT Parseable M ()

AddCategories Cat

Also adds for each list category its element category, transitively.

Defined in BNFC.Check.Pass1

Methods

addCategories :: Cat -> ReaderT Parseable M ()

AddCategories Item

Defined in BNFC.Check.Pass1

Methods

addCategories :: Item -> ReaderT Parseable M ()

AddCategories a => AddCategories [a]

Defined in BNFC.Check.Pass1

Methods

addCategories :: [a] -> ReaderT Parseable M ()

AddCategories (WithPosition ICat)

Directly add to _stUsedCats.

Defined in BNFC.Check.Pass1

Methods

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

Collecting keywords

class AddKeywords a where

Methods

addKeywords :: a -> M ()

Instances

AddKeywords RHS

Defined in BNFC.Check.Pass1

Methods

addKeywords :: RHS -> M ()

AddKeywords Item

Defined in BNFC.Check.Pass1

Methods

addKeywords :: Item -> M ()

AddKeywords a => AddKeywords [a]

Defined in BNFC.Check.Pass1

Methods

addKeywords :: [a] -> M ()

ToPosition p => AddKeywords (p, String)

Defined in BNFC.Check.Pass1

Methods

addKeywords :: (p, String) -> M ()

Utilities

ruleKind :: RuleKind -> CatKind

mergeKind :: CatKind -> CatKind -> Either () CatKind

parseCat :: Cat -> ICat

parseCoerceCat :: String -> ICat

identifierToCat :: Identifier -> Cat

parseICat :: ICat -> ReaderT DefinedICats Check Cat

Resolve category.

Trash

data WithDefinition a

Constructors

WithDefinition

Fields

• wdDef :: Def
• wdThing :: a

Instances

Functor WithDefinition

Defined in BNFC.Check.Pass1

Methods

fmap :: (a -> b) -> WithDefinition a -> WithDefinition b

(<$) :: a -> WithDefinition b -> WithDefinition a

Foldable WithDefinition

Defined in BNFC.Check.Pass1

Methods

fold :: Monoid m => WithDefinition m -> m

foldMap :: Monoid m => (a -> m) -> WithDefinition a -> m

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

foldr :: (a -> b -> b) -> b -> WithDefinition a -> b

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

foldl :: (b -> a -> b) -> b -> WithDefinition a -> b

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

foldr1 :: (a -> a -> a) -> WithDefinition a -> a

foldl1 :: (a -> a -> a) -> WithDefinition a -> a

toList :: WithDefinition a -> [a]

null :: WithDefinition a -> Bool

length :: WithDefinition a -> Int

elem :: Eq a => a -> WithDefinition a -> Bool

maximum :: Ord a => WithDefinition a -> a

minimum :: Ord a => WithDefinition a -> a

sum :: Num a => WithDefinition a -> a

product :: Num a => WithDefinition a -> a

Traversable WithDefinition

Defined in BNFC.Check.Pass1

Methods

traverse :: Applicative f => (a -> f b) -> WithDefinition a -> f (WithDefinition b)

sequenceA :: Applicative f => WithDefinition (f a) -> f (WithDefinition a)

mapM :: Monad m => (a -> m b) -> WithDefinition a -> m (WithDefinition b)

sequence :: Monad m => WithDefinition (m a) -> m (WithDefinition a)

Show a => Show (WithDefinition a)

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> WithDefinition a -> ShowS

show :: WithDefinition a -> String

showList :: [WithDefinition a] -> ShowS

type PCatOrigin = WithPosition CatOrigin

data CatOrigin

Constructors

ORule

ordinary or internal rule

ORules

rules pragma

OList

separator or terminator pragma

OToken

token definition (exclusive)

Instances

Eq CatOrigin

Defined in BNFC.Check.Pass1

Methods

(==) :: CatOrigin -> CatOrigin -> Bool

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

Ord CatOrigin

Defined in BNFC.Check.Pass1

Methods

compare :: CatOrigin -> CatOrigin -> Ordering

(<) :: CatOrigin -> CatOrigin -> Bool

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

(>) :: CatOrigin -> CatOrigin -> Bool

(>=) :: CatOrigin -> CatOrigin -> Bool

max :: CatOrigin -> CatOrigin -> CatOrigin

min :: CatOrigin -> CatOrigin -> CatOrigin

Show CatOrigin

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> CatOrigin -> ShowS

show :: CatOrigin -> String

showList :: [CatOrigin] -> ShowS

type PDCatKind = WithPosition (WithDefinition CatKind)

data CatInfo

Constructors

CatInfo

Fields

• _catParsable :: Parseable

  Does this category have at least one parseable rule?

• _catOrigins :: [PCatOrigin]

  Where is this category defined? For ordinary categories, list of definitions that populate the category.

Instances

Show CatInfo

Defined in BNFC.Check.Pass1

Methods

showsPrec :: Int -> CatInfo -> ShowS

show :: CatInfo -> String

showList :: [CatInfo] -> ShowS

catParsable :: Lens' CatInfo Parseable

catOrigins :: Lens' CatInfo [PCatOrigin]