/usr/local/lib/swipl/library/listing.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
      • settings.pl
      • 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
      • prolog_colour.pl
      • lazy_lists.pl
      • ugraphs.pl -- Graph manipulation library
      • url.pl
      • www_browser.pl
      • prolog_pack.pl
      • git.pl
      • rbtrees.pl -- Red black trees
      • dif.pl -- The dif/2 constraint
      • charsio.pl
      • prolog_stack.pl
      • 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
      • terms.pl -- Term manipulation
      • utf8.pl
      • 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
        • listing/0
        • listing/1
        • listing/2
        • portray_clause/1
        • portray_clause/2
        • portray_clause/3
      • persistency.pl
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl
      • 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
 listing(:What) is det
 listing(:What, +Options) is det
List matching clauses. What is either a plain specification or a list of specifications. Plain specifications are:
  • Predicate indicator (Name/Arity or Name//Arity) Lists the indicated predicate. This also outputs relevant declarations, such as multifile/1 or dynamic/1.
  • A Head term. In this case, only clauses whose head unify with Head are listed. This is illustrated in the query below that only lists the first clause of append/3.
    ?- listing(append([], _, _)).
    lists:append([], L, L).
  • A clause reference as obtained for example from nth_clause/3.

The following options are defined:

variable_names(+How)
One of source (default) or generated. If source, for each clause that is associated to a source location the system tries to restore the original variable names. This may fail if macro expansion is not reversible or the term cannot be read due to different operator declarations. In that case variable names are generated.
source(+Bool)
If true (default false), extract the lines from the source files that produced the clauses, i.e., list the original source text rather than the decompiled clauses. Each set of contiguous clauses is preceded by a comment that indicates the file and line of origin. Clauses that cannot be related to source code are decompiled where the comment indicates the decompiled state. This is notably practical for collecting the state of multifile predicates. For example:
?- listing(file_search_path, [source(true)]).