Camfort.Analysis

This module defines the AnalysisT monad transformer, which encapsulates common functionality for analyses:

• Logging via the MonadLogger class
• Early exit via failAnalysis or 'failAnalysis''
• Error recovery via catchAnalysisT or loggingAnalysisError
• Providing access to the analysis environment via analysisModFiles

Analysis monad

data AnalysisT e w m a

The analysis monad transformer. Will usually be based on Identity (see PureAnalysis) or IO.

Has error messages of type e and warnings of type w.

Instances

(Monad m, Describe e, Describe w) => MonadLogger e w (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

setDefaultSourceFile :: FilePath -> AnalysisT e w m ()

getDefaultSourceFile :: AnalysisT e w m FilePath

recordLogMessage :: SomeMessage e w -> AnalysisT e w m ()

logError :: Origin -> e -> AnalysisT e w m ()

logError' :: Spanned a => a -> e -> AnalysisT e w m ()

logWarn :: Origin -> w -> AnalysisT e w m ()

logWarn' :: Spanned a => a -> w -> AnalysisT e w m ()

logInfo :: Origin -> Text -> AnalysisT e w m ()

logInfo' :: Spanned a => a -> Text -> AnalysisT e w m ()

logInfoNoOrigin :: Text -> AnalysisT e w m ()

logDebug :: Origin -> Text -> AnalysisT e w m ()

logDebug' :: Spanned a => a -> Text -> AnalysisT e w m ()

(Describe e, Describe w, Monad m) => MonadAnalysis e w (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> AnalysisT e w m a

analysisModFiles :: AnalysisT e w m ModFiles

MonadWriter w' m => MonadWriter w' (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

writer :: (a, w') -> AnalysisT e w m a

tell :: w' -> AnalysisT e w m ()

listen :: AnalysisT e w m a -> AnalysisT e w m (a, w')

pass :: AnalysisT e w m (a, w' -> w') -> AnalysisT e w m a

MonadState s m => MonadState s (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

get :: AnalysisT e w m s

put :: s -> AnalysisT e w m ()

state :: (s -> (a, s)) -> AnalysisT e w m a

MonadReader r m => MonadReader r (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

ask :: AnalysisT e w m r

local :: (r -> r) -> AnalysisT e w m a -> AnalysisT e w m a

reader :: (r -> a) -> AnalysisT e w m a

MonadError e' m => MonadError e' (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

throwError :: e' -> AnalysisT e w m a

catchError :: AnalysisT e w m a -> (e' -> AnalysisT e w m a) -> AnalysisT e w m a

MFunctor (AnalysisT e w :: (Type -> Type) -> Type -> Type)

As per the MFunctor instance for LoggerT, a hoisted analysis cannot output logs on the fly.

Defined in Camfort.Analysis

Methods

hoist :: forall m n (b :: k). Monad m => (forall a. m a -> n a) -> AnalysisT e w m b -> AnalysisT e w n b

MonadTrans (AnalysisT e w)

Defined in Camfort.Analysis

Methods

lift :: Monad m => m a -> AnalysisT e w m a

Monad m => Monad (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

(>>=) :: AnalysisT e w m a -> (a -> AnalysisT e w m b) -> AnalysisT e w m b

(>>) :: AnalysisT e w m a -> AnalysisT e w m b -> AnalysisT e w m b

return :: a -> AnalysisT e w m a

Functor m => Functor (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

fmap :: (a -> b) -> AnalysisT e w m a -> AnalysisT e w m b

(<$) :: a -> AnalysisT e w m b -> AnalysisT e w m a

MonadFail m => MonadFail (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

fail :: String -> AnalysisT e w m a

Monad m => Applicative (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

pure :: a -> AnalysisT e w m a

(<*>) :: AnalysisT e w m (a -> b) -> AnalysisT e w m a -> AnalysisT e w m b

liftA2 :: (a -> b -> c) -> AnalysisT e w m a -> AnalysisT e w m b -> AnalysisT e w m c

(*>) :: AnalysisT e w m a -> AnalysisT e w m b -> AnalysisT e w m b

(<*) :: AnalysisT e w m a -> AnalysisT e w m b -> AnalysisT e w m a

MonadIO m => MonadIO (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

liftIO :: IO a -> AnalysisT e w m a

type PureAnalysis e w = AnalysisT e w Identity

A pure analysis computation which cannot do any IO.

Combinators

mapAnalysisT :: Monad m => (e -> e') -> (w -> w') -> AnalysisT e w m a -> AnalysisT e' w' m a

Change the error and warning types in an analysis. To change the underlying monad use hoist.

generalizePureAnalysis :: Monad m => PureAnalysis e w a -> AnalysisT e w m a

Given a pure analysis action, it can be generalized to run in any Monad. Since the original analysis was pure, it could not have logged anything as it ran. The new analysis cannot log anything as it runs either, even it is based on IO.

class MonadLogger e w m => MonadAnalysis e w m where

Minimal complete definition

Nothing

Methods

failAnalysis :: Origin -> e -> m a

Report a critical error in the analysis at a particular source location and exit early.

default failAnalysis :: (MonadTrans t, MonadAnalysis e w m', m ~ t m') => Origin -> e -> m a

analysisModFiles :: m ModFiles

Get the ModFiles from the analysis environment.

default analysisModFiles :: (MonadTrans t, MonadAnalysis e w m', m ~ t m') => m ModFiles

Instances

MonadAnalysis e w m => MonadAnalysis e w (StateT s m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> StateT s m a

analysisModFiles :: StateT s m ModFiles

(MonadAnalysis e w m, Monoid w') => MonadAnalysis e w (WriterT w' m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> WriterT w' m a

analysisModFiles :: WriterT w' m ModFiles

MonadAnalysis e w m => MonadAnalysis e w (StateT s m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> StateT s m a

analysisModFiles :: StateT s m ModFiles

MonadAnalysis e w m => MonadAnalysis e w (ExceptT e' m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> ExceptT e' m a

analysisModFiles :: ExceptT e' m ModFiles

MonadAnalysis e w m => MonadAnalysis e w (ReaderT r m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> ReaderT r m a

analysisModFiles :: ReaderT r m ModFiles

(Describe e, Describe w, Monad m) => MonadAnalysis e w (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> AnalysisT e w m a

analysisModFiles :: AnalysisT e w m ModFiles

(MonadAnalysis e w m, Monoid w') => MonadAnalysis e w (RWST r w' s m)

Defined in Camfort.Analysis

Methods

failAnalysis :: Origin -> e -> RWST r w' s m a

analysisModFiles :: RWST r w' s m ModFiles

failAnalysis' :: (MonadAnalysis e w m, Spanned o) => o -> e -> m a

Report a critical failure in the analysis at no particular source location and exit early.

catchAnalysisT :: Monad m => (LogMessage e -> AnalysisT e w m a) -> AnalysisT e w m a -> AnalysisT e w m a

Run the given analysis and recover with the given handler function if it fails.

loggingAnalysisError :: (Monad m, Describe w, Describe e) => AnalysisT e w m a -> AnalysisT e w m (Maybe a)

Run the given analysis. If it succeeds, return its result value. Otherwise, log the error it creates and return Nothing.

This allows errors in analysis sub-programs to be collected rather than halting the entire analysis.

analysisLiftLogger :: (Monad m, Describe w, Describe e) => LoggerT e w m a -> AnalysisT e w m a

Given a logging computation, lift it into an analysis monad.

Analysis results

data AnalysisResult e r

Constructors

ARFailure Origin e

ARSuccess r

Instances

Functor (AnalysisResult e)

Defined in Camfort.Analysis

Methods

fmap :: (a -> b) -> AnalysisResult e a -> AnalysisResult e b

(<$) :: a -> AnalysisResult e b -> AnalysisResult e a

(Eq e, Eq r) => Eq (AnalysisResult e r)

Defined in Camfort.Analysis

Methods

(==) :: AnalysisResult e r -> AnalysisResult e r -> Bool

(/=) :: AnalysisResult e r -> AnalysisResult e r -> Bool

(Show e, Show r) => Show (AnalysisResult e r)

Defined in Camfort.Analysis

Methods

showsPrec :: Int -> AnalysisResult e r -> ShowS

show :: AnalysisResult e r -> String

showList :: [AnalysisResult e r] -> ShowS

Generic (AnalysisResult e r)

Defined in Camfort.Analysis

Associated Types

type Rep (AnalysisResult e r) :: Type -> Type

Methods

from :: AnalysisResult e r -> Rep (AnalysisResult e r) x

to :: Rep (AnalysisResult e r) x -> AnalysisResult e r

(NFData e, NFData r) => NFData (AnalysisResult e r)

Defined in Camfort.Analysis

Methods

rnf :: AnalysisResult e r -> ()

type Rep (AnalysisResult e r)

Defined in Camfort.Analysis

type Rep (AnalysisResult e r) = D1 ('MetaData "AnalysisResult" "Camfort.Analysis" "camfort-1.0.1-inplace" 'False) (C1 ('MetaCons "ARFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Origin) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 e)) :+: C1 ('MetaCons "ARSuccess" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 r)))

_ARFailure :: forall e r e. Prism (AnalysisResult e r) (AnalysisResult e r) (Origin, e) (Origin, e)

_ARSuccess :: forall e r r. Prism (AnalysisResult e r) (AnalysisResult e r) r r

data AnalysisReport e w r

When an analysis is run, it produces a report consisting of the logs it collect as it ran. In addition, it either fails at a certain location or succeeds with a result value.

Constructors

AnalysisReport

Fields

• _arSourceFile :: !FilePath
• _arMessages :: ![SomeMessage e w]
• _arResult :: !(AnalysisResult e r)

Instances

Functor (AnalysisReport e w)

Defined in Camfort.Analysis

Methods

fmap :: (a -> b) -> AnalysisReport e w a -> AnalysisReport e w b

(<$) :: a -> AnalysisReport e w b -> AnalysisReport e w a

(Eq e, Eq w, Eq r) => Eq (AnalysisReport e w r)

Defined in Camfort.Analysis

Methods

(==) :: AnalysisReport e w r -> AnalysisReport e w r -> Bool

(/=) :: AnalysisReport e w r -> AnalysisReport e w r -> Bool

(Show e, Show w, Show r) => Show (AnalysisReport e w r)

Defined in Camfort.Analysis

Methods

showsPrec :: Int -> AnalysisReport e w r -> ShowS

show :: AnalysisReport e w r -> String

showList :: [AnalysisReport e w r] -> ShowS

Generic (AnalysisReport e w r)

Defined in Camfort.Analysis

Associated Types

type Rep (AnalysisReport e w r) :: Type -> Type

Methods

from :: AnalysisReport e w r -> Rep (AnalysisReport e w r) x

to :: Rep (AnalysisReport e w r) x -> AnalysisReport e w r

(NFData e, NFData w, NFData r) => NFData (AnalysisReport e w r)

Defined in Camfort.Analysis

Methods

rnf :: AnalysisReport e w r -> ()

ExitCodeOfReport r => ExitCodeOfReport (AnalysisReport e w r)

Defined in Camfort.Analysis

Methods

exitCodeOf :: AnalysisReport e w r -> Int

exitCodeOfSet :: [AnalysisReport e w r] -> Int

type Rep (AnalysisReport e w r)

Defined in Camfort.Analysis

type Rep (AnalysisReport e w r) = D1 ('MetaData "AnalysisReport" "Camfort.Analysis" "camfort-1.0.1-inplace" 'False) (C1 ('MetaCons "AnalysisReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "_arSourceFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "_arMessages") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [SomeMessage e w]) :*: S1 ('MetaSel ('Just "_arResult") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AnalysisResult e r)))))

arMessages :: forall e w r w. Lens (AnalysisReport e w r) (AnalysisReport e w r) [SomeMessage e w] [SomeMessage e w]

arResult :: forall e w r r. Lens (AnalysisReport e w r) (AnalysisReport e w r) (AnalysisResult e r) (AnalysisResult e r)

describeReport :: (Describe e, Describe w, Describe r) => Text -> Maybe LogLevel -> AnalysisReport e w r -> Text

Produce a human-readable version of an AnalysisReport, at the given verbosity level. Giving Nothing for the log level hides all logs.

putDescribeReport :: (Describe e, Describe w, Describe r, MonadIO m) => Text -> Maybe LogLevel -> Bool -> AnalysisReport e w r -> m ()

Running analyses

runAnalysisT

Arguments

:: (Monad m, Describe e, Describe w)

=> FilePath

The name of the file the analysis is being run on. This is only used for logging.

-> LogOutput m

The logging output function, e.g. logOutputStd for standard output or logOutputNone for no output.

-> LogLevel

The logging verbosity level.

-> ModFiles

The list of analysis modfiles.

-> AnalysisT e w m a

The analysis transformer to run.

-> m (AnalysisReport e w a)

Run an analysis computation and collect the report.

Logging

See Camfort.Analysis.Logger for more detailed documentation.

class Monad m => MonadLogger e w m | m -> e w where

MTL-style type class for monads that support logging.

Minimal complete definition

Nothing

Methods

logError :: Origin -> e -> m ()

Log an error message at the given Origin.

logError' :: Spanned a => a -> e -> m ()

Log an error message. The origin is the current default source file, with the source span of the given piece of Fortran syntax.

logWarn :: Origin -> w -> m ()

Log a warning message at the given Origin.

logWarn' :: Spanned a => a -> w -> m ()

Log a warning message. The origin is the current default source file, with the source span of the given piece of Fortran syntax.

logInfo :: Origin -> Text -> m ()

Log an information message at the given Origin.

logInfo' :: Spanned a => a -> Text -> m ()

Log an information message. The origin is the current default source file, with the source span of the given piece of Fortran syntax.

logInfoNoOrigin :: Text -> m ()

Log an information message with no origin. For example, use this when printing output about the progress of an analysis which cannot be associated with a particular bit of source code.

logDebug :: Origin -> Text -> m ()

Log a debugging message at the given Origin.

logDebug' :: Spanned a => a -> Text -> m ()

Log a debugging message. The origin is the current default source file, with the source span of the given piece of Fortran syntax.

Instances

MonadLogger e w m => MonadLogger e w (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

setDefaultSourceFile :: FilePath -> TranslateT m ()

getDefaultSourceFile :: TranslateT m FilePath

recordLogMessage :: SomeMessage e w -> TranslateT m ()

logError :: Origin -> e -> TranslateT m ()

logError' :: Spanned a => a -> e -> TranslateT m ()

logWarn :: Origin -> w -> TranslateT m ()

logWarn' :: Spanned a => a -> w -> TranslateT m ()

logInfo :: Origin -> Text -> TranslateT m ()

logInfo' :: Spanned a => a -> Text -> TranslateT m ()

logInfoNoOrigin :: Text -> TranslateT m ()

logDebug :: Origin -> Text -> TranslateT m ()

logDebug' :: Spanned a => a -> Text -> TranslateT m ()

MonadLogger e w m => MonadLogger e w (StateT s m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> StateT s m ()

getDefaultSourceFile :: StateT s m FilePath

recordLogMessage :: SomeMessage e w -> StateT s m ()

logError :: Origin -> e -> StateT s m ()

logError' :: Spanned a => a -> e -> StateT s m ()

logWarn :: Origin -> w -> StateT s m ()

logWarn' :: Spanned a => a -> w -> StateT s m ()

logInfo :: Origin -> Text -> StateT s m ()

logInfo' :: Spanned a => a -> Text -> StateT s m ()

logInfoNoOrigin :: Text -> StateT s m ()

logDebug :: Origin -> Text -> StateT s m ()

logDebug' :: Spanned a => a -> Text -> StateT s m ()

(MonadLogger e w m, Monoid w') => MonadLogger e w (WriterT w' m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> WriterT w' m ()

getDefaultSourceFile :: WriterT w' m FilePath

recordLogMessage :: SomeMessage e w -> WriterT w' m ()

logError :: Origin -> e -> WriterT w' m ()

logError' :: Spanned a => a -> e -> WriterT w' m ()

logWarn :: Origin -> w -> WriterT w' m ()

logWarn' :: Spanned a => a -> w -> WriterT w' m ()

logInfo :: Origin -> Text -> WriterT w' m ()

logInfo' :: Spanned a => a -> Text -> WriterT w' m ()

logInfoNoOrigin :: Text -> WriterT w' m ()

logDebug :: Origin -> Text -> WriterT w' m ()

logDebug' :: Spanned a => a -> Text -> WriterT w' m ()

MonadLogger e w m => MonadLogger e w (StateT s m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> StateT s m ()

getDefaultSourceFile :: StateT s m FilePath

recordLogMessage :: SomeMessage e w -> StateT s m ()

logError :: Origin -> e -> StateT s m ()

logError' :: Spanned a => a -> e -> StateT s m ()

logWarn :: Origin -> w -> StateT s m ()

logWarn' :: Spanned a => a -> w -> StateT s m ()

logInfo :: Origin -> Text -> StateT s m ()

logInfo' :: Spanned a => a -> Text -> StateT s m ()

logInfoNoOrigin :: Text -> StateT s m ()

logDebug :: Origin -> Text -> StateT s m ()

logDebug' :: Spanned a => a -> Text -> StateT s m ()

MonadLogger e w m => MonadLogger e w (ExceptT e' m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> ExceptT e' m ()

getDefaultSourceFile :: ExceptT e' m FilePath

recordLogMessage :: SomeMessage e w -> ExceptT e' m ()

logError :: Origin -> e -> ExceptT e' m ()

logError' :: Spanned a => a -> e -> ExceptT e' m ()

logWarn :: Origin -> w -> ExceptT e' m ()

logWarn' :: Spanned a => a -> w -> ExceptT e' m ()

logInfo :: Origin -> Text -> ExceptT e' m ()

logInfo' :: Spanned a => a -> Text -> ExceptT e' m ()

logInfoNoOrigin :: Text -> ExceptT e' m ()

logDebug :: Origin -> Text -> ExceptT e' m ()

logDebug' :: Spanned a => a -> Text -> ExceptT e' m ()

MonadLogger e w m => MonadLogger e w (ReaderT r m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> ReaderT r m ()

getDefaultSourceFile :: ReaderT r m FilePath

recordLogMessage :: SomeMessage e w -> ReaderT r m ()

logError :: Origin -> e -> ReaderT r m ()

logError' :: Spanned a => a -> e -> ReaderT r m ()

logWarn :: Origin -> w -> ReaderT r m ()

logWarn' :: Spanned a => a -> w -> ReaderT r m ()

logInfo :: Origin -> Text -> ReaderT r m ()

logInfo' :: Spanned a => a -> Text -> ReaderT r m ()

logInfoNoOrigin :: Text -> ReaderT r m ()

logDebug :: Origin -> Text -> ReaderT r m ()

logDebug' :: Spanned a => a -> Text -> ReaderT r m ()

(Monad m, Describe e, Describe w) => MonadLogger e w (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> LoggerT e w m ()

getDefaultSourceFile :: LoggerT e w m FilePath

recordLogMessage :: SomeMessage e w -> LoggerT e w m ()

logError :: Origin -> e -> LoggerT e w m ()

logError' :: Spanned a => a -> e -> LoggerT e w m ()

logWarn :: Origin -> w -> LoggerT e w m ()

logWarn' :: Spanned a => a -> w -> LoggerT e w m ()

logInfo :: Origin -> Text -> LoggerT e w m ()

logInfo' :: Spanned a => a -> Text -> LoggerT e w m ()

logInfoNoOrigin :: Text -> LoggerT e w m ()

logDebug :: Origin -> Text -> LoggerT e w m ()

logDebug' :: Spanned a => a -> Text -> LoggerT e w m ()

(Monad m, Describe e, Describe w) => MonadLogger e w (AnalysisT e w m)

Defined in Camfort.Analysis

Methods

setDefaultSourceFile :: FilePath -> AnalysisT e w m ()

getDefaultSourceFile :: AnalysisT e w m FilePath

recordLogMessage :: SomeMessage e w -> AnalysisT e w m ()

logError :: Origin -> e -> AnalysisT e w m ()

logError' :: Spanned a => a -> e -> AnalysisT e w m ()

logWarn :: Origin -> w -> AnalysisT e w m ()

logWarn' :: Spanned a => a -> w -> AnalysisT e w m ()

logInfo :: Origin -> Text -> AnalysisT e w m ()

logInfo' :: Spanned a => a -> Text -> AnalysisT e w m ()

logInfoNoOrigin :: Text -> AnalysisT e w m ()

logDebug :: Origin -> Text -> AnalysisT e w m ()

logDebug' :: Spanned a => a -> Text -> AnalysisT e w m ()

(MonadLogger e w m, Monoid w') => MonadLogger e w (RWST r w' s m)

Defined in Camfort.Analysis.Logger

Methods

setDefaultSourceFile :: FilePath -> RWST r w' s m ()

getDefaultSourceFile :: RWST r w' s m FilePath

recordLogMessage :: SomeMessage e w -> RWST r w' s m ()

logError :: Origin -> e -> RWST r w' s m ()

logError' :: Spanned a => a -> e -> RWST r w' s m ()

logWarn :: Origin -> w -> RWST r w' s m ()

logWarn' :: Spanned a => a -> w -> RWST r w' s m ()

logInfo :: Origin -> Text -> RWST r w' s m ()

logInfo' :: Spanned a => a -> Text -> RWST r w' s m ()

logInfoNoOrigin :: Text -> RWST r w' s m ()

logDebug :: Origin -> Text -> RWST r w' s m ()

logDebug' :: Spanned a => a -> Text -> RWST r w' s m ()

Message origins

data Origin

A message origin, containing a file and a source span.

Constructors

Origin

Fields

• _oFile :: FilePath
• _oSpan :: SrcSpan

Instances

Eq Origin

Defined in Camfort.Analysis.Logger

Methods

(==) :: Origin -> Origin -> Bool

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

Ord Origin

Defined in Camfort.Analysis.Logger

Methods

compare :: Origin -> Origin -> Ordering

(<) :: Origin -> Origin -> Bool

(<=) :: Origin -> Origin -> Bool

(>) :: Origin -> Origin -> Bool

(>=) :: Origin -> Origin -> Bool

max :: Origin -> Origin -> Origin

min :: Origin -> Origin -> Origin

Show Origin

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

Generic Origin

Defined in Camfort.Analysis.Logger

Associated Types

type Rep Origin :: Type -> Type

Methods

from :: Origin -> Rep Origin x

to :: Rep Origin x -> Origin

NFData Origin

Defined in Camfort.Analysis.Logger

Methods

rnf :: Origin -> ()

Describe Origin

Defined in Camfort.Analysis.Logger

Methods

describe :: Origin -> Text

describeBuilder :: Origin -> Builder

type Rep Origin

Defined in Camfort.Analysis.Logger

type Rep Origin = D1 ('MetaData "Origin" "Camfort.Analysis.Logger" "camfort-1.0.1-inplace" 'False) (C1 ('MetaCons "Origin" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "_oSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SrcSpan)))

atSpanned :: (MonadLogger e w m, Spanned a) => a -> m Origin

Make an origin at the source span of a piece of Fortran syntax, in the current file.

atSpannedInFile :: Spanned a => FilePath -> a -> Origin

Make an origin at the source span of a piece of Fortran syntax, in the given file.

Log outputs

data LogOutput m

A function to output logs in a particular monad m.

logOutputStd

Arguments

:: MonadIO m

=> Bool

If True, print more concise output when message origin is repeated.

-> LogOutput m

Output logs to standard output (i.e. the console).

logOutputNone

Arguments

:: Monad m

=> Bool

If True, print more concise output when message origin is repeated.

-> LogOutput m

Output no logs.

Log levels

data LogLevel

A logging level. At each logging level, only produce output at that level or lower.

Constructors

LogError

At level LogError, only error messages are shown.

LogWarn

At level LogWarn, error and warning messages are shown.

LogInfo

At level LogInfo, error, warning and information messages are shown.

LogDebug

At level LogDebug, error, warning, information and debug output is shown.

Instances

Eq LogLevel

Defined in Camfort.Analysis.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Defined in Camfort.Analysis.Logger

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Show LogLevel

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Describe LogLevel

Defined in Camfort.Analysis.Logger

Methods

describe :: LogLevel -> Text

describeBuilder :: LogLevel -> Builder

Describe class

class Describe a where

A type class for efficiently converting values to human-readable output. Can be automatically instantiated for Show types, but this will not be very human-readable for a lot of types.

Minimal complete definition

Nothing

Methods

describe :: a -> Text

Convert the value to a human-readable output as a strict Text value.

describeBuilder :: a -> Builder

Convert the value to human-readable output in a text Builder which can be efficiently concatenated with other Builders.

default describeBuilder :: Show a => a -> Builder

Instances

Describe Double

Defined in Camfort.Analysis.Logger

Methods

describe :: Double -> Text

describeBuilder :: Double -> Builder

Describe Float

Defined in Camfort.Analysis.Logger

Methods

describe :: Float -> Text

describeBuilder :: Float -> Builder

Describe Int

Defined in Camfort.Analysis.Logger

Methods

describe :: Int -> Text

describeBuilder :: Int -> Builder

Describe Integer

Defined in Camfort.Analysis.Logger

Methods

describe :: Integer -> Text

describeBuilder :: Integer -> Builder

Describe ()

Defined in Camfort.Analysis.Logger

Methods

describe :: () -> Text

describeBuilder :: () -> Builder

Describe Void

Defined in Camfort.Analysis.Logger

Methods

describe :: Void -> Text

describeBuilder :: Void -> Builder

Describe Text

Defined in Camfort.Analysis.Logger

Methods

describe :: Text -> Text

describeBuilder :: Text -> Builder

Describe SrcSpan

Defined in Camfort.Analysis.Logger

Methods

describe :: SrcSpan -> Text

describeBuilder :: SrcSpan -> Builder

Describe Origin

Defined in Camfort.Analysis.Logger

Methods

describe :: Origin -> Text

describeBuilder :: Origin -> Builder

Describe LogLevel

Defined in Camfort.Analysis.Logger

Methods

describe :: LogLevel -> Text

describeBuilder :: LogLevel -> Builder

Describe ImplicitNoneReport

Defined in Camfort.Analysis.Simple

Methods

describe :: ImplicitNoneReport -> Text

describeBuilder :: ImplicitNoneReport -> Builder

Describe DerivedDataTypeReport

Defined in Camfort.Specification.DerivedDataType

Methods

describe :: DerivedDataTypeReport -> Text

describeBuilder :: DerivedDataTypeReport -> Builder

Describe CheckResult

Defined in Camfort.Specification.Stencils.CheckFrontend

Methods

describe :: CheckResult -> Text

describeBuilder :: CheckResult -> Builder

Describe StencilsReport

Defined in Camfort.Specification.Stencils.InferenceFrontend

Methods

describe :: StencilsReport -> Text

describeBuilder :: StencilsReport -> Builder

Describe ConsistencyError

Defined in Camfort.Specification.Units.Analysis.Consistent

Methods

describe :: ConsistencyError -> Text

describeBuilder :: ConsistencyError -> Builder

Describe ConsistencyReport

Defined in Camfort.Specification.Units.Analysis.Consistent

Methods

describe :: ConsistencyReport -> Text

describeBuilder :: ConsistencyReport -> Builder

Describe InferenceResult

Defined in Camfort.Specification.Units.Analysis.Infer

Methods

describe :: InferenceResult -> Text

describeBuilder :: InferenceResult -> Builder

Describe InferenceReport

Defined in Camfort.Specification.Units.Analysis.Infer

Methods

describe :: InferenceReport -> Text

describeBuilder :: InferenceReport -> Builder

Describe TranslateError

Defined in Language.Fortran.Model.Translate

Methods

describe :: TranslateError -> Text

describeBuilder :: TranslateError -> Builder

Describe HoareCheckResult

Defined in Camfort.Specification.Hoare.CheckBackend

Methods

describe :: HoareCheckResult -> Text

describeBuilder :: HoareCheckResult -> Builder

Describe HoareBackendError

Defined in Camfort.Specification.Hoare.CheckBackend

Methods

describe :: HoareBackendError -> Text

describeBuilder :: HoareBackendError -> Builder

Describe HoareFrontendWarning

Defined in Camfort.Specification.Hoare.CheckFrontend

Methods

describe :: HoareFrontendWarning -> Text

describeBuilder :: HoareFrontendWarning -> Builder

Describe HoareFrontendError

Defined in Camfort.Specification.Hoare.CheckFrontend

Methods

describe :: HoareFrontendError -> Text

describeBuilder :: HoareFrontendError -> Builder

Describe HoareCheckResults

Defined in Camfort.Specification.Hoare

Methods

describe :: HoareCheckResults -> Text

describeBuilder :: HoareCheckResults -> Builder

Describe [Char]

Defined in Camfort.Analysis.Logger

Methods

describe :: [Char] -> Text

describeBuilder :: [Char] -> Builder

Describe a => Describe (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

describe :: LogMessage a -> Text

describeBuilder :: LogMessage a -> Builder

(Describe e, Describe w) => Describe (SomeMessage e w)

Defined in Camfort.Analysis.Logger

Methods

describe :: SomeMessage e w -> Text

describeBuilder :: SomeMessage e w -> Builder

describeShow :: Show a => a -> Text

Convert a Show-able value directly to strict Text. Useful when you have a Show instance but not a Describe instance.

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.

>>> [1,2,3] <> [4,5,6]
[1,2,3,4,5,6]

Exit Code of reports

class ExitCodeOfReport a where

Minimal complete definition

Nothing

Methods

exitCodeOf :: a -> Int

Interpret an exit code from report (default 0)

exitCodeOfSet :: [a] -> Int

Interpret an exit code from a set of reports (default: maximises absolute value)

Instances

ExitCodeOfReport ()

Defined in Camfort.Analysis

Methods

exitCodeOf :: () -> Int

exitCodeOfSet :: [()] -> Int

ExitCodeOfReport Text

Defined in Camfort.Analysis

Methods

exitCodeOf :: Text -> Int

exitCodeOfSet :: [Text] -> Int

ExitCodeOfReport ImplicitNoneReport

Defined in Camfort.Analysis.Simple

Methods

exitCodeOf :: ImplicitNoneReport -> Int

exitCodeOfSet :: [ImplicitNoneReport] -> Int

ExitCodeOfReport DerivedDataTypeReport

Defined in Camfort.Specification.DerivedDataType

Methods

exitCodeOf :: DerivedDataTypeReport -> Int

exitCodeOfSet :: [DerivedDataTypeReport] -> Int

ExitCodeOfReport ConsistencyResult

Defined in Camfort.Specification.Stencils.Consistency

Methods

exitCodeOf :: ConsistencyResult -> Int

exitCodeOfSet :: [ConsistencyResult] -> Int

ExitCodeOfReport CheckResult

Defined in Camfort.Specification.Stencils.CheckFrontend

Methods

exitCodeOf :: CheckResult -> Int

exitCodeOfSet :: [CheckResult] -> Int

ExitCodeOfReport StencilsReport

Defined in Camfort.Specification.Stencils.InferenceFrontend

Methods

exitCodeOf :: StencilsReport -> Int

exitCodeOfSet :: [StencilsReport] -> Int

ExitCodeOfReport ConsistencyReport

Defined in Camfort.Specification.Units.Analysis.Consistent

Methods

exitCodeOf :: ConsistencyReport -> Int

exitCodeOfSet :: [ConsistencyReport] -> Int

ExitCodeOfReport InferenceResult

Defined in Camfort.Specification.Units.Analysis.Infer

Methods

exitCodeOf :: InferenceResult -> Int

exitCodeOfSet :: [InferenceResult] -> Int

ExitCodeOfReport HoareCheckResult

Defined in Camfort.Specification.Hoare.CheckBackend

Methods

exitCodeOf :: HoareCheckResult -> Int

exitCodeOfSet :: [HoareCheckResult] -> Int

ExitCodeOfReport HoareCheckResults

Defined in Camfort.Specification.Hoare

Methods

exitCodeOf :: HoareCheckResults -> Int

exitCodeOfSet :: [HoareCheckResults] -> Int

ExitCodeOfReport r => ExitCodeOfReport (AnalysisReport e w r)

Defined in Camfort.Analysis

Methods

exitCodeOf :: AnalysisReport e w r -> Int

exitCodeOfSet :: [AnalysisReport e w r] -> Int