RcnCountStatistics Struct Reference

A collection of source code metrics. More...

#include <reckon/reckon.h>

Data Fields
RcnCount	totalLogicalLines
	The total number of logical lines of code, across all files and programming languages.
RcnCount	totalPhysicalLines
	The total number of hard physical lines, across all files and formats.
RcnCount	totalWords
	The total number of words, across all files and formats.
RcnCount	totalCharacters
	The total number of characters, across all files and formats.
RcnCount	totalSourceSize
	The total size of the source code files, across all files and formats.
RcnCount	logicalLines [RECKON_NUM_SUPPORTED_FORMATS]
	The number of logical lines of code per supported programming language.
RcnCount	physicalLines [RECKON_NUM_SUPPORTED_FORMATS]
	The number of hard physical lines per supported programming language.
RcnCount	words [RECKON_NUM_SUPPORTED_FORMATS]
	The number of words per supported format.
RcnCount	characters [RECKON_NUM_SUPPORTED_FORMATS]
	The number of characters per supported format.
RcnCount	sourceSize [RECKON_NUM_SUPPORTED_FORMATS]
	The total size of the source code files per supported format.
RcnCountResultSet	count
	The set of results for each analyzed source code file.
RcnResultState	state
	The state of the compound operation, indicating success or failure.

Detailed Description

A collection of source code metrics.

This type is used to track and store the results for code analysis operations. It contains statistics about a set of source code files, where conceptually every text file that would be part of a source tree is considered a source code file, even if it doesn't contain actual code.

Field Documentation

characters

RcnCount RcnCountStatistics::characters[RECKON_NUM_SUPPORTED_FORMATS]

The number of characters per supported format.

The index corresponds to the RcnTextFormat enumerator values.

count

RcnCountResultSet RcnCountStatistics::count

The set of results for each analyzed source code file.

logicalLines

RcnCount RcnCountStatistics::logicalLines[RECKON_NUM_SUPPORTED_FORMATS]

The number of logical lines of code per supported programming language.

The index corresponds to the RcnTextFormat enumerator values.

physicalLines

RcnCount RcnCountStatistics::physicalLines[RECKON_NUM_SUPPORTED_FORMATS]

The number of hard physical lines per supported programming language.

The index corresponds to the RcnTextFormat enumerator values.

sourceSize

RcnCount RcnCountStatistics::sourceSize[RECKON_NUM_SUPPORTED_FORMATS]

The total size of the source code files per supported format.

The index corresponds to the RcnTextFormat enumerator values. The size is measured in bytes.

state

RcnResultState RcnCountStatistics::state

The state of the compound operation, indicating success or failure.

In case the result set only contains one source file, this state reflects the result state of the processing of that one source file and is therefore equivalent to the state of the corresponding only result group in the set.

totalCharacters

RcnCount RcnCountStatistics::totalCharacters

The total number of characters, across all files and formats.

totalLogicalLines

RcnCount RcnCountStatistics::totalLogicalLines

The total number of logical lines of code, across all files and programming languages.

totalPhysicalLines

RcnCount RcnCountStatistics::totalPhysicalLines

The total number of hard physical lines, across all files and formats.

totalSourceSize

RcnCount RcnCountStatistics::totalSourceSize

The total size of the source code files, across all files and formats.

Measured in bytes.

totalWords

RcnCount RcnCountStatistics::totalWords

The total number of words, across all files and formats.

words

RcnCount RcnCountStatistics::words[RECKON_NUM_SUPPORTED_FORMATS]

The number of words per supported format.

The index corresponds to the RcnTextFormat enumerator values.