• 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

/home/swipl/lib/swipl/library/pcre.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl -- List Manipulation
      • debug.pl
      • broadcast.pl -- Event service
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • uid.pl -- User and group management on Unix systems
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • filesex.pl
      • doc_http.pl -- Documentation server
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • uri.pl -- Process URIs
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl -- Prolog syntax colouring support.
      • 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
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • atom.pl -- Operations on atoms
      • porter_stem.pl
      • solution_sequences.pl -- Modify solution sequences
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • process.pl -- Create processes and redirect I/O
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • time.pl -- Time and alarm library
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • sha.pl -- SHA secure hashes
      • crypt.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • memfile.pl
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl -- Non-backtrackable sets
      • xsdp_types.pl -- XML-Schema primitive types
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
        • re_match/2
        • re_match/3
        • re_matchsub/3
        • re_matchsub/4
        • re_foldl/6
        • re_split/3
        • re_split/4
        • re_replace/4
        • re_replace/5
        • re_compile/3
        • re_flush/0
        • re_config/1
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rdf.pl -- RDF/XML parser
      • sgml_write.pl -- XML/SGML writer module
      • archive.pl -- Access several archive formats
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dialect.pl -- Support multiple Prolog dialects
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • rbtrees.pl -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • yall.pl -- Lambda expressions
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • random.pl -- Random numbers
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • 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
      • 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
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • redis.pl -- Redis client
      • terms.pl -- Term manipulation
      • jpl.pl -- A Java interface for SWI Prolog 7.x
      • intercept.pl -- Intercept and signal interface
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_stack.pl -- Examine the Prolog stack
      • codesio.pl -- I/O on Lists of Character Codes
      • heaps.pl -- heaps/priority queues
      • backcomp.pl -- Backward compatibility
      • date.pl -- Process dates and times
      • prolog_debug.pl -- User level debugging tools
      • prolog_profile.pl -- Execution profiler
      • listing.pl -- List programs and pretty print clauses
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • unicode.pl -- Unicode string handling
      • stomp.pl -- STOMP client.
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • plunit.pl -- Unit Testing
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • strings.pl -- String utilities
      • base32.pl -- Base32 encoding and decoding
      • c14n2.pl -- C14n2 canonical XML documents
      • cgi.pl -- Read CGI parameters
      • doc_files.pl -- Create stand-alone documentation files
      • editline.pl -- BSD libedit based command line editing
      • explain.pl -- Describe Prolog Terms
      • files.pl
      • help.pl -- Text based manual
      • isub.pl -- isub: a string similarity measure
      • doc_latex.pl -- PlDoc LaTeX backend
      • mqi.pl
      • optparse.pl -- command line parsing
      • term_to_json.pl
      • make.pl -- Reload modified source files
      • odbc.pl
      • oset.pl -- Ordered set manipulation
      • paxos.pl -- A Replicated Data Store
      • pdt_console.pl
      • prolog_trace.pl -- Print access to predicates
      • prolog_wrap.pl -- Wrapping predicates
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • wfs.pl -- Well Founded Semantics interface
      • charsio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • sort.pl
      • statistics.pl -- Get information about resource usage
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl -- Conditional coroutining
      • redis_streams.pl -- Using Redis streams
      • xmldsig.pl -- XML Digital signature
      • xmlenc.pl -- XML encryption library
      • edit.pl -- Editor interface
      • threadutil.pl -- Interactive thread utilities
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • double_metaphone.pl -- Phonetic string matching
      • hashtable.pl -- Hash tables
      • check.pl -- Consistency checking
      • udp_broadcast.pl -- A UDP broadcast proxy
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • prolog_autoload.pl -- Autoload all dependencies
      • table.pl
      • writef.pl -- Old-style formatted write
      • streampool.pl -- Input multiplexing
      • pwp.pl -- Prolog Well-formed Pages
      • rlimit.pl
      • yaml.pl -- Process YAML data
      • prolog_stream.pl -- A stream with Prolog callbacks
      • shell.pl -- Elementary shell commands
      • readline.pl -- GNU readline interface
      • portray_text.pl -- Portray text
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • win_menu.pl -- Console window menu
      • tty.pl -- Terminal operations
      • test_cover.pl -- Clause coverage analysis
      • streams.pl -- Manage Prolog streams
      • janus.pl -- Call Python from Prolog
      • rwlocks.pl -- Read/write locks
      • macros.pl -- Macro expansion
 re_compile(+Pattern, -Regex, +Options) is det
Compiles Pattern to a Regex blob of type regex (see blob/2). Defined Options are given below. Please consult the PCRE2 API documentation for details. If an option is repeated, the first value is used and subsequent values are ignored. Unrecognized options are ignored. Unless otherwise specified, boolean options default to false. Some options may not exist on your system, depending on the PCRE2 version and how it was built - these unsupported options are silently ignored.

