/usr/lib/swipl/library/modules.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl
      • broadcast.pl
      • socket.pl
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl
      • option.pl
      • uid.pl
      • unix.pl
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl
      • settings.pl
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • ssl.pl
      • crypto.pl -- Cryptography and authentication library
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • 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
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • 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
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • optparse.pl -- command line parsing
      • prolog_debug.pl -- User level debugging tools
      • threadutil.pl -- Interactive thread utilities
      • nb_set.pl -- Non-backtrackable sets
      • backcomp.pl -- Backward compatibility
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • charsio.pl -- I/O on Lists of Character Codes
      • streampool.pl -- Input multiplexing
      • redis.pl -- Redis client
      • redis_streams.pl -- Using Redis streams
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_metainference.pl -- Infer meta-predicate properties
      • intercept.pl -- Intercept and signal interface
      • c14n2.pl -- C14n2 canonical XML documents
      • sgml_write.pl -- XML/SGML writer module
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl -- Consistency checking
      • mqi.pl
      • thread.pl -- High level thread primitives
      • make.pl -- Reload modified source files
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • paxos.pl -- A Replicated Data Store
      • editline.pl -- BSD libedit based command line editing
      • heaps.pl -- heaps/priority queues
      • 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
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • odbc.pl
      • portray_text.pl -- Portray text
      • doc_latex.pl -- PlDoc LaTeX backend
      • udp_broadcast.pl -- A UDP broadcast proxy
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • plunit.pl -- Unit Testing
      • edit.pl -- Editor interface
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • yaml.pl -- Process YAML data
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • prolog_wrap.pl -- Wrapping predicates
      • table.pl
      • isub.pl -- isub: a string similarity measure
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • xsdp_types.pl -- XML-Schema primitive types
      • xmlenc.pl -- XML encryption library
      • prolog_profile.pl -- Execution profiler
      • xmldsig.pl -- XML Digital signature
      • stomp.pl -- STOMP client.
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • archive.pl -- Access several archive formats
      • crypt.pl
      • readline.pl -- GNU readline interface
      • hashtable.pl -- Hash tables
      • unicode.pl -- Unicode string handling
      • double_metaphone.pl -- Phonetic string matching
      • rdf.pl -- RDF/XML parser
      • prolog_trace.pl -- Print access to predicates
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • writef.pl -- Old-style formatted write
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_history.pl -- Per-directory persistent commandline history
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • shell.pl -- Elementary shell commands
      • macros.pl -- Macro expansion
      • streams.pl -- Manage Prolog streams
      • test_cover.pl -- Clause coverage analysis
      • doc_files.pl -- Create stand-alone documentation files
      • rwlocks.pl -- Read/write locks
      • readln.pl -- Read line as list of tokens
      • help.pl -- Text based manual
      • files.pl
      • explain.pl -- Describe Prolog Terms
      • prolog_versions.pl -- Demand specific Prolog versions
      • rlimit.pl
      • oset.pl -- Ordered set manipulation
      • cgi.pl -- Read CGI parameters
      • pwp.pl -- Prolog Well-formed Pages
      • tty.pl -- Terminal operations
 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.