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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
########################################################################
##
## Copyright (C) 2009-2022 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave 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.
##
## Octave 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 Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} doc_cache_create (@var{out_file}, @var{directory})
## @deftypefnx {} {} doc_cache_create (@var{out_file})
## @deftypefnx {} {} doc_cache_create ()
## Generate documentation cache for all functions in @var{directory}.
##
## A documentation cache is generated for all functions in @var{directory}
## which may be a single string or a cell array of strings. The cache is used
## to speed up the function @code{lookfor}.
##
## The cache is saved in the file @var{out_file} which defaults to the value
## @file{doc-cache} if not given.
##
## If no directory is given (or it is the empty matrix), a cache for built-in
## functions, operators, and keywords is generated.
##
## @seealso{doc_cache_file, lookfor, path}
## @end deftypefn
function doc_cache_create (out_file = "doc-cache", directory = [])
## Check input
if (! ischar (out_file))
print_usage ();
endif
## Generate cache
if (isempty (directory))
cache = gen_builtin_cache ();
elseif (iscell (directory))
if (all (cellfun ("isclass", directory, "char")))
cache = gen_doc_cache_in_dir (directory);
else
error ("doc_cache_create: cell must contain only strings");
endif
elseif (ischar (directory))
cache = gen_doc_cache_in_dir (directory);
else
error ("doc_cache_create: second input argument must be a string or a cell of strings");
endif
## Save cache
if (! isempty (cache))
save_header_format_string (["# doc-cache created by Octave " OCTAVE_VERSION], "local");
save ("-text", out_file, "cache");
endif
endfunction
function [text, first_sentence, status] = handle_function (f, text, format)
first_sentence = "";
## Skip internal functions starting with "__"
if (strncmp (f, "__", 2))
status = 1;
return;
endif
## Take action depending on help text format
switch (lower (format))
case "plain text"
status = 0;
case "texinfo"
[text, status] = __makeinfo__ (text, "plain text");
case "html"
[text, status] = strip_html_tags (text);
otherwise
status = 1;
endswitch
## Did we get the help text?
if (status != 0 || isempty (text))
warning ("doc_cache_create: unusable help text found in file '%s'", f);
return;
endif
## Get first sentence of help text
first_sentence = get_first_help_sentence (f);
endfunction
function cache = create_cache (list)
cache = {};
## For each function:
for n = 1:length (list)
f = list{n};
## Get help text
[text, format] = get_help_text (f);
[text, first_sentence, status] = handle_function (f, text, format);
## Did we get the help text?
if (status != 0)
continue;
endif
## Store the help text
cache(1, end+1) = f;
cache(2, end) = text;
cache(3, end) = first_sentence;
endfor
endfunction
function cache = gen_doc_cache_in_dir (directory)
## If 'directory' is not in the current path, add it so we search it
dir_in_path = ismember (directory, ostrsplit (path (), pathsep ()));
## dirs not in path
if (! iscell (directory))
directory = {directory};
endif
dirs_notpath = {directory{! dir_in_path}};
## add them
if (! isempty (dirs_notpath))
addpath (dirs_notpath{:});
endif
## create cache
func = @(s_) create_cache (__list_functions__ (s_));
cache = cellfun (func, directory, "UniformOutput", false);
## concatenate results
cache = [cache{:}];
## remove dirs from path
if (! isempty (dirs_notpath))
rmpath (dirs_notpath{:});
endif
endfunction
function cache = gen_builtin_cache ()
operators = __operators__ ();
keywords = __keywords__ ();
builtins = __builtins__ ();
list = {operators{:}, keywords{:}, builtins{:}};
cache = create_cache (list);
endfunction
## No true tests desirable for this function.
## Test input validation
%!error doc_cache_create (1)
|
