include/1 — Logtalk 3.100.1

directive

# `include/1`

## Description

    include(File)

Includes a file contents, which must be valid terms, at the place of occurrence of the directive. The file can be specified as a relative path, an absolute path, or using library notation and is expanded as a source file name. Relative paths are interpreted as relative to the path of the file containing the directive. The file extension is optional (the recognized Logtalk and Prolog file extensions are defined in the backend adapter files).

When using the reflection API, predicates from an included file can be distinguished from predicates from the main file by looking for the `include/1` predicate declaration property or the `include/1` predicate definition property. For the included predicates, the `line_count/1` property stores the term line number in the included file.

This directive can be used as either a source file directive or an entity directive. As an entity directive, it can be used both in entities defined in source files and with the entity creation built-in predicates. In the latter case, the file should be specified using an absolute path or using library notation (which expands to a full path) to avoid a fragile dependency on the current working directory.

Included files may contain an encoding/1 directive, which may specify the same encoding of the main file or a different encoding.

Warning

The use of nested included files (i.e., included files including other files) is only partially supported. Notably, the reflection API currently only keeps track of the included files dependency on the main file. Although this allows predicates such as `logtalk_make/0-1` to work correctly, it prevents full code navigation features in supported IDEs for predicates defined in the nested included files.

When using this directive as an argument in calls to the create_object/4, create_category/4, and create_protocol/3 built-in predicates, the objects, categories, and protocols will not be recreated or redefined when the included file(s) are modified and the logtalk_make/0 predicate or the logtalk_make/1 (with target `all`) predicates are called.

## Template and modes

    include(@source_file_name)

## Examples

    % include the "raw_1.txt" text file found
    % on the "data" library directory:
    :- include(data('raw_1.txt')).

    % include a "factbase.pl" file in the same directory
    % of the source file containing the directive:
    :- include('factbase.pl').

    % include a file given its absolute path:
    :- include('/home/me/databases/countries.pl').

    % create a wrapper object for a Prolog file using
    % library notation to define the file path:
    | ?- create_object(cities, [], [public(city/4), include(geo('cities.pl'))], []).