/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 -- Apply predicates on a list
      • lists.pl
      • broadcast.pl
      • shlib.pl
      • option.pl
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl
      • main.pl
      • readutil.pl
      • operators.pl
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl
      • record.pl
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl
      • aggregate.pl
      • yall.pl
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl
      • prolog_format.pl
      • predicate_options.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl
      • atom.pl -- Operations on atoms
      • modules.pl -- Module utility predicates
      • 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
      • lazy_lists.pl
      • ugraphs.pl
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_pack.pl
      • git.pl -- Run GIT commands
      • rbtrees.pl
      • dif.pl -- The dif/2 constraint
      • charsio.pl -- I/O on Lists of Character Codes
      • prolog_stack.pl
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl -- Well Founded Semantics interface
      • dialect.pl
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl -- Dict utilities
      • varnumbers.pl
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • heaps.pl
      • statistics.pl
      • terms.pl -- Term manipulation
      • utf8.pl
      • when.pl
      • backcomp.pl
      • intercept.pl -- Intercept and signal interface
      • files.pl
      • prolog_codewalk.pl
      • listing.pl
      • prolog_metainference.pl
      • fastrw.pl
      • prolog_config.pl
      • prolog_jiti.pl
      • ansi_term.pl
      • thread.pl -- High level thread primitives
      • tables.pl
      • nb_set.pl -- Non-backtrackable sets
      • make.pl
      • check.pl -- Consistency checking
      • hashtable.pl -- Hash tables
      • persistency.pl -- Provide persistent dynamic predicates
      • prolog_debug.pl -- User level debugging tools
      • portray_text.pl
      • optparse.pl
      • strings.pl -- String utilities
      • system.pl -- System utilities
      • prolog_trace.pl -- Print access to predicates
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • threadutil.pl -- Interactive thread utilities
      • prolog_profile.pl
      • writef.pl -- Old-style formatted write
      • streams.pl
      • ctypes.pl -- Character code classification
      • oset.pl
      • edit.pl
      • quintus.pl -- Quintus compatibility
      • increval.pl -- Incremental dynamic predicate modification
      • shell.pl -- Elementary shell commands
      • prolog_wrap.pl -- Wrapping predicates
      • prolog_history.pl
      • zip.pl -- Access resource ZIP archives
      • prolog_coverage.pl
      • qsave.pl
      • prolog_autoload.pl
      • exceptions.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.