/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 -- List Manipulation
      • broadcast.pl
      • shlib.pl
      • option.pl -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • 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
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • yall.pl
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • 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
      • ugraphs.pl -- Graph manipulation library
      • url.pl
      • www_browser.pl
      • prolog_pack.pl -- A package manager for Prolog
      • git.pl
      • rbtrees.pl -- Red black trees
      • dif.pl -- The dif/2 constraint
      • charsio.pl -- I/O on Lists of Character Codes
      • prolog_stack.pl -- Examine the Prolog stack
      • edinburgh.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl
      • dialect.pl
      • prolog_code.pl
      • sort.pl
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • check.pl -- Consistency checking
      • prolog_wrap.pl
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl
      • coinduction.pl
      • date.pl -- Process dates and times
      • heaps.pl
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • when.pl -- Conditional coroutining
      • backcomp.pl -- Backward compatibility
      • optparse.pl -- command line parsing
      • make.pl
      • prolog_autoload.pl
      • prolog_codewalk.pl -- Prolog code walker
      • rwlocks.pl
      • nb_set.pl -- Non-backtrackable sets
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • quintus.pl -- Quintus compatibility
      • qsave.pl
      • zip.pl -- Access resource ZIP archives
      • prolog_debug.pl
      • streams.pl
      • threadutil.pl -- Interactive thread utilities
      • shell.pl -- Elementary shell commands
      • writef.pl -- Old-style formatted write
      • prolog_profile.pl
      • ansi_term.pl
      • system.pl
      • ctypes.pl -- Character code classification
      • prolog_versions.pl
      • strings.pl
      • edit.pl -- Editor interface
      • prolog_trace.pl
      • prolog_metainference.pl
      • prolog_history.pl
      • prolog_config.pl
      • help.pl
      • portray_text.pl
      • thread.pl -- High level thread primitives
      • prolog_coverage.pl
      • explain.pl
      • intercept.pl
      • prolog_jiti.pl
      • macros.pl
      • oset.pl
      • fastrw.pl
      • hashtable.pl
      • exceptions.pl
 xref_source(+Source) is det
 xref_source(+Source, +Options) is det
Generate the cross-reference data for Source if not already done and the source is not modified. Checking for modifications is only done for files. Options processed:
silent(+Boolean)
If true (default false), emit warning messages.
module(+Module)
Define the initial context module to work in.
register_called(+Which)
Determines which calls are registerd. Which is one of all, non_iso or non_built_in (default).
comments(+CommentHandling)
How to handle comments. If store, comments are stored into the database as if the file was compiled. If collect, comments are entered to the xref database and made available through xref_mode/2 and xref_comment/4. If ignore, comments are simply ignored. Default is to collect comments.
process_include(+Boolean)
Process the content of included files (default is true).
stream(+Stream)
Process the input from Stream rather than opening Source.
Arguments:
Source- File specification or XPCE buffer