Metric-HIS.APCGCYCLE

HIS ap_cg_cycle metric: Number of callgraph recursions

Required inputs: RFG

This metric counts the number of call-graph recursions.

Possible Messages

This rule has no predefined messages.

Options

• This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity

• This rule shares the following common metric options: base_view_name, excluded_node_types, report_all_values

• The following places define options that affect this rule: Analysis-GlobalOptions

display_name

display_name : str | None = 'HIS ap_cg_cycle'

Description of the metric shown in the dashboard. If None, rfg_metric_name is used.

 

exclude_compiler_generated_cycles

exclude_compiler_generated_cycles : bool = False

Whether calls should be reported that contain only of compiler-generated routines.

 

ignored_edge_types

ignored_edge_types : set[str] = set()

Edge type names which should be ignored, e.g. Dynamic_Call

 

max_value

max_value : int | None = 0

Maximum allowed value. None if unlimited.

 

min_value

min_value : int | None = 0

Minimum allowed value. None if unlimited.

 

pre_excludes

pre_excludes : set[bauhaus.analysis.config.GlobPattern] = set()

String list of globbing patterns of directories/filenames to exclude before the analysis is performed, i.e. no cycle is reported if the only connecting path goes through a node matching at least one pre_exclude entry

 

rfg_metric_name

rfg_metric_name : str = 'Metric.HIS.AP_CG_CYCLE'

Name of the node attribute storing the metric value in the RFG.

 

selfloops

selfloops : bool = True

Whether only directly recursive elements should be counted as well.

 

treat_global_excludes_as_pre_excludes

treat_global_excludes_as_pre_excludes : bool = True

Whether global excludes should be treated as pre-excludes for this metric, adding them to any existing entries in the pre_excludes option.