Copyright	(c) 2005 Martin Engelke 2007 Sebastian Fischer 2011 - 2016 Björn Peemöller 2016 - 2017 Finn Teegen 2018 Kai-Oliver Prott
License	BSD-3-clause
Maintainer	fte@informatik.uni-kiel.de
Stability	experimental
Portability	portable
Safe Haskell	Safe
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

data Options = Options {
- optMode :: CymakeMode
- optVerbosity :: Verbosity
- optForce :: Bool
- optLibraryPaths :: [FilePath]
- optImportPaths :: [FilePath]
- optHtmlDir :: Maybe FilePath
- optUseSubdir :: Bool
- optInterface :: Bool
- optPrepOpts :: PrepOpts
- optWarnOpts :: WarnOpts
- optTargetTypes :: [TargetType]
- optExtensions :: [KnownExtension]
- optDebugOpts :: DebugOpts
- optCaseMode :: CaseMode
- optCppOpts :: CppOpts
}
data CppOpts = CppOpts {
- cppRun :: Bool
- cppDefinitions :: Map String Int
}
data PrepOpts = PrepOpts {
- ppPreprocess :: Bool
- ppCmd :: String
- ppOpts :: [String]
}
data WarnOpts = WarnOpts {
- wnWarn :: Bool
- wnWarnFlags :: [WarnFlag]
- wnWarnAsError :: Bool
}
data DebugOpts = DebugOpts {
- dbDumpLevels :: [DumpLevel]
- dbDumpEnv :: Bool
- dbDumpRaw :: Bool
- dbDumpAllBindings :: Bool
- dbDumpSimple :: Bool
}
data CaseMode
- = CaseModeFree
- | CaseModeHaskell
- | CaseModeProlog
- | CaseModeGoedel
data CymakeMode
- = ModeHelp
- | ModeVersion
- | ModeNumericVersion
- | ModeMake
data Verbosity
- = VerbQuiet
- | VerbStatus
data TargetType
- = Tokens
- | Comments
- | Parsed
- | FlatCurry
- | TypedFlatCurry
- | TypeAnnotatedFlatCurry
- | AbstractCurry
- | UntypedAbstractCurry
- | Html
- | AST
- | ShortAST
data WarnFlag
- = WarnMultipleImports
- | WarnDisjoinedRules
- | WarnUnusedGlobalBindings
- | WarnUnusedBindings
- | WarnNameShadowing
- | WarnOverlapping
- | WarnIncompletePatterns
- | WarnMissingSignatures
- | WarnMissingMethods
- | WarnOrphanInstances
- | WarnIrregularCaseMode
data KnownExtension
- = AnonFreeVars
- | CPP
- | FunctionalPatterns
- | NegativeLiterals
- | NoImplicitPrelude
data DumpLevel
- = DumpCondCompiled
- | DumpParsed
- | DumpExtensionChecked
- | DumpTypeSyntaxChecked
- | DumpKindChecked
- | DumpSyntaxChecked
- | DumpPrecChecked
- | DumpDeriveChecked
- | DumpInstanceChecked
- | DumpTypeChecked
- | DumpExportChecked
- | DumpQualified
- | DumpDerived
- | DumpDesugared
- | DumpDictionaries
- | DumpNewtypes
- | DumpSimplified
- | DumpLifted
- | DumpTranslated
- | DumpCaseCompleted
- | DumpTypedFlatCurry
- | DumpFlatCurry
dumpLevel :: [(DumpLevel, String, String)]
defaultOptions :: Options
defaultPrepOpts :: PrepOpts
defaultWarnOpts :: WarnOpts
defaultDebugOpts :: DebugOpts
getCompilerOpts :: IO (String, Options, [String], [String])
updateOpts :: Options -> [String] -> (Options, [String], [String])
usage :: String -> String

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
optCaseMode :: CaseMode
case mode
optCppOpts :: CppOpts
C preprocessor options

Instances

Show Options Source #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #

data CppOpts Source #

C preprocessor options

Constructors

CppOpts
Fields cppRun :: Bool run C preprocessor cppDefinitions :: Map String Int defintions for the C preprocessor

Instances

Show CppOpts Source #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> CppOpts -> ShowS # show :: CppOpts -> String # showList :: [CppOpts] -> 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 #
Instance details Defined in CompilerOpts 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 #
Instance details Defined in CompilerOpts 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 dbDumpAllBindings :: Bool dump all bindings instead of just the local bindings dbDumpSimple :: Bool print more readable environments

Instances

Show DebugOpts Source #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> DebugOpts -> ShowS # show :: DebugOpts -> String # showList :: [DebugOpts] -> ShowS #

data CaseMode Source #

Constructors

CaseModeFree
CaseModeHaskell
CaseModeProlog
CaseModeGoedel

Instances

