/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
      • broadcast.pl -- Event service
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl
      • yall.pl -- Lambda expressions
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • 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 -- Module utility predicates
      • 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 -- Open a URL in the users browser
      • prolog_pack.pl
      • git.pl
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • dialect.pl -- Support multiple Prolog dialects
      • system.pl -- System utilities
      • terms.pl
      • date.pl -- Process dates and times
      • persistency.pl -- Provide persistent dynamic predicates
      • iostream.pl -- Utilities to deal with streams
      • prolog_stack.pl -- Examine the Prolog stack
      • edinburgh.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl -- Well Founded Semantics interface
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • dicts.pl -- Dict utilities
      • dif.pl -- The dif/2 constraint
      • varnumbers.pl -- Utilities for numbered terms
      • pio.pl
      • prolog_debug.pl -- User level debugging tools
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • heaps.pl -- heaps/priority queues
      • rbtrees.pl -- Red black trees
      • statistics.pl
      • when.pl -- Conditional coroutining
      • backcomp.pl
      • check.pl
      • thread.pl
      • prolog_trace.pl
      • threadutil.pl -- Interactive thread utilities
      • writef.pl -- Old-style formatted write
      • listing.pl
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • quintus.pl
      • shell.pl -- Elementary shell commands
      • prolog_versions.pl
      • prolog_config.pl
      • oset.pl -- Ordered set manipulation
      • intercept.pl -- Intercept and signal interface
      • hashtable.pl
      • prolog_profile.pl -- Execution profiler
      • fastrw.pl
      • prolog_coverage.pl -- Coverage analysis tool
      • edit.pl
      • make.pl -- Reload modified source files
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • ctypes.pl -- Character code classification
      • nb_set.pl
      • files.pl
      • optparse.pl -- command line parsing
      • streams.pl
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • qsave.pl
      • zip.pl -- Access resource ZIP archives
      • rwlocks.pl
      • macros.pl -- Macro expansion
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_wrap.pl -- Wrapping predicates
        • wrap_predicate/4
        • unwrap_predicate/2
        • current_predicate_wrapper/4
      • readln.pl
      • help.pl -- Text based manual
      • portray_text.pl
      • exceptions.pl -- Exception classification
      • strings.pl
      • explain.pl -- Describe Prolog Terms
      • tty.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_metainference.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.