/usr/lib/swipl/library/pure_input.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • debug.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • broadcast.pl
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • operators.pl
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl -- Lambda expressions
      • assoc.pl -- Binary associations
      • prolog_format.pl
      • pure_input.pl -- Pure Input from files and streams
        • phrase_from_file/2
        • phrase_from_file/3
        • phrase_from_stream/2
        • phrase_from_stream/3
        • syntax_error//1
        • lazy_list_location//1
        • lazy_list_character_count//1
        • stream_to_lazy_codes/2
        • stream_to_lazy_chars/2
        • stream_to_lazy_list/2
      • solution_sequences.pl -- Modify solution sequences
      • ordsets.pl -- Ordered set manipulation
      • random.pl
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl
      • predicate_options.pl -- Access and analyse predicate options
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl
      • prolog_colour.pl
      • lazy_lists.pl -- Lazy list handling
      • ugraphs.pl -- Graph manipulation library
      • url.pl
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl
      • git.pl
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • quintus.pl -- Quintus compatibility
      • prolog_versions.pl
      • prolog_wrap.pl
      • dialect.pl -- Support multiple Prolog dialects
      • date.pl -- Process dates and times
      • persistency.pl -- Provide persistent dynamic predicates
      • iostream.pl -- Utilities to deal with streams
      • prolog_code.pl
      • strings.pl
      • dif.pl -- The dif/2 constraint
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • terms.pl -- Term manipulation
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • threadutil.pl -- Interactive thread utilities
      • prolog_stack.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl
      • sort.pl
      • dicts.pl
      • varnumbers.pl
      • rbtrees.pl -- Red black trees
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • prolog_config.pl
      • edit.pl -- Editor interface
      • tableutil.pl
      • prolog_profile.pl
      • thread.pl -- High level thread primitives
      • portray_text.pl
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl
      • coinduction.pl -- Co-Logic Programming
      • heaps.pl -- heaps/priority queues
      • statistics.pl
      • when.pl -- Conditional coroutining
      • ctypes.pl -- Character code classification
      • optparse.pl -- command line parsing
      • prolog_coverage.pl
      • zip.pl -- Access resource ZIP archives
      • vm.pl
      • system.pl -- System utilities
      • prolog_deps.pl
      • prolog_codewalk.pl
      • fastrw.pl
      • listing.pl
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • explain.pl
      • qpforeign.pl
      • tty.pl
      • nb_rbtrees.pl
      • oset.pl
      • shell.pl -- Elementary shell commands
      • tables.pl
      • check.pl -- Consistency checking
      • nb_set.pl -- Non-backtrackable sets
      • prolog_trace.pl
      • qsave.pl
      • help.pl
      • intercept.pl
      • writef.pl
      • macros.pl
      • pio.pl
      • exceptions.pl -- Exception classification
      • streams.pl
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_debug.pl
      • make.pl -- Reload modified source files
      • rwlocks.pl -- Read/write locks
      • increval.pl
      • readln.pl
      • hashtable.pl
      • check_installation.pl -- Check installation issues and features
 phrase_from_file(:Grammar, +File) is nondet
 phrase_from_file(:Grammar, +File, +Options) is nondet
Process the content of File using the DCG rule Grammar. The space usage of this mechanism depends on the length of the not committed part of Grammar. Committed parts of the temporary list are reclaimed by the garbage collector, while the list is extended on demand due to unification of the attributed tail variable.

Options are passed to open/4 and phrase_from_stream/3. The latter notable allows for as(chars) to call a DCG compiled for dealing with character lists rather than codes.

Below is an example that counts the number of times a string appears in a file. The library dcg/basics provides string//1 matching an arbitrary string and remainder//1 which matches the remainder of the input without parsing.

:- use_module(library(dcg/basics)).

file_contains(File, Pattern) :-
        phrase_from_file(match(Pattern), File).

match(Pattern) -->
        string(_),
        string(Pattern),
        remainder(_).

match_count(File, Pattern, Count) :-
        aggregate_all(count, file_contains(File, Pattern), Count).

This can be called as (note that the pattern must be a string (code list)):

?- match_count('pure_input.pl', `file`, Count).