• 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/process.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl -- Error generating support
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • 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 -- Option list processing
      • uid.pl
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • filesex.pl -- Extended operations on files
      • 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
      • process.pl -- Create processes and redirect I/O
        • process_create/3
        • process_id/1
        • process_id/2
        • is_process/1
        • process_release/1
        • process_wait/2
        • process_wait/3
        • process_kill/1
        • process_kill/2
        • process_group_kill/1
        • process_group_kill/2
        • process_set_method/1
      • memfile.pl
      • prolog_config.pl -- Provide configuration information
      • 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
      • 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
      • 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
      • 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
      • 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
      • yall.pl -- Lambda expressions
      • 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
      • streampool.pl -- Input multiplexing
      • redis.pl -- Redis client
      • backcomp.pl -- Backward compatibility
      • plunit.pl -- Unit Testing
      • jpl.pl -- A Java interface for SWI Prolog 7.x
      • unicode.pl -- Unicode string handling
      • redis_streams.pl -- Using Redis streams
      • charsio.pl -- I/O on Lists of Character Codes
      • optparse.pl -- command line parsing
      • strings.pl -- String utilities
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • make.pl -- Reload modified source files
      • intercept.pl -- Intercept and signal interface
      • listing.pl -- List programs and pretty print clauses
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_code.pl -- Utilities for reasoning about code
      • check.pl -- Consistency checking
      • xmldsig.pl -- XML Digital signature
      • date.pl -- Process dates and times
      • sort.pl
      • statistics.pl -- Get information about resource usage
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • tty.pl -- Terminal operations
      • readline.pl -- GNU readline interface
      • prolog_stream.pl -- A stream with Prolog callbacks
      • writef.pl -- Old-style formatted write
      • udp_broadcast.pl -- A UDP broadcast proxy
      • codesio.pl -- I/O on Lists of Character Codes
      • help.pl -- Text based manual
      • prolog_stack.pl -- Examine the Prolog stack
      • terms.pl -- Term manipulation
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • threadutil.pl -- Interactive thread utilities
      • shell.pl -- Elementary shell commands
      • prolog_history.pl -- Per-directory persistent commandline history
      • doc_files.pl -- Create stand-alone documentation files
      • pwp.pl -- Prolog Well-formed Pages
      • oset.pl -- Ordered set manipulation
      • prolog_wrap.pl -- Wrapping predicates
      • edit.pl -- Editor interface
      • c14n2.pl -- C14n2 canonical XML documents
      • xmlenc.pl -- XML encryption library
      • table.pl
      • explain.pl -- Describe Prolog Terms
      • base32.pl -- Base32 encoding and decoding
      • odbc.pl
      • isub.pl -- isub: a string similarity measure
      • yaml.pl -- Process YAML data
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • hashtable.pl -- Hash tables
      • coinduction.pl -- Co-Logic Programming
      • paxos.pl -- A Replicated Data Store
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_trace.pl -- Print access to predicates
      • heaps.pl -- heaps/priority queues
      • varnumbers.pl -- Utilities for numbered terms
      • doc_latex.pl -- PlDoc LaTeX backend
      • zip.pl -- Access resource ZIP archives
      • cgi.pl -- Read CGI parameters
      • rlimit.pl
      • double_metaphone.pl -- Phonetic string matching
      • editline.pl -- BSD libedit based command line editing
      • tables.pl -- XSB interface to tables
      • qsave.pl -- Save current program as a state or executable
      • when.pl -- Conditional coroutining
      • test_cover.pl -- Clause cover analysis
      • wfs.pl -- Well Founded Semantics interface
      • win_menu.pl -- Console window menu
      • files.pl
      • protobufs.pl -- Google's Protocol Buffers
      • pdt_console.pl
      • term_to_json.pl
      • portray_text.pl -- Portray text
 process_create(+Exe, +Args:list, +Options) is det
Create a new process running the file Exe and using arguments from the given list. Exe is a file specification as handed to absolute_file_name/3. Typically one use the path file alias to specify an executable file on the current PATH. Args is a list of arguments that are handed to the new process. On Unix systems, each element in the list becomes a separate argument in the new process. In Windows, the arguments are simply concatenated to form the commandline. Each argument itself is either a primitive or a list of primitives. A primitive is either atomic or a term file(Spec). Using file(Spec), the system inserts a filename using the OS filename conventions which is properly quoted if needed.

Options:

