object

# `caller_diagram(Format)`

- `Format` - Graph language file format.

Predicates for generating caller diagrams showing direct and indirect callers of a predicate or a non-terminal.

Availability:
`logtalk_load(diagrams(loader))`
Author: Paulo Moura
Version: 1:0:0
Date: 2026-03-12
Compilation flags:
`static, context_switching_calls`
Imports:
`public` diagram(Format)
Uses:
list
logtalk
user
Remarks:
(none)
Inherited public predicates:
all_files/0 all_files/1 all_libraries/0 all_libraries/1 check_option/1 check_options/1 default_option/1 default_options/1 diagram_description/1 diagram_name_suffix/1 directories/2 directories/3 directory/1 directory/2 directory/3 files/1 files/2 files/3 format_object/1 libraries/1 libraries/2 libraries/3 library/1 library/2 option/2 option/3 rdirectory/1 rdirectory/2 rdirectory/3 rlibrary/1 rlibrary/2 valid_option/1 valid_options/1

## Public predicates

### `predicate/2`

Creates a caller diagram for the given predicate or non-terminal using the specified options. Predicates are specified as `Entity::Name/Arity`. Non-terminals are specified as `Entity::Name//Arity`.

Compilation flags:
`static`
Template:
`predicate(QualifiedIndicator,Options)`
Mode and number of proofs:
`predicate(+qualified_predicate_indicator,+list(compound))` - `one`

### `predicate/1`

Creates a caller diagram for the given predicate using default options. Predicates are specified as `Entity::Name/Arity`. Non-terminals are specified as `Entity::Name//Arity`.

Compilation flags:
`static`
Template:
`predicate(QualifiedIndicator)`
Mode and number of proofs:
`predicate(+qualified_predicate_indicator)` - `one`

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

### `included_caller_/1`

Table of callers already included in the diagram.

Compilation flags:
`dynamic`
Template:
`included_caller_(Caller)`
Mode and number of proofs:
`included_caller_(?qualified_predicate_indicator)` - `zero_or_more`
`included_caller_(?predicate_indicator)` - `zero_or_more`

## Operators

(none)

See also

xref_diagram(Format), entity_diagram(Format)