defun.cc

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2025 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 <string>
 
#include "defun.h"
#include "dynamic-ld.h"
#include "error.h"
#include "help.h"
#include "ov.h"
#include "ov-builtin.h"
#include "ov-dld-fcn.h"
#include "ov-fcn.h"
#include "ov-mex-fcn.h"
#include "ov-usr-fcn.h"
#include "ovl.h"
#include "oct-lvalue.h"
#include "pager.h"
#include "interpreter-private.h"
#include "interpreter.h"
#include "symtab.h"
#include "variables.h"
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
// Print the usage part of the doc string of FCN (user-defined or DEFUN).
void
print_usage ()
{
  tree_evaluator& tw = __get_evaluator__ ();
 
  const octave_function *cur = tw.current_function ();
 
  if (cur)
    print_usage (cur->name ());
  else
    error ("print_usage: invalid function");
}
 
void
print_usage (const std::string& name)
{
  interpreter& interp = __get_interpreter__ ();
 
  interp.feval ("print_usage", octave_value (name), 0);
}
 
void
check_version (const std::string& version, const std::string& fcn)
{
  if (version != OCTAVE_API_VERSION)
    {
      error ("API version %s found in .oct file function '%s'\n"
             "       does not match the running Octave (API version %s)\n"
             "       this can lead to incorrect results or other failures\n"
             "       you can fix this problem by recompiling this .oct file",
             version.c_str (), fcn.c_str (), OCTAVE_API_VERSION);
    }
}
 
// Install variables and functions in the symbol tables.
 
void
install_dld_function (octave_dld_function::fcn f, const std::string& name,
                      const dynamic_library& shl, const std::string& doc,
                      bool relative)
{
  octave_dld_function *fcn = new octave_dld_function (f, shl, name, doc);
 
  if (relative)
    fcn->mark_relative ();
 
  octave_value fval (fcn);
 
  symbol_table& symtab = __get_symbol_table__ ();
 
  symtab.install_built_in_function (name, fval);
}
 
void
install_dld_function (octave_dld_function::meth m, const std::string& name,
                      const dynamic_library& shl, const std::string& doc,
                      bool relative)
{
  octave_dld_function *fcn = new octave_dld_function (m, shl, name, doc);
 
  if (relative)
    fcn->mark_relative ();
 
  octave_value fval (fcn);
 
  symbol_table& symtab = __get_symbol_table__ ();
 
  symtab.install_built_in_function (name, fval);
}
 
void
install_mex_function (void *fptr, bool fmex, const std::string& name,
                      const dynamic_library& shl, bool relative)
{
  octave_mex_function *fcn = new octave_mex_function (fptr, fmex, shl, name);
 
  if (relative)
    fcn->mark_relative ();
 
  octave_value fval (fcn);
 
  symbol_table& symtab = __get_symbol_table__ ();
 
  symtab.install_built_in_function (name, fval);
}
 
dynamic_library
get_current_shlib ()
{
  dynamic_library retval;
 
  tree_evaluator& tw = __get_evaluator__ ();
 
  octave_function *curr_fcn = tw.current_function ();
 
  if (curr_fcn)
    {
      if (curr_fcn->is_dld_function ())
        {
          octave_dld_function *dld
            = dynamic_cast<octave_dld_function *> (curr_fcn);
          retval = dld->get_shlib ();
        }
      else if (curr_fcn->is_mex_function ())
        {
          octave_mex_function *mex
            = dynamic_cast<octave_mex_function *> (curr_fcn);
          retval = mex->get_shlib ();
        }
    }
 
  return retval;
}
 
OCTAVE_END_NAMESPACE(octave)