/usr/lib/swipl/library/modules.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 -- 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 -- 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
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl -- Lambda expressions
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • pure_input.pl -- Pure Input from files and streams
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • 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
        • in_temporary_module/3
        • current_temporary_module/1
      • 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 -- A package manager for Prolog
      • git.pl -- Run GIT commands
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • quintus.pl -- Quintus compatibility
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • prolog_wrap.pl -- Wrapping predicates
      • dialect.pl -- Support multiple Prolog dialects
      • date.pl -- Process dates and times
      • persistency.pl -- Provide persistent dynamic predicates
      • iostream.pl -- Utilities to deal with streams
      • prolog_code.pl -- Utilities for reasoning about code
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • terms.pl -- Term manipulation
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • threadutil.pl -- Interactive thread utilities
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • rbtrees.pl -- Red black trees
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • base32.pl -- Base32 encoding and decoding
      • ctypes.pl -- Character code classification
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • statistics.pl -- Get information about resource usage
      • heaps.pl -- heaps/priority queues
      • when.pl -- Conditional coroutining
      • optparse.pl -- command line parsing
      • prolog_debug.pl -- User level debugging tools
      • listing.pl -- List programs and pretty print clauses
      • shell.pl -- Elementary shell commands
      • thread.pl -- High level thread primitives
      • readln.pl -- Read line as list of tokens
      • make.pl -- Reload modified source files
      • prolog_deps.pl
      • nb_set.pl -- Non-backtrackable sets
      • check_installation.pl -- Check installation issues and features
      • check.pl -- Consistency checking
      • oset.pl -- Ordered set manipulation
      • vm.pl
      • increval.pl
      • tables.pl -- XSB interface to tables
      • prolog_jiti.pl
      • rwlocks.pl -- Read/write locks
      • qsave.pl
      • explain.pl -- Describe Prolog Terms
      • zip.pl -- Access resource ZIP archives
      • fastrw.pl
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_coverage.pl
      • writef.pl -- Old-style formatted write
      • intercept.pl -- Intercept and signal interface
      • help.pl
      • edit.pl
      • system.pl
      • prolog_config.pl
      • prolog_autoload.pl -- Autoload all dependencies
      • hashtable.pl
      • files.pl
      • prolog_trace.pl
      • portray_text.pl
      • prolog_profile.pl
      • prolog_metainference.pl
      • exceptions.pl -- Exception classification
      • tty.pl
      • streams.pl
      • qpforeign.pl
 in_temporary_module(?Module, :Setup, :Goal)
Run Goal on temporary loaded sources and discard the module and loaded predicates after completion. This predicate performs the following steps:
  1. If Module is unbound, create a unique identifier for it.
  2. Turn Module into a temporary module using set_module/1. Note that this requires the module to be non-existent or empty. If Module is specified, it should typically be set to a unique value as obtained from e.g. uuid/1.
  3. Run Setup in the context of Module.
  4. If setup succeeded possible choice points are discarded and Goal is started.

The logical result of this predicate is the same as `(Setup@Module -> Goal@Module)`, i.e., both Setup and Goal are resolved relative to the current module, but executed in the context of Module. If Goal must be called in Module, use call(Goal).

The module and all its predicates are destroyed after Goal terminates, as defined by setup_call_cleanup/3.

Discussion This predicate is intended to load programs in an isolated environment and reclaim all resources. This unfortunately is incomplete:

  • Running the code may leave side effects such as creating records, flags, changing Prolog flags, etc. The system has no provisions to track this.
  • So called functors (name/arity pairs) are not yet subject to garbage collection. Functors are both used to define predicates and to create compound terms.
See also
- library(sandbox) determines whether unknown goals are safe to call.
- load_files/2 offers the option sandboxed(true) to load code from unknown sources safely.