Reckon 0.5.1-dev
A Tool to Count Logical Lines of Code
Loading...
Searching...
No Matches
RcnStatOptions Struct Reference

Options to customize the behaviour of counting operations. More...

#include <reckon/reckon.h>

Data Fields

uint32_t operations
 Options to specify which counting operations to perform.
uint32_t formats
 Options to specify which text formats to include in the counting.
bool stopOnError
 Whether to stop the processing on the first encountered error.
bool keepFileContent
 Whether to keep the original file content in memory.

Detailed Description

Options to customize the behaviour of counting operations.

Allows users to specify various options that control how counting operations are performed.

A zero-initialized RcnStatOptions struct will select default behaviour.

Field Documentation

◆ formats

uint32_t RcnStatOptions::formats

Options to specify which text formats to include in the counting.

This is also used to specify programming languages to include. Use RcnFormatOption options to enable or disable specific formats and/or programming languages. Formats can be combined using bitwise OR.

A value of zero (default) selects all available text formats.

◆ keepFileContent

bool RcnStatOptions::keepFileContent

Whether to keep the original file content in memory.

If this is set to true, then after processing a source file, the file content will be retained in memory for potential future use. If this is set to false, the original content may be discarded automatically after processing in order to free up memory as soon as possible.

◆ operations

uint32_t RcnStatOptions::operations

Options to specify which counting operations to perform.

Use RcnCountOption options to enable or disable specific operations. Operations can be combined using bitwise OR.

A value of zero (default) selects all available counting operations.

◆ stopOnError

bool RcnStatOptions::stopOnError

Whether to stop the processing on the first encountered error.

If this is set to true, then compound functions like rcnCount() will abort as soon as any error is encountered. Otherwise, a function may or may not attempt to continue its operation when encountering non-critical errors. Some errors, e.g. memory allocation failures, are considered critical and may always abort an operation immediately regardless of this option's value.