Hets - the Heterogeneous Tool Set

Copyright(c) Martin Kuehl, Christian Maeder, Uni Bremen 2002-2006
LicenseGPLv2 or higher, see LICENSE.txt
MaintainerChristian.Maeder@dfki.de
Stabilityprovisional
Portabilityportable
Safe HaskellNone

Driver.Options

Description

Datatypes for options that hets understands. Useful functions to parse and check user-provided values.

Synopsis

Documentation

data HetcatsOpts

HetcatsOpts is a record of all options received from the command line

Constructors

HcOpt 

Fields

analysis :: AnaType
 
guiType :: GuiType
 
urlCatalog :: [(String, String)]
 
infiles :: [FilePath]

files to be read

specNames :: [SIMPLE_ID]

specs to be processed

transNames :: [SIMPLE_ID]

comorphism to be processed

viewNames :: [SIMPLE_ID]

views to be processed

intype :: InType
 
libdirs :: [FilePath]
 
modelSparQ :: FilePath
 
counterSparQ :: Int
 
outdir :: FilePath
 
outtypes :: [OutType]
 
xupdate :: FilePath
 
recurse :: Bool
 
verbose :: Int
 
defLogic :: String
 
defSyntax :: String
 
outputToStdout :: Bool

send messages to stdout?

caslAmalg :: [CASLAmalgOpt]
 
interactive :: Bool
 
connectP :: Int
 
connectH :: String
 
uncolored :: Bool
 
xmlFlag :: Bool
 
applyAutomatic :: Bool
 
computeNormalForm :: Bool
 
dumpOpts :: [String]
 
ioEncoding :: Enc
 
useLibPos :: Bool

use the library name in positions to avoid differences after uploads

unlit :: Bool
 
serve :: Bool
 
listen :: Int
 
whitelist :: [[String]]
 
blacklist :: [[String]]
 
runMMT :: Bool
 
fullTheories :: Bool
 
outputLogicGraph :: Bool
 
fileType :: Bool
 
accessToken :: String
 
fullSign :: Bool
 

Instances

data Flag

every Flag describes an option (see usage info)

optionArgs :: [(String, String -> Flag)]

options that require arguments for the wep-api excluding "translation"

optionFlags :: [(String, Flag)]

command line switches for the wep-api excluding non-dev-graph related ones

makeOpts :: HetcatsOpts -> Flag -> HetcatsOpts

makeOpts includes a parsed Flag in a set of HetcatsOpts

data AnaType

AnaType describes the type of analysis to be performed

Constructors

Basic 
Structured 
Skip 

Instances

data GuiType

GuiType determines if we want the GUI shown

Constructors

UseGui 
NoGui 

Instances

data InType

InType describes the type of input the infile contains

data OWLFormat

OWLFormat lists possibilities for OWL syntax (in + out)

Constructors

Manchester 
OwlXml 
RdfXml 
OBO 
Turtle 

data OutType

OutType describes the type of outputs that we want to generate

Constructors

PrettyOut PrettyType 
GraphOut GraphType 
Prf 
EnvOut 
OWLOut OWLFormat 
CLIFOut 
KIFOut 
OmdocOut 
XmlOut

development graph xml output

JsonOut

development graph json output

ExperimentalOut

for testing new functionality

HaskellOut 
FreeCADOut 
ThyFile

isabelle theory file

DfgFile SPFType

SPASS input file

TPTPFile SPFType 
ComptableXml 
RDFOut 
SigFile Delta

signature as text

TheoryFile Delta

signature with sentences as text

SymXml 
SymsXml 

Instances

data PrettyType

PrettyType describes the type of output we want the pretty-printer to generate

Instances

data GraphType

GraphType describes the type of Graph that we want generated

Constructors

Dot Bool

True means show internal node labels

Instances

data SPFType

Instances

data ATType

ATType describes distinct types of ATerms

Instances

data Delta

Instances

hetcatsOpts :: [String] -> IO HetcatsOpts

hetcatsOpts parses sensible HetcatsOpts from ARGV

isStructured :: HetcatsOpts -> Bool

check if structured analysis should be performed

guess :: String -> InType -> InType

guesses the InType

rmSuffix :: FilePath -> FilePath

remove the extension from a file

envSuffix :: String

the suffix of env files

prfSuffix :: String

the suffix of env files

removePrfOut :: HetcatsOpts -> HetcatsOpts

remove prf writing

hasEnvOut :: HetcatsOpts -> Bool

should env be written

hasPrfOut :: HetcatsOpts -> Bool

should prf be written

existsAnSource :: HetcatsOpts -> FilePath -> IO (Maybe FilePath)

checks if a source file for the given file name exists

checkRecentEnv :: HetcatsOpts -> FilePath -> FilePath -> IO Bool

gets two Paths and checks if the first file is not older than the second one and should return True for two identical files

downloadExtensions :: [String]

intypes useable for downloads

defaultHetcatsOpts :: HetcatsOpts

defaultHetcatsOpts defines the default HetcatsOpts, which are used as basic values when the user specifies nothing else

hetsVersion :: String

short version without date for ATC files

showDiags :: HetcatsOpts -> [Diagnosis] -> IO ()

show diagnostic messages (see Result.hs), according to verbosity level

showDiags1 :: HetcatsOpts -> ResultT IO a -> ResultT IO a

show diagnostic messages (see Result.hs), according to verbosity level

putIfVerbose :: HetcatsOpts -> Int -> String -> IO ()

putIfVerbose prints a given String to StdOut when the given HetcatsOpts' Verbosity exceeds the given level

doDump :: HetcatsOpts -> String -> IO () -> IO ()

checkUri :: FilePath -> Bool

check if infile is uri

useCatalogURL :: HetcatsOpts -> FilePath -> FilePath

translate a given http reference using the URL catalog

hetsIOError :: String -> IO a

print error and usage and exit with code 2