1/*  Part of SWI-Prolog
    2
    3    Author:        Jan Wielemaker
    4    E-mail:        J.Wielemaker@vu.nl
    5    WWW:           http://www.swi-prolog.org
    6    Copyright (c)  2010-2016, University of Amsterdam
    7    All rights reserved.
    8
    9    Redistribution and use in source and binary forms, with or without
   10    modification, are permitted provided that the following conditions
   11    are met:
   12
   13    1. Redistributions of source code must retain the above copyright
   14       notice, this list of conditions and the following disclaimer.
   15
   16    2. Redistributions in binary form must reproduce the above copyright
   17       notice, this list of conditions and the following disclaimer in
   18       the documentation and/or other materials provided with the
   19       distribution.
   20
   21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   32    POSSIBILITY OF SUCH DAMAGE.
   33*/
   34
   35:- module(sicstus_system,
   36	  [ environ/2,			% ?Name, ?Value
   37
   38	    exec/3,			% +Command, -Streams, -PID
   39	    wait/2,			% +PID, -Status
   40	    pid/1,			% -PID
   41
   42	    now/1,			% -TimeStamp
   43	    datime/1,			% -DaTime
   44	    datime/2,			% +TimeStamp, -DaTime
   45	    sleep/1,			% +Seconds
   46
   47	    shell/0,
   48	    shell/1,			% +Command
   49	    shell/2,			% +Command, -Status
   50
   51	    system/0,
   52	    system/1,			% +Command
   53	    system/2,			% +Command, -Status
   54
   55	    popen/3,			% +Command, +Mode, -Stream
   56
   57	    host_name/1,		% -HostName
   58
   59	    working_directory/2,	% -Old, +New
   60	    make_directory/1,		% +DirName
   61	    file_exists/1,		% +FileName
   62	    delete_file/1,		% +FileName
   63	    rename_file/2,		% +Old, +New
   64	    mktemp/2,			% +Template, -FileName
   65	    tmpnam/1			% -FileName
   66	  ]).   67:- use_module(library(process)).   68:- use_module(library(socket)).   69:- use_module(library(shell), [shell/0]).   70
   71:- multifile sicstus:rename_module/2.   72
   73sicstus:rename_module(system, sicstus_system).

 environ(?Name, ?Value) is nondet

True if Value is an atom associated with the environment variable or system property Name.

Compatibility

- sicstus

To be done

- Mode -Name is not supported.

Because SWI-Prolog doesn't have an obvious equivalent to
SICStus system properties, this predicate currently
behaves as if no system properties are defined,
i. e. only environment variables are returned.

  104environ(Name, Value) :-
  105	getenv(Name, Value).
  106
  107
  108		 /*******************************
  109		 *	      PROCESSES		*
  110		 *******************************/

 exec(+Command, +Streams, -PID)

SICStus 3 compatible implementation of exec/3 on top of the SICStus 4 compatible process_create/3.

bug

- The SICStus version for Windows seems to hand Command directly to CreateProcess(). We hand it to

%COMSPEC% /s /c "Command"

In case of conflict, it is adviced to use process_create/3

  127exec(Command, Streams, PID) :-
  128	Streams = [In, Out, Error],
  129	shell(Shell, Command, Argv),
  130	process_create(Shell, Argv,
  131		       [ stdin(In),
  132			 stdout(Out),
  133			 stderr(Error),
  134			 process(PID)
  135		       ]).
  136
  137shell(Shell, Command, ['/s', '/c', Command]) :-
  138	current_prolog_flag(windows, true), !,
  139	getenv('COMSPEC', Shell).
  140shell('/bin/sh', Command, ['-c', Command]).

 wait(+PID, -Status)

Wait for processes created using exec/3.

See also

- exec/3

  148wait(PID, Status) :-
  149	process_wait(PID, Status).

 pid(-PID)

Process ID of the current process.

Compatibility

- sicstus.

  157pid(PID) :-
  158	current_prolog_flag(pid, PID).

 now(-When) is det

Unify when with the current time-stamp

Compatibility

- sicstus

  166now(When) :-
  167	get_time(Now),
  168	When is integer(Now).

 datime(+When, -Datime) is det

datime(-When, +Datime) is det

True when Datime is a datime/6 record that reflects the time stamp When.

Compatibility

- sicstus

  178datime(When, datime(Year,Month,Day,Hour,Min,Sec)) :-
  179	var(When),
  180	!,
  181	date_time_stamp(date(Year,Month,Day,Hour,Min,Sec,_,_,_), When).
  182datime(When, datime(Year,Month,Day,Hour,Min,Sec)) :-
  183	stamp_date_time(When, date(Year,Month,Day,Hour,Min,SecF,_,_,_), local),
  184	Sec is integer(SecF).

 datime(-Datime) is det

Unifies Datime with the current date and time as a datime/6 record of the form datime(Year,Month,Day,Hour,Min,Sec). All fields are integers.

Compatibility

- sicstus

  194datime(datime(Year,Month,Day,Hour,Min,Sec)) :-
  195	get_time(Now),
  196	stamp_date_time(Now, date(Year,Month,Day,Hour,Min,SecF,_,_,_), local),
  197	Sec is integer(SecF).

 system

 system(+Command)

 system(+Command, -Status)

Synomyms for shell/0, shell/1 and shell/2.

Compatibility

- sicstus.

  208system :- shell.
  209system(Command) :- shell(Command).
  210system(Command, Status) :- shell(Command, Status).

 popen(+Command, +Mode, ?Stream)

Compatibility

- sicstus

  216popen(Command, Mode, Stream) :-
  217	open(pipe(Command), Mode, Stream).

 host_name(-HostName)

See also

- gethostname/1

Compatibility

- sicstus

  224host_name(HostName) :-
  225	gethostname(HostName).
  226
  227
  228		 /*******************************
  229		 *	 FILE OPERATIONS	*
  230		 *******************************/

 mktemp(+Template, -File) is det

Interface to the Unix function. This emulation uses tmp_file/2 and ignores Template.

deprecated

- This interface is a security-risc. Use tmp_file_stream/3.

Compatibility

- sicstus

  241mktemp(_Template, File) :-
  242	tmp_file(mkstemp, File).

 tmpnam(-FileName)

Interface to tmpnam(). This emulation uses tmp_file/2.

deprecated

- This interface is a security-risc. Use tmp_file_stream/3.

Compatibility

- sicstus

  252tmpnam(File) :-
  253	tmp_file(tmpnam, File).

 file_exists(+FileName) is semidet

True if a file named FileName exists.

Compatibility

- sicstus

  261file_exists(FileName) :-
  262	exists_file(FileName)