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.

outputMode :: OutputMode

Describe how the results should be exported.

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

Parsing

analyze

Arguments

:: 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 :: FilePath -> IO (Either String LModule)

Parse a module with the default instructions for the C pre-processor

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.

export :: Config -> [(FilePath, AnalysisResult)] -> String

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