• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

/usr/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
      • 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
      • thread_pool.pl
      • gensym.pl
      • settings.pl -- Setting management
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl
      • record.pl -- Access compound arguments by name
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl -- Ordered set manipulation
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • iostream.pl -- Utilities to deal with streams
      • atom.pl -- Operations on atoms
      • prolog_pack.pl -- A package manager for Prolog
      • solution_sequences.pl -- Modify solution sequences
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • persistency.pl -- Provide persistent dynamic predicates
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl -- Non-backtrackable sets
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dialect.pl -- Support multiple Prolog dialects
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl -- Lambda expressions
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • rbtrees.pl -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • random.pl -- Random numbers
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • pprint.pl -- Pretty Print Prolog terms
      • modules.pl -- Module utility predicates
      • lazy_lists.pl -- Lazy list handling
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl -- Dict utilities
      • listing.pl -- List programs and pretty print clauses
      • threadutil.pl -- Interactive thread utilities
      • statistics.pl -- Get information about resource usage
      • backcomp.pl -- Backward compatibility
      • prolog_debug.pl -- User level debugging tools
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_profile.pl -- Execution profiler
      • date.pl -- Process dates and times
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • check.pl -- Consistency checking
      • sort.pl
      • tables.pl -- XSB interface to tables
      • charsio.pl -- I/O on Lists of Character Codes
      • writef.pl -- Old-style formatted write
      • optparse.pl -- command line parsing
      • strings.pl -- String utilities
      • intercept.pl -- Intercept and signal interface
      • zip.pl -- Access resource ZIP archives
      • varnumbers.pl -- Utilities for numbered terms
      • 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
      • terms.pl -- Term manipulation
      • when.pl -- Conditional coroutining
      • quintus.pl -- Quintus compatibility
      • edit.pl -- Editor interface
      • increval.pl -- Incremental dynamic predicate modification
      • prolog_coverage.pl -- Coverage analysis tool
      • rwlocks.pl -- Read/write locks
      • prolog_history.pl -- Per-directory persistent commandline history
      • macros.pl -- Macro expansion
      • oset.pl -- Ordered set manipulation
      • prolog_codewalk.pl -- Prolog code walker
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_autoload.pl -- Autoload all dependencies
      • streams.pl -- Manage Prolog streams
        • with_output_to/3
      • make.pl -- Reload modified source files
      • portray_text.pl -- Portray text
      • tty.pl -- Terminal operations
      • shell.pl -- Elementary shell commands
      • help.pl -- Text based manual
      • explain.pl -- Describe Prolog Terms
      • wfs.pl -- Well Founded Semantics interface
      • exceptions.pl -- Exception classification
      • prolog_config.pl -- Provide configuration information
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • qsave.pl -- Save current program as a state or executable
 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, _)).
ClioPatria (version V3.1.1-51-ga0b30a5)