☰

Manifest compiler

Author(s): Jose F. Morales.

This module implements predicates to load, consult, and compile Manifest.pl files. A Manifest file allows the specification of a bundle:

NOTE: Configuration flags and nested definitions must be defined in a <bundle>.hooks.pl module.

Use make_bundlereg/4 for processing of Manifest.pl files into bundle registry entries. Bundle registries are written using fastrw so that the support code to load them is minimal. They include cheaper runtime meta-information (like dependencies, versions, path aliases, etc.).

For registered bundles, you can use ensure_load_manifest/1 and manifest_call/2 for loading and consulting a bundle specification.

NOTE: Users should never call custom build command definitions directly with manifest_call/2. Use builder_cmds instead.

Documentation on exports

PREDICATEis_bundledir/1

Usage:is_bundledir(BundleDir)

BundleDir is the directory for a bundle (i.e., contains a Manifest.pl file

    PREDICATElocate_manifest_file/2

    Usage:locate_manifest_file(BundleDir,ManifestFile)

    Given BundleDir a bundle directory, ManifestFile is unified with the name of the manifest file

      PREDICATElookup_bundle_root/2

      Usage:lookup_bundle_root(File,BundleDir)

      Detect the bundle root dir for the given File (a directory or normal file)

        PREDICATEensure_load_manifest/1

        Usage:ensure_load_manifest(Target)

        Ensure that the manifest for Target is loaded (including Manifest sentences and .hooks.pl modules). The bundle must have been scanned before, so that its source directory is known.

          PREDICATEmanifest_call/2

          Usage:manifest_call(Target,Head)

          Call Target:Head, a predicate defined in a Manifest (fact, predicate in hooks, or nested predicate)

            PREDICATEmanifest_current_predicate/2

            Usage:manifest_current_predicate(Target,Head)

            Head is declared in Target

              PREDICATEsplit_target/3
              No further documentation available for this predicate.

              PREDICATEcompose_target/3
              No further documentation available for this predicate.

              PREDICATEtarget_is_bundle/1
              No further documentation available for this predicate.

              PREDICATEmake_bundlereg/4

              Usage:make_bundlereg(Bundle,BundleDir,FinalBundleDir,RegFile)

              Generate a bundlereg RegFile for bundle Bundle at BundleDir, where the final bundle directory is FinalBundleDir.

                PREDICATEbundle_info/1

                Usage:bundle_info(Bundle)

                Show info of Bundle

                  PREDICATEget_bundle_readme/2
                  No further documentation available for this predicate.

                  PREDICATEbundle_manual_base/2
                  No further documentation available for this predicate.

                  PREDICATEmain_file_relpath/2
                  No further documentation available for this predicate.

                  PREDICATEmain_file_path/3
                  No further documentation available for this predicate.

                  Documentation on multifiles

                  PREDICATEm_bundlehook_decl/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_bundlehook_do/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_name/1
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_version/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_source_url/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_source_md5/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_patch/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_build_system/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_option1/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_option2/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_custom_configure/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_custom_build/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_third_party_custom_install/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_bundle_config_call/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_bundle_config_entry/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_bundle_foreign_config_tool/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEm_bundle_foreign_dep/4
                  No further documentation available for this predicate. The predicate is multifile.

                  Generated with LPdoc using Ciao