CompilerOpts

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.

Documentation

data Options

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

Defined in CompilerOpts

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data CppOpts

C preprocessor options

Constructors

CppOpts

Fields

• cppRun :: Bool

  run C preprocessor

• cppDefinitions :: Map String Int

  defintions for the C preprocessor

Instances

Show CppOpts

Defined in CompilerOpts

Methods

showsPrec :: Int -> CppOpts -> ShowS

show :: CppOpts -> String

showList :: [CppOpts] -> ShowS

data PrepOpts

Preprocessor options

Constructors

PrepOpts

Fields

• ppPreprocess :: Bool

  apply custom preprocessor

• ppCmd :: String

  preprocessor command

• ppOpts :: [String]

  preprocessor options

Instances

Show PrepOpts

Defined in CompilerOpts

Methods

showsPrec :: Int -> PrepOpts -> ShowS

show :: PrepOpts -> String

showList :: [PrepOpts] -> ShowS

data WarnOpts

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

Defined in CompilerOpts

Methods

showsPrec :: Int -> WarnOpts -> ShowS

show :: WarnOpts -> String

showList :: [WarnOpts] -> ShowS

data DebugOpts

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

Defined in CompilerOpts

Methods

showsPrec :: Int -> DebugOpts -> ShowS

show :: DebugOpts -> String

showList :: [DebugOpts] -> ShowS

data CaseMode

Constructors

CaseModeFree

CaseModeHaskell

CaseModeProlog

CaseModeGoedel

Instances

Eq CaseMode

Defined in CompilerOpts

Methods

(==) :: CaseMode -> CaseMode -> Bool

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

Show CaseMode

Defined in CompilerOpts

Methods

showsPrec :: Int -> CaseMode -> ShowS

show :: CaseMode -> String

showList :: [CaseMode] -> ShowS

data CymakeMode

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

Defined in CompilerOpts

Methods

(==) :: CymakeMode -> CymakeMode -> Bool

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

Show CymakeMode

Defined in CompilerOpts

Methods

showsPrec :: Int -> CymakeMode -> ShowS

show :: CymakeMode -> String

showList :: [CymakeMode] -> ShowS

data Verbosity

Verbosity level

Constructors

VerbQuiet

be quiet

VerbStatus

show status of compilation

Instances

Eq Verbosity

Defined in CompilerOpts

Methods

(==) :: Verbosity -> Verbosity -> Bool

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

Ord Verbosity

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

Defined in CompilerOpts

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

data TargetType

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

Defined in CompilerOpts

Methods

(==) :: TargetType -> TargetType -> Bool

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

Show TargetType

Defined in CompilerOpts

Methods

showsPrec :: Int -> TargetType -> ShowS

show :: TargetType -> String

showList :: [TargetType] -> ShowS

data WarnFlag

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

Defined in CompilerOpts

Methods

minBound :: WarnFlag

maxBound :: WarnFlag

Enum WarnFlag

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

Defined in CompilerOpts

Methods

(==) :: WarnFlag -> WarnFlag -> Bool

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

Show WarnFlag

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

Defined in Curry.Syntax.Extension

Methods

minBound :: KnownExtension

maxBound :: KnownExtension

Enum KnownExtension

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

Defined in Curry.Syntax.Extension

Methods

(==) :: KnownExtension -> KnownExtension -> Bool

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

Read KnownExtension

Defined in Curry.Syntax.Extension

Methods

readsPrec :: Int -> ReadS KnownExtension

readList :: ReadS [KnownExtension]

readPrec :: ReadPrec KnownExtension

readListPrec :: ReadPrec [KnownExtension]

Show KnownExtension

Defined in Curry.Syntax.Extension

Methods

showsPrec :: Int -> KnownExtension -> ShowS

show :: KnownExtension -> String

showList :: [KnownExtension] -> ShowS

data DumpLevel

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

Defined in CompilerOpts

Methods

minBound :: DumpLevel

maxBound :: DumpLevel

Enum DumpLevel

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

Defined in CompilerOpts

Methods

(==) :: DumpLevel -> DumpLevel -> Bool

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

Show DumpLevel

Defined in CompilerOpts

Methods

showsPrec :: Int -> DumpLevel -> ShowS

show :: DumpLevel -> String

showList :: [DumpLevel] -> ShowS

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

Description and flag of dump levels

defaultOptions :: Options

Default compiler options

defaultPrepOpts :: PrepOpts

Default preprocessor options

defaultWarnOpts :: WarnOpts

Default warning options

defaultDebugOpts :: DebugOpts

Default dump options

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

Retrieve the compiler Options

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

Update the Options record by the parsed and processed arguments

usage :: String -> String

Print the usage information of the command line tool.