/usr/local/lib/swipl/library/modules.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
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • 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 -- 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
      • 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
      • 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
      • lazy_lists.pl -- Lazy list handling
      • ugraphs.pl -- Graph manipulation library
      • iostream.pl -- Utilities to deal with streams
      • 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
      • rbtrees.pl -- Red black trees
      • dif.pl -- The dif/2 constraint
      • 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 -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • dialect.pl -- Support multiple Prolog dialects
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • backcomp.pl -- Backward compatibility
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • when.pl -- Conditional coroutining
      • intercept.pl -- Intercept and signal interface
      • quintus.pl -- Quintus compatibility
      • prolog_debug.pl -- User level debugging tools
      • listing.pl -- List programs and pretty print clauses
      • system.pl -- System utilities
      • prolog_profile.pl -- Execution profiler
      • persistency.pl -- Provide persistent dynamic predicates
      • check.pl -- Consistency checking
      • prolog_codewalk.pl -- Prolog code walker
      • files.pl
      • thread.pl -- High level thread primitives
      • make.pl -- Reload modified source files
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_coverage.pl -- Coverage analysis tool
      • fastrw.pl -- Fast reading and writing of terms
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • macros.pl -- Macro expansion
      • nb_set.pl -- Non-backtrackable sets
      • oset.pl -- Ordered set manipulation
      • portray_text.pl -- Portray text
      • prolog_config.pl -- Provide configuration information
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • shell.pl -- Elementary shell commands
      • optparse.pl -- command line parsing
      • strings.pl -- String utilities
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_trace.pl -- Print access to predicates
      • prolog_wrap.pl -- Wrapping predicates
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • edit.pl -- Editor interface
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • rwlocks.pl -- Read/write locks
      • writef.pl -- Old-style formatted write
      • explain.pl -- Describe Prolog Terms
      • threadutil.pl -- Interactive thread utilities
      • help.pl -- Text based manual
      • prolog_history.pl -- Per-directory persistent commandline history
      • streams.pl -- Manage Prolog streams
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • exceptions.pl -- Exception classification
 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.