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
96
97
98
|
% Copyright (C) 2019-2025 Free Software Foundation, Inc.
%
% This program 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.
%
% This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
function [out, docTopic] = help(varargin)
% HELP- Provide help, augmented so Emacs picks it up to display in a special buffer.
%
% See the help for the built-in help command by asking for "help help" in
% MATLAB, which will redirect to the correct location.
me = [mfilename('fullpath'), '.m'];
% Recursion detection, which should not occur, but be safe.
[ST] = dbstack('-completenames',1);
files = { ST.file };
mask = strncmp(files, me, length(me));
if any(mask)
disp('MATLAB Emacs help override recursion detected. Exiting.');
return;
end
% Locate built-in help.m
builtinHelp = '';
helpLocations = which('-all', 'help.m');
for idx = 1 : length(helpLocations)
loc = helpLocations{idx};
if (ispc && strcmpi(loc, me)) || (~ispc && strcmp(loc, me))
continue % skip /path/to/Emacs-MATLAB-Mode/toolbox/help.m
end
builtinHelp = loc;
break
end
assert(~isempty(builtinHelp));
% Cd to where built-in help is so we call that first.
% On cleanup restore orig working directory.
builtinHelpDir = fileparts(builtinHelp);
origCWD=pwd;
cd(builtinHelpDir);
addpath(origCWD); % handle case of 'help foo' where foo.m is in oldCWD
cleanup = onCleanup(@()cd(origCWD));
if ~strcmp(which('help'), builtinHelp)
rehash path % force the builtin help to appear
h = which('help');
if ~strcmp(h, builtinHelp)
error(['assert - failed to get built-in help, got: ', h, ' expected: ', builtinHelp]);
end
end
args = varargin;
nso = emacsnetshell('fetch');
if isempty(nso)
cookie = true;
else
cookie = false;
end
if nargin > 0 && strcmp(args{1}, '-emacs')
cookie=false;
args = args(2:end);
end
switch nargout
case 0
if cookie
disp(['<EMACSCAP>(*MATLAB Help: ' args{:} '*)']);
end
try
help(args{:});
catch ERR
disp(ERR)
end
if cookie
disp('</EMACSCAP>');
end
case 1
[out] = help(args{:});
case 2
[out, docTopic] = help(args{:});
end
end
% LocalWords: completenames EMACSCAP
|
