/usr/local/lib/swipl/library/prolog_xref.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • debug.pl -- Print debug messages and test assertions
      • apply.pl
      • lists.pl -- List Manipulation
      • broadcast.pl
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl
      • main.pl
      • readutil.pl
      • operators.pl
      • pairs.pl
      • prolog_source.pl
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl
      • pure_input.pl -- Pure Input from files and streams
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • yall.pl -- Lambda expressions
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl
      • predicate_options.pl -- Access and analyse predicate options
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl
      • atom.pl -- Operations on atoms
      • modules.pl
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
        • called_by/4
        • called_by/2
        • meta_goal/2
        • hook/1
        • xref_source/1
        • xref_source/2
        • xref_clean/1
        • xref_current_source/1
        • xref_done/2
        • xref_called/3
        • xref_called/4
        • xref_called/5
        • xref_defined/3
        • xref_definition_line/2
        • xref_exported/2
        • xref_module/2
        • xref_uses_file/3
        • xref_op/2
        • xref_prolog_flag/4
        • xref_comment/3
        • xref_comment/4
        • xref_mode/3
        • xref_option/2
        • xref_meta/3
        • xref_meta/2
        • xref_meta_src/3
        • xref_hook/1
        • xref_public_list/3
        • xref_public_list/4
        • xref_public_list/6
        • xref_public_list/7
        • xref_source_file/3
        • xref_source_file/4
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl -- Lazy list handling
      • ugraphs.pl -- Graph manipulation library
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_pack.pl -- A package manager for Prolog
      • git.pl -- Run GIT commands
      • rbtrees.pl
      • dif.pl -- The dif/2 constraint
      • charsio.pl
      • prolog_stack.pl
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • dialect.pl -- Support multiple Prolog dialects
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl
      • varnumbers.pl -- Utilities for numbered terms
      • backcomp.pl
      • threadutil.pl -- Interactive thread utilities
      • prolog_debug.pl
      • help.pl
      • qsave.pl
      • zip.pl
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl
      • date.pl
      • heaps.pl -- heaps/priority queues
      • statistics.pl
      • terms.pl -- Term manipulation
      • utf8.pl
      • when.pl -- Conditional coroutining
      • ctypes.pl
      • streams.pl
      • hashtable.pl
      • writef.pl
      • prolog_metainference.pl
      • prolog_codewalk.pl
      • prolog_profile.pl
      • prolog_coverage.pl -- Coverage analysis tool
      • strings.pl
      • listing.pl -- List programs and pretty print clauses
      • quintus.pl
      • prolog_versions.pl
      • macros.pl -- Macro expansion
      • exceptions.pl
      • optparse.pl
      • thread.pl -- High level thread primitives
      • prolog_trace.pl
      • ansi_term.pl
      • check.pl
      • prolog_autoload.pl -- Autoload all dependencies
      • tables.pl
      • fastrw.pl -- Fast reading and writing of terms
      • edit.pl -- Editor interface
      • system.pl -- System utilities
      • explain.pl
      • portray_text.pl
      • make.pl -- Reload modified source files
      • rwlocks.pl
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_wrap.pl -- Wrapping predicates
      • nb_set.pl -- Non-backtrackable sets
      • intercept.pl
      • shell.pl -- Elementary shell commands
      • oset.pl
      • persistency.pl
      • increval.pl -- Incremental dynamic predicate modification
      • prolog_history.pl
      • prolog_config.pl
      • files.pl
 xref_public_list(+Spec, +Source, +Options) is semidet
Find meta-information about File. If Spec resolves to a Prolog source file, this predicate reads all terms upto the first term that is not a directive. If Spec resolves to a SWI-Prolog `.qlf` file, it extracts part of the information from the QLF file. It uses the module and meta_predicate directives to assemble the information in Options. Options processed:
path(-Path)
Path is the full path name of the referenced file. If Spec resolves to a .qlf file, Path is the name of the embedded Prolog file.
module(-Module)
Module is the module defines in Spec.
exports(-Exports)
Exports is a list of predicate indicators and operators collected from the module/2 term and reexport declarations.
public -Public
Public declarations of the file. Currently always [] for .qlf files.
meta(-Meta)
Meta is a list of heads as they appear in meta_predicate/1 declarations. Currently always [] for .qlf files.
silent(+Boolean)
Do not print any messages or raise exceptions on errors.

The information collected by this predicate is cached. The cached data is considered valid as long as the modification time of the file does not change.

Arguments:
Source- is the file from which Spec is referenced.