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

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl
      • debug.pl
      • broadcast.pl -- Event service
      • socket.pl
      • predicate_options.pl
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • uid.pl -- User and group management on Unix systems
      • unix.pl
      • syslog.pl
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • 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
      • 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
      • nb_set.pl -- Non-backtrackable sets
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • 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
      • rbtrees.pl -- Red black trees
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • backcomp.pl -- Backward compatibility
      • intercept.pl -- Intercept and signal interface
      • check.pl -- Consistency checking
      • plunit.pl -- Unit Testing
      • rdf_triple.pl -- Create triples from intermediate representation
      • unicode.pl -- Unicode string handling
      • prolog_profile.pl -- Execution profiler
      • prolog_stream.pl -- A stream with Prolog callbacks
      • redis.pl -- Redis client
      • sgml_write.pl -- XML/SGML writer module
      • udp_broadcast.pl -- A UDP broadcast proxy
      • prolog_metainference.pl -- Infer meta-predicate properties
      • fastrw.pl -- Fast reading and writing of terms
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • stomp.pl -- STOMP client.
      • cgi.pl -- Read CGI parameters
      • xmlenc.pl -- XML encryption library
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_versions.pl -- Demand specific Prolog versions
      • thread.pl -- High level thread primitives
      • zip.pl -- Access resource ZIP archives
      • editline.pl -- BSD libedit based command line editing
      • archive.pl -- Access several archive formats
      • optparse.pl -- command line parsing
      • double_metaphone.pl -- Phonetic string matching
      • portray_text.pl -- Portray text
      • prolog_debug.pl -- User level debugging tools
      • threadutil.pl -- Interactive thread utilities
      • shell.pl -- Elementary shell commands
      • test_cover.pl -- Clause coverage analysis
      • rdf.pl -- RDF/XML parser
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • paxos.pl -- A Replicated Data Store
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • make.pl -- Reload modified source files
      • table.pl
      • hashtable.pl -- Hash tables
      • rwlocks.pl -- Read/write locks
      • prolog_trace.pl -- Print access to predicates
      • odbc.pl
      • xmldsig.pl -- XML Digital signature
      • c14n2.pl -- C14n2 canonical XML documents
      • crypt.pl
      • edit.pl -- Editor interface
      • prolog_wrap.pl -- Wrapping predicates
      • readline.pl -- GNU readline interface
      • yaml.pl -- Process YAML data
        • yaml_read/2
        • yaml_write/2
        • yaml_write/3
        • tagged/3
      • redis_streams.pl -- Using Redis streams
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • isub.pl -- isub: a string similarity measure
      • writef.pl -- Old-style formatted write
      • rlimit.pl
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • pwp.pl -- Prolog Well-formed Pages
      • readln.pl -- Read line as list of tokens
      • streampool.pl -- Input multiplexing
      • oset.pl -- Ordered set manipulation
      • mqi.pl
      • quintus.pl -- Quintus compatibility
 yaml_read(+Input, -DOM) is det
Parse Input to a YAML DOM. The DOM representation uses the following mapping:
  • A YAML sequence is mapped to a Prolog List.
  • A YAML mapping is mapped to a Prolog dict.
  • Untagged scalars follow the implicit tag rules defined by YAML, providing numbers (int, float and special floats), null and the booleans true and false. Other untagged values are returned as a Prolog string. Tagged values are returned as tag(Tag, String) which is processed by yalm_tagged/3. This internal predicate calls the user hook yaml:tagged/3 with the same arguments and, if the hook fails, provides the following defaults:
    • !!binary converts the Base64 to a string of bytes.
    • !!str explicitly keeps a string
    • !!null translates "null" to null
    • !!bool translates to true and false
    • !!int translates to an integer
    • !!float translates to a float
    • Anything else is returned as tag(Tag, String)
Arguments:
Input- is one of (1) a stream, (2) a term string(Data) or (3) a file name.
bug
- YAML defines that floats do not require a digit after the decimal dot. We use the Prolog parser which does require the decimal dot to be followed by at least one digit. Because the YAML spec intends to match JSON which does require a digit, we ignore this incompatibility, expecting it will be addressed in the next YAML version.