Image handling

Author(s): Jose F. Morales.

This module defines the handling of image commands. It defines predicates to locate and convert images in the different formats required for documentation.

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc_images)).
Exports:
- Predicates:
  locate_and_convert_image/4, clean_image_cache/0.

Documentation on exports

PREDICATElocate_and_convert_image/4

Usage:locate_and_convert_image(SrcSpecS,AcceptedExts,DocSt,TargetFileS)

The image at SrcSpecS is located (as one of the known image extensions imgext/1) and converted to one of the AcceptedExts. The target file is called TargetFileS

Call and exit should be compatible with:
(string/1)SrcSpecS is a string (a list of character codes).
(list/2)AcceptedExts is a list of atms.
(docstate/1)docstate(DocSt)
(string/1)TargetFileS is a string (a list of character codes).

PREDICATEclean_image_cache/0

Usage:

Clean the cache for image copy/conversions.

Documentation on imports

This module has the following direct dependencies:

Application modules:
autodoc_state, autodoc_filesystem, autodoc_settings, autodoc_messages.
System library modules:
datafacts_rt, lists, system, system_extra, process, pathnames, format.
Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props, stream_basic.
Packages:
prelude, initial, condcomp, dcg, assertions, assertions/assertions_basic, regtypes, fsyntax, datafacts.