Safe Haskell	None
Language	Haskell2010

BNFC.Options

Synopsis

data Mode
- = UsageError String
- | Help
- | License
- | Version
- | Target SharedOptions FilePath
data Target
- = TargetC
- | TargetCpp
- | TargetCppNoStl
- | TargetHaskell
- | TargetHaskellGadt
- | TargetLatex
- | TargetJava
- | TargetOCaml
- | TargetPygments
- | TargetCheck
type Backend = SharedOptions -> CF -> IO ()
parseMode :: [String] -> (Mode, UsageWarnings)
usage :: String
help :: String
versionString :: String
data SharedOptions = Options {
- lbnfFile :: FilePath
- lang :: String
- outDir :: FilePath
- force :: Bool
- target :: Target
- make :: Maybe String
- inPackage :: InPackage
- linenumbers :: RecordPositions
- ansi :: Ansi
- inDir :: Bool
- functor :: Bool
- generic :: Bool
- alexMode :: AlexVersion
- tokenText :: TokenText
- glr :: HappyMode
- xml :: Int
- agda :: Bool
- ocamlParser :: OCamlParser
- javaLexerParser :: JavaLexerParser
- visualStudio :: Bool
- wcf :: Bool
}
defaultOptions :: SharedOptions
isDefault :: Eq a => (SharedOptions -> a) -> SharedOptions -> Bool
printOptions :: SharedOptions -> String
data AlexVersion = Alex3
data HappyMode
- = Standard
- | GLR
data OCamlParser
- = OCamlYacc
- | Menhir
data JavaLexerParser
- = JLexCup
- | JFlexCup
- | Antlr4
data RecordPositions
- = RecordPositions
- | NoRecordPositions
data TokenText
- = StringToken
- | ByteStringToken
- | TextToken
data Ansi
- = Ansi
- | BeyondAnsi
type InPackage = Maybe String
removedIn290 :: String
translateOldOptions :: [String] -> ParseOpt [String]

Documentation

data Mode Source #

To decouple the option parsing from the execution of the program, we introduce a data structure that holds the result of the parsing of the arguments.

Constructors

UsageError String
Help
License
Version
Target SharedOptions FilePath

Instances

Instances details

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

data Target Source #

Target languages

Constructors

TargetC
TargetCpp
TargetCppNoStl
TargetHaskell
TargetHaskellGadt
TargetLatex
TargetJava
TargetOCaml
TargetPygments
TargetCheck

Instances

Instances details

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

type Backend Source #

Arguments

= SharedOptions	Options
-> CF	Grammar
-> IO ()

parseMode :: [String] -> (Mode, UsageWarnings) Source #

Main parsing function

usage :: String Source #

help :: String Source #

versionString :: String Source #

data SharedOptions Source #

This is the option record that is passed to the different backends.

Constructors

Options

Fields

lbnfFile :: FilePath
The input file BNFC processes.
lang :: String
The language we generate: the basename of lbnfFile.
outDir :: FilePath
Target directory for generated files.
force :: Bool
Ignore errors as much as possible?
target :: Target
E.g. --haskell.
make :: Maybe String
The name of the Makefile to generate or Nothing for no Makefile.
inPackage :: InPackage
The hierarchical package to put the modules in, or Nothing.
linenumbers :: RecordPositions
Add and set line_number field for syntax classes
ansi :: Ansi
Restrict to the ANSI language standard (C/C++)?
inDir :: Bool
Option -d.
functor :: Bool
Option --functor. Make AST functorial?
generic :: Bool
Option --generic. Derive Data, Generic, Typeable?
alexMode :: AlexVersion
Options --alex.
tokenText :: TokenText
Options --bytestrings, --string-token, and --text-token.
glr :: HappyMode
Happy option --glr.
xml :: Int
Options --xml, generate DTD and XML printers.
agda :: Bool
Option --agda. Create bindings for Agda?
ocamlParser :: OCamlParser
Option --menhir to switch to Menhir.
javaLexerParser :: JavaLexerParser
visualStudio :: Bool
Generate Visual Studio solution/project files.
wcf :: Bool
Windows Communication Foundation.

