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

  • swipl
    • library
      • error.pl
      • debug.pl
      • 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
      • gensym.pl
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl
      • pure_input.pl
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl
      • random.pl
      • base64.pl
      • aggregate.pl
      • yall.pl -- Lambda expressions
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl
      • prolog_format.pl
      • predicate_options.pl -- Access and analyse predicate options
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl
      • atom.pl
      • 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 -- Prolog syntax colouring support.
      • lazy_lists.pl
      • ugraphs.pl -- Graph manipulation library
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_pack.pl
      • git.pl
      • rbtrees.pl -- Red black trees
      • dif.pl -- The dif/2 constraint
      • charsio.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl
      • dialect.pl -- Support multiple Prolog dialects
      • prolog_code.pl
      • sort.pl
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • statistics.pl -- Get information about resource usage
      • listing.pl
      • base32.pl
      • codesio.pl
      • coinduction.pl
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • terms.pl
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • when.pl
      • backcomp.pl
      • optparse.pl -- command line parsing
      • portray_text.pl
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • quintus.pl -- Quintus compatibility
      • threadutil.pl -- Interactive thread utilities
      • prolog_debug.pl -- User level debugging tools
      • prolog_codewalk.pl
      • prolog_metainference.pl
      • thread.pl -- High level thread primitives
      • tables.pl
      • writef.pl -- Old-style formatted write
      • system.pl
      • ctypes.pl -- Character code classification
      • intercept.pl -- Intercept and signal interface
      • zip.pl -- Access resource ZIP archives
      • exceptions.pl
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • strings.pl -- String utilities
      • make.pl
      • nb_set.pl
      • prolog_trace.pl
      • streams.pl -- Manage Prolog streams
      • increval.pl
      • help.pl -- Text based manual
      • check.pl
      • macros.pl -- Macro expansion
      • hashtable.pl
      • rwlocks.pl
      • prolog_profile.pl
      • prolog_coverage.pl
      • oset.pl -- Ordered set manipulation
      • fastrw.pl
      • edit.pl -- Editor interface
      • prolog_autoload.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_config.pl
      • shell.pl
      • persistency.pl
      • qsave.pl
      • prolog_wrap.pl
      • prolog_versions.pl
      • explain.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.