• 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
      • 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 -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • 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 -- 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
      • 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 -- 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 -- 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 -- Lazy list handling
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl -- Dict utilities
      • help.pl -- Text based manual
      • tables.pl -- XSB interface to tables
      • tableutil.pl -- Table inspection and statistics utilities
      • listing.pl -- List programs and pretty print clauses
      • prolog_profile.pl -- Execution profiler
      • date.pl -- Process dates and times
      • backcomp.pl -- Backward compatibility
      • edit.pl
      • make.pl -- Reload modified source files
      • threadutil.pl -- Interactive thread utilities
      • shell.pl -- Elementary shell commands
      • optparse.pl -- command line parsing
      • prolog_codewalk.pl
      • check.pl
      • heaps.pl -- heaps/priority queues
      • terms.pl
      • quintus.pl
      • strings.pl -- String utilities
      • prolog_stack.pl -- Examine the Prolog stack
      • wfs.pl
      • statistics.pl -- Get information about resource usage
      • charsio.pl -- I/O on Lists of Character Codes
      • oset.pl -- Ordered set manipulation
      • increval.pl
      • coinduction.pl -- Co-Logic Programming
      • varnumbers.pl -- Utilities for numbered terms
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • explain.pl
      • 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
      • sort.pl
      • fastrw.pl
      • portray_text.pl
      • intercept.pl -- Intercept and signal interface
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • codesio.pl -- I/O on Lists of Character Codes
      • prolog_wrap.pl
      • prolog_debug.pl -- User level debugging tools
      • prolog_metainference.pl -- Infer meta-predicate properties
      • base32.pl -- Base32 encoding and decoding
      • when.pl -- Conditional coroutining
      • prolog_autoload.pl -- Autoload all dependencies
      • system.pl -- System utilities
      • prolog_config.pl
      • prolog_trace.pl
      • rwlocks.pl
      • zip.pl -- Access resource ZIP archives
      • streams.pl -- Manage Prolog streams
      • tty.pl -- Terminal operations
      • prolog_history.pl -- Per-directory persistent commandline history
      • writef.pl -- Old-style formatted write
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_qlfmake.pl -- Compile the library to QLF format
      • hashtable.pl -- Hash tables
      • exceptions.pl -- Exception classification
      • files.pl
      • macros.pl
      • qsave.pl
 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)