octave: libinterp/octave-value/cdef-utils.h annotate

annotate libinterp/octave-value/cdef-utils.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	853e60367cb6 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) 2012-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 ////////////////////////////////////////////////////////////////////////
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	25
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	26 #if ! defined (octave_cdef_utils_h)
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	27 #define octave_cdef_utils_h 1
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	28
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	29 #include "octave-config.h"
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	30
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	31 #include <list>
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	32 #include <string>
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	33
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	34 class octave_value;
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	35 class Cell;
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	36
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	37 namespace octave
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	38 {
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	39 class cdef_class;
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	40 class cdef_package;
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	41
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	42 extern std::string
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	43 get_base_name (const std::string& nm);
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	44
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	45 extern void
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	46 make_function_of_class (const std::string& class_name,
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	47 const octave_value& fcn);
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	48
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	49 extern void
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	50 make_function_of_class (const cdef_class& cls, const octave_value& fcn);
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	51
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	52 extern cdef_class
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	53 lookup_class (const std::string& name, bool error_if_not_found = true,
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	54 bool load_if_not_found = true);
2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	55
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	56 extern cdef_class
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	57 lookup_class (const cdef_class& cls);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	58
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	59 extern cdef_class
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	60 lookup_class (const octave_value& ov);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	61
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	62 extern std::list<cdef_class>
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	63 lookup_classes (const Cell& cls_list);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	64
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	65 extern octave_value
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	66 to_ov (const cdef_object& obj);
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	67
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	68 extern octave_value
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	69 to_ov (const octave_value& ov);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	70
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	71 extern cdef_object
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	72 to_cdef (const octave_value& val);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	73
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	74 extern cdef_object&
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	75 to_cdef_ref (const octave_value& val);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	76
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	77 extern cdef_object
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	78 to_cdef (const cdef_object& obj);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	79
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	80 extern octave_value
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	81 to_ov (const std::list<cdef_class>& class_list);
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	82
26774 568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	83 extern bool
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	84 is_dummy_method (const octave_value& fcn);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	85
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	86 extern bool
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	87 is_superclass (const cdef_class& clsa, const cdef_class& clsb,
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	88 bool allow_equal = true, int max_depth = -1);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	89 extern bool
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	90 is_strict_superclass (const cdef_class& clsa, const cdef_class& clsb);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	91
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	92 extern bool
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	93 is_direct_superclass (const cdef_class& clsa, const cdef_class& clsb);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	94
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	95 extern cdef_package
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	96 lookup_package (const std::string& name, bool error_if_not_found = true,
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	97 bool load_if_not_found = true);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	98
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	99 extern cdef_class
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	100 get_class_context (std::string& name, bool& in_constructor);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	101
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	102 extern cdef_class
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	103 get_class_context (void);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	104
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	105 extern bool
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	106 check_access (const cdef_class& cls, const octave_value& acc,
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	107 const std::string& meth_name = "",
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	108 const std::string& prop_name = "",
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	109 bool is_prop_set = false);
568c2ab2782d move classdef classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 26772 diff changeset	110 }
26772 d1419ac09564 split method, package, and property classes from cdef-class file John W. Eaton <jwe@octave.org> parents: 26769 diff changeset	111
26769 2f847e3e8d6b split classdef into multiple smaller source files John W. Eaton <jwe@octave.org> parents: diff changeset	112 #endif

Mercurial > octave

annotate libinterp/octave-value/cdef-utils.h @ 27923:bd51beb6205e