/**
 * Warranty & Liability
 * To the extent permitted by applicable law and unless explicitly
 * otherwise agreed upon, XLOG Technologies AG makes no warranties
 * regarding the provided information. XLOG Technologies AG assumes
 * no liability that any problems might be solved with the information
 * provided by XLOG Technologies AG.
 *
 * Rights & License
 * All industrial property rights regarding the information - copyright
 * and patent rights in particular - are the sole property of XLOG
 * Technologies AG. If the company was not the originator of some
 * excerpts, XLOG Technologies AG has at least obtained the right to
 * reproduce, change and translate the information.
 *
 * Reproduction is restricted to the whole unaltered document. Reproduction
 * of the information is only allowed for non-commercial uses. Selling,
 * giving away or letting of the execution of the library is prohibited.
 * The library can be distributed as part of your applications and libraries
 * for execution provided this comment remains unchanged.
 *
 * Restrictions
 * Only to be distributed with programs that add significant and primary
 * functionality to the library. Not to be distributed with additional
 * software intended to replace any components of the library.
 *
 * Trademarks
 * Jekejeke is a registered trademark of XLOG Technologies AG.
 */

% sys_meta_args(+Atom, +Integer, -List)
:- multifile(sys_meta_args/3).

% time measurement
sys_meta_args(call_with_time_limit, 2, [t,g]).

/**
 * sleep(D):
 * The predicate suspends execution for D seconds.
 */
% sleep(+Float)
sleep(Delay) :-
   os_sleep_promise(Delay, Prom),
   '$YIELD'(Prom).

/**
 * call_later(G, D):
 * call_later(G, D, T):
 * The predicate succeeds. As a side effect it schedules the
 * goal G to be executed after D seconds. The ternary
 * predicate succeeds in T with the scheduled timer.
 */
% call_later(+Goal, +Float)
call_later(Goal, Delay) :-
   sys_frost_horn((:- Goal), 0, Native),
   os_call_later(Native, Delay, _).

% call_later(+Goal, +Integer, -Timer)
call_later(Goal, Delay, Timer) :-
   sys_frost_horn((:- Goal), 0, Native),
   os_call_later(Native, Delay, Timer).

/**
 * call_with_time_limit(D, G):
 * The predicate succeeds once if G succeeds. If the goal
 * has not terminated after D seconds a time limit
 * system error is signalled to the goal.
 */
% call_with_time_limit(+Float, +Goal)
call_with_time_limit(Delay, Goal) :-
   current_prolog_flag(allow_yield, on), !,
   task_self(Task),
   setup_call_cleanup(
      call_later(sys_timeout_signal(Task), Delay, Timer),
      Goal,
      timer_cancel(Timer)).
call_with_time_limit(_, _) :-
   throw(error(system_error(illegal_yield),_)).

% sys_timeout_signal(+Task)
sys_timeout_signal(Task) :-
   task_abort(Task, system_error(timelimit_exceeded)).

/*******************************************************************/
/* Foreign Predicates                                              */
/*******************************************************************/

% os_sleep_promise(D, P)
% defined in foreign(util/siglib)

% call_later(G, D, T)
% defined in foreign(util/siglib)

% timer_cancel(T)
% defined in foreign(util/siglib)

:- ensure_loaded(foreign(util/siglib)).