ov-fcn.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2026 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 (octave_ov_fcn_h)
#define octave_ov_fcn_h 1
 
#include "octave-config.h"
 
#include <string>
 
#include "oct-time.h"
#include "str-vec.h"
 
#include "comment-list.h"
#include "ovl.h"
#include "ov-base.h"
#include "ov-typeinfo.h"
#include "symscope.h"
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
class filepos;
class stack_frame;
class tree_evaluator;
class tree_walker;
 
OCTAVE_END_NAMESPACE(octave)
 
// Functions.
 
class OCTINTERP_API octave_function : public octave_base_value
{
public:
 
  octave_function ()
    : m_relative (false), m_locked (false), m_private (false),
      m_dispatch_class (), m_package_name (), m_name (), m_dir_name (),
      m_doc () { }
 
  OCTAVE_DISABLE_COPY_MOVE (octave_function)
 
  ~octave_function () = default;
 
  octave_base_value * clone () const;
  octave_base_value * empty_clone () const;
 
  bool is_defined () const { return true; }
 
  bool is_function () const { return true; }
 
  virtual bool is_system_fcn_file () const { return false; }
 
  virtual std::string fcn_file_name () const { return ""; }
 
  virtual std::string src_file_name () const { return ""; }
 
  virtual octave::filepos beg_pos () const;
  virtual octave::filepos end_pos () const;
 
  virtual octave::comment_list leading_comments () const;
  virtual octave::comment_list trailing_comments () const;
 
  // The name to show in the profiler (also used as map-key).
  virtual std::string profiler_name () const { return name (); }
 
  virtual std::string parent_fcn_name () const { return ""; }
 
  virtual octave::symbol_scope parent_fcn_scope () const
  { return octave::symbol_scope::invalid (); }
 
  virtual std::list<std::string> parent_fcn_names () const
  { return std::list<std::string> (); }
 
  virtual void mark_fcn_file_up_to_date (const octave::sys::time&) { }
 
  virtual octave::symbol_scope scope () { return octave::symbol_scope::invalid (); }
 
  virtual octave::sys::time time_parsed () const
  { return octave::sys::time (static_cast<OCTAVE_TIME_T> (0)); }
 
  virtual octave::sys::time time_checked () const
  { return octave::sys::time (static_cast<OCTAVE_TIME_T> (0)); }
 
  virtual int call_depth () const { return 0; }
 
  virtual bool is_nested_function () const { return false; }
 
  virtual bool is_parent_function () const { return false; }
 
  virtual bool is_subfunction () const { return false; }
 
  virtual bool is_compiled () const { return false; }
 
  bool is_class_constructor (const std::string& cname = "") const
  {
    return (is_classdef_constructor (cname) || is_legacy_constructor (cname));
  }
 
  bool is_class_method (const std::string& cname = "") const
  {
    return (is_classdef_method (cname) || is_legacy_method (cname));
  }
 
  virtual bool
  is_legacy_constructor (const std::string& = "") const
  { return false; }
 
  virtual bool
  is_classdef_constructor (const std::string& = "") const
  { return false; }
 
  virtual bool is_legacy_method (const std::string& = "") const
  { return false; }
 
  virtual bool is_classdef_method (const std::string& = "") const
  { return false; }
 
  virtual bool takes_varargs () const { return false; }
 
  virtual bool takes_var_return () const { return false; }
 
  // The next two functions are for dispatching to built-in
  // functions given built-in classes.
 
  virtual void push_dispatch_class (const std::string&) { }
 
  virtual bool handles_dispatch_class (const std::string&) const
  { return false; }
 
  void stash_dispatch_class (const std::string& nm) { m_dispatch_class = nm; }
 
  std::string dispatch_class () const { return m_dispatch_class; }
 
  void stash_package_name (const std::string& pack) { m_package_name = pack; }
 
  std::string package_name () const { return m_package_name; }
 
  virtual void
  mark_as_private_function (const std::string& cname = "")
  {
    m_private = true;
    m_dispatch_class = cname;
  }
 
  bool is_private_function () const { return m_private; }
 
  bool is_private_function_of_class (const std::string& nm) const
  { return m_private && m_dispatch_class == nm; }
 
  virtual bool
  is_anonymous_function_of_class (const std::string& = "") const
  { return false; }
 
  std::string dir_name () const { return m_dir_name; }
 
  void stash_dir_name (const std::string& dir) { m_dir_name = dir; }
 
  void lock ()
  {
    this->lock_subfunctions ();
    m_locked = true;
  }
 
  void unlock ()
  {
    this->unlock_subfunctions ();
    m_locked = false;
  }
 
  bool islocked () const { return m_locked; }
 
  virtual void lock_subfunctions () { }
 
  virtual void unlock_subfunctions () { }
 
  virtual void maybe_relocate_end () { }
 
  // Not valid until after the function is completely parsed.
  virtual bool has_subfunctions () const { return false; }
 
  virtual void stash_subfunction_names (const std::list<std::string>&) { }
 
  virtual std::list<std::string> subfunction_names () const
  { return std::list<std::string> (); }
 
  void mark_relative () { m_relative = true; }
 
  bool is_relative () const { return m_relative; }
 
  std::string name () const { return m_name; }
 
  std::string canonical_name () const
  {
    if (m_package_name.empty ())
      return m_name;
    else
      return m_package_name + '.' + m_name;
  }
 
  void document (const std::string& ds) { m_doc = ds; }
 
  virtual std::string
  doc_string (const std::string& /*meth_name*/ = "") const { return m_doc; }
 
  virtual void unload () { }
 
  virtual void accept (octave::tree_walker&) { }
 
  virtual bool accepts_postfix_index (char type) const
  { return (type == '('); }
 
  // Push new stack frame (if necessary) and execute function.
  virtual octave_value_list
  call (octave::tree_evaluator& tw, int nargout = 0,
        const octave_value_list& args = octave_value_list ());
 
  // Execute function without pushing new stack frame (assumes that has
  // already been done).
  virtual octave_value_list
  execute (octave::tree_evaluator& tw, int nargout = 0,
           const octave_value_list& args = octave_value_list ()) = 0;
 
protected:
 
  octave_function (const std::string& nm,
                   const std::string& ds = "")
    : m_relative (false), m_locked (false), m_private (false),
      m_dispatch_class (), m_name (nm), m_dir_name (), m_doc (ds) { }
 
  // TRUE if this function was found from a m_relative path element.
  bool m_relative;
 
  // TRUE if this function is tagged so that it can't be cleared.
  bool m_locked;
 
  // TRUE means this is a private function.
  bool m_private;
 
  // If this object is a class method or constructor, or a private
  // function inside a class directory, this is the name of the class
  // to which the method belongs.
  std::string m_dispatch_class;
 
  // If this function is part of a package, this is the full name
  // of the package to which the function belongs.
  std::string m_package_name;
 
  // The name of this function.
  std::string m_name;
 
  // The name of the directory in the path where we found this
  // function.  May be m_relative.
  std::string m_dir_name;
 
  // The help text for this function.
  std::string m_doc;
};
 
#endif