• 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 -- List Manipulation
      • 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 -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • 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 -- Define Quasi Quotation syntax
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl -- Prolog syntax colouring support.
      • 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 -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • persistency.pl -- Provide persistent dynamic predicates
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl -- Non-backtrackable sets
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • iostream.pl -- Utilities to deal with streams
      • dialect.pl -- Support multiple Prolog dialects
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl
      • 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 -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • 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 -- Dict utilities
      • tables.pl -- XSB interface to tables
      • threadutil.pl -- Interactive thread utilities
      • base32.pl
      • date.pl
      • backcomp.pl -- Backward compatibility
      • prolog_trace.pl
      • intercept.pl -- Intercept and signal interface
      • prolog_stack.pl -- Examine the Prolog stack
      • oset.pl -- Ordered set manipulation
      • 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
      • prolog_coverage.pl -- Coverage analysis tool
      • zip.pl -- Access resource ZIP archives
      • check.pl -- Consistency checking
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_wrap.pl -- Wrapping predicates
      • make.pl -- Reload modified source files
      • optparse.pl -- command line parsing
      • prolog_debug.pl -- User level debugging tools
      • shell.pl
      • prolog_codewalk.pl -- Prolog code walker
      • charsio.pl -- I/O on Lists of Character Codes
      • prolog_history.pl
      • prolog_config.pl
      • explain.pl
      • files.pl
      • wfs.pl -- Well Founded Semantics interface
      • prolog_metainference.pl
      • writef.pl -- Old-style formatted write
      • edit.pl -- Editor interface
      • prolog_autoload.pl
      • heaps.pl
      • system.pl -- System utilities
      • increval.pl -- Incremental dynamic predicate modification
      • tty.pl
      • codesio.pl
      • hashtable.pl -- Hash tables
      • macros.pl
      • terms.pl -- Term manipulation
      • coinduction.pl -- Co-Logic Programming
      • sort.pl
      • statistics.pl -- Get information about resource usage
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl
      • strings.pl -- String utilities
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • streams.pl -- Manage Prolog streams
      • help.pl
      • tableutil.pl
      • qsave.pl
      • portray_text.pl
      • fastrw.pl -- Fast reading and writing of terms
      • rwlocks.pl
      • prolog_qlfmake.pl -- Compile the library to QLF format
      • prolog_jiti.pl
      • exceptions.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)]).
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)