/usr/lib/swipl/library/prolog_wrap.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
      • shlib.pl
      • option.pl
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl
      • readutil.pl
      • operators.pl
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • record.pl
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl
      • assoc.pl
      • prolog_format.pl
      • pure_input.pl -- Pure Input from files and streams
      • solution_sequences.pl
      • ordsets.pl -- Ordered set manipulation
      • random.pl
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • predicate_options.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • modules.pl
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl
      • ugraphs.pl -- Graph manipulation library
      • url.pl
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • git.pl
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • quintus.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • prolog_wrap.pl -- Wrapping predicates
        • wrap_predicate/4
        • unwrap_predicate/2
        • current_predicate_wrapper/4
      • dialect.pl
      • date.pl -- Process dates and times
      • persistency.pl -- Provide persistent dynamic predicates
      • iostream.pl -- Utilities to deal with streams
      • prolog_code.pl
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • terms.pl
      • ansi_term.pl
      • threadutil.pl -- Interactive thread utilities
      • prolog_stack.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl -- Well Founded Semantics interface
      • sort.pl
      • dicts.pl
      • varnumbers.pl -- Utilities for numbered terms
      • rbtrees.pl -- Red black trees
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl
      • coinduction.pl -- Co-Logic Programming
      • heaps.pl -- heaps/priority queues
      • statistics.pl
      • when.pl -- Conditional coroutining
      • backcomp.pl
      • ctypes.pl -- Character code classification
      • increval.pl
      • tables.pl -- XSB interface to tables
      • listing.pl -- List programs and pretty print clauses
      • qsave.pl
      • tty.pl -- Terminal operations
      • zip.pl
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl
      • optparse.pl
      • prolog_debug.pl -- User level debugging tools
      • make.pl
      • prolog_coverage.pl
      • prolog_codewalk.pl -- Prolog code walker
      • readln.pl
      • nb_set.pl -- Non-backtrackable sets
      • shell.pl
      • intercept.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • help.pl
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_config.pl -- Provide configuration information
      • system.pl -- System utilities
      • writef.pl
      • vm.pl
      • prolog_profile.pl -- Execution profiler
      • edit.pl -- Editor interface
      • explain.pl -- Describe Prolog Terms
      • qpforeign.pl
      • prolog_jiti.pl
      • prolog_trace.pl
      • thread.pl -- High level thread primitives
      • files.pl
      • streams.pl -- Manage Prolog streams
      • exceptions.pl
      • fastrw.pl
      • macros.pl
      • nb_rbtrees.pl
      • prolog_deps.pl
      • rwlocks.pl
      • portray_text.pl -- Portray text
      • hashtable.pl
      • check_installation.pl -- Check installation issues and features
      • oset.pl
      • pio.pl
 wrap_predicate(:Head, +Name, -Wrapped, +Body) is det
Wrap the predicate referenced by Head using Body. Subsequent calls to Head call the given Body term. Body may call the original definition through Wrapped. Wrapped is a term of the shape below, where Closure is an opaque blob.
call(Closure(A1, ...))

Name names the wrapper for inspection using predicate_property/2 or deletion using unwrap_predicate/2. If Head has a wrapper with Name the Body of the existing wrapper is updated without changing the order of the registered wrappers. The same predicate may be wrapped multiple times. Multiple wrappers are executed starting with the last registered (outermost).

The predicate referenced by Head does not need to be defined at the moment the wrapper is installed. If Head is undefined, the predicate is created instead of searched for using e.g., the auto loader.

Registered wrappers are not part of saved states (see qsave_program/2) and thus need to be re-registered, for example using initialization/1.

An example of using wrap_predicate/4 for computing GCD:

    :- wrap_predicate(gcd(A,B,Gcd), gcd_wrap, W, gcd_wrap(W, A, B, Gcd)).

    gcd(X, Y, Gcd), X < Y => gcd(X, Y-X, Gcd).
    gcd(X, Y, Gcd), X > Y => gcd(Y, X-Y, Gcd).
    gcd(X, _, Gcd) => Gcd = X.

    gcd_wrap(call(Closure), X, Y, Gcd) :-
        functor(Closure, ClosureBlob, 3),
        X_eval is X,
        Y_eval is Y,
        call(ClosureBlob, X_eval, Y_eval, Gcd).

or (less efficient):

    gcd_wrap(call(Closure), X, Y, Gcd) :-
        functor(Closure, ClosureBlob, 3),
        call(ClosureBlob, X_eval, Y_eval, G),
        Gcd is G.