Code forensics  0.1
Generate historical information about code changes
walker_config Struct Reference

runtime configuration state object More...

#include <program_state.hpp>

Public Types

enum  threading_mode { async, defer, sequential }
 

Public Member Functions

bool use_analytics (Analytics which) const
 

Public Attributes

bool use_subprocess = true
 
threading_mode use_threading = threading_mode::async
 
Str repo
 Current project root path (absolute path) More...
 
Str heads
 Which repository branch to use. More...
 
Vec< Analyticsanalytics
 
Str db_path
 
bool try_incremental
 
bool log_progress_bars
 
Func< bool(CR< Str >)> allow_path
 Allow processing of a specific path in the repository. More...
 
Func< int(CR< PTime >)> get_commit_period
 Get integer index of the period for Date. More...
 
Func< int(CR< PTime >)> get_sampled_period
 
Func< bool(CR< PTime >, CR< Str >, CR< Str >)> allow_sample
 Check whether commits at the specified date should be analysed. More...
 

Detailed Description

runtime configuration state object

Member Enumeration Documentation

◆ threading_mode

Which threading mode to use during application execution (mostly for debugging purposes)

Enumerator
async 
defer 
sequential 

Member Function Documentation

◆ use_analytics()

bool walker_config::use_analytics ( Analytics  which) const
inline

Member Data Documentation

◆ allow_path

Func<bool(CR<Str>)> walker_config::allow_path

Allow processing of a specific path in the repository.

◆ allow_sample

Func<bool(CR<PTime>, CR<Str>, CR<Str>)> walker_config::allow_sample

Check whether commits at the specified date should be analysed.

◆ analytics

Vec<Analytics> walker_config::analytics

◆ db_path

Str walker_config::db_path

◆ get_commit_period

Func<int(CR<PTime>)> walker_config::get_commit_period

Get integer index of the period for Date.

◆ get_sampled_period

Func<int(CR<PTime>)> walker_config::get_sampled_period

◆ heads

Str walker_config::heads

Which repository branch to use.

◆ log_progress_bars

bool walker_config::log_progress_bars

◆ repo

Str walker_config::repo

Current project root path (absolute path)

◆ try_incremental

bool walker_config::try_incremental

◆ use_subprocess

bool walker_config::use_subprocess = true

Analyse commits via subprocess launches or via libgit blame execution

◆ use_threading

threading_mode walker_config::use_threading = threading_mode::async

The documentation for this struct was generated from the following file: