{-# LANGUAGE CPP #-}
module Agda.Interaction.Options
( CommandLineOptions(..)
, PragmaOptions(..)
, OptionsPragma
, Flag, OptM, runOptM, OptDescr(..), ArgDescr(..)
, Verbosity
, WarningMode(..)
, checkOpts
, parseStandardOptions, parseStandardOptions'
, parsePragmaOptions
, parsePluginOptions
, defaultOptions
, defaultInteractionOptions
, defaultVerbosity
, defaultCutOff
, defaultPragmaOptions
, standardOptions_
, unsafePragmaOptions
, isLiterate
, mapFlag
, usage
, defaultLibDir
, inputFlag
, standardOptions
, getOptSimple
) where
import Control.Monad ( (>=>), when )
import Control.Monad.Trans
import Data.IORef
import Data.Either
import Data.Maybe
import Data.List ( isSuffixOf , intercalate )
import Data.Set ( Set )
import qualified Data.Set as Set
import System.Console.GetOpt ( getOpt', usageInfo, ArgOrder(ReturnInOrder)
, OptDescr(..), ArgDescr(..)
)
import System.Directory ( doesFileExist, doesDirectoryExist )
import Text.EditDistance
import Agda.Termination.CutOff ( CutOff(..) )
import Agda.Interaction.Library
import Agda.Interaction.Options.Help
import Agda.Interaction.Options.IORefs
import Agda.Interaction.Options.Warnings
import Agda.Utils.Except
( ExceptT
, MonadError(catchError, throwError)
, runExceptT
)
import Agda.Utils.FileName ( absolute, AbsolutePath, filePath )
import Agda.Utils.Functor ( (<&>) )
import Agda.Utils.Lens ( Lens', over )
import Agda.Utils.List ( groupOn, wordsBy )
import Agda.Utils.Monad ( ifM, readM )
import Agda.Utils.String ( indent )
import Agda.Utils.Trie ( Trie )
import Agda.Syntax.Parser.Literate ( literateExts )
import qualified Agda.Utils.Trie as Trie
import Agda.Version
import Paths_Agda ( getDataFileName )
import qualified System.IO.Unsafe as UNSAFE (unsafePerformIO)
isLiterate :: FilePath -> Bool
isLiterate file = any (`isSuffixOf` file) literateExts
type Verbosity = Trie String Int
data CommandLineOptions = Options
{ optProgramName :: String
, optInputFile :: Maybe FilePath
, optIncludePaths :: [FilePath]
, optAbsoluteIncludePaths :: [AbsolutePath]
, optLibraries :: [LibName]
, optOverrideLibrariesFile :: Maybe FilePath
, optDefaultLibs :: Bool
, optUseLibs :: Bool
, optShowVersion :: Bool
, optShowHelp :: Maybe Help
, optInteractive :: Bool
, optGHCiInteraction :: Bool
, optOptimSmashing :: Bool
, optCompileDir :: Maybe FilePath
, optGenerateVimFile :: Bool
, optGenerateLaTeX :: Bool
, optGenerateHTML :: Bool
, optDependencyGraph :: Maybe FilePath
, optLaTeXDir :: FilePath
, optHTMLDir :: FilePath
, optCSSFile :: Maybe FilePath
, optIgnoreInterfaces :: Bool
, optForcing :: Bool
, optPragmaOptions :: PragmaOptions
, optOnlyScopeChecking :: Bool
}
deriving Show
data PragmaOptions = PragmaOptions
{ optShowImplicit :: Bool
, optShowIrrelevant :: Bool
, optUseUnicode :: Bool
, optVerbose :: Verbosity
, optProofIrrelevance :: Bool
, optAllowUnsolved :: Bool
, optDisablePositivity :: Bool
, optTerminationCheck :: Bool
, optTerminationDepth :: CutOff
, optCompletenessCheck :: Bool
, optUniverseCheck :: Bool
, optSizedTypes :: Bool
, optInjectiveTypeConstructors :: Bool
, optGuardingTypeConstructors :: Bool
, optUniversePolymorphism :: Bool
, optIrrelevantProjections :: Bool
, optExperimentalIrrelevance :: Bool
, optWithoutK :: Bool
, optCopatterns :: Bool
, optPatternMatching :: Bool
, optExactSplit :: Bool
, optEta :: Bool
, optRewriting :: Bool
, optPostfixProjections :: Bool
, optInstanceSearchDepth :: Int
, optInversionMaxDepth :: Int
, optSafe :: Bool
, optWarningMode :: WarningMode
, optCompileNoMain :: Bool
, optCaching :: Bool
, optCountClusters :: Bool
, optAutoInline :: Bool
, optPrintPatternSynonyms :: Bool
}
deriving (Show, Eq)
type OptionsPragma = [String]
mapFlag :: (String -> String) -> OptDescr a -> OptDescr a
mapFlag f (Option _ long arg descr) = Option [] (map f long) arg descr
defaultVerbosity :: Verbosity
defaultVerbosity = Trie.singleton [] 1
defaultInteractionOptions :: PragmaOptions
defaultInteractionOptions = defaultPragmaOptions
defaultOptions :: CommandLineOptions
defaultOptions = Options
{ optProgramName = "agda"
, optInputFile = Nothing
, optIncludePaths = []
, optAbsoluteIncludePaths = []
, optLibraries = []
, optOverrideLibrariesFile = Nothing
, optDefaultLibs = True
, optUseLibs = True
, optShowVersion = False
, optShowHelp = Nothing
, optInteractive = False
, optGHCiInteraction = False
, optOptimSmashing = True
, optCompileDir = Nothing
, optGenerateVimFile = False
, optGenerateLaTeX = False
, optGenerateHTML = False
, optDependencyGraph = Nothing
, optLaTeXDir = defaultLaTeXDir
, optHTMLDir = defaultHTMLDir
, optCSSFile = Nothing
, optIgnoreInterfaces = False
, optForcing = True
, optPragmaOptions = defaultPragmaOptions
, optOnlyScopeChecking = False
}
defaultPragmaOptions :: PragmaOptions
defaultPragmaOptions = PragmaOptions
{ optShowImplicit = False
, optShowIrrelevant = False
, optUseUnicode = True
, optVerbose = defaultVerbosity
, optProofIrrelevance = False
, optExperimentalIrrelevance = False
, optIrrelevantProjections = True
, optAllowUnsolved = False
, optDisablePositivity = False
, optTerminationCheck = True
, optTerminationDepth = defaultCutOff
, optCompletenessCheck = True
, optUniverseCheck = True
, optSizedTypes = True
, optInjectiveTypeConstructors = False
, optGuardingTypeConstructors = False
, optUniversePolymorphism = True
, optWithoutK = False
, optCopatterns = True
, optPatternMatching = True
, optExactSplit = False
, optEta = True
, optRewriting = False
, optPostfixProjections = False
, optInstanceSearchDepth = 500
, optInversionMaxDepth = 50
, optSafe = False
, optWarningMode = defaultWarningMode
, optCompileNoMain = False
, optCaching = True
, optCountClusters = False
, optAutoInline = True
, optPrintPatternSynonyms = True
}
defaultCutOff :: CutOff
defaultCutOff = CutOff 0
defaultLaTeXDir :: String
defaultLaTeXDir = "latex"
defaultHTMLDir :: String
defaultHTMLDir = "html"
type OptM = ExceptT String IO
runOptM :: OptM a -> IO (Either String a)
runOptM = runExceptT
type Flag opts = opts -> OptM opts
checkOpts :: Flag CommandLineOptions
checkOpts opts
| not (matches [optGHCiInteraction, isJust . optInputFile] <= 1) =
throwError "Choose at most one: input file or --interaction.\n"
| or [ p opts && matches ps > 1 | (p, ps) <- exclusive ] =
throwError exclusiveMessage
| otherwise = return opts
where
matches = length . filter ($ opts)
atMostOne =
[ optGenerateHTML
, isJust . optDependencyGraph
] ++
map fst exclusive
exclusive =
[ ( optOnlyScopeChecking
, optSafe . optPragmaOptions :
optGenerateVimFile :
atMostOne
)
, ( optInteractive
, optGenerateLaTeX : atMostOne
)
, ( optGHCiInteraction
, optGenerateLaTeX : atMostOne
)
]
exclusiveMessage = unlines $
[ "The options --interactive, --interaction and"
, "--only-scope-checking cannot be combined with each other or"
, "with --html or --dependency-graph. Furthermore"
, "--interactive and --interaction cannot be combined with"
, "--latex, and --only-scope-checking cannot be combined with"
, "--safe or --vim."
]
unsafePragmaOptions :: PragmaOptions -> [String]
unsafePragmaOptions opts =
[ "--allow-unsolved-metas" | optAllowUnsolved opts ] ++
[ "--no-positivity-check" | optDisablePositivity opts ] ++
[ "--no-termination-check" | not (optTerminationCheck opts) ] ++
[ "--type-in-type" | not (optUniverseCheck opts) ] ++
[ "--injective-type-constructors" | optInjectiveTypeConstructors opts ] ++
[ "--guardedness-preserving-type-constructors" | optGuardingTypeConstructors opts ] ++
[ "--experimental-irrelevance" | optExperimentalIrrelevance opts ] ++
[ "--rewriting" | optRewriting opts ] ++
[]
inputFlag :: FilePath -> Flag CommandLineOptions
inputFlag f o =
case optInputFile o of
Nothing -> return $ o { optInputFile = Just f }
Just _ -> throwError "only one input file allowed"
versionFlag :: Flag CommandLineOptions
versionFlag o = return $ o { optShowVersion = True }
helpFlag :: Maybe String -> Flag CommandLineOptions
helpFlag Nothing o = return $ o { optShowHelp = Just GeneralHelp }
helpFlag (Just str) o = case string2HelpTopic str of
Just hpt -> return $ o { optShowHelp = Just (HelpFor hpt) }
Nothing -> throwError $ "unknown help topic " ++ str ++ " (available: " ++
intercalate ", " (map fst allHelpTopics) ++ ")"
safeFlag :: Flag PragmaOptions
safeFlag o = return $ o { optSafe = True }
sharingFlag :: Bool -> Flag CommandLineOptions
sharingFlag _ o = return o
cachingFlag :: Bool -> Flag PragmaOptions
cachingFlag b o = return $ o { optCaching = b }
proofIrrelevanceFlag :: Flag PragmaOptions
proofIrrelevanceFlag o = return $ o { optProofIrrelevance = True }
experimentalIrrelevanceFlag :: Flag PragmaOptions
experimentalIrrelevanceFlag o = return $ o { optExperimentalIrrelevance = True }
noIrrelevantProjectionsFlag :: Flag PragmaOptions
noIrrelevantProjectionsFlag o = return $ o { optIrrelevantProjections = False }
ignoreInterfacesFlag :: Flag CommandLineOptions
ignoreInterfacesFlag o = return $ o { optIgnoreInterfaces = True }
allowUnsolvedFlag :: Flag PragmaOptions
allowUnsolvedFlag o = do
let upd = over warningSet (Set.\\ unsolvedWarnings)
return $ o { optAllowUnsolved = True
, optWarningMode = upd (optWarningMode o)
}
showImplicitFlag :: Flag PragmaOptions
showImplicitFlag o = return $ o { optShowImplicit = True }
showIrrelevantFlag :: Flag PragmaOptions
showIrrelevantFlag o = return $ o { optShowIrrelevant = True }
asciiOnlyFlag :: Flag PragmaOptions
asciiOnlyFlag o = do
lift $ writeIORef unicodeOrAscii AsciiOnly
return $ o { optUseUnicode = False }
ghciInteractionFlag :: Flag CommandLineOptions
ghciInteractionFlag o = return $ o { optGHCiInteraction = True }
vimFlag :: Flag CommandLineOptions
vimFlag o = return $ o { optGenerateVimFile = True }
latexFlag :: Flag CommandLineOptions
latexFlag o = return $ o { optGenerateLaTeX = True }
onlyScopeCheckingFlag :: Flag CommandLineOptions
onlyScopeCheckingFlag o = return $ o { optOnlyScopeChecking = True }
countClustersFlag :: Flag PragmaOptions
countClustersFlag o =
#ifdef COUNT_CLUSTERS
return $ o { optCountClusters = True }
#else
throwError
"Cluster counting has not been enabled in this build of Agda."
#endif
noAutoInlineFlag :: Flag PragmaOptions
noAutoInlineFlag o = return $ o { optAutoInline = False }
noPrintPatSynFlag :: Flag PragmaOptions
noPrintPatSynFlag o = return $ o { optPrintPatternSynonyms = False }
latexDirFlag :: FilePath -> Flag CommandLineOptions
latexDirFlag d o = return $ o { optLaTeXDir = d }
noPositivityFlag :: Flag PragmaOptions
noPositivityFlag o = do
let upd = over warningSet (Set.delete NotStrictlyPositive_)
return $ o { optDisablePositivity = True
, optWarningMode = upd (optWarningMode o)
}
dontTerminationCheckFlag :: Flag PragmaOptions
dontTerminationCheckFlag o = do
let upd = over warningSet (Set.delete TerminationIssue_)
return $ o { optTerminationCheck = False
, optWarningMode = upd (optWarningMode o)
}
dontCompletenessCheckFlag :: Flag PragmaOptions
dontCompletenessCheckFlag _ =
throwError "the --no-coverage-check option has been removed"
dontUniverseCheckFlag :: Flag PragmaOptions
dontUniverseCheckFlag o = return $ o { optUniverseCheck = False }
etaFlag :: Flag PragmaOptions
etaFlag o = return $ o { optEta = True }
noEtaFlag :: Flag PragmaOptions
noEtaFlag o = return $ o { optEta = False }
sizedTypes :: Flag PragmaOptions
sizedTypes o = return $ o { optSizedTypes = True }
noSizedTypes :: Flag PragmaOptions
noSizedTypes o = return $ o { optSizedTypes = False }
injectiveTypeConstructorFlag :: Flag PragmaOptions
injectiveTypeConstructorFlag o = return $ o { optInjectiveTypeConstructors = True }
guardingTypeConstructorFlag :: Flag PragmaOptions
guardingTypeConstructorFlag o = return $ o { optGuardingTypeConstructors = True }
universePolymorphismFlag :: Flag PragmaOptions
universePolymorphismFlag o = return $ o { optUniversePolymorphism = True }
noUniversePolymorphismFlag :: Flag PragmaOptions
noUniversePolymorphismFlag o = return $ o { optUniversePolymorphism = False }
noForcingFlag :: Flag CommandLineOptions
noForcingFlag o = return $ o { optForcing = False }
withKFlag :: Flag PragmaOptions
withKFlag o = return $ o { optWithoutK = False }
withoutKFlag :: Flag PragmaOptions
withoutKFlag o = return $ o { optWithoutK = True }
copatternsFlag :: Flag PragmaOptions
copatternsFlag o = return $ o { optCopatterns = True }
noCopatternsFlag :: Flag PragmaOptions
noCopatternsFlag o = return $ o { optCopatterns = False }
noPatternMatchingFlag :: Flag PragmaOptions
noPatternMatchingFlag o = return $ o { optPatternMatching = False }
exactSplitFlag :: Flag PragmaOptions
exactSplitFlag o = do
let upd = over warningSet (Set.insert CoverageNoExactSplit_)
return $ o { optExactSplit = True
, optWarningMode = upd (optWarningMode o)
}
noExactSplitFlag :: Flag PragmaOptions
noExactSplitFlag o = do
let upd = over warningSet (Set.delete CoverageNoExactSplit_)
return $ o { optExactSplit = False
, optWarningMode = upd (optWarningMode o)
}
rewritingFlag :: Flag PragmaOptions
rewritingFlag o = return $ o { optRewriting = True }
postfixProjectionsFlag :: Flag PragmaOptions
postfixProjectionsFlag o = return $ o { optPostfixProjections = True }
instanceDepthFlag :: String -> Flag PragmaOptions
instanceDepthFlag s o = do
d <- integerArgument "--instance-search-depth" s
return $ o { optInstanceSearchDepth = d }
inversionMaxDepthFlag :: String -> Flag PragmaOptions
inversionMaxDepthFlag s o = do
d <- integerArgument "--inversion-max-depth" s
return $ o { optInversionMaxDepth = d }
interactiveFlag :: Flag CommandLineOptions
interactiveFlag o = do
prag <- allowUnsolvedFlag (optPragmaOptions o)
return $ o { optInteractive = True
, optPragmaOptions = prag
}
compileFlagNoMain :: Flag PragmaOptions
compileFlagNoMain o = return $ o { optCompileNoMain = True }
compileDirFlag :: FilePath -> Flag CommandLineOptions
compileDirFlag f o = return $ o { optCompileDir = Just f }
htmlFlag :: Flag CommandLineOptions
htmlFlag o = return $ o { optGenerateHTML = True }
dependencyGraphFlag :: FilePath -> Flag CommandLineOptions
dependencyGraphFlag f o = return $ o { optDependencyGraph = Just f }
htmlDirFlag :: FilePath -> Flag CommandLineOptions
htmlDirFlag d o = return $ o { optHTMLDir = d }
cssFlag :: FilePath -> Flag CommandLineOptions
cssFlag f o = return $ o { optCSSFile = Just f }
includeFlag :: FilePath -> Flag CommandLineOptions
includeFlag d o = return $ o { optIncludePaths = d : optIncludePaths o }
libraryFlag :: String -> Flag CommandLineOptions
libraryFlag s o = return $ o { optLibraries = optLibraries o ++ [s] }
overrideLibrariesFileFlag :: String -> Flag CommandLineOptions
overrideLibrariesFileFlag s o = do
ifM (liftIO $ doesFileExist s)
(return $ o { optOverrideLibrariesFile = Just s })
(throwError $ "Libraries file not found: " ++ s)
noDefaultLibsFlag :: Flag CommandLineOptions
noDefaultLibsFlag o = return $ o { optDefaultLibs = False }
noLibsFlag :: Flag CommandLineOptions
noLibsFlag o = return $ o { optUseLibs = False }
verboseFlag :: String -> Flag PragmaOptions
verboseFlag s o =
do (k,n) <- parseVerbose s
return $ o { optVerbose = Trie.insert k n $ optVerbose o }
where
parseVerbose s = case wordsBy (`elem` ":.") s of
[] -> usage
ss -> do
n <- readM (last ss) `catchError` \_ -> usage
return (init ss, n)
usage = throwError "argument to verbose should be on the form x.y.z:N or N"
warningModeFlag :: String -> Flag PragmaOptions
warningModeFlag s o = case warningModeUpdate s of
Just upd -> return $ o { optWarningMode = upd (optWarningMode o) }
Nothing -> throwError $ "unknown warning flag " ++ s ++ ". See --help=warning."
terminationDepthFlag :: String -> Flag PragmaOptions
terminationDepthFlag s o =
do k <- readM s `catchError` \_ -> usage
when (k < 1) $ usage
return $ o { optTerminationDepth = CutOff $ k-1 }
where usage = throwError "argument to termination-depth should be >= 1"
integerArgument :: String -> String -> OptM Int
integerArgument flag s =
readM s `catchError` \_ ->
throwError $ "option '" ++ flag ++ "' requires an integer argument"
standardOptions :: [OptDescr (Flag CommandLineOptions)]
standardOptions =
[ Option ['V'] ["version"] (NoArg versionFlag) "show version number"
, Option ['?'] ["help"] (OptArg helpFlag "TOPIC")
("show help for TOPIC (available: "
++ intercalate ", " (map fst allHelpTopics)
++ ")")
, Option ['I'] ["interactive"] (NoArg interactiveFlag)
"start in interactive mode"
, Option [] ["interaction"] (NoArg ghciInteractionFlag)
"for use with the Emacs mode"
, Option [] ["compile-dir"] (ReqArg compileDirFlag "DIR")
("directory for compiler output (default: the project root)")
, Option [] ["vim"] (NoArg vimFlag)
"generate Vim highlighting files"
, Option [] ["latex"] (NoArg latexFlag)
"generate LaTeX with highlighted source code"
, Option [] ["latex-dir"] (ReqArg latexDirFlag "DIR")
("directory in which LaTeX files are placed (default: " ++
defaultLaTeXDir ++ ")")
, Option [] ["html"] (NoArg htmlFlag)
"generate HTML files with highlighted source code"
, Option [] ["html-dir"] (ReqArg htmlDirFlag "DIR")
("directory in which HTML files are placed (default: " ++
defaultHTMLDir ++ ")")
, Option [] ["css"] (ReqArg cssFlag "URL")
"the CSS file used by the HTML files (can be relative)"
, Option [] ["dependency-graph"] (ReqArg dependencyGraphFlag "FILE")
"generate a Dot file with a module dependency graph"
, Option [] ["ignore-interfaces"] (NoArg ignoreInterfacesFlag)
"ignore interface files (re-type check everything)"
, Option ['i'] ["include-path"] (ReqArg includeFlag "DIR")
"look for imports in DIR"
, Option ['l'] ["library"] (ReqArg libraryFlag "LIB")
"use library LIB"
, Option [] ["library-file"] (ReqArg overrideLibrariesFileFlag "FILE")
"use FILE instead of the standard libraries file"
, Option [] ["no-libraries"] (NoArg noLibsFlag)
"don't use any library files"
, Option [] ["no-default-libraries"] (NoArg noDefaultLibsFlag)
"don't use default libraries"
, Option [] ["no-forcing"] (NoArg noForcingFlag)
"disable the forcing optimisation"
, Option [] ["sharing"] (NoArg $ sharingFlag True)
"DEPRECATED: does nothing"
, Option [] ["no-sharing"] (NoArg $ sharingFlag False)
"DEPRECATED: does nothing"
, Option [] ["only-scope-checking"] (NoArg onlyScopeCheckingFlag)
"only scope-check the top-level module, do not type-check it"
] ++ map (fmap lift) pragmaOptions
where
lift :: Flag PragmaOptions -> Flag CommandLineOptions
lift f = \opts -> do
ps <- f (optPragmaOptions opts)
return (opts { optPragmaOptions = ps })
pragmaOptions :: [OptDescr (Flag PragmaOptions)]
pragmaOptions =
[ Option [] ["show-implicit"] (NoArg showImplicitFlag)
"show implicit arguments when printing"
, Option [] ["show-irrelevant"] (NoArg showIrrelevantFlag)
"show irrelevant arguments when printing"
, Option [] ["no-unicode"] (NoArg asciiOnlyFlag)
"don't use unicode characters when printing terms"
, Option ['v'] ["verbose"] (ReqArg verboseFlag "N")
"set verbosity level to N"
, Option [] ["allow-unsolved-metas"] (NoArg allowUnsolvedFlag)
"succeed and create interface file regardless of unsolved meta variables"
, Option [] ["no-positivity-check"] (NoArg noPositivityFlag)
"do not warn about not strictly positive data types"
, Option [] ["no-termination-check"] (NoArg dontTerminationCheckFlag)
"do not warn about possibly nonterminating code"
, Option [] ["termination-depth"] (ReqArg terminationDepthFlag "N")
"allow termination checker to count decrease/increase upto N (default N=1)"
, Option [] ["no-coverage-check"] (NoArg dontCompletenessCheckFlag)
"the option has been removed"
, Option [] ["type-in-type"] (NoArg dontUniverseCheckFlag)
"ignore universe levels (this makes Agda inconsistent)"
, Option [] ["sized-types"] (NoArg sizedTypes)
"use sized types (default, inconsistent with `musical' coinduction)"
, Option [] ["no-sized-types"] (NoArg noSizedTypes)
"disable sized types"
, Option [] ["injective-type-constructors"] (NoArg injectiveTypeConstructorFlag)
"enable injective type constructors (makes Agda anti-classical and possibly inconsistent)"
, Option [] ["guardedness-preserving-type-constructors"] (NoArg guardingTypeConstructorFlag)
"treat type constructors as inductive constructors when checking productivity"
, Option [] ["no-universe-polymorphism"] (NoArg noUniversePolymorphismFlag)
"disable universe polymorphism"
, Option [] ["universe-polymorphism"] (NoArg universePolymorphismFlag)
"enable universe polymorphism (default)"
, Option [] ["no-irrelevant-projections"] (NoArg noIrrelevantProjectionsFlag)
"disable projection of irrelevant record fields"
, Option [] ["experimental-irrelevance"] (NoArg experimentalIrrelevanceFlag)
"enable potentially unsound irrelevance features (irrelevant levels, irrelevant data matching)"
, Option [] ["with-K"] (NoArg withKFlag)
"enable the K rule in pattern matching"
, Option [] ["without-K"] (NoArg withoutKFlag)
"disable the K rule in pattern matching"
, Option [] ["copatterns"] (NoArg copatternsFlag)
"enable definitions by copattern matching (default)"
, Option [] ["no-copatterns"] (NoArg noCopatternsFlag)
"disable definitions by copattern matching"
, Option [] ["no-pattern-matching"] (NoArg noPatternMatchingFlag)
"disable pattern matching completely"
, Option [] ["exact-split"] (NoArg exactSplitFlag)
"require all clauses in a definition to hold as definitional equalities (unless marked CATCHALL)"
, Option [] ["no-exact-split"] (NoArg noExactSplitFlag)
"do not require all clauses in a definition to hold as definitional equalities (default)"
, Option [] ["no-eta-equality"] (NoArg noEtaFlag)
"default records to no-eta-equality"
, Option [] ["rewriting"] (NoArg rewritingFlag)
"enable declaration and use of REWRITE rules"
, Option [] ["postfix-projections"] (NoArg postfixProjectionsFlag)
"make postfix projection notation the default"
, Option [] ["instance-search-depth"] (ReqArg instanceDepthFlag "N")
"set instance search depth to N (default: 500)"
, Option [] ["inversion-max-depth"] (ReqArg inversionMaxDepthFlag "N")
"set maximum depth for pattern match inversion to N (default: 50)"
, Option [] ["safe"] (NoArg safeFlag)
"disable postulates, unsafe OPTION pragmas and primTrustMe"
, Option ['W'] ["warning"] (ReqArg warningModeFlag "FLAG")
("set warning flags. See --help=warning.")
, Option [] ["no-main"] (NoArg compileFlagNoMain)
"do not treat the requested module as the main module of a program when compiling"
, Option [] ["caching"] (NoArg $ cachingFlag True)
"enable caching of typechecking (default)"
, Option [] ["no-caching"] (NoArg $ cachingFlag False)
"disable caching of typechecking"
, Option [] ["count-clusters"] (NoArg countClustersFlag)
("count extended grapheme clusters when " ++
"generating LaTeX (note that this flag " ++
#ifdef COUNT_CLUSTERS
"is not enabled in all builds of Agda)"
#else
"has not been enabled in this build of Agda)"
#endif
)
, Option [] ["no-auto-inline"] (NoArg noAutoInlineFlag)
("disable automatic compile-time inlining " ++
"(only definitions marked INLINE will be inlined)")
, Option [] ["no-print-pattern-synonyms"] (NoArg noPrintPatSynFlag)
"expand pattern synonyms when printing terms"
]
standardOptions_ :: [OptDescr ()]
standardOptions_ = map (fmap $ const ()) standardOptions
getOptSimple
:: [String]
-> [OptDescr (Flag opts)]
-> (String -> Flag opts)
-> Flag opts
getOptSimple argv opts fileArg = \ defaults ->
case getOpt' (ReturnInOrder fileArg) opts argv of
(o, _, [] , [] ) -> foldl (>>=) (return defaults) o
(_, _, unrecognized, errs) -> throwError $ umsg ++ emsg
where
ucap = "Unrecognized " ++ plural unrecognized "option" ++ ":"
ecap = plural errs "Option error" ++ ":"
umsg = if null unrecognized then "" else unlines $
ucap : map suggest unrecognized
emsg = if null errs then "" else unlines $
ecap : errs
plural [_] x = x
plural _ x = x ++ "s"
longopts :: [String]
longopts = map ("--" ++) $ concat $ map (\ (Option _ long _ _) -> long) opts
dist :: String -> String -> Int
dist s t = restrictedDamerauLevenshteinDistance defaultEditCosts s t
close :: String -> String -> Maybe (Int, String)
close s t = let d = dist s t in if d <= 3 then Just (d, t) else Nothing
closeopts :: String -> [(Int, String)]
closeopts s = mapMaybe (close s) longopts
alts :: String -> [[String]]
alts s = map (map snd) $ groupOn fst $ closeopts s
suggest :: String -> String
suggest s = case alts s of
[] -> s
as : _ -> s ++ " (did you mean " ++ sugs as ++ " ?)"
sugs :: [String] -> String
sugs [a] = a
sugs as = "any of " ++ intercalate " " as
parseStandardOptions :: [String] -> OptM CommandLineOptions
parseStandardOptions argv = parseStandardOptions' argv defaultOptions
parseStandardOptions' :: [String] -> Flag CommandLineOptions
parseStandardOptions' argv opts = do
opts <- getOptSimple (stripRTS argv) standardOptions inputFlag opts
checkOpts opts
parsePragmaOptions
:: [String]
-> CommandLineOptions
-> OptM PragmaOptions
parsePragmaOptions argv opts = do
ps <- getOptSimple argv pragmaOptions
(\s _ -> throwError $ "Bad option in pragma: " ++ s)
(optPragmaOptions opts)
_ <- checkOpts (opts { optPragmaOptions = ps })
return ps
parsePluginOptions :: [String] -> [OptDescr (Flag opts)] -> Flag opts
parsePluginOptions argv opts =
getOptSimple argv opts
(\s _ -> throwError $
"Internal error: Flag " ++ s ++ " passed to a plugin")
usage :: [OptDescr ()] -> String -> Help -> String
usage options progName GeneralHelp = usageInfo (header progName) options
where
header progName = unlines [ "Agda version " ++ version, ""
, "Usage: " ++ progName ++ " [OPTIONS...] [FILE]" ]
usage options progName (HelpFor topic) = helpTopicUsage topic
stripRTS :: [String] -> [String]
stripRTS [] = []
stripRTS ("--RTS" : argv) = argv
stripRTS (arg : argv)
| is "+RTS" arg = stripRTS $ drop 1 $ dropWhile (not . is "-RTS") argv
| otherwise = arg : stripRTS argv
where
is x arg = [x] == take 1 (words arg)
defaultLibDir :: IO FilePath
defaultLibDir = do
libdir <- fmap filePath (absolute =<< getDataFileName "lib")
ifM (doesDirectoryExist libdir)
(return libdir)
(error $ "The lib directory " ++ libdir ++ " does not exist")