Mercurial > octave
view libinterp/octave-value/ov-classdef.cc @ 32589:05b4479c29d8 stable
maint: C++ style check for libinterp/ before 9.1 release.
* libinterp/corefcn/__ichol__.cc, libinterp/corefcn/__ilu__.cc,
libinterp/corefcn/bsxfun.cc, libinterp/corefcn/call-stack.cc,
libinterp/corefcn/defaults.cc, libinterp/corefcn/environment.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/event-manager.cc,
libinterp/corefcn/ft-text-renderer.cc, libinterp/corefcn/gl-render.cc,
libinterp/corefcn/graphics-utils.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/help.cc,
libinterp/corefcn/hook-fcn.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/interpreter-private.cc, libinterp/corefcn/interpreter.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-hdf5.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/mex.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/oct-map.cc, libinterp/corefcn/oct-stream.cc,
libinterp/corefcn/pager.cc, libinterp/corefcn/perms.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/qr.cc,
libinterp/corefcn/settings.cc, libinterp/corefcn/sparse-xdiv.cc,
libinterp/corefcn/stack-frame.cc, libinterp/corefcn/syminfo.cc,
libinterp/corefcn/symrcm.cc, libinterp/corefcn/symscope.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/sysdep.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/url-handle-manager.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/xnorm.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-ch-mat.cc, libinterp/octave-value/ov-class.cc,
libinterp/octave-value/ov-classdef.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-handle.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-inline.h, libinterp/octave-value/ov-lazy-idx.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-range.h,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/octave.cc,
libinterp/parse-tree/anon-fcn-validator.cc, libinterp/parse-tree/bp-table.cc,
libinterp/parse-tree/oct-lvalue.cc, libinterp/parse-tree/pt-classdef.cc,
libinterp/parse-tree/pt-colon.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-eval.h, libinterp/parse-tree/pt-tm-const.cc,
libinterp/parse-tree/pt-walk.cc:
C++ style check for libinterp/ before 9.1 release.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 12 Dec 2023 18:24:05 -0800 |
parents | 8e4f14837db2 |
children | 2f3b54f81947 2e484f9f1f18 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2012-2023 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include <algorithm> #include <iomanip> #include "cdef-class.h" #include "cdef-method.h" #include "cdef-package.h" #include "cdef-property.h" #include "cdef-utils.h" #include "defun.h" #include "errwarn.h" #include "interpreter-private.h" #include "load-path.h" #include "ov-classdef.h" #include "ov-fcn-handle.h" #include "ov-typeinfo.h" #include "ov-usr-fcn.h" #include "parse.h" #include "pr-output.h" #include "pt-eval.h" #include "pt-misc.h" #include "oct-lvalue.h" static bool in_class_method (const octave::cdef_class& cls) { octave::cdef_class ctx = octave::get_class_context (); return (ctx.ok () && octave::is_superclass (ctx, cls)); } int octave_classdef::s_t_id (-1); const std::string octave_classdef::s_t_name ("object"); void octave_classdef::register_type (octave::type_info& ti) { s_t_id = ti.register_type (octave_classdef::s_t_name, "<unknown>", octave_value (new octave_classdef ())); } octave_value_list octave_classdef::subsref (const std::string& type, const std::list<octave_value_list>& idx, int nargout) { std::size_t skip = 0; octave_value_list retval; octave::cdef_class cls = m_object.get_class (); if (! in_class_method (cls) && ! called_from_builtin ()) { octave::cdef_method meth = cls.find_method ("subsref"); if (meth.ok ()) { octave_value_list args; args(1) = make_idx_args (type, idx, "subsref"); m_count++; args(0) = octave_value (this); // If the number of output arguments is unknown, attempt to set up // a proper value for nargout at least in the simple case where the // cs-list-type expression - i.e., {} or ().x, is the leading one. if (nargout <= 0) { bool maybe_cs_list_query = (type[0] == '.' || type[0] == '{' || (type.length () > 1 && type[0] == '(' && type[1] == '.')); if (maybe_cs_list_query) { // Set up a proper nargout for the subsref call by calling numel. octave_value_list tmp; int nout; if (type[0] != '.') tmp = idx.front (); nout = xnumel (tmp); if (nargout != 0 || nout > 1) nargout = nout; } else if (nargout < 0) nargout = 1; } retval = meth.execute (args, nargout, true, "subsref"); // Since we're handling subsref, if the list has more than one element // and the caller to subsref accepts more that one output, return // the elements as a comma-separated list so that we can pass it to the // evaluator if (retval.length () > 1 && (nargout < 0 || nargout > 1)) { if (nargout <= 0 || nargout >= retval.length ()) // Take the whole list retval = octave_value (retval); else // Take nargout elements of the list retval = octave_value (retval.slice (0, nargout)); } return retval; } } // At this point, the default subsref mechanism must be used. retval = m_object.subsref (type, idx, nargout, skip, octave::cdef_class ()); if (type.length () > skip && idx.size () > skip) retval = retval(0).next_subsref (nargout, type, idx, skip); return retval; } octave_value octave_classdef::subsref (const std::string& type, const std::list<octave_value_list>& idx, bool auto_add) { std::size_t skip = 0; octave_value_list retval; // This variant of subsref is used to create temporary values when doing // assignment with multi-level indexing. AFAIK this is only used for internal // purpose (not sure we should even implement this). octave::cdef_class cls = m_object.get_class (); if (! in_class_method (cls)) { octave::cdef_method meth = cls.find_method ("subsref"); if (meth.ok ()) { octave_value_list args; args(1) = make_idx_args (type, idx, "subsref"); m_count++; args(0) = octave_value (this); retval = meth.execute (args, 1, true, "subsref"); return retval.length () > 0 ? retval(0) : octave_value (); } } retval = m_object.subsref (type, idx, 1, skip, octave::cdef_class (), auto_add); if (type.length () > skip && idx.size () > skip) retval = retval(0).next_subsref (1, type, idx, skip); return retval.length () > 0 ? retval(0) : octave_value (); } octave_value octave_classdef::subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs) { octave_value retval; octave::cdef_class cls = m_object.get_class (); if (! in_class_method (cls) && ! called_from_builtin ()) { octave::cdef_method meth = cls.find_method ("subsasgn"); if (meth.ok ()) { octave_value_list args; args(1) = make_idx_args (type, idx, "subsasgn"); m_count++; args(0) = octave_value (this); args(2) = rhs; octave_value_list retlist; retlist = meth.execute (args, 1, true, "subsasgn"); if (retlist.empty ()) error ("overloaded method 'subsasgn' did not return any value"); retval = retlist(0); } } if (! retval.is_defined ()) retval = m_object.subsasgn (type, idx, rhs); return retval; } octave_value octave_classdef::undef_subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs) { if (type.length () == 1 && type[0] == '(') { m_object = m_object.make_array (); return subsasgn (type, idx, rhs); } else return octave_base_value::undef_subsasgn (type, idx, rhs); return octave_value (); } Matrix octave_classdef::size () { octave::cdef_class cls = m_object.get_class (); if (! in_class_method (cls) && ! called_from_builtin ()) { octave::cdef_method meth = cls.find_method ("size"); if (meth.ok ()) { m_count++; octave_value_list args (1, octave_value (this)); octave_value_list lv = meth.execute (args, 1, true, "size"); if (lv.length () <= 0 || ! lv(0).is_matrix_type () || ! lv(0).dims ().isvector ()) error ("%s.size: invalid return value", class_name ().c_str ()); return lv(0).matrix_value (); } } return octave_base_value::size (); } octave_idx_type octave_classdef::xnumel (const octave_value_list& idx) { octave_idx_type retval = -1; octave::cdef_class cls = m_object.get_class (); if (! in_class_method (cls) && ! called_from_builtin ()) { octave::cdef_method meth = cls.find_method ("numel"); if (meth.ok ()) { octave_value_list args (idx.length () + 1, octave_value ()); m_count++; args(0) = octave_value (this); for (octave_idx_type i = 0; i < idx.length (); i++) args(i+1) = idx(i); // Temporarily set lvalue list of current statement to NULL, to avoid // using that list for the execution of the method "numel" octave::interpreter& interp = octave::__get_interpreter__ (); octave::tree_evaluator& tw = interp.get_evaluator(); octave::unwind_action act ([&tw] (const std::list<octave::octave_lvalue> *lvl) { tw.set_lvalue_list (lvl); }, tw.lvalue_list ()); tw.set_lvalue_list (nullptr); octave_value_list lv = meth.execute (args, 1, true, "numel"); if (lv.length () != 1 || ! lv(0).is_scalar_type ()) error ("@%s/numel: invalid return value", cls.get_name ().c_str ()); retval = lv(0).idx_type_value (true); return retval; } } retval = octave_base_value::xnumel (idx); return retval; } void octave_classdef::print (std::ostream& os, bool) { print_raw (os); } void octave_classdef::print_raw (std::ostream& os, bool) const { octave::cdef_class cls = m_object.get_class (); if (cls.ok ()) { bool is_array = m_object.is_array (); increment_indent_level (); indent (os); os << class_name () << " object"; if (is_array) os << " array"; os << " with properties:"; newline (os); if (! Vcompact_format) newline (os); increment_indent_level (); std::map<std::string, octave::cdef_property> property_map = cls.get_property_map (); std::size_t max_len = 0; for (const auto& pname_prop : property_map) { // FIXME: this loop duplicates a significant portion of the // loop below and the loop in Fproperties. const octave::cdef_property& prop = pname_prop.second; const std::string nm = prop.get_name (); octave_value acc = prop.get ("GetAccess"); if (! acc.is_string () || acc.string_value () != "public") continue; octave_value hid = prop.get ("Hidden"); if (hid.bool_value ()) continue; std::size_t sz = nm.size (); if (sz > max_len) max_len = sz; } for (auto& pname_prop : property_map) { const octave::cdef_property& prop = pname_prop.second; const std::string nm = prop.get_name (); octave_value acc = prop.get ("GetAccess"); if (! acc.is_string () || acc.string_value () != "public") continue; octave_value hid = prop.get ("Hidden"); if (hid.bool_value ()) continue; indent (os); if (is_array) os << " " << nm; else { octave_value val = prop.get_value (m_object, false); dim_vector dims = val.dims (); os << std::setw (max_len+2) << nm << ": "; if (val.is_string ()) os << val.string_value (); else if (val.islogical ()) os << val.bool_value (); else os << "[" << dims.str () << " " << val.class_name () << "]"; } newline (os); } decrement_indent_level (); decrement_indent_level (); } } bool octave_classdef::is_instance_of (const std::string& cls_name) const { octave::cdef_class cls = octave::lookup_class (cls_name, false, false); if (cls.ok ()) return is_superclass (cls, m_object.get_class ()); return false; } octave_value octave_classdef::superclass_ref (const std::string& meth, const std::string& cls) { return octave_value (new octave_classdef_superclass_ref (meth, cls)); } octave_value octave_classdef::metaclass_query (const std::string& cls) { return octave::to_ov (octave::lookup_class (cls)); } bool octave_classdef_meta::is_classdef_method (const std::string& cname) const { bool retval = false; if (m_object.is_method ()) { if (cname.empty ()) retval = true; else { octave::cdef_method meth (m_object); return meth.is_defined_in_class (cname); } } return retval; } bool octave_classdef_meta::is_classdef_constructor (const std::string& cname) const { bool retval = false; if (m_object.is_class ()) { if (cname.empty ()) retval = true; else { octave::cdef_class cls (m_object); if (cls.get_name () == cname) retval = true; } } return retval; } std::string octave_classdef_meta::doc_string (const std::string& meth_name) const { if (m_object.is_class ()) { octave::cdef_class cls (m_object); if (meth_name.empty ()) return cls.doc_string (); octave::cdef_method cdef_meth = cls.find_method (meth_name); if (cdef_meth.ok ()) return cdef_meth.get_doc_string (); } return ""; } std::string octave_classdef_meta::file_name () const { if (m_object.is_class ()) { octave::cdef_class cls (m_object); return cls.file_name (); } return ""; } octave_value_list octave_classdef_superclass_ref::execute (octave::tree_evaluator& tw, int nargout, const octave_value_list& idx) { octave_value_list retval; std::string meth_name; bool in_constructor; octave::cdef_class ctx; ctx = octave::get_class_context (meth_name, in_constructor); if (! ctx.ok ()) error ("superclass calls can only occur in methods or constructors"); std::string mname = m_method_name; std::string cname = m_class_name; // CLS is the superclass. The lookup_class function handles // pkg.class names. octave::cdef_class cls = octave::lookup_class (cname); if (in_constructor) { if (! is_direct_superclass (cls, ctx)) error ("'%s' is not a direct superclass of '%s'", cname.c_str (), ctx.get_name ().c_str ()); if (! is_constructed_object (tw, mname)) error ("cannot call superclass constructor with variable '%s'", mname.c_str ()); octave_value sym = tw.varval (mname); cls.run_constructor (octave::to_cdef_ref (sym), idx); retval(0) = sym; } else { std::size_t pos = mname.find ('.'); octave::cdef_object obj; if (pos != std::string::npos) { // We are looking at obj.meth. std::string oname = m_method_name.substr (0, pos); mname = mname.substr (pos + 1); octave_value tval = tw.varval (oname); // FIXME: Can we only call superclass methods on the current // object? If so, and we are looking at something like // // function meth (obj, ...) // obj.meth@superclass (...) // // Do we need to verify that the object that was passed to // meth is the same as the object we find when looking up // obj in the expression obj.meth? If so, what is the right // way to perform that check? if (tval.is_classdef_object ()) { octave_classdef *cdobj = tval.classdef_object_value (); obj = cdobj->get_object (); } } if (mname != meth_name) error ("method name mismatch ('%s' != '%s')", mname.c_str (), meth_name.c_str ()); if (! is_strict_superclass (cls, ctx)) error ("'%s' is not a superclass of '%s'", cname.c_str (), ctx.get_name ().c_str ()); // I see 2 possible implementations here: // 1) use cdef_object::subsref with a different class // context; this avoids duplicating code, but // assumes the object is always the first argument // 2) lookup the method manually and call // cdef_method::execute; this duplicates part of // logic in cdef_object::subsref, but avoid the // assumption of 1) // Not being sure about the assumption of 1), I // go with option 2) for the time being. octave::cdef_method meth = cls.find_method (meth_name, false); if (! meth.ok ()) error ("no method '%s' found in superclass '%s'", meth_name.c_str (), cname.c_str ()); retval = (obj.ok () ? meth.execute (obj, idx, nargout, true, meth_name) : meth.execute (idx, nargout, true, meth_name)); } return retval; } bool octave_classdef_superclass_ref::is_constructed_object (octave::tree_evaluator& tw, const std::string& nm) { octave_function *of = tw.current_function (); if (of->is_classdef_constructor ()) { octave_user_function *uf = of->user_function_value (true); if (uf) { octave::tree_parameter_list *ret_list = uf->return_list (); if (ret_list && ret_list->length () == 1) return (ret_list->front ()->name () == nm); } } return false; } OCTAVE_BEGIN_NAMESPACE(octave) DEFUN (__meta_get_package__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{pkg} =} __meta_get_package__ (@var{pkg_name}) Undocumented internal function. @end deftypefn */) { if (args.length () != 1) print_usage (); std::string cname = args(0).xstring_value ("PKG_NAME must be a string"); return to_ov (lookup_package (cname)); } DEFUN (metaclass, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{metaclass_obj} =} metaclass (obj) Return the meta.class object corresponding to the class of @var{obj}. @end deftypefn */) { if (args.length () != 1) print_usage (); cdef_object obj = to_cdef (args(0)); return to_ov (obj.get_class ()); } // FIXME: What about dynamic properties if obj is a scalar, or the // properties of the class of obj if obj is an array? Probably there // should be a function to do this job so that the DEFUN is just a // simple wrapper. DEFUN (properties, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {} properties (@var{obj}) @deftypefnx {} {} properties (@var{class_name}) @deftypefnx {} {@var{proplist} =} properties (@dots{}) Display or return the public properties for the classdef object @var{obj} or the named class @var{class_name}. If an output value is requested, return the list of property names in a cell array. Programming Note: Property names are returned if the @code{GetAccess} attribute is public and if the @code{Hidden} attribute is false. @seealso{methods} @end deftypefn */) { if (args.length () != 1) print_usage (); octave_value arg = args(0); std::string class_name; if (arg.isobject ()) class_name = arg.class_name (); else if (arg.is_string ()) class_name = arg.string_value (); else err_wrong_type_arg ("properties", arg); cdef_class cls; cls = lookup_class (class_name, false, true); if (! cls.ok ()) error ("invalid class: %s", class_name.c_str ()); std::map<std::string, cdef_property> property_map = cls.get_property_map (); std::list<std::string> property_names; for (const auto& pname_prop : property_map) { // FIXME: this loop duplicates a significant portion of the loops // in octave_classdef::print_raw. const cdef_property& prop = pname_prop.second; octave_value acc = prop.get ("GetAccess"); if (! acc.is_string () || acc.string_value () != "public") continue; octave_value hid = prop.get ("Hidden"); if (hid.bool_value ()) continue; property_names.push_back (pname_prop.first); } if (nargout > 0) return octave_value (Cell (string_vector (property_names))); octave_stdout << "properties for class " << class_name << ":\n\n"; for (const auto& nm : property_names) octave_stdout << " " << nm << "\n"; octave_stdout << std::endl; return octave_value (); } /* %!assert (properties ("inputParser"), %! {"CaseSensitive"; "FunctionName"; "KeepUnmatched"; %! "Parameters"; "PartialMatching"; "Results"; %! "StructExpand"; "Unmatched"; "UsingDefaults"}); */ // FIXME: Need to implement the -full option. DEFMETHOD (__methods__, interp, args, , doc: /* -*- texinfo -*- @deftypefn {} {[@var{mtds}, @var{found}] =} __methods__ (@var{obj}) @deftypefnx {} {[@var{mtds}, @var{found}] =} __methods__ ("classname") Implement @code{methods} for Octave class objects and classnames. @seealso{methods} @end deftypefn */) { // Input validation has already been done in methods.m. octave_value arg = args(0); std::string class_name; if (arg.isobject ()) class_name = arg.class_name (); else if (arg.is_string ()) class_name = arg.string_value (); else err_wrong_type_arg ("__methods__", arg); string_vector sv; bool found = false; cdef_class cls = lookup_class (class_name, false, true); if (cls.ok ()) { // Find methods for classdef objects. std::map<std::string, cdef_method> method_map = cls.get_method_map (false, true); std::list<std::string> method_names; for (const auto& nm_mthd : method_map) { const cdef_method& method = nm_mthd.second; octave_value acc = method.get ("Access"); if (! acc.is_string () || acc.string_value () != "public") continue; octave_value hid = method.get ("Hidden"); if (hid.bool_value ()) continue; method_names.push_back (nm_mthd.first); } sv = string_vector (method_names); found = true; } else { // Find methods for legacy @CLASS objects. load_path& lp = interp.get_load_path (); sv = string_vector (lp.methods (class_name)); found = ! sv.empty (); } return ovl (Cell (sv), found); } /* // BIST tests are in file methods.m %!assert (1) */ OCTAVE_END_NAMESPACE(octave)