• 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/prolog_coverage.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
      • 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
        • coverage/1
        • coverage/2
        • show_coverage/1
        • report_hook/2
        • cov_save_data/2
        • cov_load_data/2
        • cov_reset/0
        • cov_property/1
      • 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
 show_coverage(+Options) is det
Show collected coverage data. By default it reports the percentage of called and failed clauses related to covered files. Using dir(Dir), detailed line-by-line annotated files are created in the directory Dir. Other options control the level of detail.
all(+Boolean)
When true, report on any file in which some predicate was called.
modules(+Modules)
Only report on files that implement one of the given Modules.
roots(+Directories)
Only report on files below one of the given roots. Each directory in Directories can be a specification for absolute_file_name/3.
annotate(+Bool)
Create an annotated file for the detailed results. This is implied if the ext or dir option are specified.
ext(+Ext)
Extension to use for the annotated file. Default is `.cov`.
dir(+Dir)
Dump the annotations in the given directory. If not given, the annotated files are created in the same directory as the source file. Each clause that is related to a physical line in the file is annotated with one of:
###Clause was never executed.
++NClause was entered N times and always succeeded
--NClause was entered N times and never succeeded
+N-MClause has succeeded N times and failed M times
+N*MClause was entered N times and succeeded M times

All call sites are annotated using the same conventions, except that --- is used to annotate subgoals that were never called.

line_numbers(Boolean)
If true (default), add line numbers to the annotated file.
color(Boolean)
Controls using ANSI escape sequences to color the output in the annotated source. Default is true.
width(+Columns)
Presumed width of the output window. A value of 40 is considered the minimum. Smaller values are handled as 40.

For example, run a goal and create annotated files in a directory cov using:

?- show_coverage([dir(cov)]).
bug
- Color annotations are created using ANSI escape sequences. On most systems these are displayed if the file is printed on the terminal. On most systems less may be used with the -r flag. Alternatively, programs such as ansi2html (Linux) may be used to convert the files to HTML. It would probably be better to integrate the output generation with library(pldoc/doc_htmlsrc).
ClioPatria (version V3.1.1-59-g7b9a7a3)