/usr/local/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
      • 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
      • readutil.pl -- Read utilities
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • solution_sequences.pl
      • ordsets.pl
      • random.pl -- Random numbers
      • base64.pl
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • yall.pl -- Lambda expressions
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl
      • prolog_format.pl -- Analyse format specifications
      • predicate_options.pl -- Access and analyse predicate options
      • 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 cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl -- Lazy list handling
      • ugraphs.pl -- Graph manipulation library
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_pack.pl
      • git.pl
      • rbtrees.pl
      • dif.pl
      • charsio.pl -- I/O on Lists of Character Codes
      • prolog_stack.pl -- Examine the Prolog stack
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl
      • dialect.pl -- Support multiple Prolog dialects
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • quintus.pl -- Quintus compatibility
      • base32.pl
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl
      • date.pl -- Process dates and times
      • heaps.pl
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • when.pl
      • backcomp.pl
      • increval.pl
      • tables.pl -- XSB interface to tables
      • oset.pl
      • thread.pl -- High level thread primitives
      • edit.pl
      • make.pl -- Reload modified source files
      • shell.pl
      • ansi_term.pl
      • prolog_codewalk.pl
      • listing.pl -- List programs and pretty print clauses
      • prolog_metainference.pl -- Infer meta-predicate properties
      • persistency.pl
      • check.pl -- Consistency checking
      • writef.pl -- Old-style formatted write
      • prolog_debug.pl -- User level debugging tools
      • prolog_trace.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • strings.pl
      • threadutil.pl -- Interactive thread utilities
      • ctypes.pl -- Character code classification
      • prolog_profile.pl
      • explain.pl
      • rwlocks.pl
      • exceptions.pl -- Exception classification
      • qsave.pl
      • zip.pl -- Access resource ZIP archives
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_config.pl -- Provide configuration information
      • optparse.pl -- command line parsing
      • prolog_wrap.pl -- Wrapping predicates
        • wrap_predicate/4
        • unwrap_predicate/2
        • current_predicate_wrapper/4
      • macros.pl
      • help.pl -- Text based manual
      • fastrw.pl
      • system.pl -- System utilities
      • prolog_coverage.pl
      • hashtable.pl -- Hash tables
      • nb_set.pl
      • files.pl
      • streams.pl
      • prolog_autoload.pl
      • portray_text.pl
      • intercept.pl
      • prolog_jiti.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.