Copyright	(c) 2005 Martin Engelke 2007 Sebastian Fischer 2011 - 2016 Björn Peemöller
License	BSD-3-clause
Maintainer	bjp@informatik.uni-kiel.de
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

CompilerOpts

Description

This module defines data structures holding options for the compilation of Curry programs, and utility functions for printing help information as well as parsing the command line arguments.

Synopsis

Documentation

data Options Source #

Compiler options

Constructors

Options

Fields

optMode :: CymakeMode
modus operandi
optVerbosity :: Verbosity
verbosity level compilation
optForce :: Bool
force (re-)compilation of target
optLibraryPaths :: [FilePath]
directories to search in for libraries
optImportPaths :: [FilePath]
directories to search in for imports
optHtmlDir :: Maybe FilePath
output directory for HTML
optUseSubdir :: Bool
use subdir for output?
optInterface :: Bool
create a FlatCurry interface file?
optPrepOpts :: PrepOpts
preprocessor options
optWarnOpts :: WarnOpts
warning options
optTargetTypes :: [TargetType]
what to generate
optExtensions :: [KnownExtension]
enabled language extensions
optDebugOpts :: DebugOpts
debug options

Instances

Show Options Source #
Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #

data PrepOpts Source #

Preprocessor options

Constructors

PrepOpts
Fields ppPreprocess :: Bool apply custom preprocessor ppCmd :: String preprocessor command ppOpts :: [String] preprocessor options

Instances

Show PrepOpts Source #
Methods showsPrec :: Int -> PrepOpts -> ShowS # show :: PrepOpts -> String # showList :: [PrepOpts] -> ShowS #

data WarnOpts Source #

Warning options

Constructors

WarnOpts
Fields wnWarn :: Bool show warnings? (legacy option) wnWarnFlags :: [WarnFlag] Warnings flags (see below) wnWarnAsError :: Bool Should warnings be treated as errors?

Instances

Show WarnOpts Source #
Methods showsPrec :: Int -> WarnOpts -> ShowS # show :: WarnOpts -> String # showList :: [WarnOpts] -> ShowS #

data DebugOpts Source #

Debug options

Constructors

DebugOpts
Fields dbDumpLevels :: [DumpLevel] dump levels dbDumpEnv :: Bool dump compilation environment dbDumpRaw :: Bool dump data structure

Instances

Show DebugOpts Source #
Methods showsPrec :: Int -> DebugOpts -> ShowS # show :: DebugOpts -> String # showList :: [DebugOpts] -> ShowS #

data CymakeMode Source #

Modus operandi of the program

Constructors

ModeHelp	Show help information and exit
ModeVersion	Show version and exit
ModeNumericVersion	Show numeric version, suitable for later processing
ModeMake	Compile with dependencies

Instances

Eq CymakeMode Source #
Methods (==) :: CymakeMode -> CymakeMode -> Bool # (/=) :: CymakeMode -> CymakeMode -> Bool #
Show CymakeMode Source #
Methods showsPrec :: Int -> CymakeMode -> ShowS # show :: CymakeMode -> String # showList :: [CymakeMode] -> ShowS #

data Verbosity Source #

Verbosity level

Constructors

VerbQuiet	be quiet
VerbStatus	show status of compilation

Instances

Eq Verbosity Source #
Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Show Verbosity Source #
Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

data TargetType Source #

Type of the target file

Constructors

Tokens	Source code tokens
Parsed	Parsed source code
FlatCurry	FlatCurry
ExtendedFlatCurry	Extended FlatCurry
AbstractCurry	AbstractCurry
UntypedAbstractCurry	Untyped AbstractCurry
Html	HTML documentation

Instances

Eq TargetType Source #
Methods (==) :: TargetType -> TargetType -> Bool # (/=) :: TargetType -> TargetType -> Bool #
Show TargetType Source #
Methods showsPrec :: Int -> TargetType -> ShowS # show :: TargetType -> String # showList :: [TargetType] -> ShowS #

data WarnFlag Source #

Warnings flags

Constructors

WarnMultipleImports	Warn for multiple imports
WarnDisjoinedRules	Warn for disjoined function rules
WarnUnusedGlobalBindings	Warn for unused global bindings
WarnUnusedBindings	Warn for unused local bindings
WarnNameShadowing	Warn for name shadowing
WarnOverlapping	Warn for overlapping rules/alternatives
WarnIncompletePatterns	Warn for incomplete pattern matching
WarnMissingSignatures	Warn for missing type signatures

Instances

