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

/usr/lib/swipl-7.5.1/library/prolog_stream.pl
AllApplicationManualNameSummaryHelp

  • swipl-7.5.1
    • library
      • doc_http.pl -- Documentation server
      • pldoc.pl -- Process source documentation
      • lists.pl -- List Manipulation
      • error.pl -- Error generating support
      • pairs.pl -- Operations on key-value lists
      • apply.pl -- Apply predicates on a list
      • memfile.pl
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • operators.pl -- Manage operators
      • debug.pl -- Print debug messages and test assertions
      • option.pl -- Option list processing
      • prolog_source.pl -- Examine Prolog source-files
      • socket.pl -- Network socket (TCP and UDP) library
      • thread_pool.pl -- Resource bounded thread management
      • rbtrees.pl -- Red black trees
      • gensym.pl -- Generate unique symbols
      • readutil.pl -- Read utilities
      • url.pl -- Analysing and constructing URL
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • uri.pl -- Process URIs
      • settings.pl -- Setting management
      • broadcast.pl -- Event service
      • arithmetic.pl -- Extensible arithmetic
      • sgml.pl -- SGML, XML and HTML parser
      • iostream.pl -- Utilities to deal with streams
      • dialect.pl -- Support multiple Prolog dialects
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • ordsets.pl -- Ordered set manipulation
      • oset.pl -- Ordered set manipulation
      • www_browser.pl -- Open a URL in the users browser
      • process.pl -- Create processes and redirect I/O
      • prolog_colour.pl -- Prolog syntax colouring support.
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • predicate_options.pl -- Access and analyse predicate options
      • prolog_clause.pl -- Get detailed source-information about a clause
      • occurs.pl -- Finding and counting sub-terms
      • listing.pl -- List programs and pretty print clauses
      • record.pl -- Access compound arguments by name
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • filesex.pl -- Extended operations on files
      • xpath.pl -- Select nodes in an XML DOM
      • prolog_pack.pl -- A package manager for Prolog
      • archive.pl -- Access several archive formats
      • rdf.pl
      • rdf_parser.pl
      • rewrite.pl
      • quintus.pl -- Quintus compatibility
      • rdf_triple.pl -- Create triples from intermediate representation
      • sgml_write.pl -- XML/SGML writer module
      • xsdp_types.pl -- XML-Schema primitive types
      • thread.pl -- High level thread primitives
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • sha.pl -- SHA secure hashes
      • crypt.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • tty.pl -- Terminal operations
      • terms.pl -- Term manipulation
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • when.pl -- Conditional coroutining
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • double_metaphone.pl -- Phonetic string matching
      • porter_stem.pl
      • nb_set.pl -- Non-backtrackable sets
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • system.pl -- System utilities
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • helpidx.pl
      • explain.pl -- Describe Prolog Terms
      • edit.pl -- Editor interface
      • make.pl -- Reload modified source files
      • check.pl -- Consistency checking
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • threadutil.pl -- Interactive thread utilities
      • statistics.pl -- Get information about resource usage
      • help.pl
      • backcomp.pl -- Backward compatibility
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • date.pl -- Process dates and times
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • rdf_ntriples.pl -- RDF N-triples parser (obsolete)
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dif.pl -- The dif/2 constraint
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_stack.pl -- Examine the Prolog stack
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • charsio.pl -- I/O on Lists of Character Codes
      • modules.pl -- Module utility predicates
      • term_to_json.pl
      • editline.pl -- BSD libedit based command line editing
      • console_input.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • base32.pl -- Base32 encoding and decoding
      • xmldsig.pl -- XML Digital signature
      • c14n2.pl -- C14n2 canonical XML documents
      • dicts.pl -- Dict utilities
      • pwp.pl -- Prolog Well-formed Pages
      • qsave.pl -- Save current program as a state or executable
      • prolog_autoload.pl -- Autoload all dependencies
      • files.pl
      • udp_broadcast.pl -- A UDP Broadcast Bridge
      • uid.pl -- User and group management on Unix systems
      • cgi.pl -- Read CGI parameters
      • bdb.pl -- Berkeley DB interface
      • chr.pl
      • sort.pl
      • unix.pl -- Unix specific operations
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • yall.pl -- Lambda expressions
      • prolog_stream.pl -- A stream with Prolog callbacks
        • open_prolog_stream/4
      • protobufs.pl -- Google's Protocol Buffers
      • odbc.pl
      • random.pl -- Random numbers
      • readline.pl -- GNU readline interface
      • optparse.pl -- command line parsing
      • writef.pl -- Old-style formatted write
      • hash_stream.pl -- Maintain a hash on a stream
      • varnumbers.pl -- Utilities for numbered terms
      • doc_latex.pl -- PlDoc LaTeX backend
      • plunit.pl -- Unit Testing
      • unicode.pl -- Unicode string handling
      • shell.pl -- Elementary shell commands
      • syslog.pl -- Unix syslog interface
      • win_menu.pl -- Console window menu
      • md5.pl -- MD5 hashes
      • isub.pl -- isub: a string similarity measure
      • tabling.pl -- Tabled execution (SLG WAM)
      • rlimit.pl
      • doc_files.pl -- Create stand-alone documentation files
      • main.pl -- Provide entry point for scripts
      • test_cover.pl -- Clause cover analysis
      • xmlenc.pl -- XML encryption library
      • table.pl
      • streampool.pl
      • pdt_console.pl
open_prolog_stream(+Module, +Mode, -Stream, +Options)
Create a new stream that implements its I/O by calling predicates in Module. The called predicates are:
Module:stream_write(+Stream,+String)
Called for a Mode = write stream if data is available. String contains the (textual) data that is written to Stream. The callback is called if the buffer of Stream overflows, the user calls flush_output(Stream) or Stream is closed and there is buffered data.
Module:stream_read(+Stream,-Term)
Called for a Mode == read stream to get new data. On success the stream extracts text from the provided Term. Term is typically a string, atom, code or character list. If term is not one of the above, it is handed to writeq/1. To signal end-of-file, unify stream with an empty text, e.g., stream_read(Stream, "").
Module:stream_close(+Stream)
Called when the stream is closed. This predicate must succeed. The callback can be used to cleanup associated resources.

The current implementation only deals with text streams. The stream uses the wchar_t encoding. The buffer size must be a multiple of wchar_t, i.e., a multiple of four for portability. The newline mode of the stream is posix on all platforms, disabling the translation "\n" --> "\r\n".

Arguments:
Options- is currently ignored.
bug
- Futher versions might require additional callbacks. As we demand all callbacks to be defined, existing code needs to implement the new callbacks.
ClioPatria (version V3.0.0-338-gc91dba5-DIRTY)