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)  1985-2011, University of Amsterdam
    7                              VU University Amsterdam
    8    All rights reserved.
    9
   10    Redistribution and use in source and binary forms, with or without
   11    modification, are permitted provided that the following conditions
   12    are met:
   13
   14    1. Redistributions of source code must retain the above copyright
   15       notice, this list of conditions and the following disclaimer.
   16
   17    2. Redistributions in binary form must reproduce the above copyright
   18       notice, this list of conditions and the following disclaimer in
   19       the documentation and/or other materials provided with the
   20       distribution.
   21
   22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   23    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   25    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   26    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   27    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   28    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   29    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   30    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   31    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   32    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   33    POSSIBILITY OF SUCH DAMAGE.
   34*/
   35
   36:- module(swi_system_utilities,
   37        [ lock_predicate/1,
   38          unlock_predicate/1,
   39          system_mode/1,
   40          system_module/0
   41        ]).   42:- autoload(library(error),[must_be/2]).   43
   44
   45/** <module> System utilities
   46
   47This module provides some tools to deal with system predicates. System
   48predicates cannot be traced or redefined.
   49
   50@deprecated     Use :- set_prolog_flag(generate_debug_info, false) to
   51                hide predicate internals from the tracer.
   52@tbd            Move this functionality to prolog flags.
   53*/
   54
   55%!  system_mode(+Boolean) is det.
   56%
   57%   Switch the system into system or user mode.  When in system mode,
   58%   system predicates loose most of their special properties, so it
   59%   becomes possible to trace and even redefine them.
   60%
   61%   @deprecated  New code should use the prolog flag =access_level=.
   62
   63system_mode(Val) :-
   64    must_be(boolean, Val),
   65    (   Val == true
   66    ->  set_prolog_flag(access_level, system)
   67    ;   set_prolog_flag(access_level, user)
   68    ).
   69
   70%!  system_module
   71%
   72%   Any predicate defined after this declaraction   uptil the end of
   73%   the file will become a system   predicate. Normally invoked by a
   74%   directive immediately following the module declaration.
   75
   76system_module :-
   77    set_prolog_flag(generate_debug_info, false).
   78
   79:- meta_predicate
   80    lock_predicate(:),
   81    unlock_predicate(:).   82
   83%!  lock_predicate(+PredInd)
   84%
   85%   Transform a predicate into a system predicate.
   86
   87lock_predicate(PredInd) :-
   88    '$set_predicate_attribute'(PredInd, system, true).
   89
   90%!  unlock_predicate(+PredInd)
   91%
   92%   Transform a system predicate into a normal system predicate.
   93
   94unlock_predicate(PredInd) :-
   95    '$set_predicate_attribute'(PredInd, system, false)