Bounded WarnFlag Source #
Methods minBound :: WarnFlag # maxBound :: WarnFlag #
Enum WarnFlag Source #
Methods succ :: WarnFlag -> WarnFlag # pred :: WarnFlag -> WarnFlag # toEnum :: Int -> WarnFlag # fromEnum :: WarnFlag -> Int # enumFrom :: WarnFlag -> [WarnFlag] # enumFromThen :: WarnFlag -> WarnFlag -> [WarnFlag] # enumFromTo :: WarnFlag -> WarnFlag -> [WarnFlag] # enumFromThenTo :: WarnFlag -> WarnFlag -> WarnFlag -> [WarnFlag] #
Eq WarnFlag Source #
Methods (==) :: WarnFlag -> WarnFlag -> Bool # (/=) :: WarnFlag -> WarnFlag -> Bool #
Show WarnFlag Source #
Methods showsPrec :: Int -> WarnFlag -> ShowS # show :: WarnFlag -> String # showList :: [WarnFlag] -> ShowS #

data KnownExtension :: * #

Known language extensions of Curry.

Constructors

AnonFreeVars	anonymous free variables
FunctionalPatterns	functional patterns
NegativeLiterals	negative literals
NoImplicitPrelude	no implicit import of the prelude

Instances

Bounded KnownExtension
Methods minBound :: KnownExtension # maxBound :: KnownExtension #
Enum KnownExtension
Methods succ :: KnownExtension -> KnownExtension # pred :: KnownExtension -> KnownExtension # toEnum :: Int -> KnownExtension # fromEnum :: KnownExtension -> Int # enumFrom :: KnownExtension -> [KnownExtension] # enumFromThen :: KnownExtension -> KnownExtension -> [KnownExtension] # enumFromTo :: KnownExtension -> KnownExtension -> [KnownExtension] # enumFromThenTo :: KnownExtension -> KnownExtension -> KnownExtension -> [KnownExtension] #
Eq KnownExtension
Methods (==) :: KnownExtension -> KnownExtension -> Bool # (/=) :: KnownExtension -> KnownExtension -> Bool #
Data KnownExtension
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KnownExtension -> c KnownExtension # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KnownExtension # toConstr :: KnownExtension -> Constr # dataTypeOf :: KnownExtension -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c KnownExtension) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KnownExtension) # gmapT :: (forall b. Data b => b -> b) -> KnownExtension -> KnownExtension # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KnownExtension -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KnownExtension -> r # gmapQ :: (forall d. Data d => d -> u) -> KnownExtension -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KnownExtension -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension #
Read KnownExtension
Methods readsPrec :: Int -> ReadS KnownExtension # readList :: ReadS [KnownExtension] # readPrec :: ReadPrec KnownExtension # readListPrec :: ReadPrec [KnownExtension] #
Show KnownExtension
Methods showsPrec :: Int -> KnownExtension -> ShowS # show :: KnownExtension -> String # showList :: [KnownExtension] -> ShowS #

data DumpLevel Source #

Dump level

Constructors

DumpParsed	dump source code after parsing
DumpKindChecked	dump source code after kind checking
DumpSyntaxChecked	dump source code after syntax checking
DumpPrecChecked	dump source code after precedence checking
DumpTypeChecked	dump source code after type checking
DumpExportChecked	dump source code after export checking
DumpQualified	dump source after qualification
DumpDesugared	dump source after desugaring
DumpSimplified	dump source after simplification
DumpLifted	dump source after lambda-lifting
DumpTranslated	dump IL code after translation
DumpCaseCompleted	dump IL code after case completion
DumpFlatCurry	dump FlatCurry code (pretty-printed)

Instances

Bounded DumpLevel Source #
Methods minBound :: DumpLevel # maxBound :: DumpLevel #
Enum DumpLevel Source #
Methods succ :: DumpLevel -> DumpLevel # pred :: DumpLevel -> DumpLevel # toEnum :: Int -> DumpLevel # fromEnum :: DumpLevel -> Int # enumFrom :: DumpLevel -> [DumpLevel] # enumFromThen :: DumpLevel -> DumpLevel -> [DumpLevel] # enumFromTo :: DumpLevel -> DumpLevel -> [DumpLevel] # enumFromThenTo :: DumpLevel -> DumpLevel -> DumpLevel -> [DumpLevel] #
Eq DumpLevel Source #
Methods (==) :: DumpLevel -> DumpLevel -> Bool # (/=) :: DumpLevel -> DumpLevel -> Bool #
Show DumpLevel Source #
Methods showsPrec :: Int -> DumpLevel -> ShowS # show :: DumpLevel -> String # showList :: [DumpLevel] -> ShowS #

dumpLevel :: [(DumpLevel, String, String)] Source #

Description and flag of dump levels

defaultOptions :: Options Source #

Default compiler options

defaultPrepOpts :: PrepOpts Source #

Default preprocessor options

defaultWarnOpts :: WarnOpts Source #

Default warning options

defaultDebugOpts :: DebugOpts Source #

Default dump options

getCompilerOpts :: IO (String, Options, [String], [String]) Source #

Retrieve the compiler Options

updateOpts :: Options -> [String] -> (Options, [String], [String]) Source #

Update the Options record by the parsed and processed arguments

usage :: String -> String Source #

Print the usage information of the command line tool.