/usr/local/lib/swipl/library/modules.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • debug.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl
      • broadcast.pl -- Event service
      • shlib.pl
      • option.pl -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl
      • settings.pl -- Setting management
      • arithmetic.pl
      • 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
      • pure_input.pl
      • solution_sequences.pl
      • ordsets.pl
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl
      • yall.pl
      • sandbox.pl -- Sandboxed Prolog code
      • 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 -- 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
      • 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
      • dialect.pl -- Support multiple Prolog dialects
      • system.pl
      • 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 -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • dicts.pl -- Dict utilities
      • dif.pl -- The dif/2 constraint
      • varnumbers.pl
      • pio.pl -- Pure I/O
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl
      • heaps.pl -- heaps/priority queues
      • rbtrees.pl
      • statistics.pl
      • when.pl
      • backcomp.pl -- Backward compatibility
      • nb_set.pl -- Non-backtrackable sets
      • tty.pl
      • thread.pl
      • exceptions.pl -- Exception classification
      • writef.pl
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl
      • oset.pl -- Ordered set manipulation
      • qsave.pl
      • zip.pl -- Access resource ZIP archives
      • prolog_autoload.pl
      • check.pl
      • prolog_codewalk.pl -- Prolog code walker
      • optparse.pl -- command line parsing
      • ctypes.pl -- Character code classification
      • shell.pl
      • portray_text.pl
      • help.pl -- Text based manual
      • make.pl
      • edit.pl -- Editor interface
      • hashtable.pl
      • strings.pl
      • quintus.pl -- Quintus compatibility
      • prolog_debug.pl
      • prolog_coverage.pl -- Coverage analysis tool
      • listing.pl -- List programs and pretty print clauses
      • prolog_metainference.pl -- Infer meta-predicate properties
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • threadutil.pl -- Interactive thread utilities
      • prolog_jiti.pl
      • files.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_config.pl -- Provide configuration information
      • prolog_profile.pl
      • intercept.pl -- Intercept and signal interface
      • prolog_trace.pl
      • prolog_wrap.pl -- Wrapping predicates
      • rwlocks.pl
      • explain.pl
      • macros.pl -- Macro expansion
      • streams.pl
      • readln.pl
      • fastrw.pl -- Fast reading and writing of terms
 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.