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(lpdoc(autodoc_filesystem)). - Exports:
- Predicates:
cleanup_vpath/0, add_vpath/1, find_file/2, find_doc_source/2, file_format_name/2, supported_file_format/1, format_get_subtarget/3, format_get_file/3, clean_fs_db/0, get_output_dir/2, get_cache_dir/2, get_cache_dir0/2, ensure_output_dir/1, ensure_cache_dir/1, absfile_for_aux/3, absfile_for_subtarget/4, main_output_name/2, main_output_name_novers/1, get_parent_bundle/1, get_modspec/2, modname_nodoc/2, modspec_nodoc/2, get_subbase/3, absfile_to_relfile/3, clean_all/0, clean_docs_no_texi/0, clean_all_temporary/0, clean_intermediate/0, pred_to_glob_pattern/2. - Regular Types:
filename/1, filename_noext/1, subtarget/1.
- Predicates:
- Imports:
- Application modules:
autodoc_settings, autodoc_structure, autodoc_state. - System library modules:
aggregates, pathnames, system, system_extra, terms, paths_extra, bundle_info, source_tree. - 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, condcomp, dcg, assertions, regtypes, basicmodes, fsyntax, hiord.
- Application modules:
Documentation on exports
Usage:
The kind of intermediate/final results for a single documentation processing unit (module).
Usage:format_get_subtarget(Format,Backend,Subtarget)
Backend and Subtarget are the backend and subtarget that generates files with format Format
- Call and exit should be compatible with:
(atm/1)Format 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)
Dir is the directory where the documentation files are generated. Note that this is not the installation directory.
Usage:get_cache_dir(Backend,Dir)
Dir is the directory where temporary documentation files will be stored (for the active backend)
Usage:get_cache_dir0(Backend,Dir)
Dir is the directory where temporary documentation files will be stored (for all backends)
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:
(filename_noext/1)Base is the base name of a file (without extension).
(atm/1)Sub is an atom.
(filename_noext/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.
