Filesystem Abstraction
Author(s): Jose F. Morales.
This module provides definitions to assign unique file-system paths and names for each of the intermediate and final results of documentation generation.
Usage and interface
- Library usage:
:- use_module(library(autodoc_filesystem)). - Exports:
- Predicates:
file_format_name/2, supported_file_format/1, file_format_provided_by_backend/3, clean_fs_db/0, get_output_dir/2, get_cache_dir/2, ensure_output_dir/1, ensure_cache_dir/1, main_absfile_in_format/2, main_absfile_for_subtarget/3, absfile_for_aux/3, absfile_for_subtarget/4, main_output_name/2, get_subbase/3, absfile_to_relfile/3, clean_all/0, clean_docs_no_texi/0, clean_all_temporal/0, clean_intermediate/0, clean_tex_intermediate/0. - Regular Types:
filename/1, basename/1, subtarget/1.
- Predicates:
- Imports:
- Application modules:
lpdocsrc(src(autodoc_settings)), lpdocsrc(src(autodoc_structure)), lpdocsrc(src(autodoc_state)). - System library modules:
aggregates, system_extra, terms, dirutils, system, lpdist/makedir_aux, lpdist/bundle_versions. - Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basic_props, basiccontrol, data_facts, exceptions, io_aux, io_basic, prolog_flags, streams_basic, system_info, term_compare, term_typing, hiord_rt, debugger_support. - Packages:
prelude, nonpure, dcg, assertions, regtypes, basicmodes, fsyntax.
- Application modules:
Documentation on exports
Usage:
The kind of intermediate/final results for a single documentation processing unit (module).
Usage:file_format_provided_by_backend(Ext,Backend,Subtarget)
Backend is the backend that generates files with format Ext
- Call and exit should be compatible with:
(atm/1)Ext is an atom.
(backend_id/1)Backend is a supported backend.
(atm/1)Subtarget is an atom.
Usage:
Clean the cached information for the filesystem mapping of the documentaton generation.
Usage:get_output_dir(Backend,Dir)
Obtain the Dir directory where the documentation files are generated. Note that this is not the installation directory.
Usage:get_cache_dir(Backend,Dir)
Obtain the Dir directory where final documentation files will be stored
Usage:main_absfile_in_format(Ext,File)
File is the absolute file name for the documentation in Ext format of the main module
Usage:absfile_for_aux(AuxName,Backend,AbsFile)
Absolute file for an auxiliary output file (e.g. CSS, images, etc.)
Usage:get_subbase(Base,Sub,SubBase)
SubBase is the name for the sub-file (Sub) associated with Base
- The following properties should hold upon exit:
(basename/1)Base is the base name of a file (without extension).
(atm/1)Sub is an atom.
(basename/1)SubBase is the base name of a file (without extension).
Usage:absfile_to_relfile(A,Backend,B)
Obtain the relative path, w.r.t. the output directory, of an absolute file. This is useful, e.g., for URLs.
