/usr/local/lib/swipl/library/streams.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
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • operators.pl
      • 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
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • yall.pl -- Lambda expressions
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • predicate_options.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl
      • atom.pl -- Operations on atoms
      • modules.pl
      • 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
      • 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
      • prolog_clause.pl
      • 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
      • iostream.pl -- Utilities to deal with streams
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • backcomp.pl -- Backward compatibility
      • thread.pl
      • prolog_wrap.pl
      • heaps.pl
      • files.pl
      • base32.pl
      • quintus.pl
      • shell.pl
      • date.pl
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • utf8.pl
      • when.pl
      • writef.pl -- Old-style formatted write
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • ansi_term.pl
      • help.pl -- Text based manual
      • qsave.pl
      • zip.pl -- Access resource ZIP archives
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl
      • prolog_autoload.pl
      • check.pl -- Consistency checking
      • macros.pl
      • portray_text.pl -- Portray text
      • nb_set.pl -- Non-backtrackable sets
      • optparse.pl -- command line parsing
      • strings.pl
      • ctypes.pl -- Character code classification
      • persistency.pl
      • listing.pl -- List programs and pretty print clauses
      • threadutil.pl -- Interactive thread utilities
      • edit.pl
      • increval.pl
      • tables.pl -- XSB interface to tables
      • prolog_profile.pl -- Execution profiler
      • make.pl -- Reload modified source files
      • prolog_debug.pl -- User level debugging tools
      • prolog_trace.pl
      • hashtable.pl
      • fastrw.pl
      • prolog_coverage.pl -- Coverage analysis tool
      • prolog_config.pl
      • oset.pl
      • explain.pl -- Describe Prolog Terms
      • prolog_history.pl -- Per-directory persistent commandline history
      • system.pl
      • streams.pl -- Manage Prolog streams
        • with_output_to/3
      • prolog_jiti.pl
      • exceptions.pl
      • intercept.pl -- Intercept and signal interface
      • rwlocks.pl
 with_output_to(?Output, :Goal, +Options) is det
Run Goal and once/1 while capturing all output to all streams (current_output, user_output and user_error) in the string Output. Options processed:
capture(ListOfStreams)
List of streams to capture. Default is [], causing the predicate to call with_output_to/2. The only admissible list elements are the alias names for the Prolog standard streams. As current_output is always captured, the only two values are user_output and user_error
color(Boolean)
When true, pretend the output is a terminal, causing messages to use ANSI term escape sequences for color.

For example, the following captures an error message. Note that we must catch and print the message inside Goal. If we do not do so the exception of Goal is simply propagated into the environment without binding Output.

?- with_output_to(string(Out),
                  catch(A is log(-1), E, print_message(error, E)),
                  [capture([user_error]), color(true)]).
Out = "\u001B[1;31mERROR: is/2: Arithmetic: \c
       evaluation error: `undefined'\n\u001B[0m",
E = error(evaluation_error(undefined), context(system:(is)/2, _)).