The various matching predicates can take either a Regex blob or a string pattern; if they are given a string pattern, they call re_compile/3 and cache the result; so, there is little reason to use re_compile/3 directly.

  • anchored(Bool) If true, match only at the first position
  • auto_capture(Bool) Enable use of numbered capturing parentheses. (default true)
  • bsr(Mode) If anycrlf, \R only matches CR, LF or CRLF; if unicode, \R matches all Unicode line endings.
  • bsr2(Mode) - synonym for bsr(Mode).
  • caseless(Bool) If true, do caseless matching.
  • compat(With) Error - PCRE1 had compat(javascript) for JavaScript compatibility, but PCRE2 has removed that.
  • dollar_endonly(Bool) If true, $ not to match newline at end
  • dotall(Bool) If true, . matches anything including NL
  • dupnames(Bool) If true, allow duplicate names for subpatterns
  • extended(Bool) If true, ignore white space and # comments
  • firstline(Bool) If true, force matching to be before newline
  • greedy(Bool) If true, operators such as + and * are greedy unless followed by ?; if false, the operators are not greedy and ? has the opposite meaning. It can also beset by a `(?U)` within the pattern - see the PCRE2 pattern internal option setting documentation for details and note that the PCRE2 option is UNGREEDY, which is the inverse of this packages greedy options. (default true)
  • compat(With) Raises an errr - PCRE1 had compat(javascript) for JavaScript compatibility, but PCRE2 has removed that option . Consider using the alt_bsux and extra_alt_bsux options.
  • multiline(Bool) If true, ^ and $ match newlines within data
  • newline(Mode) If any, recognize any Unicode newline sequence; if anycrlf (default), recognize CR, LF, and CRLF as newline sequences; if cr, recognize CR; if lf, recognize LF; crlf recognize CRLF as newline; if nul, recognize the NULL character (0x00) as newline.
  • newline2(Mode) - synonym for newline(Mode).
  • ucp(Bool) If true, use Unicode properties for \d, \w, etc.
  • utf_check(Bool) - see PCRE2 API documentation You should not need this because SWI-Prolog ensures that the UTF8 strings are valid,
  • endanchored(boolean) - see PCRE2 API documentation
  • allow_empty_class(boolean) - see PCRE2 API documentation
  • alt_bsux(boolean) - see PCRE2 API documentation
  • auto_callout(boolean) - see PCRE2 API documentation
  • match_unset_backref(boolean) - see PCRE2 API documentation
  • never_ucp(boolean) - see PCRE2 API documentation
  • never_utf(boolean) - see PCRE2 API documentation
  • auto_possess(boolean) - see PCRE2 API documentation (default true)
  • dotstar_anchor(boolean) - see PCRE2 API documentation (default true)
  • start_optimize(boolean) - see PCRE2 API documentation (default true)
  • utf(boolean) - see PCRE2 API documentation
  • never_backslash_c(boolean) - see PCRE2 API documentation
  • alt_circumflex(boolean) - see PCRE2 API documentation
  • alt_verbnames(boolean) - see PCRE2 API documentation
  • use_offset_limit(boolean) - see PCRE2 API documentation
  • extended_more(boolean) - see PCRE2 API documentation
  • literal(boolean) - see PCRE2 API documentation
  • match_invalid_utf(boolean) - see PCRE2 API documentation
  • jit_complete(boolean) - see PCRE2 API documentation
  • jit_partial_soft(boolean) - see PCRE2 API documentation
  • jit_partial_hard(boolean) - see PCRE2 API documentation
  • jit_invalid_utf(boolean) - see PCRE2 API documentation
  • jit(boolean) - see PCRE2 API documentation (default true)
  • copy_matched_subject(boolean) - see PCRE2 API documentation

In addition to the options above that directly map to PCRE flags the following options are processed:

  • optimise(Bool) or optimize(Bool) Turns on the JIT compiler for additional optimization that greatly that speeds up the matching performance of many patterns. (Note that he meaning has changed slightly from the PCRE1 implementation
  • PCRE2 always optimises where possible; this is an additional optimisation.)
  • capture_type(+Type) How to return the matched part of the input and possibly captured groups in there. Possible values are:
    string
    Return the captured string as a string (default).
    atom
    Return the captured string as an atom.
    range
    Return the captured string as a pair Start-Length. Note that we use Start-Length rather than the more conventional Start-End to allow for immediate use with sub_atom/5 and sub_string/5.
    term
    Parse the captured string as a Prolog term. This is notably practical if you capture a number.

The capture_type specifies the default for this pattern. The interface supports a different type for each named group using the syntax `(?<name_T>...)`, where T is one of S (string), A (atom), I (integer), F (float), N (number), T (term) and R (range). In the current implementation I, F and N are synonyms for T. Future versions may act different if the parsed value is not of the requested numeric type.

Note that re_compile/3 does not support the Pattern/Flags form that is supported by re_match/3, re_replace/4, etc.; the Pattern must be text and all compile options specified in Options.

ClioPatria (version V3.1.1-42-gd6a756b-DIRTY)