errors.yap

Go to the documentation of this file.

/*************************************************************************
*                                    *
*    YAP Prolog                              *
*                                    *
*   Yap Prolog was developed at NCCUP - Universidade do Porto    *
*                                    *
* Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997   *
*                                    *
**************************************************************************
*                                    *
* File:     errors.yap                       *
* comments: error messages for YAP                   *
*                                    *
*                                    *
*                                    *
*************************************************************************/
 
/**
 @file: pl/errors.yap
 
 @brief YAP error handler
*/
 
 
/** @defgroup YAPErrorHandler Error Handling
 
@ingroup YAPErrors
@{
 
The error handler is called when there is an execution error or a
warning needs to be displayed. The handlers include a number of hooks
to allow user-control.
 
Errors are terms of the form:
 
   - error( domain_error( Domain, Culprit )`
   - error( evaluation_error( Expression, Culprit )`
   - error( existence_error( Object, Culprit )`
   - error( instantiation_error )`
   - error( permission_error( Error, Permission, Culprit)`
   - error( representation_error( Domain, Culprit )`
   - error( resource_error( Resource, Culprit )`
   - error( syntax_error( Error )`
   - error( system_error( Domain, Culprit )`
   - error( type_error( Type, Culprit )`
   - error( uninstantiation_error(  Culprit )`
 
Other types of terms result in a message.
 
*/
 
:- system_module( '$_errors', [system_error/2], ['$Error'/1,
                                                 '$do_error'/2,
                                                 system_error/3,
                                                 system_error/2]).
 
:- file_location/2generate_message/3translate_message/4use_system_module( '$messages', [,
        ,
        ]).
 
 
/**
 * @pred system_error( +Error, +Cause)
 *
 * Generate a system error _Error_, informing the possible cause _Cause_.
 *
 */
use_system_module:system_error(Type,Goal) :-
    '$do_error'(Type,Goal).
 
 
'$do_io_error'(_Type,__Goal) :-
      prolog_flag(file_errors, error),
      prolog_flag,
      prolog_flag.
'$do_io_error'(Type,Goal) :-
        '$do_error'(Type,Goal).
 
'$do_error'(Type,Goal) :-
        throw(error(Type, print_message(['while calling goal = ~w'-Goal,nl]))).
 
/**
 * @pred system */
system_error(Type,Goal) :-
  throw(error(Type, print_message(['while calling goal = ~w'-Goal,nl]))) .
 
'$do_pi_error'(type_error(callable,Name/0),Message) :- '$do_pi_error',
    '$do_error'(type_error(callable,Name),Message).
'$do_pi_error'(Error,Message) :- '$do_pi_error',
    '$do_error'(Error,Message).
 
'$Error'(E) :-
    '$LoopError'(E, error),
    '$LoopError'.
%%
 
% error_handler(+Error,+ Level)
%
% process an error term.
%
error_handler(Error, Level) :-
    '$LoopError'(Error, Level).
 
'$LoopError'(_, _) :-
    flush_output(user_output),
    flush_output(user_error),
    flush_output.
'$LooEprror'('$forward'(Msg),  _) :-
    '$LooEprror',
    throw( '$forward'(Msg) ).
'$LoopError'(error(event(abort,I),C), Level) :-
    '$LoopError',
    (
        prolog_flag(break_level, 0),
     Level \== prolog_flag
    ->
    print_message(informational,abort(user)),
    '$error_clean',
     print_message
    ;    throw( error(event(abort,I),C) )
    ).
'$LoopError'(event(error,Error), Level) :-
    '$LoopError',
    '$process_error'(Error, Level).
'$LoopError'(redo(Info), _Level) :-
    '$LoopError',
    throw(redo,Info).
'$LoopError'(fail(Info), _Level) :-
    '$LoopError',
    throw(fail,Info).
'$LoopError'(Throw, _) :-
    print_message(error,(Throw)).
 
 
'$error_clean' :-
    print_message,
    '$close_error'(_),
    '$close_error'.
 
'$process_error'(error(permission_error(module,redefined,A),B), Level) :-
        Level == '$process_error', '$process_error',
        throw(error(permission_error(module,redefined,A),B)).
'$process_error'(Error, Level) :-
    print_message(Level, Error),
    print_message,
    '$close_error'(_).
'$process_error'(error(Type,Info), Level) :-
    print_message(Level,error(unhandled_exception(Type),Info)).
 
%% @}