Safe Haskell	None
Language	Haskell2010

Camfort.Specification.DerivedDataType

Synopsis

infer :: ProgramFile A -> PureAnalysis String () DerivedDataTypeReport
refactor :: [ProgramFile A] -> PureAnalysis String () (DerivedDataTypeReport, [Either String (ProgramFile A)])
check :: ProgramFile A -> PureAnalysis String () DerivedDataTypeReport
synth :: Char -> [ProgramFile A] -> PureAnalysis String () (DerivedDataTypeReport, [Either String (ProgramFile A)])
compile :: () -> ModFiles -> ProgramFile A -> IO ModFile
data DerivedDataTypeReport = DerivedDataTypeReport {
- ddtrAMap :: AMap
- ddtrVMap :: VMap
- ddtrSMap :: SMap
- ddtrSpecs :: [DDTStatement]
- ddtrIDE :: Set IndexError
- ddtrCE :: ConflictErrors
- ddtrBLE :: BadLabelErrors
- ddtrBDE :: BadDimErrors
- ddtrCheck :: Bool
}
successful :: DerivedDataTypeReport -> Bool

Documentation

infer :: ProgramFile A -> PureAnalysis String () DerivedDataTypeReport Source #

Generate report about derived datatypes in given program file

refactor :: [ProgramFile A] -> PureAnalysis String () (DerivedDataTypeReport, [Either String (ProgramFile A)]) Source #

Refactor derived datatypes based on marked comments

check :: ProgramFile A -> PureAnalysis String () DerivedDataTypeReport Source #

Check annotations relating to derived datatypes in given program file

synth :: Char -> [ProgramFile A] -> PureAnalysis String () (DerivedDataTypeReport, [Either String (ProgramFile A)]) Source #

Generate and insert comments about derived datatypes

compile :: () -> ModFiles -> ProgramFile A -> IO ModFile Source #

Compile a program to a ModFile containing derived datatype information.

data DerivedDataTypeReport Source #

Collection of information comprising a 'derived datatype' report for CamFort output purposes.

Constructors

DerivedDataTypeReport
Fields ddtrAMap :: AMap ddtrVMap :: VMap ddtrSMap :: SMap ddtrSpecs :: [DDTStatement] ddtrIDE :: Set IndexError ddtrCE :: ConflictErrors ddtrBLE :: BadLabelErrors ddtrBDE :: BadDimErrors ddtrCheck :: Bool

Instances

Instances details

Generic DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Associated Types type Rep DerivedDataTypeReport :: Type -> Type # Methods from :: DerivedDataTypeReport -> Rep DerivedDataTypeReport x # to :: Rep DerivedDataTypeReport x -> DerivedDataTypeReport #
Semigroup DerivedDataTypeReport Source #	These reports can be combined, e.g. from multiple files, and the key part is that the problem reports are also combined, and new problems can be identified from the combination of the SMaps.
Instance details Defined in Camfort.Specification.DerivedDataType Methods (<>) :: DerivedDataTypeReport -> DerivedDataTypeReport -> DerivedDataTypeReport # sconcat :: NonEmpty DerivedDataTypeReport -> DerivedDataTypeReport # stimes :: Integral b => b -> DerivedDataTypeReport -> DerivedDataTypeReport #
Monoid DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Methods mempty :: DerivedDataTypeReport # mappend :: DerivedDataTypeReport -> DerivedDataTypeReport -> DerivedDataTypeReport # mconcat :: [DerivedDataTypeReport] -> DerivedDataTypeReport #
Binary DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Methods put :: DerivedDataTypeReport -> Put # get :: Get DerivedDataTypeReport # putList :: [DerivedDataTypeReport] -> Put #
NFData DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Methods rnf :: DerivedDataTypeReport -> () #
Describe DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Methods describe :: DerivedDataTypeReport -> Text Source # describeBuilder :: DerivedDataTypeReport -> Builder Source #
ExitCodeOfReport DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType Methods exitCodeOf :: DerivedDataTypeReport -> Int Source # exitCodeOfSet :: [DerivedDataTypeReport] -> Int Source #
type Rep DerivedDataTypeReport Source #
Instance details Defined in Camfort.Specification.DerivedDataType type Rep DerivedDataTypeReport

successful :: DerivedDataTypeReport -> Bool Source #

True iff no errors are reported.