Eq CaseMode Source #
Instance details Defined in CompilerOpts Methods (==) :: CaseMode -> CaseMode -> Bool # (/=) :: CaseMode -> CaseMode -> Bool #
Show CaseMode Source #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> CaseMode -> ShowS # show :: CaseMode -> String # showList :: [CaseMode] -> 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 #
Instance details Defined in CompilerOpts Methods (==) :: CymakeMode -> CymakeMode -> Bool # (/=) :: CymakeMode -> CymakeMode -> Bool #
Show CymakeMode Source #
Instance details Defined in CompilerOpts 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 #
Instance details Defined in CompilerOpts Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details Defined in CompilerOpts 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 #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

data TargetType Source #

Type of the target file

Constructors

Tokens	Source code tokens
Comments	Source code comments
Parsed	Parsed source code
FlatCurry	FlatCurry
TypedFlatCurry	Typed FlatCurry
TypeAnnotatedFlatCurry	Type-annotated FlatCurry
AbstractCurry	AbstractCurry
UntypedAbstractCurry	Untyped AbstractCurry
Html	HTML documentation
AST	Abstract-Syntax-Tree after checks
ShortAST	Abstract-Syntax-Tree with shortened decls

Instances

Eq TargetType Source #
Instance details Defined in CompilerOpts Methods (==) :: TargetType -> TargetType -> Bool # (/=) :: TargetType -> TargetType -> Bool #
Show TargetType Source #
Instance details Defined in CompilerOpts 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
WarnMissingMethods	Warn for missing method implementations
WarnOrphanInstances	Warn for orphan instances
WarnIrregularCaseMode

Instances

Bounded WarnFlag Source #
Instance details Defined in CompilerOpts Methods minBound :: WarnFlag # maxBound :: WarnFlag #
Enum WarnFlag Source #
Instance details Defined in CompilerOpts 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 #
Instance details Defined in CompilerOpts Methods (==) :: WarnFlag -> WarnFlag -> Bool # (/=) :: WarnFlag -> WarnFlag -> Bool #
Show WarnFlag Source #
Instance details Defined in CompilerOpts Methods showsPrec :: Int -> WarnFlag -> ShowS # show :: WarnFlag -> String # showList :: [WarnFlag] -> ShowS #

data KnownExtension #

Known language extensions of Curry.

Constructors

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

Instances

Bounded KnownExtension
Instance details Defined in Curry.Syntax.Extension Methods minBound :: KnownExtension # maxBound :: KnownExtension #
Enum KnownExtension
Instance details Defined in Curry.Syntax.Extension 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
Instance details Defined in Curry.Syntax.Extension Methods (==) :: KnownExtension -> KnownExtension -> Bool # (/=) :: KnownExtension -> KnownExtension -> Bool #
Read KnownExtension
Instance details Defined in Curry.Syntax.Extension Methods readsPrec :: Int -> ReadS KnownExtension # readList :: ReadS [KnownExtension] # readPrec :: ReadPrec KnownExtension # readListPrec :: ReadPrec [KnownExtension] #
Show KnownExtension
Instance details Defined in Curry.Syntax.Extension Methods showsPrec :: Int -> KnownExtension -> ShowS # show :: KnownExtension -> String # showList :: [KnownExtension] -> ShowS #

data DumpLevel Source #

Dump level

Constructors

DumpCondCompiled	dump source code after conditional compiling
DumpParsed	dump source code after parsing
DumpExtensionChecked	dump source code after extension checking
DumpTypeSyntaxChecked	dump source code after type syntax checking
DumpKindChecked	dump source code after kind checking
DumpSyntaxChecked	dump source code after syntax checking
DumpPrecChecked	dump source code after precedence checking
DumpDeriveChecked	dump source code after derive checking
DumpInstanceChecked	dump source code after instance checking
DumpTypeChecked	dump source code after type checking
DumpExportChecked	dump source code after export checking
DumpQualified	dump source code after qualification
DumpDerived	dump source code after deriving
DumpDesugared	dump source code after desugaring
DumpDictionaries	dump source code after dictionary transformation
DumpNewtypes	dump source code after removing newtype constructors
DumpSimplified	dump source code after simplification
DumpLifted	dump source code after lambda-lifting
DumpTranslated	dump IL code after translation
DumpCaseCompleted	dump IL code after case completion
DumpTypedFlatCurry	dump typed FlatCurry code
DumpFlatCurry	dump FlatCurry code

Instances

Bounded DumpLevel Source #
Instance details Defined in CompilerOpts Methods minBound :: DumpLevel # maxBound :: DumpLevel #
Enum DumpLevel Source #
Instance details Defined in CompilerOpts 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 #
Instance details Defined in CompilerOpts Methods (==) :: DumpLevel -> DumpLevel -> Bool # (/=) :: DumpLevel -> DumpLevel -> Bool #
Show DumpLevel Source #
Instance details Defined in CompilerOpts 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.