listing.pl -- List programs and pretty print clauses

This module implements listing code from the internal representation in a human readable format.

• listing/0 lists a module.
• listing/1 lists a predicate or matching clause
• listing/2 lists a predicate or matching clause with options
• portray_clause/2 pretty-prints a clause-term

Layout can be customized using library(settings). The effective settings can be listed using list_settings/1 as illustrated below. Settings can be changed using set_setting/2.

?- list_settings(listing).
========================================================================
Name                      Value (*=modified) Comment
========================================================================
listing:body_indentation  4              Indentation used goals in the body
listing:tab_distance      0              Distance between tab-stops.
...

To be done

- More settings, support Coding Guidelines for Prolog and make the suggestions there the default.

- Provide persistent user customization

 listing

Lists all predicates defined in the calling module. Imported predicates are not listed. To list the content of the module mymodule, use one of the calls below.

?- mymodule:listing.
?- listing(mymodule:_).

 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)]).

 portray_clause(+Clause) is det

 portray_clause(+Out:stream, +Clause) is det

 portray_clause(+Out:stream, +Clause, +Options) is det

Portray `Clause' on the current output stream. Layout of the clause is to our best standards. Deals with control structures and calls via meta-call predicates as determined using the predicate property meta_predicate. If Clause contains attributed variables, these are treated as normal variables.

Variable names are by default generated using numbervars/4 using the option singletons(true). This names the variables A, B, ... and the singletons _. Variables can be named explicitly by binding them to a term '$VAR'(Name), where Name is an atom denoting a valid variable name (see the option numbervars(true) from write_term/2) as well as by using the variable_names(Bindings) option from write_term/2.

Options processed in addition to write_term/2 options:

variable_names(+Bindings)

See above and write_term/2.

indent(+Columns)

Left margin used for the clause. Default 0.

module(+Module)

Module used to determine whether a goal resolves to a meta predicate. Default user.

Re-exported predicates

The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.

 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)]).

 portray_clause(+Clause) is det

 portray_clause(+Out:stream, +Clause) is det

 portray_clause(+Out:stream, +Clause, +Options) is det

Portray `Clause' on the current output stream. Layout of the clause is to our best standards. Deals with control structures and calls via meta-call predicates as determined using the predicate property meta_predicate. If Clause contains attributed variables, these are treated as normal variables.

Variable names are by default generated using numbervars/4 using the option singletons(true). This names the variables A, B, ... and the singletons _. Variables can be named explicitly by binding them to a term '$VAR'(Name), where Name is an atom denoting a valid variable name (see the option numbervars(true) from write_term/2) as well as by using the variable_names(Bindings) option from write_term/2.

Options processed in addition to write_term/2 options:

variable_names(+Bindings)

See above and write_term/2.

indent(+Columns)

Left margin used for the clause. Default 0.

module(+Module)

Module used to determine whether a goal resolves to a meta predicate. Default user.

 portray_clause(+Clause) is det

 portray_clause(+Out:stream, +Clause) is det

 portray_clause(+Out:stream, +Clause, +Options) is det

Portray `Clause' on the current output stream. Layout of the clause is to our best standards. Deals with control structures and calls via meta-call predicates as determined using the predicate property meta_predicate. If Clause contains attributed variables, these are treated as normal variables.

Variable names are by default generated using numbervars/4 using the option singletons(true). This names the variables A, B, ... and the singletons _. Variables can be named explicitly by binding them to a term '$VAR'(Name), where Name is an atom denoting a valid variable name (see the option numbervars(true) from write_term/2) as well as by using the variable_names(Bindings) option from write_term/2.

Options processed in addition to write_term/2 options:

variable_names(+Bindings)

See above and write_term/2.

indent(+Columns)

Left margin used for the clause. Default 0.

module(+Module)

Module used to determine whether a goal resolves to a meta predicate. Default user.