category

# `file_diagram(Format)`

- `Format` - Graph language file format.

Common predicates for generating file diagrams.

Availability:
`logtalk_load(diagrams(loader))`
Author: Paulo Moura
Version: 2:13:2
Date: 2022-05-31
Compilation flags:
`static`
Extends:
`public` diagram(Format)
Uses:
list
logtalk
modules_diagram_support
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

(no local declarations; see entity ancestors if any)

## Protected predicates

### `remember_included_file/1`

Remember included Logtalk file in the diagram.

Compilation flags:
`static`
Template:
`remember_included_file(Path)`
Mode and number of proofs:
`remember_included_file(+atom)` - `one`

### `remember_referenced_logtalk_file/1`

Remember referenced Logtalk file in the diagram.

Compilation flags:
`static`
Template:
`remember_referenced_logtalk_file(Path)`
Mode and number of proofs:
`remember_referenced_logtalk_file(+atom)` - `one`

### `remember_referenced_prolog_file/1`

Remember referenced Prolog file in the diagram.

Compilation flags:
`static`
Template:
`remember_referenced_prolog_file(Path)`
Mode and number of proofs:
`remember_referenced_prolog_file(+atom)` - `one`

## Private predicates

### `included_file_/1`

Table of Logtalk files already included in the diagram.

Compilation flags:
`dynamic`
Template:
`included_file_(Path)`
Mode and number of proofs:
`included_file_(?atom)` - `zero_or_more`

### `referenced_logtalk_file_/1`

Table of referenced Logtalk files in the diagram.

Compilation flags:
`dynamic`
Template:
`referenced_logtalk_file_(Path)`
Mode and number of proofs:
`referenced_logtalk_file_(?atom)` - `zero_or_more`

### `referenced_prolog_file_/1`

Table of referenced Prolog files in the diagram.

Compilation flags:
`dynamic`
Template:
`referenced_prolog_file_(Path)`
Mode and number of proofs:
`referenced_prolog_file_(?atom)` - `zero_or_more`

## Operators

(none)