Argon

Programmatic interface to Argon.

Types

type AnalysisResult = Either String [ComplexityBlock]

Represent the result of the analysis of one file. It can either be an error message or a list of ComplexityBlocks.

newtype ComplexityBlock

Hold the data associated to a function binding: (location, function name, complexity).

Constructors

CC (Loc, String, Int)

Instances

Eq ComplexityBlock

Ord ComplexityBlock

Show ComplexityBlock

ToJSON ComplexityBlock

ToJSON (FilePath, AnalysisResult)

data OutputMode

Type describing how the results should be exported.

Constructors

BareText

Text-only output, no colors.

Colored

Text-only output, with colors.

JSON

Data is serialized to JSON.

Instances

Eq OutputMode

Show OutputMode

data Config

Type holding all the options passed from the command line.

Constructors

Config

Fields

minCC :: Int

Minimum complexity a block has to have to be shown in results.

exts :: [ExtensionFlag]

Path to the main Cabal file

headers :: [FilePath]

Header files to be automatically included before preprocessing

includeDirs :: [FilePath]

Additional include directories for the C preprocessor

outputMode :: OutputMode

Describe how the results should be exported.

defaultConfig :: Config

Default configuration options.

Warning: These are not Argon's default options.

type Loc = (Int, Int)

Type synonym representing a location in the source code. The tuple represents the following: (start line, start col).

type LModule = Located (HsModule RdrName)

Type synonym for a syntax node representing a module tagged with a SrcSpan

Gathering source files

allFiles :: (MonadIO m, MonadSafe m) => FilePath -> Producer FilePath m ()

Starting from a path, generate a sequence of paths corresponding to Haskell files. The filesystem is traversed depth-first.

Parsing

analyze

Arguments

:: Config

Configuration options

-> FilePath

The filename corresponding to the source code

-> IO (FilePath, AnalysisResult)

Parse the code in the given filename and compute cyclomatic complexity for every function binding.

parseModule :: Config -> FilePath -> IO (Either String LModule)

Parse a module with the default instructions for the C pre-processor Only the includes directory is taken from the config

parseExts :: FilePath -> IO [ExtensionFlag]

Parse the given Cabal file generate a list of GHC extension flags. The extension names are read from the default-extensions field in the library section.

flagsMap :: Map String ExtensionFlag

A Map from extensions names to extensions flags

Manipulating results

order :: [ComplexityBlock] -> [ComplexityBlock]

Order a list of blocks. Ordering is done with respect to:

1. complexity (descending)
2. line number (ascending)
3. function name (alphabetically)

filterResults :: Config -> (FilePath, AnalysisResult) -> (FilePath, AnalysisResult)

Filter the results of the analysis, with respect to the given Config.

filterNulls :: (FilePath, AnalysisResult) -> Bool

A result is discarded if it correspond to a successful analysis and there are no blocks to show

exportStream :: MonadIO m => Config -> Producer (FilePath, AnalysisResult) m () -> Effect m ()

Export analysis' results. How to export the data is defined by the Config parameter.

Formatting results

bareTextFormatter :: MonadIO m => Pipe (FilePath, AnalysisResult) String m ()

coloredTextFormatter :: MonadIO m => Pipe (FilePath, AnalysisResult) String m ()

Utilities

srcSpanToLoc :: SrcSpan -> Loc

Convert a GHC's SrcSpan to a (line, column) pair. In case of a GHC's "bad span" the resulting pair is (0, 0).

locToString :: Loc -> String

Convert a location to a string of the form "line:col"

tagMsg :: Loc -> String -> String

Add the location to a string message