PAKCS
Exported names: Imported modules:

Module CurryCheck

This is the implementation of the currycheck tool. It performs various checks on Curry programs:

  • Correct usage of set functions, non-strict unification, default rules, DET annotations, contracts
  • All EasyCheck tests are extracted and checked
  • For all functions declared as deterministic, determinism properties are generated and checked.
  • For functions with postconditions (f'post), checks for postconditions are generated (together with possible preconditions)
  • For functions with specification (f'spec), checks for satisfaction of these specifications are generated (together with possible preconditions).

Author: Michael Hanus, Jan-Patrick Baye

Version: December 2017

Summary of exported operations:

maxArity :: Int   
Maximal arity of check functions and tuples currently supported:
ccBanner :: String   
usageText :: String   
defaultOptions :: Options   
options :: [OptDescr (Options -> Options)]   
processOpts :: Options -> IO Options   
Further option processing, e.g., setting coloring mode.
isQuiet :: Options -> Bool   
putStrIfNormal :: Options -> String -> IO ()   
Print second argument if verbosity level is not quiet:
putStrIfVerbose :: Options -> String -> IO ()   
Print second argument if verbosity level > 1:
putStrLnIfDebug :: Options -> String -> IO ()   
Print second argument if verbosity level > 3:
withColor :: Options -> (String -> String) -> String -> String   
use some coloring (from library AnsiCodes) if color option is on:
defTypeSuffix :: String   
postCondSuffix :: String   
satSpecSuffix :: String   
isDetSuffix :: String   
isIOTest :: Test -> Bool   
isUnitTest :: Test -> Bool   
isPropTest :: Test -> Bool   
isEquivTest :: Test -> Bool   
getTestName :: Test -> (String,String)   
getTestLine :: Test -> Int   
genTestMsg :: String -> Test -> String   
staticErrorTestMod :: String -> [String] -> TestModule   
testThisModule :: TestModule -> Bool   
userTestDataOfModule :: TestModule -> [((String,String),Bool)]   
equivPropTypes :: TestModule -> [(String,String)]   
createTests :: Options -> String -> TestModule -> [CFuncDecl]   
easyCheckConfig :: Options -> (String,String)   
type2genop :: String -> TestModule -> Bool -> CTypeExpr -> CExpr   
isFloatType :: CTypeExpr -> Bool   
typename2genopname :: String -> [(String,String)] -> Bool -> (String,String) -> (String,String)   
transQN :: String -> String   
makeAllPublic :: CurryProg -> CurryProg   
classifyTests :: Options -> CurryProg -> [CFuncDecl] -> [Test]   
transformTests :: Options -> String -> CurryProg -> IO ([CFuncDecl],[CFuncDecl],CurryProg)   
transformDetTests :: Options -> [String] -> CurryProg -> ([CFuncDecl],[CFuncDecl],CurryProg)   
preCondOperations :: [CFuncDecl] -> [(String,String)]   
funDeclsWith :: (String -> Bool) -> [CFuncDecl] -> [CFuncDecl]   
propResultType :: CTypeExpr -> CTypeExpr   
genPostCondTest :: [(String,String)] -> [(String,String)] -> CFuncDecl -> [CFuncDecl]   
genSpecTest :: [(String,String)] -> [(String,String)] -> CFuncDecl -> [CFuncDecl]   
revertDetOpTrans :: [(String,String)] -> CFuncDecl -> CFuncDecl   
genDetOpTests :: [String] -> [(String,String)] -> [CFuncDecl] -> [CFuncDecl]   
genDetProp :: [(String,String)] -> CFuncDecl -> CFuncDecl   
poly2default :: String -> CFuncDecl -> [(Bool,CFuncDecl)]   
poly2defaultType :: String -> CTypeExpr -> CTypeExpr   
orgTestName :: (String,String) -> (String,String)   
analyseModule :: Options -> String -> IO [TestModule]   
staticProgAnalysis :: Options -> String -> String -> CurryProg -> IO ([String],[((String,String),String)])   
analyseCurryProg :: Options -> String -> CurryProg -> IO [TestModule]   
generatorsOfProg :: CurryProg -> [(String,String)]   
genBottomType :: String -> TypeDecl -> CTypeDecl   
isBasicExtType :: (String,String) -> Bool   
defaultValueOfBasicExtType :: String -> CLiteral   
ctype2BotType :: String -> CTypeExpr -> CTypeExpr   
t2bt :: String -> String   
genPeval :: String -> TypeDecl -> CFuncDecl   
genPValOf :: String -> TypeDecl -> CFuncDecl   
ftype2pvalOf :: String -> String -> [(Int,String)] -> TypeExpr -> CExpr   
ctype2pvalOf :: String -> String -> CTypeExpr -> CExpr   
ctypedecl2ftypedecl :: CTypeDecl -> TypeDecl   
genMainTestModule :: Options -> String -> [TestModule] -> IO ()   
genMainFunction :: Options -> String -> [Test] -> CFuncDecl   
collectAllTestTypeDecls :: [(TypeDecl,Bool)] -> [((String,String),Bool)] -> IO [(TypeDecl,Bool)]   
createTestDataGenerator :: String -> (TypeDecl,Bool) -> CFuncDecl   
cleanup :: Options -> String -> [TestModule] -> IO ()   
showTestStatistics :: [TestModule] -> String   
main :: IO ()   
renameProp2EasyCheck :: CurryProg -> CurryProg   
firstWord :: String -> String   
stripSuffix :: String -> String -> String   
modNameToId :: String -> String   
arityOfType :: CTypeExpr -> Int   
searchTreeModule :: String   
Name of the SearchTree module.
searchTreeTC :: (String,String)   
Name of SearchTree type constructor.
generatorModule :: String   
Name of the SearchTreeGenerator module.
choiceGen :: (String,String)   
writeCurryProgram :: Options -> String -> CurryProg -> String -> IO ()   
isPAKCS :: Bool   
containsPPOptionLine :: String -> Bool   
tconsOf :: CTypeExpr -> [(String,String)]   
unionOn :: (a -> [b]) -> [a] -> [b]   

Exported datatypes:

Options

Constructors:

  • Options :: Bool -> Int -> Bool -> Int -> Int -> String -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> String -> Options

    Fields:

    • optHelp :: Bool
    • optVerb :: Int
    • optKeep :: Bool
    • optMaxTest :: Int
    • optMaxFail :: Int
    • optDefType :: String
    • optSource :: Bool
    • optProp :: Bool
    • optSpec :: Bool
    • optDet :: Bool
    • optProof :: Bool
    • optColor :: Bool
    • optMainProg :: String
Test

Constructors:

TestModule

Constructors:

  • TestModule :: String -> String -> [String] -> [Test] -> [QName] -> TestModule

    Fields:

    • orgModuleName :: String
    • testModuleName :: String
    • staticErrors :: [String]
    • propTests :: [Test]
    • generators :: [QName]

Exported operations:

maxArity :: Int   

Maximal arity of check functions and tuples currently supported:

Further infos:
  • solution complete, i.e., able to compute all solutions

ccBanner :: String   

usageText :: String   

defaultOptions :: Options   

Further infos:
  • solution complete, i.e., able to compute all solutions

options :: [OptDescr (Options -> Options)]   

processOpts :: Options -> IO Options   

Further option processing, e.g., setting coloring mode.

isQuiet :: Options -> Bool   

putStrIfNormal :: Options -> String -> IO ()   

Print second argument if verbosity level is not quiet:

putStrIfVerbose :: Options -> String -> IO ()   

Print second argument if verbosity level > 1:

putStrLnIfDebug :: Options -> String -> IO ()   

Print second argument if verbosity level > 3:

withColor :: Options -> (String -> String) -> String -> String   

use some coloring (from library AnsiCodes) if color option is on:

defTypeSuffix :: String   

Further infos:
  • solution complete, i.e., able to compute all solutions

postCondSuffix :: String   

Further infos:
  • solution complete, i.e., able to compute all solutions

satSpecSuffix :: String   

Further infos:
  • solution complete, i.e., able to compute all solutions

isDetSuffix :: String   

Further infos:
  • solution complete, i.e., able to compute all solutions

isIOTest :: Test -> Bool   

isUnitTest :: Test -> Bool   

isPropTest :: Test -> Bool   

isEquivTest :: Test -> Bool   

getTestName :: Test -> (String,String)   

Further infos:
  • solution complete, i.e., able to compute all solutions

getTestLine :: Test -> Int   

Further infos:
  • solution complete, i.e., able to compute all solutions

genTestMsg :: String -> Test -> String   

staticErrorTestMod :: String -> [String] -> TestModule   

Further infos:
  • solution complete, i.e., able to compute all solutions

testThisModule :: TestModule -> Bool   

Further infos:
  • solution complete, i.e., able to compute all solutions

userTestDataOfModule :: TestModule -> [((String,String),Bool)]   

equivPropTypes :: TestModule -> [(String,String)]   

createTests :: Options -> String -> TestModule -> [CFuncDecl]   

easyCheckConfig :: Options -> (String,String)   

type2genop :: String -> TestModule -> Bool -> CTypeExpr -> CExpr   

isFloatType :: CTypeExpr -> Bool   

typename2genopname :: String -> [(String,String)] -> Bool -> (String,String) -> (String,String)   

transQN :: String -> String   

classifyTests :: Options -> CurryProg -> [CFuncDecl] -> [Test]   

transformTests :: Options -> String -> CurryProg -> IO ([CFuncDecl],[CFuncDecl],CurryProg)   

transformDetTests :: Options -> [String] -> CurryProg -> ([CFuncDecl],[CFuncDecl],CurryProg)   

preCondOperations :: [CFuncDecl] -> [(String,String)]   

funDeclsWith :: (String -> Bool) -> [CFuncDecl] -> [CFuncDecl]   

genPostCondTest :: [(String,String)] -> [(String,String)] -> CFuncDecl -> [CFuncDecl]   

genSpecTest :: [(String,String)] -> [(String,String)] -> CFuncDecl -> [CFuncDecl]   

revertDetOpTrans :: [(String,String)] -> CFuncDecl -> CFuncDecl   

genDetOpTests :: [String] -> [(String,String)] -> [CFuncDecl] -> [CFuncDecl]   

genDetProp :: [(String,String)] -> CFuncDecl -> CFuncDecl   

poly2default :: String -> CFuncDecl -> [(Bool,CFuncDecl)]   

poly2defaultType :: String -> CTypeExpr -> CTypeExpr   

orgTestName :: (String,String) -> (String,String)   

analyseModule :: Options -> String -> IO [TestModule]   

staticProgAnalysis :: Options -> String -> String -> CurryProg -> IO ([String],[((String,String),String)])   

analyseCurryProg :: Options -> String -> CurryProg -> IO [TestModule]   

generatorsOfProg :: CurryProg -> [(String,String)]   

genBottomType :: String -> TypeDecl -> CTypeDecl   

isBasicExtType :: (String,String) -> Bool   

ctype2BotType :: String -> CTypeExpr -> CTypeExpr   

t2bt :: String -> String   

genPeval :: String -> TypeDecl -> CFuncDecl   

genPValOf :: String -> TypeDecl -> CFuncDecl   

ftype2pvalOf :: String -> String -> [(Int,String)] -> TypeExpr -> CExpr   

ctype2pvalOf :: String -> String -> CTypeExpr -> CExpr   

genMainTestModule :: Options -> String -> [TestModule] -> IO ()   

genMainFunction :: Options -> String -> [Test] -> CFuncDecl   

collectAllTestTypeDecls :: [(TypeDecl,Bool)] -> [((String,String),Bool)] -> IO [(TypeDecl,Bool)]   

createTestDataGenerator :: String -> (TypeDecl,Bool) -> CFuncDecl   

cleanup :: Options -> String -> [TestModule] -> IO ()   

showTestStatistics :: [TestModule] -> String   

main :: IO ()   

firstWord :: String -> String   

stripSuffix :: String -> String -> String   

modNameToId :: String -> String   

arityOfType :: CTypeExpr -> Int   

searchTreeModule :: String   

Name of the SearchTree module.

Further infos:
  • solution complete, i.e., able to compute all solutions

searchTreeTC :: (String,String)   

Name of SearchTree type constructor.

Further infos:
  • solution complete, i.e., able to compute all solutions

generatorModule :: String   

Name of the SearchTreeGenerator module.

Further infos:
  • solution complete, i.e., able to compute all solutions

choiceGen :: (String,String)   

Further infos:
  • solution complete, i.e., able to compute all solutions

writeCurryProgram :: Options -> String -> CurryProg -> String -> IO ()   

isPAKCS :: Bool   

containsPPOptionLine :: String -> Bool   

tconsOf :: CTypeExpr -> [(String,String)]   

unionOn :: (a -> [b]) -> [a] -> [b]