Safe Haskell	None
Language	Haskell2010

BNFC.Check.Pass1

Contents

Pass 1 checker
Collecting categories
Collecting keywords
Utilities
Trash

Description

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.

Synopsis

data Pass1 = Pass1 {
- _stDefinedCats :: DefinedICats
- _stUsedCats :: Map ICat (List1 (WithPosition Parseable))
- _stKeywords :: Map Keyword (List1 Position)
}
type DefinedICats = Map ICat PCatKind
data CatKind
- = KRules (List1 RuleKind)
- | KList
- | KToken PositionToken
type PCatKind = WithPosition CatKind
data RuleKind
- = ROrdinary Parseable
- | RRules
- | RCoercion
stUsedCats :: Lens' Pass1 (Map ICat (List1 (WithPosition Parseable)))
stKeywords :: Lens' Pass1 (Map Keyword (List1 Position))
stDefinedCats :: Lens' Pass1 DefinedICats
checkLBNF :: Grammar -> Check (Grammar, Pass1)
type M = StateT Pass1 Check
checkGrammar :: Grammar -> M Grammar
checkDef :: Def -> M (Maybe Def)
useCats :: AddCategories a => a -> M ()
useCatsInternal :: AddCategories a => a -> M ()
class AddCategories a where
- addCategories :: a -> ReaderT Parseable M ()
class AddKeywords a where
- addKeywords :: a -> M ()
ruleKind :: RuleKind -> CatKind
mergeKind :: CatKind -> CatKind -> Either () CatKind
parseCat :: Cat -> ICat
parseCoerceCat :: String -> ICat
identifierToCat :: Identifier -> Cat
parseICat :: ICat -> ReaderT DefinedICats Check Cat
data WithDefinition a = WithDefinition {
- wdDef :: Def
- wdThing :: a
}
type PCatOrigin = WithPosition CatOrigin
data CatOrigin
- = ORule
- | ORules
- | OList
- | OToken
type PDCatKind = WithPosition (WithDefinition CatKind)
data CatInfo = CatInfo {
- _catParsable :: Parseable
- _catOrigins :: [PCatOrigin]
}
catParsable :: Lens' CatInfo Parseable
catOrigins :: Lens' CatInfo [PCatOrigin]

Documentation

data Pass1 Source #

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

Instances details

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

type DefinedICats = Map ICat PCatKind Source #

data CatKind Source #

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

Instances details

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

type PCatKind = WithPosition CatKind Source #

data RuleKind Source #

The kind of a rule definition.

Constructors

ROrdinary Parseable	ordinary or `internal` rule
RRules	`rules` pragma
RCoercion	`coercion` pragma

Instances

Instances details

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

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

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

stDefinedCats :: Lens' Pass1 DefinedICats Source #

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

Entry point for pass 1.

Pass 1 checker

type M = StateT Pass1 Check Source #

The monad for pass 1, manipulates Pass1.

checkGrammar :: Grammar -> M Grammar Source #

Check a whole grammar, swallowing errorneous definitions.

checkDef :: Def -> M (Maybe Def) Source #

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

Collecting categories

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

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

class AddCategories a where Source #

Collect categories used in something.

Methods

addCategories :: a -> ReaderT Parseable M () Source #

Instances

Instances details

AddCategories RHS Source #
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: RHS -> ReaderT Parseable M () Source #
AddCategories Cat Source #	Also adds for each list category its element category, transitively.
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: Cat -> ReaderT Parseable M () Source #
AddCategories Item Source #
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: Item -> ReaderT Parseable M () Source #
AddCategories a => AddCategories [a] Source #
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: [a] -> ReaderT Parseable M () Source #
AddCategories (WithPosition ICat) Source #	Directly add to `_stUsedCats`.
Instance details Defined in BNFC.Check.Pass1 Methods addCategories :: WithPosition ICat -> ReaderT Parseable M () Source #

Collecting keywords

class AddKeywords a where Source #

Methods

addKeywords :: a -> M () Source #

Instances

Instances details

AddKeywords RHS Source #
Instance details Defined in BNFC.Check.Pass1 Methods addKeywords :: RHS -> M () Source #
AddKeywords Item Source #
Instance details Defined in BNFC.Check.Pass1 Methods addKeywords :: Item -> M () Source #
AddKeywords a => AddKeywords [a] Source #
Instance details Defined in BNFC.Check.Pass1 Methods addKeywords :: [a] -> M () Source #
ToPosition p => AddKeywords (p, String) Source #
Instance details Defined in BNFC.Check.Pass1 Methods addKeywords :: (p, String) -> M () Source #

Utilities

ruleKind :: RuleKind -> CatKind Source #

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

parseCat :: Cat -> ICat Source #

parseCoerceCat :: String -> ICat Source #

identifierToCat :: Identifier -> Cat Source #

parseICat :: ICat -> ReaderT DefinedICats Check Cat Source #

Resolve category.

Trash

data WithDefinition a Source #

Constructors

WithDefinition
Fields wdDef :: Def wdThing :: a

Instances

Instances details

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

type PCatOrigin = WithPosition CatOrigin Source #

data CatOrigin Source #

Constructors

ORule	ordinary or `internal` rule
ORules	`rules` pragma
OList	`separator` or `terminator` pragma
OToken	`token` definition (exclusive)

Instances

Instances details

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

type PDCatKind = WithPosition (WithDefinition CatKind) Source #

data CatInfo Source #

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

Instances details

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

catParsable :: Lens' CatInfo Parseable Source #

catOrigins :: Lens' CatInfo [PCatOrigin] Source #