Camfort.Analysis.Logger

Provides logging for analyses. MonadLogger is a type class for monads which support logging. LoggerT is a concrete monad transformer instantiating the class.

As a logger runs, it may print out log messages on the fly (depending on the provided LogOutput function). It also collects logs to be inspected at the end of the computation.

A log message must usually include an Origin, which describes where in a Fortran source file the message originated. This is made more convenient via functions such as 'logWarn'', which produces an Origin based on a piece of Fortran syntax, along with a default source file stored in the environment.

Log messages each come with an associated LogLevel:

• LogError is for hard errors which will often cause the computation to fail.
• LogWarn is for messages about things that are likely to cause problems.
• LogInfo is for general information about what the computation is doing.
• LogDebug is for extra-verbose output that helps with debugging, but which will be uninteresting to most users.

Conversion to text description

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 Void

Defined in Camfort.Analysis.Logger

Methods

describe :: Void -> Text

describeBuilder :: Void -> Builder

Describe LogLevel

Defined in Camfort.Analysis.Logger

Methods

describe :: LogLevel -> Text

describeBuilder :: LogLevel -> Builder

Describe Origin

Defined in Camfort.Analysis.Logger

Methods

describe :: Origin -> Text

describeBuilder :: Origin -> 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 HoareCheckResults

Defined in Camfort.Specification.Hoare

Methods

describe :: HoareCheckResults -> Text

describeBuilder :: HoareCheckResults -> Builder

Describe HoareBackendError

Defined in Camfort.Specification.Hoare.CheckBackend

Methods

describe :: HoareBackendError -> Text

describeBuilder :: HoareBackendError -> Builder

Describe HoareCheckResult

Defined in Camfort.Specification.Hoare.CheckBackend

Methods

describe :: HoareCheckResult -> Text

describeBuilder :: HoareCheckResult -> Builder

Describe HoareFrontendError

Defined in Camfort.Specification.Hoare.CheckFrontend

Methods

describe :: HoareFrontendError -> Text

describeBuilder :: HoareFrontendError -> Builder

Describe HoareFrontendWarning

Defined in Camfort.Specification.Hoare.CheckFrontend

Methods

describe :: HoareFrontendWarning -> Text

describeBuilder :: HoareFrontendWarning -> 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 InferenceReport

Defined in Camfort.Specification.Units.Analysis.Infer

Methods

describe :: InferenceReport -> Text

describeBuilder :: InferenceReport -> Builder

Describe InferenceResult

Defined in Camfort.Specification.Units.Analysis.Infer

Methods

describe :: InferenceResult -> Text

describeBuilder :: InferenceResult -> Builder

Describe TranslateError

Defined in Language.Fortran.Model.Translate

Methods

describe :: TranslateError -> Text

describeBuilder :: TranslateError -> Builder

Describe SrcSpan

Defined in Camfort.Analysis.Logger

Methods

describe :: SrcSpan -> Text

describeBuilder :: SrcSpan -> Builder

Describe Text

Defined in Camfort.Analysis.Logger

Methods

describe :: Text -> Text

