/usr/lib/swipl/library/listing.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl
      • socket.pl
      • predicate_options.pl
      • shlib.pl
      • option.pl
      • uid.pl
      • unix.pl
      • syslog.pl
      • thread_pool.pl
      • gensym.pl
      • settings.pl
      • arithmetic.pl
      • main.pl
      • readutil.pl
      • ssl.pl
      • crypto.pl
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • 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 -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • tables.pl -- XSB interface to tables
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • statistics.pl -- Get information about resource usage
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • when.pl -- Conditional coroutining
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • quintus.pl -- Quintus compatibility
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • doc_latex.pl -- PlDoc LaTeX backend
      • crypt.pl
      • thread.pl -- High level thread primitives
      • xmlenc.pl -- XML encryption library
      • help.pl -- Text based manual
      • writef.pl -- Old-style formatted write
      • sgml_write.pl -- XML/SGML writer module
      • explain.pl -- Describe Prolog Terms
      • threadutil.pl -- Interactive thread utilities
      • redis.pl -- Redis client
      • hashtable.pl -- Hash tables
      • edit.pl -- Editor interface
      • prolog_debug.pl -- User level debugging tools
      • xmldsig.pl -- XML Digital signature
      • c14n2.pl -- C14n2 canonical XML documents
      • intercept.pl -- Intercept and signal interface
      • pwp.pl -- Prolog Well-formed Pages
      • streampool.pl -- Input multiplexing
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl -- Consistency checking
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • odbc.pl
      • stomp.pl -- STOMP client.
      • prolog_trace.pl -- Print access to predicates
      • optparse.pl -- command line parsing
      • macros.pl -- Macro expansion
      • rdf_parser.pl
      • rewrite_term.pl
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • doc_files.pl -- Create stand-alone documentation files
      • fastrw.pl -- Fast reading and writing of terms
      • make.pl -- Reload modified source files
      • system.pl -- System utilities
      • zip.pl -- Access resource ZIP archives
      • table.pl
      • prolog_profile.pl -- Execution profiler
      • shell.pl -- Elementary shell commands
      • test_cover.pl -- Clause coverage analysis
      • unicode.pl -- Unicode string handling
      • streams.pl -- Manage Prolog streams
      • redis_streams.pl -- Using Redis streams
      • increval.pl -- Incremental dynamic predicate modification
      • qsave.pl -- Save current program as a state or executable
      • archive.pl -- Access several archive formats
      • prolog_metainference.pl -- Infer meta-predicate properties
      • editline.pl -- BSD libedit based command line editing
      • rdf.pl -- RDF/XML parser
      • rdf_triple.pl -- Create triples from intermediate representation
      • files.pl
      • udp_broadcast.pl -- A UDP broadcast proxy
      • xsdp_types.pl -- XML-Schema primitive types
      • prolog_versions.pl -- Demand specific Prolog versions
      • rwlocks.pl -- Read/write locks
      • prolog_wrap.pl -- Wrapping predicates
      • paxos.pl -- A Replicated Data Store
      • double_metaphone.pl -- Phonetic string matching
      • mqi.pl
      • prolog_history.pl -- Per-directory persistent commandline history
 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)]).