octave: libinterp/parse-tree/pt.h annotate

annotate libinterp/parse-tree/pt.h @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	0a5b15007766

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 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 1996-2020 The Octave Project Developers
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 ////////////////////////////////////////////////////////////////////////
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_pt_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17744 diff changeset	27 #define octave_pt_h 1
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21157 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21157 diff changeset	30
2991 fc751d2a99fd [project @ 1997-05-16 21:00:48 by jwe] jwe parents: 2987 diff changeset	31 #include <string>
fc751d2a99fd [project @ 1997-05-16 21:00:48 by jwe] jwe parents: 2987 diff changeset	32
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	33 #include <iosfwd>
2991 fc751d2a99fd [project @ 1997-05-16 21:00:48 by jwe] jwe parents: 2987 diff changeset	34
4748 7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe] jwe parents: 4192 diff changeset	35 class octave_function;
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	36
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	37 namespace octave
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	38 {
26113 8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	39 class tree_evaluator;
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	40 class tree_walker;
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	41
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	42 // Base class for the parse tree.
16627 de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	43
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	44 class tree
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	45 {
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	46 public:
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	47
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	48 tree (int l = -1, int c = -1)
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	49 : m_line_num (l), m_column_num (c), m_bp_cond (nullptr)
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	50 { }
21157 94fc5f13d51b dbstop: conditional breakpoint, dbstop if caught error etc. (bug #46795) Lachlan Andrew <lachlanbis@gmail.com> parents: 20791 diff changeset	51
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	52 // No copying!
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	53
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	54 tree (const tree&) = delete;
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	55
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	56 tree& operator = (const tree&) = delete;
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	57
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	58 virtual ~tree (void) = default;
8843 b9ce57a309a3 don't store breakpoint info in tree_statement object John W. Eaton <jwe@octave.org> parents: 8658 diff changeset	59
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	60 virtual int line (void) const { return m_line_num; }
21157 94fc5f13d51b dbstop: conditional breakpoint, dbstop if caught error etc. (bug #46795) Lachlan Andrew <lachlanbis@gmail.com> parents: 20791 diff changeset	61
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	62 virtual int column (void) const { return m_column_num; }
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	63
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	64 void line (int l) { m_line_num = l; }
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 7818 diff changeset	65
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	66 void column (int c) { m_column_num = c; }
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	67
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	68 void set_location (int l, int c)
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	69 {
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	70 m_line_num = l;
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	71 m_column_num = c;
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	72 }
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	73
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	74 virtual void set_breakpoint (const std::string& condition)
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	75 {
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	76 if (m_bp_cond)
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	77 *m_bp_cond = condition;
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	78 else
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	79 m_bp_cond = new std::string (condition);
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	80 }
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	81
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	82 virtual void delete_breakpoint (void)
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	83 {
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	84 if (m_bp_cond)
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	85 {
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	86 delete m_bp_cond;
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	87
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	88 m_bp_cond = nullptr;
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	89 }
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	90 }
2991 fc751d2a99fd [project @ 1997-05-16 21:00:48 by jwe] jwe parents: 2987 diff changeset	91
26113 8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	92 bool meets_bp_condition (tree_evaluator& tw) const;
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	93
26113 8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94 bool is_breakpoint (void) const
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	95 {
26113 8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 return m_bp_cond;
8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	97 }
8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	98
8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	99 bool is_active_breakpoint (tree_evaluator& tw) const
8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	100 {
8a15f3bace49 move eval_string inside interpreter/evaluator class John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	101 return m_bp_cond && meets_bp_condition (tw);
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	102 }
3772 e44ffad3d06c [project @ 2001-02-03 06:23:38 by jwe] jwe parents: 3770 diff changeset	103
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	104 // breakpoint condition, or "0" (i.e., "false") if no breakpoint.
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	105 // To distinguish "0" from a disabled breakpoint, test "is_breakpoint" too.
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	106 const std::string bp_cond (void) const
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	107 {
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	108 return m_bp_cond ? *m_bp_cond : "0";
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	109 }
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	110
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	111 std::string str_print_code (void);
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	112
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	113 virtual void accept (tree_walker& tw) = 0;
2991 fc751d2a99fd [project @ 1997-05-16 21:00:48 by jwe] jwe parents: 2987 diff changeset	114
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	115 private:
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	116
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	117 // The input line and column where we found the text that was
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	118 // eventually converted to this tree node.
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	119 int m_line_num;
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	120 int m_column_num;
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	121
24846 7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	122 // NULL if no breakpoint, or a breakpoint condition if there is one.
7620f1f5290d use m_ prefix for member variables in parse tree classes John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	123 std::string *m_bp_cond;
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	124 };
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23073 diff changeset	125 }
2987 ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	126
ae20b3f37f5e [project @ 1997-05-16 07:05:15 by jwe] jwe parents: diff changeset	127 #endif

Mercurial > octave

annotate libinterp/parse-tree/pt.h @ 27923:bd51beb6205e