Instances

Instances details

Eq SharedOptions Source #
Instance details Defined in BNFC.Options Methods (==) :: SharedOptions -> SharedOptions -> Bool Source # (/=) :: SharedOptions -> SharedOptions -> Bool Source #
Ord SharedOptions Source #
Instance details Defined in BNFC.Options Methods compare :: SharedOptions -> SharedOptions -> Ordering Source # (<) :: SharedOptions -> SharedOptions -> Bool Source # (<=) :: SharedOptions -> SharedOptions -> Bool Source # (>) :: SharedOptions -> SharedOptions -> Bool Source # (>=) :: SharedOptions -> SharedOptions -> Bool Source # max :: SharedOptions -> SharedOptions -> SharedOptions Source # min :: SharedOptions -> SharedOptions -> SharedOptions Source #
Show SharedOptions Source #
Instance details Defined in BNFC.Options Methods showsPrec :: Int -> SharedOptions -> ShowS Source # show :: SharedOptions -> String Source # showList :: [SharedOptions] -> ShowS Source #
OCamlParserName SharedOptions Source #
Instance details Defined in BNFC.Backend.OCaml.OCamlUtil Methods ocamlParserName :: SharedOptions -> String Source #

defaultOptions :: SharedOptions Source #

isDefault Source #

Arguments

:: Eq a
=> (SharedOptions -> a)	Option field name.
-> SharedOptions	Options.
-> Bool

Check whether an option is unchanged from the default.

printOptions :: SharedOptions -> String Source #

Print options as input to BNFC.

unwords [ "bnfc", printOptions opts ] should call bnfc with the same options as the current instance.

data AlexVersion Source #

Which version of Alex is targeted?

Constructors

Alex3

Instances

Instances details

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

data HappyMode Source #

Happy modes

Constructors

Standard
GLR

Instances

Instances details

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

data OCamlParser Source #

Which parser generator for ocaml?

Constructors

OCamlYacc
Menhir

Instances

Instances details

Eq OCamlParser Source #
Instance details Defined in BNFC.Options Methods (==) :: OCamlParser -> OCamlParser -> Bool Source # (/=) :: OCamlParser -> OCamlParser -> Bool Source #
Ord OCamlParser Source #
Instance details Defined in BNFC.Options Methods compare :: OCamlParser -> OCamlParser -> Ordering Source # (<) :: OCamlParser -> OCamlParser -> Bool Source # (<=) :: OCamlParser -> OCamlParser -> Bool Source # (>) :: OCamlParser -> OCamlParser -> Bool Source # (>=) :: OCamlParser -> OCamlParser -> Bool Source # max :: OCamlParser -> OCamlParser -> OCamlParser Source # min :: OCamlParser -> OCamlParser -> OCamlParser Source #
Show OCamlParser Source #
Instance details Defined in BNFC.Options Methods showsPrec :: Int -> OCamlParser -> ShowS Source # show :: OCamlParser -> String Source # showList :: [OCamlParser] -> ShowS Source #
OCamlParserName OCamlParser Source #
Instance details Defined in BNFC.Backend.OCaml.OCamlUtil Methods ocamlParserName :: OCamlParser -> String Source #

data JavaLexerParser Source #

Which Java backend?

Constructors

JLexCup
JFlexCup
Antlr4

Instances

Instances details

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

data RecordPositions Source #

Line numbers or not?

Constructors

RecordPositions
NoRecordPositions

Instances

Instances details

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

data TokenText Source #

How to represent token content in the Haskell backend?

Constructors

StringToken	Represent strings as `String`.
ByteStringToken	Represent strings as `ByteString`.
TextToken	Represent strings as `Data.Text`.

Instances

Instances details

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

data Ansi Source #

Restrict to ANSI standard (C/C++)?

Constructors

Ansi
BeyondAnsi

Instances

Instances details

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

type InPackage = Maybe String Source #

Package name (C++ and Java backends).

removedIn290 :: String Source #

translateOldOptions :: [String] -> ParseOpt [String] Source #

A translation function to maintain backward compatibility with the old option syntax.