Mercurial > octave
view scripts/help/lookfor.m @ 21633:dcf8922b724b
Deprecate printf, puts, and scanf. Make fputs a M-file.
* libinterp/corefcn/file-io.cc: extracted printf, puts, and scanf to M-files.
* scripts/deprecated/printf.m: new function, equivalent to version file-io.cc.
* scripts/deprecated/puts.m: new function, equivalent to version file-io.cc.
* scripts/deprecated/scanf.m: new function, equivalent to version file-io.cc.
* scripts/deprecated/module.mk: added printf, puts, and scanf.
* scripts/io/fputs.m: new function, equivalent to version file-io.cc.
* scripts/io/module.mk: added fputs.
* doc/interpreter/io.txi: adapted documentation to current implementation.
* NEWS: announced changes.
* doc/interpreter/basics.txi: replaced printf by fprintf.
* doc/interpreter/stmt.txi: replaced printf by fprintf.
* doc/interpreter/var.txi: replaced printf by fprintf.
* doc/refcard/refcard.tex: removed printf and scanf.
* examples/code/@FIRfilter/display.m: replaced printf by fprintf.
* examples/code/@polynomial/display.m: replaced printf by fprintf.
* scripts/@ftp/display.m: replaced printf by fprintf.
* scripts/general/inputParser.m: replaced printf by fprintf.
* scripts/general/methods.m: replaced printf by fprintf.
* scripts/general/profexplore.m: replaced printf by fprintf.
* scripts/general/profshow.m: replaced printf by fprintf.
* scripts/help/help.m: replaced puts by fputs and printf by fprintf.
* scripts/help/lookfor.m: replaced puts by fputs and printf by fprintf.
* scripts/help/which.m: replaced printf by fprintf.
* scripts/image/imformats.m: replaced printf by fprintf.
* scripts/io/beep.m: replaced puts by fputs.
* scripts/io/textread.m: replaced printf by fprintf.
* scripts/java/javaclasspath.m: replaced printf by fprintf.
* scripts/java/javamem.m: replaced printf by fprintf.
* scripts/miscellaneous/dir.m: replaced printf by fprintf.
* scripts/miscellaneous/dos.m: replaced printf by fprintf.
* scripts/miscellaneous/fact.m: replaced printf by fprintf.
* scripts/miscellaneous/info.m: replaced printf by fprintf.
* scripts/miscellaneous/license.m: replaced printf by fprintf.
* scripts/miscellaneous/ls.m: replaced puts by fputs.
* scripts/miscellaneous/menu.m: replaced printf by fprintf.
* scripts/miscellaneous/mkoctfile.m: replaced printf by fprintf.
* scripts/miscellaneous/private/display_info_file.m:
* scripts/miscellaneous/unix.m: replaced printf by fprintf.
* scripts/miscellaneous/ver.m: replaced printf by fprintf.
* scripts/miscellaneous/what.m: replaced printf by fprintf.
* scripts/ode/ode23.m: replaced printf by fprintf.
* scripts/ode/ode45.m: replaced printf by fprintf.
* scripts/optimization/fminbnd.m: replaced printf by fprintf.
* scripts/optimization/optimset.m: replaced puts by fputs and printf by fprintf.
* scripts/optimization/sqp.m: replaced printf by fprintf.
* scripts/pkg/pkg.m: replaced printf by fprintf.
* scripts/pkg/private/describe.m: replaced printf by fprintf.
* scripts/pkg/private/install.m: replaced printf by fprintf.
* scripts/pkg/private/installed_packages.m: replaced printf by fprintf.
* scripts/pkg/private/list_forge_packages.m: replaced puts by fputs and printf by fprintf.
* scripts/pkg/private/rebuild.m: replaced printf by fprintf.
* scripts/plot/util/__gnuplot_drawnow__.m: replaced puts by fputs and printf by fprintf.
* scripts/signal/stft.m: replaced printf by fprintf.
* scripts/sparse/bicg.m: replaced printf by fprintf.
* scripts/sparse/bicgstab.m: replaced printf by fprintf.
* scripts/sparse/cgs.m: replaced printf by fprintf.
* scripts/sparse/pcg.m: replaced printf by fprintf.
* scripts/sparse/pcr.m: replaced printf by fprintf.
* scripts/sparse/qmr.m: replaced printf by fprintf.
* scripts/statistics/models/logistic_regression.m: replaced printf by fprintf.
* scripts/statistics/tests/anova.m: replaced printf by fprintf.
* scripts/statistics/tests/bartlett_test.m: replaced printf by fprintf.
* scripts/statistics/tests/chisquare_test_homogeneity.m: replaced printf by fprintf.
* scripts/statistics/tests/chisquare_test_independence.m: replaced printf by fprintf.
* scripts/statistics/tests/cor_test.m: replaced printf by fprintf.
* scripts/statistics/tests/f_test_regression.m: replaced printf by fprintf.
* scripts/statistics/tests/hotelling_test.m: replaced printf by fprintf.
* scripts/statistics/tests/hotelling_test_2.m: replaced printf by fprintf.
* scripts/statistics/tests/kolmogorov_smirnov_test.m: replaced printf by fprintf.
* scripts/statistics/tests/kolmogorov_smirnov_test_2.m: replaced printf by fprintf.
* scripts/statistics/tests/kruskal_wallis_test.m: replaced printf by fprintf.
* scripts/statistics/tests/manova.m: replaced printf by fprintf.
* scripts/statistics/tests/mcnemar_test.m: replaced printf by fprintf.
* scripts/statistics/tests/prop_test_2.m: replaced printf by fprintf.
* scripts/statistics/tests/run_test.m: replaced printf by fprintf.
* scripts/statistics/tests/sign_test.m: replaced printf by fprintf.
* scripts/statistics/tests/t_test.m: replaced printf by fprintf.
* scripts/statistics/tests/t_test_2.m: replaced printf by fprintf.
* scripts/statistics/tests/t_test_regression.m: replaced printf by fprintf.
* scripts/statistics/tests/u_test.m: replaced printf by fprintf.
* scripts/statistics/tests/var_test.m: replaced printf by fprintf.
* scripts/statistics/tests/welch_test.m: replaced printf by fprintf.
* scripts/statistics/tests/wilcoxon_test.m: replaced printf by fprintf.
* scripts/statistics/tests/z_test.m: replaced printf by fprintf.
* scripts/statistics/tests/z_test_2.m: replaced printf by fprintf.
* scripts/strings/strtok.m: replaced printf by fprintf.
* scripts/testfun/__run_test_suite__.m: replaced puts by fputs and printf by fprintf.
* scripts/testfun/demo.m: replaced printf by fprintf.
* scripts/testfun/example.m: replaced printf by fprintf.
* scripts/testfun/private/compare_plot_demos.m: replaced printf by fprintf.
* scripts/testfun/rundemos.m: replaced printf by fprintf.
* scripts/testfun/runtests.m: replaced puts by fputs and printf by fprintf.
* scripts/testfun/speed.m: replaced printf by fprintf.
* scripts/testfun/test.m: replaced printf by fprintf.
* scripts/time/calendar.m: replaced puts by fputs and printf by fprintf.
* test/io.tst: replaced printf by fprintf.
author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
---|---|
date | Wed, 20 Apr 2016 17:53:10 +0200 |
parents | 6c2fd62db1f7 |
children | 96518f623c91 |
line wrap: on
line source
## Copyright (C) 2009-2015 Søren Hauberg ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} lookfor @var{str} ## @deftypefnx {} {} lookfor -all @var{str} ## @deftypefnx {} {[@var{fcn}, @var{help1str}] =} lookfor (@var{str}) ## @deftypefnx {} {[@var{fcn}, @var{help1str}] =} lookfor ("-all", @var{str}) ## Search for the string @var{str} in the documentation of all functions in the ## current function search path. ## ## By default, @code{lookfor} looks for @var{str} in just the first sentence of ## the help string for each function found. The entire help text of each ## function can be searched by using the @qcode{"-all"} argument. All searches ## are case insensitive. ## ## When called with no output arguments, @code{lookfor} prints the list of ## matching functions to the terminal. Otherwise, the output argument ## @var{fcns} contains the function names and @var{help1str} contains the first ## sentence from the help string of each function. ## ## Programming Note: The ability of @code{lookfor} to correctly identify the ## first sentence of the help text is dependent on the format of the function's ## help. All Octave core functions are correctly formatted, but the same can ## not be guaranteed for external packages and user-supplied functions. ## Therefore, the use of the @qcode{"-all"} argument may be necessary to find ## related functions that are not a part of Octave. ## ## The speed of lookup is greatly enhanced by having a cached documentation ## file. See @code{doc_cache_create} for more information. ## @seealso{help, doc, which, path, doc_cache_create} ## @end deftypefn function [fcn, help1str] = lookfor (str, arg2) if (strcmpi (str, "-all")) ## The difference between using '-all' and not is which part of the caches ## we search. The cache is organized such that row ## 1) contains the function name ## 2) contains the full help text ## 3) contains the first sentence of the help text. str = arg2; search_type = 2; # search the second row (full help text) else search_type = 3; # search the third column (first help sentence) endif str = lower (str); # Compare is case insensitive ## Search functions, operators, and keywords that come with Octave cache_file = doc_cache_file (); if (exist (cache_file, "file")) [fcnlist, help_text] = search_cache (str, cache_file, search_type); had_core_cache = true; else fcnlist = help_text = {}; had_core_cache = false; endif ## Search functions in new path dirs. orig_path = ostrsplit (__pathorig__ (), pathsep ()); ## ditto for path. new_path = ostrsplit (path (), pathsep ()); ## remove directories already covered by orig_path. if (had_core_cache) new_path = setdiff (new_path, orig_path); endif for n = 1:numel (new_path) fcndir = new_path{n}; cache_file = fullfile (fcndir, "doc-cache"); if (exist (cache_file, "file")) ## We have a cache in the directory, then read it and search it! [fcns, htext] = search_cache (str, cache_file, search_type); fcnlist(end+1:end+length (fcns)) = fcns; help_text(end+1:end+length (htext)) = htext; else ## We don't have a cache. Search files. for fcn_in_fcndir = (__list_functions__ (fcndir)).' fn = fcn_in_fcndir{1}; ## Skip files that start with "__" if (strncmp (fn, "__", 2)) continue; endif status = 0; ## Extract first sentence try warn_state = warning (); unwind_protect warning ("off"); first_sentence = get_first_help_sentence (fn, 1024); unwind_protect_cleanup warning (warn_state); end_unwind_protect catch status = 1; end_try_catch if (status) ## Error getting first help sentence elseif (search_type == 3) ## only search the first sentence of the help text text = first_sentence; elseif (search_type == 2) ## search entire help text try warn_state = warning (); unwind_protect warning ("off"); [text, fmt] = get_help_text (fn); switch (lower (fmt)) 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 unwind_protect_cleanup warning (warn_state); end_unwind_protect catch status = 1; end_try_catch endif ## Search the help text if (status == 0 && strfind (lower (text), str)) fcnlist(end+1) = fn; help_text(end+1) = first_sentence; endif endfor endif endfor if (nargout == 0) ## Print the results (FIXME: it would be nice to break at word boundaries) indent = 20; term_width = (terminal_size ())(2); desc_width = term_width - indent - 2; indent_space = blanks (indent); for k = 1:length (fcnlist) f = fcnlist{k}; f(end+1:indent-1) = " "; fputs ([f " "]); lf = length (f); desc = strtrim (strrep (help_text{k}, "\n", " ")); ldesc = length (desc); fprintf ("%s\n", desc(1:min (ldesc, desc_width - (lf - indent)))); for start = (desc_width - (lf - indent) + 1):desc_width:ldesc stop = min (start + desc_width, ldesc); fprintf ("%s%s\n", indent_space, strtrim (desc (start:stop))); endfor endfor else ## Return the results instead of displaying them fcn = fcnlist; help1str = help_text; endif endfunction function [fcns, help_texts] = search_cache (str, cache_file, search_type) load (cache_file); if (! isempty (cache)) t1 = strfind (lower (cache (1, :)), str); t2 = strfind (lower (cache (search_type, :)), str); cache_idx = find (! (cellfun ("isempty", t1) & cellfun ("isempty", t2))); fcns = cache(1, cache_idx); help_texts = cache(3, cache_idx); else fcns = help_texts = {}; endif endfunction