stdin(Spec)
stdout(Spec)
stderr(Spec)
Bind the standard streams of the new process. Spec is one of the terms below. If pipe(Pipe) is used, the Prolog stream is a stream in text-mode using the encoding of the default locale. The encoding can be changed using set_stream/2, or by using the two-argument form of pipe, which accepts an encoding(Encoding) option. The options stdout and stderr may use the same stream, in which case both output streams are connected to the same Prolog stream.
std
Just share with the Prolog I/O streams. On Unix, if the user_input, etc. are bound to a file handle but not to 0,1,2 the process I/O is bound to the file handles of these streams.
null
Bind to a null stream. Reading from such a stream returns end-of-file, writing produces no output
pipe(-Stream)
pipe(-Stream, +StreamOptions)
Attach input and/or output to a Prolog stream. The optional StreamOptions argument is a list of options that affect the stream. Currently only the options type(+Type) and encoding(+Encoding) are supported, which have the same meaning as the stream properties of the same name (see stream_property/2). StreamOptions is provided mainly for SICStus compatibility - the SWI-Prolog predicate set_stream/2 can be used for the same purpose.
stream(+Stream)
Attach input or output to an existing Prolog stream. This stream must be associated with an OS file handle (see stream_property/2, property file_no). This option is not provided by the SICStus implementation.
cwd(+Directory)
Run the new process in Directory. Directory can be a compound specification, which is converted using absolute_file_name/3. See also process_set_method/1.
env(+List)
As environment(List), but only the specified variables are passed, i.e., no variables are inherited.
environment(+List)
Specify additional environment variables for the new process. List is a list of Name=Value terms, where Value is expanded the same way as the Args argument. If neither env nor environment is passed the environment is inherited from the Prolog process.
process(-PID)
Unify PID with the process id of the created process.
detached(+Bool)
In Unix: If true, detach the process from the terminal Currently mapped to setsid(); Also creates a new process group for the child In Windows: If true, detach the process from the current job via the CREATE_BREAKAWAY_FROM_JOB flag. In Vista and beyond, processes launched from the shell directly have the 'compatibility assistant' attached to them automatically unless they have a UAC manifest embedded in them. This means that you will get a permission denied error if you try and assign the newly-created PID to a job you create yourself.
window(+Bool)
If true, create a window for the process (Windows only)
priority(+Priority)
In Unix: specifies the process priority for the newly created process. Priority must be an integer between -20 and 19. Positive values are nicer to others, and negative values are less so. The default is zero. Users are free to lower their own priority. Only the super-user may raise it to less-than zero.

If the user specifies the process(-PID) option, he must call process_wait/2 to reclaim the process. Without this option, the system will wait for completion of the process after the last pipe stream is closed.

If the process is not waited for, it must succeed with status 0. If not, an process_error is raised.

Windows notes

On Windows this call is an interface to the CreateProcess() API. The commandline consists of the basename of Exe and the arguments formed from Args. Arguments are separated by a single space. If all characters satisfy iswalnum() it is unquoted. If the argument contains a double-quote it is quoted using single quotes. If both single and double quotes appear a domain_error is raised, otherwise double-quote are used.

The CreateProcess() API has many options. Currently only the CREATE_NO_WINDOW options is supported through the window(+Bool) option. If omitted, the default is to use this option if the application has no console. Future versions are likely to support more window specific options and replace win_exec/2.

Examples

First, a very simple example that behaves the same as shell('ls -l'), except for error handling:

?- process_create(path(ls), ['-l'], []).

The following example uses grep to find all matching lines in a file.

grep(File, Pattern, Lines) :-
        setup_call_cleanup(
            process_create(path(grep), [ Pattern, file(File) ],
                           [ stdout(pipe(Out))
                           ]),
            read_lines(Out, Lines),
            close(Out)).

read_lines(Out, Lines) :-
        read_line_to_codes(Out, Line1),
        read_lines(Line1, Out, Lines).

read_lines(end_of_file, _, []) :- !.
read_lines(Codes, Out, [Line|Lines]) :-
        atom_codes(Line, Codes),
        read_line_to_codes(Out, Line2),
        read_lines(Line2, Out, Lines).
Errors
- process_error(Exe, Status) where Status is one of exit(Code) or killed(Signal). Raised if the process is waited for (i.e., Options does not include process(-PID)), and does not exit with status 0.
bug
- On Windows, environment(List) is handled as env(List), i.e., the environment is not inherited.
ClioPatria (version V3.1.1-40-g9d9e003)