• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

/usr/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
      • broadcast.pl -- Event service
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl
      • main.pl
      • readutil.pl -- Read utilities
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • quasi_quotations.pl
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_colour.pl
      • record.pl -- Access compound arguments by name
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl -- Ordered set manipulation
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • solution_sequences.pl -- Modify solution sequences
      • atom.pl -- Operations on atoms
      • prolog_pack.pl -- A package manager for Prolog
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • utf8.pl
      • base64.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • pure_input.pl
      • nb_set.pl -- Non-backtrackable sets
      • aggregate.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • iostream.pl -- Utilities to deal with streams
      • dialect.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl -- Lambda expressions
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • predicate_options.pl -- Access and analyse predicate options
      • rbtrees.pl
      • nb_rbtrees.pl
      • sandbox.pl
      • prolog_format.pl -- Analyse format specifications
      • random.pl -- Random numbers
      • pprint.pl -- Pretty Print Prolog terms
      • modules.pl -- Module utility predicates
      • lazy_lists.pl
      • edinburgh.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl
      • heaps.pl
      • backcomp.pl -- Backward compatibility
      • date.pl
      • prolog_profile.pl -- Execution profiler
      • listing.pl -- List programs and pretty print clauses
        • listing/0
        • listing/1
        • listing/2
        • portray_clause/1
        • portray_clause/2
        • portray_clause/3
      • quintus.pl -- Quintus compatibility
      • oset.pl -- Ordered set manipulation
      • varnumbers.pl
      • tables.pl -- XSB interface to tables
      • charsio.pl
      • terms.pl -- Term manipulation
      • make.pl -- Reload modified source files
      • streams.pl -- Manage Prolog streams
      • rwlocks.pl -- Read/write locks
      • threadutil.pl -- Interactive thread utilities
      • wfs.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • check.pl -- Consistency checking
      • intercept.pl -- Intercept and signal interface
      • prolog_coverage.pl -- Coverage analysis tool
      • prolog_debug.pl -- User level debugging tools
      • increval.pl -- Incremental dynamic predicate modification
      • help.pl -- Text based manual
      • portray_text.pl
      • statistics.pl -- Get information about resource usage
      • optparse.pl -- command line parsing
      • ansi_term.pl
      • hashtable.pl -- Hash tables
      • coinduction.pl -- Co-Logic Programming
      • qsave.pl
      • zip.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • codesio.pl -- I/O on Lists of Character Codes
      • shell.pl -- Elementary shell commands
      • when.pl -- Conditional coroutining
      • system.pl -- System utilities
      • prolog_jiti.pl
      • prolog_codewalk.pl -- Prolog code walker
      • exceptions.pl -- Exception classification
      • base32.pl
      • sort.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • edit.pl
      • macros.pl -- Macro expansion
      • prolog_autoload.pl -- Autoload all dependencies
      • writef.pl -- Old-style formatted write
      • strings.pl -- String utilities
      • tableutil.pl
      • tty.pl
      • prolog_config.pl
      • explain.pl
      • fastrw.pl
      • prolog_trace.pl
      • files.pl
      • prolog_wrap.pl -- Wrapping predicates
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_qlfmake.pl -- Compile the library to QLF format
 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)]).
thread(+ThreadId)
If a predicate is thread local, list the clauses as seen by the given ThreadId. Ignored if the predicate is not thread local.
module(+Module)
Module whose operator table is used to write the clauses. Default is the module from which listing/2 is called. This matters for a program listed in a module other than the one whose operators it is written with, e.g., a compiled representation kept in a temporary module.

Other options are passed to portray_clause/3 and from there to write_term/3.

ClioPatria (version V3.1.1-59-g7b9a7a3)