describeBuilder :: Text -> 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 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 a => Describe (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

describe :: LogMessage a -> Text

describeBuilder :: LogMessage a -> Builder

Describe [Char]

Defined in Camfort.Analysis.Logger

Methods

describe :: [Char] -> Text

describeBuilder :: [Char] -> 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

tellDescribe :: (MonadWriter Builder m, Describe a) => a -> m ()

Write a Describe-able value directly into a writer monad.

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.

builderToStrict :: Builder -> Text

A convenience combinator to directly convert a lazy text Builder to a strict Text value.

data Builder

A Builder is an efficient way to build lazy Text values. There are several functions for constructing builders, but only one to inspect them: to extract any data, you have to turn them into lazy Text values using toLazyText.

Internally, a builder constructs a lazy Text by filling arrays piece by piece. As each buffer is filled, it is 'popped' off, to become a new chunk of the resulting lazy Text. All this is hidden from the user of the Builder.

Instances

IsString Builder

Performs replacement on invalid scalar values:

>>> :set -XOverloadedStrings
>>> "\55555" :: Builder
"\65533"

Defined in Data.Text.Internal.Builder

Methods

fromString :: String -> Builder

Monoid Builder

Defined in Data.Text.Internal.Builder

Methods

mempty :: Builder

mappend :: Builder -> Builder -> Builder

mconcat :: [Builder] -> Builder

Semigroup Builder

Defined in Data.Text.Internal.Builder

Methods

(<>) :: Builder -> Builder -> Builder

sconcat :: NonEmpty Builder -> Builder

stimes :: Integral b => b -> Builder -> Builder

Show Builder

Defined in Data.Text.Internal.Builder

Methods

showsPrec :: Int -> Builder -> ShowS

show :: Builder -> String

showList :: [Builder] -> ShowS

Eq Builder

Defined in Data.Text.Internal.Builder

Methods

(==) :: Builder -> Builder -> Bool

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

Ord Builder

Defined in Data.Text.Internal.Builder

Methods

compare :: Builder -> Builder -> Ordering

(<) :: Builder -> Builder -> Bool

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

(>) :: Builder -> Builder -> Bool

(>=) :: Builder -> Builder -> Bool

max :: Builder -> Builder -> Builder

min :: Builder -> Builder -> Builder

data Text

A space efficient, packed, unboxed Unicode text type.

Instances

ExitCodeOfReport Text

Defined in Camfort.Analysis

Methods

exitCodeOf :: Text -> Int

exitCodeOfSet :: [Text] -> Int

Describe Text

Defined in Camfort.Analysis.Logger

Methods

describe :: Text -> Text

describeBuilder :: Text -> Builder

Hashable Text

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> Text -> Int

hash :: Text -> Int

Ixed Text

Defined in Control.Lens.At

Methods

ix :: Index Text -> Traversal' Text (IxValue Text)

AsEmpty Text

Defined in Control.Lens.Empty

Methods

_Empty :: Prism' Text ()

Reversing Text

Defined in Control.Lens.Internal.Iso

Methods

reversing :: Text -> Text

Prefixed Text

Defined in Control.Lens.Prism

Methods

prefixed :: Text -> Prism' Text Text

Suffixed Text

Defined in Control.Lens.Prism

Methods

suffixed :: Text -> Prism' Text Text

Cons Text Text Char Char

Defined in Control.Lens.Cons

Methods

_Cons :: Prism Text Text (Char, Text) (Char, Text)

Snoc Text Text Char Char

Defined in Control.Lens.Cons

Methods

_Snoc :: Prism Text Text (Text, Char) (Text, Char)

(a ~ Char, b ~ Char) => Each Text Text a b

each :: Traversal Text Text Char Char

Defined in Control.Lens.Each

Methods

each :: Traversal Text Text a b

type Item Text

Defined in Data.Text

type Item Text = Char

type Index Text

Defined in Control.Lens.At

type Index Text = Int

type IxValue Text

Defined in Control.Lens.At

type IxValue Text = Char

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

An associative operation.

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

Messages

data Origin

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

Constructors

Origin

Fields

• _oFile :: FilePath
• _oSpan :: SrcSpan

Instances

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

Show Origin

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

Describe Origin

Defined in Camfort.Analysis.Logger

Methods

describe :: Origin -> Text

describeBuilder :: Origin -> Builder

NFData Origin

Defined in Camfort.Analysis.Logger

Methods

rnf :: Origin -> ()

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

type Rep Origin

Defined in Camfort.Analysis.Logger

type Rep Origin = D1 ('MetaData "Origin" "Camfort.Analysis.Logger" "camfort-1.2.0-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)))

data ParsedOrigin

Constructors

ParsedOrigin FilePath (Int, Int) (Int, Int)

Instances

Show ParsedOrigin

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> ParsedOrigin -> ShowS

show :: ParsedOrigin -> String

showList :: [ParsedOrigin] -> ShowS

Eq ParsedOrigin

Defined in Camfort.Analysis.Logger

Methods

(==) :: ParsedOrigin -> ParsedOrigin -> Bool

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

Ord ParsedOrigin

Defined in Camfort.Analysis.Logger

Methods

compare :: ParsedOrigin -> ParsedOrigin -> Ordering

(<) :: ParsedOrigin -> ParsedOrigin -> Bool

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

(>) :: ParsedOrigin -> ParsedOrigin -> Bool

(>=) :: ParsedOrigin -> ParsedOrigin -> Bool

max :: ParsedOrigin -> ParsedOrigin -> ParsedOrigin

min :: ParsedOrigin -> ParsedOrigin -> ParsedOrigin

parseOrigin :: String -> Maybe ParsedOrigin

Extract information about filename and source span from a string.

oFile :: Lens' Origin FilePath

oSpan :: Lens' Origin SrcSpan

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

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

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

data LogMessage a

A logged message with an origin and a message value.

Constructors

LogMessage

Fields

• _lmOrigin :: Maybe Origin
• _lmMsg :: a

Instances

Foldable LogMessage

Defined in Camfort.Analysis.Logger

Methods

fold :: Monoid m => LogMessage m -> m

foldMap :: Monoid m => (a -> m) -> LogMessage a -> m

foldMap' :: Monoid m => (a -> m) -> LogMessage a -> m

foldr :: (a -> b -> b) -> b -> LogMessage a -> b

foldr' :: (a -> b -> b) -> b -> LogMessage a -> b

foldl :: (b -> a -> b) -> b -> LogMessage a -> b

foldl' :: (b -> a -> b) -> b -> LogMessage a -> b

foldr1 :: (a -> a -> a) -> LogMessage a -> a

foldl1 :: (a -> a -> a) -> LogMessage a -> a

toList :: LogMessage a -> [a]

null :: LogMessage a -> Bool

length :: LogMessage a -> Int

elem :: Eq a => a -> LogMessage a -> Bool

maximum :: Ord a => LogMessage a -> a

minimum :: Ord a => LogMessage a -> a

sum :: Num a => LogMessage a -> a

product :: Num a => LogMessage a -> a

Traversable LogMessage

Defined in Camfort.Analysis.Logger

Methods

traverse :: Applicative f => (a -> f b) -> LogMessage a -> f (LogMessage b)

sequenceA :: Applicative f => LogMessage (f a) -> f (LogMessage a)

mapM :: Monad m => (a -> m b) -> LogMessage a -> m (LogMessage b)

sequence :: Monad m => LogMessage (m a) -> m (LogMessage a)

Functor LogMessage

Defined in Camfort.Analysis.Logger

Methods

fmap :: (a -> b) -> LogMessage a -> LogMessage b

(<$) :: a -> LogMessage b -> LogMessage a

Generic (LogMessage a)

Defined in Camfort.Analysis.Logger

Associated Types

type Rep (LogMessage a) :: Type -> Type

Methods

from :: LogMessage a -> Rep (LogMessage a) x

to :: Rep (LogMessage a) x -> LogMessage a

Show a => Show (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> LogMessage a -> ShowS

show :: LogMessage a -> String

showList :: [LogMessage a] -> ShowS

Describe a => Describe (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

describe :: LogMessage a -> Text

describeBuilder :: LogMessage a -> Builder

NFData a => NFData (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

rnf :: LogMessage a -> ()

Eq a => Eq (LogMessage a)

Defined in Camfort.Analysis.Logger

Methods

(==) :: LogMessage a -> LogMessage a -> Bool

(/=) :: LogMessage a -> LogMessage a -> Bool

type Rep (LogMessage a)

Defined in Camfort.Analysis.Logger

type Rep (LogMessage a) = D1 ('MetaData "LogMessage" "Camfort.Analysis.Logger" "camfort-1.2.0-inplace" 'False) (C1 ('MetaCons "LogMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "_lmOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Origin)) :*: S1 ('MetaSel ('Just "_lmMsg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

lmOrigin :: forall a. Lens' (LogMessage a) (Maybe Origin)

lmMsg :: forall a a. Lens (LogMessage a) (LogMessage a) a a

data SomeMessage e w

A message at one of the four LogLevels.

Constructors

MsgError (LogMessage e)

MsgWarn (LogMessage w)

MsgInfo (LogMessage Text)

MsgDebug (LogMessage Text)

Instances

Generic (SomeMessage e w)

Defined in Camfort.Analysis.Logger

Associated Types

type Rep (SomeMessage e w) :: Type -> Type

Methods

from :: SomeMessage e w -> Rep (SomeMessage e w) x

to :: Rep (SomeMessage e w) x -> SomeMessage e w

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

Defined in Camfort.Analysis.Logger

Methods

showsPrec :: Int -> SomeMessage e w -> ShowS

show :: SomeMessage e w -> String

showList :: [SomeMessage e w] -> ShowS

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

Defined in Camfort.Analysis.Logger

Methods

describe :: SomeMessage e w -> Text

describeBuilder :: SomeMessage e w -> Builder

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

Defined in Camfort.Analysis.Logger

Methods

rnf :: SomeMessage e w -> ()

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

Defined in Camfort.Analysis.Logger

Methods

(==) :: SomeMessage e w -> SomeMessage e w -> Bool

(/=) :: SomeMessage e w -> SomeMessage e w -> Bool

type Rep (SomeMessage e w)

Defined in Camfort.Analysis.Logger

type Rep (SomeMessage e w) = D1 ('MetaData "SomeMessage" "Camfort.Analysis.Logger" "camfort-1.2.0-inplace" 'False) ((C1 ('MetaCons "MsgError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LogMessage e))) :+: C1 ('MetaCons "MsgWarn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LogMessage w)))) :+: (C1 ('MetaCons "MsgInfo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LogMessage Text))) :+: C1 ('MetaCons "MsgDebug" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LogMessage Text)))))

_MsgError :: forall e w e. Prism (SomeMessage e w) (SomeMessage e w) (LogMessage e) (LogMessage e)

_MsgWarn :: forall e w w. Prism (SomeMessage e w) (SomeMessage e w) (LogMessage w) (LogMessage w)

_MsgInfo :: forall e w. Prism' (SomeMessage e w) (LogMessage Text)

_MsgDebug :: forall e w. Prism' (SomeMessage e w) (LogMessage Text)

Logging monad

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

setDefaultSourceFile :: FilePath -> m ()

Set the default source file, i.e. the file in which messages originate by default.

default setDefaultSourceFile :: (MonadTrans t, MonadLogger e w m', m ~ t m') => FilePath -> m ()

getDefaultSourceFile :: m FilePath

Get the current default source file, i.e. the file in which messages originate by default.

default getDefaultSourceFile :: (MonadTrans t, MonadLogger e w m', m ~ t m') => m FilePath

recordLogMessage :: SomeMessage e w -> m ()

Record a log message. Output it based on the LogOutput function used and store it in the collected logs.

default recordLogMessage :: (MonadTrans t, MonadLogger e w m', m ~ t m') => SomeMessage e w -> m ()

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 (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 ()

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 (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 ()

(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 ()

(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 ()

(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 ()

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.

data LoggerT e w m a

The logging monad transformer, containing errors of type e and warnings of type w.

Instances

(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 ()

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

This doesn't behave quite as you may think. When a LoggerT is hoisted, the resulting LoggerT cannot output as it goes. It still collects logs to be inspected when it finishes.

Defined in Camfort.Analysis.Logger

Methods

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

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

Defined in Camfort.Analysis.Logger

Methods

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

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

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

Defined in Camfort.Analysis.Logger

Methods

ask :: LoggerT e w m r

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

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

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

Defined in Camfort.Analysis.Logger

Methods

get :: LoggerT e w m s

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

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

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

Defined in Camfort.Analysis.Logger

Methods

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

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

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

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

MonadTrans (LoggerT e w)

Defined in Camfort.Analysis.Logger

Methods

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

MonadFail m => MonadFail (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

fail :: String -> LoggerT e w m a

MonadIO m => MonadIO (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

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

Monad m => Applicative (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

pure :: a -> LoggerT e w m a

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

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

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

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

Functor m => Functor (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

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

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

Monad m => Monad (LoggerT e w m)

Defined in Camfort.Analysis.Logger

Methods

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

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

return :: a -> LoggerT e w m a

mapLoggerT :: Functor m => (e -> e') -> (w -> w') -> LoggerT e w m a -> LoggerT e' w' m a

Change the error and warning types in a logger computation. To change the underlying monad use hoist.

Running a logger

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.

runLoggerT

Arguments

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

=> FilePath

The initial default source file. This is only used for displaying message origins.

-> LogOutput m

The logging output function. E.g. logOutputStd or logOutputNone.

-> LogLevel

The log level for on-the-fly logging. Doesn't affect which logs are collected at the end.

-> LoggerT e w m a

The logging action to run.

-> m (a, [SomeMessage e w])

Run the logging monad transformer. Returns the action's result value and a list of logs which were collected as it ran.