1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
% STK_ERROR throws an STK error with a good-looking error identifier.
% Copyright Notice
%
% Copyright (C) 2017 CentraleSupelec
% Copyright (C) 2012 SUPELEC
%
% Authors: Julien Bect <julien.bect@centralesupelec.fr>
% Emmanuel Vazquez <emmanuel.vazquez@centralesupelec.fr>
% Copying Permission Statement
%
% This file is part of
%
% STK: a Small (Matlab/Octave) Toolbox for Kriging
% (https://github.com/stk-kriging/stk/)
%
% STK is free software: you can redistribute it and/or modify it under
% the terms of the GNU General Public License as published by the Free
% Software Foundation, either version 3 of the License, or (at your
% option) any later version.
%
% STK is distributed in the hope that it will be useful, but WITHOUT
% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
% or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
% License for more details.
%
% You should have received a copy of the GNU General Public License
% along with STK. If not, see <http://www.gnu.org/licenses/>.
function stk_error (errmsg, mnemonic, stack)
% Second component of error identifier = name of calling function
% (unless stk_error has been called directly from the base workspace)
if nargin < 3,
try
stack = dbstack ('-completenames');
% In Octave, -completenames is at best ignored (in recent versions)
% or generates an error (in, e.g., Octave 3.6.2).
catch
stack = dbstack ();
end
if length (stack) == 1,
caller = 'BaseWorkspace';
else
% pretend that the error has been thrown by the caller
stack = stack(2:end);
% and get caller name to form the error identifier
caller = stack(1).name;
end
else
% If a "stack" has been provided by the user, we use it without asking
% questions (if it's a struct)
if ~ isstruct (stack) || ~ isfield (stack, 'name'),
% We will throw an error, but not the one we were requested to!
errmsg = 'Argument "stack" should be a valid stack structure.';
mnemonic = 'InvalidArgument';
stack = dbstack ();
end
caller = stack(1).name;
end
% Keep only subfunction name (Octave)
gt_pos = strfind (caller, '>');
if ~ isempty (gt_pos),
caller = caller((gt_pos + 1):end);
end
% Construct the error structure
errstruct = struct (...
'message', errmsg, ...
'identifier', sprintf ('STK:%s:%s', caller, mnemonic), ...
'stack', stack);
% Note: the 'stack' argument is ignore in Octave 4.0.0 and earlier
% releases (see https://savannah.gnu.org/bugs/?47107)
error (errstruct);
end % function
%!shared errmsg, mnemonic, badstack
%! errmsg = 'Go ahead, make my day.';
%! mnemonic = 'ClintEastwood';
%! badstack = 0; % not a valid stack structure
% Valid use of stk_error
%!error <make my day> stk_error(errmsg, mnemonic);
% Use of an incorrect stack structure
%!error <stack structure> stk_error (errmsg, mnemonic, badstack);
%!error id=STK:stk_error:InvalidArgument stk_error (errmsg, mnemonic, badstack);
|
