octave: libinterp/corefcn/help.cc annotate

annotate libinterp/corefcn/help.cc @ 32632:2e484f9f1f18 stable

maint: update Octave Project Developers copyright for the new year

author	John W. Eaton <jwe@octave.org>
date	Fri, 22 Dec 2023 12:08:17 -0500
parents	05b4479c29d8
children	2faec354b977

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 32589 diff changeset	3 // Copyright (C) 1993-2024 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	29
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	30 #include <cstdlib>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	31 #include <cstring>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	32
5769 2b9a5ce46678 [project @ 2006-04-18 15:57:06 by jwe] jwe parents: 5768 diff changeset	33 #include <algorithm>
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	34 #include <fstream>
25438 cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible John W. Eaton <jwe@octave.org> parents: 25395 diff changeset	35 #include <istream>
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	36 #include <map>
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5738 diff changeset	37 #include <sstream>
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	38 #include <string>
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	39
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	40 #include "cmd-edit.h"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	41 #include "file-ops.h"
6253 f1676652d808 [project @ 2007-01-24 20:43:36 by jwe] jwe parents: 6243 diff changeset	42 #include "file-stat.h"
25548 d6050ba12c0c Call get_ASCII_filename for std::ifstream (bug #49118). Markus Mützel <markus.muetzel@gmx.de> parents: 25460 diff changeset	43 #include "lo-sysdep.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2900 diff changeset	44 #include "oct-env.h"
19269 65554f5847ac don't include oct-locbuf.h in header files unnecessarily John W. Eaton <jwe@octave.org> parents: 19152 diff changeset	45 #include "oct-locbuf.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	46 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	47
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	48 #include "Cell.h"
7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	49 #include "builtin-defun-decls.h"
25460 627d6bde9b8d solve installation info initialization problem differently John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	50 #include "defaults.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	51 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	52 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21017 diff changeset	53 #include "errwarn.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	54 #include "help.h"
2177 0bddc913621b [project @ 1996-05-13 16:36:11 by jwe] jwe parents: 2124 diff changeset	55 #include "input.h"
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	56 #include "interpreter-private.h"
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	57 #include "interpreter.h"
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	58 #include "load-path.h"
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	59 #include "ov-classdef.h"
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	60 #include "ov-fcn-handle.h"
7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	61 #include "ov-usr-fcn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	62 #include "ovl.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	63 #include "pager.h"
3018 5708b8bb4f06 [project @ 1997-06-03 21:48:05 by jwe] jwe parents: 3016 diff changeset	64 #include "parse.h"
1466 2f85a175308f [project @ 1995-09-22 07:48:59 by jwe] jwe parents: 1443 diff changeset	65 #include "pathsearch.h"
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	66 #include "procstream.h"
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	67 #include "quit.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	68 #include "sighandlers.h"
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	69 #include "symtab.h"
8672 2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	70 #include "unwind-prot.h"
242 742c4795aea9 [project @ 1993-11-30 21:26:43 by jwe] jwe parents: 240 diff changeset	71 #include "utils.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	72 #include "variables.h"
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3296 diff changeset	73 #include "version.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	74
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	75 #include "default-defs.h"
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	76
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31105 diff changeset	77 OCTAVE_BEGIN_NAMESPACE(octave)
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	78
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	79 const static char *const operators[] =
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	80 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	81 "!",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	82 "~",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	83 "!=",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	84 "~=",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	85 R"(")",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	86 "#",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	87 "%",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	88 "#{",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	89 "%{",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	90 "#}",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	91 "%}",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	92 "...",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	93 "&",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	94 "&&",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	95 "'",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	96 "(",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	97 ")",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	98 "*",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	99 "^",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	100 "+",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	101 "++",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	102 ",",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	103 "-",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	104 "--",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	105 ".'",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	106 ".*",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	107 ".^",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	108 "./",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	109 "/",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	110 R"(.\)",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	111 R"(\)",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	112 ":",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	113 ";",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	114 "<",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	115 "<=",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	116 "=",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	117 "==",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	118 ">",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	119 ">=",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	120 "[",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	121 "]",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	122 "\|",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	123 "\|\|",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	124 nullptr
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	125 };
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	126
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	127 const static string_vector operator_names (operators);
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	128
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	129 static bool
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	130 looks_like_html (const std::string& msg)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	131 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	132 const std::size_t p1 = msg.find ('\n');
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	133 std::string t = msg.substr (0, p1);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	134 // FIXME: this comparison should be case-insensitive
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	135 const std::size_t p2 = t.find ("<html");
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	136
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	137 return (p2 != std::string::npos);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	138 }
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	139
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	140 static bool
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	141 looks_like_texinfo (const std::string& msg, std::size_t& p1)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	142 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	143 p1 = msg.find ('\n');
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	144
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	145 std::string t = msg.substr (0, p1);
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	146
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	147 if (p1 == std::string::npos)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	148 p1 = 0;
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	149
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	150 std::size_t p2 = t.find ("-- texinfo --");
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	151
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	152 return (p2 != std::string::npos);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	153 }
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 27037 diff changeset	154
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	155 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	156 help_system::built_in_docstrings_file (const octave_value_list& args,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	157 int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	158 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	159 return set_internal_variable (m_built_in_docstrings_file, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	160 "built_in_docstrings_file", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	161 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	162
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	163 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	164 help_system::doc_cache_file (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	165 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	166 return set_internal_variable (m_doc_cache_file, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	167 "doc_cache_file", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	168 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	169
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	170 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	171 help_system::info_file (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	172 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	173 return set_internal_variable (m_info_file, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	174 "info_file", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	175 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	176
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	177 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	178 help_system::info_program (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	179 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	180 return set_internal_variable (m_info_program, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	181 "info_program", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	182 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	183
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	184 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	185 help_system::makeinfo_program (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	186 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	187 return set_internal_variable (m_makeinfo_program, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	188 "makeinfo_program", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	189 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	190
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	191 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	192 help_system::suppress_verbose_help_message (const octave_value_list& args,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	193 int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	194 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	195 return set_internal_variable (m_suppress_verbose_help_message, args,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	196 nargout, "suppress_verbose_help_message");
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	197 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	198
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	199 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	200 help_system::texi_macros_file (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	201 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	202 return set_internal_variable (m_texi_macros_file, args, nargout,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	203 "texi_macros_file", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	204 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	205
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	206 std::string
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	207 help_system::raw_help (const std::string& nm, bool& symbol_found) const
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	208 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	209 std::string h;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	210 std::string w;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	211 std::string f;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	212
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	213 bool found;
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	214
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	215 found = raw_help_from_symbol_table (nm, h, w, symbol_found);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	216
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	217 if (! found)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	218 found = raw_help_from_file (nm, h, f, symbol_found);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	219
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	220 bool external_doc = h.compare (0, 12, "external-doc") == 0;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	221
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	222 if (! found \|\| external_doc)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	223 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	224 std::string tmp_nm = nm;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	225
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	226 if (external_doc && h.length () > 12 && h[12] == ':')
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	227 tmp_nm = h.substr (13);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	228
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	229 raw_help_from_docstrings_file (tmp_nm, h, symbol_found);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	230 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	231
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	232 return h;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	233 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	234
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	235 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	236 help_system::which (const std::string& name,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	237 std::string& type) const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	238 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	239 std::string file;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	240
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	241 if (name.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	242 return file;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	243
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	244 type = "";
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	245
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	246 symbol_table& symtab = m_interpreter.get_symbol_table ();
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	247
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	248 octave_value val = symtab.find_function (name);
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	249
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	250 if (val.is_defined ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	251 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	252 octave_function *fcn = val.function_value ();
26594 088b8a2dcb06 use @CLASS name when searching for @CLASS/METHOD (bug #55501) John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	253
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	254 if (fcn)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	255 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	256 if (fcn->is_classdef_meta ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	257 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	258 octave_classdef_meta *meta_obj
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	259 = dynamic_cast<octave_classdef_meta *> (fcn);
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	260
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	261 file = meta_obj->file_name ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	262
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	263 if (meta_obj->is_classdef_constructor ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	264 type = "class constructor";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	265 else if (meta_obj->is_classdef_method ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	266 type = "class method";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	267 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	268 type = "classdef meta object";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	269 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	270 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	271 {
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	272
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	273 file = fcn->fcn_file_name ();
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	274
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	275 if (! file.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	276 type = val.is_user_script () ? "script" : "function";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	277 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	278 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	279 if (fcn->is_user_function ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	280 type = "command-line function";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	281 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	282 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	283 file = fcn->src_file_name ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	284 type = "built-in function";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	285 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	286 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	287 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	288 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	289 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	290 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	291 // We might find a file that contains only a doc string.
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	292
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	293 load_path& lp = m_interpreter.get_load_path ();
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	294
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	295 file = lp.find_fcn_file (name);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	296 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	297 }
30260 bfbe6e528af5 which: report correct info for classdef constructors (bug #49434) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	298
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	299 if (file.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	300 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	301 // File query.
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	302
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	303 load_path& lp = m_interpreter.get_load_path ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	304
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	305 // For compatibility: "file." queries "file".
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	306 if (name.size () > 1 && name[name.size () - 1] == '.')
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	307 file = lp.find_file (name.substr (0, name.size () - 1));
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	308 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	309 file = lp.find_file (name);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	310
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	311 file = sys::env::make_absolute (file);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	312 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	313
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	314 return file;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	315 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	316
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	317 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	318 help_system::which (const std::string& name) const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	319 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	320 std::string type;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	321
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	322 return which (name, type);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	323 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	324
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	325 string_vector
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	326 help_system::make_name_list () const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	327 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	328 const static string_vector keywords
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	329 = Fiskeyword ()(0).string_vector_value ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	330
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	331 const static int key_len = keywords.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	332
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	333 symbol_table& symtab = m_interpreter.get_symbol_table ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	334
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	335 const string_vector bif = symtab.built_in_function_names ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	336 const int bif_len = bif.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	337
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	338 const string_vector cfl = symtab.cmdline_function_names ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	339 const int cfl_len = cfl.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	340
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	341 const string_vector lcl = m_interpreter.variable_names ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	342 const int lcl_len = lcl.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	343
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	344 load_path& lp = m_interpreter.get_load_path ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	345
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	346 const string_vector ffl = lp.fcn_names ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	347 const int ffl_len = ffl.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	348
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	349 const string_vector afl = m_interpreter.autoloaded_functions ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	350 const int afl_len = afl.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	351
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	352 const string_vector lfl = local_functions ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	353 const int lfl_len = lfl.numel ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	354
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	355 const int total_len
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	356 = key_len + bif_len + cfl_len + lcl_len + ffl_len + afl_len + lfl_len;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	357
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	358 string_vector list (total_len);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	359
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	360 // Put all the symbols in one big list.
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	361
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	362 int j = 0;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	363 int i = 0;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	364
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	365 for (i = 0; i < key_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	366 list[j++] = keywords[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	367
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	368 for (i = 0; i < bif_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	369 list[j++] = bif[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	370
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	371 for (i = 0; i < cfl_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	372 list[j++] = cfl[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	373
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	374 for (i = 0; i < lcl_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	375 list[j++] = lcl[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	376
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	377 for (i = 0; i < ffl_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	378 list[j++] = ffl[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	379
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	380 for (i = 0; i < afl_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	381 list[j++] = afl[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	382
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	383 for (i = 0; i < lfl_len; i++)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	384 list[j++] = lfl[i];
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	385
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	386 return list;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	387 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	388
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	389 void
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	390 help_system::get_help_text (const std::string& name, std::string& text,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	391 std::string& format) const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	392 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	393 bool symbol_found = false;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	394 text = raw_help (name, symbol_found);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	395
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	396 format = "Not found";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	397 if (symbol_found)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	398 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	399 std::size_t idx = -1;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	400 if (text.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	401 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	402 format = "Not documented";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	403 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	404 else if (looks_like_texinfo (text, idx))
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	405 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	406 format = "texinfo";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	407 text.erase (0, idx);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	408 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	409 else if (looks_like_html (text))
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	410 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	411 format = "html";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	412 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	413 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	414 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	415 format = "plain text";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	416 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	417 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	418 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	419
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	420 void
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	421 help_system::get_help_text_from_file (const std::string& fname,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	422 std::string& text,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	423 std::string& format) const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	424 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	425 bool symbol_found = false;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	426
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	427 std::string f;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	428
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	429 raw_help_from_file (fname, text, f, symbol_found);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	430
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	431 format = "Not found";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	432 if (symbol_found)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	433 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	434 std::size_t idx = -1;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	435 if (text.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	436 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	437 format = "Not documented";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	438 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	439 else if (looks_like_texinfo (text, idx))
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	440 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	441 format = "texinfo";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	442 text.erase (0, idx);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	443 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	444 else if (looks_like_html (text))
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	445 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	446 format = "html";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	447 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	448 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	449 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	450 format = "plain text";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	451 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	452 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	453 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	454
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	455 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	456 help_system::init_built_in_docstrings_file ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	457 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	458 std::string df = sys::env::getenv ("OCTAVE_BUILT_IN_DOCSTRINGS_FILE");
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	459
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	460 std::string dir_sep = sys::file_ops::dir_sep_str ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	461
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	462 if (df.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	463 df = config::oct_etc_dir () + dir_sep + "built-in-docstrings";
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	464
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	465 return df;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	466 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	467
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	468 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	469 help_system::init_doc_cache_file ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	470 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	471 std::string def_file = config::prepend_octave_home (OCTAVE_DOC_CACHE_FILE);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	472
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	473 std::string env_file = sys::env::getenv ("OCTAVE_DOC_CACHE_FILE");
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	474
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	475 return (env_file.empty () ? def_file : env_file);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	476 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	477
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	478 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	479 help_system::init_info_file ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	480 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	481 std::string std_info_file = config::prepend_octave_home (OCTAVE_INFOFILE);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	482
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	483 std::string oct_info_file = sys::env::getenv ("OCTAVE_INFO_FILE");
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	484
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	485 return (oct_info_file.empty () ? std_info_file : oct_info_file);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	486 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	487
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	488 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	489 help_system::init_info_program ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	490 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	491 std::string info_prog = sys::env::getenv ("OCTAVE_INFO_PROGRAM");
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	492
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	493 if (info_prog.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	494 info_prog = "info";
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	495
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	496 return info_prog;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	497 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	498
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	499 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	500 help_system::init_texi_macros_file ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	501 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	502 std::string def_file
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	503 = config::prepend_octave_home (OCTAVE_TEXI_MACROS_FILE);
22295 12f1d273d22a maint: Remove trailing spaces from code. Rik <rik@octave.org> parents: 22199 diff changeset	504
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	505 std::string env_file = sys::env::getenv ("OCTAVE_TEXI_MACROS_FILE");
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	506
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	507 return (env_file.empty () ? def_file : env_file);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	508 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	509
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	510 // Return a vector of all functions from this file,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	511 // for use in command line auto-completion.
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	512 string_vector
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	513 help_system::local_functions () const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	514 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	515 string_vector retval;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	516
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	517 tree_evaluator& tw = m_interpreter.get_evaluator ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	518
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	519 octave_user_code *curr_fcn = tw.current_user_code ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	520
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	521 if (! curr_fcn)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	522 return retval;
25394 9e39a53b4e00 make listing local functions for command completion work again (bug #53925) John W. Eaton <jwe@octave.org> parents: 25388 diff changeset	523
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	524 // All subfunctions are listed in the top-level function of this file.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	525 // If curr_fcn is a subfunction, then there must be a parent and
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	526 // curr_fcn will always be valid in and after executing this loop.
25394 9e39a53b4e00 make listing local functions for command completion work again (bug #53925) John W. Eaton <jwe@octave.org> parents: 25388 diff changeset	527
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	528 while (curr_fcn->is_subfunction ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	529 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	530 symbol_scope pscope = curr_fcn->parent_fcn_scope ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	531 curr_fcn = pscope.user_code ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	532 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	533
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	534 // Get subfunctions.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	535 const std::list<std::string> names = curr_fcn->subfunction_names ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	536
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	537 std::size_t sz = names.size ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	538 retval.resize (sz);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	539
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	540 // Loop over them.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	541 std::size_t i = 0;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	542 for (const auto& nm : names)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	543 retval(i++) = nm;
22556 121e9639b604 doc: Correctly get last entry from DOCSTRINGS file (bug #49224). Rik <rik@octave.org> parents: 22407 diff changeset	544
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	545 return retval;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	546 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	547
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	548 bool
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	549 help_system::raw_help_from_symbol_table (const std::string& nm,
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	550 std::string& h, std::string& w,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	551 bool& symbol_found) const
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	552 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	553 std::string meth_nm;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	554
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	555 symbol_table& symtab = m_interpreter.get_symbol_table ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	556
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	557 octave_value val = symtab.find_function (nm);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	558
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	559 if (! val.is_defined ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	560 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	561 std::size_t pos = nm.rfind ('.');
28514 fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	562
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	563 if (pos != std::string::npos)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	564 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	565 meth_nm = nm.substr (pos+1);
28514 fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	566
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	567 val = symtab.find_function (nm.substr (0, pos));
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	568 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	569 }
28514 fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	570
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	571 if (val.is_defined ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	572 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	573 octave_function *fcn = val.function_value ();
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	574
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	575 if (fcn)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	576 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	577 // FCN may actually be a classdef_meta object.
28514 fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	578
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	579 symbol_found = true;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	580
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	581 h = fcn->doc_string (meth_nm);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	582
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	583 w = fcn->fcn_file_name ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	584
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	585 if (w.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	586 w = fcn->is_user_function () ? "command-line function"
28514 fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	587 : "built-in function";
fab862fedf85 allow help to find docstrings for classdef classes and methods (bug #43047) John W. Eaton <jwe@octave.org> parents: 28432 diff changeset	588
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	589 return true;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	590 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	591 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	592
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	593 return false;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	594 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	595
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	596 bool
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	597 help_system::raw_help_from_file (const std::string& nm,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	598 std::string& h, std::string& file,
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	599 bool& symbol_found) const
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	600 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	601 bool retval = false;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	602
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	603 h = get_help_from_file (nm, symbol_found, file);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	604
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	605 if (h.length () > 0)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	606 retval = true;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	607
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	608 return retval;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	609 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	610
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	611 bool
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	612 help_system::raw_help_from_docstrings_file (const std::string& nm,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	613 std::string& h,
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	614 bool& symbol_found) const
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	615 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	616 typedef std::pair<std::streampos, std::streamoff> txt_limits_type;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	617 typedef std::map<std::string, txt_limits_type> help_txt_map_type;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	618
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	619 static help_txt_map_type help_txt_map;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	620 static bool initialized = false;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	621
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	622 h = "";
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	623 symbol_found = false;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	624
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	625 // FIXME: Should we cache the timestamp of the file and reload the
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	626 // offsets if it changes? Or just warn about that? Or just ignore
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	627 // it, and assume it won't change?
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	628
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	629 if (! initialized)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	630 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	631 std::ifstream file = sys::ifstream (m_built_in_docstrings_file.c_str (),
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	632 std::ios::in \| std::ios::binary);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	633
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	634 if (! file)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	635 error ("failed to open docstrings file: %s",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	636 m_built_in_docstrings_file.c_str ());
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	637
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	638 // Ignore header;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	639 file.ignore (std::numeric_limits<std::streamsize>::max(), 0x1d);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	640
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	641 if (file.eof ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	642 error ("invalid built-in-docstrings file!");
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	643
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	644 // FIXME: eliminate fixed buffer size.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	645 std::size_t bufsize = 1000;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	646 OCTAVE_LOCAL_BUFFER (char, buf, bufsize);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	647
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	648 while (! file.eof ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	649 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	650 std::string name;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	651 int i = 0;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	652 int c;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	653 while (file
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	654 && (c = file.get ()) != std::istream::traits_type::eof ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	655 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	656 if (c == '\n' \|\| c == '\r')
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	657 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	658 buf[i] = '\0';
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	659 name = buf;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	660 break;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	661 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	662 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	663 buf[i++] = c;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	664 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	665
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	666 // Skip @c FILENAME which is part of current DOCSTRINGS
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	667 // syntax. This may disappear if a specific format for
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	668 // docstring files is developed.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	669 while (file
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	670 && (c = file.get ()) != std::istream::traits_type::eof ()
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	671 && c != '\n' && c != '\r')
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	672 ; // skip text
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	673
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	674 // skip newline characters
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	675 while (file
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	676 && (c = file.get ()) != std::istream::traits_type::eof ()
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	677 && (c == '\n' \|\| c == '\r'))
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	678 ; // skip text
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	679
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	680 file.unget ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	681
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	682 // Position of beginning of help text.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	683 std::streampos beg = file.tellg ();
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	684
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	685 // Skip help text.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	686 file.ignore (std::numeric_limits<std::streamsize>::max(), 0x1d);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	687
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	688 // Position of end of help text.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	689 std::streamoff len;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	690
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	691 if (! file.eof ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	692 len = file.tellg () - beg - 1;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	693 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	694 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	695 file.seekg (0, file.end);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	696 len = file.tellg () - beg - 1;
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	697 file.setstate (file.eofbit); // reset eof flag
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	698 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	699
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	700 help_txt_map[name] = txt_limits_type (beg, len);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	701 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	702
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	703 initialized = true;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	704 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	705
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	706 help_txt_map_type::const_iterator it = help_txt_map.find (nm);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	707
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	708 if (it != help_txt_map.end ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	709 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	710 txt_limits_type txt_limits = it->second;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	711
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	712 std::streampos beg = txt_limits.first;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	713 std::streamoff len = txt_limits.second;
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	714
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	715 std::ifstream file = sys::ifstream (m_built_in_docstrings_file.c_str (),
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	716 std::ios::in \| std::ios::binary);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	717
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	718 if (! file)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	719 error ("failed to open docstrings file: %s",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	720 m_built_in_docstrings_file.c_str ());
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	721
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	722 file.seekg (beg);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	723
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	724 std::size_t txt_len = len;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	725 OCTAVE_LOCAL_BUFFER (char, buf, txt_len + 1);
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	726
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	727 file.read (buf, txt_len);
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	728
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	729 buf[txt_len] = '\0';
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	730
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	731 h = buf;
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	732
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	733 symbol_found = true;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	734 }
22198 f6181638f6c5 search docstrings file for built-in and dld function help text (bug #48554) John W. Eaton <jwe@octave.org> parents: 22172 diff changeset	735
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	736 return symbol_found;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	737 }
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	738
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	739 // FIXME: It's not likely that this does the right thing now.
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	740
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	741 string_vector
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	742 make_name_list ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	743 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	744 help_system& help_sys = __get_help_system__ ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	745
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	746 return help_sys.make_name_list ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	747 }
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29670 diff changeset	748
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	749 DEFMETHOD (get_help_text, interp, args, ,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	750 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	751 @deftypefn {} {[@var{text}, @var{format}] =} get_help_text (@var{name})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	752 Return the raw help text of function @var{name}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	753
27438 7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	754 The raw help text is returned in @var{text} and the format in @var{format}.
7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	755 The format is a string which is one of @qcode{"texinfo"}, @qcode{"html"}, or
7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	756 @w{@qcode{"plain text"}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	757 @seealso{get_help_text_from_file}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	758 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	759 {
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	760 if (args.length () != 1)
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	761 print_usage ();
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	762
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	763 const std::string name = args(0).xstring_value ("get_help_text: NAME must be a string");
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	764
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	765 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	766
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20922 diff changeset	767 std::string text, format;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	768
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	769 help_sys.get_help_text (name, text, format);
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	770
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20922 diff changeset	771 return ovl (text, format);
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	772 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	773
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	774 DEFMETHOD (get_help_text_from_file, interp, args, ,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	775 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	776 @deftypefn {} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	777 Return the raw help text from the file @var{fname}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	778
27438 7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	779 The raw help text is returned in @var{text} and the format in @var{format}.
7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	780 The format is a string which is one of @qcode{"texinfo"}, @qcode{"html"}, or
7db34a40cd23 doc: Improve documentation for get_help_text, get_help_text_from_file. Rik <rik@octave.org> parents: 27361 diff changeset	781 @w{@qcode{"plain text"}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	782 @seealso{get_help_text}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	783 @end deftypefn */)
9806 8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9416 diff changeset	784 {
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	785 if (args.length () != 1)
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	786 print_usage ();
9806 8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9416 diff changeset	787
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	788 const std::string fname = args(0).xstring_value ("get_help_text_from_file: NAME must be a string");
9806 8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9416 diff changeset	789
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	790 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	791
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20922 diff changeset	792 std::string text, format;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	793
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	794 help_sys.get_help_text_from_file (fname, text, format);
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	795
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20922 diff changeset	796 return ovl (text, format);
9806 8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9416 diff changeset	797 }
8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9416 diff changeset	798
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	799 // Return a cell array of strings containing the names of all operators.
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	800
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	801 DEFUN (__operators__, , ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	802 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30588 diff changeset	803 @deftypefn {} {@var{cstr} =} __operators__ ()
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30588 diff changeset	804 Return a cell array of strings of all possible Octave operators.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	805 @end deftypefn */)
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	806 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	807 return ovl (Cell (operator_names));
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	808 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	809
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	810 // Return a cell array of strings containing the names of all keywords.
7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	811 // iskeyword() function is located in lex.ll and is based on what the parser
7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	812 // thinks is a keyword.
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	813
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	814 DEFALIAS (__keywords__, iskeyword)
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	815
23065 7c7a61c2e0ed Replace out-of-date __keywords__ with alias to iskeyword. Rik <rik@octave.org> parents: 23052 diff changeset	816 // Return a cell array of strings with the names of all builtin functions.
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	817
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23553 diff changeset	818 DEFMETHOD (__builtins__, interp, , ,
5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23553 diff changeset	819 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	820 @deftypefn {} {} __builtins__ ()
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30588 diff changeset	821 Return a cell array of all builtin (compiled) functions available to Octave.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	822 @end deftypefn */)
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	823 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	824 symbol_table& symtab = interp.get_symbol_table ();
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23553 diff changeset	825
5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23553 diff changeset	826 const string_vector bif = symtab.built_in_function_names ();
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	827
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21100 diff changeset	828 return ovl (Cell (bif));
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	829 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	830
23553 14723784b9f2 don't use singleton for call_stack John W. Eaton <jwe@octave.org> parents: 23466 diff changeset	831 DEFMETHOD (localfunctions, interp, args, ,
14723784b9f2 don't use singleton for call_stack John W. Eaton <jwe@octave.org> parents: 23466 diff changeset	832 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30588 diff changeset	833 @deftypefn {} {@var{subfcn_list} =} localfunctions ()
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	834 Return a list of all local functions, i.e., subfunctions, within the current
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	835 file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	836
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	837 The return value is a column cell array of function handles to all local
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	838 functions accessible from the function from which @code{localfunctions} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	839 called. Nested functions are @emph{not} included in the list.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	840
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	841 If the call is from the command line, an anonymous function, or a script,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	842 the return value is an empty cell array.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	843
22974 ecc5eeada8dc Don't mark nested functions in primary function as subfunctions. Rik <rik@octave.org> parents: 22885 diff changeset	844 @seealso{functions}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	845 @end deftypefn */)
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	846 {
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	847 if (args.length () != 0)
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	848 print_usage ();
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	849
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	850 Cell retval;
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	851
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	852 // Find the main function we are in.
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	853 tree_evaluator& tw = interp.get_evaluator ();
28432 71c34141cc2d refactor handling of parent functions and localfunctions John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	854 octave_user_code *caller = tw.debug_user_code ();
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	855
28432 71c34141cc2d refactor handling of parent functions and localfunctions John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	856 if (! caller)
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	857 return ovl (retval);
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	858
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	859 symbol_scope scope = caller->scope ();
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	860
28432 71c34141cc2d refactor handling of parent functions and localfunctions John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	861 return ovl (Cell (scope.localfunctions ()));
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	862 }
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	863
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	864 /*
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	865 %!test
26679 2b6aa96a5c82 create BIST temporary files in tempdir instead of P_tmpdir (bug #55565) Mike Miller <mtmiller@octave.org> parents: 26677 diff changeset	866 %! f = tempname (tempdir (), "oct_");
27361 a7d21a6a7922 BIST should not rely on the current directory to be writable. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 26594 diff changeset	867 %! [~, fcn_name] = fileparts (f);
22016 d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	868 %! f = [f ".m"];
26677 33f79d94f21f Create any BIST temporary files in writable temporary directory (bug #55565). Rik <rik@octave.org> parents: 26661 diff changeset	869 %! save_path = path ();
22016 d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	870 %! unwind_protect
26679 2b6aa96a5c82 create BIST temporary files in tempdir instead of P_tmpdir (bug #55565) Mike Miller <mtmiller@octave.org> parents: 26677 diff changeset	871 %! addpath (tempdir ());
22016 d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	872 %! fid = fopen (f, "w+");
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	873 %! fprintf (fid, "function z = %s\n z = localfunctions; end\n", fcn_name);
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	874 %! fprintf (fid, "function z = b(x)\n z = x+1; end\n");
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	875 %! fprintf (fid, "function z = c(x)\n z = 2*x; end\n");
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	876 %! fclose (fid);
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	877 %! d = eval (fcn_name);
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	878 %! assert (size (d), [2, 1]);
22974 ecc5eeada8dc Don't mark nested functions in primary function as subfunctions. Rik <rik@octave.org> parents: 22885 diff changeset	879 %! assert (d{1} (3), 4);
ecc5eeada8dc Don't mark nested functions in primary function as subfunctions. Rik <rik@octave.org> parents: 22885 diff changeset	880 %! assert (d{2} (3), 6);
22016 d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	881 %! unwind_protect_cleanup
d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	882 %! unlink (f);
26677 33f79d94f21f Create any BIST temporary files in writable temporary directory (bug #55565). Rik <rik@octave.org> parents: 26661 diff changeset	883 %! path (save_path);
22016 d4ce10f57918 Clean up localfunctions BIST test Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	884 %! end_unwind_protect
21765 23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	885 */
23a610a3f001 Implement localfunctions Matlab command (bug #47705). Lachlan Andrew <lachlanbis@gmail.com> parents: 21733 diff changeset	886
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	887 DEFMETHOD (__which__, interp, args, ,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	888 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30588 diff changeset	889 @deftypefn {} {@var{var_struct} =} __which__ (@var{name}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	890 Undocumented internal function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	891 @end deftypefn */)
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	892 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	893 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	894
20996 20bd3d4fabad Clean up instances of make_argv(). Rik <rik@octave.org> parents: 20940 diff changeset	895 string_vector argv = args.make_argv ();
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	896
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	897 int nargin = argv.numel ();
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	898
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	899 octave_map m (dim_vector (1, nargin));
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	900
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	901 Cell names (1, nargin);
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	902 Cell files (1, nargin);
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	903 Cell types (1, nargin);
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	904
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	905 for (int i = 0; i < nargin; i++)
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	906 {
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	907 std::string name = argv[i];
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	908
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	909 std::string type;
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	910
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	911 std::string file = help_sys.which (name, type);
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	912
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	913 names(i) = name;
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	914 files(i) = file;
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	915 types(i) = type;
20803 c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	916 }
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	917
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	918 m.assign ("name", names);
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	919 m.assign ("file", files);
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	920 m.assign ("type", types);
c22206c1a88f eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20714 diff changeset	921
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20884 diff changeset	922 return ovl (m);
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	923 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	924
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	925 // Return a cell array of strings containing the names of all
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	926 // functions available in DIRECTORY. If no directory is given, search
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	927 // the current path.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	928
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	929 DEFMETHOD (__list_functions__, interp, args, ,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	930 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	931 @deftypefn {} {@var{retval} =} __list_functions__ ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	932 @deftypefnx {} {@var{retval} =} __list_functions__ (@var{directory})
22337 77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	933 Return a list of all functions (.m and .oct functions) in the load path.
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	934
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	935 If the optional argument @var{directory} is given then list only the functions
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	936 in that directory.
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	937 @seealso{path}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	938 @end deftypefn */)
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	939 {
8863 34a821854961 pkg.m (generate_lookfor_cache): generate a DOC file for each directory Jason Riedy <jason@acm.org> parents: 8861 diff changeset	940 octave_value retval;
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	941
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	942 load_path& lp = interp.get_load_path ();
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	943
22337 77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	944 if (args.length () == 0)
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	945 {
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	946 // Get list of all functions
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	947 string_vector ffl = lp.fcn_names ();
27016 9b261300a001 move file-scope static autoload map variable and functions to evaluator John W. Eaton <jwe@octave.org> parents: 26679 diff changeset	948 string_vector afl = interp.autoloaded_functions ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	949
22337 77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	950 retval = Cell (ffl.append (afl));
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	951 }
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	952 else
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	953 {
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20678 diff changeset	954 std::string dir = args(0).xstring_value ("__list_functions__: DIRECTORY argument must be a string");
8863 34a821854961 pkg.m (generate_lookfor_cache): generate a DOC file for each directory Jason Riedy <jason@acm.org> parents: 8861 diff changeset	955
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	956 string_vector fl = lp.files (dir, true);
19403 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19269 diff changeset	957
22337 77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	958 // Return a sorted list with unique entries (in case of .m and .oct
77c209d63b75 Update __list_functions__ internal function. Rik <rik@octave.org> parents: 22323 diff changeset	959 // versions of the same function in a given directory, for example).
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	960 fl.sort (true);
8863 34a821854961 pkg.m (generate_lookfor_cache): generate a DOC file for each directory Jason Riedy <jason@acm.org> parents: 8861 diff changeset	961
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	962 retval = Cell (fl);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	963 }
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	964
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	965 return retval;
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	966 }
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	967
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	968 DEFMETHOD (built_in_docstrings_file, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	969 doc: /* -- texinfo --
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	970 @deftypefn {} {@var{val} =} built_in_docstrings_file ()
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	971 @deftypefnx {} {@var{old_val} =} built_in_docstrings_file (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	972 @deftypefnx {} {@var{old_val} =} built_in_docstrings_file (@var{new_val}, "local")
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	973 Query or set the internal variable that specifies the name of the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	974 file containing docstrings for built-in Octave functions.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	975
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	976 The default value is
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	977 @file{@var{octave-home}/share/octave/@var{version}/etc/built-in-docstrings},
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	978 in which @var{octave-home} is the root directory of the Octave installation,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	979 and @var{version} is the Octave version number. The default value may be
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	980 overridden by the environment variable
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	981 @w{@env{OCTAVE_BUILT_IN_DOCSTRINGS_FILE}}, or the command line argument
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	982 @option{--built-in-docstrings-file FNAME}.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	983
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	984 Note: This variable is only used when Octave is initializing itself.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	985 Modifying it during a running session of Octave will have no effect.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	986 @end deftypefn */)
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	987 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	988 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	989
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	990 return help_sys.built_in_docstrings_file (args, nargout);
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	991 }
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	992
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	993 DEFMETHOD (doc_cache_file, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	994 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	995 @deftypefn {} {@var{val} =} doc_cache_file ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	996 @deftypefnx {} {@var{old_val} =} doc_cache_file (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	997 @deftypefnx {} {@var{old_val} =} doc_cache_file (@var{new_val}, "local")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	998 Query or set the internal variable that specifies the name of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	999 Octave documentation cache file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1000
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1001 A cache file significantly improves the performance of the @code{lookfor}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1002 command. The default value is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1003 @file{@var{octave-home}/share/octave/@var{version}/etc/doc-cache},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1004 in which @var{octave-home} is the root directory of the Octave installation,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1005 and @var{version} is the Octave version number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1006 The default value may be overridden by the environment variable
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1007 @w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1008 @option{--doc-cache-file FNAME}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1009
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1010 When called from inside a function with the @qcode{"local"} option, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1011 variable is changed locally for the function and any subroutines it calls.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1012 The original variable value is restored when exiting the function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1013 @seealso{doc_cache_create, lookfor, info_program, doc, help, makeinfo_program}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1014 @seealso{lookfor}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1015 @end deftypefn */)
8861 31f864877246 doc and lookfor fixes John W. Eaton <jwe@octave.org> parents: 8812 diff changeset	1016 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1017 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1018
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1019 return help_sys.doc_cache_file (args, nargout);
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1020 }
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1021
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1022 DEFMETHOD (info_file, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1023 doc: /* -- texinfo --
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1024 @deftypefn {} {@var{val} =} info_file ()
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1025 @deftypefnx {} {@var{old_val} =} info_file (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	1026 @deftypefnx {} {@var{old_val} =} info_file (@var{new_val}, "local")
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1027 Query or set the internal variable that specifies the name of the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1028 Octave info file.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1029
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1030 The default value is
28880 68e6e6f083f3 doc: Correct some installation paths (bug #59236). Markus Mützel <markus.muetzel@gmx.de> parents: 28514 diff changeset	1031 @file{@var{octave-home}/share/info/octave.info}, in
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1032 which @var{octave-home} is the root directory of the Octave installation.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1033 The default value may be overridden by the environment variable
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1034 @w{@env{OCTAVE_INFO_FILE}}, or the command line argument
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1035 @option{--info-file FNAME}.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1036
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1037 When called from inside a function with the @qcode{"local"} option, the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1038 variable is changed locally for the function and any subroutines it calls.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1039 The original variable value is restored when exiting the function.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1040 @seealso{info_program, doc, help, makeinfo_program}
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1041 @end deftypefn */)
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1042 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1043 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1044
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1045 return help_sys.info_file (args, nargout);
8861 31f864877246 doc and lookfor fixes John W. Eaton <jwe@octave.org> parents: 8812 diff changeset	1046 }
31f864877246 doc and lookfor fixes John W. Eaton <jwe@octave.org> parents: 8812 diff changeset	1047
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1048 DEFMETHOD (info_program, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1049 doc: /* -- texinfo --
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1050 @deftypefn {} {@var{val} =} info_program ()
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1051 @deftypefnx {} {@var{old_val} =} info_program (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	1052 @deftypefnx {} {@var{old_val} =} info_program (@var{new_val}, "local")
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1053 Query or set the internal variable that specifies the name of the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1054 info program to run.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1055
29668 f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release. Rik <rik@octave.org> parents: 29654 diff changeset	1056 The default value is @file{info}. The default value may be
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release. Rik <rik@octave.org> parents: 29654 diff changeset	1057 overridden by the environment variable @w{@env{OCTAVE_INFO_PROGRAM}}, or the
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release. Rik <rik@octave.org> parents: 29654 diff changeset	1058 command line argument @option{--info-program NAME}.
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1059
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1060 When called from inside a function with the @qcode{"local"} option, the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1061 variable is changed locally for the function and any subroutines it calls.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1062 The original variable value is restored when exiting the function.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1063 @seealso{info_file, doc, help, makeinfo_program}
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1064 @end deftypefn */)
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1065 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1066 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1067
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1068 return help_sys.info_program (args, nargout);
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1069 }
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1070
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1071 DEFMETHOD (makeinfo_program, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1072 doc: /* -- texinfo --
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1073 @deftypefn {} {@var{val} =} makeinfo_program ()
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1074 @deftypefnx {} {@var{old_val} =} makeinfo_program (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	1075 @deftypefnx {} {@var{old_val} =} makeinfo_program (@var{new_val}, "local")
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1076 Query or set the internal variable that specifies the name of the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1077 program that Octave runs to format help text containing
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1078 Texinfo markup commands.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1079
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1080 The default value is @code{makeinfo}.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1081
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1082 When called from inside a function with the @qcode{"local"} option, the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1083 variable is changed locally for the function and any subroutines it calls.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1084 The original variable value is restored when exiting the function.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1085 @seealso{texi_macros_file, info_file, info_program, doc, help}
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1086 @end deftypefn */)
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1087 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1088 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1089
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1090 return help_sys.makeinfo_program (args, nargout);
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1091 }
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1092
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1093 DEFMETHOD (suppress_verbose_help_message, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1094 doc: /* -- texinfo --
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1095 @deftypefn {} {@var{val} =} suppress_verbose_help_message ()
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1096 @deftypefnx {} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	1097 @deftypefnx {} {@var{old_val} =} suppress_verbose_help_message (@var{new_val}, "local")
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1098 Query or set the internal variable that controls whether Octave
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1099 will add additional help information to the end of the output from
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1100 the @code{help} command and usage messages for built-in commands.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1101
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1102 When called from inside a function with the @qcode{"local"} option, the
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1103 variable is changed locally for the function and any subroutines it calls.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1104 The original variable value is restored when exiting the function.
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1105 @end deftypefn */)
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1106 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1107 help_system& help_sys = interp.get_help_system ();
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1108
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1109 return help_sys.suppress_verbose_help_message (args, nargout);
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1110 }
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1111
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1112 DEFMETHOD (texi_macros_file, interp, args, nargout,
b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1113 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1114 @deftypefn {} {@var{val} =} texi_macros_file ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1115 @deftypefnx {} {@var{old_val} =} texi_macros_file (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30565 diff changeset	1116 @deftypefnx {} {@var{old_val} =} texi_macros_file (@var{new_val}, "local")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1117 Query or set the internal variable that specifies the name of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1118 file containing Texinfo macros that are prepended to documentation strings
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1119 before they are passed to makeinfo.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1120
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1121 The default value is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1122 @file{@var{octave-home}/share/octave/@var{version}/etc/macros.texi},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1123 in which @var{octave-home} is the root directory of the Octave installation,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1124 and @var{version} is the Octave version number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1125 The default value may be overridden by the environment variable
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1126 @w{@env{OCTAVE_TEXI_MACROS_FILE}}, or the command line argument
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1127 @option{--texi-macros-file FNAME}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1128
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1129 When called from inside a function with the @qcode{"local"} option, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1130 variable is changed locally for the function and any subroutines it calls.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1131 The original variable value is restored when exiting the function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1132 @seealso{makeinfo_program}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1133 @end deftypefn */)
14614 4e9dc46d4125 handle texinfo macros consistently in help system and manual John W. Eaton <jwe@octave.org> parents: 14360 diff changeset	1134 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	1135 help_system& help_sys = interp.get_help_system ();
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	1136
23721 b2d55b52ee51 new class to manage help system and associated variables John W. Eaton <jwe@octave.org> parents: 23693 diff changeset	1137 return help_sys.texi_macros_file (args, nargout);
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1138 }
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29670 diff changeset	1139
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31105 diff changeset	1140 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/help.cc @ 32632:2e484f9f1f18 stable